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.257 by root, Sat Apr 21 17:34:24 2007 UTC vs.
Revision 1.345 by root, Tue Aug 28 19:30:11 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
…		…
291	};	323	};
292	$TICK_WATCHER->stop;	324	$TICK_WATCHER->stop;
293	$guard	325	$guard
294	}	326	}
295		327
		328	=item cf::get_slot $time[, $priority[, $name]]
		329
		330	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		331	This call blocks and returns only when you have at least C<$time> seconds
		332	of cpu time till the next tick. The slot is only valid till the next cede.
		333
		334	The optional C<$name> can be used to identify the job to run. It might be
		335	used for statistical purposes and should identify the same time-class.
		336
		337	Useful for short background jobs.
		338
		339	=cut
		340
		341	our @SLOT_QUEUE;
		342	our $SLOT_QUEUE;
		343
		344	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		345	$SLOT_QUEUE = Coro::async {
		346	my $signal = new Coro::Signal;
		347
		348	while () {
		349	next_job:
		350	my $avail = cf::till_tick;
		351	if ($avail > 0.01) {
		352	for (0 .. $#SLOT_QUEUE) {
		353	if ($SLOT_QUEUE[$_][0] < $avail) {
		354	my $job = splice @SLOT_QUEUE, $_, 1, ();
		355	$job->[2]->send;
		356	Coro::cede;
		357	goto next_job;
		358	}
		359	}
		360	}
		361
		362	if (@SLOT_QUEUE) {
		363	# we do not use wait_For_tick() as it returns immediately when tick is inactive
		364	push @cf::WAIT_FOR_TICK, $signal;
		365	$signal->wait;
		366	} else {
		367	Coro::schedule;
		368	}
		369	}
		370	};
		371
		372	sub get_slot($;$$) {
		373	my ($time, $pri, $name) = @_;
		374
		375	$time = $TICK * .6 if $time > $TICK * .6;
		376	my $sig = new Coro::Signal;
		377
		378	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		379	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		380	$SLOT_QUEUE->ready;
		381	$sig->wait;
		382	}
		383
296	=item cf::async { BLOCK }	384	=item cf::async { BLOCK }
297		385
298	Currently the same as Coro::async_pool, meaning you cannot use	386	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	387	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.	388	thing you are allowed to do is call C<prio> on it.
…		…
303		391
304	BEGIN { *async = \&Coro::async_pool }	392	BEGIN { *async = \&Coro::async_pool }
305		393
306	=item cf::sync_job { BLOCK }	394	=item cf::sync_job { BLOCK }
307		395
308	The design of crossfire+ requires that the main coro ($Coro::main) is	396	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	397	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.	398	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		399	acceptable.
311		400
312	If it must be done, put the blocking parts into C<sync_job>. This will run	401	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	402	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	403	server will be frozen during this time, so the block should either finish
315	fast or be very important.	404	fast or be very important.
…		…
318		407
319	sub sync_job(&) {	408	sub sync_job(&) {
320	my ($job) = @_;	409	my ($job) = @_;
321		410
322	if ($Coro::current == $Coro::main) {	411	if ($Coro::current == $Coro::main) {
		412	my $time = Event::time;
		413
323	# this is the main coro, too bad, we have to block	414	# this is the main coro, too bad, we have to block
324	# till the operation succeeds, freezing the server :/	415	# till the operation succeeds, freezing the server :/
325		416
326	# TODO: use suspend/resume instead	417	# TODO: use suspend/resume instead
327	# (but this is cancel-safe)	418	# (but this is cancel-safe)
…		…
338		429
339	while ($busy) {	430	while ($busy) {
340	Coro::cede or Event::one_event;	431	Coro::cede or Event::one_event;
341	}	432	}
342		433
		434	$time = Event::time - $time;
		435
		436	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		437	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		438
		439	$tick_start += $time; # do not account sync jobs to server load
		440
343	wantarray ? @res : $res[0]	441	wantarray ? @res : $res[0]
344	} else {	442	} else {
345	# we are in another coroutine, how wonderful, everything just works	443	# we are in another coroutine, how wonderful, everything just works
346		444
347	$job->()	445	$job->()
…		…
366	$EXT_CORO{$coro+0} = $coro;	464	$EXT_CORO{$coro+0} = $coro;
367		465
368	$coro	466	$coro
369	}	467	}
370		468
371	sub write_runtime {	469	=item fork_call { }, $args
372	my $guard = cf::lock_acquire "write_runtime";
373		470
374	my $runtime = "$LOCALDIR/runtime";	471	Executes the given code block with the given arguments in a seperate
		472	process, returning the results. Everything must be serialisable with
		473	Coro::Storable. May, of course, block. Note that the executed sub may
		474	never block itself or use any form of Event handling.
375		475
376	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	476	=cut
377	or return;
378		477
379	my $value = $cf::RUNTIME + 90 + 10;	478	sub fork_call(&@) {
380	# 10 is the runtime save interval, for a monotonic clock	479	my ($cb, @args) = @_;
381	# 60 allows for the watchdog to kill the server.
382		480
383	(aio_write $fh, 0, (length $value), $value, 0) <= 0	481	# we seemingly have to make a local copy of the whole thing,
384	and return;	482	# otherwise perl prematurely frees the stuff :/
		483	# TODO: investigate and fix (liekly this will be rather laborious)
385		484
386	# always fsync - this file is important	485	my @res = Coro::Util::fork_eval {
387	aio_fsync $fh	486	reset_signals;
388	and return;	487	&$cb
		488	}, @args;
389		489
390	close $fh	490	wantarray ? @res : $res[-1]
391	or return;	491	}
392		492
393	aio_rename "$runtime~", $runtime	493	=item $value = cf::db_get $family => $key
394	and return;
395		494
		495	Returns a single value from the environment database.
		496
		497	=item cf::db_put $family => $key => $value
		498
		499	Stores the given C<$value> in the family. It can currently store binary
		500	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		501
		502	=cut
		503
		504	our $DB;
		505
		506	sub db_init {
		507	unless ($DB) {
		508	$DB = BDB::db_create $DB_ENV;
		509
		510	cf::sync_job {
		511	eval {
		512	$DB->set_flags (BDB::CHKSUM);
		513
		514	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		515	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		516	cf::cleanup "db_open(db): $!" if $!;
		517	};
		518	cf::cleanup "db_open(db): $@" if $@;
		519	};
396	1	520	}
		521	}
		522
		523	sub db_get($$) {
		524	my $key = "$_[0]/$_[1]";
		525
		526	cf::sync_job {
		527	BDB::db_get $DB, undef, $key, my $data;
		528
		529	$! ? ()
		530	: $data
		531	}
		532	}
		533
		534	sub db_put($$$) {
		535	BDB::dbreq_pri 4;
		536	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		537	}
		538
		539	=item cf::cache $id => [$paths...], $processversion => $process
		540
		541	Generic caching function that returns the value of the resource $id,
		542	caching and regenerating as required.
		543
		544	This function can block.
		545
		546	=cut
		547
		548	sub cache {
		549	my ($id, $src, $processversion, $process) = @_;
		550
		551	my $meta =
		552	join "\x00",
		553	$processversion,
		554	map {
		555	aio_stat $_
		556	and Carp::croak "$_: $!";
		557
		558	($_, (stat _)[7,9])
		559	} @$src;
		560
		561	my $dbmeta = db_get cache => "$id/meta";
		562	if ($dbmeta ne $meta) {
		563	# changed, we may need to process
		564
		565	my @data;
		566	my $md5;
		567
		568	for (0 .. $#$src) {
		569	0 <= aio_load $src->[$_], $data[$_]
		570	or Carp::croak "$src->[$_]: $!";
		571	}
		572
		573	# if processing is expensive, check
		574	# checksum first
		575	if (1) {
		576	$md5 =
		577	join "\x00",
		578	$processversion,
		579	map {
		580	Coro::cede;
		581	($src->[$_], Digest::MD5::md5_hex $data[$_])
		582	} 0.. $#$src;
		583
		584
		585	my $dbmd5 = db_get cache => "$id/md5";
		586	if ($dbmd5 eq $md5) {
		587	db_put cache => "$id/meta", $meta;
		588
		589	return db_get cache => "$id/data";
		590	}
		591	}
		592
		593	my $t1 = Time::HiRes::time;
		594	my $data = $process->(\@data);
		595	my $t2 = Time::HiRes::time;
		596
		597	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		598
		599	db_put cache => "$id/data", $data;
		600	db_put cache => "$id/md5" , $md5;
		601	db_put cache => "$id/meta", $meta;
		602
		603	return $data;
		604	}
		605
		606	db_get cache => "$id/data"
397	}	607	}
398		608
399	=item cf::datalog type => key => value, ...	609	=item cf::datalog type => key => value, ...
400		610
401	Log a datalog packet of the given type with the given key-value pairs.	611	Log a datalog packet of the given type with the given key-value pairs.
…		…
419	attach callbacks/event handlers (a collection of which is called an "attachment")	629	attach callbacks/event handlers (a collection of which is called an "attachment")
420	to it. All such attachable objects support the following methods.	630	to it. All such attachable objects support the following methods.
421		631
422	In the following description, CLASS can be any of C<global>, C<object>	632	In the following description, CLASS can be any of C<global>, C<object>
423	C<player>, C<client> or C<map> (i.e. the attachable objects in	633	C<player>, C<client> or C<map> (i.e. the attachable objects in
424	crossfire+).	634	Crossfire TRT).
425		635
426	=over 4	636	=over 4
427		637
428	=item $attachable->attach ($attachment, key => $value...)	638	=item $attachable->attach ($attachment, key => $value...)
429		639
…		…
592	$registry = $CB_TYPE[$object_type] ||= [];	802	$registry = $CB_TYPE[$object_type] ||= [];
593		803
594	} elsif ($type eq "subtype") {	804	} elsif ($type eq "subtype") {
595	defined $object_type or Carp::croak "subtype specified without type";	805	defined $object_type or Carp::croak "subtype specified without type";
596	my $object_subtype = shift @arg;	806	my $object_subtype = shift @arg;
597	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	807	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
598		808
599	} elsif ($type eq "package") {	809	} elsif ($type eq "package") {
600	my $pkg = shift @arg;	810	my $pkg = shift @arg;
601		811
602	while (my ($name, $id) = each %cb_id) {	812	while (my ($name, $id) = each %cb_id) {
…		…
631	_attach $registry, $klass, @attach;	841	_attach $registry, $klass, @attach;
632	}	842	}
633		843
634	$obj->{$name} = \%arg;	844	$obj->{$name} = \%arg;
635	} else {	845	} else {
636	warn "object uses attachment '$name' that is not available, postponing.\n";	846	warn "object uses attachment '$name' which is not available, postponing.\n";
637	}	847	}
638		848
639	$obj->{_attachment}{$name} = undef;	849	$obj->{_attachment}{$name} = undef;
640	}	850	}
641		851
…		…
643	if (ref $_[0]) {	853	if (ref $_[0]) {
644	_object_attach @_;	854	_object_attach @_;
645	} else {	855	} else {
646	_attach shift->_attach_registry, @_;	856	_attach shift->_attach_registry, @_;
647	}	857	}
		858	_recalc_want;
