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.264 by root, Sun May 6 05:44:48 2007 UTC vs.
Revision 1.354 by root, Sun Sep 2 12:26:54 2007 UTC

…		…
10	use Event;	10	use Event;
11	use Opcode;	11	use Opcode;
12	use Safe;	12	use Safe;
13	use Safe::Hole;	13	use Safe::Hole;
14		14
15	use Coro 3.61 ();	15	use Coro 3.64 ();
16	use Coro::State;	16	use Coro::State;
17	use Coro::Handle;	17	use Coro::Handle;
18	use Coro::Event;	18	use Coro::Event;
19	use Coro::Timer;	19	use Coro::Timer;
20	use Coro::Signal;	20	use Coro::Signal;
21	use Coro::Semaphore;	21	use Coro::Semaphore;
22	use Coro::AIO;	22	use Coro::AIO;
23	use Coro::Storable;	23	use Coro::Storable;
		24	use Coro::Util ();
24		25
		26	use JSON::XS ();
25	use BDB ();	27	use BDB ();
26	use Data::Dumper;	28	use Data::Dumper;
27	use Digest::MD5;	29	use Digest::MD5;
28	use Fcntl;	30	use Fcntl;
29	use YAML::Syck ();	31	use YAML::Syck ();
30	use IO::AIO 2.32 ();	32	use IO::AIO 2.32 ();
31	use Time::HiRes;	33	use Time::HiRes;
32	use Compress::LZF;	34	use Compress::LZF;
		35	use Digest::MD5 ();
33		36
34	# configure various modules to our taste	37	# configure various modules to our taste
35	#	38	#
36	$Storable::canonical = 1; # reduce rsync transfers	39	$Storable::canonical = 1; # reduce rsync transfers
37	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator	40	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
…		…
49	our %COMMAND = ();	52	our %COMMAND = ();
50	our %COMMAND_TIME = ();	53	our %COMMAND_TIME = ();
51		54
52	our @EXTS = (); # list of extension package names	55	our @EXTS = (); # list of extension package names
53	our %EXTCMD = ();	56	our %EXTCMD = ();
		57	our %EXTICMD = ();
54	our %EXT_CORO = (); # coroutines bound to extensions	58	our %EXT_CORO = (); # coroutines bound to extensions
55	our %EXT_MAP = (); # pluggable maps	59	our %EXT_MAP = (); # pluggable maps
56		60
57	our $RELOAD; # number of reloads so far	61	our $RELOAD; # number of reloads so far
58	our @EVENT;	62	our @EVENT;
…		…
90	our $LINK_MAP; # the special {link} map, which is always available	94	our $LINK_MAP; # the special {link} map, which is always available
91		95
92	# used to convert map paths into valid unix filenames by replacing / by ∕	96	# used to convert map paths into valid unix filenames by replacing / by ∕
93	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	97	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
94		98
		99	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		100	our $LOADAVG; # same thing, but with alpha-smoothing
		101	our $tick_start; # for load detecting purposes
		102
95	binmode STDOUT;	103	binmode STDOUT;
96	binmode STDERR;	104	binmode STDERR;
97		105
98	# read virtual server time, if available	106	# read virtual server time, if available
99	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {	107	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
…		…
139		147
140	=item $cf::TICK	148	=item $cf::TICK
141		149
142	The interval between server ticks, in seconds.	150	The interval between server ticks, in seconds.
143		151
		152	=item $cf::LOADAVG
		153
		154	The current CPU load on the server (alpha-smoothed), as a value between 0
		155	(none) and 1 (overloaded), indicating how much time is spent on processing
		156	objects per tick. Healthy values are < 0.5.
		157
		158	=item $cf::LOAD
		159
		160	The raw value load value from the last tick.
		161
144	=item %cf::CFG	162	=item %cf::CFG
145		163
146	Configuration for the server, loaded from C</etc/crossfire/config>, or	164	Configuration for the server, loaded from C</etc/crossfire/config>, or
147	from wherever your confdir points to.	165	from wherever your confdir points to.
148		166
149	=item cf::wait_for_tick, cf::wait_for_tick_begin	167	=item cf::wait_for_tick, cf::wait_for_tick_begin
150		168
151	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only	169	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
152	returns directly I<after> the tick processing (and consequently, can only wake one process	170	returns directly I<after> the tick processing (and consequently, can only wake one process
153	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.	171	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
		172
		173	=item @cf::INVOKE_RESULTS
		174
		175	This array contains the results of the last C<invoke ()> call. When
		176	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		177	that call.
154		178
155	=back	179	=back
156		180
157	=cut	181	=cut
158		182
…		…
173	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	197	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
174	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	198	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
175	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	199	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
176	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	200	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
177	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	201	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		202	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
178	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	203	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
179		204
180	# we bless all objects into (empty) derived classes to force a method lookup	205	# we bless all objects into (empty) derived classes to force a method lookup
181	# within the Safe compartment.	206	# within the Safe compartment.
182	for my $pkg (qw(	207	for my $pkg (qw(
183	cf::global cf::attachable	208	cf::global cf::attachable
…		…
191	}	216	}
192		217
193	$Event::DIED = sub {	218	$Event::DIED = sub {
194	warn "error in event callback: @_";	219	warn "error in event callback: @_";
195	};	220	};
		221
		222	#############################################################################
196		223
197	=head2 UTILITY FUNCTIONS	224	=head2 UTILITY FUNCTIONS
198		225
199	=over 4	226	=over 4
200		227
…		…
219	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	246	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
220	$d	247	$d
221	} || "[unable to dump $_[0]: '$@']";	248	} || "[unable to dump $_[0]: '$@']";
222	}	249	}
223		250
224	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
225
226	=item $ref = cf::from_json $json	251	=item $ref = cf::from_json $json
227		252
228	Converts a JSON string into the corresponding perl data structure.	253	Converts a JSON string into the corresponding perl data structure.
229		254
230	=item $json = cf::to_json $ref	255	=item $json = cf::to_json $ref
231		256
232	Converts a perl data structure into its JSON representation.	257	Converts a perl data structure into its JSON representation.
		258
		259	=cut
		260
		261	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
		262
		263	sub to_json ($) { $json_coder->encode ($_[0]) }
		264	sub from_json ($) { $json_coder->decode ($_[0]) }
233		265
234	=item cf::lock_wait $string	266	=item cf::lock_wait $string
235		267
236	Wait until the given lock is available. See cf::lock_acquire.	268	Wait until the given lock is available. See cf::lock_acquire.
237		269
…		…
239		271
240	Wait until the given lock is available and then acquires it and returns	272	Wait until the given lock is available and then acquires it and returns
241	a Coro::guard object. If the guard object gets destroyed (goes out of scope,	273	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
242	for example when the coroutine gets canceled), the lock is automatically	274	for example when the coroutine gets canceled), the lock is automatically
243	returned.	275	returned.
		276
		277	Locks are *not* recursive, locking from the same coro twice results in a
		278	deadlocked coro.
244		279
245	Lock names should begin with a unique identifier (for example, cf::map::find	280	Lock names should begin with a unique identifier (for example, cf::map::find
246	uses map_find and cf::map::load uses map_load).	281	uses map_find and cf::map::load uses map_load).
247		282
248	=item $locked = cf::lock_active $string	283	=item $locked = cf::lock_active $string
…		…
291	};	326	};
292	$TICK_WATCHER->stop;	327	$TICK_WATCHER->stop;
293	$guard	328	$guard
294	}	329	}
295		330
		331	=item cf::get_slot $time[, $priority[, $name]]
		332
		333	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		334	This call blocks and returns only when you have at least C<$time> seconds
		335	of cpu time till the next tick. The slot is only valid till the next cede.
		336
		337	The optional C<$name> can be used to identify the job to run. It might be
		338	used for statistical purposes and should identify the same time-class.
		339
		340	Useful for short background jobs.
		341
		342	=cut
		343
		344	our @SLOT_QUEUE;
		345	our $SLOT_QUEUE;
		346
		347	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		348	$SLOT_QUEUE = Coro::async {
		349	my $signal = new Coro::Signal;
		350
		351	while () {
		352	next_job:
		353	my $avail = cf::till_tick;
		354	if ($avail > 0.01) {
		355	for (0 .. $#SLOT_QUEUE) {
		356	if ($SLOT_QUEUE[$_][0] < $avail) {
		357	my $job = splice @SLOT_QUEUE, $_, 1, ();
		358	$job->[2]->send;
		359	Coro::cede;
		360	goto next_job;
		361	}
		362	}
		363	}
		364
		365	if (@SLOT_QUEUE) {
		366	# we do not use wait_For_tick() as it returns immediately when tick is inactive
		367	push @cf::WAIT_FOR_TICK, $signal;
		368	$signal->wait;
		369	} else {
		370	Coro::schedule;
		371	}
		372	}
		373	};
		374
		375	sub get_slot($;$$) {
		376	my ($time, $pri, $name) = @_;
		377
		378	$time = $TICK * .6 if $time > $TICK * .6;
		379	my $sig = new Coro::Signal;
		380
		381	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		382	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		383	$SLOT_QUEUE->ready;
		384	$sig->wait;
		385	}
		386
