ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.182 by root, Fri Jan 19 15:38:01 2007 UTC vs.
Revision 1.405 by root, Mon Dec 17 08:03:22 2007 UTC

…		…
3	use utf8;	3	use utf8;
4	use strict;	4	use strict;
5		5
6	use Symbol;	6	use Symbol;
7	use List::Util;	7	use List::Util;
8	use Storable;	8	use Socket;
		9	use EV 1.86;
9	use Opcode;	10	use Opcode;
10	use Safe;	11	use Safe;
11	use Safe::Hole;	12	use Safe::Hole;
		13	use Storable ();
12		14
13	use Coro 3.4 ();	15	use Coro 4.32 ();
		16	use Coro::State;
		17	use Coro::Handle;
14	use Coro::Event;	18	use Coro::EV;
15	use Coro::Timer;	19	use Coro::Timer;
16	use Coro::Signal;	20	use Coro::Signal;
17	use Coro::Semaphore;	21	use Coro::Semaphore;
18	use Coro::AIO;	22	use Coro::AIO;
		23	use Coro::BDB;
		24	use Coro::Storable;
		25	use Coro::Util ();
19		26
		27	use JSON::XS 2.01 ();
		28	use BDB ();
20	use Data::Dumper;	29	use Data::Dumper;
21	use Digest::MD5;	30	use Digest::MD5;
22	use Fcntl;	31	use Fcntl;
23	use IO::AIO 2.32 ();
24	use YAML::Syck ();	32	use YAML::Syck ();
		33	use IO::AIO 2.51 ();
25	use Time::HiRes;	34	use Time::HiRes;
		35	use Compress::LZF;
		36	use Digest::MD5 ();
26		37
27	use Event; $Event::Eval = 1; # no idea why this is required, but it is	38	# configure various modules to our taste
28		39	#
29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	40	$Storable::canonical = 1; # reduce rsync transfers
		41	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		42	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
30		43
31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	44	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32	$YAML::Syck::ImplicitUnicode = 1;	45	$YAML::Syck::ImplicitUnicode = 1;
33		46
34	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority	47	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
35		48
		49	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		50
36	our %COMMAND = ();	51	our %COMMAND = ();
37	our %COMMAND_TIME = ();	52	our %COMMAND_TIME = ();
38		53
39	our @EXTS = (); # list of extension package names	54	our @EXTS = (); # list of extension package names
40	our %EXTCMD = ();	55	our %EXTCMD = ();
		56	our %EXTICMD = ();
41	our %EXT_CORO = (); # coroutines bound to extensions	57	our %EXT_CORO = (); # coroutines bound to extensions
42	our %EXT_MAP = (); # pluggable maps	58	our %EXT_MAP = (); # pluggable maps
43		59
		60	our $RELOAD; # number of reloads so far
44	our @EVENT;	61	our @EVENT;
45	our $LIBDIR = datadir . "/ext";
46		62
47	our $TICK = MAX_TIME * 1e-6;	63	our $CONFDIR = confdir;
		64	our $DATADIR = datadir;
		65	our $LIBDIR = "$DATADIR/ext";
		66	our $PODDIR = "$DATADIR/pod";
		67	our $MAPDIR = "$DATADIR/" . mapdir;
		68	our $LOCALDIR = localdir;
		69	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		70	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		71	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		72	our $RANDOMDIR = "$LOCALDIR/random";
		73	our $BDBDIR = "$LOCALDIR/db";
		74	our %RESOURCE;
		75
		76	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
48	our $TICK_WATCHER;	77	our $TICK_WATCHER;
49	our $AIO_POLL_WATCHER;	78	our $AIO_POLL_WATCHER;
50	our $WRITE_RUNTIME_WATCHER;	79	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
51	our $NEXT_TICK;	80	our $NEXT_TICK;
52	our $NOW;	81	our $USE_FSYNC = 1; # use fsync to write maps - default off
		82
		83	our $BDB_POLL_WATCHER;
		84	our $BDB_DEADLOCK_WATCHER;
		85	our $BDB_CHECKPOINT_WATCHER;
		86	our $BDB_TRICKLE_WATCHER;
		87	our $DB_ENV;
53		88
54	our %CFG;	89	our %CFG;
55		90
56	our $UPTIME; $UPTIME ||= time;	91	our $UPTIME; $UPTIME ||= time;
57	our $RUNTIME;	92	our $RUNTIME;
		93	our $NOW;
58		94
59	our %PLAYER; # all users	95	our (%PLAYER, %PLAYER_LOADING); # all users
60	our %MAP; # all maps	96	our (%MAP, %MAP_LOADING ); # all maps
61	our $LINK_MAP; # the special {link} map, which is always available	97	our $LINK_MAP; # the special {link} map, which is always available
62	our $RANDOM_MAPS = cf::localdir . "/random";
63
64	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
65	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
66		98
67	# used to convert map paths into valid unix filenames by replacing / by ∕	99	# used to convert map paths into valid unix filenames by replacing / by ∕
68	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	100	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69		101
		102	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		103	our $LOADAVG; # same thing, but with alpha-smoothing
		104	our $tick_start; # for load detecting purposes
		105
70	binmode STDOUT;	106	binmode STDOUT;
71	binmode STDERR;	107	binmode STDERR;
72		108
73	# read virtual server time, if available	109	# read virtual server time, if available
74	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	110	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
75	open my $fh, "<", cf::localdir . "/runtime"	111	open my $fh, "<", "$LOCALDIR/runtime"
76	or die "unable to read runtime file: $!";	112	or die "unable to read runtime file: $!";
77	$RUNTIME = <$fh> + 0.;	113	$RUNTIME = <$fh> + 0.;
78	}	114	}
79		115
80	mkdir cf::localdir;	116	mkdir $_
81	mkdir cf::localdir . "/" . cf::playerdir;	117	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
82	mkdir cf::localdir . "/" . cf::tmpdir;
83	mkdir cf::localdir . "/" . cf::uniquedir;
84	mkdir $RANDOM_MAPS;
85		118
86	our $EMERGENCY_POSITION;	119	our $EMERGENCY_POSITION;
		120
		121	sub cf::map::normalise;
87		122
88	#############################################################################	123	#############################################################################
89		124
90	=head2 GLOBAL VARIABLES	125	=head2 GLOBAL VARIABLES
91		126
…		…
98	=item $cf::RUNTIME	133	=item $cf::RUNTIME
99		134
100	The time this server has run, starts at 0 and is increased by $cf::TICK on	135	The time this server has run, starts at 0 and is increased by $cf::TICK on
101	every server tick.	136	every server tick.
102		137
103	=item $cf::LIBDIR	138	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		139	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		140	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
104		141
105	The perl library directory, where extensions and cf-specific modules can	142	Various directories - "/etc", read-only install directory, perl-library
106	be found. It will be added to C<@INC> automatically.	143	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		144	unique-items directory, player file directory, random maps directory and
		145	database environment.
107		146
108	=item $cf::NOW	147	=item $cf::NOW
109		148
110	The time of the last (current) server tick.	149	The time of the last (current) server tick.
111		150
112	=item $cf::TICK	151	=item $cf::TICK
113		152
114	The interval between server ticks, in seconds.	153	The interval between server ticks, in seconds.
115		154
		155	=item $cf::LOADAVG
		156
		157	The current CPU load on the server (alpha-smoothed), as a value between 0
		158	(none) and 1 (overloaded), indicating how much time is spent on processing
		159	objects per tick. Healthy values are < 0.5.
		160
		161	=item $cf::LOAD
		162
		163	The raw value load value from the last tick.
		164
116	=item %cf::CFG	165	=item %cf::CFG
117		166
118	Configuration for the server, loaded from C</etc/crossfire/config>, or	167	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
119	from wherever your confdir points to.	168	from wherever your confdir points to.
120		169
121	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	170	=item cf::wait_for_tick, cf::wait_for_tick_begin
122		171
123	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	172	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
124	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick	173	returns directly I<after> the tick processing (and consequently, can only wake one process
125	processing has been done. Call C<< ->wait >> on them to maximise the	174	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
126	window of cpu time available, or simply to synchronise to the server tick.	175
		176	=item @cf::INVOKE_RESULTS
		177
		178	This array contains the results of the last C<invoke ()> call. When
		179	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		180	that call.
127		181
128	=back	182	=back
129		183
130	=cut	184	=cut
131		185
132	BEGIN {	186	BEGIN {
133	*CORE::GLOBAL::warn = sub {	187	*CORE::GLOBAL::warn = sub {
134	my $msg = join "", @_;	188	my $msg = join "", @_;
135	utf8::encode $msg;
136		189
137	$msg .= "\n"	190	$msg .= "\n"
138	unless $msg =~ /\n$/;	191	unless $msg =~ /\n$/;
		192
		193	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
139		194
140	LOG llevError, $msg;	195	LOG llevError, $msg;
141	};	196	};
142	}	197	}
143		198
144	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	199	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
145	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	200	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
146	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	201	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
147	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	202	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
148	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	203	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		204	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
149	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	205	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
150		206
151	# we bless all objects into (empty) derived classes to force a method lookup	207	# we bless all objects into (empty) derived classes to force a method lookup
152	# within the Safe compartment.	208	# within the Safe compartment.
153	for my $pkg (qw(	209	for my $pkg (qw(
154	cf::global cf::attachable	210	cf::global cf::attachable
…		…
159	)) {	215	)) {
160	no strict 'refs';	216	no strict 'refs';
161	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	217	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
162	}	218	}
163		219
164	$Event::DIED = sub {	220	$EV::DIED = sub {
165	warn "error in event callback: @_";	221	warn "error in event callback: @_";
166	};	222	};
		223
		224	#############################################################################
167		225
168	=head2 UTILITY FUNCTIONS	226	=head2 UTILITY FUNCTIONS
169		227
170	=over 4	228	=over 4
171		229
…		…
190	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	248	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
191	$d	249	$d
192	} || "[unable to dump $_[0]: '$@']";	250	} || "[unable to dump $_[0]: '$@']";
193	}	251	}
194		252
195	use JSON::Syck (); # TODO# replace by JSON::PC once working
196
197	=item $ref = cf::from_json $json	253	=item $ref = cf::decode_json $json
198		254
199	Converts a JSON string into the corresponding perl data structure.	255	Converts a JSON string into the corresponding perl data structure.
200		256
201	=cut
202
203	sub from_json($) {
204	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
205	JSON::Syck::Load $_[0]
206	}
207
208	=item $json = cf::to_json $ref	257	=item $json = cf::encode_json $ref
209		258
210	Converts a perl data structure into its JSON representation.	259	Converts a perl data structure into its JSON representation.
211		260
212	=cut	261	=cut
213		262
214	sub to_json($) {	263	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
215	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	264
216	JSON::Syck::Dump $_[0]	265	sub encode_json($) { $json_coder->encode ($_[0]) }
217	}	266	sub decode_json($) { $json_coder->decode ($_[0]) }
218		267
219	=item cf::lock_wait $string	268	=item cf::lock_wait $string
220		269
221	Wait until the given lock is available. See cf::lock_acquire.	270	Wait until the given lock is available. See cf::lock_acquire.
222		271
…		…
225	Wait until the given lock is available and then acquires it and returns	274	Wait until the given lock is available and then acquires it and returns
226	a Coro::guard object. If the guard object gets destroyed (goes out of scope,	275	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
227	for example when the coroutine gets canceled), the lock is automatically	276	for example when the coroutine gets canceled), the lock is automatically
228	returned.	277	returned.
229		278
		279	Locks are *not* recursive, locking from the same coro twice results in a
		280	deadlocked coro.
		281
230	Lock names should begin with a unique identifier (for example, cf::map::find	282	Lock names should begin with a unique identifier (for example, cf::map::find
231	uses map_find and cf::map::load uses map_load).	283	uses map_find and cf::map::load uses map_load).
232		284
		285	=item $locked = cf::lock_active $string
		286
		287	Return true if the lock is currently active, i.e. somebody has locked it.
		288
233	=cut	289	=cut
234		290
235	our %LOCK;	291	our %LOCK;
		292	our %LOCKER;#d#
