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.270 by root, Sat May 26 15:44:06 2007 UTC vs.
Revision 1.356 by root, Tue Sep 4 05:43:21 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;
…		…
83	our %CFG;	87	our %CFG;
84		88
85	our $UPTIME; $UPTIME ||= time;	89	our $UPTIME; $UPTIME ||= time;
86	our $RUNTIME;	90	our $RUNTIME;
87		91
88	our %PLAYER; # all users	92	our (%PLAYER, %PLAYER_LOADING); # all users
89	our %MAP; # all maps	93	our (%MAP, %MAP_LOADING ); # all maps
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
…		…
164		168
165	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
166	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
167	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.
168		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.
		178
169	=back	179	=back
170		180
171	=cut	181	=cut
172		182
173	BEGIN {	183	BEGIN {
…		…
187	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	197	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
188	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	198	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
189	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	199	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
190	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	200	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
191	@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';
192	@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)
193		204
194	# 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
195	# within the Safe compartment.	206	# within the Safe compartment.
196	for my $pkg (qw(	207	for my $pkg (qw(
197	cf::global cf::attachable	208	cf::global cf::attachable
…		…
205	}	216	}
206		217
207	$Event::DIED = sub {	218	$Event::DIED = sub {
208	warn "error in event callback: @_";	219	warn "error in event callback: @_";
209	};	220	};
		221
		222	#############################################################################
210		223
211	=head2 UTILITY FUNCTIONS	224	=head2 UTILITY FUNCTIONS
212		225
213	=over 4	226	=over 4
214		227
…		…
233	$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;
234	$d	247	$d
235	} || "[unable to dump $_[0]: '$@']";	248	} || "[unable to dump $_[0]: '$@']";
236	}	249	}
237		250
238	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
239
240	=item $ref = cf::from_json $json	251	=item $ref = cf::from_json $json
241		252
242	Converts a JSON string into the corresponding perl data structure.	253	Converts a JSON string into the corresponding perl data structure.
243		254
244	=item $json = cf::to_json $ref	255	=item $json = cf::to_json $ref
245		256
246	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]) }
247		265
248	=item cf::lock_wait $string	266	=item cf::lock_wait $string
249		267
250	Wait until the given lock is available. See cf::lock_acquire.	268	Wait until the given lock is available. See cf::lock_acquire.
251		269
…		…
253		271
254	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
255	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,
256	for example when the coroutine gets canceled), the lock is automatically	274	for example when the coroutine gets canceled), the lock is automatically
257	returned.	275	returned.
		276
		277	Locks are *not* recursive, locking from the same coro twice results in a
		278	deadlocked coro.
258		279
259	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
260	uses map_find and cf::map::load uses map_load).	281	uses map_find and cf::map::load uses map_load).
261		282
262	=item $locked = cf::lock_active $string	283	=item $locked = cf::lock_active $string
…		…
305	};	326	};
306	$TICK_WATCHER->stop;	327	$TICK_WATCHER->stop;
307	$guard	328	$guard
308	}	329	}
309		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
310	=item cf::async { BLOCK }	387	=item cf::async { BLOCK }
311		388
312	Currently the same as Coro::async_pool, meaning you cannot use	389	Currently the same as Coro::async_pool, meaning you cannot use
313	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
314	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.
…		…
317		394
318	BEGIN { *async = \&Coro::async_pool }	395	BEGIN { *async = \&Coro::async_pool }
319		396
320	=item cf::sync_job { BLOCK }	397	=item cf::sync_job { BLOCK }
321		398
322	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)
323	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
324	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.
325		403
326	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
327	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
328	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
329	fast or be very important.	407	fast or be very important.
…		…
389	$EXT_CORO{$coro+0} = $coro;	467	$EXT_CORO{$coro+0} = $coro;
390		468
391	$coro	469	$coro
392	}	470	}
393		471
394	sub write_runtime {	472	=item fork_call { }, $args
395	my $runtime = "$LOCALDIR/runtime";
396		473
397	# first touch the runtime file to show we are still running:	474	Executes the given code block with the given arguments in a seperate
398	# the fsync below can take a very very long time.	475	process, returning the results. Everything must be serialisable with
		476	Coro::Storable. May, of course, block. Note that the executed sub may
		477	never block itself or use any form of Event handling.
399		478
400	if (my $fh = aio_open $runtime, O_WRONLY, 0) {	479	=cut
401	utime undef, undef, $fh;
402	}
403		480
404	my $guard = cf::lock_acquire "write_runtime";	481	sub fork_call(&@) {
		482	my ($cb, @args) = @_;
405		483
406	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	484	# we seemingly have to make a local copy of the whole thing,
407	or return;	485	# otherwise perl prematurely frees the stuff :/
		486	# TODO: investigate and fix (likely this will be rather laborious)
408		487
409	my $value = $cf::RUNTIME + 90 + 10;	488	my @res = Coro::Util::fork_eval {
410	# 10 is the runtime save interval, for a monotonic clock	489	reset_signals;
411	# 60 allows for the watchdog to kill the server.	490	&$cb
		491	}, @args;
412		492
413	(aio_write $fh, 0, (length $value), $value, 0) <= 0	493	wantarray ? @res : $res[-1]
414	and return;	494	}
415		495
416	# always fsync - this file is important	496	=item $value = cf::db_get $family => $key
417	aio_fsync $fh
418	and return;
419		497
420	# touch it again to show we are up-to-date	498	Returns a single value from the environment database.
421	utime undef, undef, $fh;
422		499
423	close $fh	500	=item cf::db_put $family => $key => $value
424	or return;
425		501
426	aio_rename "$runtime~", $runtime	502	Stores the given C<$value> in the family. It can currently store binary
427	and return;	503	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
428		504
429	warn "runtime file written.\n";#d#	505	=cut
430		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	};
431	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"
432	}	610	}
433		611
434	=item cf::datalog type => key => value, ...	612	=item cf::datalog type => key => value, ...
435		613
436	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.
…		…
454	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")
455	to it. All such attachable objects support the following methods.	633	to it. All such attachable objects support the following methods.
456		634
457	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>
458	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
459	crossfire+).	637	Crossfire TRT).
460		638
461	=over 4	639	=over 4
462		640
463	=item $attachable->attach ($attachment, key => $value...)	641	=item $attachable->attach ($attachment, key => $value...)
464		642
…		…
666	_attach $registry, $klass, @attach;	844	_attach $registry, $klass, @attach;
667	}	845	}
668		846
669	$obj->{$name} = \%arg;	847	$obj->{$name} = \%arg;
670	} else {	848	} else {
671	warn "object uses attachment '$name' that is not available, postponing.\n";	849	warn "object uses attachment '$name' which is not available, postponing.\n";
672	}	850	}
673		851
674	$obj->{_attachment}{$name} = undef;	852	$obj->{_attachment}{$name} = undef;
675	}	853	}
676		854
…		…
716	";	894	";
717	die if $@;	895	die if $@;
718	}	896	}
719		897
720	our $override;	898	our $override;
721	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?
722		900
723	sub override {	901	sub override {
724	$override = 1;	902	$override = 1;
725	@invoke_results = ();	903	@INVOKE_RESULTS = (@_);
726	}	904	}
727		905
728	sub do_invoke {	906	sub do_invoke {
729	my $event = shift;	907	my $event = shift;
730	my $callbacks = shift;	908	my $callbacks = shift;
731		909
732	@invoke_results = ();	910	@INVOKE_RESULTS = ();
733		911
734	local $override;	912	local $override;
735		913
736	for (@$callbacks) {	914	for (@$callbacks) {
737	eval { &{$_->[1]} };	915	eval { &{$_->[1]} };
…		…
754		932
755	Generate an object-specific event with the given arguments.	933	Generate an object-specific event with the given arguments.
756		934
757	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
758	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
759	results (if you must, access C<@cf::invoke_results> directly).	937	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
760		938
761	=back	939	=back
762		940
763	=cut	941	=cut
764		942
765	#############################################################################	943	#############################################################################
766	# 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	}
767		956
768	sub reattach {	957	sub reattach {
769	# basically do the same as instantiate, without calling instantiate	958	# basically do the same as instantiate, without calling instantiate
770	my ($obj) = @_;	959	my ($obj) = @_;
771		960
…		…
815	},	1004	},
816	);	1005	);
817		1006
818	sub object_freezer_save {	1007	sub object_freezer_save {
819	my ($filename, $rdata, $objs) = @_;	1008	my ($filename, $rdata, $objs) = @_;
		1009
		1010	my $guard = cf::lock_acquire "io";
820		1011
821	sync_job {	1012	sync_job {
822	if (length $$rdata) {	1013	if (length $$rdata) {
823	warn sprintf "saving %s (%d,%d)\n",	1014	warn sprintf "saving %s (%d,%d)\n",
824	$filename, length $$rdata, scalar @$objs;	1015	$filename, length $$rdata, scalar @$objs;
…		…
848	}	1039	}
849	} else {	1040	} else {
850	aio_unlink $filename;	1041	aio_unlink $filename;
851	aio_unlink "$filename.pst";	1042	aio_unlink "$filename.pst";
852	}	1043	}
853	}	1044	};
		1045
		1046	undef $guard;
854	}	1047	}
855		1048
856	sub object_freezer_as_string {	1049	sub object_freezer_as_string {
857	my ($rdata, $objs) = @_;	1050	my ($rdata, $objs) = @_;
858		1051
…		…
863		1056
864	sub object_thawer_load {	1057	sub object_thawer_load {
865	my ($filename) = @_;	1058	my ($filename) = @_;
866		1059
867	my ($data, $av);	1060	my ($data, $av);
		1061
		1062	my $guard = cf::lock_acquire "io";
868		1063
869	(aio_load $filename, $data) >= 0	1064	(aio_load $filename, $data) >= 0
870	or return;	1065	or return;
871		1066
872	unless (aio_stat "$filename.pst") {	1067	unless (aio_stat "$filename.pst") {
873	(aio_load "$filename.pst", $av) >= 0	1068	(aio_load "$filename.pst", $av) >= 0
874	or return;	1069	or return;
		1070
		1071	undef $guard;
875	$av = eval { (Storable::thaw $av)->{objs} };	1072	$av = eval { (Storable::thaw $av)->{objs} };
876	}	1073	}
877		1074
878	warn sprintf "loading %s (%d)\n",	1075	warn sprintf "loading %s (%d)\n",
879	$filename, length $data, scalar @{$av || []};#d#	1076	$filename, length $data, scalar @{$av || []};
		1077
880	return ($data, $av);	1078	($data, $av)
881	}	1079	}
		1080
		1081	=head2 COMMAND CALLBACKS
		1082
		1083	=over 4
		1084
		1085	=cut
882		1086
883	#############################################################################	1087	#############################################################################
884	# command handling &c	1088	# command handling &c
885		1089
886	=item cf::register_command $name => \&callback($ob,$args);	1090	=item cf::register_command $name => \&callback($ob,$args);
…		…
899	push @{ $COMMAND{$name} }, [$caller, $cb];	1103	push @{ $COMMAND{$name} }, [$caller, $cb];
900	}	1104	}
901		1105
902	=item cf::register_extcmd $name => \&callback($pl,$packet);	1106	=item cf::register_extcmd $name => \&callback($pl,$packet);
903		1107
904	Register a callbackf ro execution when the client sends an extcmd packet.	1108	Register a callback for execution when the client sends an (synchronous)
		1109	extcmd packet. Ext commands will be processed in the order they are
		1110	received by the server, like other user commands. The first argument is
		1111	the logged-in player. Ext commands can only be processed after a player
		1112	has logged in successfully.
905		1113
906	If the callback returns something, it is sent back as if reply was being	1114	If the callback returns something, it is sent back as if reply was being
907	called.	1115	called.
908		1116
		1117	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1118
		1119	Register a callback for execution when the client sends an (asynchronous)
		1120	exticmd packet. Exti commands are processed by the server as soon as they
		1121	are received, i.e. out of order w.r.t. other commands. The first argument
		1122	is a client socket. Exti commands can be received anytime, even before
		1123	log-in.
		1124
		1125	If the callback returns something, it is sent back as if reply was being
		1126	called.
		1127
909	=cut	1128	=cut
910		1129
911	sub register_extcmd {	1130	sub register_extcmd {
912	my ($name, $cb) = @_;	1131	my ($name, $cb) = @_;
913		1132
914	$EXTCMD{$name} = $cb;	1133	$EXTCMD{$name} = $cb;
		1134	}
		1135
		1136	sub register_exticmd {
		1137	my ($name, $cb) = @_;
		1138
		1139	$EXTICMD{$name} = $cb;
915	}	1140	}
916		1141
917	cf::player->attach (	1142	cf::player->attach (
918	on_command => sub {	1143	on_command => sub {
919	my ($pl, $name, $params) = @_;	1144	my ($pl, $name, $params) = @_;
…		…
928	cf::override;	1153	cf::override;
929	},	1154	},
930	on_extcmd => sub {	1155	on_extcmd => sub {
931	my ($pl, $buf) = @_;	1156	my ($pl, $buf) = @_;
932		1157
933	my $msg = eval { from_json $buf };	1158	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
934		1159
935	if (ref $msg) {	1160	if (ref $msg) {
		1161	my ($type, $reply, @payload) =
		1162	"ARRAY" eq ref $msg
		1163	? @$msg
		1164	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1165
		1166	my @reply;
		1167
936	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1168	if (my $cb = $EXTCMD{$type}) {
937	if (my %reply = $cb->($pl, $msg)) {	1169	@reply = $cb->($pl, @payload);
938	$pl->ext_reply ($msg->{msgid}, %reply);
939	}
940	}	1170	}
		1171
		1172	$pl->ext_reply ($reply, @reply)
		1173	if $reply;
		1174
941	} else {	1175	} else {
942	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1176	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
943	}	1177	}
944		1178
945	cf::override;	1179	cf::override;
946	},	1180	},
947	);	1181	);
948		1182
949	sub load_extension {
950	my ($path) = @_;
951
952	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
953	my $base = $1;
954	my $pkg = $1;
955	$pkg =~ s/[^[:word:]]/_/g;
956	$pkg = "ext::$pkg";
957
958	warn "... loading '$path' into '$pkg'\n";
959
960	open my $fh, "<:utf8", $path
961	or die "$path: $!";
962
963	my $source =
964	"package $pkg; use strict; use utf8;\n"
965	. "#line 1 \"$path\"\n{\n"
966	. (do { local $/; <$fh> })
967	. "\n};\n1";
968
969	unless (eval $source) {
970	my $msg = $@ ? "$path: $@\n"
971	: "extension disabled.\n";
972	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
973	warn $@;
974	warn "mandatory extension failed to load, exiting.\n";
975	exit 1;
976	}
977	die $@;
978	}
979
980	push @EXTS, $pkg;
981	}
982
983	sub load_extensions {	1183	sub load_extensions {
		1184	cf::sync_job {
		1185	my %todo;
		1186
984	for my $ext (<$LIBDIR/*.ext>) {	1187	for my $path (<$LIBDIR/*.ext>) {
985	next unless -r $ext;	1188	next unless -r $path;
986	eval {	1189
987	load_extension $ext;	1190	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1191	my $base = $1;
		1192	my $pkg = $1;
		1193	$pkg =~ s/[^[:word:]]/_/g;
		1194	$pkg = "ext::$pkg";
		1195
		1196	open my $fh, "<:utf8", $path
		1197	or die "$path: $!";
		1198
		1199	my $source = do { local $/; <$fh> };
		1200
		1201	my %ext = (
		1202	path => $path,
		1203	base => $base,
		1204	pkg => $pkg,
		1205	);
		1206
		1207	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1208	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1209
		1210	$ext{source} =
		1211	"package $pkg; use strict; use utf8;\n"
		1212	. "#line 1 \"$path\"\n{\n"
		1213	. $source
		1214	. "\n};\n1";
		1215
		1216	$todo{$base} = \%ext;
		1217	}
		1218
		1219	my %done;
		1220	while (%todo) {
		1221	my $progress;
		1222
		1223	while (my ($k, $v) = each %todo) {
		1224	for (split /,\s*/, $v->{meta}{depends}) {
		1225	goto skip
		1226	unless exists $done{$_};
		1227	}
		1228
		1229	warn "... loading '$k' into '$v->{pkg}'\n";
		1230
		1231	unless (eval $v->{source}) {
		1232	my $msg = $@ ? "$v->{path}: $@\n"
		1233	: "$v->{base}: extension inactive.\n";
		1234
		1235	if (exists $v->{meta}{mandatory}) {
		1236	warn $msg;
		1237	warn "mandatory extension failed to load, exiting.\n";
		1238	exit 1;
		1239	}
		1240
		1241	warn $msg;
		1242	}
		1243
		1244	$done{$k} = delete $todo{$k};
		1245	push @EXTS, $v->{pkg};
		1246	$progress = 1;
988	1	1247	}
989	} or warn "$ext not loaded: $@";	1248
		1249	skip:
		1250	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1251	unless $progress;
		1252	}
990	}	1253	};
991	}	1254	}
992		1255
993	#############################################################################	1256	#############################################################################
		1257
		1258	=back
994		1259
995	=head2 CORE EXTENSIONS	1260	=head2 CORE EXTENSIONS
996		1261
997	Functions and methods that extend core crossfire objects.	1262	Functions and methods that extend core crossfire objects.
998		1263
…		…
1048	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";	1313	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1049	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";	1314	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1050	aio_unlink +(playerdir $login) . "/$login.pl.pst";	1315	aio_unlink +(playerdir $login) . "/$login.pl.pst";
1051	aio_unlink +(playerdir $login) . "/$login.pl";	1316	aio_unlink +(playerdir $login) . "/$login.pl";
1052		1317
1053	my $pl = load_pl path $login	1318	my $f = new_from_file cf::object::thawer path $login
1054	or return;	1319	or return;
		1320
		1321	$f->next;
		1322	my $pl = cf::player::load_pl $f
		1323	or return;
		1324	local $cf::PLAYER_LOADING{$login} = $pl;
		1325	$f->resolve_delayed_derefs;
1055	$cf::PLAYER{$login} = $pl	1326	$cf::PLAYER{$login} = $pl
1056	}	1327	}
1057	}	1328	}
1058	}	1329	}
1059		1330
…		…
1069		1340
1070	aio_mkdir playerdir $pl, 0770;	1341	aio_mkdir playerdir $pl, 0770;
1071	$pl->{last_save} = $cf::RUNTIME;	1342	$pl->{last_save} = $cf::RUNTIME;
1072		1343
1073	$pl->save_pl ($path);	1344	$pl->save_pl ($path);
1074	Coro::cede;	1345	cf::cede_to_tick;
1075	}	1346	}
1076		1347
1077	sub new($) {	1348	sub new($) {
1078	my ($login) = @_;	1349	my ($login) = @_;
1079		1350
…		…
1083	$self->{deny_save} = 1;	1354	$self->{deny_save} = 1;
1084		1355
1085	$cf::PLAYER{$login} = $self;	1356	$cf::PLAYER{$login} = $self;
1086		1357
1087	$self	1358	$self
		1359	}
		1360
		1361	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1362
		1363	=cut
		1364
		1365	sub send_msg {
		1366	my $ns = shift->ns
		1367	or return;
		1368	$ns->send_msg (@_);
1088	}	1369	}
1089		1370
1090	=item $pl->quit_character	1371	=item $pl->quit_character
1091		1372
1092	Nukes the player without looking back. If logged in, the connection will	1373	Nukes the player without looking back. If logged in, the connection will
…		…
1147	or return [];	1428	or return [];
1148		1429
1149	my @logins;	1430	my @logins;
1150		1431
1151	for my $login (@$dirs) {	1432	for my $login (@$dirs) {
		1433	my $path = path $login;
		1434
		1435	# a .pst is a dead give-away for a valid player
		1436	unless (-e "$path.pst") {
1152	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1437	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1153	aio_read $fh, 0, 512, my $buf, 0 or next;	1438	aio_read $fh, 0, 512, my $buf, 0 or next;
1154	$buf !~ /^password -------------$/m or next; # official not-valid tag	1439	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1440	}
1155		1441
1156	utf8::decode $login;	1442	utf8::decode $login;
1157	push @logins, $login;	1443	push @logins, $login;
1158	}	1444	}
1159		1445
…		…
1186	}	1472	}
1187		1473
1188	\@paths	1474	\@paths
1189	}	1475	}
1190		1476
		1477	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1478
		1479	Expand crossfire pod fragments into protocol xml.
		1480
		1481	=cut
		1482
		1483	sub expand_cfpod {
		1484	((my $self), (local $_)) = @_;
		1485
		1486	# escape & and <
		1487	s/&/&amp;/g;
		1488	s/(?<![BIUGHT])</&lt;/g;
		1489
		1490	# this is buggy, it needs to properly take care of nested <'s
		1491
		1492	1 while
		1493	# replace B<>, I<>, U<> etc.
		1494	s/B<([^\>]*)>/<b>$1<\/b>/
		1495	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1496	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1497	|| s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
		1498	# replace G<male|female> tags
		1499	|| s{G<([^>|]*)\|([^>]*)>}{
		1500	$self->gender ? $2 : $1
		1501	}ge
		1502	# replace H<hint text>
		1503	|| s{H<([^\>]*)>}
		1504	{
		1505	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1506	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1507	"")
		1508	[$self->{hintmode}]
		1509	}ge;
		1510
		1511	# create single paragraphs (very hackish)
		1512	s/(?<=\S)\n(?=\w)/ /g;
		1513
		1514	# compress some whitespace
		1515	s/\s+\n/\n/g; # ws line-ends
		1516	s/\n\n+/\n/g; # double lines
		1517	s/^\n+//; # beginning lines
		1518	s/\n+$//; # ending lines
		1519
		1520	$_
		1521	}
		1522
		1523	sub hintmode {
		1524	$_[0]{hintmode} = $_[1] if @_ > 1;
		1525	$_[0]{hintmode}
		1526	}
		1527
1191	=item $player->ext_reply ($msgid, %msg)	1528	=item $player->ext_reply ($msgid, @msg)
1192		1529
1193	Sends an ext reply to the player.	1530	Sends an ext reply to the player.
1194		1531
1195	=cut	1532	=cut
1196		1533
1197	sub ext_reply($$%) {	1534	sub ext_reply($$@) {
1198	my ($self, $id, %msg) = @_;	1535	my ($self, $id, @msg) = @_;
1199		1536
1200	$msg{msgid} = $id;	1537	$self->ns->ext_reply ($id, @msg)
1201
1202	$self->send ("ext " . cf::to_json \%msg);
1203	}	1538	}
1204		1539
1205	=item $player->ext_event ($type, %msg)	1540	=item $player->ext_msg ($type, @msg)
1206		1541
1207	Sends an ext event to the client.	1542	Sends an ext event to the client.
1208		1543
1209	=cut	1544	=cut
1210		1545
1211	sub ext_event($$%) {	1546	sub ext_msg($$@) {
1212	my ($self, $type, %msg) = @_;	1547	my ($self, $type, @msg) = @_;
1213		1548
1214	$self->ns->ext_event ($type, %msg);	1549	$self->ns->ext_msg ($type, @msg);
1215	}	1550	}
1216		1551
1217	=head3 cf::region	1552	=head3 cf::region
1218		1553
1219	=over 4	1554	=over 4
…		…
1222		1557
1223	package cf::region;	1558	package cf::region;
1224		1559
1225	=item cf::region::find_by_path $path	1560	=item cf::region::find_by_path $path
1226		1561
1227	Tries to decuce the probable region for a map knowing only its path.	1562	Tries to decuce the likely region for a map knowing only its path.
1228		1563
1229	=cut	1564	=cut
1230		1565
1231	sub find_by_path($) {	1566	sub find_by_path($) {
1232	my ($path) = @_;	1567	my ($path) = @_;
1233		1568
1234	my ($match, $specificity);	1569	my ($match, $specificity);
1235		1570
1236	for my $region (list) {	1571	for my $region (list) {
1237	if ($region->match && $path =~ $region->match) {	1572	if ($region->{match} && $path =~ $region->{match}) {
1238	($match, $specificity) = ($region, $region->specificity)	1573	($match, $specificity) = ($region, $region->specificity)
1239	if $region->specificity > $specificity;	1574	if $region->specificity > $specificity;
1240	}	1575	}
1241	}	1576	}
1242		1577
…		…
1306	my ($self, $merge) = @_;	1641	my ($self, $merge) = @_;
1307		1642
1308	# we have to keep some variables in memory intact	1643	# we have to keep some variables in memory intact
1309	local $self->{path};	1644	local $self->{path};
1310	local $self->{load_path};	1645	local $self->{load_path};
1311	local $self->{deny_save};
1312	local $self->{deny_reset};
1313		1646
1314	$self->SUPER::thawer_merge ($merge);	1647	$self->SUPER::thawer_merge ($merge);
1315	}	1648	}
1316		1649
1317	sub normalise {	1650	sub normalise {
…		…
1364	$self->init; # pass $1 etc.	1697	$self->init; # pass $1 etc.
1365	return $self;	1698	return $self;
1366	}	1699	}
1367	}	1700	}
1368		1701
1369	Carp::carp "unable to resolve path '$path' (base '$base').";	1702	Carp::cluck "unable to resolve path '$path' (base '$base').";
1370	()	1703	()
1371	}	1704	}
1372		1705
1373	sub init {	1706	sub init {
1374	my ($self) = @_;	1707	my ($self) = @_;
…		…
1417		1750
1418	$_->change_map_light ($change)	1751	$_->change_map_light ($change)
1419	for grep $_->outdoor, values %cf::MAP;	1752	for grep $_->outdoor, values %cf::MAP;
1420	}	1753	}
1421		1754
		1755	sub decay_objects {
		1756	my ($self) = @_;
		1757
		1758	return if $self->{deny_reset};
		1759
		1760	$self->do_decay_objects;
		1761	}
		1762
1422	sub unlink_save {	1763	sub unlink_save {
1423	my ($self) = @_;	1764	my ($self) = @_;
1424		1765
1425	utf8::encode (my $save = $self->save_path);	1766	utf8::encode (my $save = $self->save_path);
1426	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1767	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
…		…
1429		1770
1430	sub load_header_from($) {	1771	sub load_header_from($) {
1431	my ($self, $path) = @_;	1772	my ($self, $path) = @_;
1432		1773
1433	utf8::encode $path;	1774	utf8::encode $path;
1434	#aio_open $path, O_RDONLY, 0	1775	my $f = new_from_file cf::object::thawer $path
1435	# or return;
1436
1437	$self->_load_header ($path)
1438	or return;	1776	or return;
		1777
		1778	$self->_load_header ($f)
		1779	or return;
		1780
		1781	local $MAP_LOADING{$self->{path}} = $self;
		1782	$f->resolve_delayed_derefs;
1439		1783
1440	$self->{load_path} = $path;	1784	$self->{load_path} = $path;
1441		1785
1442	1	1786	1
1443	}	1787	}
…		…
1482	$self->load_header_orig	1826	$self->load_header_orig
1483	or return;	1827	or return;
1484	$self->prepare_orig;	1828	$self->prepare_orig;
1485	}	1829	}
1486		1830
		1831	$self->{deny_reset} = 1
		1832	if $self->no_reset;
		1833
1487	$self->default_region (cf::region::find_by_path $self->{path})	1834	$self->default_region (cf::region::find_by_path $self->{path})
1488	unless $self->default_region;	1835	unless $self->default_region;
1489		1836
1490	1	1837	1
1491	}	1838	}
…		…
1506	$map->{last_save} = $cf::RUNTIME;	1853	$map->{last_save} = $cf::RUNTIME;
1507		1854
1508	$map->load_header	1855	$map->load_header
1509	or return;	1856	or return;
1510		1857
1511	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1858	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1512	# doing this can freeze the server in a sync job, obviously	1859	# doing this can freeze the server in a sync job, obviously
1513	#$cf::WAIT_FOR_TICK->wait;	1860	#$cf::WAIT_FOR_TICK->wait;
1514	$map->reset;	1861	$map->reset;
1515	undef $guard;	1862	undef $guard;
1516	return find $path;	1863	return find $path;
…		…
1529	local $self->{deny_reset} = 1; # loading can take a long time	1876	local $self->{deny_reset} = 1; # loading can take a long time
1530		1877
1531	my $path = $self->{path};	1878	my $path = $self->{path};
1532		1879
1533	{	1880	{
		1881	my $guard1 = cf::lock_acquire "map_data:$path";
1534	my $guard = cf::lock_acquire "map_load:$path";	1882	my $guard2 = cf::lock_acquire "map_load:$path";
1535		1883
1536	return if $self->in_memory != cf::MAP_SWAPPED;	1884	return if $self->in_memory != cf::MAP_SWAPPED;
1537		1885
1538	$self->in_memory (cf::MAP_LOADING);	1886	$self->in_memory (cf::MAP_LOADING);
1539		1887
1540	$self->alloc;	1888	$self->alloc;
1541		1889
1542	$self->pre_load;	1890	$self->pre_load;
1543	Coro::cede;	1891	cf::cede_to_tick;
1544		1892
		1893	my $f = new_from_file cf::object::thawer $self->{load_path};
		1894	$f->skip_block;
1545	$self->_load_objects ($self->{load_path}, 1)	1895	$self->_load_objects ($f)
1546	or return;	1896	or return;
1547		1897
1548	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1898	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1549	if delete $self->{load_original};	1899	if delete $self->{load_original};
1550		1900
1551	if (my $uniq = $self->uniq_path) {	1901	if (my $uniq = $self->uniq_path) {
1552	utf8::encode $uniq;	1902	utf8::encode $uniq;
1553	if (aio_open $uniq, O_RDONLY, 0) {	1903	unless (aio_stat $uniq) {
		1904	if (my $f = new_from_file cf::object::thawer $uniq) {
1554	$self->clear_unique_items;	1905	$self->clear_unique_items;
1555	$self->_load_objects ($uniq, 0);	1906	$self->_load_objects ($f);
		1907	$f->resolve_delayed_derefs;
		1908	}
1556	}	1909	}
1557	}	1910	}
1558		1911
1559	Coro::cede;	1912	$f->resolve_delayed_derefs;
		1913
		1914	cf::cede_to_tick;
1560	# now do the right thing for maps	1915	# now do the right thing for maps
1561	$self->link_multipart_objects;	1916	$self->link_multipart_objects;
1562	$self->difficulty ($self->estimate_difficulty)	1917	$self->difficulty ($self->estimate_difficulty)
1563	unless $self->difficulty;	1918	unless $self->difficulty;
1564	Coro::cede;	1919	cf::cede_to_tick;
1565		1920
1566	unless ($self->{deny_activate}) {	1921	unless ($self->{deny_activate}) {
1567	$self->decay_objects;	1922	$self->decay_objects;
1568	$self->fix_auto_apply;	1923	$self->fix_auto_apply;
1569	$self->update_buttons;	1924	$self->update_buttons;
1570	Coro::cede;	1925	cf::cede_to_tick;
1571	$self->set_darkness_map;	1926	$self->set_darkness_map;
1572	Coro::cede;	1927	cf::cede_to_tick;
1573	$self->activate;	1928	$self->activate;
1574	}	1929	}
		1930
		1931	$self->{last_save} = $cf::RUNTIME;
		1932	$self->last_access ($cf::RUNTIME);
1575		1933
1576	$self->in_memory (cf::MAP_IN_MEMORY);	1934	$self->in_memory (cf::MAP_IN_MEMORY);
1577	}	1935	}
1578		1936
1579	$self->post_load;	1937	$self->post_load;
…		…
1583	my ($self, $ob) = @_;	1941	my ($self, $ob) = @_;
1584		1942
1585	return find "~" . $ob->name . "/" . $self->{path}	1943	return find "~" . $ob->name . "/" . $self->{path}
1586	if $self->per_player;	1944	if $self->per_player;
1587		1945
		1946	# return find "?party/" . $ob->name . "/" . $self->{path}
		1947	# if $self->per_party;
		1948
1588	$self	1949	$self
1589	}	1950	}
1590		1951
1591	# find and load all maps in the 3x3 area around a map	1952	# find and load all maps in the 3x3 area around a map
1592	sub load_diag {	1953	sub load_neighbours {
1593	my ($map) = @_;	1954	my ($map) = @_;
1594		1955
1595	my @diag; # diagonal neighbours	1956	my @neigh; # diagonal neighbours
1596		1957
1597	for (0 .. 3) {	1958	for (0 .. 3) {
1598	my $neigh = $map->tile_path ($_)	1959	my $neigh = $map->tile_path ($_)
1599	or next;	1960	or next;
1600	$neigh = find $neigh, $map	1961	$neigh = find $neigh, $map
1601	or next;	1962	or next;
1602	$neigh->load;	1963	$neigh->load;
1603		1964
		1965	push @neigh,
1604	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	1966	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1605	[$neigh->tile_path (($_ + 1) % 4), $neigh];	1967	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1606	}	1968	}
1607		1969
1608	for (@diag) {	1970	for (grep defined $_->[0], @neigh) {
		1971	my ($path, $origin) = @$_;
1609	my $neigh = find @$_	1972	my $neigh = find $path, $origin
1610	or next;	1973	or next;
1611	$neigh->load;	1974	$neigh->load;
1612	}	1975	}
1613	}	1976	}
1614		1977
…		…
1619	}	1982	}
1620		1983
1621	sub do_load_sync {	1984	sub do_load_sync {
1622	my ($map) = @_;	1985	my ($map) = @_;
1623		1986
		1987	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		1988	if $Coro::current == $Coro::main;
		1989
1624	cf::sync_job { $map->load };	1990	cf::sync_job { $map->load };
1625	}	1991	}
1626		1992
1627	our %MAP_PREFETCH;	1993	our %MAP_PREFETCH;
1628	our $MAP_PREFETCHER = undef;	1994	our $MAP_PREFETCHER = undef;
1629		1995
1630	sub find_async {	1996	sub find_async {
1631	my ($path, $origin) = @_;	1997	my ($path, $origin, $load) = @_;
1632		1998
1633	$path = normalise $path, $origin && $origin->{path};	1999	$path = normalise $path, $origin && $origin->{path};
1634		2000
1635	if (my $map = $cf::MAP{$path}) {	2001	if (my $map = $cf::MAP{$path}) {
1636	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2002	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1637	}	2003	}
1638		2004
1639	undef $MAP_PREFETCH{$path};	2005	$MAP_PREFETCH{$path} |= $load;
		2006
1640	$MAP_PREFETCHER ||= cf::async {	2007	$MAP_PREFETCHER ||= cf::async {
1641	while (%MAP_PREFETCH) {	2008	while (%MAP_PREFETCH) {
1642	for my $path (keys %MAP_PREFETCH) {	2009	while (my ($k, $v) = each %MAP_PREFETCH) {
1643	my $map = find $path	2010	if (my $map = find $k) {
1644	or next;
1645	$map->load;	2011	$map->load if $v;
		2012	}
1646		2013
1647	delete $MAP_PREFETCH{$path};	2014	delete $MAP_PREFETCH{$k};
1648	}	2015	}
1649	}	2016	}
1650	undef $MAP_PREFETCHER;	2017	undef $MAP_PREFETCHER;
1651	};	2018	};
1652	$MAP_PREFETCHER->prio (6);	2019	$MAP_PREFETCHER->prio (6);
…		…
1655	}	2022	}
1656		2023
1657	sub save {	2024	sub save {
1658	my ($self) = @_;	2025	my ($self) = @_;
1659		2026
1660	my $lock = cf::lock_acquire "map_data:" . $self->path;	2027	my $lock = cf::lock_acquire "map_data:$self->{path}";
1661		2028
1662	$self->{last_save} = $cf::RUNTIME;	2029	$self->{last_save} = $cf::RUNTIME;
1663		2030
1664	return unless $self->dirty;	2031	return unless $self->dirty;
1665		2032
…		…
1688	my ($self) = @_;	2055	my ($self) = @_;
1689		2056
1690	# save first because save cedes	2057	# save first because save cedes
1691	$self->save;	2058	$self->save;
1692		2059
1693	my $lock = cf::lock_acquire "map_data:" . $self->path;	2060	my $lock = cf::lock_acquire "map_data:$self->{path}";
1694		2061
1695	return if $self->players;	2062	return if $self->players;
1696	return if $self->in_memory != cf::MAP_IN_MEMORY;	2063	return if $self->in_memory != cf::MAP_IN_MEMORY;
1697	return if $self->{deny_save};	2064	return if $self->{deny_save};
1698		2065
…		…
1702		2069
1703	sub reset_at {	2070	sub reset_at {
1704	my ($self) = @_;	2071	my ($self) = @_;
1705		2072
1706	# TODO: safety, remove and allow resettable per-player maps	2073	# TODO: safety, remove and allow resettable per-player maps
1707	return 1e99 if $self->isa ("ext::map_per_player");#d#
1708	return 1e99 if $self->{deny_reset};	2074	return 1e99 if $self->{deny_reset};
1709		2075
1710	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2076	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1711	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2077	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1712		2078
…		…
1723	my ($self) = @_;	2089	my ($self) = @_;
1724		2090
1725	my $lock = cf::lock_acquire "map_data:$self->{path}";	2091	my $lock = cf::lock_acquire "map_data:$self->{path}";
1726		2092
1727	return if $self->players;	2093	return if $self->players;
1728	return if $self->isa ("ext::map_per_player");#d#
1729		2094
1730	warn "resetting map ", $self->path;#d#	2095	warn "resetting map ", $self->path;
1731		2096
1732	$self->in_memory (cf::MAP_SWAPPED);	2097	$self->in_memory (cf::MAP_SWAPPED);
1733		2098
1734	# need to save uniques path	2099	# need to save uniques path
1735	unless ($self->{deny_save}) {	2100	unless ($self->{deny_save}) {
…		…
1752	my $nuke_counter = "aaaa";	2117	my $nuke_counter = "aaaa";
1753		2118
1754	sub nuke {	2119	sub nuke {
1755	my ($self) = @_;	2120	my ($self) = @_;
1756		2121
		2122	{
		2123	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2124
1757	delete $cf::MAP{$self->path};	2125	delete $cf::MAP{$self->path};
1758		2126
1759	$self->unlink_save;	2127	$self->unlink_save;
1760		2128
1761	bless $self, "cf::map";	2129	bless $self, "cf::map";
1762	delete $self->{deny_reset};	2130	delete $self->{deny_reset};
1763	$self->{deny_save} = 1;	2131	$self->{deny_save} = 1;
1764	$self->reset_timeout (1);	2132	$self->reset_timeout (1);
1765	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2133	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1766		2134
1767	$cf::MAP{$self->path} = $self;	2135	$cf::MAP{$self->path} = $self;
		2136	}
1768		2137
1769	$self->reset; # polite request, might not happen	2138	$self->reset; # polite request, might not happen
		2139	}
		2140
		2141	=item $maps = cf::map::tmp_maps
		2142
		2143	Returns an arrayref with all map paths of currently instantiated and saved
		2144	maps. May block.
		2145
		2146	=cut
		2147
		2148	sub tmp_maps() {
		2149	[
		2150	map {
		2151	utf8::decode $_;
		2152	/\.map$/
		2153	? normalise $_
		2154	: ()
		2155	} @{ aio_readdir $TMPDIR or [] }
		2156	]
		2157	}
		2158
		2159	=item $maps = cf::map::random_maps
		2160
		2161	Returns an arrayref with all map paths of currently instantiated and saved
		2162	random maps. May block.
		2163
		2164	=cut
		2165
		2166	sub random_maps() {
		2167	[
		2168	map {
		2169	utf8::decode $_;
		2170	/\.map$/
		2171	? normalise "?random/$_"
		2172	: ()
		2173	} @{ aio_readdir $RANDOMDIR or [] }
		2174	]
1770	}	2175	}
1771		2176
1772	=item cf::map::unique_maps	2177	=item cf::map::unique_maps
1773		2178
1774	Returns an arrayref of paths of all shared maps that have	2179	Returns an arrayref of paths of all shared maps that have
1775	instantiated unique items. May block.	2180	instantiated unique items. May block.
1776		2181
1777	=cut	2182	=cut
1778		2183
1779	sub unique_maps() {	2184	sub unique_maps() {
1780	my $files = aio_readdir $UNIQUEDIR	2185	[
1781	or return;	2186	map {
1782
1783	my @paths;
1784
1785	for (@$files) {
1786	utf8::decode $_;	2187	utf8::decode $_;
1787	next if /\.pst$/;	2188	/\.map$/
1788	next unless /^$PATH_SEP/o;	2189	? normalise $_
1789		2190	: ()
1790	push @paths, cf::map::normalise $_;	2191	} @{ aio_readdir $UNIQUEDIR or [] }
1791	}	2192	]
1792
1793	\@paths
1794	}	2193	}
1795		2194
1796	package cf;	2195	package cf;
1797		2196
1798	=back	2197	=back
…		…
1816	map { $_, inv_recursive_ $_->inv } @_	2215	map { $_, inv_recursive_ $_->inv } @_
1817	}	2216	}
1818		2217
1819	sub inv_recursive {	2218	sub inv_recursive {
1820	inv_recursive_ inv $_[0]	2219	inv_recursive_ inv $_[0]
		2220	}
		2221
		2222	=item $ref = $ob->ref
		2223
		2224	creates and returns a persistent reference to an objetc that can be stored as a string.
		2225
		2226	=item $ob = cf::object::deref ($refstring)
		2227
		2228	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2229	even if the object actually exists. May block.
		2230
		2231	=cut
		2232
		2233	sub deref {
		2234	my ($ref) = @_;
		2235
		2236	# temporary compatibility#TODO#remove
		2237	$ref =~ s{^<}{player/<};
		2238
		2239	if ($ref =~ m{^player\/(<1\.\d+>)/(.*)$}) {
		2240	my ($uuid, $name) = ($1, $2);
		2241	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2242	or return;
		2243	$pl->ob->uuid eq $uuid
		2244	or return;
		2245
		2246	$pl->ob
		2247	} else {
		2248	warn "$ref: cannot resolve object reference\n";
		2249	undef
		2250	}
1821	}	2251	}
1822		2252
1823	package cf;	2253	package cf;
1824		2254
1825	=back	2255	=back
…		…
1844		2274
1845	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2275	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1846		2276
1847	if ($self->{record_replies}) {	2277	if ($self->{record_replies}) {
1848	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2278	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2279
1849	} else {	2280	} else {
		2281	my $pl = $self->contr;
		2282
		2283	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2284	my $dialog = $pl->{npc_dialog};
		2285	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2286
		2287	} else {
1850	$msg = $npc->name . " says: $msg" if $npc;	2288	$msg = $npc->name . " says: $msg" if $npc;
1851	$self->message ($msg, $flags);	2289	$self->message ($msg, $flags);
		2290	}
1852	}	2291	}
		2292	}
		2293
		2294	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2295
		2296	=cut
		2297
		2298	sub cf::object::send_msg {
		2299	my $pl = shift->contr
		2300	or return;
		2301	$pl->send_msg (@_);
1853	}	2302	}
1854		2303
1855	=item $player_object->may ("access")	2304	=item $player_object->may ("access")
1856		2305
1857	Returns wether the given player is authorized to access resource "access"	2306	Returns wether the given player is authorized to access resource "access"
…		…
1936	# use -1 or undef as default coordinates, not 0, 0	2385	# use -1 or undef as default coordinates, not 0, 0
1937	($x, $y) = ($map->enter_x, $map->enter_y)	2386	($x, $y) = ($map->enter_x, $map->enter_y)
1938	if $x <=0 && $y <= 0;	2387	if $x <=0 && $y <= 0;
1939		2388
1940	$map->load;	2389	$map->load;
1941	$map->load_diag;	2390	$map->load_neighbours;
1942		2391
1943	return unless $self->contr->active;	2392	return unless $self->contr->active;
1944	$self->activate_recursive;	2393	$self->activate_recursive;
1945		2394
1946	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2395	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1947	$self->enter_map ($map, $x, $y);	2396	$self->enter_map ($map, $x, $y);
1948	}	2397	}
1949		2398
1950	=item $player_object->goto ($path, $x, $y[, $check->($map)])	2399	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1951		2400
1952	Moves the player to the given map-path and coordinates by first freezing	2401	Moves the player to the given map-path and coordinates by first freezing
1953	her, loading and preparing them map, calling the provided $check callback	2402	her, loading and preparing them map, calling the provided $check callback
1954	that has to return the map if sucecssful, and then unfreezes the player on	2403	that has to return the map if sucecssful, and then unfreezes the player on
1955	the new (success) or old (failed) map position.	2404	the new (success) or old (failed) map position. In either case, $done will
		2405	be called at the end of this process.
1956		2406
1957	=cut	2407	=cut
1958		2408
1959	our $GOTOGEN;	2409	our $GOTOGEN;
1960		2410
1961	sub cf::object::player::goto {	2411	sub cf::object::player::goto {
1962	my ($self, $path, $x, $y, $check) = @_;	2412	my ($self, $path, $x, $y, $check, $done) = @_;
1963		2413
1964	# do generation counting so two concurrent goto's will be executed in-order	2414	# do generation counting so two concurrent goto's will be executed in-order
1965	my $gen = $self->{_goto_generation} = ++$GOTOGEN;	2415	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1966		2416
1967	$self->enter_link;	2417	$self->enter_link;
…		…
1987		2437
1988	if ($gen == $self->{_goto_generation}) {	2438	if ($gen == $self->{_goto_generation}) {
1989	delete $self->{_goto_generation};	2439	delete $self->{_goto_generation};
1990	$self->leave_link ($map, $x, $y);	2440	$self->leave_link ($map, $x, $y);
1991	}	2441	}
		2442
		2443	$done->() if $done;
1992	})->prio (1);	2444	})->prio (1);
1993	}	2445	}
1994		2446
1995	=item $player_object->enter_exit ($exit_object)	2447	=item $player_object->enter_exit ($exit_object)
1996		2448
…		…
2065	my $hp = $exit->stats->hp;	2517	my $hp = $exit->stats->hp;
2066	my $sp = $exit->stats->sp;	2518	my $sp = $exit->stats->sp;
2067		2519
2068	$self->enter_link;	2520	$self->enter_link;
2069		2521
		2522	# if exit is damned, update players death & WoR home-position
		2523	$self->contr->savebed ($slaying, $hp, $sp)
		2524	if $exit->flag (FLAG_DAMNED);
		2525
2070	(async {	2526	(async {
2071	$self->deactivate_recursive; # just to be sure	2527	$self->deactivate_recursive; # just to be sure
2072	unless (eval {	2528	unless (eval {
2073	$self->goto ($slaying, $hp, $sp);	2529	$self->goto ($slaying, $hp, $sp);
2074		2530
…		…
2101		2557
2102	utf8::encode $text;	2558	utf8::encode $text;
2103	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2559	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2104	}	2560	}
2105		2561
		2562	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2563
		2564	Send a drawinfo or msg packet to the client, formatting the msg for the
		2565	client if neccessary. C<$type> should be a string identifying the type of
		2566	the message, with C<log> being the default. If C<$color> is negative, suppress
		2567	the message unless the client supports the msg packet.
		2568
		2569	=cut
		2570
		2571	our %CHANNEL = (
		2572	"c/identify" => {
		2573	id => "identify",
		2574	title => "Identify",
		2575	reply => undef,
		2576	tooltip => "Items recently identified",
		2577	},
		2578	"c/examine" => {
		2579	id => "examine",
		2580	title => "Examine",
		2581	reply => undef,
		2582	tooltip => "Signs and other items you examined",
		2583	},
		2584	);
		2585
		2586	sub cf::client::send_msg {
		2587	my ($self, $channel, $msg, $color, @extra) = @_;
		2588
		2589	$msg = $self->pl->expand_cfpod ($msg);
		2590
		2591	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2592
		2593	# check predefined channels, for the benefit of C
		2594	$channel = $CHANNEL{$channel} if $CHANNEL{$channel};
		2595
		2596	if (ref $channel) {
		2597	# send meta info to client, if not yet sent
		2598	unless (exists $self->{channel}{$channel->{id}}) {
		2599	$self->{channel}{$channel->{id}} = $channel;
		2600	$self->ext_msg (channel_info => $channel)
		2601	if $self->can_msg;
		2602	}
		2603
		2604	$channel = $channel->{id};
		2605	}
		2606
		2607	return unless @extra || length $msg;
		2608
		2609	if ($self->can_msg) {
		2610	# default colour, mask it out
		2611	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2612	if $color & cf::NDI_DEF;
		2613
		2614	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2615	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2616	} else {
		2617	if ($color >= 0) {
		2618	# replace some tags by gcfclient-compatible ones
		2619	for ($msg) {
		2620	1 while
		2621	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2622	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2623	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2624	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2625	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2626	}
		2627
		2628	$color &= cf::NDI_COLOR_MASK;
		2629
		2630	utf8::encode $msg;
		2631
		2632	if (0 && $msg =~ /\[/) {
		2633	# COMMAND/INFO
		2634	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2635	} else {
		2636	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2637	$self->send_packet ("drawinfo $color $msg")
		2638	}
		2639	}
		2640	}
		2641	}
		2642
2106	=item $client->ext_event ($type, %msg)	2643	=item $client->ext_msg ($type, @msg)
2107		2644
2108	Sends an exti event to the client.	2645	Sends an ext event to the client.
2109		2646
2110	=cut	2647	=cut
2111		2648
2112	sub cf::client::ext_event($$%) {	2649	sub cf::client::ext_msg($$@) {
2113	my ($self, $type, %msg) = @_;	2650	my ($self, $type, @msg) = @_;
2114		2651
		2652	if ($self->extcmd == 2) {
		2653	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2654	} elsif ($self->extcmd == 1) { # TODO: remove
2115	$msg{msgtype} = "event_$type";	2655	push @msg, msgtype => "event_$type";
2116	$self->send_packet ("ext " . cf::to_json \%msg);	2656	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2657	}
		2658	}
		2659
		2660	=item $client->ext_reply ($msgid, @msg)
		2661
		2662	Sends an ext reply to the client.
		2663
		2664	=cut
		2665
		2666	sub cf::client::ext_reply($$@) {
		2667	my ($self, $id, @msg) = @_;
		2668
		2669	if ($self->extcmd == 2) {
		2670	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2671	} elsif ($self->extcmd == 1) {
		2672	#TODO: version 1, remove
		2673	unshift @msg, msgtype => "reply", msgid => $id;
		2674	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2675	}
2117	}	2676	}
2118		2677
2119	=item $success = $client->query ($flags, "text", \&cb)	2678	=item $success = $client->query ($flags, "text", \&cb)
2120		2679
2121	Queues a query to the client, calling the given callback with	2680	Queues a query to the client, calling the given callback with
2122	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2681	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2123	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2682	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2124		2683
2125	Queries can fail, so check the return code. Or don't, as queries will become	2684	Queries can fail, so check the return code. Or don't, as queries will
2126	reliable at some point in the future.	2685	become reliable at some point in the future.
2127		2686
2128	=cut	2687	=cut
2129		2688
2130	sub cf::client::query {	2689	sub cf::client::query {
2131	my ($self, $flags, $text, $cb) = @_;	2690	my ($self, $flags, $text, $cb) = @_;
…		…
2139	utf8::encode $text;	2698	utf8::encode $text;
2140	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2699	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2141		2700
2142	$self->send_packet ($self->{query_queue}[0][0])	2701	$self->send_packet ($self->{query_queue}[0][0])
2143	if @{ $self->{query_queue} } == 1;	2702	if @{ $self->{query_queue} } == 1;
		2703
		2704	1
2144	}	2705	}
2145		2706
2146	cf::client->attach (	2707	cf::client->attach (
		2708	on_connect => sub {
		2709	my ($ns) = @_;
		2710
		2711	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2712	},
2147	on_reply => sub {	2713	on_reply => sub {
2148	my ($ns, $msg) = @_;	2714	my ($ns, $msg) = @_;
2149		2715
2150	# this weird shuffling is so that direct followup queries	2716	# this weird shuffling is so that direct followup queries
2151	# get handled first	2717	# get handled first
…		…
2163	} else {	2729	} else {
2164	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2730	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2165	}	2731	}
2166	}	2732	}
2167	},	2733	},
		2734	on_exticmd => sub {
		2735	my ($ns, $buf) = @_;
		2736
		2737	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2738
		2739	if (ref $msg) {
		2740	my ($type, $reply, @payload) =
		2741	"ARRAY" eq ref $msg
		2742	? @$msg
		2743	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2744
		2745	my @reply;
		2746
		2747	if (my $cb = $EXTICMD{$type}) {
		2748	@reply = $cb->($ns, @payload);
		2749	}
		2750
		2751	$ns->ext_reply ($reply, @reply)
		2752	if $reply;
		2753
		2754	} else {
		2755	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2756	}
		2757
		2758	cf::override;
		2759	},
2168	);	2760	);
2169		2761
2170	=item $client->async (\&cb)	2762	=item $client->async (\&cb)
2171		2763
2172	Create a new coroutine, running the specified callback. The coroutine will	2764	Create a new coroutine, running the specified callback. The coroutine will
…		…
2213	our $safe = new Safe "safe";	2805	our $safe = new Safe "safe";
2214	our $safe_hole = new Safe::Hole;	2806	our $safe_hole = new Safe::Hole;
2215		2807
2216	$SIG{FPE} = 'IGNORE';	2808	$SIG{FPE} = 'IGNORE';
2217		2809
2218	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2810	$safe->permit_only (Opcode::opset qw(
		2811	:base_core :base_mem :base_orig :base_math
		2812	grepstart grepwhile mapstart mapwhile
		2813	sort time
		2814	));
2219		2815
2220	# here we export the classes and methods available to script code	2816	# here we export the classes and methods available to script code
2221		2817
2222	=pod	2818	=pod
2223		2819
2224	The following functions and methods are available within a safe environment:	2820	The following functions and methods are available within a safe environment:
2225		2821
2226	cf::object contr pay_amount pay_player map	2822	cf::object
		2823	contr pay_amount pay_player map x y force_find force_add
		2824	insert remove name archname title slaying race decrease_ob_nr
		2825
2227	cf::object::player player	2826	cf::object::player
2228	cf::player peaceful	2827	player
2229	cf::map trigger	2828
		2829	cf::player
		2830	peaceful
		2831
		2832	cf::map
		2833	trigger
2230		2834
2231	=cut	2835	=cut
2232		2836
2233	for (	2837	for (
2234	["cf::object" => qw(contr pay_amount pay_player map)],	2838	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2839	insert remove inv name archname title slaying race
		2840	decrease_ob_nr)],
2235	["cf::object::player" => qw(player)],	2841	["cf::object::player" => qw(player)],
2236	["cf::player" => qw(peaceful)],	2842	["cf::player" => qw(peaceful)],
2237	["cf::map" => qw(trigger)],	2843	["cf::map" => qw(trigger)],
2238	) {	2844	) {
2239	no strict 'refs';	2845	no strict 'refs';
…		…
2310	=back	2916	=back
2311		2917
2312	=cut	2918	=cut
2313		2919
2314	#############################################################################	2920	#############################################################################
2315
2316	=head2 EXTENSION DATABASE SUPPORT
2317
2318	Crossfire maintains a very simple database for extension use. It can
2319	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2320	convert to/from binary).
2321
2322	The parameter C<$family> should best start with the name of the extension
2323	using it, it should be unique.
2324
2325	=over 4
2326
2327	=item $value = cf::db_get $family => $key
2328
2329	Returns a single value from the database.
2330
2331	=item cf::db_put $family => $key => $value
2332
2333	Stores the given C<$value> in the family.
2334
2335	=cut
2336
2337	our $DB;
2338
2339	sub db_init {
2340	unless ($DB) {
2341	$DB = BDB::db_create $DB_ENV;
2342
2343	cf::sync_job {
2344	eval {
2345	$DB->set_flags (BDB::CHKSUM);
2346
2347	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2348	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2349	cf::cleanup "db_open(db): $!" if $!;
2350	};
2351	cf::cleanup "db_open(db): $@" if $@;
2352	};
2353	}
2354	}
2355
2356	sub db_get($$) {
2357	my $key = "$_[0]/$_[1]";
2358
2359	cf::sync_job {
2360	BDB::db_get $DB, undef, $key, my $data;
2361
2362	$! ? ()
2363	: $data
2364	}
2365	}
2366
2367	sub db_put($$$) {
2368	BDB::dbreq_pri 4;
2369	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2370	}
2371
2372	=item cf::cache $id => [$paths...], $processversion => $process
2373
2374	Generic caching function that returns the value of the resource $id,
2375	caching and regenerating as required.
2376
2377	This function can block.
2378
2379	=cut
2380
2381	sub cache {
2382	my ($id, $src, $processversion, $process) = @_;
2383
2384	my $meta =
2385	join "\x00",
2386	$processversion,
2387	map {
2388	aio_stat $_
2389	and Carp::croak "$_: $!";
2390
2391	($_, (stat _)[7,9])
2392	} @$src;
2393
2394	my $dbmeta = db_get cache => "$id/meta";
2395	if ($dbmeta ne $meta) {
2396	# changed, we may need to process
2397
2398	my @data;
2399	my $md5;
2400
2401	for (0 .. $#$src) {
2402	0 <= aio_load $src->[$_], $data[$_]
2403	or Carp::croak "$src->[$_]: $!";
2404	}
2405
2406	# if processing is expensive, check
2407	# checksum first
2408	if (1) {
2409	$md5 =
2410	join "\x00",
2411	$processversion,
2412	map {
2413	Coro::cede;
2414	($src->[$_], Digest::MD5::md5_hex $data[$_])
2415	} 0.. $#$src;
2416
2417
2418	my $dbmd5 = db_get cache => "$id/md5";
2419	if ($dbmd5 eq $md5) {
2420	db_put cache => "$id/meta", $meta;
2421
2422	return db_get cache => "$id/data";
2423	}
2424	}
2425
2426	my $t1 = Time::HiRes::time;
2427	my $data = $process->(\@data);
2428	my $t2 = Time::HiRes::time;
2429
2430	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2431
2432	db_put cache => "$id/data", $data;
2433	db_put cache => "$id/md5" , $md5;
2434	db_put cache => "$id/meta", $meta;
2435
2436	return $data;
2437	}
2438
2439	db_get cache => "$id/data"
2440	}
2441
2442	=item fork_call { }, $args
2443
2444	Executes the given code block with the given arguments in a seperate
2445	process, returning the results. Everything must be serialisable with
2446	Coro::Storable. May, of course, block. Note that the executed sub may
2447	never block itself or use any form of Event handling.
2448
2449	=cut
2450
2451	sub fork_call(&@) {
2452	my ($cb, @args) = @_;
2453
2454	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2455	# or die "socketpair: $!";
2456	pipe my $fh1, my $fh2
2457	or die "pipe: $!";
2458
2459	if (my $pid = fork) {
2460	close $fh2;
2461
2462	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2463	$res = Coro::Storable::thaw $res;
2464
2465	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2466
2467	die $$res unless "ARRAY" eq ref $res;
2468
2469	return wantarray ? @$res : $res->[-1];
2470	} else {
2471	reset_signals;
2472	local $SIG{__WARN__};
2473	local $SIG{__DIE__};
2474	eval {
2475	close $fh1;
2476
2477	my @res = eval { $cb->(@args) };
2478	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2479	};
2480
2481	warn $@ if $@;
2482	_exit 0;
2483	}
2484	}
2485
2486
2487
2488	#############################################################################
2489	# the server's init and main functions	2921	# the server's init and main functions
2490		2922
2491	sub load_facedata($) {	2923	sub load_facedata($) {
2492	my ($path) = @_;	2924	my ($path) = @_;
		2925
		2926	# HACK to clear player env face cache, we need some signal framework
		2927	# for this (global event?)
		2928	%ext::player_env::MUSIC_FACE_CACHE = ();
		2929
		2930	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2493		2931
2494	warn "loading facedata from $path\n";	2932	warn "loading facedata from $path\n";
2495		2933
2496	my $facedata;	2934	my $facedata;
2497	0 < aio_load $path, $facedata	2935	0 < aio_load $path, $facedata
…		…
2500	$facedata = Coro::Storable::thaw $facedata;	2938	$facedata = Coro::Storable::thaw $facedata;
2501		2939
2502	$facedata->{version} == 2	2940	$facedata->{version} == 2
2503	or cf::cleanup "$path: version mismatch, cannot proceed.";	2941	or cf::cleanup "$path: version mismatch, cannot proceed.";
2504		2942
		2943	# patch in the exptable
		2944	$facedata->{resource}{"res/exp_table"} = {
		2945	type => FT_RSRC,
		2946	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
		2947	};
		2948	cf::cede_to_tick;
		2949
2505	{	2950	{
2506	my $faces = $facedata->{faceinfo};	2951	my $faces = $facedata->{faceinfo};
2507		2952
2508	while (my ($face, $info) = each %$faces) {	2953	while (my ($face, $info) = each %$faces) {
2509	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2954	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2510	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2955	cf::face::set_visibility $idx, $info->{visibility};
		2956	cf::face::set_magicmap $idx, $info->{magicmap};
2511	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2957	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2512	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	2958	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2513	Coro::cede;	2959
		2960	cf::cede_to_tick;
2514	}	2961	}
2515		2962
2516	while (my ($face, $info) = each %$faces) {	2963	while (my ($face, $info) = each %$faces) {
2517	next unless $info->{smooth};	2964	next unless $info->{smooth};
2518	my $idx = cf::face::find $face	2965	my $idx = cf::face::find $face
2519	or next;	2966	or next;
2520	if (my $smooth = cf::face::find $info->{smooth}) {	2967	if (my $smooth = cf::face::find $info->{smooth}) {
		2968	cf::face::set_smooth $idx, $smooth;
2521	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	2969	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2522	} else {	2970	} else {
2523	warn "smooth face '$info->{smooth}' not found for face '$face'";	2971	warn "smooth face '$info->{smooth}' not found for face '$face'";
2524	}	2972	}
2525	Coro::cede;	2973
		2974	cf::cede_to_tick;
2526	}	2975	}
2527	}	2976	}
2528		2977
2529	{	2978	{
2530	my $anims = $facedata->{animinfo};	2979	my $anims = $facedata->{animinfo};
2531		2980
2532	while (my ($anim, $info) = each %$anims) {	2981	while (my ($anim, $info) = each %$anims) {
2533	cf::anim::set $anim, $info->{frames}, $info->{facings};	2982	cf::anim::set $anim, $info->{frames}, $info->{facings};
2534	Coro::cede;	2983	cf::cede_to_tick;
2535	}	2984	}
2536		2985
2537	cf::anim::invalidate_all; # d'oh	2986	cf::anim::invalidate_all; # d'oh
2538	}	2987	}
2539		2988
		2989	{
		2990	# TODO: for gcfclient pleasure, we should give resources
		2991	# that gcfclient doesn't grok a >10000 face index.
		2992	my $res = $facedata->{resource};
		2993
		2994	my $soundconf = delete $res->{"res/sound.conf"};
		2995
		2996	while (my ($name, $info) = each %$res) {
		2997	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2998	my $data;
		2999
		3000	if ($info->{type} & 1) {
		3001	# prepend meta info
		3002
		3003	my $meta = $enc->encode ({
		3004	name => $name,
		3005	%{ $info->{meta} || {} },
		3006	});
		3007
		3008	$data = pack "(w/a*)*", $meta, $info->{data};
		3009	} else {
		3010	$data = $info->{data};
		3011	}
		3012
		3013	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3014	cf::face::set_type $idx, $info->{type};
		3015
		3016	cf::cede_to_tick;
		3017	}
		3018
		3019	if ($soundconf) {
		3020	$soundconf = $enc->decode (delete $soundconf->{data});
		3021
		3022	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3023	my $sound = $soundconf->{compat}[$_]
		3024	or next;
		3025
		3026	my $face = cf::face::find "sound/$sound->[1]";
		3027	cf::sound::set $sound->[0] => $face;
		3028	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3029	}
		3030
		3031	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3032	my $face = cf::face::find "sound/$v";
		3033	cf::sound::set $k => $face;
		3034	}
		3035	}
		3036	}
		3037
2540	1	3038	1
2541	}	3039	}
2542		3040
		3041	register_exticmd fx_want => sub {
		3042	my ($ns, $want) = @_;
		3043
		3044	while (my ($k, $v) = each %$want) {
		3045	$ns->fx_want ($k, $v);
		3046	}
		3047	};
		3048
2543	sub reload_regions {	3049	sub reload_regions {
		3050	# HACK to clear player env face cache, we need some signal framework
		3051	# for this (global event?)
		3052	%ext::player_env::MUSIC_FACE_CACHE = ();
		3053
2544	load_resource_file "$MAPDIR/regions"	3054	load_resource_file "$MAPDIR/regions"
2545	or die "unable to load regions file\n";	3055	or die "unable to load regions file\n";
		3056
		3057	for (cf::region::list) {
		3058	$_->{match} = qr/$_->{match}/
		3059	if exists $_->{match};
		3060	}
2546	}	3061	}
2547		3062
2548	sub reload_facedata {	3063	sub reload_facedata {
2549	load_facedata "$DATADIR/facedata"	3064	load_facedata "$DATADIR/facedata"
2550	or die "unable to load facedata\n";	3065	or die "unable to load facedata\n";
2551	}	3066	}
2552		3067
2553	sub reload_archetypes {	3068	sub reload_archetypes {
2554	load_resource_file "$DATADIR/archetypes"	3069	load_resource_file "$DATADIR/archetypes"
2555	or die "unable to load archetypes\n";	3070	or die "unable to load archetypes\n";
		3071	#d# NEED to laod twice to resolve forward references
		3072	# this really needs to be done in an extra post-pass
		3073	# (which needs to be synchronous, so solve it differently)
		3074	load_resource_file "$DATADIR/archetypes"
		3075	or die "unable to load archetypes\n";
2556	}	3076	}
2557		3077
2558	sub reload_treasures {	3078	sub reload_treasures {
2559	load_resource_file "$DATADIR/treasures"	3079	load_resource_file "$DATADIR/treasures"
2560	or die "unable to load treasurelists\n";	3080	or die "unable to load treasurelists\n";
…		…
2563	sub reload_resources {	3083	sub reload_resources {
2564	warn "reloading resource files...\n";	3084	warn "reloading resource files...\n";
2565		3085
2566	reload_regions;	3086	reload_regions;
2567	reload_facedata;	3087	reload_facedata;
		3088	#reload_archetypes;#d#
2568	reload_archetypes;	3089	reload_archetypes;
2569	reload_treasures;	3090	reload_treasures;
2570		3091
2571	warn "finished reloading resource files\n";	3092	warn "finished reloading resource files\n";
2572	}	3093	}
2573		3094
2574	sub init {	3095	sub init {
2575	reload_resources;	3096	reload_resources;
2576	}	3097	}
2577		3098
2578	sub cfg_load {	3099	sub reload_config {
2579	open my $fh, "<:utf8", "$CONFDIR/config"	3100	open my $fh, "<:utf8", "$CONFDIR/config"
2580	or return;	3101	or return;
2581		3102
2582	local $/;	3103	local $/;
2583	*CFG = YAML::Syck::Load <$fh>;	3104	*CFG = YAML::Syck::Load <$fh>;
…		…
2603	(async {	3124	(async {
2604	Event::one_event;	3125	Event::one_event;
2605	})->prio (Coro::PRIO_MAX);	3126	})->prio (Coro::PRIO_MAX);
2606	};	3127	};
2607		3128
2608	cfg_load;	3129	reload_config;
2609	db_init;	3130	db_init;
2610	load_extensions;	3131	load_extensions;
2611		3132
2612	$TICK_WATCHER->start;	3133	$TICK_WATCHER->start;
2613	Event::loop;	3134	Event::loop;
…		…
2629	},	3150	},
2630	);	3151	);
2631	}	3152	}
2632	}	3153	}
2633		3154
		3155	sub write_runtime {
		3156	my $runtime = "$LOCALDIR/runtime";
		3157
		3158	# first touch the runtime file to show we are still running:
		3159	# the fsync below can take a very very long time.
		3160
		3161	IO::AIO::aio_utime $runtime, undef, undef;
		3162
		3163	my $guard = cf::lock_acquire "write_runtime";
		3164
		3165	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3166	or return;
		3167
		3168	my $value = $cf::RUNTIME + 90 + 10;
		3169	# 10 is the runtime save interval, for a monotonic clock
		3170	# 60 allows for the watchdog to kill the server.
		3171
		3172	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3173	and return;
		3174
		3175	# always fsync - this file is important
		3176	aio_fsync $fh
		3177	and return;
		3178
		3179	# touch it again to show we are up-to-date
		3180	aio_utime $fh, undef, undef;
		3181
		3182	close $fh
		3183	or return;
		3184
		3185	aio_rename "$runtime~", $runtime
		3186	and return;
		3187
		3188	warn "runtime file written.\n";
		3189
		3190	1
		3191	}
		3192
2634	sub emergency_save() {	3193	sub emergency_save() {
2635	my $freeze_guard = cf::freeze_mainloop;	3194	my $freeze_guard = cf::freeze_mainloop;
2636		3195
2637	warn "enter emergency perl save\n";	3196	warn "enter emergency perl save\n";
2638		3197
…		…
2713	%EXT_CORO = ();	3272	%EXT_CORO = ();
2714		3273
2715	warn "removing commands";	3274	warn "removing commands";
2716	%COMMAND = ();	3275	%COMMAND = ();
2717		3276
2718	warn "removing ext commands";	3277	warn "removing ext/exti commands";
2719	%EXTCMD = ();	3278	%EXTCMD = ();
		3279	%EXTICMD = ();
2720		3280
2721	warn "unloading/nuking all extensions";	3281	warn "unloading/nuking all extensions";
2722	for my $pkg (@EXTS) {	3282	for my $pkg (@EXTS) {
2723	warn "... unloading $pkg";	3283	warn "... unloading $pkg";
2724		3284
…		…
2767	warn "reloading cf.pm";	3327	warn "reloading cf.pm";
2768	require cf;	3328	require cf;
2769	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3329	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2770		3330
2771	warn "loading config and database again";	3331	warn "loading config and database again";
2772	cf::cfg_load;	3332	cf::reload_config;
2773		3333
2774	warn "loading extensions";	3334	warn "loading extensions";
2775	cf::load_extensions;	3335	cf::load_extensions;
2776		3336
2777	warn "reattaching attachments to objects/players";	3337	warn "reattaching attachments to objects/players";
…		…
2870	or die;	3430	or die;
2871		3431
2872	$map->width (50);	3432	$map->width (50);
2873	$map->height (50);	3433	$map->height (50);
2874	$map->alloc;	3434	$map->alloc;
2875	$map->_load_objects ("/tmp/x.map", 1);	3435	$map->_load_objects ("/tmp/x.map", 1); #TODO: does not work
2876	my $t = Event::time - $t;	3436	my $t = Event::time - $t;
2877		3437
2878	#next unless $t < 0.0013;#d#	3438	#next unless $t < 0.0013;#d#
2879	if ($t < $min) {	3439	if ($t < $min) {
2880	$min = $t;	3440	$min = $t;

Diff Legend

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