296	=item cf::async { BLOCK }	387	=item cf::async { BLOCK }
297		388
298	Currently the same as Coro::async_pool, meaning you cannot use	389	Currently the same as Coro::async_pool, meaning you cannot use
299	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only	390	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
300	thing you are allowed to do is call C<prio> on it.	391	thing you are allowed to do is call C<prio> on it.
…		…
303		394
304	BEGIN { *async = \&Coro::async_pool }	395	BEGIN { *async = \&Coro::async_pool }
305		396
306	=item cf::sync_job { BLOCK }	397	=item cf::sync_job { BLOCK }
307		398
308	The design of crossfire+ requires that the main coro ($Coro::main) is	399	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
309	always able to handle events or runnable, as crossfire+ is only partly	400	is always able to handle events or runnable, as Crossfire TRT is only
310	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	401	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		402	acceptable.
311		403
312	If it must be done, put the blocking parts into C<sync_job>. This will run	404	If it must be done, put the blocking parts into C<sync_job>. This will run
313	the given BLOCK in another coroutine while waiting for the result. The	405	the given BLOCK in another coroutine while waiting for the result. The
314	server will be frozen during this time, so the block should either finish	406	server will be frozen during this time, so the block should either finish
315	fast or be very important.	407	fast or be very important.
…		…
318		410
319	sub sync_job(&) {	411	sub sync_job(&) {
320	my ($job) = @_;	412	my ($job) = @_;
321		413
322	if ($Coro::current == $Coro::main) {	414	if ($Coro::current == $Coro::main) {
		415	my $time = Event::time;
		416
323	# this is the main coro, too bad, we have to block	417	# this is the main coro, too bad, we have to block
324	# till the operation succeeds, freezing the server :/	418	# till the operation succeeds, freezing the server :/
325		419
326	# TODO: use suspend/resume instead	420	# TODO: use suspend/resume instead
327	# (but this is cancel-safe)	421	# (but this is cancel-safe)
…		…
338		432
339	while ($busy) {	433	while ($busy) {
340	Coro::cede or Event::one_event;	434	Coro::cede or Event::one_event;
341	}	435	}
342		436
		437	$time = Event::time - $time;
		438
		439	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		440	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		441
		442	$tick_start += $time; # do not account sync jobs to server load
		443
343	wantarray ? @res : $res[0]	444	wantarray ? @res : $res[0]
344	} else {	445	} else {
345	# we are in another coroutine, how wonderful, everything just works	446	# we are in another coroutine, how wonderful, everything just works
346		447
347	$job->()	448	$job->()
…		…
366	$EXT_CORO{$coro+0} = $coro;	467	$EXT_CORO{$coro+0} = $coro;
367		468
368	$coro	469	$coro
369	}	470	}
370		471
371	sub write_runtime {	472	=item fork_call { }, $args
372	my $runtime = "$LOCALDIR/runtime";
373		473
374	# first touch the runtime file to show we are still running:	474	Executes the given code block with the given arguments in a seperate
375	# the fsync below can take a very very long time.	475	process, returning the results. Everything must be serialisable with
		476	Coro::Storable. May, of course, block. Note that the executed sub may
		477	never block itself or use any form of Event handling.
376		478
377	warn "touching runtime...\n";#d#	479	=cut
378	if (my $fh = aio_open $runtime, O_WRONLY, 0) {
379	utime undef, undef, $fh;
380	}
381		480
382	my $guard = cf::lock_acquire "write_runtime";	481	sub fork_call(&@) {
		482	my ($cb, @args) = @_;
383		483
384	warn "starting to write runtime...\n";#d#	484	# we seemingly have to make a local copy of the whole thing,
385	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	485	# otherwise perl prematurely frees the stuff :/
386	or return;	486	# TODO: investigate and fix (liekly this will be rather laborious)
387		487
388	my $value = $cf::RUNTIME + 90 + 10;	488	my @res = Coro::Util::fork_eval {
389	# 10 is the runtime save interval, for a monotonic clock	489	reset_signals;
390	# 60 allows for the watchdog to kill the server.	490	&$cb
		491	}, @args;
391		492
392	(aio_write $fh, 0, (length $value), $value, 0) <= 0	493	wantarray ? @res : $res[-1]
393	and return;	494	}
394		495
395	# always fsync - this file is important	496	=item $value = cf::db_get $family => $key
396	aio_fsync $fh
397	and return;
398		497
399	# touch it again to show we are up-to-date	498	Returns a single value from the environment database.
400	utime undef, undef, $fh;
401		499
402	close $fh	500	=item cf::db_put $family => $key => $value
403	or return;
404		501
405	aio_rename "$runtime~", $runtime	502	Stores the given C<$value> in the family. It can currently store binary
406	and return;	503	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
407		504
408	warn "... done writing runtime.\n";#d#	505	=cut
409		506
		507	our $DB;
		508
		509	sub db_init {
		510	unless ($DB) {
		511	$DB = BDB::db_create $DB_ENV;
		512
		513	cf::sync_job {
		514	eval {
		515	$DB->set_flags (BDB::CHKSUM);
		516
		517	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		518	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		519	cf::cleanup "db_open(db): $!" if $!;
		520	};
		521	cf::cleanup "db_open(db): $@" if $@;
		522	};
410	1	523	}
		524	}
		525
		526	sub db_get($$) {
		527	my $key = "$_[0]/$_[1]";
		528
		529	cf::sync_job {
		530	BDB::db_get $DB, undef, $key, my $data;
		531
		532	$! ? ()
		533	: $data
		534	}
		535	}
		536
		537	sub db_put($$$) {
		538	BDB::dbreq_pri 4;
		539	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		540	}
		541
		542	=item cf::cache $id => [$paths...], $processversion => $process
		543
		544	Generic caching function that returns the value of the resource $id,
		545	caching and regenerating as required.
		546
		547	This function can block.
		548
		549	=cut
		550
		551	sub cache {
		552	my ($id, $src, $processversion, $process) = @_;
		553
		554	my $meta =
		555	join "\x00",
		556	$processversion,
		557	map {
		558	aio_stat $_
		559	and Carp::croak "$_: $!";
		560
		561	($_, (stat _)[7,9])
		562	} @$src;
		563
		564	my $dbmeta = db_get cache => "$id/meta";
		565	if ($dbmeta ne $meta) {
		566	# changed, we may need to process
		567
		568	my @data;
		569	my $md5;
		570
		571	for (0 .. $#$src) {
		572	0 <= aio_load $src->[$_], $data[$_]
		573	or Carp::croak "$src->[$_]: $!";
		574	}
		575
		576	# if processing is expensive, check
		577	# checksum first
		578	if (1) {
		579	$md5 =
		580	join "\x00",
		581	$processversion,
		582	map {
		583	cf::cede_to_tick;
		584	($src->[$_], Digest::MD5::md5_hex $data[$_])
		585	} 0.. $#$src;
		586
		587
		588	my $dbmd5 = db_get cache => "$id/md5";
		589	if ($dbmd5 eq $md5) {
		590	db_put cache => "$id/meta", $meta;
		591
		592	return db_get cache => "$id/data";
		593	}
		594	}
		595
		596	my $t1 = Time::HiRes::time;
		597	my $data = $process->(\@data);
		598	my $t2 = Time::HiRes::time;
		599
		600	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		601
		602	db_put cache => "$id/data", $data;
		603	db_put cache => "$id/md5" , $md5;
		604	db_put cache => "$id/meta", $meta;
		605
		606	return $data;
		607	}
		608
		609	db_get cache => "$id/data"
411	}	610	}
412		611
413	=item cf::datalog type => key => value, ...	612	=item cf::datalog type => key => value, ...
414		613
415	Log a datalog packet of the given type with the given key-value pairs.	614	Log a datalog packet of the given type with the given key-value pairs.
…		…
433	attach callbacks/event handlers (a collection of which is called an "attachment")	632	attach callbacks/event handlers (a collection of which is called an "attachment")
434	to it. All such attachable objects support the following methods.	633	to it. All such attachable objects support the following methods.
435		634
436	In the following description, CLASS can be any of C<global>, C<object>	635	In the following description, CLASS can be any of C<global>, C<object>
437	C<player>, C<client> or C<map> (i.e. the attachable objects in	636	C<player>, C<client> or C<map> (i.e. the attachable objects in
438	crossfire+).	637	Crossfire TRT).
439		638
440	=over 4	639	=over 4
441		640
442	=item $attachable->attach ($attachment, key => $value...)	641	=item $attachable->attach ($attachment, key => $value...)
443		642
…		…
606	$registry = $CB_TYPE[$object_type] ||= [];	805	$registry = $CB_TYPE[$object_type] ||= [];
607		806
608	} elsif ($type eq "subtype") {	807	} elsif ($type eq "subtype") {
609	defined $object_type or Carp::croak "subtype specified without type";	808	defined $object_type or Carp::croak "subtype specified without type";
610	my $object_subtype = shift @arg;	809	my $object_subtype = shift @arg;
611	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	810	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
612		811
613	} elsif ($type eq "package") {	812	} elsif ($type eq "package") {
614	my $pkg = shift @arg;	813	my $pkg = shift @arg;
615		814
616	while (my ($name, $id) = each %cb_id) {	815	while (my ($name, $id) = each %cb_id) {
…		…
645	_attach $registry, $klass, @attach;	844	_attach $registry, $klass, @attach;
646	}	845	}
647		846
648	$obj->{$name} = \%arg;	847	$obj->{$name} = \%arg;
649	} else {	848	} else {
650	warn "object uses attachment '$name' that is not available, postponing.\n";	849	warn "object uses attachment '$name' which is not available, postponing.\n";
651	}	850	}
652		851
653	$obj->{_attachment}{$name} = undef;	852	$obj->{_attachment}{$name} = undef;
654	}	853	}
655		854
…		…
657	if (ref $_[0]) {	856	if (ref $_[0]) {
658	_object_attach @_;	857	_object_attach @_;
659	} else {	858	} else {
660	_attach shift->_attach_registry, @_;	859	_attach shift->_attach_registry, @_;
661	}	860	}
		861	_recalc_want;
662	};	862	};
663		863
664	# all those should be optimised	864	# all those should be optimised
665	sub cf::attachable::detach {	865	sub cf::attachable::detach {
666	my ($obj, $name) = @_;	866	my ($obj, $name) = @_;
…		…
669	delete $obj->{_attachment}{$name};	869	delete $obj->{_attachment}{$name};
670	reattach ($obj);	870	reattach ($obj);
671	} else {	871	} else {
672	Carp::croak "cannot, currently, detach class attachments";	872	Carp::croak "cannot, currently, detach class attachments";
673	}	873	}
		874	_recalc_want;
674	};	875	};
675		876
676	sub cf::attachable::attached {	877	sub cf::attachable::attached {
677	my ($obj, $name) = @_;	878	my ($obj, $name) = @_;
678		879
…		…
693	";	894	";
694	die if $@;	895	die if $@;
695	}	896	}
696		897
697	our $override;	898	our $override;
698	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	899	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
699		900
700	sub override {	901	sub override {
701	$override = 1;	902	$override = 1;
702	@invoke_results = ();	903	@INVOKE_RESULTS = (@_);
703	}	904	}
704		905
705	sub do_invoke {	906	sub do_invoke {
706	my $event = shift;	907	my $event = shift;
707	my $callbacks = shift;	908	my $callbacks = shift;
708		909
709	@invoke_results = ();	910	@INVOKE_RESULTS = ();
710		911
711	local $override;	912	local $override;
712		913
713	for (@$callbacks) {	914	for (@$callbacks) {
714	eval { &{$_->[1]} };	915	eval { &{$_->[1]} };
…		…
731		932
732	Generate an object-specific event with the given arguments.	933	Generate an object-specific event with the given arguments.
733		934
734	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	935	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
735	removed in future versions), and there is no public API to access override	936	removed in future versions), and there is no public API to access override
736	results (if you must, access C<@cf::invoke_results> directly).	937	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
737		938
738	=back	939	=back
739		940
740	=cut	941	=cut
741		942
742	#############################################################################	943	#############################################################################
743	# object support	944	# object support
		945	#
		946
		947	sub _can_merge {
		948	my ($ob1, $ob2) = @_;
		949
		950	local $Storable::canonical = 1;
		951	my $fob1 = Storable::freeze $ob1;
		952	my $fob2 = Storable::freeze $ob2;
		953
		954	$fob1 eq $fob2
		955	}
744		956
745	sub reattach {	957	sub reattach {
746	# basically do the same as instantiate, without calling instantiate	958	# basically do the same as instantiate, without calling instantiate
747	my ($obj) = @_;	959	my ($obj) = @_;
748		960
…		…
851	or return;	1063	or return;
852	$av = eval { (Storable::thaw $av)->{objs} };	1064	$av = eval { (Storable::thaw $av)->{objs} };
853	}	1065	}
854		1066
855	warn sprintf "loading %s (%d)\n",	1067	warn sprintf "loading %s (%d)\n",
856	$filename, length $data, scalar @{$av || []};#d#	1068	$filename, length $data, scalar @{$av || []};
857	return ($data, $av);	1069	return ($data, $av);
858	}	1070	}
		1071
		1072	=head2 COMMAND CALLBACKS
		1073
		1074	=over 4
		1075
		1076	=cut