236		293
237	sub lock_wait($) {	294	sub lock_wait($) {
238	my ($key) = @_;	295	my ($key) = @_;
		296
		297	if ($LOCKER{$key} == $Coro::current) {#d#
		298	Carp::cluck "lock_wait($key) for already-acquired lock";#d#
		299	return;#d#
		300	}#d#
239		301
240	# wait for lock, if any	302	# wait for lock, if any
241	while ($LOCK{$key}) {	303	while ($LOCK{$key}) {
242	push @{ $LOCK{$key} }, $Coro::current;	304	push @{ $LOCK{$key} }, $Coro::current;
243	Coro::schedule;	305	Coro::schedule;
…		…
249		311
250	# wait, to be sure we are not locked	312	# wait, to be sure we are not locked
251	lock_wait $key;	313	lock_wait $key;
252		314
253	$LOCK{$key} = [];	315	$LOCK{$key} = [];
		316	$LOCKER{$key} = $Coro::current;#d#
254		317
255	Coro::guard {	318	Coro::guard {
		319	delete $LOCKER{$key};#d#
256	# wake up all waiters, to be on the safe side	320	# wake up all waiters, to be on the safe side
257	$_->ready for @{ delete $LOCK{$key} };	321	$_->ready for @{ delete $LOCK{$key} };
258	}	322	}
259	}	323	}
260		324
		325	sub lock_active($) {
		326	my ($key) = @_;
		327
		328	! ! $LOCK{$key}
		329	}
		330
261	sub freeze_mainloop {	331	sub freeze_mainloop {
262	return unless $TICK_WATCHER->is_active;	332	return unless $TICK_WATCHER->is_active;
263		333
264	my $guard = Coro::guard {	334	my $guard = Coro::guard {
265	$TICK_WATCHER->start;	335	$TICK_WATCHER->start;
266	$WRITE_RUNTIME_WATCHER->start;
267	};	336	};
268	$WRITE_RUNTIME_WATCHER->stop;
269	$TICK_WATCHER->stop;	337	$TICK_WATCHER->stop;
270	$guard	338	$guard
		339	}
		340
		341	=item cf::periodic $interval, $cb
		342
		343	Like EV::periodic, but randomly selects a starting point so that the actions
		344	get spread over timer.
		345
		346	=cut
		347
		348	sub periodic($$) {
		349	my ($interval, $cb) = @_;
		350
		351	my $start = rand List::Util::min 180, $interval;
		352
		353	EV::periodic $start, $interval, 0, $cb
		354	}
		355
		356	=item cf::get_slot $time[, $priority[, $name]]
		357
		358	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		359	This call blocks and returns only when you have at least C<$time> seconds
		360	of cpu time till the next tick. The slot is only valid till the next cede.
		361
		362	The optional C<$name> can be used to identify the job to run. It might be
		363	used for statistical purposes and should identify the same time-class.
		364
		365	Useful for short background jobs.
		366
		367	=cut
		368
		369	our @SLOT_QUEUE;
		370	our $SLOT_QUEUE;
		371
		372	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		373	$SLOT_QUEUE = Coro::async {
		374	$Coro::current->desc ("timeslot manager");
		375
		376	my $signal = new Coro::Signal;
		377
		378	while () {
		379	next_job:
		380	my $avail = cf::till_tick;
		381	if ($avail > 0.01) {
		382	for (0 .. $#SLOT_QUEUE) {
		383	if ($SLOT_QUEUE[$_][0] < $avail) {
		384	my $job = splice @SLOT_QUEUE, $_, 1, ();
		385	$job->[2]->send;
		386	Coro::cede;
		387	goto next_job;
		388	}
		389	}
		390	}
		391
		392	if (@SLOT_QUEUE) {
		393	# we do not use wait_for_tick() as it returns immediately when tick is inactive
		394	push @cf::WAIT_FOR_TICK, $signal;
		395	$signal->wait;
		396	} else {
		397	Coro::schedule;
		398	}
		399	}
		400	};
		401
		402	sub get_slot($;$$) {
		403	my ($time, $pri, $name) = @_;
		404
		405	$time = $TICK * .6 if $time > $TICK * .6;
		406	my $sig = new Coro::Signal;
		407
		408	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		409	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		410	$SLOT_QUEUE->ready;
		411	$sig->wait;
271	}	412	}
272		413
273	=item cf::async { BLOCK }	414	=item cf::async { BLOCK }
274		415
275	Currently the same as Coro::async_pool, meaning you cannot use	416	Currently the same as Coro::async_pool, meaning you cannot use
…		…
280		421
281	BEGIN { *async = \&Coro::async_pool }	422	BEGIN { *async = \&Coro::async_pool }
282		423
283	=item cf::sync_job { BLOCK }	424	=item cf::sync_job { BLOCK }
284		425
285	The design of crossfire+ requires that the main coro ($Coro::main) is	426	The design of Deliantra requires that the main coroutine ($Coro::main)
286	always able to handle events or runnable, as crossfire+ is only partly	427	is always able to handle events or runnable, as Deliantra is only
287	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	428	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		429	acceptable.
288		430
289	If it must be done, put the blocking parts into C<sync_job>. This will run	431	If it must be done, put the blocking parts into C<sync_job>. This will run
290	the given BLOCK in another coroutine while waiting for the result. The	432	the given BLOCK in another coroutine while waiting for the result. The
291	server will be frozen during this time, so the block should either finish	433	server will be frozen during this time, so the block should either finish
292	fast or be very important.	434	fast or be very important.
…		…
295		437
296	sub sync_job(&) {	438	sub sync_job(&) {
297	my ($job) = @_;	439	my ($job) = @_;
298		440
299	if ($Coro::current == $Coro::main) {	441	if ($Coro::current == $Coro::main) {
		442	my $time = EV::time;
		443
300	# this is the main coro, too bad, we have to block	444	# this is the main coro, too bad, we have to block
301	# till the operation succeeds, freezing the server :/	445	# till the operation succeeds, freezing the server :/
302		446
		447	LOG llevError, Carp::longmess "sync job";#d#
		448
303	# TODO: use suspend/resume instead	449	# TODO: use suspend/resume instead
304	# (but this is cancel-safe)	450	# (but this is cancel-safe)
305	my $freeze_guard = freeze_mainloop;	451	my $freeze_guard = freeze_mainloop;
306		452
307	my $busy = 1;	453	my $busy = 1;
308	my @res;	454	my @res;
309		455
310	(async {	456	(async {
		457	$Coro::current->desc ("sync job coro");
311	@res = eval { $job->() };	458	@res = eval { $job->() };
312	warn $@ if $@;	459	warn $@ if $@;
313	undef $busy;	460	undef $busy;
314	})->prio (Coro::PRIO_MAX);	461	})->prio (Coro::PRIO_MAX);
315		462
316	while ($busy) {	463	while ($busy) {
317	Coro::cede or Event::one_event;	464	if (Coro::nready) {
		465	Coro::cede_notself;
		466	} else {
		467	EV::loop EV::LOOP_ONESHOT;
318	}	468	}
		469	}
		470
		471	$time = EV::time - $time;
		472
		473	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		474	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		475
		476	$tick_start += $time; # do not account sync jobs to server load
319		477
320	wantarray ? @res : $res[0]	478	wantarray ? @res : $res[0]
321	} else {	479	} else {
322	# we are in another coroutine, how wonderful, everything just works	480	# we are in another coroutine, how wonderful, everything just works
323		481
…		…
343	$EXT_CORO{$coro+0} = $coro;	501	$EXT_CORO{$coro+0} = $coro;
344		502
345	$coro	503	$coro
346	}	504	}
347		505
348	sub write_runtime {	506	=item fork_call { }, $args
349	my $runtime = cf::localdir . "/runtime";
350		507
351	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	508	Executes the given code block with the given arguments in a seperate
352	or return;	509	process, returning the results. Everything must be serialisable with
		510	Coro::Storable. May, of course, block. Note that the executed sub may
		511	never block itself or use any form of event handling.
353		512
354	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	513	=cut
355	(aio_write $fh, 0, (length $value), $value, 0) <= 0
356	and return;
357		514
358	aio_fsync $fh	515	sub fork_call(&@) {
359	and return;	516	my ($cb, @args) = @_;
360		517
361	close $fh	518	# we seemingly have to make a local copy of the whole thing,
362	or return;	519	# otherwise perl prematurely frees the stuff :/
		520	# TODO: investigate and fix (likely this will be rather laborious)
363		521
364	aio_rename "$runtime~", $runtime	522	my @res = Coro::Util::fork_eval {
365	and return;	523	reset_signals;
		524	&$cb
		525	}, @args;
366		526
		527	wantarray ? @res : $res[-1]
		528	}
		529
		530	=item $value = cf::db_get $family => $key
		531
		532	Returns a single value from the environment database.
		533
		534	=item cf::db_put $family => $key => $value
		535
		536	Stores the given C<$value> in the family. It can currently store binary
		537	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		538
		539	=item $db = cf::db_table "name"
		540
		541	Create and/or open a new database table. The string must not be "db" and must be unique
		542	within each server.
		543
		544	=cut
		545
		546	sub db_table($) {
		547	my ($name) = @_;
		548	my $db = BDB::db_create $DB_ENV;
		549
		550	eval {
		551	$db->set_flags (BDB::CHKSUM);
		552
		553	utf8::encode $name;
		554	BDB::db_open $db, undef, $name, undef, BDB::BTREE,
		555	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		556	cf::cleanup "db_open(db): $!" if $!;
		557	};
		558	cf::cleanup "db_open(db): $@" if $@;
		559
		560	$db
		561	}
		562
		563	our $DB;
		564
		565	sub db_init {
		566	cf::sync_job {
		567	$DB ||= db_table "db";
		568	};
		569	}
		570
		571	sub db_get($$) {
		572	my $key = "$_[0]/$_[1]";
		573
		574	cf::sync_job {
		575	BDB::db_get $DB, undef, $key, my $data;
		576
		577	$! ? ()
		578	: $data
367	1	579	}
		580	}
		581
		582	sub db_put($$$) {
		583	BDB::dbreq_pri 4;
		584	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		585	}
		586
		587	=item cf::cache $id => [$paths...], $processversion => $process
		588
		589	Generic caching function that returns the value of the resource $id,
		590	caching and regenerating as required.
		591
		592	This function can block.
		593
		594	=cut
		595
		596	sub cache {
		597	my ($id, $src, $processversion, $process) = @_;
		598
		599	my $meta =
		600	join "\x00",
		601	$processversion,
		602	map {
		603	aio_stat $_
		604	and Carp::croak "$_: $!";
		605
		606	($_, (stat _)[7,9])
		607	} @$src;
		608
		609	my $dbmeta = db_get cache => "$id/meta";
		610	if ($dbmeta ne $meta) {
		611	# changed, we may need to process
		612
		613	my @data;
		614	my $md5;
		615
		616	for (0 .. $#$src) {
		617	0 <= aio_load $src->[$_], $data[$_]
		618	or Carp::croak "$src->[$_]: $!";
		619	}
		620
		621	# if processing is expensive, check
		622	# checksum first
		623	if (1) {
		624	$md5 =
		625	join "\x00",
		626	$processversion,
		627	map {
		628	cf::cede_to_tick;
		629	($src->[$_], Digest::MD5::md5_hex $data[$_])
		630	} 0.. $#$src;
		631
		632
		633	my $dbmd5 = db_get cache => "$id/md5";
		634	if ($dbmd5 eq $md5) {
		635	db_put cache => "$id/meta", $meta;
		636
		637	return db_get cache => "$id/data";
		638	}
		639	}
		640
		641	my $t1 = Time::HiRes::time;
		642	my $data = $process->(\@data);
		643	my $t2 = Time::HiRes::time;
		644
		645	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		646
		647	db_put cache => "$id/data", $data;
		648	db_put cache => "$id/md5" , $md5;
		649	db_put cache => "$id/meta", $meta;
		650
		651	return $data;
		652	}
		653
		654	db_get cache => "$id/data"
		655	}
		656
		657	=item cf::datalog type => key => value, ...
		658
		659	Log a datalog packet of the given type with the given key-value pairs.
		660
		661	=cut
		662
		663	sub datalog($@) {
		664	my ($type, %kv) = @_;
		665	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
368	}	666	}
369		667
370	=back	668	=back
371		669
372	=cut	670	=cut
…		…
379	attach callbacks/event handlers (a collection of which is called an "attachment")	677	attach callbacks/event handlers (a collection of which is called an "attachment")
380	to it. All such attachable objects support the following methods.	678	to it. All such attachable objects support the following methods.
381		679
382	In the following description, CLASS can be any of C<global>, C<object>	680	In the following description, CLASS can be any of C<global>, C<object>
383	C<player>, C<client> or C<map> (i.e. the attachable objects in	681	C<player>, C<client> or C<map> (i.e. the attachable objects in
384	crossfire+).	682	Deliantra).
385		683
386	=over 4	684	=over 4
387		685
388	=item $attachable->attach ($attachment, key => $value...)	686	=item $attachable->attach ($attachment, key => $value...)
389		687
…		…
552	$registry = $CB_TYPE[$object_type] ||= [];	850	$registry = $CB_TYPE[$object_type] ||= [];
553		851
554	} elsif ($type eq "subtype") {	852	} elsif ($type eq "subtype") {
555	defined $object_type or Carp::croak "subtype specified without type";	853	defined $object_type or Carp::croak "subtype specified without type";
556	my $object_subtype = shift @arg;	854	my $object_subtype = shift @arg;
557	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	855	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
558		856
559	} elsif ($type eq "package") {	857	} elsif ($type eq "package") {
560	my $pkg = shift @arg;	858	my $pkg = shift @arg;
561		859
562	while (my ($name, $id) = each %cb_id) {	860	while (my ($name, $id) = each %cb_id) {
…		…
591	_attach $registry, $klass, @attach;	889	_attach $registry, $klass, @attach;
592	}	890	}
593		891
594	$obj->{$name} = \%arg;	892	$obj->{$name} = \%arg;
595	} else {	893	} else {
596	warn "object uses attachment '$name' that is not available, postponing.\n";	894	warn "object uses attachment '$name' which is not available, postponing.\n";
597	}	895	}
598		896
599	$obj->{_attachment}{$name} = undef;	897	$obj->{_attachment}{$name} = undef;
600	}	898	}
601		899
…		…
603	if (ref $_[0]) {	901	if (ref $_[0]) {
604	_object_attach @_;	902	_object_attach @_;
605	} else {	903	} else {
606	_attach shift->_attach_registry, @_;	904	_attach shift->_attach_registry, @_;
607	}	905	}
		906	_recalc_want;
608	};	907	};
609		908
610	# all those should be optimised	909	# all those should be optimised
611	sub cf::attachable::detach {	910	sub cf::attachable::detach {
612	my ($obj, $name) = @_;	911	my ($obj, $name) = @_;
…		…
615	delete $obj->{_attachment}{$name};	914	delete $obj->{_attachment}{$name};
616	reattach ($obj);	915	reattach ($obj);
617	} else {	916	} else {
618	Carp::croak "cannot, currently, detach class attachments";	917	Carp::croak "cannot, currently, detach class attachments";
619	}	918	}
		919	_recalc_want;