648	};	859	};
649		860
650	# all those should be optimised	861	# all those should be optimised
651	sub cf::attachable::detach {	862	sub cf::attachable::detach {
652	my ($obj, $name) = @_;	863	my ($obj, $name) = @_;
…		…
655	delete $obj->{_attachment}{$name};	866	delete $obj->{_attachment}{$name};
656	reattach ($obj);	867	reattach ($obj);
657	} else {	868	} else {
658	Carp::croak "cannot, currently, detach class attachments";	869	Carp::croak "cannot, currently, detach class attachments";
659	}	870	}
		871	_recalc_want;
660	};	872	};
661		873
662	sub cf::attachable::attached {	874	sub cf::attachable::attached {
663	my ($obj, $name) = @_;	875	my ($obj, $name) = @_;
664		876
…		…
679	";	891	";
680	die if $@;	892	die if $@;
681	}	893	}
682		894
683	our $override;	895	our $override;
684	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	896	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
685		897
686	sub override {	898	sub override {
687	$override = 1;	899	$override = 1;
688	@invoke_results = ();	900	@INVOKE_RESULTS = (@_);
689	}	901	}
690		902
691	sub do_invoke {	903	sub do_invoke {
692	my $event = shift;	904	my $event = shift;
693	my $callbacks = shift;	905	my $callbacks = shift;
694		906
695	@invoke_results = ();	907	@INVOKE_RESULTS = ();
696		908
697	local $override;	909	local $override;
698		910
699	for (@$callbacks) {	911	for (@$callbacks) {
700	eval { &{$_->[1]} };	912	eval { &{$_->[1]} };
…		…
717		929
718	Generate an object-specific event with the given arguments.	930	Generate an object-specific event with the given arguments.
719		931
720	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	932	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
721	removed in future versions), and there is no public API to access override	933	removed in future versions), and there is no public API to access override
722	results (if you must, access C<@cf::invoke_results> directly).	934	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
723		935
724	=back	936	=back
725		937
726	=cut	938	=cut
727		939
728	#############################################################################	940	#############################################################################
729	# object support	941	# object support
		942	#
		943
		944	sub _can_merge {
		945	my ($ob1, $ob2) = @_;
		946
		947	local $Storable::canonical = 1;
		948	my $fob1 = Storable::freeze $ob1;
		949	my $fob2 = Storable::freeze $ob2;
		950
		951	$fob1 eq $fob2
		952	}
730		953
731	sub reattach {	954	sub reattach {
732	# basically do the same as instantiate, without calling instantiate	955	# basically do the same as instantiate, without calling instantiate
733	my ($obj) = @_;	956	my ($obj) = @_;
734		957
…		…
837	or return;	1060	or return;
838	$av = eval { (Storable::thaw $av)->{objs} };	1061	$av = eval { (Storable::thaw $av)->{objs} };
839	}	1062	}
840		1063
841	warn sprintf "loading %s (%d)\n",	1064	warn sprintf "loading %s (%d)\n",
842	$filename, length $data, scalar @{$av || []};#d#	1065	$filename, length $data, scalar @{$av || []};
843	return ($data, $av);	1066	return ($data, $av);
844	}	1067	}
		1068
		1069	=head2 COMMAND CALLBACKS
		1070
		1071	=over 4
		1072
		1073	=cut
845		1074
846	#############################################################################	1075	#############################################################################
847	# command handling &c	1076	# command handling &c
848		1077
849	=item cf::register_command $name => \&callback($ob,$args);	1078	=item cf::register_command $name => \&callback($ob,$args);
…		…
862	push @{ $COMMAND{$name} }, [$caller, $cb];	1091	push @{ $COMMAND{$name} }, [$caller, $cb];
863	}	1092	}
864		1093
865	=item cf::register_extcmd $name => \&callback($pl,$packet);	1094	=item cf::register_extcmd $name => \&callback($pl,$packet);
866		1095
867	Register a callbackf ro execution when the client sends an extcmd packet.	1096	Register a callback for execution when the client sends an (synchronous)
		1097	extcmd packet. Ext commands will be processed in the order they are
		1098	received by the server, like other user commands. The first argument is
		1099	the logged-in player. Ext commands can only be processed after a player
		1100	has logged in successfully.
868		1101
869	If the callback returns something, it is sent back as if reply was being	1102	If the callback returns something, it is sent back as if reply was being
870	called.	1103	called.
871		1104
		1105	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1106
		1107	Register a callback for execution when the client sends an (asynchronous)
		1108	exticmd packet. Exti commands are processed by the server as soon as they
		1109	are received, i.e. out of order w.r.t. other commands. The first argument
		1110	is a client socket. Exti commands can be received anytime, even before
		1111	log-in.
		1112
		1113	If the callback returns something, it is sent back as if reply was being
		1114	called.
		1115
872	=cut	1116	=cut
873		1117
874	sub register_extcmd {	1118	sub register_extcmd {
875	my ($name, $cb) = @_;	1119	my ($name, $cb) = @_;
876		1120
877	$EXTCMD{$name} = $cb;	1121	$EXTCMD{$name} = $cb;
		1122	}
		1123
		1124	sub register_exticmd {
		1125	my ($name, $cb) = @_;
		1126
		1127	$EXTICMD{$name} = $cb;
878	}	1128	}
879		1129
880	cf::player->attach (	1130	cf::player->attach (
881	on_command => sub {	1131	on_command => sub {
882	my ($pl, $name, $params) = @_;	1132	my ($pl, $name, $params) = @_;
…		…
891	cf::override;	1141	cf::override;
892	},	1142	},
893	on_extcmd => sub {	1143	on_extcmd => sub {
894	my ($pl, $buf) = @_;	1144	my ($pl, $buf) = @_;
895		1145
896	my $msg = eval { from_json $buf };	1146	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
897		1147
898	if (ref $msg) {	1148	if (ref $msg) {
		1149	my ($type, $reply, @payload) =
		1150	"ARRAY" eq ref $msg
		1151	? @$msg
		1152	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1153
		1154	my @reply;
		1155
899	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1156	if (my $cb = $EXTCMD{$type}) {
900	if (my %reply = $cb->($pl, $msg)) {	1157	@reply = $cb->($pl, @payload);
901	$pl->ext_reply ($msg->{msgid}, %reply);
902	}
903	}	1158	}
		1159
		1160	$pl->ext_reply ($reply, @reply)
		1161	if $reply;
		1162
904	} else {	1163	} else {
905	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1164	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
906	}	1165	}
907		1166
908	cf::override;	1167	cf::override;
909	},	1168	},
910	);	1169	);
911		1170
912	sub load_extension {
913	my ($path) = @_;
914
915	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
916	my $base = $1;
917	my $pkg = $1;
918	$pkg =~ s/[^[:word:]]/_/g;
919	$pkg = "ext::$pkg";
920
921	warn "... loading '$path' into '$pkg'\n";
922
923	open my $fh, "<:utf8", $path
924	or die "$path: $!";
925
926	my $source =
927	"package $pkg; use strict; use utf8;\n"
928	. "#line 1 \"$path\"\n{\n"
929	. (do { local $/; <$fh> })
930	. "\n};\n1";
931
932	unless (eval $source) {
933	my $msg = $@ ? "$path: $@\n"
934	: "extension disabled.\n";
935	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
936	warn $@;
937	warn "mandatory extension failed to load, exiting.\n";
938	exit 1;
939	}
940	die $@;
941	}
942
943	push @EXTS, $pkg;
944	}
945
946	sub load_extensions {	1171	sub load_extensions {
		1172	cf::sync_job {
		1173	my %todo;
		1174
947	for my $ext (<$LIBDIR/*.ext>) {	1175	for my $path (<$LIBDIR/*.ext>) {
948	next unless -r $ext;	1176	next unless -r $path;
949	eval {	1177
950	load_extension $ext;	1178	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1179	my $base = $1;
		1180	my $pkg = $1;
		1181	$pkg =~ s/[^[:word:]]/_/g;
		1182	$pkg = "ext::$pkg";
		1183
		1184	open my $fh, "<:utf8", $path
		1185	or die "$path: $!";
		1186
		1187	my $source = do { local $/; <$fh> };
		1188
		1189	my %ext = (
		1190	path => $path,
		1191	base => $base,
		1192	pkg => $pkg,
		1193	);
		1194
		1195	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1196	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1197
		1198	$ext{source} =
		1199	"package $pkg; use strict; use utf8;\n"
		1200	. "#line 1 \"$path\"\n{\n"
		1201	. $source
		1202	. "\n};\n1";
		1203
		1204	$todo{$base} = \%ext;
		1205	}
		1206
		1207	my %done;
		1208	while (%todo) {
		1209	my $progress;
		1210
		1211	while (my ($k, $v) = each %todo) {
		1212	for (split /,\s*/, $v->{meta}{depends}) {
		1213	goto skip
		1214	unless exists $done{$_};
		1215	}
		1216
		1217	warn "... loading '$k' into '$v->{pkg}'\n";
		1218
		1219	unless (eval $v->{source}) {
		1220	my $msg = $@ ? "$v->{path}: $@\n"
		1221	: "$v->{base}: extension inactive.\n";
		1222
		1223	if (exists $v->{meta}{mandatory}) {
		1224	warn $msg;
		1225	warn "mandatory extension failed to load, exiting.\n";
		1226	exit 1;
		1227	}
		1228
		1229	warn $msg;
		1230	}
		1231
		1232	$done{$k} = delete $todo{$k};
		1233	push @EXTS, $v->{pkg};
		1234	$progress = 1;
951	1	1235	}
952	} or warn "$ext not loaded: $@";	1236
		1237	skip:
		1238	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1239	unless $progress;
		1240	}