859		1077
860	#############################################################################	1078	#############################################################################
861	# command handling &c	1079	# command handling &c
862		1080
863	=item cf::register_command $name => \&callback($ob,$args);	1081	=item cf::register_command $name => \&callback($ob,$args);
…		…
876	push @{ $COMMAND{$name} }, [$caller, $cb];	1094	push @{ $COMMAND{$name} }, [$caller, $cb];
877	}	1095	}
878		1096
879	=item cf::register_extcmd $name => \&callback($pl,$packet);	1097	=item cf::register_extcmd $name => \&callback($pl,$packet);
880		1098
881	Register a callbackf ro execution when the client sends an extcmd packet.	1099	Register a callback for execution when the client sends an (synchronous)
		1100	extcmd packet. Ext commands will be processed in the order they are
		1101	received by the server, like other user commands. The first argument is
		1102	the logged-in player. Ext commands can only be processed after a player
		1103	has logged in successfully.
882		1104
883	If the callback returns something, it is sent back as if reply was being	1105	If the callback returns something, it is sent back as if reply was being
884	called.	1106	called.
885		1107
		1108	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1109
		1110	Register a callback for execution when the client sends an (asynchronous)
		1111	exticmd packet. Exti commands are processed by the server as soon as they
		1112	are received, i.e. out of order w.r.t. other commands. The first argument
		1113	is a client socket. Exti commands can be received anytime, even before
		1114	log-in.
		1115
		1116	If the callback returns something, it is sent back as if reply was being
		1117	called.
		1118
886	=cut	1119	=cut
887		1120
888	sub register_extcmd {	1121	sub register_extcmd {
889	my ($name, $cb) = @_;	1122	my ($name, $cb) = @_;
890		1123
891	$EXTCMD{$name} = $cb;	1124	$EXTCMD{$name} = $cb;
		1125	}
		1126
		1127	sub register_exticmd {
		1128	my ($name, $cb) = @_;
		1129
		1130	$EXTICMD{$name} = $cb;
892	}	1131	}
893		1132
894	cf::player->attach (	1133	cf::player->attach (
895	on_command => sub {	1134	on_command => sub {
896	my ($pl, $name, $params) = @_;	1135	my ($pl, $name, $params) = @_;
…		…
905	cf::override;	1144	cf::override;
906	},	1145	},
907	on_extcmd => sub {	1146	on_extcmd => sub {
908	my ($pl, $buf) = @_;	1147	my ($pl, $buf) = @_;
909		1148
910	my $msg = eval { from_json $buf };	1149	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
911		1150
912	if (ref $msg) {	1151	if (ref $msg) {
		1152	my ($type, $reply, @payload) =
		1153	"ARRAY" eq ref $msg
		1154	? @$msg
		1155	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1156
		1157	my @reply;
		1158
913	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1159	if (my $cb = $EXTCMD{$type}) {
914	if (my %reply = $cb->($pl, $msg)) {	1160	@reply = $cb->($pl, @payload);
915	$pl->ext_reply ($msg->{msgid}, %reply);
916	}
917	}	1161	}
		1162
		1163	$pl->ext_reply ($reply, @reply)
		1164	if $reply;
		1165
918	} else {	1166	} else {
919	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1167	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
920	}	1168	}
921		1169
922	cf::override;	1170	cf::override;
923	},	1171	},
924	);	1172	);
925		1173
926	sub load_extension {
927	my ($path) = @_;
928
929	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
930	my $base = $1;
931	my $pkg = $1;
932	$pkg =~ s/[^[:word:]]/_/g;
933	$pkg = "ext::$pkg";
934
935	warn "... loading '$path' into '$pkg'\n";
936
937	open my $fh, "<:utf8", $path
938	or die "$path: $!";
939
940	my $source =
941	"package $pkg; use strict; use utf8;\n"
942	. "#line 1 \"$path\"\n{\n"
943	. (do { local $/; <$fh> })
944	. "\n};\n1";
945
946	unless (eval $source) {
947	my $msg = $@ ? "$path: $@\n"
948	: "extension disabled.\n";
949	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
950	warn $@;
951	warn "mandatory extension failed to load, exiting.\n";
952	exit 1;
953	}
954	die $@;
955	}
956
957	push @EXTS, $pkg;
958	}
959
960	sub load_extensions {	1174	sub load_extensions {
		1175	cf::sync_job {
		1176	my %todo;
		1177
961	for my $ext (<$LIBDIR/*.ext>) {	1178	for my $path (<$LIBDIR/*.ext>) {
962	next unless -r $ext;	1179	next unless -r $path;
963	eval {	1180
964	load_extension $ext;	1181	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1182	my $base = $1;
		1183	my $pkg = $1;
		1184	$pkg =~ s/[^[:word:]]/_/g;
		1185	$pkg = "ext::$pkg";
		1186
		1187	open my $fh, "<:utf8", $path
		1188	or die "$path: $!";
		1189
		1190	my $source = do { local $/; <$fh> };
		1191
		1192	my %ext = (
		1193	path => $path,
		1194	base => $base,
		1195	pkg => $pkg,
		1196	);
		1197
		1198	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1199	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1200
		1201	$ext{source} =
		1202	"package $pkg; use strict; use utf8;\n"
		1203	. "#line 1 \"$path\"\n{\n"
		1204	. $source
		1205	. "\n};\n1";
		1206
		1207	$todo{$base} = \%ext;
		1208	}
		1209
		1210	my %done;
		1211	while (%todo) {
		1212	my $progress;
		1213
		1214	while (my ($k, $v) = each %todo) {
		1215	for (split /,\s*/, $v->{meta}{depends}) {
		1216	goto skip
		1217	unless exists $done{$_};
		1218	}
		1219
		1220	warn "... loading '$k' into '$v->{pkg}'\n";
		1221
		1222	unless (eval $v->{source}) {
		1223	my $msg = $@ ? "$v->{path}: $@\n"
		1224	: "$v->{base}: extension inactive.\n";
		1225
		1226	if (exists $v->{meta}{mandatory}) {
		1227	warn $msg;
		1228	warn "mandatory extension failed to load, exiting.\n";
		1229	exit 1;
		1230	}
		1231
		1232	warn $msg;
		1233	}
		1234
		1235	$done{$k} = delete $todo{$k};
		1236	push @EXTS, $v->{pkg};
		1237	$progress = 1;
965	1	1238	}
966	} or warn "$ext not loaded: $@";	1239
		1240	skip:
		1241	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1242	unless $progress;
		1243	}
967	}	1244	};
968	}	1245	}
969		1246
970	#############################################################################	1247	#############################################################################
		1248
		1249	=back
971		1250
972	=head2 CORE EXTENSIONS	1251	=head2 CORE EXTENSIONS
973		1252
974	Functions and methods that extend core crossfire objects.	1253	Functions and methods that extend core crossfire objects.
975		1254
…		…
1046		1325
1047	aio_mkdir playerdir $pl, 0770;	1326	aio_mkdir playerdir $pl, 0770;
1048	$pl->{last_save} = $cf::RUNTIME;	1327	$pl->{last_save} = $cf::RUNTIME;
1049		1328
1050	$pl->save_pl ($path);	1329	$pl->save_pl ($path);
1051	Coro::cede;	1330	cf::cede_to_tick;
1052	}	1331	}
1053		1332
1054	sub new($) {	1333	sub new($) {
1055	my ($login) = @_;	1334	my ($login) = @_;
1056		1335
…		…
1060	$self->{deny_save} = 1;	1339	$self->{deny_save} = 1;
1061		1340
1062	$cf::PLAYER{$login} = $self;	1341	$cf::PLAYER{$login} = $self;
1063		1342
1064	$self	1343	$self
		1344	}
		1345
		1346	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1347
		1348	=cut
		1349
		1350	sub send_msg {
		1351	my $ns = shift->ns
		1352	or return;
		1353	$ns->send_msg (@_);
1065	}	1354	}
1066		1355
1067	=item $pl->quit_character	1356	=item $pl->quit_character
1068		1357
1069	Nukes the player without looking back. If logged in, the connection will	1358	Nukes the player without looking back. If logged in, the connection will
…		…
1124	or return [];	1413	or return [];
1125		1414
1126	my @logins;	1415	my @logins;
1127		1416
1128	for my $login (@$dirs) {	1417	for my $login (@$dirs) {
		1418	my $path = path $login;
		1419
		1420	# a .pst is a dead give-away for a valid player
		1421	unless (-e "$path.pst") {
1129	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1422	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1130	aio_read $fh, 0, 512, my $buf, 0 or next;	1423	aio_read $fh, 0, 512, my $buf, 0 or next;
1131	$buf !~ /^password -------------$/m or next; # official not-valid tag	1424	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1425	}
1132		1426
1133	utf8::decode $login;	1427	utf8::decode $login;
1134	push @logins, $login;	1428	push @logins, $login;
1135	}	1429	}
1136		1430
…		…
1163	}	1457	}
1164		1458
1165	\@paths	1459	\@paths
1166	}	1460	}
1167		1461
		1462	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1463
		1464	Expand crossfire pod fragments into protocol xml.
		1465
		1466	=cut
		1467
		1468	sub expand_cfpod {
		1469	((my $self), (local $_)) = @_;
		1470
		1471	# escape & and <
		1472	s/&/&amp;/g;
		1473	s/(?<![BIUGHT])</&lt;/g;
		1474
		1475	# this is buggy, it needs to properly take care of nested <'s
		1476
		1477	1 while
		1478	# replace B<>, I<>, U<> etc.
		1479	s/B<([^\>]*)>/<b>$1<\/b>/
		1480	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1481	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1482	|| s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
		1483	# replace G<male|female> tags
		1484	|| s{G<([^>|]*)\|([^>]*)>}{
		1485	$self->gender ? $2 : $1
		1486	}ge
		1487	# replace H<hint text>
		1488	|| s{H<([^\>]*)>}
		1489	{
		1490	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1491	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1492	"")
		1493	[$self->{hintmode}]
		1494	}ge;
		1495
		1496	# create single paragraphs (very hackish)
		1497	s/(?<=\S)\n(?=\w)/ /g;
		1498
		1499	# compress some whitespace
		1500	s/\s+\n/\n/g; # ws line-ends
		1501	s/\n\n+/\n/g; # double lines
		1502	s/^\n+//; # beginning lines
		1503	s/\n+$//; # ending lines
		1504
		1505	$_
		1506	}
		1507
		1508	sub hintmode {
		1509	$_[0]{hintmode} = $_[1] if @_ > 1;
		1510	$_[0]{hintmode}
		1511	}
		1512