620	};	920	};
621		921
622	sub cf::attachable::attached {	922	sub cf::attachable::attached {
623	my ($obj, $name) = @_;	923	my ($obj, $name) = @_;
624		924
…		…
639	";	939	";
640	die if $@;	940	die if $@;
641	}	941	}
642		942
643	our $override;	943	our $override;
644	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	944	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
645		945
646	sub override {	946	sub override {
647	$override = 1;	947	$override = 1;
648	@invoke_results = ();	948	@INVOKE_RESULTS = (@_);
649	}	949	}
650		950
651	sub do_invoke {	951	sub do_invoke {
652	my $event = shift;	952	my $event = shift;
653	my $callbacks = shift;	953	my $callbacks = shift;
654		954
655	@invoke_results = ();	955	@INVOKE_RESULTS = ();
656		956
657	local $override;	957	local $override;
658		958
659	for (@$callbacks) {	959	for (@$callbacks) {
660	eval { &{$_->[1]} };	960	eval { &{$_->[1]} };
…		…
677		977
678	Generate an object-specific event with the given arguments.	978	Generate an object-specific event with the given arguments.
679		979
680	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	980	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
681	removed in future versions), and there is no public API to access override	981	removed in future versions), and there is no public API to access override
682	results (if you must, access C<@cf::invoke_results> directly).	982	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
683		983
684	=back	984	=back
685		985
686	=cut	986	=cut
687		987
688	#############################################################################	988	#############################################################################
689	# object support	989	# object support
		990
		991	sub _object_equal($$);
		992	sub _object_equal($$) {
		993	my ($a, $b) = @_;
		994
		995	return 0 unless (ref $a) eq (ref $b);
		996
		997	if ("HASH" eq ref $a) {
		998	my @ka = keys %$a;
		999	my @kb = keys %$b;
		1000
		1001	return 0 if @ka != @kb;
		1002
		1003	for (0 .. $#ka) {
		1004	return 0 unless $ka[$_] eq $kb[$_];
		1005	return 0 unless _object_equal $a->{$ka[$_]}, $b->{$kb[$_]};
		1006	}
		1007
		1008	} elsif ("ARRAY" eq ref $a) {
		1009
		1010	return 0 if @$a != @$b;
		1011
		1012	for (0 .. $#$a) {
		1013	return 0 unless _object_equal $a->[$_], $b->[$_];
		1014	}
		1015
		1016	} elsif ($a ne $b) {
		1017	return 0;
		1018	}
		1019
		1020	1
		1021	}
		1022
		1023	our $SLOW_MERGES;#d#
		1024	sub _can_merge {
		1025	my ($ob1, $ob2) = @_;
		1026
		1027	++$SLOW_MERGES;#d#
		1028
		1029	# we do the slow way here
		1030	return _object_equal $ob1, $ob2
		1031	}
690		1032
691	sub reattach {	1033	sub reattach {
692	# basically do the same as instantiate, without calling instantiate	1034	# basically do the same as instantiate, without calling instantiate
693	my ($obj) = @_;	1035	my ($obj) = @_;
694		1036
…		…
715	cf::attachable->attach (	1057	cf::attachable->attach (
716	prio => -1000000,	1058	prio => -1000000,
717	on_instantiate => sub {	1059	on_instantiate => sub {
718	my ($obj, $data) = @_;	1060	my ($obj, $data) = @_;
719		1061
720	$data = from_json $data;	1062	$data = decode_json $data;
721		1063
722	for (@$data) {	1064	for (@$data) {
723	my ($name, $args) = @$_;	1065	my ($name, $args) = @$_;
724		1066
725	$obj->attach ($name, %{$args || {} });	1067	$obj->attach ($name, %{$args || {} });
…		…
741	sub object_freezer_save {	1083	sub object_freezer_save {
742	my ($filename, $rdata, $objs) = @_;	1084	my ($filename, $rdata, $objs) = @_;
743		1085
744	sync_job {	1086	sync_job {
745	if (length $$rdata) {	1087	if (length $$rdata) {
		1088	utf8::decode (my $decname = $filename);
746	warn sprintf "saving %s (%d,%d)\n",	1089	warn sprintf "saving %s (%d,%d)\n",
747	$filename, length $$rdata, scalar @$objs;	1090	$decname, length $$rdata, scalar @$objs;
748		1091
749	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1092	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
750	chmod SAVE_MODE, $fh;	1093	chmod SAVE_MODE, $fh;
751	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1094	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
752	aio_fsync $fh;	1095	aio_fsync $fh if $cf::USE_FSYNC;
753	close $fh;	1096	close $fh;
754		1097
755	if (@$objs) {	1098	if (@$objs) {
756	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	1099	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
757	chmod SAVE_MODE, $fh;	1100	chmod SAVE_MODE, $fh;
758	my $data = Storable::nfreeze { version => 1, objs => $objs };	1101	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
759	aio_write $fh, 0, (length $data), $data, 0;	1102	aio_write $fh, 0, (length $data), $data, 0;
760	aio_fsync $fh;	1103	aio_fsync $fh if $cf::USE_FSYNC;
761	close $fh;	1104	close $fh;
762	aio_rename "$filename.pst~", "$filename.pst";	1105	aio_rename "$filename.pst~", "$filename.pst";
763	}	1106	}
764	} else {	1107	} else {
765	aio_unlink "$filename.pst";	1108	aio_unlink "$filename.pst";
…		…
771	}	1114	}
772	} else {	1115	} else {
773	aio_unlink $filename;	1116	aio_unlink $filename;
774	aio_unlink "$filename.pst";	1117	aio_unlink "$filename.pst";
775	}	1118	}
776	}	1119	};
777	}	1120	}
778		1121
779	sub object_freezer_as_string {	1122	sub object_freezer_as_string {
780	my ($rdata, $objs) = @_;	1123	my ($rdata, $objs) = @_;
781		1124
…		…
793	or return;	1136	or return;
794		1137
795	unless (aio_stat "$filename.pst") {	1138	unless (aio_stat "$filename.pst") {
796	(aio_load "$filename.pst", $av) >= 0	1139	(aio_load "$filename.pst", $av) >= 0
797	or return;	1140	or return;
		1141
798	$av = eval { (Storable::thaw $av)->{objs} };	1142	my $st = eval { Coro::Storable::thaw $av };
		1143	$av = $st->{objs};
799	}	1144	}
800		1145
		1146	utf8::decode (my $decname = $filename);
801	warn sprintf "loading %s (%d)\n",	1147	warn sprintf "loading %s (%d,%d)\n",
802	$filename, length $data, scalar @{$av || []};#d#	1148	$decname, length $data, scalar @{$av || []};
		1149
803	return ($data, $av);	1150	($data, $av)
804	}	1151	}
		1152
		1153	=head2 COMMAND CALLBACKS
		1154
		1155	=over 4
		1156
		1157	=cut
805		1158
806	#############################################################################	1159	#############################################################################
807	# command handling &c	1160	# command handling &c
808		1161
809	=item cf::register_command $name => \&callback($ob,$args);	1162	=item cf::register_command $name => \&callback($ob,$args);
…		…
822	push @{ $COMMAND{$name} }, [$caller, $cb];	1175	push @{ $COMMAND{$name} }, [$caller, $cb];
823	}	1176	}
824		1177
825	=item cf::register_extcmd $name => \&callback($pl,$packet);	1178	=item cf::register_extcmd $name => \&callback($pl,$packet);
826		1179
827	Register a callbackf ro execution when the client sends an extcmd packet.	1180	Register a callback for execution when the client sends an (synchronous)
		1181	extcmd packet. Ext commands will be processed in the order they are
		1182	received by the server, like other user commands. The first argument is
		1183	the logged-in player. Ext commands can only be processed after a player
		1184	has logged in successfully.
828		1185
829	If the callback returns something, it is sent back as if reply was being	1186	If the callback returns something, it is sent back as if reply was being
830	called.	1187	called.
831		1188
		1189	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1190
		1191	Register a callback for execution when the client sends an (asynchronous)
		1192	exticmd packet. Exti commands are processed by the server as soon as they
		1193	are received, i.e. out of order w.r.t. other commands. The first argument
		1194	is a client socket. Exti commands can be received anytime, even before
		1195	log-in.
		1196
		1197	If the callback returns something, it is sent back as if reply was being
		1198	called.
		1199
832	=cut	1200	=cut
833		1201
834	sub register_extcmd {	1202	sub register_extcmd {
835	my ($name, $cb) = @_;	1203	my ($name, $cb) = @_;
836		1204
837	$EXTCMD{$name} = $cb;	1205	$EXTCMD{$name} = $cb;
		1206	}
		1207
		1208	sub register_exticmd {
		1209	my ($name, $cb) = @_;
		1210
		1211	$EXTICMD{$name} = $cb;
838	}	1212	}
839		1213
840	cf::player->attach (	1214	cf::player->attach (
841	on_command => sub {	1215	on_command => sub {
842	my ($pl, $name, $params) = @_;	1216	my ($pl, $name, $params) = @_;
…		…
851	cf::override;	1225	cf::override;
852	},	1226	},
853	on_extcmd => sub {	1227	on_extcmd => sub {
854	my ($pl, $buf) = @_;	1228	my ($pl, $buf) = @_;
855		1229
856	my $msg = eval { from_json $buf };	1230	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
857		1231
858	if (ref $msg) {	1232	if (ref $msg) {
		1233	my ($type, $reply, @payload) =
		1234	"ARRAY" eq ref $msg
		1235	? @$msg
		1236	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1237
		1238	my @reply;
		1239
859	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1240	if (my $cb = $EXTCMD{$type}) {
860	if (my %reply = $cb->($pl, $msg)) {	1241	@reply = $cb->($pl, @payload);
861	$pl->ext_reply ($msg->{msgid}, %reply);
862	}
863	}	1242	}
		1243
		1244	$pl->ext_reply ($reply, @reply)
		1245	if $reply;
		1246
864	} else {	1247	} else {
865	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1248	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
866	}	1249	}
867		1250
868	cf::override;	1251	cf::override;
869	},	1252	},
870	);	1253	);
871		1254
872	sub load_extension {
873	my ($path) = @_;
874
875	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
876	my $base = $1;
877	my $pkg = $1;
878	$pkg =~ s/[^[:word:]]/_/g;
879	$pkg = "ext::$pkg";
880
881	warn "... loading '$path' into '$pkg'\n";
882
883	open my $fh, "<:utf8", $path
884	or die "$path: $!";
885
886	my $source =
887	"package $pkg; use strict; use utf8;\n"
888	. "#line 1 \"$path\"\n{\n"
889	. (do { local $/; <$fh> })
890	. "\n};\n1";
891
892	unless (eval $source) {
893	my $msg = $@ ? "$path: $@\n"
894	: "extension disabled.\n";
895	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
896	warn $@;
897	warn "mandatory extension failed to load, exiting.\n";
898	exit 1;
899	}
900	die $@;
901	}
902
903	push @EXTS, $pkg;
904	}
905
906	sub load_extensions {	1255	sub load_extensions {
		1256	cf::sync_job {
		1257	my %todo;
		1258
907	for my $ext (<$LIBDIR/*.ext>) {	1259	for my $path (<$LIBDIR/*.ext>) {
908	next unless -r $ext;	1260	next unless -r $path;
909	eval {	1261
910	load_extension $ext;	1262	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1263	my $base = $1;
		1264	my $pkg = $1;
		1265	$pkg =~ s/[^[:word:]]/_/g;
		1266	$pkg = "ext::$pkg";
		1267
		1268	open my $fh, "<:utf8", $path
		1269	or die "$path: $!";
		1270
		1271	my $source = do { local $/; <$fh> };
		1272
		1273	my %ext = (
		1274	path => $path,
		1275	base => $base,
		1276	pkg => $pkg,
		1277	);
		1278
		1279	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1280	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1281
		1282	$ext{source} =
		1283	"package $pkg; use strict; use utf8;\n"
		1284	. "#line 1 \"$path\"\n{\n"
		1285	. $source
		1286	. "\n};\n1";
		1287
		1288	$todo{$base} = \%ext;
		1289	}
		1290
		1291	my %done;
		1292	while (%todo) {
		1293	my $progress;
		1294
		1295	while (my ($k, $v) = each %todo) {
		1296	for (split /,\s*/, $v->{meta}{depends}) {
		1297	goto skip
		1298	unless exists $done{$_};
		1299	}
		1300
		1301	warn "... loading '$k' into '$v->{pkg}'\n";
		1302
		1303	unless (eval $v->{source}) {
		1304	my $msg = $@ ? "$v->{path}: $@\n"
		1305	: "$v->{base}: extension inactive.\n";
		1306
		1307	if (exists $v->{meta}{mandatory}) {
		1308	warn $msg;
		1309	warn "mandatory extension failed to load, exiting.\n";
		1310	exit 1;
		1311	}
		1312
		1313	warn $msg;
		1314	}
		1315
		1316	$done{$k} = delete $todo{$k};
		1317	push @EXTS, $v->{pkg};
		1318	$progress = 1;
911	1	1319	}
912	} or warn "$ext not loaded: $@";	1320
		1321	skip:
		1322	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1323	unless $progress;
		1324	}
913	}	1325	};
914	}	1326	}
915		1327
916	#############################################################################	1328	#############################################################################
917		1329
		1330	=back
		1331
918	=head2 CORE EXTENSIONS	1332	=head2 CORE EXTENSIONS
919		1333
920	Functions and methods that extend core crossfire objects.	1334	Functions and methods that extend core crossfire objects.
921		1335
922	=cut	1336	=cut
…		…
927		1341
928	=head3 cf::player	1342	=head3 cf::player
929		1343
930	=over 4	1344	=over 4
931		1345
		1346	=item cf::player::num_playing
		1347
		1348	Returns the official number of playing players, as per the Crossfire metaserver rules.
		1349
		1350	=cut
		1351
		1352	sub num_playing {
		1353	scalar grep
		1354	$_->ob->map
		1355	&& !$_->hidden
		1356	&& !$_->ob->flag (cf::FLAG_WIZ),
		1357	cf::player::list
		1358	}
		1359
932	=item cf::player::find $login	1360	=item cf::player::find $login
933		1361
934	Returns the given player object, loading it if necessary (might block).	1362	Returns the given player object, loading it if necessary (might block).
935		1363
936	=cut	1364	=cut
937		1365
938	sub playerdir($) {	1366	sub playerdir($) {
939	cf::localdir	1367	"$PLAYERDIR/"
940	. "/"
941	. cf::playerdir
942	. "/"
943	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1368	. (ref $_[0] ? $_[0]->ob->name : $_[0])
944	}	1369	}
945		1370
946	sub path($) {	1371	sub path($) {
947	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1372	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
948		1373
949	(playerdir $login) . "/$login.pl"	1374	(playerdir $login) . "/playerdata"
950	}	1375	}
951		1376
952	sub find_active($) {	1377	sub find_active($) {
953	$cf::PLAYER{$_[0]}	1378	$cf::PLAYER{$_[0]}
954	and $cf::PLAYER{$_[0]}->active	1379	and $cf::PLAYER{$_[0]}->active
…		…
967	my $login = $_[0];	1392	my $login = $_[0];
968		1393
969	my $guard = cf::lock_acquire "user_find:$login";	1394	my $guard = cf::lock_acquire "user_find:$login";
970		1395
971	$cf::PLAYER{$_[0]} || do {	1396	$cf::PLAYER{$_[0]} || do {
972	my $pl = load_pl path $login	1397	# rename old playerfiles to new ones
		1398	#TODO: remove when no longer required
		1399	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1400	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1401	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1402	aio_unlink +(playerdir $login) . "/$login.pl";
		1403
		1404	my $f = new_from_file cf::object::thawer path $login
973	or return;	1405	or return;
		1406
		1407	my $pl = cf::player::load_pl $f
		1408	or return;
		1409	local $cf::PLAYER_LOADING{$login} = $pl;
		1410	$f->resolve_delayed_derefs;
974	$cf::PLAYER{$login} = $pl	1411	$cf::PLAYER{$login} = $pl
975	}	1412	}
976	}	1413	}
977	}	1414	}
978		1415
…		…
988		1425
989	aio_mkdir playerdir $pl, 0770;	1426	aio_mkdir playerdir $pl, 0770;
990	$pl->{last_save} = $cf::RUNTIME;	1427	$pl->{last_save} = $cf::RUNTIME;
991		1428
992	$pl->save_pl ($path);	1429	$pl->save_pl ($path);
993	Coro::cede;	1430	cf::cede_to_tick;
994	}	1431	}
995		1432
996	sub new($) {	1433	sub new($) {
997	my ($login) = @_;	1434	my ($login) = @_;
998		1435
…		…
1004	$cf::PLAYER{$login} = $self;	1441	$cf::PLAYER{$login} = $self;
1005		1442
1006	$self	1443	$self
1007	}	1444	}
1008		1445
		1446	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1447
		1448	=cut
		1449
		1450	sub send_msg {
		1451	my $ns = shift->ns
		1452	or return;
		1453	$ns->send_msg (@_);
		1454	}
		1455
