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.278 by root, Mon Jun 11 21:38:14 2007 UTC vs.
Revision 1.364 by root, Tue Sep 11 08:41: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;
…		…
76	our $NEXT_TICK;	80	our $NEXT_TICK;
77	our $NOW;	81	our $NOW;
78	our $USE_FSYNC = 1; # use fsync to write maps - default off	82	our $USE_FSYNC = 1; # use fsync to write maps - default off
79		83
80	our $BDB_POLL_WATCHER;	84	our $BDB_POLL_WATCHER;
		85	our $BDB_CHECKPOINT_WATCHER;
		86	our $BDB_TRICKLE_WATCHER;
81	our $DB_ENV;	87	our $DB_ENV;
82		88
83	our %CFG;	89	our %CFG;
84		90
85	our $UPTIME; $UPTIME ||= time;	91	our $UPTIME; $UPTIME ||= time;
86	our $RUNTIME;	92	our $RUNTIME;
87		93
88	our %PLAYER; # all users	94	our (%PLAYER, %PLAYER_LOADING); # all users
89	our %MAP; # all maps	95	our (%MAP, %MAP_LOADING ); # all maps
90	our $LINK_MAP; # the special {link} map, which is always available	96	our $LINK_MAP; # the special {link} map, which is always available
91		97
92	# used to convert map paths into valid unix filenames by replacing / by ∕	98	# used to convert map paths into valid unix filenames by replacing / by ∕
93	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	99	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
94		100
…		…
164		170
165	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only	171	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
166	returns directly I<after> the tick processing (and consequently, can only wake one process	172	returns directly I<after> the tick processing (and consequently, can only wake one process
167	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.	173	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
168		174
		175	=item @cf::INVOKE_RESULTS
		176
		177	This array contains the results of the last C<invoke ()> call. When
		178	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		179	that call.
		180
169	=back	181	=back
170		182
171	=cut	183	=cut
172		184
173	BEGIN {	185	BEGIN {
…		…
177	$msg .= "\n"	189	$msg .= "\n"
178	unless $msg =~ /\n$/;	190	unless $msg =~ /\n$/;
179		191
180	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;	192	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
181		193
182	utf8::encode $msg;
183	LOG llevError, $msg;	194	LOG llevError, $msg;
184	};	195	};
185	}	196	}
186		197
187	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	198	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
…		…
206	}	217	}
207		218
208	$Event::DIED = sub {	219	$Event::DIED = sub {
209	warn "error in event callback: @_";	220	warn "error in event callback: @_";
210	};	221	};
		222
		223	#############################################################################
211		224
212	=head2 UTILITY FUNCTIONS	225	=head2 UTILITY FUNCTIONS
213		226
214	=over 4	227	=over 4
215		228
…		…
234	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	247	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
235	$d	248	$d
236	} || "[unable to dump $_[0]: '$@']";	249	} || "[unable to dump $_[0]: '$@']";
237	}	250	}
238		251
239	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
240
241	=item $ref = cf::from_json $json	252	=item $ref = cf::from_json $json
242		253
243	Converts a JSON string into the corresponding perl data structure.	254	Converts a JSON string into the corresponding perl data structure.
244		255
245	=item $json = cf::to_json $ref	256	=item $json = cf::to_json $ref
246		257
247	Converts a perl data structure into its JSON representation.	258	Converts a perl data structure into its JSON representation.
		259
		260	=cut
		261
		262	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
		263
		264	sub to_json ($) { $json_coder->encode ($_[0]) }
		265	sub from_json ($) { $json_coder->decode ($_[0]) }
248		266
249	=item cf::lock_wait $string	267	=item cf::lock_wait $string
250		268
251	Wait until the given lock is available. See cf::lock_acquire.	269	Wait until the given lock is available. See cf::lock_acquire.
252		270
…		…
255	Wait until the given lock is available and then acquires it and returns	273	Wait until the given lock is available and then acquires it and returns
256	a Coro::guard object. If the guard object gets destroyed (goes out of scope,	274	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
257	for example when the coroutine gets canceled), the lock is automatically	275	for example when the coroutine gets canceled), the lock is automatically
258	returned.	276	returned.
259		277
		278	Locks are *not* recursive, locking from the same coro twice results in a
		279	deadlocked coro.
		280
260	Lock names should begin with a unique identifier (for example, cf::map::find	281	Lock names should begin with a unique identifier (for example, cf::map::find
261	uses map_find and cf::map::load uses map_load).	282	uses map_find and cf::map::load uses map_load).
262		283
263	=item $locked = cf::lock_active $string	284	=item $locked = cf::lock_active $string
264		285
265	Return true if the lock is currently active, i.e. somebody has locked it.	286	Return true if the lock is currently active, i.e. somebody has locked it.
266		287
267	=cut	288	=cut
268		289
269	our %LOCK;	290	our %LOCK;
		291	our %LOCKER;#d#
270		292
271	sub lock_wait($) {	293	sub lock_wait($) {
272	my ($key) = @_;	294	my ($key) = @_;
		295
		296	if ($LOCKER{$key} == $Coro::current) {#d#
		297	Carp::cluck "lock_wait($key) for already-acquired lock";#d#
		298	return;#d#
		299	}#d#
273		300
274	# wait for lock, if any	301	# wait for lock, if any
275	while ($LOCK{$key}) {	302	while ($LOCK{$key}) {
276	push @{ $LOCK{$key} }, $Coro::current;	303	push @{ $LOCK{$key} }, $Coro::current;
277	Coro::schedule;	304	Coro::schedule;
…		…
283		310
284	# wait, to be sure we are not locked	311	# wait, to be sure we are not locked
285	lock_wait $key;	312	lock_wait $key;
286		313
287	$LOCK{$key} = [];	314	$LOCK{$key} = [];
		315	$LOCKER{$key} = $Coro::current;#d#
288		316
289	Coro::guard {	317	Coro::guard {
		318	delete $LOCKER{$key};#d#
290	# wake up all waiters, to be on the safe side	319	# wake up all waiters, to be on the safe side
291	$_->ready for @{ delete $LOCK{$key} };	320	$_->ready for @{ delete $LOCK{$key} };
292	}	321	}
293	}	322	}
294		323
…		…
306	};	335	};
307	$TICK_WATCHER->stop;	336	$TICK_WATCHER->stop;
308	$guard	337	$guard
309	}	338	}
310		339
		340	=item cf::get_slot $time[, $priority[, $name]]
		341
		342	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		343	This call blocks and returns only when you have at least C<$time> seconds
		344	of cpu time till the next tick. The slot is only valid till the next cede.
		345
		346	The optional C<$name> can be used to identify the job to run. It might be
		347	used for statistical purposes and should identify the same time-class.
		348
		349	Useful for short background jobs.
		350
		351	=cut
		352
		353	our @SLOT_QUEUE;
		354	our $SLOT_QUEUE;
		355
		356	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		357	$SLOT_QUEUE = Coro::async {
		358	my $signal = new Coro::Signal;
		359
		360	while () {
		361	next_job:
		362	my $avail = cf::till_tick;
		363	if ($avail > 0.01) {
		364	for (0 .. $#SLOT_QUEUE) {
		365	if ($SLOT_QUEUE[$_][0] < $avail) {
		366	my $job = splice @SLOT_QUEUE, $_, 1, ();
		367	$job->[2]->send;
		368	Coro::cede;
		369	goto next_job;
		370	}
		371	}
		372	}
		373
		374	if (@SLOT_QUEUE) {
		375	# we do not use wait_For_tick() as it returns immediately when tick is inactive
		376	push @cf::WAIT_FOR_TICK, $signal;
		377	$signal->wait;
		378	} else {
		379	Coro::schedule;
		380	}
		381	}
		382	};
		383
		384	sub get_slot($;$$) {
		385	my ($time, $pri, $name) = @_;
		386
		387	$time = $TICK * .6 if $time > $TICK * .6;
		388	my $sig = new Coro::Signal;
		389
		390	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		391	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		392	$SLOT_QUEUE->ready;
		393	$sig->wait;
		394	}
		395