1168	=item $player->ext_reply ($msgid, %msg)	1513	=item $player->ext_reply ($msgid, @msg)
1169		1514
1170	Sends an ext reply to the player.	1515	Sends an ext reply to the player.
1171		1516
1172	=cut	1517	=cut
1173		1518
1174	sub ext_reply($$%) {	1519	sub ext_reply($$@) {
1175	my ($self, $id, %msg) = @_;	1520	my ($self, $id, @msg) = @_;
1176		1521
1177	$msg{msgid} = $id;	1522	$self->ns->ext_reply ($id, @msg)
1178
1179	$self->send ("ext " . cf::to_json \%msg);
1180	}	1523	}
1181		1524
1182	=item $player->ext_event ($type, %msg)	1525	=item $player->ext_msg ($type, @msg)
1183		1526
1184	Sends an ext event to the client.	1527	Sends an ext event to the client.
1185		1528
1186	=cut	1529	=cut
1187		1530
1188	sub ext_event($$%) {	1531	sub ext_msg($$@) {
1189	my ($self, $type, %msg) = @_;	1532	my ($self, $type, @msg) = @_;
1190		1533
1191	$self->ns->ext_event ($type, %msg);	1534	$self->ns->ext_msg ($type, @msg);
1192	}	1535	}
1193		1536
1194	=head3 cf::region	1537	=head3 cf::region
1195		1538
1196	=over 4	1539	=over 4
…		…
1199		1542
1200	package cf::region;	1543	package cf::region;
1201		1544
1202	=item cf::region::find_by_path $path	1545	=item cf::region::find_by_path $path
1203		1546
1204	Tries to decuce the probable region for a map knowing only its path.	1547	Tries to decuce the likely region for a map knowing only its path.
1205		1548
1206	=cut	1549	=cut
1207		1550
1208	sub find_by_path($) {	1551	sub find_by_path($) {
1209	my ($path) = @_;	1552	my ($path) = @_;
1210		1553
1211	my ($match, $specificity);	1554	my ($match, $specificity);
1212		1555
1213	for my $region (list) {	1556	for my $region (list) {
1214	if ($region->match && $path =~ $region->match) {	1557	if ($region->{match} && $path =~ $region->{match}) {
1215	($match, $specificity) = ($region, $region->specificity)	1558	($match, $specificity) = ($region, $region->specificity)
1216	if $region->specificity > $specificity;	1559	if $region->specificity > $specificity;
1217	}	1560	}
1218	}	1561	}
1219		1562
…		…
1283	my ($self, $merge) = @_;	1626	my ($self, $merge) = @_;
1284		1627
1285	# we have to keep some variables in memory intact	1628	# we have to keep some variables in memory intact
1286	local $self->{path};	1629	local $self->{path};
1287	local $self->{load_path};	1630	local $self->{load_path};
1288	local $self->{deny_save};
1289	local $self->{deny_reset};
1290		1631
1291	$self->SUPER::thawer_merge ($merge);	1632	$self->SUPER::thawer_merge ($merge);
1292	}	1633	}
1293		1634
1294	sub normalise {	1635	sub normalise {
…		…
1341	$self->init; # pass $1 etc.	1682	$self->init; # pass $1 etc.
1342	return $self;	1683	return $self;
1343	}	1684	}
1344	}	1685	}
1345		1686
1346	Carp::carp "unable to resolve path '$path' (base '$base').";	1687	Carp::cluck "unable to resolve path '$path' (base '$base').";
1347	()	1688	()
1348	}	1689	}
1349		1690
1350	sub init {	1691	sub init {
1351	my ($self) = @_;	1692	my ($self) = @_;
…		…
1392	sub change_all_map_light {	1733	sub change_all_map_light {
1393	my ($change) = @_;	1734	my ($change) = @_;
1394		1735
1395	$_->change_map_light ($change)	1736	$_->change_map_light ($change)
1396	for grep $_->outdoor, values %cf::MAP;	1737	for grep $_->outdoor, values %cf::MAP;
		1738	}
		1739
		1740	sub decay_objects {
		1741	my ($self) = @_;
		1742
		1743	return if $self->{deny_reset};
		1744
		1745	$self->do_decay_objects;
1397	}	1746	}
1398		1747
1399	sub unlink_save {	1748	sub unlink_save {
1400	my ($self) = @_;	1749	my ($self) = @_;
1401		1750
…		…
1459	$self->load_header_orig	1808	$self->load_header_orig
1460	or return;	1809	or return;
1461	$self->prepare_orig;	1810	$self->prepare_orig;
1462	}	1811	}
1463		1812
		1813	$self->{deny_reset} = 1
		1814	if $self->no_reset;
		1815
1464	$self->default_region (cf::region::find_by_path $self->{path})	1816	$self->default_region (cf::region::find_by_path $self->{path})
1465	unless $self->default_region;	1817	unless $self->default_region;
1466		1818
1467	1	1819	1
1468	}	1820	}
…		…
1483	$map->{last_save} = $cf::RUNTIME;	1835	$map->{last_save} = $cf::RUNTIME;
1484		1836
1485	$map->load_header	1837	$map->load_header
1486	or return;	1838	or return;
1487		1839
1488	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1840	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1489	# doing this can freeze the server in a sync job, obviously	1841	# doing this can freeze the server in a sync job, obviously
1490	#$cf::WAIT_FOR_TICK->wait;	1842	#$cf::WAIT_FOR_TICK->wait;
1491	$map->reset;	1843	$map->reset;
1492	undef $guard;	1844	undef $guard;
1493	return find $path;	1845	return find $path;
…		…
1506	local $self->{deny_reset} = 1; # loading can take a long time	1858	local $self->{deny_reset} = 1; # loading can take a long time
1507		1859
1508	my $path = $self->{path};	1860	my $path = $self->{path};
1509		1861
1510	{	1862	{
		1863	my $guard1 = cf::lock_acquire "map_data:$path";
1511	my $guard = cf::lock_acquire "map_load:$path";	1864	my $guard2 = cf::lock_acquire "map_load:$path";
1512		1865
1513	return if $self->in_memory != cf::MAP_SWAPPED;	1866	return if $self->in_memory != cf::MAP_SWAPPED;
1514		1867
1515	$self->in_memory (cf::MAP_LOADING);	1868	$self->in_memory (cf::MAP_LOADING);
1516		1869
1517	$self->alloc;	1870	$self->alloc;
1518		1871
1519	$self->pre_load;	1872	$self->pre_load;
1520	Coro::cede;	1873	cf::cede_to_tick;
1521		1874
1522	$self->_load_objects ($self->{load_path}, 1)	1875	$self->_load_objects ($self->{load_path}, 1)
1523	or return;	1876	or return;
1524		1877
1525	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1878	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
…		…
1531	$self->clear_unique_items;	1884	$self->clear_unique_items;
1532	$self->_load_objects ($uniq, 0);	1885	$self->_load_objects ($uniq, 0);
1533	}	1886	}
1534	}	1887	}
1535		1888
1536	Coro::cede;	1889	cf::cede_to_tick;
1537	# now do the right thing for maps	1890	# now do the right thing for maps
1538	$self->link_multipart_objects;	1891	$self->link_multipart_objects;
1539	$self->difficulty ($self->estimate_difficulty)	1892	$self->difficulty ($self->estimate_difficulty)
1540	unless $self->difficulty;	1893	unless $self->difficulty;
1541	Coro::cede;	1894	cf::cede_to_tick;
1542		1895
1543	unless ($self->{deny_activate}) {	1896	unless ($self->{deny_activate}) {
1544	$self->decay_objects;	1897	$self->decay_objects;
1545	$self->fix_auto_apply;	1898	$self->fix_auto_apply;
1546	$self->update_buttons;	1899	$self->update_buttons;
1547	Coro::cede;	1900	cf::cede_to_tick;
1548	$self->set_darkness_map;	1901	$self->set_darkness_map;
1549	Coro::cede;	1902	cf::cede_to_tick;
1550	$self->activate;	1903	$self->activate;
1551	}	1904	}
		1905
		1906	$self->{last_save} = $cf::RUNTIME;
		1907	$self->last_access ($cf::RUNTIME);
1552		1908
1553	$self->in_memory (cf::MAP_IN_MEMORY);	1909	$self->in_memory (cf::MAP_IN_MEMORY);
1554	}	1910	}
1555		1911
1556	$self->post_load;	1912	$self->post_load;
…		…
1560	my ($self, $ob) = @_;	1916	my ($self, $ob) = @_;
1561		1917
1562	return find "~" . $ob->name . "/" . $self->{path}	1918	return find "~" . $ob->name . "/" . $self->{path}
1563	if $self->per_player;	1919	if $self->per_player;
1564		1920
		1921	# return find "?party/" . $ob->name . "/" . $self->{path}
		1922	# if $self->per_party;
		1923