1009	=item $pl->quit_character	1456	=item $pl->quit_character
1010		1457
1011	Nukes the player without looking back. If logged in, the connection will	1458	Nukes the player without looking back. If logged in, the connection will
1012	be destroyed. May block for a long time.	1459	be destroyed. May block for a long time.
1013		1460
1014	=cut	1461	=cut
1015		1462
1016	sub quit_character {	1463	sub quit_character {
1017	my ($pl) = @_;	1464	my ($pl) = @_;
		1465
		1466	my $name = $pl->ob->name;
1018		1467
1019	$pl->{deny_save} = 1;	1468	$pl->{deny_save} = 1;
1020	$pl->password ("*"); # this should lock out the player until we nuked the dir	1469	$pl->password ("*"); # this should lock out the player until we nuked the dir
1021		1470
1022	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1471	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1027	my $path = playerdir $pl;	1476	my $path = playerdir $pl;
1028	my $temp = "$path~$cf::RUNTIME~deleting~";	1477	my $temp = "$path~$cf::RUNTIME~deleting~";
1029	aio_rename $path, $temp;	1478	aio_rename $path, $temp;
1030	delete $cf::PLAYER{$pl->ob->name};	1479	delete $cf::PLAYER{$pl->ob->name};
1031	$pl->destroy;	1480	$pl->destroy;
		1481
		1482	my $prefix = qr<^~\Q$name\E/>;
		1483
		1484	# nuke player maps
		1485	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1486
1032	IO::AIO::aio_rmtree $temp;	1487	IO::AIO::aio_rmtree $temp;
		1488	}
		1489
		1490	=item $pl->kick
		1491
		1492	Kicks a player out of the game. This destroys the connection.
		1493
		1494	=cut
		1495
		1496	sub kick {
		1497	my ($pl, $kicker) = @_;
		1498
		1499	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1500	$pl->killer ("kicked");
		1501	$pl->ns->destroy;
1033	}	1502	}
1034		1503
1035	=item cf::player::list_logins	1504	=item cf::player::list_logins
1036		1505
1037	Returns am arrayref of all valid playernames in the system, can take a	1506	Returns am arrayref of all valid playernames in the system, can take a
1038	while and may block, so not sync_job-capable, ever.	1507	while and may block, so not sync_job-capable, ever.
1039		1508
1040	=cut	1509	=cut
1041		1510
1042	sub list_logins {	1511	sub list_logins {
1043	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1512	my $dirs = aio_readdir $PLAYERDIR
1044	or return [];	1513	or return [];
1045		1514
1046	my @logins;	1515	my @logins;
1047		1516
1048	for my $login (@$dirs) {	1517	for my $login (@$dirs) {
		1518	my $path = path $login;
		1519
		1520	# a .pst is a dead give-away for a valid player
		1521	unless (-e "$path.pst") {
1049	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1522	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1050	aio_read $fh, 0, 512, my $buf, 0 or next;	1523	aio_read $fh, 0, 512, my $buf, 0 or next;
1051	$buf !~ /^password -------------$/m or next; # official not-valid tag	1524	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1525	}
1052		1526
1053	utf8::decode $login;	1527	utf8::decode $login;
1054	push @logins, $login;	1528	push @logins, $login;
1055	}	1529	}
1056		1530
…		…
1064		1538
1065	=cut	1539	=cut
1066		1540
1067	sub maps($) {	1541	sub maps($) {
1068	my ($pl) = @_;	1542	my ($pl) = @_;
		1543
		1544	$pl = ref $pl ? $pl->ob->name : $pl;
1069		1545
1070	my $files = aio_readdir playerdir $pl	1546	my $files = aio_readdir playerdir $pl
1071	or return;	1547	or return;
1072		1548
1073	my @paths;	1549	my @paths;
…		…
1075	for (@$files) {	1551	for (@$files) {
1076	utf8::decode $_;	1552	utf8::decode $_;
1077	next if /\.(?:pl|pst)$/;	1553	next if /\.(?:pl|pst)$/;
1078	next unless /^$PATH_SEP/o;	1554	next unless /^$PATH_SEP/o;
1079		1555
1080	s/\.map$//;	1556	push @paths, cf::map::normalise "~$pl/$_";
1081	push @paths, "~" . $pl->ob->name . "/" . $_;
1082	}	1557	}
1083		1558
1084	\@paths	1559	\@paths
1085	}	1560	}
1086		1561
		1562	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1563
		1564	Expand crossfire pod fragments into protocol xml.
		1565
		1566	=cut
		1567
		1568	use re 'eval';
		1569
		1570	my $group;
		1571	my $interior; $interior = qr{
		1572	# match a pod interior sequence sans C<< >>
		1573	(?:
		1574	\ (.*?)\ (?{ $group = $^N })
		1575	| < (??{$interior}) >
		1576	)
		1577	}x;
		1578
		1579	sub expand_cfpod {
		1580	my ($self, $pod) = @_;
		1581
		1582	my $xml;
		1583
		1584	while () {
		1585	if ($pod =~ /\G( (?: [^BCGHITU]+ | .(?!<) )+ )/xgcs) {
		1586	$group = $1;
		1587
		1588	$group =~ s/&/&amp;/g;
		1589	$group =~ s/</&lt;/g;
		1590
		1591	$xml .= $group;
		1592	} elsif ($pod =~ m%\G
		1593	([BCGHITU])
		1594	<
		1595	(?:
		1596	([^<>]*) (?{ $group = $^N })
		1597	| < $interior >
		1598	)
		1599	>
		1600	%gcsx
		1601	) {
		1602	my ($code, $data) = ($1, $group);
		1603
		1604	if ($code eq "B") {
		1605	$xml .= "<b>" . expand_cfpod ($self, $data) . "</b>";
		1606	} elsif ($code eq "I") {
		1607	$xml .= "<i>" . expand_cfpod ($self, $data) . "</i>";
		1608	} elsif ($code eq "U") {
		1609	$xml .= "<u>" . expand_cfpod ($self, $data) . "</u>";
		1610	} elsif ($code eq "C") {
		1611	$xml .= "<tt>" . expand_cfpod ($self, $data) . "</tt>";
		1612	} elsif ($code eq "T") {
		1613	$xml .= "<big><b>" . expand_cfpod ($self, $data) . "</b></big>";
		1614	} elsif ($code eq "G") {
		1615	my ($male, $female) = split /\|/, $data;
		1616	$data = $self->gender ? $female : $male;
		1617	$xml .= expand_cfpod ($self, $data);
		1618	} elsif ($code eq "H") {
		1619	$xml .= ("<fg name=\"lightblue\">[" . expand_cfpod ($self, $data) . " (Use hintmode to suppress hints)]</fg>",
		1620	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1621	"")
		1622	[$self->{hintmode}];
		1623	} else {
		1624	$xml .= "error processing '$code($data)' directive";
		1625	}
		1626	} else {
		1627	if ($pod =~ /\G(.+)/) {
		1628	warn "parse error while expanding $pod (at $1)";
		1629	}
		1630	last;
		1631	}
		1632	}
		1633
		1634	for ($xml) {
		1635	# create single paragraphs (very hackish)
		1636	s/(?<=\S)\n(?=\w)/ /g;
		1637
		1638	# compress some whitespace
		1639	s/\s+\n/\n/g; # ws line-ends
		1640	s/\n\n+/\n/g; # double lines
		1641	s/^\n+//; # beginning lines
		1642	s/\n+$//; # ending lines
		1643	}
		1644
		1645	$xml
		1646	}
		1647
		1648	no re 'eval';
		1649
		1650	sub hintmode {
		1651	$_[0]{hintmode} = $_[1] if @_ > 1;
		1652	$_[0]{hintmode}
		1653	}
		1654
1087	=item $player->ext_reply ($msgid, $msgtype, %msg)	1655	=item $player->ext_reply ($msgid, @msg)
1088		1656
1089	Sends an ext reply to the player.	1657	Sends an ext reply to the player.
1090		1658
1091	=cut	1659	=cut
1092		1660
1093	sub ext_reply($$$%) {	1661	sub ext_reply($$@) {
1094	my ($self, $id, %msg) = @_;	1662	my ($self, $id, @msg) = @_;
1095		1663
1096	$msg{msgid} = $id;	1664	$self->ns->ext_reply ($id, @msg)
1097
1098	$self->send ("ext " . cf::to_json \%msg);
1099	}	1665	}
1100		1666
1101	package cf;	1667	=item $player->ext_msg ($type, @msg)
		1668
		1669	Sends an ext event to the client.
		1670
		1671	=cut
		1672
		1673	sub ext_msg($$@) {
		1674	my ($self, $type, @msg) = @_;
		1675
		1676	$self->ns->ext_msg ($type, @msg);
		1677	}
		1678
		1679	=head3 cf::region
		1680
		1681	=over 4
		1682
		1683	=cut
		1684
		1685	package cf::region;
		1686
		1687	=item cf::region::find_by_path $path
		1688
		1689	Tries to decuce the likely region for a map knowing only its path.
		1690
		1691	=cut
		1692
		1693	sub find_by_path($) {
		1694	my ($path) = @_;
		1695
		1696	my ($match, $specificity);
		1697
		1698	for my $region (list) {
		1699	if ($region->{match} && $path =~ $region->{match}) {
		1700	($match, $specificity) = ($region, $region->specificity)
		1701	if $region->specificity > $specificity;
		1702	}
		1703	}
		1704
		1705	$match
		1706	}
1102		1707
1103	=back	1708	=back
1104
1105		1709
1106	=head3 cf::map	1710	=head3 cf::map
1107		1711
1108	=over 4	1712	=over 4
1109		1713
…		…
1137	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1741	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1138	(cf::region::find $rmp->{region}), $rmp->{custom}	1742	(cf::region::find $rmp->{region}), $rmp->{custom}
1139	)	1743	)
1140	}	1744	}
1141		1745
		1746	=item cf::map->register ($regex, $prio)
		1747
		1748	Register a handler for the map path matching the given regex at the
		1749	givne priority (higher is better, built-in handlers have priority 0, the
		1750	default).
		1751
		1752	=cut
		1753