311	=item cf::async { BLOCK }	396	=item cf::async { BLOCK }
312		397
313	Currently the same as Coro::async_pool, meaning you cannot use	398	Currently the same as Coro::async_pool, meaning you cannot use
314	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only	399	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
315	thing you are allowed to do is call C<prio> on it.	400	thing you are allowed to do is call C<prio> on it.
…		…
318		403
319	BEGIN { *async = \&Coro::async_pool }	404	BEGIN { *async = \&Coro::async_pool }
320		405
321	=item cf::sync_job { BLOCK }	406	=item cf::sync_job { BLOCK }
322		407
323	The design of crossfire+ requires that the main coro ($Coro::main) is	408	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
324	always able to handle events or runnable, as crossfire+ is only partly	409	is always able to handle events or runnable, as Crossfire TRT is only
325	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	410	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		411	acceptable.
326		412
327	If it must be done, put the blocking parts into C<sync_job>. This will run	413	If it must be done, put the blocking parts into C<sync_job>. This will run
328	the given BLOCK in another coroutine while waiting for the result. The	414	the given BLOCK in another coroutine while waiting for the result. The
329	server will be frozen during this time, so the block should either finish	415	server will be frozen during this time, so the block should either finish
330	fast or be very important.	416	fast or be very important.
…		…
390	$EXT_CORO{$coro+0} = $coro;	476	$EXT_CORO{$coro+0} = $coro;
391		477
392	$coro	478	$coro
393	}	479	}
394		480
395	sub write_runtime {	481	=item fork_call { }, $args
396	my $runtime = "$LOCALDIR/runtime";
397		482
398	# first touch the runtime file to show we are still running:	483	Executes the given code block with the given arguments in a seperate
399	# the fsync below can take a very very long time.	484	process, returning the results. Everything must be serialisable with
		485	Coro::Storable. May, of course, block. Note that the executed sub may
		486	never block itself or use any form of Event handling.
400		487
401	IO::AIO::aio_utime $runtime, undef, undef;	488	=cut
402		489
403	my $guard = cf::lock_acquire "write_runtime";	490	sub fork_call(&@) {
		491	my ($cb, @args) = @_;
404		492
405	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	493	# we seemingly have to make a local copy of the whole thing,
406	or return;	494	# otherwise perl prematurely frees the stuff :/
		495	# TODO: investigate and fix (likely this will be rather laborious)
407		496
408	my $value = $cf::RUNTIME + 90 + 10;	497	my @res = Coro::Util::fork_eval {
409	# 10 is the runtime save interval, for a monotonic clock	498	reset_signals;
410	# 60 allows for the watchdog to kill the server.	499	&$cb
		500	}, @args;
411		501
412	(aio_write $fh, 0, (length $value), $value, 0) <= 0	502	wantarray ? @res : $res[-1]
413	and return;	503	}
414		504
415	# always fsync - this file is important	505	=item $value = cf::db_get $family => $key
416	aio_fsync $fh
417	and return;
418		506
419	# touch it again to show we are up-to-date	507	Returns a single value from the environment database.
420	aio_utime $fh, undef, undef;
421		508
422	close $fh	509	=item cf::db_put $family => $key => $value
423	or return;
424		510
425	aio_rename "$runtime~", $runtime	511	Stores the given C<$value> in the family. It can currently store binary
426	and return;	512	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
427		513
428	warn "runtime file written.\n";	514	=item $db = cf::db_table "name"
429		515
		516	Create and/or open a new database table. The string must not be "db" and must be unique
		517	within each server.
		518
		519	=cut
		520
		521	sub db_table($) {
		522	my ($name) = @_;
		523	my $db = BDB::db_create $DB_ENV;
		524
		525	eval {
		526	$db->set_flags (BDB::CHKSUM);
		527
		528	utf8::encode $name;
		529	BDB::db_open $db, undef, $name, undef, BDB::BTREE,
		530	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		531	cf::cleanup "db_open(db): $!" if $!;
		532	};
		533	cf::cleanup "db_open(db): $@" if $@;
		534
		535	$db
		536	}
		537
		538	our $DB;
		539
		540	sub db_init {
		541	cf::sync_job {
		542	$DB ||= db_table "db";
		543	};
		544	}
		545
		546	sub db_get($$) {
		547	my $key = "$_[0]/$_[1]";
		548
		549	cf::sync_job {
		550	BDB::db_get $DB, undef, $key, my $data;
		551
		552	$! ? ()
		553	: $data
430	1	554	}
		555	}
		556
		557	sub db_put($$$) {
		558	BDB::dbreq_pri 4;
		559	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		560	}
		561
		562	=item cf::cache $id => [$paths...], $processversion => $process
		563
		564	Generic caching function that returns the value of the resource $id,
		565	caching and regenerating as required.
		566
		567	This function can block.
		568
		569	=cut
		570
		571	sub cache {
		572	my ($id, $src, $processversion, $process) = @_;
		573
		574	my $meta =
		575	join "\x00",
		576	$processversion,
		577	map {
		578	aio_stat $_
		579	and Carp::croak "$_: $!";
		580
		581	($_, (stat _)[7,9])
		582	} @$src;
		583
		584	my $dbmeta = db_get cache => "$id/meta";
		585	if ($dbmeta ne $meta) {
		586	# changed, we may need to process
		587
		588	my @data;
		589	my $md5;
		590
		591	for (0 .. $#$src) {
		592	0 <= aio_load $src->[$_], $data[$_]
		593	or Carp::croak "$src->[$_]: $!";
		594	}
		595
		596	# if processing is expensive, check
		597	# checksum first
		598	if (1) {
		599	$md5 =
		600	join "\x00",
		601	$processversion,
		602	map {
		603	cf::cede_to_tick;
		604	($src->[$_], Digest::MD5::md5_hex $data[$_])
		605	} 0.. $#$src;
		606
		607
		608	my $dbmd5 = db_get cache => "$id/md5";
		609	if ($dbmd5 eq $md5) {
		610	db_put cache => "$id/meta", $meta;
		611
		612	return db_get cache => "$id/data";
		613	}
		614	}
		615
		616	my $t1 = Time::HiRes::time;
		617	my $data = $process->(\@data);
		618	my $t2 = Time::HiRes::time;
		619
		620	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		621
		622	db_put cache => "$id/data", $data;
		623	db_put cache => "$id/md5" , $md5;
		624	db_put cache => "$id/meta", $meta;
		625
		626	return $data;
		627	}
		628
		629	db_get cache => "$id/data"
431	}	630	}
432		631
433	=item cf::datalog type => key => value, ...	632	=item cf::datalog type => key => value, ...
434		633
435	Log a datalog packet of the given type with the given key-value pairs.	634	Log a datalog packet of the given type with the given key-value pairs.
…		…
453	attach callbacks/event handlers (a collection of which is called an "attachment")	652	attach callbacks/event handlers (a collection of which is called an "attachment")
454	to it. All such attachable objects support the following methods.	653	to it. All such attachable objects support the following methods.
455		654
456	In the following description, CLASS can be any of C<global>, C<object>	655	In the following description, CLASS can be any of C<global>, C<object>
457	C<player>, C<client> or C<map> (i.e. the attachable objects in	656	C<player>, C<client> or C<map> (i.e. the attachable objects in
458	crossfire+).	657	Crossfire TRT).
459		658
460	=over 4	659	=over 4
461		660
462	=item $attachable->attach ($attachment, key => $value...)	661	=item $attachable->attach ($attachment, key => $value...)
463		662
…		…
665	_attach $registry, $klass, @attach;	864	_attach $registry, $klass, @attach;
666	}	865	}
667		866
668	$obj->{$name} = \%arg;	867	$obj->{$name} = \%arg;
669	} else {	868	} else {
670	warn "object uses attachment '$name' that is not available, postponing.\n";	869	warn "object uses attachment '$name' which is not available, postponing.\n";
671	}	870	}
672		871
673	$obj->{_attachment}{$name} = undef;	872	$obj->{_attachment}{$name} = undef;
674	}	873	}
675		874
…		…
715	";	914	";
716	die if $@;	915	die if $@;
717	}	916	}
718		917
719	our $override;	918	our $override;
720	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	919	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
721		920
722	sub override {	921	sub override {
723	$override = 1;	922	$override = 1;
724	@invoke_results = ();	923	@INVOKE_RESULTS = (@_);
725	}	924	}
726		925
727	sub do_invoke {	926	sub do_invoke {
728	my $event = shift;	927	my $event = shift;
729	my $callbacks = shift;	928	my $callbacks = shift;
730		929
731	@invoke_results = ();	930	@INVOKE_RESULTS = ();
732		931
733	local $override;	932	local $override;
734		933
735	for (@$callbacks) {	934	for (@$callbacks) {
736	eval { &{$_->[1]} };	935	eval { &{$_->[1]} };
…		…
753		952
754	Generate an object-specific event with the given arguments.	953	Generate an object-specific event with the given arguments.
755		954
756	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	955	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
757	removed in future versions), and there is no public API to access override	956	removed in future versions), and there is no public API to access override
758	results (if you must, access C<@cf::invoke_results> directly).	957	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
759		958
760	=back	959	=back
761		960
762	=cut	961	=cut
763		962
764	#############################################################################	963	#############################################################################
765	# object support	964	# object support
		965	#
		966
		967	sub _can_merge {
		968	my ($ob1, $ob2) = @_;
		969
		970	local $Storable::canonical = 1;
		971	my $fob1 = Storable::freeze $ob1;
		972	my $fob2 = Storable::freeze $ob2;
		973
		974	$fob1 eq $fob2
		975	}
766		976
767	sub reattach {	977	sub reattach {
768	# basically do the same as instantiate, without calling instantiate	978	# basically do the same as instantiate, without calling instantiate
769	my ($obj) = @_;	979	my ($obj) = @_;
770		980
…		…
815	);	1025	);
816		1026
817	sub object_freezer_save {	1027	sub object_freezer_save {
818	my ($filename, $rdata, $objs) = @_;	1028	my ($filename, $rdata, $objs) = @_;
819		1029
		1030	my $guard = cf::lock_acquire "io";
		1031
820	sync_job {	1032	sync_job {
821	if (length $$rdata) {	1033	if (length $$rdata) {
		1034	utf8::decode (my $decname = $filename);
822	warn sprintf "saving %s (%d,%d)\n",	1035	warn sprintf "saving %s (%d,%d)\n",
823	$filename, length $$rdata, scalar @$objs;	1036	$decname, length $$rdata, scalar @$objs;
824		1037
825	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1038	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
826	chmod SAVE_MODE, $fh;	1039	chmod SAVE_MODE, $fh;
827	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1040	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
828	aio_fsync $fh if $cf::USE_FSYNC;	1041	aio_fsync $fh if $cf::USE_FSYNC;
…		…
847	}	1060	}
848	} else {	1061	} else {
849	aio_unlink $filename;	1062	aio_unlink $filename;
850	aio_unlink "$filename.pst";	1063	aio_unlink "$filename.pst";
851	}	1064	}
852	}	1065	};
		1066
		1067	undef $guard;
853	}	1068	}
854		1069
855	sub object_freezer_as_string {	1070	sub object_freezer_as_string {
856	my ($rdata, $objs) = @_;	1071	my ($rdata, $objs) = @_;
857		1072
…		…
862		1077
863	sub object_thawer_load {	1078	sub object_thawer_load {
864	my ($filename) = @_;	1079	my ($filename) = @_;
865		1080
866	my ($data, $av);	1081	my ($data, $av);
		1082
		1083	my $guard = cf::lock_acquire "io";
867		1084
868	(aio_load $filename, $data) >= 0	1085	(aio_load $filename, $data) >= 0
869	or return;	1086	or return;
870		1087
871	unless (aio_stat "$filename.pst") {	1088	unless (aio_stat "$filename.pst") {
872	(aio_load "$filename.pst", $av) >= 0	1089	(aio_load "$filename.pst", $av) >= 0
873	or return;	1090	or return;
		1091
		1092	undef $guard;
874	$av = eval { (Storable::thaw $av)->{objs} };	1093	$av = eval { (Storable::thaw $av)->{objs} };
875	}	1094	}
876		1095
		1096	utf8::decode (my $decname = $filename);
877	warn sprintf "loading %s (%d)\n",	1097	warn sprintf "loading %s (%d,%d)\n",
878	$filename, length $data, scalar @{$av || []};	1098	$decname, length $data, scalar @{$av || []};
		1099
879	return ($data, $av);	1100	($data, $av)
880	}	1101	}
		1102
		1103	=head2 COMMAND CALLBACKS
		1104
		1105	=over 4
		1106
		1107	=cut
881		1108
882	#############################################################################	1109	#############################################################################
883	# command handling &c	1110	# command handling &c
884		1111
885	=item cf::register_command $name => \&callback($ob,$args);	1112	=item cf::register_command $name => \&callback($ob,$args);
…		…
898	push @{ $COMMAND{$name} }, [$caller, $cb];	1125	push @{ $COMMAND{$name} }, [$caller, $cb];
899	}	1126	}
900		1127
901	=item cf::register_extcmd $name => \&callback($pl,$packet);	1128	=item cf::register_extcmd $name => \&callback($pl,$packet);
902		1129
903	Register a callbackf ro execution when the client sends an extcmd packet.	1130	Register a callback for execution when the client sends an (synchronous)
		1131	extcmd packet. Ext commands will be processed in the order they are
		1132	received by the server, like other user commands. The first argument is
		1133	the logged-in player. Ext commands can only be processed after a player
		1134	has logged in successfully.