1565	$self	1924	$self
1566	}	1925	}
1567		1926
1568	# find and load all maps in the 3x3 area around a map	1927	# find and load all maps in the 3x3 area around a map
1569	sub load_diag {	1928	sub load_neighbours {
1570	my ($map) = @_;	1929	my ($map) = @_;
1571		1930
1572	my @diag; # diagonal neighbours	1931	my @neigh; # diagonal neighbours
1573		1932
1574	for (0 .. 3) {	1933	for (0 .. 3) {
1575	my $neigh = $map->tile_path ($_)	1934	my $neigh = $map->tile_path ($_)
1576	or next;	1935	or next;
1577	$neigh = find $neigh, $map	1936	$neigh = find $neigh, $map
1578	or next;	1937	or next;
1579	$neigh->load;	1938	$neigh->load;
1580		1939
		1940	push @neigh,
1581	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	1941	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1582	[$neigh->tile_path (($_ + 1) % 4), $neigh];	1942	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1583	}	1943	}
1584		1944
1585	for (@diag) {	1945	for (grep defined $_->[0], @neigh) {
		1946	my ($path, $origin) = @$_;
1586	my $neigh = find @$_	1947	my $neigh = find $path, $origin
1587	or next;	1948	or next;
1588	$neigh->load;	1949	$neigh->load;
1589	}	1950	}
1590	}	1951	}
1591		1952
…		…
1596	}	1957	}
1597		1958
1598	sub do_load_sync {	1959	sub do_load_sync {
1599	my ($map) = @_;	1960	my ($map) = @_;
1600		1961
		1962	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		1963	if $Coro::current == $Coro::main;
		1964
1601	cf::sync_job { $map->load };	1965	cf::sync_job { $map->load };
1602	}	1966	}
1603		1967
1604	our %MAP_PREFETCH;	1968	our %MAP_PREFETCH;
1605	our $MAP_PREFETCHER = undef;	1969	our $MAP_PREFETCHER = undef;
1606		1970
1607	sub find_async {	1971	sub find_async {
1608	my ($path, $origin) = @_;	1972	my ($path, $origin, $load) = @_;
1609		1973
1610	$path = normalise $path, $origin && $origin->{path};	1974	$path = normalise $path, $origin && $origin->{path};
1611		1975
1612	if (my $map = $cf::MAP{$path}) {	1976	if (my $map = $cf::MAP{$path}) {
1613	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	1977	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1614	}	1978	}
1615		1979
1616	undef $MAP_PREFETCH{$path};	1980	$MAP_PREFETCH{$path} |= $load;
		1981
1617	$MAP_PREFETCHER ||= cf::async {	1982	$MAP_PREFETCHER ||= cf::async {
1618	while (%MAP_PREFETCH) {	1983	while (%MAP_PREFETCH) {
1619	for my $path (keys %MAP_PREFETCH) {	1984	while (my ($k, $v) = each %MAP_PREFETCH) {
1620	my $map = find $path	1985	if (my $map = find $k) {
1621	or next;
1622	$map->load;	1986	$map->load if $v;
		1987	}
1623		1988
1624	delete $MAP_PREFETCH{$path};	1989	delete $MAP_PREFETCH{$k};
1625	}	1990	}
1626	}	1991	}
1627	undef $MAP_PREFETCHER;	1992	undef $MAP_PREFETCHER;
1628	};	1993	};
1629	$MAP_PREFETCHER->prio (6);	1994	$MAP_PREFETCHER->prio (6);
…		…
1632	}	1997	}
1633		1998
1634	sub save {	1999	sub save {
1635	my ($self) = @_;	2000	my ($self) = @_;
1636		2001
1637	my $lock = cf::lock_acquire "map_data:" . $self->path;	2002	my $lock = cf::lock_acquire "map_data:$self->{path}";
1638		2003
1639	$self->{last_save} = $cf::RUNTIME;	2004	$self->{last_save} = $cf::RUNTIME;
1640		2005
1641	return unless $self->dirty;	2006	return unless $self->dirty;
1642		2007
…		…
1665	my ($self) = @_;	2030	my ($self) = @_;
1666		2031
1667	# save first because save cedes	2032	# save first because save cedes
1668	$self->save;	2033	$self->save;
1669		2034
1670	my $lock = cf::lock_acquire "map_data:" . $self->path;	2035	my $lock = cf::lock_acquire "map_data:$self->{path}";
1671		2036
1672	return if $self->players;	2037	return if $self->players;
1673	return if $self->in_memory != cf::MAP_IN_MEMORY;	2038	return if $self->in_memory != cf::MAP_IN_MEMORY;
1674	return if $self->{deny_save};	2039	return if $self->{deny_save};
1675		2040
…		…
1679		2044
1680	sub reset_at {	2045	sub reset_at {
1681	my ($self) = @_;	2046	my ($self) = @_;
1682		2047
1683	# TODO: safety, remove and allow resettable per-player maps	2048	# TODO: safety, remove and allow resettable per-player maps
1684	return 1e99 if $self->isa ("ext::map_per_player");#d#
1685	return 1e99 if $self->{deny_reset};	2049	return 1e99 if $self->{deny_reset};
1686		2050
1687	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2051	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1688	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2052	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1689		2053
…		…
1700	my ($self) = @_;	2064	my ($self) = @_;
1701		2065
1702	my $lock = cf::lock_acquire "map_data:$self->{path}";	2066	my $lock = cf::lock_acquire "map_data:$self->{path}";
1703		2067
1704	return if $self->players;	2068	return if $self->players;
1705	return if $self->isa ("ext::map_per_player");#d#
1706		2069
1707	warn "resetting map ", $self->path;#d#	2070	warn "resetting map ", $self->path;
1708		2071
1709	$self->in_memory (cf::MAP_SWAPPED);	2072	$self->in_memory (cf::MAP_SWAPPED);
1710		2073
1711	# need to save uniques path	2074	# need to save uniques path
1712	unless ($self->{deny_save}) {	2075	unless ($self->{deny_save}) {
…		…
1729	my $nuke_counter = "aaaa";	2092	my $nuke_counter = "aaaa";
1730		2093
1731	sub nuke {	2094	sub nuke {
1732	my ($self) = @_;	2095	my ($self) = @_;
1733		2096
		2097	{
		2098	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2099
1734	delete $cf::MAP{$self->path};	2100	delete $cf::MAP{$self->path};
1735		2101
1736	$self->unlink_save;	2102	$self->unlink_save;
1737		2103
1738	bless $self, "cf::map";	2104	bless $self, "cf::map";
1739	delete $self->{deny_reset};	2105	delete $self->{deny_reset};
1740	$self->{deny_save} = 1;	2106	$self->{deny_save} = 1;
1741	$self->reset_timeout (1);	2107	$self->reset_timeout (1);
1742	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2108	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1743		2109
1744	$cf::MAP{$self->path} = $self;	2110	$cf::MAP{$self->path} = $self;
		2111	}
1745		2112
1746	$self->reset; # polite request, might not happen	2113	$self->reset; # polite request, might not happen
		2114	}
		2115
		2116	=item $maps = cf::map::tmp_maps
		2117
		2118	Returns an arrayref with all map paths of currently instantiated and saved
		2119	maps. May block.
		2120
		2121	=cut
		2122
		2123	sub tmp_maps() {
		2124	[
		2125	map {
		2126	utf8::decode $_;
		2127	/\.map$/
		2128	? normalise $_
		2129	: ()
		2130	} @{ aio_readdir $TMPDIR or [] }
		2131	]
		2132	}
		2133
		2134	=item $maps = cf::map::random_maps
		2135
		2136	Returns an arrayref with all map paths of currently instantiated and saved
		2137	random maps. May block.
		2138
		2139	=cut
		2140
		2141	sub random_maps() {
		2142	[
		2143	map {
		2144	utf8::decode $_;
		2145	/\.map$/
		2146	? normalise "?random/$_"
		2147	: ()
		2148	} @{ aio_readdir $RANDOMDIR or [] }
		2149	]
1747	}	2150	}
1748		2151
1749	=item cf::map::unique_maps	2152	=item cf::map::unique_maps
1750		2153
1751	Returns an arrayref of paths of all shared maps that have	2154	Returns an arrayref of paths of all shared maps that have
1752	instantiated unique items. May block.	2155	instantiated unique items. May block.
1753		2156
1754	=cut	2157	=cut
1755		2158
1756	sub unique_maps() {	2159	sub unique_maps() {
1757	my $files = aio_readdir $UNIQUEDIR	2160	[
1758	or return;	2161	map {
1759
1760	my @paths;
1761
1762	for (@$files) {
1763	utf8::decode $_;	2162	utf8::decode $_;
1764	next if /\.pst$/;	2163	/\.map$/
1765	next unless /^$PATH_SEP/o;	2164	? normalise $_
1766		2165	: ()
1767	push @paths, cf::map::normalise $_;	2166	} @{ aio_readdir $UNIQUEDIR or [] }
1768	}	2167	]
1769
1770	\@paths
1771	}	2168	}
1772		2169
1773	package cf;	2170	package cf;
1774		2171
1775	=back	2172	=back
…		…
1821		2218
1822	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2219	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1823		2220
1824	if ($self->{record_replies}) {	2221	if ($self->{record_replies}) {
1825	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2222	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2223
1826	} else {	2224	} else {
		2225	my $pl = $self->contr;
		2226
		2227	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2228	my $dialog = $pl->{npc_dialog};
		2229	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2230
		2231	} else {
1827	$msg = $npc->name . " says: $msg" if $npc;	2232	$msg = $npc->name . " says: $msg" if $npc;
1828	$self->message ($msg, $flags);	2233	$self->message ($msg, $flags);
		2234	}
1829	}	2235	}
		2236	}
		2237
		2238	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2239
		2240	=cut
		2241
		2242	sub cf::object::send_msg {
		2243	my $pl = shift->contr
		2244	or return;
		2245	$pl->send_msg (@_);
1830	}	2246	}
1831		2247
1832	=item $player_object->may ("access")	2248	=item $player_object->may ("access")
1833		2249
1834	Returns wether the given player is authorized to access resource "access"	2250	Returns wether the given player is authorized to access resource "access"
…		…
1881	$self->deactivate_recursive;	2297	$self->deactivate_recursive;
1882		2298
1883	return if UNIVERSAL::isa $self->map, "ext::map_link";	2299	return if UNIVERSAL::isa $self->map, "ext::map_link";
1884		2300
1885	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2301	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1886	if $self->map;	2302	if $self->map && $self->map->{path} ne "{link}";
1887		2303
1888	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2304	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1889	}	2305	}
1890		2306
1891	sub cf::object::player::leave_link {	2307	sub cf::object::player::leave_link {
1892	my ($self, $map, $x, $y) = @_;	2308	my ($self, $map, $x, $y) = @_;
		2309
		2310	return unless $self->contr->active;
1893		2311
1894	my $link_pos = delete $self->{_link_pos};	2312	my $link_pos = delete $self->{_link_pos};
1895		2313
1896	unless ($map) {	2314	unless ($map) {
1897	# restore original map position	2315	# restore original map position
…		…
1911	# use -1 or undef as default coordinates, not 0, 0	2329	# use -1 or undef as default coordinates, not 0, 0
1912	($x, $y) = ($map->enter_x, $map->enter_y)	2330	($x, $y) = ($map->enter_x, $map->enter_y)
1913	if $x <=0 && $y <= 0;	2331	if $x <=0 && $y <= 0;
1914		2332
1915	$map->load;	2333	$map->load;
1916	$map->load_diag;	2334	$map->load_neighbours;
1917		2335
1918	return unless $self->contr->active;	2336	return unless $self->contr->active;
1919	$self->activate_recursive;	2337	$self->activate_recursive;
1920		2338
1921	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2339	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1922	$self->enter_map ($map, $x, $y);	2340	$self->enter_map ($map, $x, $y);
1923	}	2341	}
1924		2342
1925	cf::player->attach (	2343	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1926	on_logout => sub {
1927	my ($pl) = @_;
1928		2344
1929	# abort map switching before logout	2345	Moves the player to the given map-path and coordinates by first freezing
1930	if ($pl->ob->{_link_pos}) {	2346	her, loading and preparing them map, calling the provided $check callback
1931	cf::sync_job {	2347	that has to return the map if sucecssful, and then unfreezes the player on
1932	$pl->ob->leave_link	2348	the new (success) or old (failed) map position. In either case, $done will
1933	};	2349	be called at the end of this process.
1934	}
1935	},
1936	on_login => sub {
1937	my ($pl) = @_;
1938		2350
1939	# try to abort aborted map switching on player login :)
1940	# should happen only on crashes
1941	if ($pl->ob->{_link_pos}) {
1942	$pl->ob->enter_link;
1943	(async {
1944	$pl->ob->reply (undef,
1945	"There was an internal problem at your last logout, "
1946	. "the server will try to bring you to your intended destination in a second.",
1947	cf::NDI_RED);
1948	# we need this sleep as the login has a concurrent enter_exit running
1949	# and this sleep increases chances of the player not ending up in scorn
1950	Coro::Timer::sleep 1;
1951	$pl->ob->leave_link;
1952	})->prio (2);
1953	}
1954	},
1955	);
1956
1957	=item $player_object->goto ($path, $x, $y)
1958
1959	=cut	2351	=cut
		2352
		2353	our $GOTOGEN;
1960		2354
1961	sub cf::object::player::goto {	2355	sub cf::object::player::goto {
1962	my ($self, $path, $x, $y) = @_;	2356	my ($self, $path, $x, $y, $check, $done) = @_;
		2357
		2358	# do generation counting so two concurrent goto's will be executed in-order
		2359	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1963		2360
1964	$self->enter_link;	2361	$self->enter_link;
1965		2362
1966	(async {	2363	(async {
1967	my $map = eval {	2364	my $map = eval {
1968	my $map = cf::map::find $path;	2365	my $map = cf::map::find $path;
		2366
		2367	if ($map) {
1969	$map = $map->customise_for ($self) if $map;	2368	$map = $map->customise_for ($self);
		2369	$map = $check->($map) if $check && $map;
		2370	} else {
		2371	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2372	}
		2373
1970	$map	2374	$map
		2375	};
		2376
		2377	if ($@) {
		2378	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2379	LOG llevError | logBacktrace, Carp::longmess $@;
1971	} or	2380	}
1972	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1973		2381
		2382	if ($gen == $self->{_goto_generation}) {
		2383	delete $self->{_goto_generation};
1974	$self->leave_link ($map, $x, $y);	2384	$self->leave_link ($map, $x, $y);
		2385	}
		2386
		2387	$done->() if $done;
1975	})->prio (1);	2388	})->prio (1);
1976	}	2389	}
1977		2390
1978	=item $player_object->enter_exit ($exit_object)	2391	=item $player_object->enter_exit ($exit_object)
1979		2392
…		…
2048	my $hp = $exit->stats->hp;	2461	my $hp = $exit->stats->hp;
2049	my $sp = $exit->stats->sp;	2462	my $sp = $exit->stats->sp;
2050		2463
2051	$self->enter_link;	2464	$self->enter_link;
2052		2465
		2466	# if exit is damned, update players death & WoR home-position
		2467	$self->contr->savebed ($slaying, $hp, $sp)
		2468	if $exit->flag (FLAG_DAMNED);
		2469
2053	(async {	2470	(async {
2054	$self->deactivate_recursive; # just to be sure	2471	$self->deactivate_recursive; # just to be sure
2055	unless (eval {	2472	unless (eval {
2056	$self->goto ($slaying, $hp, $sp);	2473	$self->goto ($slaying, $hp, $sp);
2057		2474
…		…
2084		2501
2085	utf8::encode $text;	2502	utf8::encode $text;
2086	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2503	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2087	}	2504	}
2088		2505
		2506	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2507
		2508	Send a drawinfo or msg packet to the client, formatting the msg for the
		2509	client if neccessary. C<$type> should be a string identifying the type of
		2510	the message, with C<log> being the default. If C<$color> is negative, suppress
		2511	the message unless the client supports the msg packet.
		2512
		2513	=cut
		2514
		2515	our %CHANNEL = (
		2516	"c/identify" => {
		2517	id => "identify",
		2518	title => "Identify",
		2519	reply => undef,
		2520	tooltip => "Items recently identified",
		2521	},
		2522	"c/examine" => {
		2523	id => "examine",
		2524	title => "Examine",
		2525	reply => undef,
		2526	tooltip => "Signs and other items you examined",
		2527	},
		2528	);
		2529
		2530	sub cf::client::send_msg {
		2531	my ($self, $channel, $msg, $color, @extra) = @_;
		2532
		2533	$msg = $self->pl->expand_cfpod ($msg);
		2534
		2535	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2536
		2537	# check predefined channels, for the benefit of C
		2538	$channel = $CHANNEL{$channel} if $CHANNEL{$channel};
		2539
		2540	if (ref $channel) {
		2541	# send meta info to client, if not yet sent
		2542	unless (exists $self->{channel}{$channel->{id}}) {
		2543	$self->{channel}{$channel->{id}} = $channel;
		2544	$self->ext_msg (channel_info => $channel)
		2545	if $self->can_msg;
		2546	}
		2547
		2548	$channel = $channel->{id};
		2549	}
		2550
		2551	return unless @extra || length $msg;
		2552
		2553	if ($self->can_msg) {
		2554	# default colour, mask it out
		2555	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2556	if $color & cf::NDI_DEF;
		2557
		2558	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2559	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2560	} else {
		2561	if ($color >= 0) {
		2562	# replace some tags by gcfclient-compatible ones
		2563	for ($msg) {
		2564	1 while
		2565	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2566	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2567	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2568	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2569	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2570	}
		2571
		2572	$color &= cf::NDI_COLOR_MASK;
		2573
		2574	utf8::encode $msg;
		2575
		2576	if (0 && $msg =~ /\[/) {
		2577	# COMMAND/INFO
		2578	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2579	} else {
		2580	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2581	$self->send_packet ("drawinfo $color $msg")
		2582	}
		2583	}
		2584	}
		2585	}
		2586
2089	=item $client->ext_event ($type, %msg)	2587	=item $client->ext_msg ($type, @msg)
2090		2588
2091	Sends an exti event to the client.	2589	Sends an ext event to the client.
2092		2590
2093	=cut	2591	=cut
2094		2592
2095	sub cf::client::ext_event($$%) {	2593	sub cf::client::ext_msg($$@) {
2096	my ($self, $type, %msg) = @_;	2594	my ($self, $type, @msg) = @_;
2097		2595
		2596	if ($self->extcmd == 2) {
		2597	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2598	} elsif ($self->extcmd == 1) { # TODO: remove
2098	$msg{msgtype} = "event_$type";	2599	push @msg, msgtype => "event_$type";
2099	$self->send_packet ("ext " . cf::to_json \%msg);	2600	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2601	}
		2602	}
		2603
		2604	=item $client->ext_reply ($msgid, @msg)
		2605
		2606	Sends an ext reply to the client.
		2607
		2608	=cut
		2609
		2610	sub cf::client::ext_reply($$@) {
		2611	my ($self, $id, @msg) = @_;
		2612
		2613	if ($self->extcmd == 2) {
		2614	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2615	} elsif ($self->extcmd == 1) {
		2616	#TODO: version 1, remove
		2617	unshift @msg, msgtype => "reply", msgid => $id;
		2618	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2619	}
2100	}	2620	}
2101		2621
2102	=item $success = $client->query ($flags, "text", \&cb)	2622	=item $success = $client->query ($flags, "text", \&cb)
2103		2623
2104	Queues a query to the client, calling the given callback with	2624	Queues a query to the client, calling the given callback with
2105	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2625	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2106	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2626	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2107		2627
2108	Queries can fail, so check the return code. Or don't, as queries will become	2628	Queries can fail, so check the return code. Or don't, as queries will
2109	reliable at some point in the future.	2629	become reliable at some point in the future.
2110		2630
2111	=cut	2631	=cut
2112		2632
2113	sub cf::client::query {	2633	sub cf::client::query {
2114	my ($self, $flags, $text, $cb) = @_;	2634	my ($self, $flags, $text, $cb) = @_;
…		…
2122	utf8::encode $text;	2642	utf8::encode $text;
2123	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2643	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2124		2644
2125	$self->send_packet ($self->{query_queue}[0][0])	2645	$self->send_packet ($self->{query_queue}[0][0])
2126	if @{ $self->{query_queue} } == 1;	2646	if @{ $self->{query_queue} } == 1;
		2647
		2648	1
2127	}	2649	}
2128		2650
2129	cf::client->attach (	2651	cf::client->attach (
		2652	on_connect => sub {
		2653	my ($ns) = @_;
		2654
		2655	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2656	},
2130	on_reply => sub {	2657	on_reply => sub {
2131	my ($ns, $msg) = @_;	2658	my ($ns, $msg) = @_;
2132		2659
2133	# this weird shuffling is so that direct followup queries	2660	# this weird shuffling is so that direct followup queries
2134	# get handled first	2661	# get handled first
…		…
2146	} else {	2673	} else {
2147	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2674	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2148	}	2675	}
2149	}	2676	}
2150	},	2677	},
		2678	on_exticmd => sub {
		2679	my ($ns, $buf) = @_;
		2680
		2681	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2682
		2683	if (ref $msg) {
		2684	my ($type, $reply, @payload) =
		2685	"ARRAY" eq ref $msg
		2686	? @$msg
		2687	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2688
		2689	my @reply;
		2690
		2691	if (my $cb = $EXTICMD{$type}) {
		2692	@reply = $cb->($ns, @payload);
		2693	}
		2694
		2695	$ns->ext_reply ($reply, @reply)
		2696	if $reply;
		2697
		2698	} else {
		2699	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2700	}
		2701
		2702	cf::override;
		2703	},
2151	);	2704	);
2152		2705
2153	=item $client->async (\&cb)	2706	=item $client->async (\&cb)
2154		2707
2155	Create a new coroutine, running the specified callback. The coroutine will	2708	Create a new coroutine, running the specified callback. The coroutine will
…		…
2196	our $safe = new Safe "safe";	2749	our $safe = new Safe "safe";
2197	our $safe_hole = new Safe::Hole;	2750	our $safe_hole = new Safe::Hole;
2198		2751
2199	$SIG{FPE} = 'IGNORE';	2752	$SIG{FPE} = 'IGNORE';
2200		2753
2201	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2754	$safe->permit_only (Opcode::opset qw(
		2755	:base_core :base_mem :base_orig :base_math
		2756	grepstart grepwhile mapstart mapwhile
		2757	sort time
		2758	));
2202		2759
2203	# here we export the classes and methods available to script code	2760	# here we export the classes and methods available to script code
2204		2761
2205	=pod	2762	=pod
2206		2763
2207	The following functions and methods are available within a safe environment:	2764	The following functions and methods are available within a safe environment:
2208		2765
2209	cf::object contr pay_amount pay_player map	2766	cf::object
		2767	contr pay_amount pay_player map x y force_find force_add
		2768	insert remove name archname title slaying race decrease_ob_nr
		2769
2210	cf::object::player player	2770	cf::object::player
2211	cf::player peaceful	2771	player
2212	cf::map trigger	2772
		2773	cf::player
		2774	peaceful
		2775
		2776	cf::map
		2777	trigger
2213		2778
2214	=cut	2779	=cut
2215		2780
2216	for (	2781	for (
2217	["cf::object" => qw(contr pay_amount pay_player map)],	2782	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2783	insert remove inv name archname title slaying race
		2784	decrease_ob_nr)],
2218	["cf::object::player" => qw(player)],	2785	["cf::object::player" => qw(player)],
2219	["cf::player" => qw(peaceful)],	2786	["cf::player" => qw(peaceful)],
2220	["cf::map" => qw(trigger)],	2787	["cf::map" => qw(trigger)],
2221	) {	2788	) {
2222	no strict 'refs';	2789	no strict 'refs';
…		…
2293	=back	2860	=back
2294		2861
2295	=cut	2862	=cut
2296		2863
2297	#############################################################################	2864	#############################################################################
2298
2299	=head2 EXTENSION DATABASE SUPPORT
2300
2301	Crossfire maintains a very simple database for extension use. It can
2302	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2303	convert to/from binary).
2304
2305	The parameter C<$family> should best start with the name of the extension
2306	using it, it should be unique.
2307
2308	=over 4
2309
2310	=item $value = cf::db_get $family => $key
2311
2312	Returns a single value from the database.
2313
2314	=item cf::db_put $family => $key => $value
2315
2316	Stores the given C<$value> in the family.
2317
2318	=cut
2319
2320	our $DB;
2321
2322	sub db_init {
2323	unless ($DB) {
2324	$DB = BDB::db_create $DB_ENV;
2325
2326	cf::sync_job {
2327	eval {
2328	$DB->set_flags (BDB::CHKSUM);
2329
2330	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2331	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2332	cf::cleanup "db_open(db): $!" if $!;
2333	};
2334	cf::cleanup "db_open(db): $@" if $@;
2335	};
2336	}
2337	}
2338
2339	sub db_get($$) {
2340	my $key = "$_[0]/$_[1]";
2341
2342	cf::sync_job {
2343	BDB::db_get $DB, undef, $key, my $data;
2344
2345	$! ? ()
2346	: $data
2347	}
2348	}
2349
2350	sub db_put($$$) {
2351	BDB::dbreq_pri 4;
2352	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2353	}
2354
2355	=item cf::cache $id => [$paths...], $processversion => $process
2356
2357	Generic caching function that returns the value of the resource $id,
2358	caching and regenerating as required.
2359
2360	This function can block.
2361
2362	=cut
2363
2364	sub cache {
2365	my ($id, $src, $processversion, $process) = @_;
2366
2367	my $meta =
2368	join "\x00",
2369	$processversion,
2370	map {
2371	aio_stat $_
2372	and Carp::croak "$_: $!";
2373
2374	($_, (stat _)[7,9])
2375	} @$src;
2376
2377	my $dbmeta = db_get cache => "$id/meta";
2378	if ($dbmeta ne $meta) {
2379	# changed, we may need to process
2380
2381	my @data;
2382	my $md5;
2383
2384	for (0 .. $#$src) {
2385	0 <= aio_load $src->[$_], $data[$_]
2386	or Carp::croak "$src->[$_]: $!";
2387	}
2388
2389	# if processing is expensive, check
2390	# checksum first
2391	if (1) {
2392	$md5 =
2393	join "\x00",
2394	$processversion,
2395	map {
2396	Coro::cede;
2397	($src->[$_], Digest::MD5::md5_hex $data[$_])
2398	} 0.. $#$src;
2399
2400
2401	my $dbmd5 = db_get cache => "$id/md5";
2402	if ($dbmd5 eq $md5) {
2403	db_put cache => "$id/meta", $meta;
2404
2405	return db_get cache => "$id/data";
2406	}
2407	}
2408
2409	my $t1 = Time::HiRes::time;
2410	my $data = $process->(\@data);
2411	my $t2 = Time::HiRes::time;
2412
2413	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2414
2415	db_put cache => "$id/data", $data;
2416	db_put cache => "$id/md5" , $md5;
2417	db_put cache => "$id/meta", $meta;
2418
2419	return $data;
2420	}
2421
2422	db_get cache => "$id/data"
2423	}
2424
2425	=item fork_call { }, $args
2426
2427	Executes the given code block with the given arguments in a seperate
2428	process, returning the results. Everything must be serialisable with
2429	Coro::Storable. May, of course, block. Note that the executed sub may
2430	never block itself or use any form of Event handling.
2431
2432	=cut
2433
2434	sub fork_call(&@) {
2435	my ($cb, @args) = @_;
2436
2437	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2438	# or die "socketpair: $!";
2439	pipe my $fh1, my $fh2
2440	or die "pipe: $!";
2441
2442	if (my $pid = fork) {
2443	close $fh2;
2444
2445	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2446	$res = Coro::Storable::thaw $res;
2447
2448	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2449
2450	die $$res unless "ARRAY" eq ref $res;
2451
2452	return wantarray ? @$res : $res->[-1];
2453	} else {
2454	reset_signals;
2455	local $SIG{__WARN__};
2456	local $SIG{__DIE__};
2457	eval {
2458	close $fh1;
2459
2460	my @res = eval { $cb->(@args) };
2461	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2462	};
2463
2464	warn $@ if $@;
2465	_exit 0;
2466	}
2467	}
2468
2469
2470
2471	#############################################################################
2472	# the server's init and main functions	2865	# the server's init and main functions
2473		2866
2474	sub load_facedata($) {	2867	sub load_facedata($) {
2475	my ($path) = @_;	2868	my ($path) = @_;
		2869
		2870	# HACK to clear player env face cache, we need some signal framework
		2871	# for this (global event?)
		2872	%ext::player_env::MUSIC_FACE_CACHE = ();
		2873
		2874	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2476		2875
2477	warn "loading facedata from $path\n";	2876	warn "loading facedata from $path\n";
2478		2877
2479	my $facedata;	2878	my $facedata;
2480	0 < aio_load $path, $facedata	2879	0 < aio_load $path, $facedata
…		…
2483	$facedata = Coro::Storable::thaw $facedata;	2882	$facedata = Coro::Storable::thaw $facedata;
2484		2883
2485	$facedata->{version} == 2	2884	$facedata->{version} == 2
2486	or cf::cleanup "$path: version mismatch, cannot proceed.";	2885	or cf::cleanup "$path: version mismatch, cannot proceed.";
2487		2886
		2887	# patch in the exptable
		2888	$facedata->{resource}{"res/exp_table"} = {
		2889	type => FT_RSRC,
		2890	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
		2891	};
		2892	cf::cede_to_tick;
		2893
2488	{	2894	{
2489	my $faces = $facedata->{faceinfo};	2895	my $faces = $facedata->{faceinfo};
2490		2896
2491	while (my ($face, $info) = each %$faces) {	2897	while (my ($face, $info) = each %$faces) {
2492	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2898	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2493	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2899	cf::face::set_visibility $idx, $info->{visibility};
		2900	cf::face::set_magicmap $idx, $info->{magicmap};
2494	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2901	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2495	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	2902	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2496	Coro::cede;	2903
		2904	cf::cede_to_tick;
2497	}	2905	}
2498		2906
2499	while (my ($face, $info) = each %$faces) {	2907	while (my ($face, $info) = each %$faces) {
2500	next unless $info->{smooth};	2908	next unless $info->{smooth};
2501	my $idx = cf::face::find $face	2909	my $idx = cf::face::find $face
2502	or next;	2910	or next;
2503	if (my $smooth = cf::face::find $info->{smooth}) {	2911	if (my $smooth = cf::face::find $info->{smooth}) {
		2912	cf::face::set_smooth $idx, $smooth;
2504	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	2913	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2505	} else {	2914	} else {
2506	warn "smooth face '$info->{smooth}' not found for face '$face'";	2915	warn "smooth face '$info->{smooth}' not found for face '$face'";
2507	}	2916	}
2508	Coro::cede;	2917
		2918	cf::cede_to_tick;
2509	}	2919	}
2510	}	2920	}
2511		2921
2512	{	2922	{
2513	my $anims = $facedata->{animinfo};	2923	my $anims = $facedata->{animinfo};
2514		2924
2515	while (my ($anim, $info) = each %$anims) {	2925	while (my ($anim, $info) = each %$anims) {
2516	cf::anim::set $anim, $info->{frames}, $info->{facings};	2926	cf::anim::set $anim, $info->{frames}, $info->{facings};
2517	Coro::cede;	2927	cf::cede_to_tick;
2518	}	2928	}
2519		2929
2520	cf::anim::invalidate_all; # d'oh	2930	cf::anim::invalidate_all; # d'oh
2521	}	2931	}
2522		2932
		2933	{
		2934	# TODO: for gcfclient pleasure, we should give resources
		2935	# that gcfclient doesn't grok a >10000 face index.
		2936	my $res = $facedata->{resource};
		2937
		2938	my $soundconf = delete $res->{"res/sound.conf"};
		2939
		2940	while (my ($name, $info) = each %$res) {
		2941	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2942	my $data;
		2943
		2944	if ($info->{type} & 1) {
		2945	# prepend meta info
		2946
		2947	my $meta = $enc->encode ({
		2948	name => $name,
		2949	%{ $info->{meta} || {} },
		2950	});
		2951
		2952	$data = pack "(w/a*)*", $meta, $info->{data};
		2953	} else {
		2954	$data = $info->{data};
		2955	}
		2956
		2957	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		2958	cf::face::set_type $idx, $info->{type};
		2959
		2960	cf::cede_to_tick;
		2961	}
		2962
		2963	if ($soundconf) {
		2964	$soundconf = $enc->decode (delete $soundconf->{data});
		2965
		2966	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2967	my $sound = $soundconf->{compat}[$_]
		2968	or next;
		2969
		2970	my $face = cf::face::find "sound/$sound->[1]";
		2971	cf::sound::set $sound->[0] => $face;
		2972	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2973	}
		2974
		2975	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2976	my $face = cf::face::find "sound/$v";
		2977	cf::sound::set $k => $face;
		2978	}
		2979	}
		2980	}
		2981
2523	1	2982	1
2524	}	2983	}
2525		2984
		2985	register_exticmd fx_want => sub {
		2986	my ($ns, $want) = @_;
		2987
		2988	while (my ($k, $v) = each %$want) {
		2989	$ns->fx_want ($k, $v);
		2990	}
		2991	};
		2992
2526	sub reload_regions {	2993	sub reload_regions {
		2994	# HACK to clear player env face cache, we need some signal framework
		2995	# for this (global event?)
		2996	%ext::player_env::MUSIC_FACE_CACHE = ();
		2997
2527	load_resource_file "$MAPDIR/regions"	2998	load_resource_file "$MAPDIR/regions"
2528	or die "unable to load regions file\n";	2999	or die "unable to load regions file\n";
		3000
		3001	for (cf::region::list) {
		3002	$_->{match} = qr/$_->{match}/
		3003	if exists $_->{match};
		3004	}
2529	}	3005	}
2530		3006
2531	sub reload_facedata {	3007	sub reload_facedata {
2532	load_facedata "$DATADIR/facedata"	3008	load_facedata "$DATADIR/facedata"
2533	or die "unable to load facedata\n";	3009	or die "unable to load facedata\n";
2534	}	3010	}
2535		3011
2536	sub reload_archetypes {	3012	sub reload_archetypes {
2537	load_resource_file "$DATADIR/archetypes"	3013	load_resource_file "$DATADIR/archetypes"
2538	or die "unable to load archetypes\n";	3014	or die "unable to load archetypes\n";
		3015	#d# NEED to laod twice to resolve forward references
		3016	# this really needs to be done in an extra post-pass
		3017	# (which needs to be synchronous, so solve it differently)
		3018	load_resource_file "$DATADIR/archetypes"
		3019	or die "unable to load archetypes\n";
2539	}	3020	}
2540		3021
2541	sub reload_treasures {	3022	sub reload_treasures {
2542	load_resource_file "$DATADIR/treasures"	3023	load_resource_file "$DATADIR/treasures"
2543	or die "unable to load treasurelists\n";	3024	or die "unable to load treasurelists\n";
…		…
2546	sub reload_resources {	3027	sub reload_resources {
2547	warn "reloading resource files...\n";	3028	warn "reloading resource files...\n";
2548		3029
2549	reload_regions;	3030	reload_regions;
2550	reload_facedata;	3031	reload_facedata;
		3032	#reload_archetypes;#d#
2551	reload_archetypes;	3033	reload_archetypes;
2552	reload_treasures;	3034	reload_treasures;
2553		3035
2554	warn "finished reloading resource files\n";	3036	warn "finished reloading resource files\n";
2555	}	3037	}
2556		3038
2557	sub init {	3039	sub init {
2558	reload_resources;	3040	reload_resources;
2559	}	3041	}
2560		3042
2561	sub cfg_load {	3043	sub reload_config {
2562	open my $fh, "<:utf8", "$CONFDIR/config"	3044	open my $fh, "<:utf8", "$CONFDIR/config"
2563	or return;	3045	or return;
2564		3046
2565	local $/;	3047	local $/;
2566	*CFG = YAML::Syck::Load <$fh>;	3048	*CFG = YAML::Syck::Load <$fh>;
…		…
2586	(async {	3068	(async {
2587	Event::one_event;	3069	Event::one_event;
2588	})->prio (Coro::PRIO_MAX);	3070	})->prio (Coro::PRIO_MAX);
2589	};	3071	};
2590		3072
2591	cfg_load;	3073	reload_config;
2592	db_init;	3074	db_init;
2593	load_extensions;	3075	load_extensions;
2594		3076
2595	$TICK_WATCHER->start;	3077	$TICK_WATCHER->start;
2596	Event::loop;	3078	Event::loop;
…		…
2612	},	3094	},
2613	);	3095	);
2614	}	3096	}
2615	}	3097	}
2616		3098
		3099	sub write_runtime {
		3100	my $runtime = "$LOCALDIR/runtime";
		3101
		3102	# first touch the runtime file to show we are still running:
		3103	# the fsync below can take a very very long time.
		3104
		3105	IO::AIO::aio_utime $runtime, undef, undef;
		3106
		3107	my $guard = cf::lock_acquire "write_runtime";
		3108
		3109	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3110	or return;
		3111
		3112	my $value = $cf::RUNTIME + 90 + 10;
		3113	# 10 is the runtime save interval, for a monotonic clock
		3114	# 60 allows for the watchdog to kill the server.
		3115
		3116	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3117	and return;
		3118
		3119	# always fsync - this file is important
		3120	aio_fsync $fh
		3121	and return;
		3122
		3123	# touch it again to show we are up-to-date
		3124	aio_utime $fh, undef, undef;
		3125
		3126	close $fh
		3127	or return;
		3128
		3129	aio_rename "$runtime~", $runtime
		3130	and return;
		3131
		3132	warn "runtime file written.\n";
		3133
		3134	1
		3135	}
		3136