1142	sub register {	1754	sub register {
1143	my (undef, $regex) = @_;	1755	my (undef, $regex, $prio) = @_;
1144	my $pkg = caller;	1756	my $pkg = caller;
1145		1757
1146	no strict;	1758	no strict;
1147	push @{"$pkg\::ISA"}, __PACKAGE__;	1759	push @{"$pkg\::ISA"}, __PACKAGE__;
1148		1760
1149	$EXT_MAP{$pkg} = qr<$regex>;	1761	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
1150	}	1762	}
1151		1763
1152	# also paths starting with '/'	1764	# also paths starting with '/'
1153	$EXT_MAP{"cf::map"} = qr{^(?=/)};	1765	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1154		1766
1155	sub thawer_merge {	1767	sub thawer_merge {
1156	my ($self, $merge) = @_;	1768	my ($self, $merge) = @_;
1157		1769
1158	# we have to keep some variables in memory intact	1770	# we have to keep some variables in memory intact
1159	local $self->{path};	1771	local $self->{path};
1160	local $self->{load_path};	1772	local $self->{load_path};
1161	local $self->{deny_save};
1162	local $self->{deny_reset};
1163		1773
1164	$self->SUPER::thawer_merge ($merge);	1774	$self->SUPER::thawer_merge ($merge);
1165	}	1775	}
1166		1776
1167	sub normalise {	1777	sub normalise {
1168	my ($path, $base) = @_;	1778	my ($path, $base) = @_;
		1779
		1780	$path = "$path"; # make sure its a string
		1781
		1782	$path =~ s/\.map$//;
1169		1783
1170	# map plan:	1784	# map plan:
1171	#	1785	#
1172	# /! non-realised random map exit (special hack!)	1786	# /! non-realised random map exit (special hack!)
1173	# {... are special paths that are not being touched	1787	# {... are special paths that are not being touched
…		…
1201		1815
1202	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object	1816	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1203		1817
1204	$path = normalise $path, $base;	1818	$path = normalise $path, $base;
1205		1819
1206	for my $pkg (keys %EXT_MAP) {	1820	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1207	if ($path =~ $EXT_MAP{$pkg}) {	1821	if ($path =~ $EXT_MAP{$pkg}[1]) {
1208	my $self = bless cf::map::new, $pkg;	1822	my $self = bless cf::map::new, $pkg;
1209	$self->{path} = $path; $self->path ($path);	1823	$self->{path} = $path; $self->path ($path);
1210	$self->init; # pass $1 etc.	1824	$self->init; # pass $1 etc.
1211	return $self;	1825	return $self;
1212	}	1826	}
1213	}	1827	}
1214		1828
1215	Carp::carp "unable to resolve path '$path'.";	1829	Carp::cluck "unable to resolve path '$path' (base '$base').";
1216	()	1830	()
1217	}	1831	}
1218		1832
1219	sub init {	1833	sub init {
1220	my ($self) = @_;	1834	my ($self) = @_;
…		…
1235		1849
1236	# the original (read-only) location	1850	# the original (read-only) location
1237	sub load_path {	1851	sub load_path {
1238	my ($self) = @_;	1852	my ($self) = @_;
1239		1853
1240	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1854	"$MAPDIR/$self->{path}.map"
1241	}	1855	}
1242		1856
1243	# the temporary/swap location	1857	# the temporary/swap location
1244	sub save_path {	1858	sub save_path {
1245	my ($self) = @_;	1859	my ($self) = @_;
1246		1860
1247	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1861	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1248	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	1862	"$TMPDIR/$path.map"
1249	}	1863	}
1250		1864
1251	# the unique path, undef == no special unique path	1865	# the unique path, undef == no special unique path
1252	sub uniq_path {	1866	sub uniq_path {
1253	my ($self) = @_;	1867	my ($self) = @_;
1254		1868
1255	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1869	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1256	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1870	"$UNIQUEDIR/$path"
1257	}	1871	}
1258		1872
1259	# and all this just because we cannot iterate over	1873	# and all this just because we cannot iterate over
1260	# all maps in C++...	1874	# all maps in C++...
1261	sub change_all_map_light {	1875	sub change_all_map_light {
…		…
1263		1877
1264	$_->change_map_light ($change)	1878	$_->change_map_light ($change)
1265	for grep $_->outdoor, values %cf::MAP;	1879	for grep $_->outdoor, values %cf::MAP;
1266	}	1880	}
1267		1881
		1882	sub decay_objects {
		1883	my ($self) = @_;
		1884
		1885	return if $self->{deny_reset};
		1886
		1887	$self->do_decay_objects;
		1888	}
		1889
1268	sub unlink_save {	1890	sub unlink_save {
1269	my ($self) = @_;	1891	my ($self) = @_;
1270		1892
1271	utf8::encode (my $save = $self->save_path);	1893	utf8::encode (my $save = $self->save_path);
1272	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1894	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
…		…
1275		1897
1276	sub load_header_from($) {	1898	sub load_header_from($) {
1277	my ($self, $path) = @_;	1899	my ($self, $path) = @_;
1278		1900
1279	utf8::encode $path;	1901	utf8::encode $path;
1280	aio_open $path, O_RDONLY, 0	1902	my $f = new_from_file cf::object::thawer $path
1281	or return;	1903	or return;
1282		1904
1283	$self->_load_header ($path)	1905	$self->_load_header ($f)
1284	or return;	1906	or return;
1285		1907
		1908	local $MAP_LOADING{$self->{path}} = $self;
		1909	$f->resolve_delayed_derefs;
		1910
1286	$self->{load_path} = $path;	1911	$self->{load_path} = $path;
1287		1912
1288	1	1913	1
1289	}	1914	}
1290		1915
1291	sub load_orig {	1916	sub load_header_orig {
1292	my ($self) = @_;	1917	my ($self) = @_;
1293		1918
1294	$self->load_header_from ($self->load_path)	1919	$self->load_header_from ($self->load_path)
1295	}	1920	}
1296		1921
1297	sub load_temp {	1922	sub load_header_temp {
1298	my ($self) = @_;	1923	my ($self) = @_;
1299		1924
1300	$self->load_header_from ($self->save_path)	1925	$self->load_header_from ($self->save_path)
		1926	}
		1927
		1928	sub prepare_temp {
		1929	my ($self) = @_;
		1930
		1931	$self->last_access ((delete $self->{last_access})
		1932	|| $cf::RUNTIME); #d#
		1933	# safety
		1934	$self->{instantiate_time} = $cf::RUNTIME
		1935	if $self->{instantiate_time} > $cf::RUNTIME;
		1936	}
		1937
		1938	sub prepare_orig {
		1939	my ($self) = @_;
		1940
		1941	$self->{load_original} = 1;
		1942	$self->{instantiate_time} = $cf::RUNTIME;
		1943	$self->last_access ($cf::RUNTIME);
		1944	$self->instantiate;
1301	}	1945	}
1302		1946
1303	sub load_header {	1947	sub load_header {
1304	my ($self) = @_;	1948	my ($self) = @_;
1305		1949
1306	if ($self->load_temp) {	1950	if ($self->load_header_temp) {
1307	$self->last_access ((delete $self->{last_access})	1951	$self->prepare_temp;
1308	|| $cf::RUNTIME); #d#
1309	# safety
1310	$self->{instantiate_time} = $cf::RUNTIME
1311	if $self->{instantiate_time} > $cf::RUNTIME;
1312	} else {	1952	} else {
1313	$self->load_orig	1953	$self->load_header_orig
1314	or return;	1954	or return;
1315		1955	$self->prepare_orig;
1316	$self->{load_original} = 1;
1317	$self->{instantiate_time} = $cf::RUNTIME;
1318	$self->last_access ($cf::RUNTIME);
1319	$self->instantiate;
1320	}	1956	}
		1957
		1958	$self->{deny_reset} = 1
		1959	if $self->no_reset;
		1960
		1961	$self->default_region (cf::region::find_by_path $self->{path})
		1962	unless $self->default_region;
1321		1963
1322	1	1964	1
1323	}	1965	}
1324		1966
1325	sub find;	1967	sub find;
1326	sub find {	1968	sub find {
1327	my ($path, $origin) = @_;	1969	my ($path, $origin) = @_;
1328		1970
1329	$path = normalise $path, $origin && $origin->path;	1971	$path = normalise $path, $origin && $origin->path;
1330		1972
		1973	cf::lock_wait "map_data:$path";#d#remove
1331	cf::lock_wait "map_find:$path";	1974	cf::lock_wait "map_find:$path";
1332		1975
1333	$cf::MAP{$path} || do {	1976	$cf::MAP{$path} || do {
1334	my $guard = cf::lock_acquire "map_find:$path";	1977	my $guard1 = cf::lock_acquire "map_find:$path";
		1978	my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
		1979
1335	my $map = new_from_path cf::map $path	1980	my $map = new_from_path cf::map $path
1336	or return;	1981	or return;
1337		1982
1338	$map->{last_save} = $cf::RUNTIME;	1983	$map->{last_save} = $cf::RUNTIME;
1339		1984
1340	$map->load_header	1985	$map->load_header
1341	or return;	1986	or return;
1342		1987
1343	if ($map->should_reset) {	1988	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1989	# doing this can freeze the server in a sync job, obviously
1344	$cf::WAIT_FOR_TICK->wait;	1990	#$cf::WAIT_FOR_TICK->wait;
		1991	undef $guard1;
		1992	undef $guard2;
1345	$map->reset;	1993	$map->reset;
1346	undef $guard;
1347	$map = find $path	1994	return find $path;
1348	or return;
1349	}	1995	}
1350		1996
1351	$cf::MAP{$path} = $map	1997	$cf::MAP{$path} = $map
1352	}	1998	}
1353	}	1999	}
		2000
		2001	sub pre_load { }
		2002	sub post_load { }
1354		2003
1355	sub load {	2004	sub load {
1356	my ($self) = @_;	2005	my ($self) = @_;
1357		2006
		2007	local $self->{deny_reset} = 1; # loading can take a long time
		2008
1358	my $path = $self->{path};	2009	my $path = $self->{path};
		2010
		2011	{
1359	my $guard = cf::lock_acquire "map_load:$path";	2012	my $guard = cf::lock_acquire "map_data:$path";
1360		2013
		2014	return unless $self->valid;
1361	return if $self->in_memory != cf::MAP_SWAPPED;	2015	return unless $self->in_memory == cf::MAP_SWAPPED;
1362		2016
1363	$self->in_memory (cf::MAP_LOADING);	2017	$self->in_memory (cf::MAP_LOADING);
1364		2018
1365	$self->alloc;	2019	$self->alloc;
1366	$self->_load_objects ($self->{load_path}, 1)	2020
		2021	$self->pre_load;
		2022	cf::cede_to_tick;
		2023
		2024	my $f = new_from_file cf::object::thawer $self->{load_path};
		2025	$f->skip_block;
		2026	$self->_load_objects ($f)
1367	or return;	2027	or return;
1368		2028
1369	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2029	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1370	if delete $self->{load_original};	2030	if delete $self->{load_original};
1371		2031
1372	if (my $uniq = $self->uniq_path) {	2032	if (my $uniq = $self->uniq_path) {
1373	utf8::encode $uniq;	2033	utf8::encode $uniq;
1374	if (aio_open $uniq, O_RDONLY, 0) {	2034	unless (aio_stat $uniq) {
		2035	if (my $f = new_from_file cf::object::thawer $uniq) {
1375	$self->clear_unique_items;	2036	$self->clear_unique_items;
1376	$self->_load_objects ($uniq, 0);	2037	$self->_load_objects ($f);
		2038	$f->resolve_delayed_derefs;
		2039	}
1377	}	2040	}
1378	}	2041	}
1379		2042
1380	Coro::cede;	2043	$f->resolve_delayed_derefs;
1381		2044
		2045	cf::cede_to_tick;
1382	# now do the right thing for maps	2046	# now do the right thing for maps
1383	$self->link_multipart_objects;	2047	$self->link_multipart_objects;
1384
1385	unless ($self->{deny_activate}) {
1386	$self->decay_objects;
1387	$self->fix_auto_apply;
1388	$self->update_buttons;
1389	Coro::cede;
1390	$self->set_darkness_map;
1391	$self->difficulty ($self->estimate_difficulty)	2048	$self->difficulty ($self->estimate_difficulty)
1392	unless $self->difficulty;	2049	unless $self->difficulty;
1393	Coro::cede;	2050	cf::cede_to_tick;
		2051
		2052	unless ($self->{deny_activate}) {
		2053	$self->decay_objects;
		2054	$self->fix_auto_apply;
		2055	$self->update_buttons;
		2056	cf::cede_to_tick;
		2057	$self->set_darkness_map;
		2058	cf::cede_to_tick;
1394	$self->activate;	2059	$self->activate;
1395	}	2060	}
1396		2061
		2062	$self->{last_save} = $cf::RUNTIME;
		2063	$self->last_access ($cf::RUNTIME);
		2064
1397	$self->in_memory (cf::MAP_IN_MEMORY);	2065	$self->in_memory (cf::MAP_IN_MEMORY);
		2066	}
		2067
		2068	$self->post_load;
1398	}	2069	}
1399		2070
1400	sub customise_for {	2071	sub customise_for {
1401	my ($self, $ob) = @_;	2072	my ($self, $ob) = @_;
1402		2073
1403	return find "~" . $ob->name . "/" . $self->{path}	2074	return find "~" . $ob->name . "/" . $self->{path}
1404	if $self->per_player;	2075	if $self->per_player;
1405		2076
		2077	# return find "?party/" . $ob->name . "/" . $self->{path}
		2078	# if $self->per_party;
		2079
1406	$self	2080	$self
1407	}	2081	}
1408		2082
1409	# find and load all maps in the 3x3 area around a map	2083	# find and load all maps in the 3x3 area around a map
1410	sub load_diag {	2084	sub load_neighbours {
1411	my ($map) = @_;	2085	my ($map) = @_;
1412		2086
1413	my @diag; # diagonal neighbours	2087	my @neigh; # diagonal neighbours
1414		2088
1415	for (0 .. 3) {	2089	for (0 .. 3) {
1416	my $neigh = $map->tile_path ($_)	2090	my $neigh = $map->tile_path ($_)
1417	or next;	2091	or next;
1418	$neigh = find $neigh, $map	2092	$neigh = find $neigh, $map
1419	or next;	2093	or next;
1420	$neigh->load;	2094	$neigh->load;
1421		2095
		2096	push @neigh,
1422	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2097	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1423	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2098	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1424	}	2099	}
1425		2100
1426	for (@diag) {	2101	for (grep defined $_->[0], @neigh) {
		2102	my ($path, $origin) = @$_;
1427	my $neigh = find @$_	2103	my $neigh = find $path, $origin
1428	or next;	2104	or next;
1429	$neigh->load;	2105	$neigh->load;
1430	}	2106	}
1431	}	2107	}
1432		2108
…		…
1437	}	2113	}
1438		2114
1439	sub do_load_sync {	2115	sub do_load_sync {
1440	my ($map) = @_;	2116	my ($map) = @_;
1441		2117
		2118	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2119	if $Coro::current == $Coro::main;
		2120
1442	cf::sync_job { $map->load };	2121	cf::sync_job { $map->load };
1443	}	2122	}
1444		2123
1445	our %MAP_PREFETCH;	2124	our %MAP_PREFETCH;
1446	our $MAP_PREFETCHER = Coro::async {	2125	our $MAP_PREFETCHER = undef;
1447	while () {
1448	for my $path (keys %MAP_PREFETCH) {
1449	my $map = find $path
1450	or next;
1451	$map->load;
1452
1453	delete $MAP_PREFETCH{$path};
1454	}
1455	Coro::schedule;
1456	}
1457	};
1458		2126
1459	sub find_async {	2127	sub find_async {
1460	my ($path, $origin) = @_;	2128	my ($path, $origin, $load) = @_;
1461		2129
1462	$path = normalise $path, $origin && $origin->{path};	2130	$path = normalise $path, $origin && $origin->{path};
1463		2131
1464	if (my $map = $cf::MAP{$path}) {	2132	if (my $map = $cf::MAP{$path}) {
1465	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2133	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
		2134	}
		2135
		2136	$MAP_PREFETCH{$path} |= $load;
		2137
		2138	$MAP_PREFETCHER ||= cf::async {
		2139	$Coro::current->{desc} = "map prefetcher";
		2140
		2141	while (%MAP_PREFETCH) {
		2142	while (my ($k, $v) = each %MAP_PREFETCH) {
		2143	if (my $map = find $k) {
		2144	$map->load if $v;
		2145	}
		2146
		2147	delete $MAP_PREFETCH{$k};
		2148	}
		2149	}
		2150	undef $MAP_PREFETCHER;
1466	}	2151	};
1467
1468	$MAP_PREFETCH{$path} = 0;
1469	$MAP_PREFETCHER->ready;	2152	$MAP_PREFETCHER->prio (6);
1470		2153
1471	()	2154	()
1472	}	2155	}
1473		2156
1474	sub save {	2157	sub save {
1475	my ($self) = @_;	2158	my ($self) = @_;
1476		2159
1477	my $lock = cf::lock_acquire "map_data:" . $self->path;	2160	my $lock = cf::lock_acquire "map_data:$self->{path}";
1478		2161
1479	$self->{last_save} = $cf::RUNTIME;	2162	$self->{last_save} = $cf::RUNTIME;
1480		2163
1481	return unless $self->dirty;	2164	return unless $self->dirty;
1482		2165
…		…
1488	return if $self->{deny_save};	2171	return if $self->{deny_save};
1489		2172
1490	local $self->{last_access} = $self->last_access;#d#	2173	local $self->{last_access} = $self->last_access;#d#
1491		2174
1492	cf::async {	2175	cf::async {
		2176	$Coro::current->{desc} = "map player save";
1493	$_->contr->save for $self->players;	2177	$_->contr->save for $self->players;
1494	};	2178	};
1495		2179
1496	if ($uniq) {	2180	if ($uniq) {
1497	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2181	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
…		…
1505	my ($self) = @_;	2189	my ($self) = @_;
1506		2190
1507	# save first because save cedes	2191	# save first because save cedes
1508	$self->save;	2192	$self->save;
1509		2193
1510	my $lock = cf::lock_acquire "map_data:" . $self->path;	2194	my $lock = cf::lock_acquire "map_data:$self->{path}";
1511		2195
1512	return if $self->players;	2196	return if $self->players;
1513	return if $self->in_memory != cf::MAP_IN_MEMORY;	2197	return if $self->in_memory != cf::MAP_IN_MEMORY;
1514	return if $self->{deny_save};	2198	return if $self->{deny_save};
1515		2199
		2200	$self->in_memory (cf::MAP_SWAPPED);
		2201
		2202	$self->deactivate;
		2203	$_->clear_links_to ($self) for values %cf::MAP;
1516	$self->clear;	2204	$self->clear;
1517	$self->in_memory (cf::MAP_SWAPPED);
1518	}	2205	}
1519		2206
1520	sub reset_at {	2207	sub reset_at {
1521	my ($self) = @_;	2208	my ($self) = @_;
1522		2209
1523	# TODO: safety, remove and allow resettable per-player maps	2210	# TODO: safety, remove and allow resettable per-player maps
1524	return 1e99 if $self->isa ("ext::map_per_player");#d#
1525	return 1e99 if $self->{deny_reset};	2211	return 1e99 if $self->{deny_reset};
1526		2212
1527	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2213	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1528	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2214	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1529		2215
…		…
1540	my ($self) = @_;	2226	my ($self) = @_;
1541		2227
1542	my $lock = cf::lock_acquire "map_data:$self->{path}";	2228	my $lock = cf::lock_acquire "map_data:$self->{path}";
1543		2229
1544	return if $self->players;	2230	return if $self->players;
1545	return if $self->isa ("ext::map_per_player");#d#
1546		2231
1547	warn "resetting map ", $self->path;#d#	2232	warn "resetting map ", $self->path;
		2233
		2234	$self->in_memory (cf::MAP_SWAPPED);
		2235
		2236	# need to save uniques path
		2237	unless ($self->{deny_save}) {
		2238	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2239
		2240	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2241	if $uniq;
		2242	}
1548		2243
1549	delete $cf::MAP{$self->path};	2244	delete $cf::MAP{$self->path};
1550		2245
1551	$self->in_memory (cf::MAP_SWAPPED);	2246	$self->deactivate;
		2247	$_->clear_links_to ($self) for values %cf::MAP;
1552	$self->clear;	2248	$self->clear;
1553
1554	$_->clear_links_to ($self) for values %cf::MAP;
1555		2249
1556	$self->unlink_save;	2250	$self->unlink_save;
1557	$self->destroy;	2251	$self->destroy;
1558	}	2252	}
1559		2253
1560	my $nuke_counter = "aaaa";	2254	my $nuke_counter = "aaaa";
1561		2255
1562	sub nuke {	2256	sub nuke {
1563	my ($self) = @_;	2257	my ($self) = @_;
1564		2258
		2259	{
		2260	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2261
1565	delete $cf::MAP{$self->path};	2262	delete $cf::MAP{$self->path};
1566		2263
1567	$self->unlink_save;	2264	$self->unlink_save;
1568		2265
1569	bless $self, "cf::map";	2266	bless $self, "cf::map";
1570	delete $self->{deny_reset};	2267	delete $self->{deny_reset};
1571	$self->{deny_save} = 1;	2268	$self->{deny_save} = 1;
1572	$self->reset_timeout (1);	2269	$self->reset_timeout (1);
1573	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2270	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1574		2271
1575	$cf::MAP{$self->path} = $self;	2272	$cf::MAP{$self->path} = $self;
		2273	}
1576		2274
1577	$self->reset; # polite request, might not happen	2275	$self->reset; # polite request, might not happen
		2276	}
		2277
		2278	=item $maps = cf::map::tmp_maps
		2279
		2280	Returns an arrayref with all map paths of currently instantiated and saved
		2281	maps. May block.
		2282
		2283	=cut
		2284
		2285	sub tmp_maps() {
		2286	[
		2287	map {
		2288	utf8::decode $_;
		2289	/\.map$/
		2290	? normalise $_
		2291	: ()
		2292	} @{ aio_readdir $TMPDIR or [] }
		2293	]
		2294	}
		2295
		2296	=item $maps = cf::map::random_maps
		2297
		2298	Returns an arrayref with all map paths of currently instantiated and saved
		2299	random maps. May block.
		2300
		2301	=cut
		2302
		2303	sub random_maps() {
		2304	[
		2305	map {
		2306	utf8::decode $_;
		2307	/\.map$/
		2308	? normalise "?random/$_"
		2309	: ()
		2310	} @{ aio_readdir $RANDOMDIR or [] }
		2311	]
1578	}	2312	}
1579		2313
1580	=item cf::map::unique_maps	2314	=item cf::map::unique_maps
1581		2315
1582	Returns an arrayref of paths of all shared maps that have	2316	Returns an arrayref of paths of all shared maps that have
1583	instantiated unique items. May block.	2317	instantiated unique items. May block.
1584		2318
1585	=cut	2319	=cut
1586		2320
1587	sub unique_maps() {	2321	sub unique_maps() {
1588	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2322	[
1589	or return;	2323	map {
1590
1591	my @paths;
1592
1593	for (@$files) {
1594	utf8::decode $_;	2324	utf8::decode $_;
1595	next if /\.pst$/;
1596	next unless /^$PATH_SEP/o;
1597
1598	s/\.map$//;	2325	/\.map$/
1599	push @paths, $_;	2326	? normalise $_
		2327	: ()
		2328	} @{ aio_readdir $UNIQUEDIR or [] }
1600	}	2329	]
1601
1602	\@paths
1603	}	2330	}
1604		2331
1605	package cf;	2332	package cf;
1606		2333
1607	=back	2334	=back
…		…
1625	map { $_, inv_recursive_ $_->inv } @_	2352	map { $_, inv_recursive_ $_->inv } @_
1626	}	2353	}
1627		2354
1628	sub inv_recursive {	2355	sub inv_recursive {
1629	inv_recursive_ inv $_[0]	2356	inv_recursive_ inv $_[0]
		2357	}
		2358
		2359	=item $ref = $ob->ref
		2360
		2361	creates and returns a persistent reference to an objetc that can be stored as a string.
		2362
		2363	=item $ob = cf::object::deref ($refstring)
		2364
		2365	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2366	even if the object actually exists. May block.
		2367
		2368	=cut
		2369
		2370	sub deref {
		2371	my ($ref) = @_;
		2372
		2373	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2374	my ($uuid, $name) = ($1, $2);
		2375	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2376	or return;
		2377	$pl->ob->uuid eq $uuid
		2378	or return;
		2379
		2380	$pl->ob
		2381	} else {
		2382	warn "$ref: cannot resolve object reference\n";
		2383	undef
		2384	}
1630	}	2385	}
1631		2386
1632	package cf;	2387	package cf;
1633		2388
1634	=back	2389	=back
…		…
1653		2408
1654	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2409	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1655		2410
1656	if ($self->{record_replies}) {	2411	if ($self->{record_replies}) {
1657	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2412	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2413
1658	} else {	2414	} else {
		2415	my $pl = $self->contr;
		2416
		2417	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2418	my $dialog = $pl->{npc_dialog};
		2419	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2420
		2421	} else {
1659	$msg = $npc->name . " says: $msg" if $npc;	2422	$msg = $npc->name . " says: $msg" if $npc;
1660	$self->message ($msg, $flags);	2423	$self->message ($msg, $flags);
		2424	}
1661	}	2425	}
		2426	}
		2427
		2428	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2429
		2430	=cut
		2431
		2432	sub cf::object::send_msg {
		2433	my $pl = shift->contr
		2434	or return;
		2435	$pl->send_msg (@_);
1662	}	2436	}
1663		2437
1664	=item $player_object->may ("access")	2438	=item $player_object->may ("access")
1665		2439
1666	Returns wether the given player is authorized to access resource "access"	2440	Returns wether the given player is authorized to access resource "access"
…		…
1698	=cut	2472	=cut
1699		2473
1700	sub link_map {	2474	sub link_map {
1701	unless ($LINK_MAP) {	2475	unless ($LINK_MAP) {
1702	$LINK_MAP = cf::map::find "{link}"	2476	$LINK_MAP = cf::map::find "{link}"
1703	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };	2477	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1704	$LINK_MAP->load;	2478	$LINK_MAP->load;
1705	}	2479	}
1706		2480
1707	$LINK_MAP	2481	$LINK_MAP
1708	}	2482	}
…		…
1713	$self->deactivate_recursive;	2487	$self->deactivate_recursive;
1714		2488
1715	return if UNIVERSAL::isa $self->map, "ext::map_link";	2489	return if UNIVERSAL::isa $self->map, "ext::map_link";
1716		2490
1717	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2491	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1718	if $self->map;	2492	if $self->map && $self->map->{path} ne "{link}";
1719		2493
1720	$self->enter_map ($LINK_MAP || link_map, 20, 20);	2494	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1721	}	2495	}
1722		2496
1723	sub cf::object::player::leave_link {	2497	sub cf::object::player::leave_link {
1724	my ($self, $map, $x, $y) = @_;	2498	my ($self, $map, $x, $y) = @_;
		2499
		2500	return unless $self->contr->active;
1725		2501
1726	my $link_pos = delete $self->{_link_pos};	2502	my $link_pos = delete $self->{_link_pos};
1727		2503
1728	unless ($map) {	2504	unless ($map) {
1729	# restore original map position	2505	# restore original map position
…		…
1743	# use -1 or undef as default coordinates, not 0, 0	2519	# use -1 or undef as default coordinates, not 0, 0
1744	($x, $y) = ($map->enter_x, $map->enter_y)	2520	($x, $y) = ($map->enter_x, $map->enter_y)
1745	if $x <=0 && $y <= 0;	2521	if $x <=0 && $y <= 0;
1746		2522
1747	$map->load;	2523	$map->load;
1748	$map->load_diag;	2524	$map->load_neighbours;
1749		2525
1750	return unless $self->contr->active;	2526	return unless $self->contr->active;
1751	$self->activate_recursive;	2527	$self->activate_recursive;
		2528
		2529	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1752	$self->enter_map ($map, $x, $y);	2530	$self->enter_map ($map, $x, $y);
1753	}	2531	}
1754		2532
1755	cf::player->attach (	2533	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1756	on_logout => sub {
1757	my ($pl) = @_;
1758		2534
1759	# abort map switching before logout	2535	Moves the player to the given map-path and coordinates by first freezing
1760	if ($pl->ob->{_link_pos}) {	2536	her, loading and preparing them map, calling the provided $check callback
1761	cf::sync_job {	2537	that has to return the map if sucecssful, and then unfreezes the player on
1762	$pl->ob->leave_link	2538	the new (success) or old (failed) map position. In either case, $done will
1763	};	2539	be called at the end of this process.
1764	}
1765	},
1766	on_login => sub {
1767	my ($pl) = @_;
1768		2540
1769	# try to abort aborted map switching on player login :)
1770	# should happen only on crashes
1771	if ($pl->ob->{_link_pos}) {
1772	$pl->ob->enter_link;
1773	(async {
1774	# we need this sleep as the login has a concurrent enter_exit running
1775	# and this sleep increases chances of the player not ending up in scorn
1776	$pl->ob->reply (undef,
1777	"There was an internal problem at your last logout, "
1778	. "the server will try to bring you to your intended destination in a second.",
1779	cf::NDI_RED);
1780	Coro::Timer::sleep 1;
1781	$pl->ob->leave_link;
1782	})->prio (2);
1783	}
1784	},
1785	);
1786
1787	=item $player_object->goto ($path, $x, $y)
1788
1789	=cut	2541	=cut
		2542
		2543	our $GOTOGEN;
1790		2544
1791	sub cf::object::player::goto {	2545	sub cf::object::player::goto {
1792	my ($self, $path, $x, $y) = @_;	2546	my ($self, $path, $x, $y, $check, $done) = @_;
		2547
		2548	# do generation counting so two concurrent goto's will be executed in-order
		2549	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1793		2550
1794	$self->enter_link;	2551	$self->enter_link;
1795		2552
1796	(async {	2553	(async {
1797	my $map = cf::map::find $path;	2554	$Coro::current->{desc} = "player::goto $path $x $y";
		2555
		2556	# *tag paths override both path and x|y
		2557	if ($path =~ /^\*(.*)$/) {
		2558	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2559	my $ob = $obs[rand @obs];
		2560
		2561	# see if we actually can go there
		2562	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2563	$ob = $obs[rand @obs];
		2564	} else {
		2565	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2566	}
		2567	# else put us there anyways for now #d#
		2568
		2569	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2570	} else {
		2571	($path, $x, $y) = (undef, undef, undef);
		2572	}
		2573	}
		2574
		2575	my $map = eval {
		2576	my $map = defined $path ? cf::map::find $path : undef;
		2577
		2578	if ($map) {
1798	$map = $map->customise_for ($self) if $map;	2579	$map = $map->customise_for ($self);
1799		2580	$map = $check->($map) if $check && $map;
1800	# warn "entering ", $map->path, " at ($x, $y)\n"	2581	} else {
1801	# if $map;
1802
1803	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2582	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2583	}
1804		2584
		2585	$map
		2586	};
		2587
		2588	if ($@) {
		2589	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2590	LOG llevError | logBacktrace, Carp::longmess $@;
		2591	}
		2592
		2593	if ($gen == $self->{_goto_generation}) {
		2594	delete $self->{_goto_generation};
1805	$self->leave_link ($map, $x, $y);	2595	$self->leave_link ($map, $x, $y);
		2596	}
		2597
		2598	$done->() if $done;
1806	})->prio (1);	2599	})->prio (1);
1807	}	2600	}
1808		2601
1809	=item $player_object->enter_exit ($exit_object)	2602	=item $player_object->enter_exit ($exit_object)
1810		2603
…		…
1839	# that depends on the exit object	2632	# that depends on the exit object
1840		2633
1841	my $rmp = parse_random_map_params $exit->msg;	2634	my $rmp = parse_random_map_params $exit->msg;
1842		2635
1843	if ($exit->map) {	2636	if ($exit->map) {
1844	$rmp->{region} = $exit->map->region_name;	2637	$rmp->{region} = $exit->region->name;
1845	$rmp->{origin_map} = $exit->map->path;	2638	$rmp->{origin_map} = $exit->map->path;
1846	$rmp->{origin_x} = $exit->x;	2639	$rmp->{origin_x} = $exit->x;
1847	$rmp->{origin_y} = $exit->y;	2640	$rmp->{origin_y} = $exit->y;
1848	}	2641	}
1849		2642
1850	$rmp->{random_seed} ||= $exit->random_seed;	2643	$rmp->{random_seed} ||= $exit->random_seed;
1851		2644
1852	my $data = cf::to_json $rmp;	2645	my $data = cf::encode_json $rmp;
1853	my $md5 = Digest::MD5::md5_hex $data;	2646	my $md5 = Digest::MD5::md5_hex $data;
1854	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2647	my $meta = "$RANDOMDIR/$md5.meta";
1855		2648
1856	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2649	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1857	aio_write $fh, 0, (length $data), $data, 0;	2650	aio_write $fh, 0, (length $data), $data, 0;
1858	undef $fh;	2651	undef $fh;
1859	aio_rename "$meta~", $meta;	2652	aio_rename "$meta~", $meta;
…		…
1866	sub cf::object::player::enter_exit {	2659	sub cf::object::player::enter_exit {
1867	my ($self, $exit) = @_;	2660	my ($self, $exit) = @_;
1868		2661
1869	return unless $self->type == cf::PLAYER;	2662	return unless $self->type == cf::PLAYER;
1870		2663
		2664	if ($exit->slaying eq "/!") {
		2665	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2666	# the problem is that $exit might not survive long enough
		2667	# so it needs to be done right now, right here
		2668	cf::sync_job { prepare_random_map $exit };
		2669	}
		2670
		2671	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2672	my $hp = $exit->stats->hp;
		2673	my $sp = $exit->stats->sp;
		2674
1871	$self->enter_link;	2675	$self->enter_link;
1872		2676
		2677	# if exit is damned, update players death & WoR home-position
		2678	$self->contr->savebed ($slaying, $hp, $sp)
		2679	if $exit->flag (FLAG_DAMNED);
		2680
1873	(async {	2681	(async {
		2682	$Coro::current->{desc} = "enter_exit $slaying $hp $sp";
		2683
1874	$self->deactivate_recursive; # just to be sure	2684	$self->deactivate_recursive; # just to be sure
1875	unless (eval {	2685	unless (eval {
1876	prepare_random_map $exit	2686	$self->goto ($slaying, $hp, $sp);
1877	if $exit->slaying eq "/!";
1878
1879	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1880	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1881		2687
1882	1;	2688	1;
1883	}) {	2689	}) {
1884	$self->message ("Something went wrong deep within the crossfire server. "	2690	$self->message ("Something went wrong deep within the crossfire server. "
1885	. "I'll try to bring you back to the map you were before. "	2691	. "I'll try to bring you back to the map you were before. "
1886	. "Please report this to the dungeon master!",	2692	. "Please report this to the dungeon master!",
1887	cf::NDI_UNIQUE | cf::NDI_RED);	2693	cf::NDI_UNIQUE | cf::NDI_RED);
1888		2694
1889	warn "ERROR in enter_exit: $@";	2695	warn "ERROR in enter_exit: $@";
1890	$self->leave_link;	2696	$self->leave_link;
1891	}	2697	}
1892	})->prio (1);	2698	})->prio (1);
…		…
1905		2711
1906	sub cf::client::send_drawinfo {	2712	sub cf::client::send_drawinfo {
1907	my ($self, $text, $flags) = @_;	2713	my ($self, $text, $flags) = @_;
1908		2714
1909	utf8::encode $text;	2715	utf8::encode $text;
1910	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2716	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1911	}	2717	}
1912		2718
		2719	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2720
		2721	Send a drawinfo or msg packet to the client, formatting the msg for the
		2722	client if neccessary. C<$type> should be a string identifying the type of
		2723	the message, with C<log> being the default. If C<$color> is negative, suppress
		2724	the message unless the client supports the msg packet.
		2725
		2726	=cut
		2727
		2728	# non-persistent channels (usually the info channel)
		2729	our %CHANNEL = (
		2730	"c/identify" => {
		2731	id => "infobox",
		2732	title => "Identify",
		2733	reply => undef,
		2734	tooltip => "Items recently identified",
		2735	},
		2736	"c/examine" => {
		2737	id => "infobox",
		2738	title => "Examine",
		2739	reply => undef,
		2740	tooltip => "Signs and other items you examined",
		2741	},
		2742	"c/book" => {
		2743	id => "infobox",
		2744	title => "Book",
		2745	reply => undef,
		2746	tooltip => "The contents of a note or book",
		2747	},
		2748	"c/lookat" => {
		2749	id => "infobox",
		2750	title => "Look",
		2751	reply => undef,
		2752	tooltip => "What you saw there",
		2753	},
		2754	"c/who" => {
		2755	id => "infobox",
		2756	title => "Players",
		2757	reply => undef,
		2758	tooltip => "Shows players who are currently online",
		2759	},
		2760	"c/body" => {
		2761	id => "infobox",
		2762	title => "Body Parts",
		2763	reply => undef,
		2764	tooltip => "Shows which body parts you posess and are available",
		2765	},
		2766	"c/uptime" => {
		2767	id => "infobox",
		2768	title => "Uptime",
		2769	reply => undef,
		2770	tooltip => "How long the server has been running since last restart",
		2771	},
		2772	"c/mapinfo" => {
		2773	id => "infobox",
		2774	title => "Map Info",
		2775	reply => undef,
		2776	tooltip => "Information related to the maps",
		2777	},
		2778	);
		2779
		2780	sub cf::client::send_msg {
		2781	my ($self, $channel, $msg, $color, @extra) = @_;
		2782
		2783	$msg = $self->pl->expand_cfpod ($msg);
		2784
		2785	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2786
		2787	# check predefined channels, for the benefit of C
		2788	if ($CHANNEL{$channel}) {
		2789	$channel = $CHANNEL{$channel};
		2790
		2791	$self->ext_msg (channel_info => $channel)
		2792	if $self->can_msg;
		2793
		2794	$channel = $channel->{id};
		2795
		2796	} elsif (ref $channel) {
		2797	# send meta info to client, if not yet sent
		2798	unless (exists $self->{channel}{$channel->{id}}) {
		2799	$self->{channel}{$channel->{id}} = $channel;
		2800	$self->ext_msg (channel_info => $channel)
		2801	if $self->can_msg;
		2802	}
		2803
		2804	$channel = $channel->{id};
		2805	}
		2806
		2807	return unless @extra || length $msg;
		2808
		2809	if ($self->can_msg) {
		2810	# default colour, mask it out
		2811	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2812	if $color & cf::NDI_DEF;
		2813
		2814	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2815	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2816	} else {
		2817	if ($color >= 0) {
		2818	# replace some tags by gcfclient-compatible ones
		2819	for ($msg) {
		2820	1 while
		2821	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2822	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2823	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2824	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2825	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2826	}
		2827
		2828	$color &= cf::NDI_COLOR_MASK;
		2829
		2830	utf8::encode $msg;
		2831
		2832	if (0 && $msg =~ /\[/) {
		2833	# COMMAND/INFO
		2834	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2835	} else {
		2836	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2837	$self->send_packet ("drawinfo $color $msg")
		2838	}
		2839	}
		2840	}
		2841	}
		2842
		2843	=item $client->ext_msg ($type, @msg)
		2844
		2845	Sends an ext event to the client.
		2846
		2847	=cut
		2848
		2849	sub cf::client::ext_msg($$@) {
		2850	my ($self, $type, @msg) = @_;
		2851
		2852	if ($self->extcmd == 2) {
		2853	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2854	} elsif ($self->extcmd == 1) { # TODO: remove
		2855	push @msg, msgtype => "event_$type";
		2856	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2857	}
		2858	}
		2859
		2860	=item $client->ext_reply ($msgid, @msg)
		2861
		2862	Sends an ext reply to the client.
		2863
		2864	=cut
		2865
		2866	sub cf::client::ext_reply($$@) {
		2867	my ($self, $id, @msg) = @_;
		2868
		2869	if ($self->extcmd == 2) {
		2870	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2871	} elsif ($self->extcmd == 1) {
		2872	#TODO: version 1, remove
		2873	unshift @msg, msgtype => "reply", msgid => $id;
		2874	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2875	}
		2876	}
1913		2877
1914	=item $success = $client->query ($flags, "text", \&cb)	2878	=item $success = $client->query ($flags, "text", \&cb)
1915		2879
1916	Queues a query to the client, calling the given callback with	2880	Queues a query to the client, calling the given callback with
1917	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2881	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1918	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2882	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1919		2883
1920	Queries can fail, so check the return code. Or don't, as queries will become	2884	Queries can fail, so check the return code. Or don't, as queries will
1921	reliable at some point in the future.	2885	become reliable at some point in the future.
1922		2886
1923	=cut	2887	=cut
1924		2888
1925	sub cf::client::query {	2889	sub cf::client::query {
1926	my ($self, $flags, $text, $cb) = @_;	2890	my ($self, $flags, $text, $cb) = @_;
…		…
1934	utf8::encode $text;	2898	utf8::encode $text;
1935	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2899	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1936		2900
1937	$self->send_packet ($self->{query_queue}[0][0])	2901	$self->send_packet ($self->{query_queue}[0][0])
1938	if @{ $self->{query_queue} } == 1;	2902	if @{ $self->{query_queue} } == 1;
		2903
		2904	1
1939	}	2905	}
1940		2906
1941	cf::client->attach (	2907	cf::client->attach (
		2908	on_connect => sub {
		2909	my ($ns) = @_;
		2910
		2911	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2912	},
1942	on_reply => sub {	2913	on_reply => sub {
1943	my ($ns, $msg) = @_;	2914	my ($ns, $msg) = @_;
1944		2915
1945	# this weird shuffling is so that direct followup queries	2916	# this weird shuffling is so that direct followup queries
1946	# get handled first	2917	# get handled first
1947	my $queue = delete $ns->{query_queue}	2918	my $queue = delete $ns->{query_queue}
1948	or return; # be conservative, not sure how that can happen, but we saw a crash here	2919	or return; # be conservative, not sure how that can happen, but we saw a crash here
1949		2920
1950	(shift @$queue)->[1]->($msg);	2921	(shift @$queue)->[1]->($msg);
		2922	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1951		2923
1952	push @{ $ns->{query_queue} }, @$queue;	2924	push @{ $ns->{query_queue} }, @$queue;
1953		2925
1954	if (@{ $ns->{query_queue} } == @$queue) {	2926	if (@{ $ns->{query_queue} } == @$queue) {
1955	if (@$queue) {	2927	if (@$queue) {
…		…
1957	} else {	2929	} else {
1958	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2930	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1959	}	2931	}
1960	}	2932	}
1961	},	2933	},
		2934	on_exticmd => sub {
		2935	my ($ns, $buf) = @_;
		2936
		2937	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2938
		2939	if (ref $msg) {
		2940	my ($type, $reply, @payload) =
		2941	"ARRAY" eq ref $msg
		2942	? @$msg
		2943	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2944
		2945	my @reply;
		2946
		2947	if (my $cb = $EXTICMD{$type}) {
		2948	@reply = $cb->($ns, @payload);
		2949	}
		2950
		2951	$ns->ext_reply ($reply, @reply)
		2952	if $reply;
		2953
		2954	} else {
		2955	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2956	}
		2957
		2958	cf::override;
		2959	},
1962	);	2960	);
1963		2961
1964	=item $client->async (\&cb)	2962	=item $client->async (\&cb)
1965		2963
1966	Create a new coroutine, running the specified callback. The coroutine will	2964	Create a new coroutine, running the specified callback. The coroutine will
…		…
2007	our $safe = new Safe "safe";	3005	our $safe = new Safe "safe";
2008	our $safe_hole = new Safe::Hole;	3006	our $safe_hole = new Safe::Hole;
2009		3007
2010	$SIG{FPE} = 'IGNORE';	3008	$SIG{FPE} = 'IGNORE';
2011		3009
2012	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3010	$safe->permit_only (Opcode::opset qw(
		3011	:base_core :base_mem :base_orig :base_math
		3012	grepstart grepwhile mapstart mapwhile
		3013	sort time
		3014	));
2013		3015
2014	# here we export the classes and methods available to script code	3016	# here we export the classes and methods available to script code
2015		3017
2016	=pod	3018	=pod
2017		3019
2018	The following fucntions and emthods are available within a safe environment:	3020	The following functions and methods are available within a safe environment:
2019		3021
2020	cf::object contr pay_amount pay_player map	3022	cf::object
		3023	contr pay_amount pay_player map x y force_find force_add destroy
		3024	insert remove name archname title slaying race decrease_ob_nr
		3025
2021	cf::object::player player	3026	cf::object::player
2022	cf::player peaceful	3027	player
2023	cf::map trigger	3028
		3029	cf::player
		3030	peaceful
		3031
		3032	cf::map
		3033	trigger
2024		3034
2025	=cut	3035	=cut
2026		3036
2027	for (	3037	for (
2028	["cf::object" => qw(contr pay_amount pay_player map)],	3038	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3039	insert remove inv name archname title slaying race
		3040	decrease_ob_nr destroy)],
2029	["cf::object::player" => qw(player)],	3041	["cf::object::player" => qw(player)],
2030	["cf::player" => qw(peaceful)],	3042	["cf::player" => qw(peaceful)],
2031	["cf::map" => qw(trigger)],	3043	["cf::map" => qw(trigger)],
2032	) {	3044	) {
2033	no strict 'refs';	3045	no strict 'refs';
…		…
2104	=back	3116	=back
2105		3117
2106	=cut	3118	=cut
2107		3119
2108	#############################################################################	3120	#############################################################################
		3121	# the server's init and main functions
2109		3122
2110	=head2 EXTENSION DATABASE SUPPORT	3123	sub load_facedata($) {
		3124	my ($path) = @_;
2111		3125
2112	Crossfire maintains a very simple database for extension use. It can	3126	# HACK to clear player env face cache, we need some signal framework
2113	currently store anything that can be serialised using Storable, which	3127	# for this (global event?)
2114	excludes objects.	3128	%ext::player_env::MUSIC_FACE_CACHE = ();
2115		3129
2116	The parameter C<$family> should best start with the name of the extension	3130	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2117	using it, it should be unique.
2118		3131
2119	=over 4	3132	warn "loading facedata from $path\n";
2120		3133
2121	=item $hashref = cf::db_get $family	3134	my $facedata;
		3135	0 < aio_load $path, $facedata
		3136	or die "$path: $!";
2122		3137
2123	Return a hashref for use by the extension C<$family>, which can be	3138	$facedata = Coro::Storable::thaw $facedata;
2124	modified. After modifications, you have to call C<cf::db_dirty> or
2125	C<cf::db_sync>.
2126		3139
2127	=item $value = cf::db_get $family => $key	3140	$facedata->{version} == 2
		3141	or cf::cleanup "$path: version mismatch, cannot proceed.";
2128		3142
2129	Returns a single value from the database	3143	# patch in the exptable
2130		3144	$facedata->{resource}{"res/exp_table"} = {
2131	=item cf::db_put $family => $hashref	3145	type => FT_RSRC,
2132		3146	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2133	Stores the given family hashref into the database. Updates are delayed, if
2134	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2135
2136	=item cf::db_put $family => $key => $value
2137
2138	Stores the given C<$value> in the family hash. Updates are delayed, if you
2139	want the data to be synced to disk immediately, use C<cf::db_sync>.
2140
2141	=item cf::db_dirty
2142
2143	Marks the database as dirty, to be updated at a later time.
2144
2145	=item cf::db_sync
2146
2147	Immediately write the database to disk I<if it is dirty>.
2148
2149	=cut
2150
2151	our $DB;
2152
2153	{
2154	my $path = cf::localdir . "/database.pst";
2155
2156	sub db_load() {
2157	$DB = stat $path ? Storable::retrieve $path : { };
2158	}
2159
2160	my $pid;
2161
2162	sub db_save() {
2163	waitpid $pid, 0 if $pid;
2164	if (0 == ($pid = fork)) {
2165	$DB->{_meta}{version} = 1;
2166	Storable::nstore $DB, "$path~";
2167	rename "$path~", $path;
2168	cf::_exit 0 if defined $pid;
2169	}
2170	}
2171
2172	my $dirty;
2173
2174	sub db_sync() {
2175	db_save if $dirty;
2176	undef $dirty;
2177	}
2178
2179	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2180	db_sync;
2181	});	3147	};
		3148	cf::cede_to_tick;
2182		3149
2183	sub db_dirty() {
2184	$dirty = 1;
2185	$idle->start;
2186	}	3150	{
		3151	my $faces = $facedata->{faceinfo};
2187		3152
2188	sub db_get($;$) {	3153	while (my ($face, $info) = each %$faces) {
2189	@_ >= 2	3154	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2190	? $DB->{$_[0]}{$_[1]}
2191	: ($DB->{$_[0]} ||= { })
2192	}
2193		3155
2194	sub db_put($$;$) {	3156	cf::face::set_visibility $idx, $info->{visibility};
2195	if (@_ >= 3) {	3157	cf::face::set_magicmap $idx, $info->{magicmap};
2196	$DB->{$_[0]}{$_[1]} = $_[2];	3158	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2197	} else {	3159	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2198	$DB->{$_[0]} = $_[1];
2199	}
2200	db_dirty;
2201	}
2202		3160
2203	cf::global->attach (	3161	cf::cede_to_tick;
2204	prio => 10000,
2205	on_cleanup => sub {
2206	db_sync;
2207	},	3162	}
2208	);
2209	}
2210		3163
2211	#############################################################################	3164	while (my ($face, $info) = each %$faces) {
2212	# the server's main()	3165	next unless $info->{smooth};
2213		3166
2214	sub cfg_load {	3167	my $idx = cf::face::find $face
		3168	or next;
		3169
		3170	if (my $smooth = cf::face::find $info->{smooth}) {
		3171	cf::face::set_smooth $idx, $smooth;
		3172	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3173	} else {
		3174	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3175	}
		3176
		3177	cf::cede_to_tick;
		3178	}
		3179	}
		3180
		3181	{
		3182	my $anims = $facedata->{animinfo};
		3183
		3184	while (my ($anim, $info) = each %$anims) {
		3185	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3186	cf::cede_to_tick;
		3187	}
		3188
		3189	cf::anim::invalidate_all; # d'oh
		3190	}
		3191
		3192	{
		3193	# TODO: for gcfclient pleasure, we should give resources
		3194	# that gcfclient doesn't grok a >10000 face index.
		3195	my $res = $facedata->{resource};
		3196
		3197	while (my ($name, $info) = each %$res) {
		3198	if (defined $info->{type}) {
		3199	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3200	my $data;
		3201
		3202	if ($info->{type} & 1) {
		3203	# prepend meta info
		3204
		3205	my $meta = $enc->encode ({
		3206	name => $name,
		3207	%{ $info->{meta} || {} },
		3208	});
		3209
		3210	$data = pack "(w/a*)*", $meta, $info->{data};
		3211	} else {
		3212	$data = $info->{data};
		3213	}
		3214
		3215	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3216	cf::face::set_type $idx, $info->{type};
		3217	} else {
		3218	$RESOURCE{$name} = $info;
		3219	}
		3220
		3221	cf::cede_to_tick;
		3222	}
		3223
		3224	if (my $soundconf = delete $res->{"res/sound.conf"}) {
		3225	$soundconf = $enc->decode (delete $soundconf->{data});
		3226
		3227	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3228	my $sound = $soundconf->{compat}[$_]
		3229	or next;
		3230
		3231	my $face = cf::face::find "sound/$sound->[1]";
		3232	cf::sound::set $sound->[0] => $face;
		3233	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3234	}
		3235
		3236	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3237	my $face = cf::face::find "sound/$v";
		3238	cf::sound::set $k => $face;
		3239	}
		3240	}
		3241	}
		3242
		3243	1
		3244	}
		3245
		3246	register_exticmd fx_want => sub {
		3247	my ($ns, $want) = @_;
		3248
		3249	while (my ($k, $v) = each %$want) {
		3250	$ns->fx_want ($k, $v);
		3251	}
		3252	};
		3253
		3254	sub reload_regions {
		3255	# HACK to clear player env face cache, we need some signal framework
		3256	# for this (global event?)
		3257	%ext::player_env::MUSIC_FACE_CACHE = ();
		3258
		3259	load_resource_file "$MAPDIR/regions"
		3260	or die "unable to load regions file\n";
		3261
		3262	for (cf::region::list) {
		3263	$_->{match} = qr/$_->{match}/
		3264	if exists $_->{match};
		3265	}
		3266	}
		3267
		3268	sub reload_facedata {
		3269	load_facedata "$DATADIR/facedata"
		3270	or die "unable to load facedata\n";
		3271	}
		3272
		3273	sub reload_archetypes {
		3274	load_resource_file "$DATADIR/archetypes"
		3275	or die "unable to load archetypes\n";
		3276	#d# NEED to laod twice to resolve forward references
		3277	# this really needs to be done in an extra post-pass
		3278	# (which needs to be synchronous, so solve it differently)
		3279	load_resource_file "$DATADIR/archetypes"
		3280	or die "unable to load archetypes\n";
		3281	}
		3282
		3283	sub reload_treasures {
		3284	load_resource_file "$DATADIR/treasures"
		3285	or die "unable to load treasurelists\n";
		3286	}
		3287
		3288	sub reload_resources {
		3289	warn "reloading resource files...\n";
		3290
		3291	reload_regions;
		3292	reload_facedata;
		3293	#reload_archetypes;#d#
		3294	reload_archetypes;
		3295	reload_treasures;
		3296
		3297	warn "finished reloading resource files\n";
		3298	}
		3299
		3300	sub init {
		3301	reload_resources;
		3302	}
		3303
		3304	sub reload_config {
2215	open my $fh, "<:utf8", cf::confdir . "/config"	3305	open my $fh, "<:utf8", "$CONFDIR/config"
2216	or return;	3306	or return;
2217		3307
2218	local $/;	3308	local $/;
2219	*CFG = YAML::Syck::Load <$fh>;	3309	*CFG = YAML::Syck::Load <$fh>;
2220		3310
…		…
2235	sub main {	3325	sub main {
2236	# we must not ever block the main coroutine	3326	# we must not ever block the main coroutine
2237	local $Coro::idle = sub {	3327	local $Coro::idle = sub {
2238	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3328	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2239	(async {	3329	(async {
2240	Event::one_event;	3330	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3331	EV::loop EV::LOOP_ONESHOT;
2241	})->prio (Coro::PRIO_MAX);	3332	})->prio (Coro::PRIO_MAX);
2242	};	3333	};
2243		3334
2244	cfg_load;	3335	reload_config;
2245	db_load;	3336	db_init;
2246	load_extensions;	3337	load_extensions;
		3338
		3339	$TICK_WATCHER->start;
		3340	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
2247	Event::loop;	3341	EV::loop;
2248	}	3342	}
2249		3343
2250	#############################################################################	3344	#############################################################################
2251	# initialisation and cleanup	3345	# initialisation and cleanup
2252		3346
2253	# install some emergency cleanup handlers	3347	# install some emergency cleanup handlers
2254	BEGIN {	3348	BEGIN {
		3349	our %SIGWATCHER = ();
2255	for my $signal (qw(INT HUP TERM)) {	3350	for my $signal (qw(INT HUP TERM)) {
2256	Event->signal (	3351	$SIGWATCHER{$signal} = EV::signal $signal, sub {
2257	data => WF_AUTOCANCEL,
2258	signal => $signal,
2259	cb => sub {
2260	cf::cleanup "SIG$signal";	3352	cf::cleanup "SIG$signal";
2261	},
2262	);	3353	};
		3354	}
		3355	}
		3356
		3357	sub write_runtime {
		3358	my $runtime = "$LOCALDIR/runtime";
		3359
		3360	# first touch the runtime file to show we are still running:
		3361	# the fsync below can take a very very long time.
		3362
		3363	IO::AIO::aio_utime $runtime, undef, undef;
		3364
		3365	my $guard = cf::lock_acquire "write_runtime";
		3366
		3367	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3368	or return;
		3369
		3370	my $value = $cf::RUNTIME + 90 + 10;
		3371	# 10 is the runtime save interval, for a monotonic clock
		3372	# 60 allows for the watchdog to kill the server.
		3373
		3374	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3375	and return;
		3376
		3377	# always fsync - this file is important
		3378	aio_fsync $fh
		3379	and return;
		3380
		3381	# touch it again to show we are up-to-date
		3382	aio_utime $fh, undef, undef;
		3383
		3384	close $fh
		3385	or return;
		3386
		3387	aio_rename "$runtime~", $runtime
		3388	and return;
		3389
		3390	warn "runtime file written.\n";
		3391
2263	}	3392	1
2264	}	3393	}
2265		3394
2266	sub emergency_save() {	3395	sub emergency_save() {
2267	my $freeze_guard = cf::freeze_mainloop;	3396	my $freeze_guard = cf::freeze_mainloop;
2268		3397
…		…
2274	# and maps saved/destroyed asynchronously.	3403	# and maps saved/destroyed asynchronously.
2275	warn "begin emergency player save\n";	3404	warn "begin emergency player save\n";
2276	for my $login (keys %cf::PLAYER) {	3405	for my $login (keys %cf::PLAYER) {
2277	my $pl = $cf::PLAYER{$login} or next;	3406	my $pl = $cf::PLAYER{$login} or next;
2278	$pl->valid or next;	3407	$pl->valid or next;
		3408	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2279	$pl->save;	3409	$pl->save;
2280	}	3410	}
2281	warn "end emergency player save\n";	3411	warn "end emergency player save\n";
2282		3412
2283	warn "begin emergency map save\n";	3413	warn "begin emergency map save\n";
…		…
2285	my $map = $cf::MAP{$path} or next;	3415	my $map = $cf::MAP{$path} or next;
2286	$map->valid or next;	3416	$map->valid or next;
2287	$map->save;	3417	$map->save;
2288	}	3418	}
2289	warn "end emergency map save\n";	3419	warn "end emergency map save\n";
		3420
		3421	warn "begin emergency database checkpoint\n";
		3422	BDB::db_env_txn_checkpoint $DB_ENV;
		3423	warn "end emergency database checkpoint\n";
2290	};	3424	};
2291		3425
2292	warn "leave emergency perl save\n";	3426	warn "leave emergency perl save\n";
2293	}	3427	}
2294		3428
		3429	sub post_cleanup {
		3430	my ($make_core) = @_;
		3431
		3432	warn Carp::longmess "post_cleanup backtrace"
		3433	if $make_core;
		3434	}
		3435