953	}	1241	};
954	}	1242	}
955		1243
956	#############################################################################	1244	#############################################################################
		1245
		1246	=back
957		1247
958	=head2 CORE EXTENSIONS	1248	=head2 CORE EXTENSIONS
959		1249
960	Functions and methods that extend core crossfire objects.	1250	Functions and methods that extend core crossfire objects.
961		1251
…		…
1048	$cf::PLAYER{$login} = $self;	1338	$cf::PLAYER{$login} = $self;
1049		1339
1050	$self	1340	$self
1051	}	1341	}
1052		1342
		1343	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1344
		1345	=cut
		1346
		1347	sub send_msg {
		1348	my $ns = shift->ns
		1349	or return;
		1350	$ns->send_msg (@_);
		1351	}
		1352
1053	=item $pl->quit_character	1353	=item $pl->quit_character
1054		1354
1055	Nukes the player without looking back. If logged in, the connection will	1355	Nukes the player without looking back. If logged in, the connection will
1056	be destroyed. May block for a long time.	1356	be destroyed. May block for a long time.
1057		1357
…		…
1149	}	1449	}
1150		1450
1151	\@paths	1451	\@paths
1152	}	1452	}
1153		1453
		1454	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1455
		1456	Expand crossfire pod fragments into protocol xml.
		1457
		1458	=cut
		1459
		1460	sub expand_cfpod {
		1461	((my $self), (local $_)) = @_;
		1462
		1463	# escape & and <
		1464	s/&/&amp;/g;
		1465	s/(?<![BIUGH])</&lt;/g;
		1466
		1467	# this is buggy, it needs to properly take care of nested <'s
		1468
		1469	1 while
		1470	# replace B<>, I<>, U<> etc.
		1471	s/B<([^\>]*)>/<b>$1<\/b>/
		1472	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1473	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1474	# replace G<male|female> tags
		1475	|| s{G<([^>|]*)\|([^>]*)>}{
		1476	$self->gender ? $2 : $1
		1477	}ge
		1478	# replace H<hint text>
		1479	|| s{H<([^\>]*)>}
		1480	{
		1481	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1482	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1483	"")
		1484	[$self->{hintmode}]
		1485	}ge;
		1486
		1487	# create single paragraphs (very hackish)
		1488	s/(?<=\S)\n(?=\w)/ /g;
		1489
		1490	# compress some whitespace
		1491	s/\s+\n/\n/g; # ws line-ends
		1492	s/\n\n+/\n/g; # double lines
		1493	s/^\n+//; # beginning lines
		1494	s/\n+$//; # ending lines
		1495
		1496	$_
		1497	}
		1498
		1499	sub hintmode {
		1500	$_[0]{hintmode} = $_[1] if @_ > 1;
		1501	$_[0]{hintmode}
		1502	}
		1503
1154	=item $player->ext_reply ($msgid, %msg)	1504	=item $player->ext_reply ($msgid, @msg)
1155		1505
1156	Sends an ext reply to the player.	1506	Sends an ext reply to the player.
1157		1507
1158	=cut	1508	=cut
1159		1509
1160	sub ext_reply($$%) {	1510	sub ext_reply($$@) {
1161	my ($self, $id, %msg) = @_;	1511	my ($self, $id, @msg) = @_;
1162		1512
1163	$msg{msgid} = $id;	1513	$self->ns->ext_reply ($id, @msg)
1164
1165	$self->send ("ext " . cf::to_json \%msg);
1166	}	1514	}
1167		1515
1168	=item $player->ext_event ($type, %msg)	1516	=item $player->ext_msg ($type, @msg)
1169		1517
1170	Sends an ext event to the client.	1518	Sends an ext event to the client.
1171		1519
1172	=cut	1520	=cut
1173		1521
1174	sub ext_event($$%) {	1522	sub ext_msg($$@) {
1175	my ($self, $type, %msg) = @_;	1523	my ($self, $type, @msg) = @_;
1176		1524
1177	$self->ns->ext_event ($type, %msg);	1525	$self->ns->ext_msg ($type, @msg);
1178	}	1526	}
1179		1527
1180	=head3 cf::region	1528	=head3 cf::region
1181		1529
1182	=over 4	1530	=over 4
…		…
1185		1533
1186	package cf::region;	1534	package cf::region;
1187		1535
1188	=item cf::region::find_by_path $path	1536	=item cf::region::find_by_path $path
1189		1537
1190	Tries to decuce the probable region for a map knowing only its path.	1538	Tries to decuce the likely region for a map knowing only its path.
1191		1539
1192	=cut	1540	=cut
1193		1541
1194	sub find_by_path($) {	1542	sub find_by_path($) {
1195	my ($path) = @_;	1543	my ($path) = @_;
1196		1544
1197	my ($match, $specificity);	1545	my ($match, $specificity);
1198		1546
1199	for my $region (list) {	1547	for my $region (list) {
1200	if ($region->match && $path =~ $region->match) {	1548	if ($region->{match} && $path =~ $region->{match}) {
1201	($match, $specificity) = ($region, $region->specificity)	1549	($match, $specificity) = ($region, $region->specificity)
1202	if $region->specificity > $specificity;	1550	if $region->specificity > $specificity;
1203	}	1551	}
1204	}	1552	}
1205		1553
…		…
1269	my ($self, $merge) = @_;	1617	my ($self, $merge) = @_;
1270		1618
1271	# we have to keep some variables in memory intact	1619	# we have to keep some variables in memory intact
1272	local $self->{path};	1620	local $self->{path};
1273	local $self->{load_path};	1621	local $self->{load_path};
1274	local $self->{deny_save};
1275	local $self->{deny_reset};
1276		1622
1277	$self->SUPER::thawer_merge ($merge);	1623	$self->SUPER::thawer_merge ($merge);
1278	}	1624	}
1279		1625
1280	sub normalise {	1626	sub normalise {
…		…
1327	$self->init; # pass $1 etc.	1673	$self->init; # pass $1 etc.
1328	return $self;	1674	return $self;
1329	}	1675	}
1330	}	1676	}
1331		1677
1332	Carp::carp "unable to resolve path '$path' (base '$base').";	1678	Carp::cluck "unable to resolve path '$path' (base '$base').";
1333	()	1679	()
1334	}	1680	}
1335		1681
1336	sub init {	1682	sub init {
1337	my ($self) = @_;	1683	my ($self) = @_;
…		…
1378	sub change_all_map_light {	1724	sub change_all_map_light {
1379	my ($change) = @_;	1725	my ($change) = @_;
1380		1726
1381	$_->change_map_light ($change)	1727	$_->change_map_light ($change)
1382	for grep $_->outdoor, values %cf::MAP;	1728	for grep $_->outdoor, values %cf::MAP;
		1729	}
		1730
		1731	sub decay_objects {
		1732	my ($self) = @_;
		1733
		1734	return if $self->{deny_reset};
		1735
		1736	$self->do_decay_objects;
1383	}	1737	}
1384		1738
1385	sub unlink_save {	1739	sub unlink_save {
1386	my ($self) = @_;	1740	my ($self) = @_;
1387		1741
…		…
1445	$self->load_header_orig	1799	$self->load_header_orig
1446	or return;	1800	or return;
1447	$self->prepare_orig;	1801	$self->prepare_orig;
1448	}	1802	}
1449		1803
		1804	$self->{deny_reset} = 1
		1805	if $self->no_reset;
		1806
1450	$self->default_region (cf::region::find_by_path $self->{path})	1807	$self->default_region (cf::region::find_by_path $self->{path})
1451	unless $self->default_region;	1808	unless $self->default_region;
1452		1809
1453	1	1810	1
1454	}	1811	}
…		…
1469	$map->{last_save} = $cf::RUNTIME;	1826	$map->{last_save} = $cf::RUNTIME;
1470		1827
1471	$map->load_header	1828	$map->load_header
1472	or return;	1829	or return;
1473		1830
1474	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1831	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1475	# doing this can freeze the server in a sync job, obviously	1832	# doing this can freeze the server in a sync job, obviously
1476	#$cf::WAIT_FOR_TICK->wait;	1833	#$cf::WAIT_FOR_TICK->wait;
1477	$map->reset;	1834	$map->reset;
1478	undef $guard;	1835	undef $guard;
1479	return find $path;	1836	return find $path;
…		…
1492	local $self->{deny_reset} = 1; # loading can take a long time	1849	local $self->{deny_reset} = 1; # loading can take a long time
1493		1850
1494	my $path = $self->{path};	1851	my $path = $self->{path};
1495		1852
1496	{	1853	{
		1854	my $guard1 = cf::lock_acquire "map_data:$path";
1497	my $guard = cf::lock_acquire "map_load:$path";	1855	my $guard2 = cf::lock_acquire "map_load:$path";
1498		1856
1499	return if $self->in_memory != cf::MAP_SWAPPED;	1857	return if $self->in_memory != cf::MAP_SWAPPED;
1500		1858
1501	$self->in_memory (cf::MAP_LOADING);	1859	$self->in_memory (cf::MAP_LOADING);
1502		1860
…		…
1534	$self->set_darkness_map;	1892	$self->set_darkness_map;
1535	Coro::cede;	1893	Coro::cede;
1536	$self->activate;	1894	$self->activate;
1537	}	1895	}
1538		1896
		1897	$self->{last_save} = $cf::RUNTIME;
		1898	$self->last_access ($cf::RUNTIME);
		1899
1539	$self->in_memory (cf::MAP_IN_MEMORY);	1900	$self->in_memory (cf::MAP_IN_MEMORY);
1540	}	1901	}
1541		1902
1542	$self->post_load;	1903	$self->post_load;
1543	}	1904	}
…		…
1546	my ($self, $ob) = @_;	1907	my ($self, $ob) = @_;
1547		1908
1548	return find "~" . $ob->name . "/" . $self->{path}	1909	return find "~" . $ob->name . "/" . $self->{path}
1549	if $self->per_player;	1910	if $self->per_player;
1550		1911
		1912	# return find "?party/" . $ob->name . "/" . $self->{path}
		1913	# if $self->per_party;
		1914
1551	$self	1915	$self
1552	}	1916	}
1553		1917
1554	# find and load all maps in the 3x3 area around a map	1918	# find and load all maps in the 3x3 area around a map
1555	sub load_diag {	1919	sub load_neighbours {
1556	my ($map) = @_;	1920	my ($map) = @_;
1557		1921
1558	my @diag; # diagonal neighbours	1922	my @neigh; # diagonal neighbours
1559		1923
1560	for (0 .. 3) {	1924	for (0 .. 3) {
1561	my $neigh = $map->tile_path ($_)	1925	my $neigh = $map->tile_path ($_)
1562	or next;	1926	or next;
1563	$neigh = find $neigh, $map	1927	$neigh = find $neigh, $map
1564	or next;	1928	or next;
1565	$neigh->load;	1929	$neigh->load;
1566		1930
		1931	push @neigh,
1567	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	1932	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1568	[$neigh->tile_path (($_ + 1) % 4), $neigh];	1933	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1569	}	1934	}
1570		1935
1571	for (@diag) {	1936	for (grep defined $_->[0], @neigh) {
		1937	my ($path, $origin) = @$_;
1572	my $neigh = find @$_	1938	my $neigh = find $path, $origin
1573	or next;	1939	or next;
1574	$neigh->load;	1940	$neigh->load;
1575	}	1941	}
1576	}	1942	}
1577		1943
…		…
1582	}	1948	}
1583		1949
1584	sub do_load_sync {	1950	sub do_load_sync {
1585	my ($map) = @_;	1951	my ($map) = @_;
1586		1952
		1953	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		1954	if $Coro::current == $Coro::main;
		1955
1587	cf::sync_job { $map->load };	1956	cf::sync_job { $map->load };
1588	}	1957	}
1589		1958
1590	our %MAP_PREFETCH;	1959	our %MAP_PREFETCH;
1591	our $MAP_PREFETCHER = undef;	1960	our $MAP_PREFETCHER = undef;
1592		1961
1593	sub find_async {	1962	sub find_async {
1594	my ($path, $origin) = @_;	1963	my ($path, $origin, $load) = @_;
1595		1964
1596	$path = normalise $path, $origin && $origin->{path};	1965	$path = normalise $path, $origin && $origin->{path};
1597		1966
1598	if (my $map = $cf::MAP{$path}) {	1967	if (my $map = $cf::MAP{$path}) {
1599	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	1968	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1600	}	1969	}
1601		1970
1602	undef $MAP_PREFETCH{$path};	1971	$MAP_PREFETCH{$path} |= $load;
		1972
1603	$MAP_PREFETCHER ||= cf::async {	1973	$MAP_PREFETCHER ||= cf::async {
1604	while (%MAP_PREFETCH) {	1974	while (%MAP_PREFETCH) {
1605	for my $path (keys %MAP_PREFETCH) {	1975	while (my ($k, $v) = each %MAP_PREFETCH) {
1606	my $map = find $path	1976	if (my $map = find $k) {
1607	or next;
1608	$map->load;	1977	$map->load if $v;
		1978	}
1609		1979
1610	delete $MAP_PREFETCH{$path};	1980	delete $MAP_PREFETCH{$k};
1611	}	1981	}
1612	}	1982	}
1613	undef $MAP_PREFETCHER;	1983	undef $MAP_PREFETCHER;
1614	};	1984	};
1615	$MAP_PREFETCHER->prio (6);	1985	$MAP_PREFETCHER->prio (6);
…		…
1618	}	1988	}
1619		1989
1620	sub save {	1990	sub save {
1621	my ($self) = @_;	1991	my ($self) = @_;
1622		1992
1623	my $lock = cf::lock_acquire "map_data:" . $self->path;	1993	my $lock = cf::lock_acquire "map_data:$self->{path}";
1624		1994
1625	$self->{last_save} = $cf::RUNTIME;	1995	$self->{last_save} = $cf::RUNTIME;
1626		1996
1627	return unless $self->dirty;	1997	return unless $self->dirty;
1628		1998
…		…
1651	my ($self) = @_;	2021	my ($self) = @_;
1652		2022
1653	# save first because save cedes	2023	# save first because save cedes
1654	$self->save;	2024	$self->save;
1655		2025
1656	my $lock = cf::lock_acquire "map_data:" . $self->path;	2026	my $lock = cf::lock_acquire "map_data:$self->{path}";
1657		2027
1658	return if $self->players;	2028	return if $self->players;
1659	return if $self->in_memory != cf::MAP_IN_MEMORY;	2029	return if $self->in_memory != cf::MAP_IN_MEMORY;
1660	return if $self->{deny_save};	2030	return if $self->{deny_save};
1661		2031
…		…
1665		2035
1666	sub reset_at {	2036	sub reset_at {
1667	my ($self) = @_;	2037	my ($self) = @_;
1668		2038
1669	# TODO: safety, remove and allow resettable per-player maps	2039	# TODO: safety, remove and allow resettable per-player maps
1670	return 1e99 if $self->isa ("ext::map_per_player");#d#
1671	return 1e99 if $self->{deny_reset};	2040	return 1e99 if $self->{deny_reset};
1672		2041
1673	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2042	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1674	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2043	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1675		2044
…		…
1686	my ($self) = @_;	2055	my ($self) = @_;
1687		2056
1688	my $lock = cf::lock_acquire "map_data:$self->{path}";	2057	my $lock = cf::lock_acquire "map_data:$self->{path}";
1689		2058
1690	return if $self->players;	2059	return if $self->players;
1691	return if $self->isa ("ext::map_per_player");#d#
1692		2060
1693	warn "resetting map ", $self->path;#d#	2061	warn "resetting map ", $self->path;
1694		2062
1695	$self->in_memory (cf::MAP_SWAPPED);	2063	$self->in_memory (cf::MAP_SWAPPED);
1696		2064
1697	# need to save uniques path	2065	# need to save uniques path
1698	unless ($self->{deny_save}) {	2066	unless ($self->{deny_save}) {
…		…
1730	$cf::MAP{$self->path} = $self;	2098	$cf::MAP{$self->path} = $self;
1731		2099
1732	$self->reset; # polite request, might not happen	2100	$self->reset; # polite request, might not happen
1733	}	2101	}
1734		2102
		2103	=item $maps = cf::map::tmp_maps
		2104
		2105	Returns an arrayref with all map paths of currently instantiated and saved
		2106	maps. May block.
		2107
		2108	=cut
		2109
		2110	sub tmp_maps() {
		2111	[
		2112	map {
		2113	utf8::decode $_;
		2114	/\.map$/
		2115	? normalise $_
		2116	: ()
		2117	} @{ aio_readdir $TMPDIR or [] }
		2118	]
		2119	}
		2120
		2121	=item $maps = cf::map::random_maps
		2122
		2123	Returns an arrayref with all map paths of currently instantiated and saved
		2124	random maps. May block.
		2125
		2126	=cut
		2127
		2128	sub random_maps() {
		2129	[
		2130	map {
		2131	utf8::decode $_;
		2132	/\.map$/
		2133	? normalise "?random/$_"
		2134	: ()
		2135	} @{ aio_readdir $RANDOMDIR or [] }
		2136	]
		2137	}
		2138
1735	=item cf::map::unique_maps	2139	=item cf::map::unique_maps
1736		2140
1737	Returns an arrayref of paths of all shared maps that have	2141	Returns an arrayref of paths of all shared maps that have
1738	instantiated unique items. May block.	2142	instantiated unique items. May block.
1739		2143
1740	=cut	2144	=cut
1741		2145
1742	sub unique_maps() {	2146	sub unique_maps() {
1743	my $files = aio_readdir $UNIQUEDIR	2147	[
1744	or return;	2148	map {
1745
1746	my @paths;
1747
1748	for (@$files) {
1749	utf8::decode $_;	2149	utf8::decode $_;
1750	next if /\.pst$/;	2150	/\.map$/
1751	next unless /^$PATH_SEP/o;	2151	? normalise $_
1752		2152	: ()
1753	push @paths, cf::map::normalise $_;	2153	} @{ aio_readdir $UNIQUEDIR or [] }
1754	}	2154	]
1755
1756	\@paths
1757	}	2155	}
1758		2156
1759	package cf;	2157	package cf;
1760		2158
1761	=back	2159	=back
…		…
1807		2205
1808	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2206	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1809		2207
1810	if ($self->{record_replies}) {	2208	if ($self->{record_replies}) {
1811	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2209	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2210
1812	} else {	2211	} else {
		2212	my $pl = $self->contr;
		2213
		2214	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2215	my $dialog = $pl->{npc_dialog};
		2216	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2217
		2218	} else {
1813	$msg = $npc->name . " says: $msg" if $npc;	2219	$msg = $npc->name . " says: $msg" if $npc;
1814	$self->message ($msg, $flags);	2220	$self->message ($msg, $flags);
		2221	}
1815	}	2222	}
		2223	}
		2224
		2225	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2226
		2227	=cut
		2228
		2229	sub cf::object::send_msg {
		2230	my $pl = shift->contr
		2231	or return;
		2232	$pl->send_msg (@_);
1816	}	2233	}
1817		2234
1818	=item $player_object->may ("access")	2235	=item $player_object->may ("access")
1819		2236
1820	Returns wether the given player is authorized to access resource "access"	2237	Returns wether the given player is authorized to access resource "access"
…		…
1862	}	2279	}
1863		2280
1864	sub cf::object::player::enter_link {	2281	sub cf::object::player::enter_link {
1865	my ($self) = @_;	2282	my ($self) = @_;
1866		2283
		2284	$self->deactivate_recursive;
		2285
1867	return if UNIVERSAL::isa $self->map, "ext::map_link";	2286	return if UNIVERSAL::isa $self->map, "ext::map_link";
1868		2287
1869	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2288	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1870	if $self->map;	2289	if $self->map && $self->map->{path} ne "{link}";
1871		2290
1872	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2291	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1873	}	2292	}
1874		2293
1875	sub cf::object::player::leave_link {	2294	sub cf::object::player::leave_link {
1876	my ($self, $map, $x, $y) = @_;	2295	my ($self, $map, $x, $y) = @_;
		2296
		2297	return unless $self->contr->active;
1877		2298
1878	my $link_pos = delete $self->{_link_pos};	2299	my $link_pos = delete $self->{_link_pos};
1879		2300
1880	unless ($map) {	2301	unless ($map) {
1881	# restore original map position	2302	# restore original map position
…		…
1895	# use -1 or undef as default coordinates, not 0, 0	2316	# use -1 or undef as default coordinates, not 0, 0
1896	($x, $y) = ($map->enter_x, $map->enter_y)	2317	($x, $y) = ($map->enter_x, $map->enter_y)
1897	if $x <=0 && $y <= 0;	2318	if $x <=0 && $y <= 0;
1898		2319
1899	$map->load;	2320	$map->load;
1900	$map->load_diag;	2321	$map->load_neighbours;
1901		2322
1902	return unless $self->contr->active;	2323	return unless $self->contr->active;
1903	$self->activate_recursive;	2324	$self->activate_recursive;
1904		2325
1905	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2326	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1906	$self->enter_map ($map, $x, $y);	2327	$self->enter_map ($map, $x, $y);
1907	}	2328	}
1908		2329
1909	cf::player->attach (	2330	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1910	on_logout => sub {
1911	my ($pl) = @_;
1912		2331
1913	# abort map switching before logout	2332	Moves the player to the given map-path and coordinates by first freezing
1914	if ($pl->ob->{_link_pos}) {	2333	her, loading and preparing them map, calling the provided $check callback
1915	cf::sync_job {	2334	that has to return the map if sucecssful, and then unfreezes the player on
1916	$pl->ob->leave_link	2335	the new (success) or old (failed) map position. In either case, $done will
1917	};	2336	be called at the end of this process.
1918	}
1919	},
1920	on_login => sub {
1921	my ($pl) = @_;
1922		2337
1923	# try to abort aborted map switching on player login :)
1924	# should happen only on crashes
1925	if ($pl->ob->{_link_pos}) {
1926	$pl->ob->enter_link;
1927	(async {
1928	$pl->ob->reply (undef,
1929	"There was an internal problem at your last logout, "
1930	. "the server will try to bring you to your intended destination in a second.",
1931	cf::NDI_RED);
1932	# we need this sleep as the login has a concurrent enter_exit running
1933	# and this sleep increases chances of the player not ending up in scorn
1934	Coro::Timer::sleep 1;
1935	$pl->ob->leave_link;
1936	})->prio (2);
1937	}
1938	},
1939	);
1940
1941	=item $player_object->goto ($path, $x, $y)
1942
1943	=cut	2338	=cut
		2339
		2340	our $GOTOGEN;
1944		2341
1945	sub cf::object::player::goto {	2342	sub cf::object::player::goto {
1946	my ($self, $path, $x, $y) = @_;	2343	my ($self, $path, $x, $y, $check, $done) = @_;
		2344
		2345	# do generation counting so two concurrent goto's will be executed in-order
		2346	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1947		2347
1948	$self->enter_link;	2348	$self->enter_link;
1949		2349
1950	(async {	2350	(async {
1951	my $map = eval {	2351	my $map = eval {
1952	my $map = cf::map::find $path;	2352	my $map = cf::map::find $path;
		2353
		2354	if ($map) {
1953	$map = $map->customise_for ($self) if $map;	2355	$map = $map->customise_for ($self);
		2356	$map = $check->($map) if $check && $map;
		2357	} else {
		2358	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2359	}
		2360
1954	$map	2361	$map
		2362	};
		2363
		2364	if ($@) {
		2365	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2366	LOG llevError | logBacktrace, Carp::longmess $@;
1955	} or	2367	}
1956	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1957		2368
		2369	if ($gen == $self->{_goto_generation}) {
		2370	delete $self->{_goto_generation};
1958	$self->leave_link ($map, $x, $y);	2371	$self->leave_link ($map, $x, $y);
		2372	}
		2373
		2374	$done->() if $done;
1959	})->prio (1);	2375	})->prio (1);
1960	}	2376	}
1961		2377
1962	=item $player_object->enter_exit ($exit_object)	2378	=item $player_object->enter_exit ($exit_object)
1963		2379
…		…
2032	my $hp = $exit->stats->hp;	2448	my $hp = $exit->stats->hp;
2033	my $sp = $exit->stats->sp;	2449	my $sp = $exit->stats->sp;
2034		2450
2035	$self->enter_link;	2451	$self->enter_link;
2036		2452
		2453	# if exit is damned, update players death & WoR home-position
		2454	$self->contr->savebed ($slaying, $hp, $sp)
		2455	if $exit->flag (FLAG_DAMNED);
		2456
2037	(async {	2457	(async {
2038	$self->deactivate_recursive; # just to be sure	2458	$self->deactivate_recursive; # just to be sure
2039	unless (eval {	2459	unless (eval {
2040	$self->goto ($slaying, $hp, $sp);	2460	$self->goto ($slaying, $hp, $sp);
2041		2461
…		…
2068		2488
2069	utf8::encode $text;	2489	utf8::encode $text;
2070	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2490	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2071	}	2491	}
2072		2492
		2493	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2494
		2495	Send a drawinfo or msg packet to the client, formatting the msg for the
		2496	client if neccessary. C<$type> should be a string identifying the type of
		2497	the message, with C<log> being the default. If C<$color> is negative, suppress
		2498	the message unless the client supports the msg packet.
		2499
		2500	=cut
		2501
		2502	sub cf::client::send_msg {
		2503	my ($self, $channel, $msg, $color, @extra) = @_;
		2504
		2505	$msg = $self->pl->expand_cfpod ($msg);
		2506
		2507	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2508
		2509	if (ref $channel) {
		2510	# send meta info to client, if not yet sent
		2511	unless (exists $self->{channel}{$channel->{id}}) {
		2512	$self->{channel}{$channel->{id}} = $channel;
		2513	$self->ext_msg (channel_info => $channel);
		2514	}
		2515
		2516	$channel = $channel->{id};
		2517	}
		2518
		2519	return unless @extra || length $msg;
		2520
		2521	if ($self->can_msg) {
		2522	# default colour, mask it out
		2523	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2524	if $color & cf::NDI_DEF;
		2525
		2526	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2527	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2528	} else {
		2529	if ($color >= 0) {
		2530	# replace some tags by gcfclient-compatible ones
		2531	for ($msg) {
		2532	1 while
		2533	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2534	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2535	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2536	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2537	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2538	}
		2539
		2540	$color &= cf::NDI_COLOR_MASK;
		2541
		2542	utf8::encode $msg;
		2543
		2544	if (0 && $msg =~ /\[/) {
		2545	# COMMAND/INFO
		2546	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2547	} else {
		2548	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2549	$self->send_packet ("drawinfo $color $msg")
		2550	}
		2551	}
		2552	}
		2553	}
		2554
2073	=item $client->ext_event ($type, %msg)	2555	=item $client->ext_msg ($type, @msg)
2074		2556
2075	Sends an exti event to the client.	2557	Sends an ext event to the client.
2076		2558
2077	=cut	2559	=cut
2078		2560
2079	sub cf::client::ext_event($$%) {	2561	sub cf::client::ext_msg($$@) {
2080	my ($self, $type, %msg) = @_;	2562	my ($self, $type, @msg) = @_;
2081		2563
		2564	if ($self->extcmd == 2) {
		2565	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2566	} elsif ($self->extcmd == 1) { # TODO: remove
2082	$msg{msgtype} = "event_$type";	2567	push @msg, msgtype => "event_$type";
2083	$self->send_packet ("ext " . cf::to_json \%msg);	2568	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2569	}
		2570	}
		2571
		2572	=item $client->ext_reply ($msgid, @msg)
		2573
		2574	Sends an ext reply to the client.
		2575
		2576	=cut
		2577
		2578	sub cf::client::ext_reply($$@) {
		2579	my ($self, $id, @msg) = @_;
		2580
		2581	if ($self->extcmd == 2) {
		2582	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2583	} elsif ($self->extcmd == 1) {
		2584	#TODO: version 1, remove
		2585	unshift @msg, msgtype => "reply", msgid => $id;
		2586	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2587	}
2084	}	2588	}
2085		2589
2086	=item $success = $client->query ($flags, "text", \&cb)	2590	=item $success = $client->query ($flags, "text", \&cb)
2087		2591
2088	Queues a query to the client, calling the given callback with	2592	Queues a query to the client, calling the given callback with
2089	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2593	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2090	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2594	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2091		2595
2092	Queries can fail, so check the return code. Or don't, as queries will become	2596	Queries can fail, so check the return code. Or don't, as queries will
2093	reliable at some point in the future.	2597	become reliable at some point in the future.
2094		2598
2095	=cut	2599	=cut
2096		2600
2097	sub cf::client::query {	2601	sub cf::client::query {
2098	my ($self, $flags, $text, $cb) = @_;	2602	my ($self, $flags, $text, $cb) = @_;
…		…
2106	utf8::encode $text;	2610	utf8::encode $text;
2107	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2611	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2108		2612
2109	$self->send_packet ($self->{query_queue}[0][0])	2613	$self->send_packet ($self->{query_queue}[0][0])
2110	if @{ $self->{query_queue} } == 1;	2614	if @{ $self->{query_queue} } == 1;
		2615
		2616	1
2111	}	2617	}
2112		2618
2113	cf::client->attach (	2619	cf::client->attach (
		2620	on_connect => sub {
		2621	my ($ns) = @_;
		2622
		2623	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2624	},
2114	on_reply => sub {	2625	on_reply => sub {
2115	my ($ns, $msg) = @_;	2626	my ($ns, $msg) = @_;
2116		2627
2117	# this weird shuffling is so that direct followup queries	2628	# this weird shuffling is so that direct followup queries
2118	# get handled first	2629	# get handled first
…		…
2130	} else {	2641	} else {
2131	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2642	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2132	}	2643	}
2133	}	2644	}
2134	},	2645	},
		2646	on_exticmd => sub {
		2647	my ($ns, $buf) = @_;
		2648
		2649	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2650
		2651	if (ref $msg) {
		2652	my ($type, $reply, @payload) =
		2653	"ARRAY" eq ref $msg
		2654	? @$msg
		2655	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2656
		2657	my @reply;
		2658
		2659	if (my $cb = $EXTICMD{$type}) {
		2660	@reply = $cb->($ns, @payload);
		2661	}
		2662
		2663	$ns->ext_reply ($reply, @reply)
		2664	if $reply;
		2665
		2666	} else {
		2667	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2668	}
		2669
		2670	cf::override;
		2671	},
2135	);	2672	);
2136		2673
2137	=item $client->async (\&cb)	2674	=item $client->async (\&cb)
2138		2675
2139	Create a new coroutine, running the specified callback. The coroutine will	2676	Create a new coroutine, running the specified callback. The coroutine will
…		…
2180	our $safe = new Safe "safe";	2717	our $safe = new Safe "safe";
2181	our $safe_hole = new Safe::Hole;	2718	our $safe_hole = new Safe::Hole;
2182		2719
2183	$SIG{FPE} = 'IGNORE';	2720	$SIG{FPE} = 'IGNORE';
2184		2721
2185	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2722	$safe->permit_only (Opcode::opset qw(
		2723	:base_core :base_mem :base_orig :base_math
		2724	grepstart grepwhile mapstart mapwhile
		2725	sort time
		2726	));
2186		2727
2187	# here we export the classes and methods available to script code	2728	# here we export the classes and methods available to script code
2188		2729
2189	=pod	2730	=pod
2190		2731
2191	The following functions and methods are available within a safe environment:	2732	The following functions and methods are available within a safe environment:
2192		2733
2193	cf::object contr pay_amount pay_player map	2734	cf::object
		2735	contr pay_amount pay_player map x y force_find force_add
		2736	insert remove name archname title slaying race decrease_ob_nr
		2737
2194	cf::object::player player	2738	cf::object::player
2195	cf::player peaceful	2739	player
2196	cf::map trigger	2740
		2741	cf::player
		2742	peaceful
		2743
		2744	cf::map
		2745	trigger
2197		2746
2198	=cut	2747	=cut
2199		2748
2200	for (	2749	for (
2201	["cf::object" => qw(contr pay_amount pay_player map)],	2750	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2751	insert remove inv name archname title slaying race
		2752	decrease_ob_nr)],
2202	["cf::object::player" => qw(player)],	2753	["cf::object::player" => qw(player)],
2203	["cf::player" => qw(peaceful)],	2754	["cf::player" => qw(peaceful)],
2204	["cf::map" => qw(trigger)],	2755	["cf::map" => qw(trigger)],
2205	) {	2756	) {
2206	no strict 'refs';	2757	no strict 'refs';
…		…
2277	=back	2828	=back
2278		2829
2279	=cut	2830	=cut
2280		2831
2281	#############################################################################	2832	#############################################################################
2282
2283	=head2 EXTENSION DATABASE SUPPORT
2284
2285	Crossfire maintains a very simple database for extension use. It can
2286	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2287	convert to/from binary).
2288
2289	The parameter C<$family> should best start with the name of the extension
2290	using it, it should be unique.
2291
2292	=over 4
2293
2294	=item $value = cf::db_get $family => $key
2295
2296	Returns a single value from the database.
2297
2298	=item cf::db_put $family => $key => $value
2299
2300	Stores the given C<$value> in the family.
2301
2302	=cut
2303
2304	our $DB;
2305
2306	sub db_init {
2307	unless ($DB) {
2308	$DB = BDB::db_create $DB_ENV;
2309
2310	cf::sync_job {
2311	eval {
2312	$DB->set_flags (BDB::CHKSUM);
2313
2314	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2315	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2316	cf::cleanup "db_open(db): $!" if $!;
2317	};
2318	cf::cleanup "db_open(db): $@" if $@;
2319	};
2320	}
2321	}
2322
2323	sub db_get($$) {
2324	my $key = "$_[0]/$_[1]";
2325
2326	cf::sync_job {
2327	BDB::db_get $DB, undef, $key, my $data;
2328
2329	$! ? ()
2330	: $data
2331	}
2332	}
2333
2334	sub db_put($$$) {
2335	BDB::dbreq_pri 4;
2336	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2337	}
2338
2339	=item cf::cache $id => [$paths...], $processversion => $process
2340
2341	Generic caching function that returns the value of the resource $id,
2342	caching and regenerating as required.
2343
2344	This function can block.
2345
2346	=cut
2347
2348	sub cache {
2349	my ($id, $src, $processversion, $process) = @_;
2350
2351	my $meta =
2352	join "\x00",
2353	$processversion,
2354	map {
2355	aio_stat $_
2356	and Carp::croak "$_: $!";
2357
2358	($_, (stat _)[7,9])
2359	} @$src;
2360
2361	my $dbmeta = db_get cache => "$id/meta";
2362	if ($dbmeta ne $meta) {
2363	# changed, we may need to process
2364
2365	my @data;
2366	my $md5;
2367
2368	for (0 .. $#$src) {
2369	0 <= aio_load $src->[$_], $data[$_]
2370	or Carp::croak "$src->[$_]: $!";
2371	}
2372
2373	# if processing is expensive, check
2374	# checksum first
2375	if (1) {
2376	$md5 =
2377	join "\x00",
2378	$processversion,
2379	map {
2380	Coro::cede;
2381	($src->[$_], Digest::MD5::md5_hex $data[$_])
2382	} 0.. $#$src;
2383
2384
2385	my $dbmd5 = db_get cache => "$id/md5";
2386	if ($dbmd5 eq $md5) {
2387	db_put cache => "$id/meta", $meta;
2388
2389	return db_get cache => "$id/data";
2390	}
2391	}
2392
2393	my $t1 = Time::HiRes::time;
2394	my $data = $process->(\@data);
2395	my $t2 = Time::HiRes::time;
2396
2397	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2398
2399	db_put cache => "$id/data", $data;
2400	db_put cache => "$id/md5" , $md5;
2401	db_put cache => "$id/meta", $meta;
2402
2403	return $data;
2404	}
2405
2406	db_get cache => "$id/data"
2407	}
2408
2409	=item fork_call { }, $args
2410
2411	Executes the given code block with the given arguments in a seperate
2412	process, returning the results. Everything must be serialisable with
2413	Coro::Storable. May, of course, block. Note that the executed sub may
2414	never block itself or use any form of Event handling.
2415
2416	=cut
2417
2418	sub fork_call(&@) {
2419	my ($cb, @args) = @_;
2420
2421	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2422	# or die "socketpair: $!";
2423	pipe my $fh1, my $fh2
2424	or die "pipe: $!";
2425
2426	if (my $pid = fork) {
2427	close $fh2;
2428
2429	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2430	$res = Coro::Storable::thaw $res;
2431
2432	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2433
2434	die $$res unless "ARRAY" eq ref $res;
2435
2436	return wantarray ? @$res : $res->[-1];
2437	} else {
2438	local $SIG{__WARN__};
2439	eval {
2440	local $SIG{__DIE__};
2441	close $fh1;
2442
2443	my @res = eval { $cb->(@args) };
2444	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2445	};
2446
2447	warn $@ if $@;
2448	_exit 0;
2449	}
2450	}
2451
2452
2453
2454	#############################################################################
2455	# the server's init and main functions	2833	# the server's init and main functions
2456		2834
2457	sub load_facedata($) {	2835	sub load_facedata($) {
2458	my ($path) = @_;	2836	my ($path) = @_;
		2837
		2838	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2459		2839
2460	warn "loading facedata from $path\n";	2840	warn "loading facedata from $path\n";
2461		2841
2462	my $facedata;	2842	my $facedata;
2463	0 < aio_load $path, $facedata	2843	0 < aio_load $path, $facedata
…		…
2466	$facedata = Coro::Storable::thaw $facedata;	2846	$facedata = Coro::Storable::thaw $facedata;
2467		2847
2468	$facedata->{version} == 2	2848	$facedata->{version} == 2
2469	or cf::cleanup "$path: version mismatch, cannot proceed.";	2849	or cf::cleanup "$path: version mismatch, cannot proceed.";
2470		2850
		2851	# patch in the exptable
		2852	$facedata->{resource}{"res/exp_table"} = {
		2853	type => FT_RSRC,
		2854	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
		2855	};
		2856	cf::cede_to_tick;
		2857
2471	{	2858	{
2472	my $faces = $facedata->{faceinfo};	2859	my $faces = $facedata->{faceinfo};
2473		2860
2474	while (my ($face, $info) = each %$faces) {	2861	while (my ($face, $info) = each %$faces) {
2475	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2862	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2476	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2863	cf::face::set_visibility $idx, $info->{visibility};
		2864	cf::face::set_magicmap $idx, $info->{magicmap};
2477	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2865	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2478	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	2866	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2479	Coro::cede;	2867
		2868	cf::cede_to_tick;
2480	}	2869	}
2481		2870
2482	while (my ($face, $info) = each %$faces) {	2871	while (my ($face, $info) = each %$faces) {
2483	next unless $info->{smooth};	2872	next unless $info->{smooth};
2484	my $idx = cf::face::find $face	2873	my $idx = cf::face::find $face
2485	or next;	2874	or next;
2486	if (my $smooth = cf::face::find $info->{smooth}) {	2875	if (my $smooth = cf::face::find $info->{smooth}) {
		2876	cf::face::set_smooth $idx, $smooth;
2487	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	2877	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2488	} else {	2878	} else {
2489	warn "smooth face '$info->{smooth}' not found for face '$face'";	2879	warn "smooth face '$info->{smooth}' not found for face '$face'";
2490	}	2880	}
2491	Coro::cede;	2881
		2882	cf::cede_to_tick;
2492	}	2883	}
2493	}	2884	}
2494		2885
2495	{	2886	{
2496	my $anims = $facedata->{animinfo};	2887	my $anims = $facedata->{animinfo};
2497		2888
2498	while (my ($anim, $info) = each %$anims) {	2889	while (my ($anim, $info) = each %$anims) {
2499	cf::anim::set $anim, $info->{frames}, $info->{facings};	2890	cf::anim::set $anim, $info->{frames}, $info->{facings};
2500	Coro::cede;	2891	cf::cede_to_tick;
2501	}	2892	}
2502		2893
2503	cf::anim::invalidate_all; # d'oh	2894	cf::anim::invalidate_all; # d'oh
2504	}	2895	}
2505		2896
		2897	{
		2898	# TODO: for gcfclient pleasure, we should give resources
		2899	# that gcfclient doesn't grok a >10000 face index.
		2900	my $res = $facedata->{resource};
		2901
		2902	my $soundconf = delete $res->{"res/sound.conf"};
		2903
		2904	while (my ($name, $info) = each %$res) {
		2905	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2906	my $data;
		2907
		2908	if ($info->{type} & 1) {
		2909	# prepend meta info
		2910
		2911	my $meta = $enc->encode ({
		2912	name => $name,
		2913	%{ $info->{meta} || {} },
		2914	});
		2915
		2916	$data = pack "(w/a*)*", $meta, $info->{data};
		2917	} else {
		2918	$data = $info->{data};
		2919	}
		2920
		2921	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		2922	cf::face::set_type $idx, $info->{type};
		2923
		2924	cf::cede_to_tick;
		2925	}
		2926
		2927	if ($soundconf) {
		2928	$soundconf = $enc->decode (delete $soundconf->{data});
		2929
		2930	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2931	my $sound = $soundconf->{compat}[$_]
		2932	or next;
		2933
		2934	my $face = cf::face::find "sound/$sound->[1]";
		2935	cf::sound::set $sound->[0] => $face;
		2936	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2937	}
		2938
		2939	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2940	my $face = cf::face::find "sound/$v";
		2941	cf::sound::set $k => $face;
		2942	}
		2943	}
		2944	}
		2945
2506	1	2946	1
2507	}	2947	}
		2948
		2949	register_exticmd fx_want => sub {
		2950	my ($ns, $want) = @_;
		2951
		2952	while (my ($k, $v) = each %$want) {
		2953	$ns->fx_want ($k, $v);
		2954	}
		2955	};
2508		2956
2509	sub reload_regions {	2957	sub reload_regions {
2510	load_resource_file "$MAPDIR/regions"	2958	load_resource_file "$MAPDIR/regions"
2511	or die "unable to load regions file\n";	2959	or die "unable to load regions file\n";
		2960
		2961	for (cf::region::list) {
		2962	$_->{match} = qr/$_->{match}/
		2963	if exists $_->{match};
		2964	}
2512	}	2965	}
2513		2966
2514	sub reload_facedata {	2967	sub reload_facedata {
2515	load_facedata "$DATADIR/facedata"	2968	load_facedata "$DATADIR/facedata"
2516	or die "unable to load facedata\n";	2969	or die "unable to load facedata\n";
2517	}	2970	}
2518		2971
2519	sub reload_archetypes {	2972	sub reload_archetypes {
2520	load_resource_file "$DATADIR/archetypes"	2973	load_resource_file "$DATADIR/archetypes"
2521	or die "unable to load archetypes\n";	2974	or die "unable to load archetypes\n";
		2975	#d# NEED to laod twice to resolve forward references
		2976	# this really needs to be done in an extra post-pass
		2977	# (which needs to be synchronous, so solve it differently)
		2978	load_resource_file "$DATADIR/archetypes"
		2979	or die "unable to load archetypes\n";
2522	}	2980	}
2523		2981
2524	sub reload_treasures {	2982	sub reload_treasures {
2525	load_resource_file "$DATADIR/treasures"	2983	load_resource_file "$DATADIR/treasures"
2526	or die "unable to load treasurelists\n";	2984	or die "unable to load treasurelists\n";
…		…
2529	sub reload_resources {	2987	sub reload_resources {
2530	warn "reloading resource files...\n";	2988	warn "reloading resource files...\n";
2531		2989
2532	reload_regions;	2990	reload_regions;
2533	reload_facedata;	2991	reload_facedata;
		2992	#reload_archetypes;#d#
2534	reload_archetypes;	2993	reload_archetypes;
2535	reload_treasures;	2994	reload_treasures;
2536		2995
2537	warn "finished reloading resource files\n";	2996	warn "finished reloading resource files\n";
2538	}	2997	}
2539		2998
2540	sub init {	2999	sub init {
2541	reload_resources;	3000	reload_resources;
2542	}	3001	}
2543		3002
2544	sub cfg_load {	3003	sub reload_config {
2545	open my $fh, "<:utf8", "$CONFDIR/config"	3004	open my $fh, "<:utf8", "$CONFDIR/config"
2546	or return;	3005	or return;
2547		3006
2548	local $/;	3007	local $/;
2549	*CFG = YAML::Syck::Load <$fh>;	3008	*CFG = YAML::Syck::Load <$fh>;
…		…
2569	(async {	3028	(async {
2570	Event::one_event;	3029	Event::one_event;
2571	})->prio (Coro::PRIO_MAX);	3030	})->prio (Coro::PRIO_MAX);
2572	};	3031	};
2573		3032
2574	cfg_load;	3033	reload_config;
2575	db_init;	3034	db_init;
2576	load_extensions;	3035	load_extensions;
2577		3036
2578	$TICK_WATCHER->start;	3037	$TICK_WATCHER->start;
2579	Event::loop;	3038	Event::loop;
…		…
2595	},	3054	},
2596	);	3055	);
2597	}	3056	}
2598	}	3057	}
2599		3058
		3059	sub write_runtime {
		3060	my $runtime = "$LOCALDIR/runtime";
		3061
		3062	# first touch the runtime file to show we are still running:
		3063	# the fsync below can take a very very long time.
		3064
		3065	IO::AIO::aio_utime $runtime, undef, undef;
		3066
		3067	my $guard = cf::lock_acquire "write_runtime";
		3068
		3069	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3070	or return;
		3071
		3072	my $value = $cf::RUNTIME + 90 + 10;
		3073	# 10 is the runtime save interval, for a monotonic clock
		3074	# 60 allows for the watchdog to kill the server.
		3075
		3076	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3077	and return;
		3078
		3079	# always fsync - this file is important
		3080	aio_fsync $fh
		3081	and return;
		3082
		3083	# touch it again to show we are up-to-date
		3084	aio_utime $fh, undef, undef;
		3085
		3086	close $fh
		3087	or return;
		3088
		3089	aio_rename "$runtime~", $runtime
		3090	and return;
		3091
		3092	warn "runtime file written.\n";
		3093
		3094	1
		3095	}
		3096
2600	sub emergency_save() {	3097	sub emergency_save() {
2601	my $freeze_guard = cf::freeze_mainloop;	3098	my $freeze_guard = cf::freeze_mainloop;
2602		3099
2603	warn "enter emergency perl save\n";	3100	warn "enter emergency perl save\n";
2604		3101
…		…
2679	%EXT_CORO = ();	3176	%EXT_CORO = ();
2680		3177
2681	warn "removing commands";	3178	warn "removing commands";
2682	%COMMAND = ();	3179	%COMMAND = ();
2683		3180
2684	warn "removing ext commands";	3181	warn "removing ext/exti commands";
2685	%EXTCMD = ();	3182	%EXTCMD = ();
		3183	%EXTICMD = ();
2686		3184
2687	warn "unloading/nuking all extensions";	3185	warn "unloading/nuking all extensions";
2688	for my $pkg (@EXTS) {	3186	for my $pkg (@EXTS) {
2689	warn "... unloading $pkg";	3187	warn "... unloading $pkg";
2690		3188
…		…
2733	warn "reloading cf.pm";	3231	warn "reloading cf.pm";
2734	require cf;	3232	require cf;
2735	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3233	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2736		3234
2737	warn "loading config and database again";	3235	warn "loading config and database again";
2738	cf::cfg_load;	3236	cf::reload_config;
2739		3237
2740	warn "loading extensions";	3238	warn "loading extensions";
2741	cf::load_extensions;	3239	cf::load_extensions;
2742		3240
2743	warn "reattaching attachments to objects/players";	3241	warn "reattaching attachments to objects/players";
…		…
2808	my $signal = new Coro::Signal;	3306	my $signal = new Coro::Signal;
2809	push @WAIT_FOR_TICK_BEGIN, $signal;	3307	push @WAIT_FOR_TICK_BEGIN, $signal;
2810	$signal->wait;	3308	$signal->wait;
2811	}	3309	}
2812		3310
		3311	my $min = 1e6;#d#
		3312	my $avg = 10;
2813	$TICK_WATCHER = Event->timer (	3313	$TICK_WATCHER = Event->timer (
2814	reentrant => 0,	3314	reentrant => 0,
2815	parked => 1,	3315	parked => 1,
2816	prio => 0,	3316	prio => 0,
2817	at => $NEXT_TICK || $TICK,	3317	at => $NEXT_TICK || $TICK,
…		…
2821	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3321	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2822	unless ++$bug_warning > 10;	3322	unless ++$bug_warning > 10;
2823	return;	3323	return;
2824	}	3324	}
2825		3325
2826	$NOW = Event::time;	3326	$NOW = $tick_start = Event::time;
2827		3327
2828	cf::server_tick; # one server iteration	3328	cf::server_tick; # one server iteration
		3329
		3330	0 && sync_job {#d#
		3331	for(1..10) {
		3332	my $t = Event::time;
		3333	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3334	or die;
		3335
		3336	$map->width (50);
		3337	$map->height (50);
		3338	$map->alloc;
		3339	$map->_load_objects ("/tmp/x.map", 1);
		3340	my $t = Event::time - $t;
		3341
		3342	#next unless $t < 0.0013;#d#
		3343	if ($t < $min) {
		3344	$min = $t;
		3345	}
		3346	$avg = $avg * 0.99 + $t * 0.01;
		3347	}
		3348	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3349	exit 0;
		3350	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3351	};
2829		3352
2830	$RUNTIME += $TICK;	3353	$RUNTIME += $TICK;
2831	$NEXT_TICK += $TICK;	3354	$NEXT_TICK += $TICK;
2832		3355
2833	if ($NOW >= $NEXT_RUNTIME_WRITE) {	3356	if ($NOW >= $NEXT_RUNTIME_WRITE) {
…		…
2839	}	3362	}
2840		3363
2841	# my $AFTER = Event::time;	3364	# my $AFTER = Event::time;
2842	# warn $AFTER - $NOW;#d#	3365	# warn $AFTER - $NOW;#d#
2843		3366
		3367	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3368	$sig->send;
		3369	}
		3370	while (my $sig = shift @WAIT_FOR_TICK) {
		3371	$sig->send;
		3372	}
		3373
		3374	$NOW = Event::time;
		3375
2844	# if we are delayed by four ticks or more, skip them all	3376	# if we are delayed by four ticks or more, skip them all
2845	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3377	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2846		3378
2847	$TICK_WATCHER->at ($NEXT_TICK);	3379	$TICK_WATCHER->at ($NEXT_TICK);
2848	$TICK_WATCHER->start;	3380	$TICK_WATCHER->start;
2849		3381
2850	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {	3382	$LOAD = ($NOW - $tick_start) / $TICK;
2851	$sig->send;	3383	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2852	}
2853	while (my $sig = shift @WAIT_FOR_TICK) {
2854	$sig->send;
2855	}
2856		3384
2857	_post_tick;	3385	_post_tick;
		3386
		3387
2858	},	3388	},
2859	);	3389	);
2860		3390
2861	{	3391	{
2862	BDB::max_poll_time $TICK * 0.1;	3392	BDB::max_poll_time $TICK * 0.1;
…		…
2921	prio => 6,	3451	prio => 6,
2922	cb => \&IO::AIO::poll_cb,	3452	cb => \&IO::AIO::poll_cb,
2923	);	3453	);
2924	}	3454	}
2925		3455
		3456	my $_log_backtrace;
		3457
		3458	sub _log_backtrace {
		3459	my ($msg, @addr) = @_;
		3460
		3461	$msg =~ s/\n//;
		3462
		3463	# limit the # of concurrent backtraces
		3464	if ($_log_backtrace < 2) {
		3465	++$_log_backtrace;
		3466	async {
		3467	my @bt = fork_call {
		3468	@addr = map { sprintf "%x", $_ } @addr;
		3469	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3470	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3471	or die "addr2line: $!";
		3472
		3473	my @funcs;
		3474	my @res = <$fh>;
		3475	chomp for @res;
		3476	while (@res) {
		3477	my ($func, $line) = splice @res, 0, 2, ();
		3478	push @funcs, "[$func] $line";
		3479	}
		3480
		3481	@funcs
		3482	};
		3483
		3484	LOG llevInfo, "[ABT] $msg\n";
		3485	LOG llevInfo, "[ABT] $_\n" for @bt;
		3486	--$_log_backtrace;
		3487	};
		3488	} else {
		3489	LOG llevInfo, "[ABT] $msg\n";
		3490	LOG llevInfo, "[ABT] [suppressed]\n";
		3491	}
		3492	}
		3493
2926	# load additional modules	3494	# load additional modules
2927	use cf::pod;	3495	use cf::pod;
2928		3496
2929	END { cf::emergency_save }	3497	END { cf::emergency_save }
2930		3498

Diff Legend

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