904		1135
905	If the callback returns something, it is sent back as if reply was being	1136	If the callback returns something, it is sent back as if reply was being
906	called.	1137	called.
907		1138
		1139	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1140
		1141	Register a callback for execution when the client sends an (asynchronous)
		1142	exticmd packet. Exti commands are processed by the server as soon as they
		1143	are received, i.e. out of order w.r.t. other commands. The first argument
		1144	is a client socket. Exti commands can be received anytime, even before
		1145	log-in.
		1146
		1147	If the callback returns something, it is sent back as if reply was being
		1148	called.
		1149
908	=cut	1150	=cut
909		1151
910	sub register_extcmd {	1152	sub register_extcmd {
911	my ($name, $cb) = @_;	1153	my ($name, $cb) = @_;
912		1154
913	$EXTCMD{$name} = $cb;	1155	$EXTCMD{$name} = $cb;
		1156	}
		1157
		1158	sub register_exticmd {
		1159	my ($name, $cb) = @_;
		1160
		1161	$EXTICMD{$name} = $cb;
914	}	1162	}
915		1163
916	cf::player->attach (	1164	cf::player->attach (
917	on_command => sub {	1165	on_command => sub {
918	my ($pl, $name, $params) = @_;	1166	my ($pl, $name, $params) = @_;
…		…
927	cf::override;	1175	cf::override;
928	},	1176	},
929	on_extcmd => sub {	1177	on_extcmd => sub {
930	my ($pl, $buf) = @_;	1178	my ($pl, $buf) = @_;
931		1179
932	my $msg = eval { from_json $buf };	1180	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933		1181
934	if (ref $msg) {	1182	if (ref $msg) {
		1183	my ($type, $reply, @payload) =
		1184	"ARRAY" eq ref $msg
		1185	? @$msg
		1186	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1187
		1188	my @reply;
		1189
935	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1190	if (my $cb = $EXTCMD{$type}) {
936	if (my %reply = $cb->($pl, $msg)) {	1191	@reply = $cb->($pl, @payload);
937	$pl->ext_reply ($msg->{msgid}, %reply);
938	}
939	}	1192	}
		1193
		1194	$pl->ext_reply ($reply, @reply)
		1195	if $reply;
		1196
940	} else {	1197	} else {
941	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1198	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
942	}	1199	}
943		1200
944	cf::override;	1201	cf::override;
…		…
967	path => $path,	1224	path => $path,
968	base => $base,	1225	base => $base,
969	pkg => $pkg,	1226	pkg => $pkg,
970	);	1227	);
971		1228
972	$ext{meta} = { map { split /=/, $_, 2 } split /\s+/, $1 }	1229	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
973	if $source =~ /^#!.*?perl.*?#\s*(.*)$/;	1230	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
974		1231
975	$ext{source} =	1232	$ext{source} =
976	"package $pkg; use strict; use utf8;\n"	1233	"package $pkg; use strict; use utf8;\n"
977	. "#line 1 \"$path\"\n{\n"	1234	. "#line 1 \"$path\"\n{\n"
978	. $source	1235	. $source
…		…
984	my %done;	1241	my %done;
985	while (%todo) {	1242	while (%todo) {
986	my $progress;	1243	my $progress;
987		1244
988	while (my ($k, $v) = each %todo) {	1245	while (my ($k, $v) = each %todo) {
989	for (split /,\s*/, $ext{meta}{depends}) {	1246	for (split /,\s*/, $v->{meta}{depends}) {
990	goto skip	1247	goto skip
991	unless exists $done{$_};	1248	unless exists $done{$_};
992	}	1249	}
993		1250
994	warn "... loading '$k' into '$v->{pkg}'\n";	1251	warn "... loading '$k' into '$v->{pkg}'\n";
995		1252
996	unless (eval $v->{source}) {	1253	unless (eval $v->{source}) {
997	my $msg = $@ ? "$v->{path}: $@\n"	1254	my $msg = $@ ? "$v->{path}: $@\n"
998	: "extension disabled.\n";	1255	: "$v->{base}: extension inactive.\n";
999		1256
1000	if (exists $v->{meta}{mandatory}) {	1257	if (exists $v->{meta}{mandatory}) {
1001	warn $msg;	1258	warn $msg;
1002	warn "mandatory extension failed to load, exiting.\n";	1259	warn "mandatory extension failed to load, exiting.\n";
1003	exit 1;	1260	exit 1;
1004	}	1261	}
1005		1262
1006	die $msg;	1263	warn $msg;
1007	}	1264	}
1008		1265
1009	$done{$k} = delete $todo{$k};	1266	$done{$k} = delete $todo{$k};
1010	push @EXTS, $v->{pkg};	1267	push @EXTS, $v->{pkg};
		1268	$progress = 1;
1011	}	1269	}
1012		1270
1013	skip:	1271	skip:
1014	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"	1272	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1015	unless $progress;	1273	unless $progress;
…		…
1017	};	1275	};
1018	}	1276	}
1019		1277
1020	#############################################################################	1278	#############################################################################
1021		1279
		1280	=back
		1281
1022	=head2 CORE EXTENSIONS	1282	=head2 CORE EXTENSIONS
1023		1283
1024	Functions and methods that extend core crossfire objects.	1284	Functions and methods that extend core crossfire objects.
1025		1285
1026	=cut	1286	=cut
…		…
1030	use Coro::AIO;	1290	use Coro::AIO;
1031		1291
1032	=head3 cf::player	1292	=head3 cf::player
1033		1293
1034	=over 4	1294	=over 4
		1295
		1296	=item cf::player::num_playing
		1297
		1298	Returns the official number of playing players, as per the Crossfire metaserver rules.
		1299
		1300	=cut
		1301
		1302	sub num_playing {
		1303	scalar grep
		1304	$_->ob->map
		1305	&& !$_->hidden
		1306	&& !$_->ob->flag (cf::FLAG_WIZ),
		1307	cf::player::list
		1308	}
1035		1309
1036	=item cf::player::find $login	1310	=item cf::player::find $login
1037		1311
1038	Returns the given player object, loading it if necessary (might block).	1312	Returns the given player object, loading it if necessary (might block).
1039		1313
…		…
1075	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";	1349	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1076	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";	1350	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1077	aio_unlink +(playerdir $login) . "/$login.pl.pst";	1351	aio_unlink +(playerdir $login) . "/$login.pl.pst";
1078	aio_unlink +(playerdir $login) . "/$login.pl";	1352	aio_unlink +(playerdir $login) . "/$login.pl";
1079		1353
1080	my $pl = load_pl path $login	1354	my $f = new_from_file cf::object::thawer path $login
1081	or return;	1355	or return;
		1356
		1357	$f->next;
		1358	my $pl = cf::player::load_pl $f
		1359	or return;
		1360	local $cf::PLAYER_LOADING{$login} = $pl;
		1361	$f->resolve_delayed_derefs;
1082	$cf::PLAYER{$login} = $pl	1362	$cf::PLAYER{$login} = $pl
1083	}	1363	}
1084	}	1364	}
1085	}	1365	}
1086		1366
…		…
1096		1376
1097	aio_mkdir playerdir $pl, 0770;	1377	aio_mkdir playerdir $pl, 0770;
1098	$pl->{last_save} = $cf::RUNTIME;	1378	$pl->{last_save} = $cf::RUNTIME;
1099		1379
1100	$pl->save_pl ($path);	1380	$pl->save_pl ($path);
1101	Coro::cede;	1381	cf::cede_to_tick;
1102	}	1382	}
1103		1383
1104	sub new($) {	1384	sub new($) {
1105	my ($login) = @_;	1385	my ($login) = @_;
1106		1386
…		…
1110	$self->{deny_save} = 1;	1390	$self->{deny_save} = 1;
1111		1391
1112	$cf::PLAYER{$login} = $self;	1392	$cf::PLAYER{$login} = $self;
1113		1393
1114	$self	1394	$self
		1395	}
		1396
		1397	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1398
		1399	=cut
		1400
		1401	sub send_msg {
		1402	my $ns = shift->ns
		1403	or return;
		1404	$ns->send_msg (@_);
1115	}	1405	}
1116		1406
1117	=item $pl->quit_character	1407	=item $pl->quit_character
1118		1408
1119	Nukes the player without looking back. If logged in, the connection will	1409	Nukes the player without looking back. If logged in, the connection will
…		…
1174	or return [];	1464	or return [];
1175		1465
1176	my @logins;	1466	my @logins;
1177		1467
1178	for my $login (@$dirs) {	1468	for my $login (@$dirs) {
		1469	my $path = path $login;
		1470
		1471	# a .pst is a dead give-away for a valid player
		1472	unless (-e "$path.pst") {
1179	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1473	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1180	aio_read $fh, 0, 512, my $buf, 0 or next;	1474	aio_read $fh, 0, 512, my $buf, 0 or next;
1181	$buf !~ /^password -------------$/m or next; # official not-valid tag	1475	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1476	}
1182		1477
1183	utf8::decode $login;	1478	utf8::decode $login;
1184	push @logins, $login;	1479	push @logins, $login;
1185	}	1480	}
1186		1481
…		…
1213	}	1508	}
1214		1509
1215	\@paths	1510	\@paths
1216	}	1511	}
1217		1512
		1513	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1514
		1515	Expand crossfire pod fragments into protocol xml.
		1516
		1517	=cut
		1518
		1519	sub expand_cfpod {
		1520	((my $self), (local $_)) = @_;
		1521
		1522	# escape & and <
		1523	s/&/&amp;/g;
		1524	s/(?<![BIUGHT])</&lt;/g;
		1525
		1526	# this is buggy, it needs to properly take care of nested <'s
		1527
		1528	1 while
		1529	# replace B<>, I<>, U<> etc.
		1530	s/B<([^\>]*)>/<b>$1<\/b>/
		1531	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1532	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1533	|| s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
		1534	# replace G<male|female> tags
		1535	|| s{G<([^>|]*)\|([^>]*)>}{
		1536	$self->gender ? $2 : $1
		1537	}ge
		1538	# replace H<hint text>
		1539	|| s{H<([^\>]*)>}
		1540	{
		1541	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1542	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1543	"")
		1544	[$self->{hintmode}]
		1545	}ge;
		1546
		1547	# create single paragraphs (very hackish)
		1548	s/(?<=\S)\n(?=\w)/ /g;
		1549
		1550	# compress some whitespace
		1551	s/\s+\n/\n/g; # ws line-ends
		1552	s/\n\n+/\n/g; # double lines
		1553	s/^\n+//; # beginning lines
		1554	s/\n+$//; # ending lines
		1555
		1556	$_
		1557	}
		1558
		1559	sub hintmode {
		1560	$_[0]{hintmode} = $_[1] if @_ > 1;
		1561	$_[0]{hintmode}
		1562	}
		1563