2295	sub reload() {	3436	sub do_reload_perl() {
2296	# can/must only be called in main	3437	# can/must only be called in main
2297	if ($Coro::current != $Coro::main) {	3438	if ($Coro::current != $Coro::main) {
2298	warn "can only reload from main coroutine\n";	3439	warn "can only reload from main coroutine";
2299	return;	3440	return;
2300	}	3441	}
2301		3442
2302	warn "reloading...";	3443	warn "reloading...";
2303		3444
2304	warn "freezing server";	3445	warn "entering sync_job";
2305	my $guard = freeze_mainloop;	3446
		3447	cf::sync_job {
		3448	cf::write_runtime; # external watchdog should not bark
2306	cf::emergency_save;	3449	cf::emergency_save;
		3450	cf::write_runtime; # external watchdog should not bark
2307		3451
2308	warn "sync database to disk";	3452	warn "syncing database to disk";
2309	cf::db_sync;	3453	BDB::db_env_txn_checkpoint $DB_ENV;
2310	IO::AIO::flush;
2311		3454
2312	eval {
2313	# if anything goes wrong in here, we should simply crash as we already saved	3455	# if anything goes wrong in here, we should simply crash as we already saved
2314		3456
2315	warn "cancel all watchers";	3457	warn "flushing outstanding aio requests";
2316	for (Event::all_watchers) {	3458	for (;;) {
2317	$_->cancel if $_->data & WF_AUTOCANCEL;	3459	BDB::flush;
		3460	IO::AIO::flush;
		3461	Coro::cede_notself;
		3462	last unless IO::AIO::nreqs || BDB::nreqs;
		3463	warn "iterate...";
2318	}	3464	}
2319		3465
		3466	++$RELOAD;
		3467
2320	warn "cancel all extension coros";	3468	warn "cancelling all extension coros";
2321	$_->cancel for values %EXT_CORO;	3469	$_->cancel for values %EXT_CORO;
2322	%EXT_CORO = ();	3470	%EXT_CORO = ();
2323		3471
2324	warn "remove commands";	3472	warn "removing commands";
2325	%COMMAND = ();	3473	%COMMAND = ();
2326		3474
2327	warn "remove ext commands";	3475	warn "removing ext/exti commands";
2328	%EXTCMD = ();	3476	%EXTCMD = ();
		3477	%EXTICMD = ();
2329		3478
2330	warn "unload/nuke all extensions";	3479	warn "unloading/nuking all extensions";
2331	for my $pkg (@EXTS) {	3480	for my $pkg (@EXTS) {
2332	warn "... unloading $pkg";	3481	warn "... unloading $pkg";
2333		3482
2334	if (my $cb = $pkg->can ("unload")) {	3483	if (my $cb = $pkg->can ("unload")) {
2335	eval {	3484	eval {
…		…
2340		3489
2341	warn "... nuking $pkg";	3490	warn "... nuking $pkg";
2342	Symbol::delete_package $pkg;	3491	Symbol::delete_package $pkg;
2343	}	3492	}
2344		3493
2345	warn "unload all perl modules loaded from $LIBDIR";	3494	warn "unloading all perl modules loaded from $LIBDIR";
2346	while (my ($k, $v) = each %INC) {	3495	while (my ($k, $v) = each %INC) {
2347	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3496	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2348		3497
2349	warn "removing <$k>";	3498	warn "... unloading $k";
2350	delete $INC{$k};	3499	delete $INC{$k};
2351		3500
2352	$k =~ s/\.pm$//;	3501	$k =~ s/\.pm$//;
2353	$k =~ s/\//::/g;	3502	$k =~ s/\//::/g;
2354		3503
…		…
2357	}	3506	}
2358		3507
2359	Symbol::delete_package $k;	3508	Symbol::delete_package $k;
2360	}	3509	}
2361		3510
2362	warn "get rid of safe::, as good as possible";	3511	warn "getting rid of safe::, as good as possible";
2363	Symbol::delete_package "safe::$_"	3512	Symbol::delete_package "safe::$_"
2364	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3513	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2365		3514
2366	warn "unload cf.pm \"a bit\"";	3515	warn "unloading cf.pm \"a bit\"";
2367	delete $INC{"cf.pm"};	3516	delete $INC{"cf.pm"};
		3517	delete $INC{"cf/pod.pm"};
2368		3518
2369	# don't, removes xs symbols, too,	3519	# don't, removes xs symbols, too,
2370	# and global variables created in xs	3520	# and global variables created in xs
2371	#Symbol::delete_package __PACKAGE__;	3521	#Symbol::delete_package __PACKAGE__;
2372		3522
		3523	warn "unload completed, starting to reload now";
		3524
2373	warn "reloading cf.pm";	3525	warn "reloading cf.pm";
2374	require cf;	3526	require cf;
2375	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3527	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2376		3528
2377	warn "load config and database again";	3529	warn "loading config and database again";
2378	cf::cfg_load;	3530	cf::reload_config;
2379	cf::db_load;
2380		3531
2381	warn "load extensions";	3532	warn "loading extensions";
2382	cf::load_extensions;	3533	cf::load_extensions;
2383		3534
2384	warn "reattach attachments to objects/players";	3535	warn "reattaching attachments to objects/players";
2385	_global_reattach;	3536	_global_reattach; # objects, sockets
2386	warn "reattach attachments to maps";	3537	warn "reattaching attachments to maps";
2387	reattach $_ for values %MAP;	3538	reattach $_ for values %MAP;
2388	};	3539	warn "reattaching attachments to players";
		3540	reattach $_ for values %PLAYER;
2389		3541
2390	if ($@) {	3542	warn "leaving sync_job";
		3543
		3544	1
		3545	} or do {
2391	warn $@;	3546	warn $@;
2392	warn "error while reloading, exiting.";	3547	warn "error while reloading, exiting.";
2393	exit 1;	3548	exit 1;
2394	}	3549	};
2395		3550
2396	warn "reloaded";	3551	warn "reloaded";
2397	};	3552	};
2398		3553
2399	our $RELOAD_WATCHER; # used only during reload	3554	our $RELOAD_WATCHER; # used only during reload
2400		3555
		3556	sub reload_perl() {
		3557	# doing reload synchronously and two reloads happen back-to-back,
		3558	# coro crashes during coro_state_free->destroy here.
		3559
		3560	$RELOAD_WATCHER ||= EV::timer 0, 0, sub {
		3561	undef $RELOAD_WATCHER;
		3562	do_reload_perl;
		3563	};
		3564	}
		3565
2401	register_command "reload" => sub {	3566	register_command "reload" => sub {
2402	my ($who, $arg) = @_;	3567	my ($who, $arg) = @_;
2403		3568
2404	if ($who->flag (FLAG_WIZ)) {	3569	if ($who->flag (FLAG_WIZ)) {
2405	$who->message ("reloading server.");	3570	$who->message ("reloading server.");
2406		3571	async {
2407	# doing reload synchronously and two reloads happen back-to-back,	3572	$Coro::current->{desc} = "perl_reload";
2408	# coro crashes during coro_state_free->destroy here.
2409
2410	$RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub {
2411	reload;	3573	reload_perl;
2412	undef $RELOAD_WATCHER;
2413	});	3574	};
2414	}	3575	}
2415	};	3576	};
2416		3577
2417	unshift @INC, $LIBDIR;	3578	unshift @INC, $LIBDIR;
2418		3579
2419	$TICK_WATCHER = Event->timer (	3580	my $bug_warning = 0;
2420	reentrant => 0,
2421	prio => 0,
2422	at => $NEXT_TICK || $TICK,
2423	data => WF_AUTOCANCEL,
2424	cb => sub {
2425	$NOW = Event::time;
2426		3581
		3582	our @WAIT_FOR_TICK;
		3583	our @WAIT_FOR_TICK_BEGIN;
		3584
		3585	sub wait_for_tick {
		3586	return unless $TICK_WATCHER->is_active;
		3587	return if $Coro::current == $Coro::main;
		3588
		3589	my $signal = new Coro::Signal;
		3590	push @WAIT_FOR_TICK, $signal;
		3591	$signal->wait;
		3592	}
		3593
		3594	sub wait_for_tick_begin {
		3595	return unless $TICK_WATCHER->is_active;
		3596	return if $Coro::current == $Coro::main;
		3597
		3598	my $signal = new Coro::Signal;
		3599	push @WAIT_FOR_TICK_BEGIN, $signal;
		3600	$signal->wait;
		3601	}
		3602
		3603	$TICK_WATCHER = EV::periodic_ns 0, $TICK, 0, sub {
		3604	if ($Coro::current != $Coro::main) {
		3605	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3606	unless ++$bug_warning > 10;
		3607	return;
		3608	}
		3609
		3610	$NOW = $tick_start = EV::now;
		3611
2427	cf::server_tick; # one server iteration	3612	cf::server_tick; # one server iteration
		3613
2428	$RUNTIME += $TICK;	3614	$RUNTIME += $TICK;
2429	$NEXT_TICK += $TICK;	3615	$NEXT_TICK = $_[0]->at;
2430		3616
2431	$WAIT_FOR_TICK->broadcast;	3617	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2432	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3618	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2433		3619	Coro::async_pool {
2434	# if we are delayed by four ticks or more, skip them all	3620	$Coro::current->{desc} = "runtime saver";
2435	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2436
2437	$TICK_WATCHER->at ($NEXT_TICK);
2438	$TICK_WATCHER->start;
2439	},
2440	);
2441
2442	IO::AIO::max_poll_time $TICK * 0.2;
2443
2444	$AIO_POLL_WATCHER = Event->io (
2445	fd => IO::AIO::poll_fileno,
2446	poll => 'r',
2447	prio => 5,
2448	data => WF_AUTOCANCEL,
2449	cb => \&IO::AIO::poll_cb,
2450	);
2451
2452	$WRITE_RUNTIME_WATCHER = Event->timer (
2453	data => WF_AUTOCANCEL,
2454	after => 0,
2455	interval => 10,
2456	cb => sub {
2457	(Coro::unblock_sub {
2458	write_runtime	3621	write_runtime
2459	or warn "ERROR: unable to write runtime file: $!";	3622	or warn "ERROR: unable to write runtime file: $!";
2460	})->();	3623	};
2461	},	3624	}
2462	);	3625
		3626	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3627	$sig->send;
		3628	}
		3629	while (my $sig = shift @WAIT_FOR_TICK) {
		3630	$sig->send;
		3631	}
		3632
		3633	$LOAD = ($NOW - $tick_start) / $TICK;
		3634	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3635
		3636	_post_tick;
		3637	};
		3638	$TICK_WATCHER->priority (EV::MAXPRI);
		3639
		3640	{
		3641	# configure BDB
		3642
		3643	BDB::min_parallel 8;
		3644	BDB::max_poll_reqs $TICK * 0.1;
		3645	$Coro::BDB::WATCHER->priority (1);
		3646
		3647	unless ($DB_ENV) {
		3648	$DB_ENV = BDB::db_env_create;
		3649	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
		3650	| BDB::LOG_AUTOREMOVE, 1);
		3651	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3652	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3653
		3654	cf::sync_job {
		3655	eval {
		3656	BDB::db_env_open
		3657	$DB_ENV,
		3658	$BDBDIR,
		3659	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3660	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3661	0666;
		3662
		3663	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3664	};
		3665
		3666	cf::cleanup "db_env_open(db): $@" if $@;
		3667	};
		3668	}
		3669
		3670	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3671	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3672	};
		3673	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		3674	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3675	};
		3676	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3677	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3678	};
		3679	}
		3680
		3681	{
		3682	# configure IO::AIO
		3683
		3684	IO::AIO::min_parallel 8;
		3685	IO::AIO::max_poll_time $TICK * 0.1;
		3686	$Coro::AIO::WATCHER->priority (1);
		3687	}
		3688
		3689	my $_log_backtrace;
		3690
		3691	sub _log_backtrace {
		3692	my ($msg, @addr) = @_;
		3693
		3694	$msg =~ s/\n//;
		3695
		3696	# limit the # of concurrent backtraces
		3697	if ($_log_backtrace < 2) {
		3698	++$_log_backtrace;
		3699	async {
		3700	$Coro::current->{desc} = "abt $msg";
		3701
		3702	my @bt = fork_call {
		3703	@addr = map { sprintf "%x", $_ } @addr;
		3704	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3705	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3706	or die "addr2line: $!";
		3707
		3708	my @funcs;
		3709	my @res = <$fh>;
		3710	chomp for @res;
		3711	while (@res) {
		3712	my ($func, $line) = splice @res, 0, 2, ();
		3713	push @funcs, "[$func] $line";
		3714	}
		3715
		3716	@funcs
		3717	};
		3718
		3719	LOG llevInfo, "[ABT] $msg\n";
		3720	LOG llevInfo, "[ABT] $_\n" for @bt;
		3721	--$_log_backtrace;
		3722	};
		3723	} else {
		3724	LOG llevInfo, "[ABT] $msg\n";
		3725	LOG llevInfo, "[ABT] [suppressed]\n";
		3726	}
		3727	}
		3728
		3729	# load additional modules
		3730	use cf::pod;
2463		3731
2464	END { cf::emergency_save }	3732	END { cf::emergency_save }
2465		3733
2466	1	3734	1
2467		3735

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines