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

Diff Legend

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