1218	=item $player->ext_reply ($msgid, %msg)	1564	=item $player->ext_reply ($msgid, @msg)
1219		1565
1220	Sends an ext reply to the player.	1566	Sends an ext reply to the player.
1221		1567
1222	=cut	1568	=cut
1223		1569
1224	sub ext_reply($$%) {	1570	sub ext_reply($$@) {
1225	my ($self, $id, %msg) = @_;	1571	my ($self, $id, @msg) = @_;
1226		1572
1227	$msg{msgid} = $id;	1573	$self->ns->ext_reply ($id, @msg)
1228
1229	$self->send ("ext " . cf::to_json \%msg);
1230	}	1574	}
1231		1575
1232	=item $player->ext_event ($type, %msg)	1576	=item $player->ext_msg ($type, @msg)
1233		1577
1234	Sends an ext event to the client.	1578	Sends an ext event to the client.
1235		1579
1236	=cut	1580	=cut
1237		1581
1238	sub ext_event($$%) {	1582	sub ext_msg($$@) {
1239	my ($self, $type, %msg) = @_;	1583	my ($self, $type, @msg) = @_;
1240		1584
1241	$self->ns->ext_event ($type, %msg);	1585	$self->ns->ext_msg ($type, @msg);
1242	}	1586	}
1243		1587
1244	=head3 cf::region	1588	=head3 cf::region
1245		1589
1246	=over 4	1590	=over 4
…		…
1249		1593
1250	package cf::region;	1594	package cf::region;
1251		1595
1252	=item cf::region::find_by_path $path	1596	=item cf::region::find_by_path $path
1253		1597
1254	Tries to decuce the probable region for a map knowing only its path.	1598	Tries to decuce the likely region for a map knowing only its path.
1255		1599
1256	=cut	1600	=cut
1257		1601
1258	sub find_by_path($) {	1602	sub find_by_path($) {
1259	my ($path) = @_;	1603	my ($path) = @_;
1260		1604
1261	my ($match, $specificity);	1605	my ($match, $specificity);
1262		1606
1263	for my $region (list) {	1607	for my $region (list) {
1264	if ($region->match && $path =~ $region->match) {	1608	if ($region->{match} && $path =~ $region->{match}) {
1265	($match, $specificity) = ($region, $region->specificity)	1609	($match, $specificity) = ($region, $region->specificity)
1266	if $region->specificity > $specificity;	1610	if $region->specificity > $specificity;
1267	}	1611	}
1268	}	1612	}
1269		1613
…		…
1389	$self->init; # pass $1 etc.	1733	$self->init; # pass $1 etc.
1390	return $self;	1734	return $self;
1391	}	1735	}
1392	}	1736	}
1393		1737
1394	Carp::carp "unable to resolve path '$path' (base '$base').";	1738	Carp::cluck "unable to resolve path '$path' (base '$base').";
1395	()	1739	()
1396	}	1740	}
1397		1741
1398	sub init {	1742	sub init {
1399	my ($self) = @_;	1743	my ($self) = @_;
…		…
1462		1806
1463	sub load_header_from($) {	1807	sub load_header_from($) {
1464	my ($self, $path) = @_;	1808	my ($self, $path) = @_;
1465		1809
1466	utf8::encode $path;	1810	utf8::encode $path;
1467	#aio_open $path, O_RDONLY, 0	1811	my $f = new_from_file cf::object::thawer $path
1468	# or return;
1469
1470	$self->_load_header ($path)
1471	or return;	1812	or return;
		1813
		1814	$self->_load_header ($f)
		1815	or return;
		1816
		1817	local $MAP_LOADING{$self->{path}} = $self;
		1818	$f->resolve_delayed_derefs;
1472		1819
1473	$self->{load_path} = $path;	1820	$self->{load_path} = $path;
1474		1821
1475	1	1822	1
1476	}	1823	}
…		…
1530	sub find {	1877	sub find {
1531	my ($path, $origin) = @_;	1878	my ($path, $origin) = @_;
1532		1879
1533	$path = normalise $path, $origin && $origin->path;	1880	$path = normalise $path, $origin && $origin->path;
1534		1881
		1882	cf::lock_wait "map_data:$path";#d#remove
1535	cf::lock_wait "map_find:$path";	1883	cf::lock_wait "map_find:$path";
1536		1884
1537	$cf::MAP{$path} || do {	1885	$cf::MAP{$path} || do {
1538	my $guard = cf::lock_acquire "map_find:$path";	1886	my $guard1 = cf::lock_acquire "map_find:$path";
		1887	my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
		1888
1539	my $map = new_from_path cf::map $path	1889	my $map = new_from_path cf::map $path
1540	or return;	1890	or return;
1541		1891
1542	$map->{last_save} = $cf::RUNTIME;	1892	$map->{last_save} = $cf::RUNTIME;
1543		1893
…		…
1545	or return;	1895	or return;
1546		1896
1547	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)	1897	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1548	# doing this can freeze the server in a sync job, obviously	1898	# doing this can freeze the server in a sync job, obviously
1549	#$cf::WAIT_FOR_TICK->wait;	1899	#$cf::WAIT_FOR_TICK->wait;
		1900	undef $guard1;
		1901	undef $guard2;
1550	$map->reset;	1902	$map->reset;
1551	undef $guard;
1552	return find $path;	1903	return find $path;
1553	}	1904	}
1554		1905
1555	$cf::MAP{$path} = $map	1906	$cf::MAP{$path} = $map
1556	}	1907	}
…		…
1565	local $self->{deny_reset} = 1; # loading can take a long time	1916	local $self->{deny_reset} = 1; # loading can take a long time
1566		1917
1567	my $path = $self->{path};	1918	my $path = $self->{path};
1568		1919
1569	{	1920	{
1570	my $guard = cf::lock_acquire "map_load:$path";	1921	my $guard = cf::lock_acquire "map_data:$path";
1571		1922
		1923	return unless $self->valid;
1572	return if $self->in_memory != cf::MAP_SWAPPED;	1924	return unless $self->in_memory == cf::MAP_SWAPPED;
1573		1925
1574	$self->in_memory (cf::MAP_LOADING);	1926	$self->in_memory (cf::MAP_LOADING);
1575		1927
1576	$self->alloc;	1928	$self->alloc;
1577		1929
1578	$self->pre_load;	1930	$self->pre_load;
1579	Coro::cede;	1931	cf::cede_to_tick;
1580		1932
		1933	my $f = new_from_file cf::object::thawer $self->{load_path};
		1934	$f->skip_block;
1581	$self->_load_objects ($self->{load_path}, 1)	1935	$self->_load_objects ($f)
1582	or return;	1936	or return;
1583		1937
1584	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1938	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1585	if delete $self->{load_original};	1939	if delete $self->{load_original};
1586		1940
1587	if (my $uniq = $self->uniq_path) {	1941	if (my $uniq = $self->uniq_path) {
1588	utf8::encode $uniq;	1942	utf8::encode $uniq;
1589	if (aio_open $uniq, O_RDONLY, 0) {	1943	unless (aio_stat $uniq) {
		1944	if (my $f = new_from_file cf::object::thawer $uniq) {
1590	$self->clear_unique_items;	1945	$self->clear_unique_items;
1591	$self->_load_objects ($uniq, 0);	1946	$self->_load_objects ($f);
		1947	$f->resolve_delayed_derefs;
		1948	}
1592	}	1949	}
1593	}	1950	}
1594		1951
1595	Coro::cede;	1952	$f->resolve_delayed_derefs;
		1953
		1954	cf::cede_to_tick;
1596	# now do the right thing for maps	1955	# now do the right thing for maps
1597	$self->link_multipart_objects;	1956	$self->link_multipart_objects;
1598	$self->difficulty ($self->estimate_difficulty)	1957	$self->difficulty ($self->estimate_difficulty)
1599	unless $self->difficulty;	1958	unless $self->difficulty;
1600	Coro::cede;	1959	cf::cede_to_tick;
1601		1960
1602	unless ($self->{deny_activate}) {	1961	unless ($self->{deny_activate}) {
1603	$self->decay_objects;	1962	$self->decay_objects;
1604	$self->fix_auto_apply;	1963	$self->fix_auto_apply;
1605	$self->update_buttons;	1964	$self->update_buttons;
1606	Coro::cede;	1965	cf::cede_to_tick;
1607	$self->set_darkness_map;	1966	$self->set_darkness_map;
1608	Coro::cede;	1967	cf::cede_to_tick;
1609	$self->activate;	1968	$self->activate;
1610	}	1969	}
		1970
		1971	$self->{last_save} = $cf::RUNTIME;
		1972	$self->last_access ($cf::RUNTIME);
1611		1973
1612	$self->in_memory (cf::MAP_IN_MEMORY);	1974	$self->in_memory (cf::MAP_IN_MEMORY);
1613	}	1975	}
1614		1976
1615	$self->post_load;	1977	$self->post_load;
…		…
1626		1988
1627	$self	1989	$self
1628	}	1990	}
1629		1991
1630	# find and load all maps in the 3x3 area around a map	1992	# find and load all maps in the 3x3 area around a map
1631	sub load_diag {	1993	sub load_neighbours {
1632	my ($map) = @_;	1994	my ($map) = @_;
1633		1995
1634	my @diag; # diagonal neighbours	1996	my @neigh; # diagonal neighbours
1635		1997
1636	for (0 .. 3) {	1998	for (0 .. 3) {
1637	my $neigh = $map->tile_path ($_)	1999	my $neigh = $map->tile_path ($_)
1638	or next;	2000	or next;
1639	$neigh = find $neigh, $map	2001	$neigh = find $neigh, $map
1640	or next;	2002	or next;
1641	$neigh->load;	2003	$neigh->load;
1642		2004
		2005	push @neigh,
1643	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2006	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1644	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2007	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1645	}	2008	}
1646		2009
1647	for (@diag) {	2010	for (grep defined $_->[0], @neigh) {
		2011	my ($path, $origin) = @$_;
1648	my $neigh = find @$_	2012	my $neigh = find $path, $origin
1649	or next;	2013	or next;
1650	$neigh->load;	2014	$neigh->load;
1651	}	2015	}
1652	}	2016	}
1653		2017
…		…
1658	}	2022	}
1659		2023
1660	sub do_load_sync {	2024	sub do_load_sync {
1661	my ($map) = @_;	2025	my ($map) = @_;
1662		2026
		2027	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2028	if $Coro::current == $Coro::main;
		2029
1663	cf::sync_job { $map->load };	2030	cf::sync_job { $map->load };
1664	}	2031	}
1665		2032
1666	our %MAP_PREFETCH;	2033	our %MAP_PREFETCH;
1667	our $MAP_PREFETCHER = undef;	2034	our $MAP_PREFETCHER = undef;
1668		2035
1669	sub find_async {	2036	sub find_async {
1670	my ($path, $origin) = @_;	2037	my ($path, $origin, $load) = @_;
1671		2038
1672	$path = normalise $path, $origin && $origin->{path};	2039	$path = normalise $path, $origin && $origin->{path};
1673		2040
1674	if (my $map = $cf::MAP{$path}) {	2041	if (my $map = $cf::MAP{$path}) {
1675	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2042	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1676	}	2043	}
1677		2044
1678	undef $MAP_PREFETCH{$path};	2045	$MAP_PREFETCH{$path} |= $load;
		2046
1679	$MAP_PREFETCHER ||= cf::async {	2047	$MAP_PREFETCHER ||= cf::async {
1680	while (%MAP_PREFETCH) {	2048	while (%MAP_PREFETCH) {
1681	for my $path (keys %MAP_PREFETCH) {	2049	while (my ($k, $v) = each %MAP_PREFETCH) {
1682	my $map = find $path	2050	if (my $map = find $k) {
1683	or next;
1684	$map->load;	2051	$map->load if $v;
		2052	}
1685		2053
1686	delete $MAP_PREFETCH{$path};	2054	delete $MAP_PREFETCH{$k};
1687	}	2055	}
1688	}	2056	}
1689	undef $MAP_PREFETCHER;	2057	undef $MAP_PREFETCHER;
1690	};	2058	};
1691	$MAP_PREFETCHER->prio (6);	2059	$MAP_PREFETCHER->prio (6);
…		…
1694	}	2062	}
1695		2063
1696	sub save {	2064	sub save {
1697	my ($self) = @_;	2065	my ($self) = @_;
1698		2066
1699	my $lock = cf::lock_acquire "map_data:" . $self->path;	2067	my $lock = cf::lock_acquire "map_data:$self->{path}";
1700		2068
1701	$self->{last_save} = $cf::RUNTIME;	2069	$self->{last_save} = $cf::RUNTIME;
1702		2070
1703	return unless $self->dirty;	2071	return unless $self->dirty;
1704		2072
…		…
1727	my ($self) = @_;	2095	my ($self) = @_;
1728		2096
1729	# save first because save cedes	2097	# save first because save cedes
1730	$self->save;	2098	$self->save;
1731		2099
1732	my $lock = cf::lock_acquire "map_data:" . $self->path;	2100	my $lock = cf::lock_acquire "map_data:$self->{path}";
1733		2101
1734	return if $self->players;	2102	return if $self->players;
1735	return if $self->in_memory != cf::MAP_IN_MEMORY;	2103	return if $self->in_memory != cf::MAP_IN_MEMORY;
1736	return if $self->{deny_save};	2104	return if $self->{deny_save};
1737		2105
		2106	$self->in_memory (cf::MAP_SWAPPED);
		2107
		2108	$self->deactivate;
		2109	$_->clear_links_to ($self) for values %cf::MAP;
1738	$self->clear;	2110	$self->clear;
1739	$self->in_memory (cf::MAP_SWAPPED);
1740	}	2111	}
1741		2112
1742	sub reset_at {	2113	sub reset_at {
1743	my ($self) = @_;	2114	my ($self) = @_;
1744		2115
…		…
1776	if $uniq;	2147	if $uniq;
1777	}	2148	}
1778		2149
1779	delete $cf::MAP{$self->path};	2150	delete $cf::MAP{$self->path};
1780		2151
		2152	$self->deactivate;
		2153	$_->clear_links_to ($self) for values %cf::MAP;
1781	$self->clear;	2154	$self->clear;
1782
1783	$_->clear_links_to ($self) for values %cf::MAP;
1784		2155
1785	$self->unlink_save;	2156	$self->unlink_save;
1786	$self->destroy;	2157	$self->destroy;
1787	}	2158	}
1788		2159
1789	my $nuke_counter = "aaaa";	2160	my $nuke_counter = "aaaa";
1790		2161
1791	sub nuke {	2162	sub nuke {
1792	my ($self) = @_;	2163	my ($self) = @_;
1793		2164
		2165	{
		2166	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2167
1794	delete $cf::MAP{$self->path};	2168	delete $cf::MAP{$self->path};
1795		2169
1796	$self->unlink_save;	2170	$self->unlink_save;
1797		2171
1798	bless $self, "cf::map";	2172	bless $self, "cf::map";
1799	delete $self->{deny_reset};	2173	delete $self->{deny_reset};
1800	$self->{deny_save} = 1;	2174	$self->{deny_save} = 1;
1801	$self->reset_timeout (1);	2175	$self->reset_timeout (1);
1802	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2176	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1803		2177
1804	$cf::MAP{$self->path} = $self;	2178	$cf::MAP{$self->path} = $self;
		2179	}
1805		2180
1806	$self->reset; # polite request, might not happen	2181	$self->reset; # polite request, might not happen
1807	}	2182	}
1808		2183
1809	=item $maps = cf::map::tmp_maps	2184	=item $maps = cf::map::tmp_maps
…		…
1885		2260
1886	sub inv_recursive {	2261	sub inv_recursive {
1887	inv_recursive_ inv $_[0]	2262	inv_recursive_ inv $_[0]
1888	}	2263	}
1889		2264
		2265	=item $ref = $ob->ref
		2266
		2267	creates and returns a persistent reference to an objetc that can be stored as a string.
		2268
		2269	=item $ob = cf::object::deref ($refstring)
		2270
		2271	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2272	even if the object actually exists. May block.
		2273
		2274	=cut
		2275
		2276	sub deref {
		2277	my ($ref) = @_;
		2278
		2279	# temporary compatibility#TODO#remove
		2280	$ref =~ s{^<}{player/<};
		2281
		2282	if ($ref =~ m{^player\/(<1\.\d+>)/(.*)$}) {
		2283	my ($uuid, $name) = ($1, $2);
		2284	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2285	or return;
		2286	$pl->ob->uuid eq $uuid
		2287	or return;
		2288
		2289	$pl->ob
		2290	} else {
		2291	warn "$ref: cannot resolve object reference\n";
		2292	undef
		2293	}
		2294	}
		2295
1890	package cf;	2296	package cf;
1891		2297
1892	=back	2298	=back
1893		2299
1894	=head3 cf::object::player	2300	=head3 cf::object::player
…		…
1911		2317
1912	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2318	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1913		2319
1914	if ($self->{record_replies}) {	2320	if ($self->{record_replies}) {
1915	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2321	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2322
1916	} else {	2323	} else {
		2324	my $pl = $self->contr;
		2325
		2326	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2327	my $dialog = $pl->{npc_dialog};
		2328	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2329
		2330	} else {
1917	$msg = $npc->name . " says: $msg" if $npc;	2331	$msg = $npc->name . " says: $msg" if $npc;
1918	$self->message ($msg, $flags);	2332	$self->message ($msg, $flags);
		2333	}
1919	}	2334	}
		2335	}
		2336
		2337	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2338
		2339	=cut
		2340
		2341	sub cf::object::send_msg {
		2342	my $pl = shift->contr
		2343	or return;
		2344	$pl->send_msg (@_);
1920	}	2345	}
1921		2346
1922	=item $player_object->may ("access")	2347	=item $player_object->may ("access")
1923		2348
1924	Returns wether the given player is authorized to access resource "access"	2349	Returns wether the given player is authorized to access resource "access"
…		…
2003	# use -1 or undef as default coordinates, not 0, 0	2428	# use -1 or undef as default coordinates, not 0, 0
2004	($x, $y) = ($map->enter_x, $map->enter_y)	2429	($x, $y) = ($map->enter_x, $map->enter_y)
2005	if $x <=0 && $y <= 0;	2430	if $x <=0 && $y <= 0;
2006		2431
2007	$map->load;	2432	$map->load;
2008	$map->load_diag;	2433	$map->load_neighbours;
2009		2434
2010	return unless $self->contr->active;	2435	return unless $self->contr->active;
2011	$self->activate_recursive;	2436	$self->activate_recursive;
2012		2437
2013	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2438	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2014	$self->enter_map ($map, $x, $y);	2439	$self->enter_map ($map, $x, $y);
2015	}	2440	}
2016		2441
2017	=item $player_object->goto ($path, $x, $y[, $check->($map)])	2442	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
2018		2443
2019	Moves the player to the given map-path and coordinates by first freezing	2444	Moves the player to the given map-path and coordinates by first freezing
2020	her, loading and preparing them map, calling the provided $check callback	2445	her, loading and preparing them map, calling the provided $check callback
2021	that has to return the map if sucecssful, and then unfreezes the player on	2446	that has to return the map if sucecssful, and then unfreezes the player on
2022	the new (success) or old (failed) map position.	2447	the new (success) or old (failed) map position. In either case, $done will
		2448	be called at the end of this process.
2023		2449
2024	=cut	2450	=cut
2025		2451
2026	our $GOTOGEN;	2452	our $GOTOGEN;
2027		2453
2028	sub cf::object::player::goto {	2454	sub cf::object::player::goto {
2029	my ($self, $path, $x, $y, $check) = @_;	2455	my ($self, $path, $x, $y, $check, $done) = @_;
2030		2456
2031	# do generation counting so two concurrent goto's will be executed in-order	2457	# do generation counting so two concurrent goto's will be executed in-order
2032	my $gen = $self->{_goto_generation} = ++$GOTOGEN;	2458	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
2033		2459
2034	$self->enter_link;	2460	$self->enter_link;
…		…
2054		2480
2055	if ($gen == $self->{_goto_generation}) {	2481	if ($gen == $self->{_goto_generation}) {
2056	delete $self->{_goto_generation};	2482	delete $self->{_goto_generation};
2057	$self->leave_link ($map, $x, $y);	2483	$self->leave_link ($map, $x, $y);
2058	}	2484	}
		2485
		2486	$done->() if $done;
2059	})->prio (1);	2487	})->prio (1);
2060	}	2488	}
2061		2489
2062	=item $player_object->enter_exit ($exit_object)	2490	=item $player_object->enter_exit ($exit_object)
2063		2491
…		…
2132	my $hp = $exit->stats->hp;	2560	my $hp = $exit->stats->hp;
2133	my $sp = $exit->stats->sp;	2561	my $sp = $exit->stats->sp;
2134		2562
2135	$self->enter_link;	2563	$self->enter_link;
2136		2564
		2565	# if exit is damned, update players death & WoR home-position
		2566	$self->contr->savebed ($slaying, $hp, $sp)
		2567	if $exit->flag (FLAG_DAMNED);
		2568
2137	(async {	2569	(async {
2138	$self->deactivate_recursive; # just to be sure	2570	$self->deactivate_recursive; # just to be sure
2139	unless (eval {	2571	unless (eval {
2140	$self->goto ($slaying, $hp, $sp);	2572	$self->goto ($slaying, $hp, $sp);
2141		2573
…		…
2168		2600
2169	utf8::encode $text;	2601	utf8::encode $text;
2170	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2602	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2171	}	2603	}
2172		2604
		2605	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2606
		2607	Send a drawinfo or msg packet to the client, formatting the msg for the
		2608	client if neccessary. C<$type> should be a string identifying the type of
		2609	the message, with C<log> being the default. If C<$color> is negative, suppress
		2610	the message unless the client supports the msg packet.
		2611
		2612	=cut
		2613
		2614	our %CHANNEL = (
		2615	"c/identify" => {
		2616	id => "identify",
		2617	title => "Identify",
		2618	reply => undef,
		2619	tooltip => "Items recently identified",
		2620	},
		2621	"c/examine" => {
		2622	id => "examine",
		2623	title => "Examine",
		2624	reply => undef,
		2625	tooltip => "Signs and other items you examined",
		2626	},
		2627	);
		2628
		2629	sub cf::client::send_msg {
		2630	my ($self, $channel, $msg, $color, @extra) = @_;
		2631
		2632	$msg = $self->pl->expand_cfpod ($msg);
		2633
		2634	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2635
		2636	# check predefined channels, for the benefit of C
		2637	$channel = $CHANNEL{$channel} if $CHANNEL{$channel};
		2638
		2639	if (ref $channel) {
		2640	# send meta info to client, if not yet sent
		2641	unless (exists $self->{channel}{$channel->{id}}) {
		2642	$self->{channel}{$channel->{id}} = $channel;
		2643	$self->ext_msg (channel_info => $channel)
		2644	if $self->can_msg;
		2645	}
		2646
		2647	$channel = $channel->{id};
		2648	}
		2649
		2650	return unless @extra || length $msg;
		2651
		2652	if ($self->can_msg) {
		2653	# default colour, mask it out
		2654	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2655	if $color & cf::NDI_DEF;
		2656
		2657	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2658	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2659	} else {
		2660	if ($color >= 0) {
		2661	# replace some tags by gcfclient-compatible ones
		2662	for ($msg) {
		2663	1 while
		2664	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2665	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2666	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2667	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2668	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2669	}
		2670
		2671	$color &= cf::NDI_COLOR_MASK;
		2672
		2673	utf8::encode $msg;
		2674
		2675	if (0 && $msg =~ /\[/) {
		2676	# COMMAND/INFO
		2677	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2678	} else {
		2679	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2680	$self->send_packet ("drawinfo $color $msg")
		2681	}
		2682	}
		2683	}
		2684	}
		2685
2173	=item $client->ext_event ($type, %msg)	2686	=item $client->ext_msg ($type, @msg)
2174		2687
2175	Sends an exti event to the client.	2688	Sends an ext event to the client.
2176		2689
2177	=cut	2690	=cut
2178		2691
2179	sub cf::client::ext_event($$%) {	2692	sub cf::client::ext_msg($$@) {
2180	my ($self, $type, %msg) = @_;	2693	my ($self, $type, @msg) = @_;
2181		2694
		2695	if ($self->extcmd == 2) {
		2696	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2697	} elsif ($self->extcmd == 1) { # TODO: remove
2182	$msg{msgtype} = "event_$type";	2698	push @msg, msgtype => "event_$type";
2183	$self->send_packet ("ext " . cf::to_json \%msg);	2699	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2700	}
		2701	}
		2702
		2703	=item $client->ext_reply ($msgid, @msg)
		2704
		2705	Sends an ext reply to the client.
		2706
		2707	=cut
		2708
		2709	sub cf::client::ext_reply($$@) {
		2710	my ($self, $id, @msg) = @_;
		2711
		2712	if ($self->extcmd == 2) {
		2713	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2714	} elsif ($self->extcmd == 1) {
		2715	#TODO: version 1, remove
		2716	unshift @msg, msgtype => "reply", msgid => $id;
		2717	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2718	}
2184	}	2719	}
2185		2720
2186	=item $success = $client->query ($flags, "text", \&cb)	2721	=item $success = $client->query ($flags, "text", \&cb)
2187		2722
2188	Queues a query to the client, calling the given callback with	2723	Queues a query to the client, calling the given callback with
2189	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2724	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2190	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2725	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2191		2726
2192	Queries can fail, so check the return code. Or don't, as queries will become	2727	Queries can fail, so check the return code. Or don't, as queries will
2193	reliable at some point in the future.	2728	become reliable at some point in the future.
2194		2729
2195	=cut	2730	=cut
2196		2731
2197	sub cf::client::query {	2732	sub cf::client::query {
2198	my ($self, $flags, $text, $cb) = @_;	2733	my ($self, $flags, $text, $cb) = @_;
…		…
2206	utf8::encode $text;	2741	utf8::encode $text;
2207	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2742	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2208		2743
2209	$self->send_packet ($self->{query_queue}[0][0])	2744	$self->send_packet ($self->{query_queue}[0][0])
2210	if @{ $self->{query_queue} } == 1;	2745	if @{ $self->{query_queue} } == 1;
		2746
		2747	1
2211	}	2748	}
2212		2749
2213	cf::client->attach (	2750	cf::client->attach (
		2751	on_connect => sub {
		2752	my ($ns) = @_;
		2753
		2754	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2755	},
2214	on_reply => sub {	2756	on_reply => sub {
2215	my ($ns, $msg) = @_;	2757	my ($ns, $msg) = @_;
2216		2758
2217	# this weird shuffling is so that direct followup queries	2759	# this weird shuffling is so that direct followup queries
2218	# get handled first	2760	# get handled first
…		…
2230	} else {	2772	} else {
2231	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2773	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2232	}	2774	}
2233	}	2775	}
2234	},	2776	},
		2777	on_exticmd => sub {
		2778	my ($ns, $buf) = @_;
		2779
		2780	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2781
		2782	if (ref $msg) {
		2783	my ($type, $reply, @payload) =
		2784	"ARRAY" eq ref $msg
		2785	? @$msg
		2786	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2787
		2788	my @reply;
		2789
		2790	if (my $cb = $EXTICMD{$type}) {
		2791	@reply = $cb->($ns, @payload);
		2792	}
		2793
		2794	$ns->ext_reply ($reply, @reply)
		2795	if $reply;
		2796
		2797	} else {
		2798	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2799	}
		2800
		2801	cf::override;
		2802	},
2235	);	2803	);
2236		2804
2237	=item $client->async (\&cb)	2805	=item $client->async (\&cb)
2238		2806
2239	Create a new coroutine, running the specified callback. The coroutine will	2807	Create a new coroutine, running the specified callback. The coroutine will
…		…
2280	our $safe = new Safe "safe";	2848	our $safe = new Safe "safe";
2281	our $safe_hole = new Safe::Hole;	2849	our $safe_hole = new Safe::Hole;
2282		2850
2283	$SIG{FPE} = 'IGNORE';	2851	$SIG{FPE} = 'IGNORE';
2284		2852
2285	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2853	$safe->permit_only (Opcode::opset qw(
		2854	:base_core :base_mem :base_orig :base_math
		2855	grepstart grepwhile mapstart mapwhile
		2856	sort time
		2857	));
2286		2858
2287	# here we export the classes and methods available to script code	2859	# here we export the classes and methods available to script code
2288		2860
2289	=pod	2861	=pod
2290		2862
2291	The following functions and methods are available within a safe environment:	2863	The following functions and methods are available within a safe environment:
2292		2864
2293	cf::object contr pay_amount pay_player map	2865	cf::object
		2866	contr pay_amount pay_player map x y force_find force_add
		2867	insert remove name archname title slaying race decrease_ob_nr
		2868
2294	cf::object::player player	2869	cf::object::player
2295	cf::player peaceful	2870	player
2296	cf::map trigger	2871
		2872	cf::player
		2873	peaceful
		2874
		2875	cf::map
		2876	trigger
2297		2877
2298	=cut	2878	=cut
2299		2879
2300	for (	2880	for (
2301	["cf::object" => qw(contr pay_amount pay_player map)],	2881	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2882	insert remove inv name archname title slaying race
		2883	decrease_ob_nr)],
2302	["cf::object::player" => qw(player)],	2884	["cf::object::player" => qw(player)],
2303	["cf::player" => qw(peaceful)],	2885	["cf::player" => qw(peaceful)],
2304	["cf::map" => qw(trigger)],	2886	["cf::map" => qw(trigger)],
2305	) {	2887	) {
2306	no strict 'refs';	2888	no strict 'refs';
…		…
2377	=back	2959	=back
2378		2960
2379	=cut	2961	=cut
2380		2962
2381	#############################################################################	2963	#############################################################################
2382
2383	=head2 EXTENSION DATABASE SUPPORT
2384
2385	Crossfire maintains a very simple database for extension use. It can
2386	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2387	convert to/from binary).
2388
2389	The parameter C<$family> should best start with the name of the extension
2390	using it, it should be unique.
2391
2392	=over 4
2393
2394	=item $value = cf::db_get $family => $key
2395
2396	Returns a single value from the database.
2397
2398	=item cf::db_put $family => $key => $value
2399
2400	Stores the given C<$value> in the family.
2401
2402	=cut
2403
2404	our $DB;
2405
2406	sub db_init {
2407	unless ($DB) {
2408	$DB = BDB::db_create $DB_ENV;
2409
2410	cf::sync_job {
2411	eval {
2412	$DB->set_flags (BDB::CHKSUM);
2413
2414	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2415	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2416	cf::cleanup "db_open(db): $!" if $!;
2417	};
2418	cf::cleanup "db_open(db): $@" if $@;
2419	};
2420	}
2421	}
2422
2423	sub db_get($$) {
2424	my $key = "$_[0]/$_[1]";
2425
2426	cf::sync_job {
2427	BDB::db_get $DB, undef, $key, my $data;
2428
2429	$! ? ()
2430	: $data
2431	}
2432	}
2433
2434	sub db_put($$$) {
2435	BDB::dbreq_pri 4;
2436	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2437	}
2438
2439	=item cf::cache $id => [$paths...], $processversion => $process
2440
2441	Generic caching function that returns the value of the resource $id,
2442	caching and regenerating as required.
2443
2444	This function can block.
2445
2446	=cut
2447
2448	sub cache {
2449	my ($id, $src, $processversion, $process) = @_;
2450
2451	my $meta =
2452	join "\x00",
2453	$processversion,
2454	map {
2455	aio_stat $_
2456	and Carp::croak "$_: $!";
2457
2458	($_, (stat _)[7,9])
2459	} @$src;
2460
2461	my $dbmeta = db_get cache => "$id/meta";
2462	if ($dbmeta ne $meta) {
2463	# changed, we may need to process
2464
2465	my @data;
2466	my $md5;
2467
2468	for (0 .. $#$src) {
2469	0 <= aio_load $src->[$_], $data[$_]
2470	or Carp::croak "$src->[$_]: $!";
2471	}
2472
2473	# if processing is expensive, check
2474	# checksum first
2475	if (1) {
2476	$md5 =
2477	join "\x00",
2478	$processversion,
2479	map {
2480	Coro::cede;
2481	($src->[$_], Digest::MD5::md5_hex $data[$_])
2482	} 0.. $#$src;
2483
2484
2485	my $dbmd5 = db_get cache => "$id/md5";
2486	if ($dbmd5 eq $md5) {
2487	db_put cache => "$id/meta", $meta;
2488
2489	return db_get cache => "$id/data";
2490	}
2491	}
2492
2493	my $t1 = Time::HiRes::time;
2494	my $data = $process->(\@data);
2495	my $t2 = Time::HiRes::time;
2496
2497	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2498
2499	db_put cache => "$id/data", $data;
2500	db_put cache => "$id/md5" , $md5;
2501	db_put cache => "$id/meta", $meta;
2502
2503	return $data;
2504	}
2505
2506	db_get cache => "$id/data"
2507	}
2508
2509	=item fork_call { }, $args
2510
2511	Executes the given code block with the given arguments in a seperate
2512	process, returning the results. Everything must be serialisable with
2513	Coro::Storable. May, of course, block. Note that the executed sub may
2514	never block itself or use any form of Event handling.
2515
2516	=cut
2517
2518	sub fork_call(&@) {
2519	my ($cb, @args) = @_;
2520
2521	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2522	# or die "socketpair: $!";
2523	pipe my $fh1, my $fh2
2524	or die "pipe: $!";
2525
2526	if (my $pid = fork) {
2527	close $fh2;
2528
2529	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2530	$res = Coro::Storable::thaw $res;
2531
2532	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2533
2534	die $$res unless "ARRAY" eq ref $res;
2535
2536	return wantarray ? @$res : $res->[-1];
2537	} else {
2538	reset_signals;
2539	local $SIG{__WARN__};
2540	local $SIG{__DIE__};
2541	eval {
2542	close $fh1;
2543
2544	my @res = eval { $cb->(@args) };
2545	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2546	};
2547
2548	warn $@ if $@;
2549	_exit 0;
2550	}
2551	}
2552
2553	#############################################################################
2554	# the server's init and main functions	2964	# the server's init and main functions
2555		2965
2556	sub load_facedata($) {	2966	sub load_facedata($) {
2557	my ($path) = @_;	2967	my ($path) = @_;
		2968
		2969	# HACK to clear player env face cache, we need some signal framework
		2970	# for this (global event?)
		2971	%ext::player_env::MUSIC_FACE_CACHE = ();
		2972
		2973	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2558		2974
2559	warn "loading facedata from $path\n";	2975	warn "loading facedata from $path\n";
2560		2976
2561	my $facedata;	2977	my $facedata;
2562	0 < aio_load $path, $facedata	2978	0 < aio_load $path, $facedata
…		…
2565	$facedata = Coro::Storable::thaw $facedata;	2981	$facedata = Coro::Storable::thaw $facedata;
2566		2982
2567	$facedata->{version} == 2	2983	$facedata->{version} == 2
2568	or cf::cleanup "$path: version mismatch, cannot proceed.";	2984	or cf::cleanup "$path: version mismatch, cannot proceed.";
2569		2985
		2986	# patch in the exptable
		2987	$facedata->{resource}{"res/exp_table"} = {
		2988	type => FT_RSRC,
		2989	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
		2990	};
		2991	cf::cede_to_tick;
		2992
2570	{	2993	{
2571	my $faces = $facedata->{faceinfo};	2994	my $faces = $facedata->{faceinfo};
2572		2995
2573	while (my ($face, $info) = each %$faces) {	2996	while (my ($face, $info) = each %$faces) {
2574	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2997	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2575	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2998	cf::face::set_visibility $idx, $info->{visibility};
		2999	cf::face::set_magicmap $idx, $info->{magicmap};
2576	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	3000	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2577	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	3001	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2578	Coro::cede;	3002
		3003	cf::cede_to_tick;
2579	}	3004	}
2580		3005
2581	while (my ($face, $info) = each %$faces) {	3006	while (my ($face, $info) = each %$faces) {
2582	next unless $info->{smooth};	3007	next unless $info->{smooth};
2583	my $idx = cf::face::find $face	3008	my $idx = cf::face::find $face
2584	or next;	3009	or next;
2585	if (my $smooth = cf::face::find $info->{smooth}) {	3010	if (my $smooth = cf::face::find $info->{smooth}) {
		3011	cf::face::set_smooth $idx, $smooth;
2586	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	3012	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2587	} else {	3013	} else {
2588	warn "smooth face '$info->{smooth}' not found for face '$face'";	3014	warn "smooth face '$info->{smooth}' not found for face '$face'";
2589	}	3015	}
2590	Coro::cede;	3016
		3017	cf::cede_to_tick;
2591	}	3018	}
2592	}	3019	}
2593		3020
2594	{	3021	{
2595	my $anims = $facedata->{animinfo};	3022	my $anims = $facedata->{animinfo};
2596		3023
2597	while (my ($anim, $info) = each %$anims) {	3024	while (my ($anim, $info) = each %$anims) {
2598	cf::anim::set $anim, $info->{frames}, $info->{facings};	3025	cf::anim::set $anim, $info->{frames}, $info->{facings};
2599	Coro::cede;	3026	cf::cede_to_tick;
2600	}	3027	}
2601		3028
2602	cf::anim::invalidate_all; # d'oh	3029	cf::anim::invalidate_all; # d'oh
2603	}	3030	}
2604		3031
		3032	{
		3033	# TODO: for gcfclient pleasure, we should give resources
		3034	# that gcfclient doesn't grok a >10000 face index.
		3035	my $res = $facedata->{resource};
		3036
		3037	my $soundconf = delete $res->{"res/sound.conf"};
		3038
		3039	while (my ($name, $info) = each %$res) {
		3040	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3041	my $data;
		3042
		3043	if ($info->{type} & 1) {
		3044	# prepend meta info
		3045
		3046	my $meta = $enc->encode ({
		3047	name => $name,
		3048	%{ $info->{meta} || {} },
		3049	});
		3050
		3051	$data = pack "(w/a*)*", $meta, $info->{data};
		3052	} else {
		3053	$data = $info->{data};
		3054	}
		3055
		3056	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3057	cf::face::set_type $idx, $info->{type};
		3058
		3059	cf::cede_to_tick;
		3060	}
		3061
		3062	if ($soundconf) {
		3063	$soundconf = $enc->decode (delete $soundconf->{data});
		3064
		3065	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3066	my $sound = $soundconf->{compat}[$_]
		3067	or next;
		3068
		3069	my $face = cf::face::find "sound/$sound->[1]";
		3070	cf::sound::set $sound->[0] => $face;
		3071	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3072	}
		3073
		3074	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3075	my $face = cf::face::find "sound/$v";
		3076	cf::sound::set $k => $face;
		3077	}
		3078	}
		3079	}
		3080
2605	1	3081	1
2606	}	3082	}
2607		3083
		3084	register_exticmd fx_want => sub {
		3085	my ($ns, $want) = @_;
		3086
		3087	while (my ($k, $v) = each %$want) {
		3088	$ns->fx_want ($k, $v);
		3089	}
		3090	};
		3091
2608	sub reload_regions {	3092	sub reload_regions {
		3093	# HACK to clear player env face cache, we need some signal framework
		3094	# for this (global event?)
		3095	%ext::player_env::MUSIC_FACE_CACHE = ();
		3096
2609	load_resource_file "$MAPDIR/regions"	3097	load_resource_file "$MAPDIR/regions"
2610	or die "unable to load regions file\n";	3098	or die "unable to load regions file\n";
		3099
		3100	for (cf::region::list) {
		3101	$_->{match} = qr/$_->{match}/
		3102	if exists $_->{match};
		3103	}
2611	}	3104	}
2612		3105
2613	sub reload_facedata {	3106	sub reload_facedata {
2614	load_facedata "$DATADIR/facedata"	3107	load_facedata "$DATADIR/facedata"
2615	or die "unable to load facedata\n";	3108	or die "unable to load facedata\n";
2616	}	3109	}
2617		3110
2618	sub reload_archetypes {	3111	sub reload_archetypes {
		3112	load_resource_file "$DATADIR/archetypes"
		3113	or die "unable to load archetypes\n";
		3114	#d# NEED to laod twice to resolve forward references
		3115	# this really needs to be done in an extra post-pass
		3116	# (which needs to be synchronous, so solve it differently)
2619	load_resource_file "$DATADIR/archetypes"	3117	load_resource_file "$DATADIR/archetypes"
2620	or die "unable to load archetypes\n";	3118	or die "unable to load archetypes\n";
2621	}	3119	}
2622		3120
2623	sub reload_treasures {	3121	sub reload_treasures {
…		…
2639		3137
2640	sub init {	3138	sub init {
2641	reload_resources;	3139	reload_resources;
2642	}	3140	}
2643		3141
2644	sub cfg_load {	3142	sub reload_config {
2645	open my $fh, "<:utf8", "$CONFDIR/config"	3143	open my $fh, "<:utf8", "$CONFDIR/config"
2646	or return;	3144	or return;
2647		3145
2648	local $/;	3146	local $/;
2649	*CFG = YAML::Syck::Load <$fh>;	3147	*CFG = YAML::Syck::Load <$fh>;
…		…
2669	(async {	3167	(async {
2670	Event::one_event;	3168	Event::one_event;
2671	})->prio (Coro::PRIO_MAX);	3169	})->prio (Coro::PRIO_MAX);
2672	};	3170	};
2673		3171
2674	cfg_load;	3172	reload_config;
2675	db_init;	3173	db_init;
2676	load_extensions;	3174	load_extensions;
2677		3175
2678	$TICK_WATCHER->start;	3176	$TICK_WATCHER->start;
2679	Event::loop;	3177	Event::loop;
…		…
2695	},	3193	},
2696	);	3194	);
2697	}	3195	}
2698	}	3196	}
2699		3197
		3198	sub write_runtime {
		3199	my $runtime = "$LOCALDIR/runtime";
		3200
		3201	# first touch the runtime file to show we are still running:
		3202	# the fsync below can take a very very long time.
		3203
		3204	IO::AIO::aio_utime $runtime, undef, undef;
		3205
		3206	my $guard = cf::lock_acquire "write_runtime";
		3207
		3208	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3209	or return;
		3210
		3211	my $value = $cf::RUNTIME + 90 + 10;
		3212	# 10 is the runtime save interval, for a monotonic clock
		3213	# 60 allows for the watchdog to kill the server.
		3214
		3215	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3216	and return;
		3217
		3218	# always fsync - this file is important
		3219	aio_fsync $fh
		3220	and return;
		3221
		3222	# touch it again to show we are up-to-date
		3223	aio_utime $fh, undef, undef;
		3224
		3225	close $fh
		3226	or return;
		3227
		3228	aio_rename "$runtime~", $runtime
		3229	and return;
		3230
		3231	warn "runtime file written.\n";
		3232
		3233	1
		3234	}
		3235
2700	sub emergency_save() {	3236	sub emergency_save() {
2701	my $freeze_guard = cf::freeze_mainloop;	3237	my $freeze_guard = cf::freeze_mainloop;
2702		3238
2703	warn "enter emergency perl save\n";	3239	warn "enter emergency perl save\n";
2704		3240
…		…
2779	%EXT_CORO = ();	3315	%EXT_CORO = ();
2780		3316
2781	warn "removing commands";	3317	warn "removing commands";
2782	%COMMAND = ();	3318	%COMMAND = ();
2783		3319
2784	warn "removing ext commands";	3320	warn "removing ext/exti commands";
2785	%EXTCMD = ();	3321	%EXTCMD = ();
		3322	%EXTICMD = ();
2786		3323
2787	warn "unloading/nuking all extensions";	3324	warn "unloading/nuking all extensions";
2788	for my $pkg (@EXTS) {	3325	for my $pkg (@EXTS) {
2789	warn "... unloading $pkg";	3326	warn "... unloading $pkg";
2790		3327
…		…
2833	warn "reloading cf.pm";	3370	warn "reloading cf.pm";
2834	require cf;	3371	require cf;
2835	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3372	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2836		3373
2837	warn "loading config and database again";	3374	warn "loading config and database again";
2838	cf::cfg_load;	3375	cf::reload_config;
2839		3376
2840	warn "loading extensions";	3377	warn "loading extensions";
2841	cf::load_extensions;	3378	cf::load_extensions;
2842		3379
2843	warn "reattaching attachments to objects/players";	3380	warn "reattaching attachments to objects/players";
…		…
2908	my $signal = new Coro::Signal;	3445	my $signal = new Coro::Signal;
2909	push @WAIT_FOR_TICK_BEGIN, $signal;	3446	push @WAIT_FOR_TICK_BEGIN, $signal;
2910	$signal->wait;	3447	$signal->wait;
2911	}	3448	}
2912		3449
2913	my $min = 1e6;#d#	3450	our $stat_fh;
2914	my $avg = 10;	3451	sysopen $stat_fh, "/tmp/cfstats", Fcntl::O_APPEND | Fcntl::O_CREAT | Fcntl::O_WRONLY, 0600;#d#
		3452
2915	$TICK_WATCHER = Event->timer (	3453	$TICK_WATCHER = Event->timer (
2916	reentrant => 0,	3454	reentrant => 0,
2917	parked => 1,	3455	parked => 1,
2918	prio => 0,	3456	prio => 0,
2919	at => $NEXT_TICK || $TICK,	3457	at => $NEXT_TICK || $TICK,
…		…
2923	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3461	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2924	unless ++$bug_warning > 10;	3462	unless ++$bug_warning > 10;
2925	return;	3463	return;
2926	}	3464	}
2927		3465
		3466	my @pl = cf::player::list; my $stats = sprintf "%.2f %d %d %d", $RUNTIME, (scalar @pl), cf::object::actives_size, cf::object::objects_size; #d#
		3467
2928	$NOW = $tick_start = Event::time;	3468	$NOW = $tick_start = Event::time;
2929		3469
2930	cf::server_tick; # one server iteration	3470	cf::server_tick; # one server iteration
2931
2932	0 && sync_job {#d#
2933	for(1..10) {
2934	my $t = Event::time;
2935	my $map = my $map = new_from_path cf::map "/tmp/x.map"
2936	or die;
2937
2938	$map->width (50);
2939	$map->height (50);
2940	$map->alloc;
2941	$map->_load_objects ("/tmp/x.map", 1);
2942	my $t = Event::time - $t;
2943
2944	#next unless $t < 0.0013;#d#
2945	if ($t < $min) {
2946	$min = $t;
2947	}
2948	$avg = $avg * 0.99 + $t * 0.01;
2949	}
2950	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
2951	exit 0;
2952	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
2953	};
2954		3471
2955	$RUNTIME += $TICK;	3472	$RUNTIME += $TICK;
2956	$NEXT_TICK += $TICK;	3473	$NEXT_TICK += $TICK;
2957		3474
2958	if ($NOW >= $NEXT_RUNTIME_WRITE) {	3475	if ($NOW >= $NEXT_RUNTIME_WRITE) {
…		…
2984	$LOAD = ($NOW - $tick_start) / $TICK;	3501	$LOAD = ($NOW - $tick_start) / $TICK;
2985	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;	3502	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2986		3503
2987	_post_tick;	3504	_post_tick;
2988		3505
2989		3506	# gather some statistics#d#
		3507	$stats .= sprintf " %d\n", 10000 * ($NOW - $tick_start);#d#
		3508	IO::AIO::aio_write $stat_fh, undef, undef, $stats, 0;#d#
2990	},	3509	},
2991	);	3510	);
2992		3511
2993	{	3512	{
		3513	BDB::min_parallel 8;
2994	BDB::max_poll_time $TICK * 0.1;	3514	BDB::max_poll_time $TICK * 0.1;
2995	$BDB_POLL_WATCHER = Event->io (	3515	$BDB_POLL_WATCHER = Event->io (
2996	reentrant => 0,	3516	reentrant => 0,
2997	fd => BDB::poll_fileno,	3517	fd => BDB::poll_fileno,
2998	poll => 'r',	3518	poll => 'r',
2999	prio => 0,	3519	prio => 0,
3000	data => WF_AUTOCANCEL,	3520	data => WF_AUTOCANCEL,
3001	cb => \&BDB::poll_cb,	3521	cb => \&BDB::poll_cb,
3002	);	3522	);
3003	BDB::min_parallel 8;
3004		3523
3005	BDB::set_sync_prepare {	3524	BDB::set_sync_prepare {
3006	my $status;	3525	my $status;
3007	my $current = $Coro::current;	3526	my $current = $Coro::current;
3008	(	3527	(
…		…
3029	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3548	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3030	0666;	3549	0666;
3031		3550
3032	cf::cleanup "db_env_open($BDBDIR): $!" if $!;	3551	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3033		3552
3034	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);	3553	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
		3554	| BDB::LOG_AUTOREMOVE, 1);
3035	$DB_ENV->set_lk_detect;	3555	$DB_ENV->set_lk_detect;
3036	};	3556	};
3037		3557
3038	cf::cleanup "db_env_open(db): $@" if $@;	3558	cf::cleanup "db_env_open(db): $@" if $@;
3039	};	3559	};
3040	}	3560	}
		3561
		3562	$BDB_CHECKPOINT_WATCHER = Event->timer (
		3563	after => 11,
		3564	interval => 60,
		3565	hard => 1,
		3566	prio => 0,
		3567	data => WF_AUTOCANCEL,
		3568	cb => sub {
		3569	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3570	},
		3571	);
		3572	$BDB_TRICKLE_WATCHER = Event->timer (
		3573	after => 5,
		3574	interval => 10,
		3575	hard => 1,
		3576	prio => 0,
		3577	data => WF_AUTOCANCEL,
		3578	cb => sub {
		3579	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3580	},
		3581	);
3041	}	3582	}
3042		3583
3043	{	3584	{
3044	IO::AIO::min_parallel 8;	3585	IO::AIO::min_parallel 8;
3045		3586

Diff Legend

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