2617	sub emergency_save() {	3137	sub emergency_save() {
2618	my $freeze_guard = cf::freeze_mainloop;	3138	my $freeze_guard = cf::freeze_mainloop;
2619		3139
2620	warn "enter emergency perl save\n";	3140	warn "enter emergency perl save\n";
2621		3141
…		…
2696	%EXT_CORO = ();	3216	%EXT_CORO = ();
2697		3217
2698	warn "removing commands";	3218	warn "removing commands";
2699	%COMMAND = ();	3219	%COMMAND = ();
2700		3220
2701	warn "removing ext commands";	3221	warn "removing ext/exti commands";
2702	%EXTCMD = ();	3222	%EXTCMD = ();
		3223	%EXTICMD = ();
2703		3224
2704	warn "unloading/nuking all extensions";	3225	warn "unloading/nuking all extensions";
2705	for my $pkg (@EXTS) {	3226	for my $pkg (@EXTS) {
2706	warn "... unloading $pkg";	3227	warn "... unloading $pkg";
2707		3228
…		…
2750	warn "reloading cf.pm";	3271	warn "reloading cf.pm";
2751	require cf;	3272	require cf;
2752	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3273	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2753		3274
2754	warn "loading config and database again";	3275	warn "loading config and database again";
2755	cf::cfg_load;	3276	cf::reload_config;
2756		3277
2757	warn "loading extensions";	3278	warn "loading extensions";
2758	cf::load_extensions;	3279	cf::load_extensions;
2759		3280
2760	warn "reattaching attachments to objects/players";	3281	warn "reattaching attachments to objects/players";
…		…
2825	my $signal = new Coro::Signal;	3346	my $signal = new Coro::Signal;
2826	push @WAIT_FOR_TICK_BEGIN, $signal;	3347	push @WAIT_FOR_TICK_BEGIN, $signal;
2827	$signal->wait;	3348	$signal->wait;
2828	}	3349	}
2829		3350
		3351	my $min = 1e6;#d#
		3352	my $avg = 10;
2830	$TICK_WATCHER = Event->timer (	3353	$TICK_WATCHER = Event->timer (
2831	reentrant => 0,	3354	reentrant => 0,
2832	parked => 1,	3355	parked => 1,
2833	prio => 0,	3356	prio => 0,
2834	at => $NEXT_TICK || $TICK,	3357	at => $NEXT_TICK || $TICK,
…		…
2838	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3361	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2839	unless ++$bug_warning > 10;	3362	unless ++$bug_warning > 10;
2840	return;	3363	return;
2841	}	3364	}
2842		3365
2843	$NOW = Event::time;	3366	$NOW = $tick_start = Event::time;
2844		3367
2845	cf::server_tick; # one server iteration	3368	cf::server_tick; # one server iteration
		3369
		3370	0 && sync_job {#d#
		3371	for(1..10) {
		3372	my $t = Event::time;
		3373	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3374	or die;
		3375
		3376	$map->width (50);
		3377	$map->height (50);
		3378	$map->alloc;
		3379	$map->_load_objects ("/tmp/x.map", 1);
		3380	my $t = Event::time - $t;
		3381
		3382	#next unless $t < 0.0013;#d#
		3383	if ($t < $min) {
		3384	$min = $t;
		3385	}
		3386	$avg = $avg * 0.99 + $t * 0.01;
		3387	}
		3388	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3389	exit 0;
		3390	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3391	};
2846		3392
2847	$RUNTIME += $TICK;	3393	$RUNTIME += $TICK;
2848	$NEXT_TICK += $TICK;	3394	$NEXT_TICK += $TICK;
2849		3395
2850	if ($NOW >= $NEXT_RUNTIME_WRITE) {	3396	if ($NOW >= $NEXT_RUNTIME_WRITE) {
…		…
2856	}	3402	}
2857		3403
2858	# my $AFTER = Event::time;	3404	# my $AFTER = Event::time;
2859	# warn $AFTER - $NOW;#d#	3405	# warn $AFTER - $NOW;#d#
2860		3406
		3407	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3408	$sig->send;
		3409	}
		3410	while (my $sig = shift @WAIT_FOR_TICK) {
		3411	$sig->send;
		3412	}
		3413
		3414	$NOW = Event::time;
		3415
2861	# if we are delayed by four ticks or more, skip them all	3416	# if we are delayed by four ticks or more, skip them all
2862	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3417	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2863		3418
2864	$TICK_WATCHER->at ($NEXT_TICK);	3419	$TICK_WATCHER->at ($NEXT_TICK);
2865	$TICK_WATCHER->start;	3420	$TICK_WATCHER->start;
2866		3421
2867	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {	3422	$LOAD = ($NOW - $tick_start) / $TICK;
2868	$sig->send;	3423	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2869	}
2870	while (my $sig = shift @WAIT_FOR_TICK) {
2871	$sig->send;
2872	}
2873		3424
2874	_post_tick;	3425	_post_tick;
		3426
		3427
2875	},	3428	},
2876	);	3429	);
2877		3430
2878	{	3431	{
2879	BDB::max_poll_time $TICK * 0.1;	3432	BDB::max_poll_time $TICK * 0.1;

Diff Legend

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