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.347 by root, Thu Aug 30 05:16:09 2007 UTC

…		…
10	use Event;	10	use Event;
11	use Opcode;	11	use Opcode;
12	use Safe;	12	use Safe;
13	use Safe::Hole;	13	use Safe::Hole;
14		14
15	use Coro 3.61 ();	15	use Coro 3.64 ();
16	use Coro::State;	16	use Coro::State;
17	use Coro::Handle;	17	use Coro::Handle;
18	use Coro::Event;	18	use Coro::Event;
19	use Coro::Timer;	19	use Coro::Timer;
20	use Coro::Signal;	20	use Coro::Signal;
21	use Coro::Semaphore;	21	use Coro::Semaphore;
22	use Coro::AIO;	22	use Coro::AIO;
23	use Coro::Storable;	23	use Coro::Storable;
		24	use Coro::Util ();
24		25
		26	use JSON::XS ();
25	use BDB ();	27	use BDB ();
26	use Data::Dumper;	28	use Data::Dumper;
27	use Digest::MD5;	29	use Digest::MD5;
28	use Fcntl;	30	use Fcntl;
29	use YAML::Syck ();	31	use YAML::Syck ();
30	use IO::AIO 2.32 ();	32	use IO::AIO 2.32 ();
31	use Time::HiRes;	33	use Time::HiRes;
32	use Compress::LZF;	34	use Compress::LZF;
		35	use Digest::MD5 ();
33		36
34	# configure various modules to our taste	37	# configure various modules to our taste
35	#	38	#
36	$Storable::canonical = 1; # reduce rsync transfers	39	$Storable::canonical = 1; # reduce rsync transfers
37	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator	40	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
…		…
49	our %COMMAND = ();	52	our %COMMAND = ();
50	our %COMMAND_TIME = ();	53	our %COMMAND_TIME = ();
51		54
52	our @EXTS = (); # list of extension package names	55	our @EXTS = (); # list of extension package names
53	our %EXTCMD = ();	56	our %EXTCMD = ();
		57	our %EXTICMD = ();
54	our %EXT_CORO = (); # coroutines bound to extensions	58	our %EXT_CORO = (); # coroutines bound to extensions
55	our %EXT_MAP = (); # pluggable maps	59	our %EXT_MAP = (); # pluggable maps
56		60
57	our $RELOAD; # number of reloads so far	61	our $RELOAD; # number of reloads so far
58	our @EVENT;	62	our @EVENT;
…		…
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 {
…		…
206	}	216	}
207		217
208	$Event::DIED = sub {	218	$Event::DIED = sub {
209	warn "error in event callback: @_";	219	warn "error in event callback: @_";
210	};	220	};
		221
		222	#############################################################################
211		223
212	=head2 UTILITY FUNCTIONS	224	=head2 UTILITY FUNCTIONS
213		225
214	=over 4	226	=over 4
215		227
…		…
234	$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;
235	$d	247	$d
236	} || "[unable to dump $_[0]: '$@']";	248	} || "[unable to dump $_[0]: '$@']";
237	}	249	}
238		250
239	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
240
241	=item $ref = cf::from_json $json	251	=item $ref = cf::from_json $json
242		252
243	Converts a JSON string into the corresponding perl data structure.	253	Converts a JSON string into the corresponding perl data structure.
244		254
245	=item $json = cf::to_json $ref	255	=item $json = cf::to_json $ref
246		256
247	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]) }
248		265
249	=item cf::lock_wait $string	266	=item cf::lock_wait $string
250		267
251	Wait until the given lock is available. See cf::lock_acquire.	268	Wait until the given lock is available. See cf::lock_acquire.
252		269
…		…
254		271
255	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
256	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,
257	for example when the coroutine gets canceled), the lock is automatically	274	for example when the coroutine gets canceled), the lock is automatically
258	returned.	275	returned.
		276
		277	Locks are *not* recursive, locking from the same coro twice results in a
		278	deadlocked coro.
259		279
260	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
261	uses map_find and cf::map::load uses map_load).	281	uses map_find and cf::map::load uses map_load).
262		282
263	=item $locked = cf::lock_active $string	283	=item $locked = cf::lock_active $string
…		…
306	};	326	};
307	$TICK_WATCHER->stop;	327	$TICK_WATCHER->stop;
308	$guard	328	$guard
309	}	329	}
310		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
311	=item cf::async { BLOCK }	387	=item cf::async { BLOCK }
312		388
313	Currently the same as Coro::async_pool, meaning you cannot use	389	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	390	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.	391	thing you are allowed to do is call C<prio> on it.
…		…
318		394
319	BEGIN { *async = \&Coro::async_pool }	395	BEGIN { *async = \&Coro::async_pool }
320		396
321	=item cf::sync_job { BLOCK }	397	=item cf::sync_job { BLOCK }
322		398
323	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)
324	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
325	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.
326		403
327	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
328	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
329	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
330	fast or be very important.	407	fast or be very important.
…		…
390	$EXT_CORO{$coro+0} = $coro;	467	$EXT_CORO{$coro+0} = $coro;
391		468
392	$coro	469	$coro
393	}	470	}
394		471
395	sub write_runtime {	472	=item fork_call { }, $args
396	my $runtime = "$LOCALDIR/runtime";
397		473
398	# first touch the runtime file to show we are still running:	474	Executes the given code block with the given arguments in a seperate
399	# 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.
400		478
401	IO::AIO::aio_utime $runtime, undef, undef;	479	=cut
402		480
403	my $guard = cf::lock_acquire "write_runtime";	481	sub fork_call(&@) {
		482	my ($cb, @args) = @_;
404		483
405	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	484	# we seemingly have to make a local copy of the whole thing,
406	or return;	485	# otherwise perl prematurely frees the stuff :/
		486	# TODO: investigate and fix (liekly this will be rather laborious)
407		487
408	my $value = $cf::RUNTIME + 90 + 10;	488	my @res = Coro::Util::fork_eval {
409	# 10 is the runtime save interval, for a monotonic clock	489	reset_signals;
410	# 60 allows for the watchdog to kill the server.	490	&$cb
		491	}, @args;
411		492
412	(aio_write $fh, 0, (length $value), $value, 0) <= 0	493	wantarray ? @res : $res[-1]
413	and return;	494	}
414		495
415	# always fsync - this file is important	496	=item $value = cf::db_get $family => $key
416	aio_fsync $fh
417	and return;
418		497
419	# touch it again to show we are up-to-date	498	Returns a single value from the environment database.
420	aio_utime $fh, undef, undef;
421		499
422	close $fh	500	=item cf::db_put $family => $key => $value
423	or return;
424		501
425	aio_rename "$runtime~", $runtime	502	Stores the given C<$value> in the family. It can currently store binary
426	and return;	503	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
427		504
428	warn "runtime file written.\n";	505	=cut
429		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	};
430	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"
431	}	610	}
432		611
433	=item cf::datalog type => key => value, ...	612	=item cf::datalog type => key => value, ...
434		613
435	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.
…		…
453	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")
454	to it. All such attachable objects support the following methods.	633	to it. All such attachable objects support the following methods.
455		634
456	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>
457	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
458	crossfire+).	637	Crossfire TRT).
459		638
460	=over 4	639	=over 4
461		640
462	=item $attachable->attach ($attachment, key => $value...)	641	=item $attachable->attach ($attachment, key => $value...)
463		642
…		…
665	_attach $registry, $klass, @attach;	844	_attach $registry, $klass, @attach;
666	}	845	}
667		846
668	$obj->{$name} = \%arg;	847	$obj->{$name} = \%arg;
669	} else {	848	} else {
670	warn "object uses attachment '$name' that is not available, postponing.\n";	849	warn "object uses attachment '$name' which is not available, postponing.\n";
671	}	850	}
672		851
673	$obj->{_attachment}{$name} = undef;	852	$obj->{_attachment}{$name} = undef;
674	}	853	}
675		854
…		…
715	";	894	";
716	die if $@;	895	die if $@;
717	}	896	}
718		897
719	our $override;	898	our $override;
720	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?
721		900
722	sub override {	901	sub override {
723	$override = 1;	902	$override = 1;
724	@invoke_results = ();	903	@INVOKE_RESULTS = (@_);
725	}	904	}
726		905
727	sub do_invoke {	906	sub do_invoke {
728	my $event = shift;	907	my $event = shift;
729	my $callbacks = shift;	908	my $callbacks = shift;
730		909
731	@invoke_results = ();	910	@INVOKE_RESULTS = ();
732		911
733	local $override;	912	local $override;
734		913
735	for (@$callbacks) {	914	for (@$callbacks) {
736	eval { &{$_->[1]} };	915	eval { &{$_->[1]} };
…		…
753		932
754	Generate an object-specific event with the given arguments.	933	Generate an object-specific event with the given arguments.
755		934
756	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
757	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
758	results (if you must, access C<@cf::invoke_results> directly).	937	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
759		938
760	=back	939	=back
761		940
762	=cut	941	=cut
763		942
764	#############################################################################	943	#############################################################################
765	# 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	}
766		956
767	sub reattach {	957	sub reattach {
768	# basically do the same as instantiate, without calling instantiate	958	# basically do the same as instantiate, without calling instantiate
769	my ($obj) = @_;	959	my ($obj) = @_;
770		960
…		…
877	warn sprintf "loading %s (%d)\n",	1067	warn sprintf "loading %s (%d)\n",
878	$filename, length $data, scalar @{$av || []};	1068	$filename, length $data, scalar @{$av || []};
879	return ($data, $av);	1069	return ($data, $av);
880	}	1070	}
881		1071
		1072	=head2 COMMAND CALLBACKS
		1073
		1074	=over 4
		1075
		1076	=cut
		1077
882	#############################################################################	1078	#############################################################################
883	# command handling &c	1079	# command handling &c
884		1080
885	=item cf::register_command $name => \&callback($ob,$args);	1081	=item cf::register_command $name => \&callback($ob,$args);
886		1082
…		…
898	push @{ $COMMAND{$name} }, [$caller, $cb];	1094	push @{ $COMMAND{$name} }, [$caller, $cb];
899	}	1095	}
900		1096
901	=item cf::register_extcmd $name => \&callback($pl,$packet);	1097	=item cf::register_extcmd $name => \&callback($pl,$packet);
902		1098
903	Register a callbackf ro execution when the client sends an extcmd packet.	1099	Register a callback for execution when the client sends an (synchronous)
		1100	extcmd packet. Ext commands will be processed in the order they are
		1101	received by the server, like other user commands. The first argument is
		1102	the logged-in player. Ext commands can only be processed after a player
		1103	has logged in successfully.
904		1104
905	If the callback returns something, it is sent back as if reply was being	1105	If the callback returns something, it is sent back as if reply was being
906	called.	1106	called.
907		1107
		1108	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1109
		1110	Register a callback for execution when the client sends an (asynchronous)
		1111	exticmd packet. Exti commands are processed by the server as soon as they
		1112	are received, i.e. out of order w.r.t. other commands. The first argument
		1113	is a client socket. Exti commands can be received anytime, even before
		1114	log-in.
		1115
		1116	If the callback returns something, it is sent back as if reply was being
		1117	called.
		1118
908	=cut	1119	=cut
909		1120
910	sub register_extcmd {	1121	sub register_extcmd {
911	my ($name, $cb) = @_;	1122	my ($name, $cb) = @_;
912		1123
913	$EXTCMD{$name} = $cb;	1124	$EXTCMD{$name} = $cb;
		1125	}
		1126
		1127	sub register_exticmd {
		1128	my ($name, $cb) = @_;
		1129
		1130	$EXTICMD{$name} = $cb;
914	}	1131	}
915		1132
916	cf::player->attach (	1133	cf::player->attach (
917	on_command => sub {	1134	on_command => sub {
918	my ($pl, $name, $params) = @_;	1135	my ($pl, $name, $params) = @_;
…		…
927	cf::override;	1144	cf::override;
928	},	1145	},
929	on_extcmd => sub {	1146	on_extcmd => sub {
930	my ($pl, $buf) = @_;	1147	my ($pl, $buf) = @_;
931		1148
932	my $msg = eval { from_json $buf };	1149	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933		1150
934	if (ref $msg) {	1151	if (ref $msg) {
		1152	my ($type, $reply, @payload) =
		1153	"ARRAY" eq ref $msg
		1154	? @$msg
		1155	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1156
		1157	my @reply;
		1158
935	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1159	if (my $cb = $EXTCMD{$type}) {
936	if (my %reply = $cb->($pl, $msg)) {	1160	@reply = $cb->($pl, @payload);
937	$pl->ext_reply ($msg->{msgid}, %reply);
938	}
939	}	1161	}
		1162
		1163	$pl->ext_reply ($reply, @reply)
		1164	if $reply;
		1165
940	} else {	1166	} else {
941	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1167	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
942	}	1168	}
943		1169
944	cf::override;	1170	cf::override;
…		…
967	path => $path,	1193	path => $path,
968	base => $base,	1194	base => $base,
969	pkg => $pkg,	1195	pkg => $pkg,
970	);	1196	);
971		1197
972	$ext{meta} = { map { split /=/, $_, 2 } split /\s+/, $1 }	1198	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
973	if $source =~ /^#!.*?perl.*?#\s*(.*)$/;	1199	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
974		1200
975	$ext{source} =	1201	$ext{source} =
976	"package $pkg; use strict; use utf8;\n"	1202	"package $pkg; use strict; use utf8;\n"
977	. "#line 1 \"$path\"\n{\n"	1203	. "#line 1 \"$path\"\n{\n"
978	. $source	1204	. $source
…		…
984	my %done;	1210	my %done;
985	while (%todo) {	1211	while (%todo) {
986	my $progress;	1212	my $progress;
987		1213
988	while (my ($k, $v) = each %todo) {	1214	while (my ($k, $v) = each %todo) {
989	for (split /,\s*/, $ext{meta}{depends}) {	1215	for (split /,\s*/, $v->{meta}{depends}) {
990	goto skip	1216	goto skip
991	unless exists $done{$_};	1217	unless exists $done{$_};
992	}	1218	}
993		1219
994	warn "... loading '$k' into '$v->{pkg}'\n";	1220	warn "... loading '$k' into '$v->{pkg}'\n";
995		1221
996	unless (eval $v->{source}) {	1222	unless (eval $v->{source}) {
997	my $msg = $@ ? "$v->{path}: $@\n"	1223	my $msg = $@ ? "$v->{path}: $@\n"
998	: "extension disabled.\n";	1224	: "$v->{base}: extension inactive.\n";
999		1225
1000	if (exists $v->{meta}{mandatory}) {	1226	if (exists $v->{meta}{mandatory}) {
1001	warn $msg;	1227	warn $msg;
1002	warn "mandatory extension failed to load, exiting.\n";	1228	warn "mandatory extension failed to load, exiting.\n";
1003	exit 1;	1229	exit 1;
1004	}	1230	}
1005		1231
1006	die $msg;	1232	warn $msg;
1007	}	1233	}
1008		1234
1009	$done{$k} = delete $todo{$k};	1235	$done{$k} = delete $todo{$k};
1010	push @EXTS, $v->{pkg};	1236	push @EXTS, $v->{pkg};
		1237	$progress = 1;
1011	}	1238	}
1012		1239
1013	skip:	1240	skip:
1014	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"	1241	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1015	unless $progress;	1242	unless $progress;
1016	}	1243	}
1017	};	1244	};
1018	}	1245	}
1019		1246
1020	#############################################################################	1247	#############################################################################
		1248
		1249	=back
1021		1250
1022	=head2 CORE EXTENSIONS	1251	=head2 CORE EXTENSIONS
1023		1252
1024	Functions and methods that extend core crossfire objects.	1253	Functions and methods that extend core crossfire objects.
1025		1254
…		…
1096		1325
1097	aio_mkdir playerdir $pl, 0770;	1326	aio_mkdir playerdir $pl, 0770;
1098	$pl->{last_save} = $cf::RUNTIME;	1327	$pl->{last_save} = $cf::RUNTIME;
1099		1328
1100	$pl->save_pl ($path);	1329	$pl->save_pl ($path);
1101	Coro::cede;	1330	cf::cede_to_tick;
1102	}	1331	}
1103		1332
1104	sub new($) {	1333	sub new($) {
1105	my ($login) = @_;	1334	my ($login) = @_;
1106		1335
…		…
1110	$self->{deny_save} = 1;	1339	$self->{deny_save} = 1;
1111		1340
1112	$cf::PLAYER{$login} = $self;	1341	$cf::PLAYER{$login} = $self;
1113		1342
1114	$self	1343	$self
		1344	}
		1345
		1346	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1347
		1348	=cut
		1349
		1350	sub send_msg {
		1351	my $ns = shift->ns
		1352	or return;
		1353	$ns->send_msg (@_);
1115	}	1354	}
1116		1355
1117	=item $pl->quit_character	1356	=item $pl->quit_character
1118		1357
1119	Nukes the player without looking back. If logged in, the connection will	1358	Nukes the player without looking back. If logged in, the connection will
…		…
1213	}	1452	}
1214		1453
1215	\@paths	1454	\@paths
1216	}	1455	}
1217		1456
		1457	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1458
		1459	Expand crossfire pod fragments into protocol xml.
		1460
		1461	=cut
		1462
		1463	sub expand_cfpod {
		1464	((my $self), (local $_)) = @_;
		1465
		1466	# escape & and <
		1467	s/&/&amp;/g;
		1468	s/(?<![BIUGH])</&lt;/g;
		1469
		1470	# this is buggy, it needs to properly take care of nested <'s
		1471
		1472	1 while
		1473	# replace B<>, I<>, U<> etc.
		1474	s/B<([^\>]*)>/<b>$1<\/b>/
		1475	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1476	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1477	# replace G<male|female> tags
		1478	|| s{G<([^>|]*)\|([^>]*)>}{
		1479	$self->gender ? $2 : $1
		1480	}ge
		1481	# replace H<hint text>
		1482	|| s{H<([^\>]*)>}
		1483	{
		1484	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1485	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1486	"")
		1487	[$self->{hintmode}]
		1488	}ge;
		1489
		1490	# create single paragraphs (very hackish)
		1491	s/(?<=\S)\n(?=\w)/ /g;
		1492
		1493	# compress some whitespace
		1494	s/\s+\n/\n/g; # ws line-ends
		1495	s/\n\n+/\n/g; # double lines
		1496	s/^\n+//; # beginning lines
		1497	s/\n+$//; # ending lines
		1498
		1499	$_
		1500	}
		1501
		1502	sub hintmode {
		1503	$_[0]{hintmode} = $_[1] if @_ > 1;
		1504	$_[0]{hintmode}
		1505	}
		1506
1218	=item $player->ext_reply ($msgid, %msg)	1507	=item $player->ext_reply ($msgid, @msg)
1219		1508
1220	Sends an ext reply to the player.	1509	Sends an ext reply to the player.
1221		1510
1222	=cut	1511	=cut
1223		1512
1224	sub ext_reply($$%) {	1513	sub ext_reply($$@) {
1225	my ($self, $id, %msg) = @_;	1514	my ($self, $id, @msg) = @_;
1226		1515
1227	$msg{msgid} = $id;	1516	$self->ns->ext_reply ($id, @msg)
1228
1229	$self->send ("ext " . cf::to_json \%msg);
1230	}	1517	}
1231		1518
1232	=item $player->ext_event ($type, %msg)	1519	=item $player->ext_msg ($type, @msg)
1233		1520
1234	Sends an ext event to the client.	1521	Sends an ext event to the client.
1235		1522
1236	=cut	1523	=cut
1237		1524
1238	sub ext_event($$%) {	1525	sub ext_msg($$@) {
1239	my ($self, $type, %msg) = @_;	1526	my ($self, $type, @msg) = @_;
1240		1527
1241	$self->ns->ext_event ($type, %msg);	1528	$self->ns->ext_msg ($type, @msg);
1242	}	1529	}
1243		1530
1244	=head3 cf::region	1531	=head3 cf::region
1245		1532
1246	=over 4	1533	=over 4
…		…
1249		1536
1250	package cf::region;	1537	package cf::region;
1251		1538
1252	=item cf::region::find_by_path $path	1539	=item cf::region::find_by_path $path
1253		1540
1254	Tries to decuce the probable region for a map knowing only its path.	1541	Tries to decuce the likely region for a map knowing only its path.
1255		1542
1256	=cut	1543	=cut
1257		1544
1258	sub find_by_path($) {	1545	sub find_by_path($) {
1259	my ($path) = @_;	1546	my ($path) = @_;
1260		1547
1261	my ($match, $specificity);	1548	my ($match, $specificity);
1262		1549
1263	for my $region (list) {	1550	for my $region (list) {
1264	if ($region->match && $path =~ $region->match) {	1551	if ($region->{match} && $path =~ $region->{match}) {
1265	($match, $specificity) = ($region, $region->specificity)	1552	($match, $specificity) = ($region, $region->specificity)
1266	if $region->specificity > $specificity;	1553	if $region->specificity > $specificity;
1267	}	1554	}
1268	}	1555	}
1269		1556
…		…
1389	$self->init; # pass $1 etc.	1676	$self->init; # pass $1 etc.
1390	return $self;	1677	return $self;
1391	}	1678	}
1392	}	1679	}
1393		1680
1394	Carp::carp "unable to resolve path '$path' (base '$base').";	1681	Carp::cluck "unable to resolve path '$path' (base '$base').";
1395	()	1682	()
1396	}	1683	}
1397		1684
1398	sub init {	1685	sub init {
1399	my ($self) = @_;	1686	my ($self) = @_;
…		…
1565	local $self->{deny_reset} = 1; # loading can take a long time	1852	local $self->{deny_reset} = 1; # loading can take a long time
1566		1853
1567	my $path = $self->{path};	1854	my $path = $self->{path};
1568		1855
1569	{	1856	{
		1857	my $guard1 = cf::lock_acquire "map_data:$path";
1570	my $guard = cf::lock_acquire "map_load:$path";	1858	my $guard2 = cf::lock_acquire "map_load:$path";
1571		1859
1572	return if $self->in_memory != cf::MAP_SWAPPED;	1860	return if $self->in_memory != cf::MAP_SWAPPED;
1573		1861
1574	$self->in_memory (cf::MAP_LOADING);	1862	$self->in_memory (cf::MAP_LOADING);
1575		1863
1576	$self->alloc;	1864	$self->alloc;
1577		1865
1578	$self->pre_load;	1866	$self->pre_load;
1579	Coro::cede;	1867	cf::cede_to_tick;
1580		1868
1581	$self->_load_objects ($self->{load_path}, 1)	1869	$self->_load_objects ($self->{load_path}, 1)
1582	or return;	1870	or return;
1583		1871
1584	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1872	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
…		…
1590	$self->clear_unique_items;	1878	$self->clear_unique_items;
1591	$self->_load_objects ($uniq, 0);	1879	$self->_load_objects ($uniq, 0);
1592	}	1880	}
1593	}	1881	}
1594		1882
1595	Coro::cede;	1883	cf::cede_to_tick;
1596	# now do the right thing for maps	1884	# now do the right thing for maps
1597	$self->link_multipart_objects;	1885	$self->link_multipart_objects;
1598	$self->difficulty ($self->estimate_difficulty)	1886	$self->difficulty ($self->estimate_difficulty)
1599	unless $self->difficulty;	1887	unless $self->difficulty;
1600	Coro::cede;	1888	cf::cede_to_tick;
1601		1889
1602	unless ($self->{deny_activate}) {	1890	unless ($self->{deny_activate}) {
1603	$self->decay_objects;	1891	$self->decay_objects;
1604	$self->fix_auto_apply;	1892	$self->fix_auto_apply;
1605	$self->update_buttons;	1893	$self->update_buttons;
1606	Coro::cede;	1894	cf::cede_to_tick;
1607	$self->set_darkness_map;	1895	$self->set_darkness_map;
1608	Coro::cede;	1896	cf::cede_to_tick;
1609	$self->activate;	1897	$self->activate;
1610	}	1898	}
		1899
		1900	$self->{last_save} = $cf::RUNTIME;
		1901	$self->last_access ($cf::RUNTIME);
1611		1902
1612	$self->in_memory (cf::MAP_IN_MEMORY);	1903	$self->in_memory (cf::MAP_IN_MEMORY);
1613	}	1904	}
1614		1905
1615	$self->post_load;	1906	$self->post_load;
…		…
1626		1917
1627	$self	1918	$self
1628	}	1919	}
1629		1920
1630	# find and load all maps in the 3x3 area around a map	1921	# find and load all maps in the 3x3 area around a map
1631	sub load_diag {	1922	sub load_neighbours {
1632	my ($map) = @_;	1923	my ($map) = @_;
1633		1924
1634	my @diag; # diagonal neighbours	1925	my @neigh; # diagonal neighbours
1635		1926
1636	for (0 .. 3) {	1927	for (0 .. 3) {
1637	my $neigh = $map->tile_path ($_)	1928	my $neigh = $map->tile_path ($_)
1638	or next;	1929	or next;
1639	$neigh = find $neigh, $map	1930	$neigh = find $neigh, $map
1640	or next;	1931	or next;
1641	$neigh->load;	1932	$neigh->load;
1642		1933
		1934	push @neigh,
1643	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	1935	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1644	[$neigh->tile_path (($_ + 1) % 4), $neigh];	1936	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1645	}	1937	}
1646		1938
1647	for (@diag) {	1939	for (grep defined $_->[0], @neigh) {
		1940	my ($path, $origin) = @$_;
1648	my $neigh = find @$_	1941	my $neigh = find $path, $origin
1649	or next;	1942	or next;
1650	$neigh->load;	1943	$neigh->load;
1651	}	1944	}
1652	}	1945	}
1653		1946
…		…
1658	}	1951	}
1659		1952
1660	sub do_load_sync {	1953	sub do_load_sync {
1661	my ($map) = @_;	1954	my ($map) = @_;
1662		1955
		1956	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		1957	if $Coro::current == $Coro::main;
		1958
1663	cf::sync_job { $map->load };	1959	cf::sync_job { $map->load };
1664	}	1960	}
1665		1961
1666	our %MAP_PREFETCH;	1962	our %MAP_PREFETCH;
1667	our $MAP_PREFETCHER = undef;	1963	our $MAP_PREFETCHER = undef;
1668		1964
1669	sub find_async {	1965	sub find_async {
1670	my ($path, $origin) = @_;	1966	my ($path, $origin, $load) = @_;
1671		1967
1672	$path = normalise $path, $origin && $origin->{path};	1968	$path = normalise $path, $origin && $origin->{path};
1673		1969
1674	if (my $map = $cf::MAP{$path}) {	1970	if (my $map = $cf::MAP{$path}) {
1675	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	1971	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1676	}	1972	}
1677		1973
1678	undef $MAP_PREFETCH{$path};	1974	$MAP_PREFETCH{$path} |= $load;
		1975
1679	$MAP_PREFETCHER ||= cf::async {	1976	$MAP_PREFETCHER ||= cf::async {
1680	while (%MAP_PREFETCH) {	1977	while (%MAP_PREFETCH) {
1681	for my $path (keys %MAP_PREFETCH) {	1978	while (my ($k, $v) = each %MAP_PREFETCH) {
1682	my $map = find $path	1979	if (my $map = find $k) {
1683	or next;
1684	$map->load;	1980	$map->load if $v;
		1981	}
1685		1982
1686	delete $MAP_PREFETCH{$path};	1983	delete $MAP_PREFETCH{$k};
1687	}	1984	}
1688	}	1985	}
1689	undef $MAP_PREFETCHER;	1986	undef $MAP_PREFETCHER;
1690	};	1987	};
1691	$MAP_PREFETCHER->prio (6);	1988	$MAP_PREFETCHER->prio (6);
…		…
1694	}	1991	}
1695		1992
1696	sub save {	1993	sub save {
1697	my ($self) = @_;	1994	my ($self) = @_;
1698		1995
1699	my $lock = cf::lock_acquire "map_data:" . $self->path;	1996	my $lock = cf::lock_acquire "map_data:$self->{path}";
1700		1997
1701	$self->{last_save} = $cf::RUNTIME;	1998	$self->{last_save} = $cf::RUNTIME;
1702		1999
1703	return unless $self->dirty;	2000	return unless $self->dirty;
1704		2001
…		…
1727	my ($self) = @_;	2024	my ($self) = @_;
1728		2025
1729	# save first because save cedes	2026	# save first because save cedes
1730	$self->save;	2027	$self->save;
1731		2028
1732	my $lock = cf::lock_acquire "map_data:" . $self->path;	2029	my $lock = cf::lock_acquire "map_data:$self->{path}";
1733		2030
1734	return if $self->players;	2031	return if $self->players;
1735	return if $self->in_memory != cf::MAP_IN_MEMORY;	2032	return if $self->in_memory != cf::MAP_IN_MEMORY;
1736	return if $self->{deny_save};	2033	return if $self->{deny_save};
1737		2034
…		…
1911		2208
1912	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2209	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1913		2210
1914	if ($self->{record_replies}) {	2211	if ($self->{record_replies}) {
1915	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2212	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2213
1916	} else {	2214	} else {
		2215	my $pl = $self->contr;
		2216
		2217	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2218	my $dialog = $pl->{npc_dialog};
		2219	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2220
		2221	} else {
1917	$msg = $npc->name . " says: $msg" if $npc;	2222	$msg = $npc->name . " says: $msg" if $npc;
1918	$self->message ($msg, $flags);	2223	$self->message ($msg, $flags);
		2224	}
1919	}	2225	}
		2226	}
		2227
		2228	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2229
		2230	=cut
		2231
		2232	sub cf::object::send_msg {
		2233	my $pl = shift->contr
		2234	or return;
		2235	$pl->send_msg (@_);
1920	}	2236	}
1921		2237
1922	=item $player_object->may ("access")	2238	=item $player_object->may ("access")
1923		2239
1924	Returns wether the given player is authorized to access resource "access"	2240	Returns wether the given player is authorized to access resource "access"
…		…
2003	# use -1 or undef as default coordinates, not 0, 0	2319	# use -1 or undef as default coordinates, not 0, 0
2004	($x, $y) = ($map->enter_x, $map->enter_y)	2320	($x, $y) = ($map->enter_x, $map->enter_y)
2005	if $x <=0 && $y <= 0;	2321	if $x <=0 && $y <= 0;
2006		2322
2007	$map->load;	2323	$map->load;
2008	$map->load_diag;	2324	$map->load_neighbours;
2009		2325
2010	return unless $self->contr->active;	2326	return unless $self->contr->active;
2011	$self->activate_recursive;	2327	$self->activate_recursive;
2012		2328
2013	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2329	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2014	$self->enter_map ($map, $x, $y);	2330	$self->enter_map ($map, $x, $y);
2015	}	2331	}
2016		2332
2017	=item $player_object->goto ($path, $x, $y[, $check->($map)])	2333	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
2018		2334
2019	Moves the player to the given map-path and coordinates by first freezing	2335	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	2336	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	2337	that has to return the map if sucecssful, and then unfreezes the player on
2022	the new (success) or old (failed) map position.	2338	the new (success) or old (failed) map position. In either case, $done will
		2339	be called at the end of this process.
2023		2340
2024	=cut	2341	=cut
2025		2342
2026	our $GOTOGEN;	2343	our $GOTOGEN;
2027		2344
2028	sub cf::object::player::goto {	2345	sub cf::object::player::goto {
2029	my ($self, $path, $x, $y, $check) = @_;	2346	my ($self, $path, $x, $y, $check, $done) = @_;
2030		2347
2031	# do generation counting so two concurrent goto's will be executed in-order	2348	# do generation counting so two concurrent goto's will be executed in-order
2032	my $gen = $self->{_goto_generation} = ++$GOTOGEN;	2349	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
2033		2350
2034	$self->enter_link;	2351	$self->enter_link;
…		…
2054		2371
2055	if ($gen == $self->{_goto_generation}) {	2372	if ($gen == $self->{_goto_generation}) {
2056	delete $self->{_goto_generation};	2373	delete $self->{_goto_generation};
2057	$self->leave_link ($map, $x, $y);	2374	$self->leave_link ($map, $x, $y);
2058	}	2375	}
		2376
		2377	$done->() if $done;
2059	})->prio (1);	2378	})->prio (1);
2060	}	2379	}
2061		2380
2062	=item $player_object->enter_exit ($exit_object)	2381	=item $player_object->enter_exit ($exit_object)
2063		2382
…		…
2132	my $hp = $exit->stats->hp;	2451	my $hp = $exit->stats->hp;
2133	my $sp = $exit->stats->sp;	2452	my $sp = $exit->stats->sp;
2134		2453
2135	$self->enter_link;	2454	$self->enter_link;
2136		2455
		2456	# if exit is damned, update players death & WoR home-position
		2457	$self->contr->savebed ($slaying, $hp, $sp)
		2458	if $exit->flag (FLAG_DAMNED);
		2459
2137	(async {	2460	(async {
2138	$self->deactivate_recursive; # just to be sure	2461	$self->deactivate_recursive; # just to be sure
2139	unless (eval {	2462	unless (eval {
2140	$self->goto ($slaying, $hp, $sp);	2463	$self->goto ($slaying, $hp, $sp);
2141		2464
…		…
2168		2491
2169	utf8::encode $text;	2492	utf8::encode $text;
2170	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2493	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2171	}	2494	}
2172		2495
		2496	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2497
		2498	Send a drawinfo or msg packet to the client, formatting the msg for the
		2499	client if neccessary. C<$type> should be a string identifying the type of
		2500	the message, with C<log> being the default. If C<$color> is negative, suppress
		2501	the message unless the client supports the msg packet.
		2502
		2503	=cut
		2504
		2505	sub cf::client::send_msg {
		2506	my ($self, $channel, $msg, $color, @extra) = @_;
		2507
		2508	$msg = $self->pl->expand_cfpod ($msg);
		2509
		2510	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2511
		2512	if (ref $channel) {
		2513	# send meta info to client, if not yet sent
		2514	unless (exists $self->{channel}{$channel->{id}}) {
		2515	$self->{channel}{$channel->{id}} = $channel;
		2516	$self->ext_msg (channel_info => $channel);
		2517	}
		2518
		2519	$channel = $channel->{id};
		2520	}
		2521
		2522	return unless @extra || length $msg;
		2523
		2524	if ($self->can_msg) {
		2525	# default colour, mask it out
		2526	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2527	if $color & cf::NDI_DEF;
		2528
		2529	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2530	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2531	} else {
		2532	if ($color >= 0) {
		2533	# replace some tags by gcfclient-compatible ones
		2534	for ($msg) {
		2535	1 while
		2536	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2537	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2538	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2539	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2540	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2541	}
		2542
		2543	$color &= cf::NDI_COLOR_MASK;
		2544
		2545	utf8::encode $msg;
		2546
		2547	if (0 && $msg =~ /\[/) {
		2548	# COMMAND/INFO
		2549	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2550	} else {
		2551	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2552	$self->send_packet ("drawinfo $color $msg")
		2553	}
		2554	}
		2555	}
		2556	}
		2557
2173	=item $client->ext_event ($type, %msg)	2558	=item $client->ext_msg ($type, @msg)
2174		2559
2175	Sends an exti event to the client.	2560	Sends an ext event to the client.
2176		2561
2177	=cut	2562	=cut
2178		2563
2179	sub cf::client::ext_event($$%) {	2564	sub cf::client::ext_msg($$@) {
2180	my ($self, $type, %msg) = @_;	2565	my ($self, $type, @msg) = @_;
2181		2566
		2567	if ($self->extcmd == 2) {
		2568	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2569	} elsif ($self->extcmd == 1) { # TODO: remove
2182	$msg{msgtype} = "event_$type";	2570	push @msg, msgtype => "event_$type";
2183	$self->send_packet ("ext " . cf::to_json \%msg);	2571	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2572	}
		2573	}
		2574
		2575	=item $client->ext_reply ($msgid, @msg)
		2576
		2577	Sends an ext reply to the client.
		2578
		2579	=cut
		2580
		2581	sub cf::client::ext_reply($$@) {
		2582	my ($self, $id, @msg) = @_;
		2583
		2584	if ($self->extcmd == 2) {
		2585	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2586	} elsif ($self->extcmd == 1) {
		2587	#TODO: version 1, remove
		2588	unshift @msg, msgtype => "reply", msgid => $id;
		2589	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2590	}
2184	}	2591	}
2185		2592
2186	=item $success = $client->query ($flags, "text", \&cb)	2593	=item $success = $client->query ($flags, "text", \&cb)
2187		2594
2188	Queues a query to the client, calling the given callback with	2595	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>,	2596	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>.	2597	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2191		2598
2192	Queries can fail, so check the return code. Or don't, as queries will become	2599	Queries can fail, so check the return code. Or don't, as queries will
2193	reliable at some point in the future.	2600	become reliable at some point in the future.
2194		2601
2195	=cut	2602	=cut
2196		2603
2197	sub cf::client::query {	2604	sub cf::client::query {
2198	my ($self, $flags, $text, $cb) = @_;	2605	my ($self, $flags, $text, $cb) = @_;
…		…
2206	utf8::encode $text;	2613	utf8::encode $text;
2207	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2614	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2208		2615
2209	$self->send_packet ($self->{query_queue}[0][0])	2616	$self->send_packet ($self->{query_queue}[0][0])
2210	if @{ $self->{query_queue} } == 1;	2617	if @{ $self->{query_queue} } == 1;
		2618
		2619	1
2211	}	2620	}
2212		2621
2213	cf::client->attach (	2622	cf::client->attach (
		2623	on_connect => sub {
		2624	my ($ns) = @_;
		2625
		2626	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2627	},
2214	on_reply => sub {	2628	on_reply => sub {
2215	my ($ns, $msg) = @_;	2629	my ($ns, $msg) = @_;
2216		2630
2217	# this weird shuffling is so that direct followup queries	2631	# this weird shuffling is so that direct followup queries
2218	# get handled first	2632	# get handled first
…		…
2230	} else {	2644	} else {
2231	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2645	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2232	}	2646	}
2233	}	2647	}
2234	},	2648	},
		2649	on_exticmd => sub {
		2650	my ($ns, $buf) = @_;
		2651
		2652	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2653
		2654	if (ref $msg) {
		2655	my ($type, $reply, @payload) =
		2656	"ARRAY" eq ref $msg
		2657	? @$msg
		2658	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2659
		2660	my @reply;
		2661
		2662	if (my $cb = $EXTICMD{$type}) {
		2663	@reply = $cb->($ns, @payload);
		2664	}
		2665
		2666	$ns->ext_reply ($reply, @reply)
		2667	if $reply;
		2668
		2669	} else {
		2670	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2671	}
		2672
		2673	cf::override;
		2674	},
2235	);	2675	);
2236		2676
2237	=item $client->async (\&cb)	2677	=item $client->async (\&cb)
2238		2678
2239	Create a new coroutine, running the specified callback. The coroutine will	2679	Create a new coroutine, running the specified callback. The coroutine will
…		…
2280	our $safe = new Safe "safe";	2720	our $safe = new Safe "safe";
2281	our $safe_hole = new Safe::Hole;	2721	our $safe_hole = new Safe::Hole;
2282		2722
2283	$SIG{FPE} = 'IGNORE';	2723	$SIG{FPE} = 'IGNORE';
2284		2724
2285	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2725	$safe->permit_only (Opcode::opset qw(
		2726	:base_core :base_mem :base_orig :base_math
		2727	grepstart grepwhile mapstart mapwhile
		2728	sort time
		2729	));
2286		2730
2287	# here we export the classes and methods available to script code	2731	# here we export the classes and methods available to script code
2288		2732
2289	=pod	2733	=pod
2290		2734
2291	The following functions and methods are available within a safe environment:	2735	The following functions and methods are available within a safe environment:
2292		2736
2293	cf::object contr pay_amount pay_player map	2737	cf::object
		2738	contr pay_amount pay_player map x y force_find force_add
		2739	insert remove name archname title slaying race decrease_ob_nr
		2740
2294	cf::object::player player	2741	cf::object::player
2295	cf::player peaceful	2742	player
2296	cf::map trigger	2743
		2744	cf::player
		2745	peaceful
		2746
		2747	cf::map
		2748	trigger
2297		2749
2298	=cut	2750	=cut
2299		2751
2300	for (	2752	for (
2301	["cf::object" => qw(contr pay_amount pay_player map)],	2753	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2754	insert remove inv name archname title slaying race
		2755	decrease_ob_nr)],
2302	["cf::object::player" => qw(player)],	2756	["cf::object::player" => qw(player)],
2303	["cf::player" => qw(peaceful)],	2757	["cf::player" => qw(peaceful)],
2304	["cf::map" => qw(trigger)],	2758	["cf::map" => qw(trigger)],
2305	) {	2759	) {
2306	no strict 'refs';	2760	no strict 'refs';
…		…
2377	=back	2831	=back
2378		2832
2379	=cut	2833	=cut
2380		2834
2381	#############################################################################	2835	#############################################################################
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	2836	# the server's init and main functions
2555		2837
2556	sub load_facedata($) {	2838	sub load_facedata($) {
2557	my ($path) = @_;	2839	my ($path) = @_;
		2840
		2841	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2558		2842
2559	warn "loading facedata from $path\n";	2843	warn "loading facedata from $path\n";
2560		2844
2561	my $facedata;	2845	my $facedata;
2562	0 < aio_load $path, $facedata	2846	0 < aio_load $path, $facedata
…		…
2565	$facedata = Coro::Storable::thaw $facedata;	2849	$facedata = Coro::Storable::thaw $facedata;
2566		2850
2567	$facedata->{version} == 2	2851	$facedata->{version} == 2
2568	or cf::cleanup "$path: version mismatch, cannot proceed.";	2852	or cf::cleanup "$path: version mismatch, cannot proceed.";
2569		2853
		2854	# patch in the exptable
		2855	$facedata->{resource}{"res/exp_table"} = {
		2856	type => FT_RSRC,
		2857	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
		2858	};
		2859	cf::cede_to_tick;
		2860
2570	{	2861	{
2571	my $faces = $facedata->{faceinfo};	2862	my $faces = $facedata->{faceinfo};
2572		2863
2573	while (my ($face, $info) = each %$faces) {	2864	while (my ($face, $info) = each %$faces) {
2574	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2865	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2575	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2866	cf::face::set_visibility $idx, $info->{visibility};
		2867	cf::face::set_magicmap $idx, $info->{magicmap};
2576	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2868	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2577	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	2869	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2578	Coro::cede;	2870
		2871	cf::cede_to_tick;
2579	}	2872	}
2580		2873
2581	while (my ($face, $info) = each %$faces) {	2874	while (my ($face, $info) = each %$faces) {
2582	next unless $info->{smooth};	2875	next unless $info->{smooth};
2583	my $idx = cf::face::find $face	2876	my $idx = cf::face::find $face
2584	or next;	2877	or next;
2585	if (my $smooth = cf::face::find $info->{smooth}) {	2878	if (my $smooth = cf::face::find $info->{smooth}) {
		2879	cf::face::set_smooth $idx, $smooth;
2586	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	2880	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2587	} else {	2881	} else {
2588	warn "smooth face '$info->{smooth}' not found for face '$face'";	2882	warn "smooth face '$info->{smooth}' not found for face '$face'";
2589	}	2883	}
2590	Coro::cede;	2884
		2885	cf::cede_to_tick;
2591	}	2886	}
2592	}	2887	}
2593		2888
2594	{	2889	{
2595	my $anims = $facedata->{animinfo};	2890	my $anims = $facedata->{animinfo};
2596		2891
2597	while (my ($anim, $info) = each %$anims) {	2892	while (my ($anim, $info) = each %$anims) {
2598	cf::anim::set $anim, $info->{frames}, $info->{facings};	2893	cf::anim::set $anim, $info->{frames}, $info->{facings};
2599	Coro::cede;	2894	cf::cede_to_tick;
2600	}	2895	}
2601		2896
2602	cf::anim::invalidate_all; # d'oh	2897	cf::anim::invalidate_all; # d'oh
2603	}	2898	}
2604		2899
		2900	{
		2901	# TODO: for gcfclient pleasure, we should give resources
		2902	# that gcfclient doesn't grok a >10000 face index.
		2903	my $res = $facedata->{resource};
		2904
		2905	my $soundconf = delete $res->{"res/sound.conf"};
		2906
		2907	while (my ($name, $info) = each %$res) {
		2908	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2909	my $data;
		2910
		2911	if ($info->{type} & 1) {
		2912	# prepend meta info
		2913
		2914	my $meta = $enc->encode ({
		2915	name => $name,
		2916	%{ $info->{meta} || {} },
		2917	});
		2918
		2919	$data = pack "(w/a*)*", $meta, $info->{data};
		2920	} else {
		2921	$data = $info->{data};
		2922	}
		2923
		2924	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		2925	cf::face::set_type $idx, $info->{type};
		2926
		2927	cf::cede_to_tick;
		2928	}
		2929
		2930	if ($soundconf) {
		2931	$soundconf = $enc->decode (delete $soundconf->{data});
		2932
		2933	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2934	my $sound = $soundconf->{compat}[$_]
		2935	or next;
		2936
		2937	my $face = cf::face::find "sound/$sound->[1]";
		2938	cf::sound::set $sound->[0] => $face;
		2939	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2940	}
		2941
		2942	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2943	my $face = cf::face::find "sound/$v";
		2944	cf::sound::set $k => $face;
		2945	}
		2946	}
		2947	}
		2948
2605	1	2949	1
2606	}	2950	}
		2951
		2952	register_exticmd fx_want => sub {
		2953	my ($ns, $want) = @_;
		2954
		2955	while (my ($k, $v) = each %$want) {
		2956	$ns->fx_want ($k, $v);
		2957	}
		2958	};
2607		2959
2608	sub reload_regions {	2960	sub reload_regions {
2609	load_resource_file "$MAPDIR/regions"	2961	load_resource_file "$MAPDIR/regions"
2610	or die "unable to load regions file\n";	2962	or die "unable to load regions file\n";
		2963
		2964	for (cf::region::list) {
		2965	$_->{match} = qr/$_->{match}/
		2966	if exists $_->{match};
		2967	}
2611	}	2968	}
2612		2969
2613	sub reload_facedata {	2970	sub reload_facedata {
2614	load_facedata "$DATADIR/facedata"	2971	load_facedata "$DATADIR/facedata"
2615	or die "unable to load facedata\n";	2972	or die "unable to load facedata\n";
2616	}	2973	}
2617		2974
2618	sub reload_archetypes {	2975	sub reload_archetypes {
		2976	load_resource_file "$DATADIR/archetypes"
		2977	or die "unable to load archetypes\n";
		2978	#d# NEED to laod twice to resolve forward references
		2979	# this really needs to be done in an extra post-pass
		2980	# (which needs to be synchronous, so solve it differently)
2619	load_resource_file "$DATADIR/archetypes"	2981	load_resource_file "$DATADIR/archetypes"
2620	or die "unable to load archetypes\n";	2982	or die "unable to load archetypes\n";
2621	}	2983	}
2622		2984
2623	sub reload_treasures {	2985	sub reload_treasures {
…		…
2639		3001
2640	sub init {	3002	sub init {
2641	reload_resources;	3003	reload_resources;
2642	}	3004	}
2643		3005
2644	sub cfg_load {	3006	sub reload_config {
2645	open my $fh, "<:utf8", "$CONFDIR/config"	3007	open my $fh, "<:utf8", "$CONFDIR/config"
2646	or return;	3008	or return;
2647		3009
2648	local $/;	3010	local $/;
2649	*CFG = YAML::Syck::Load <$fh>;	3011	*CFG = YAML::Syck::Load <$fh>;
…		…
2669	(async {	3031	(async {
2670	Event::one_event;	3032	Event::one_event;
2671	})->prio (Coro::PRIO_MAX);	3033	})->prio (Coro::PRIO_MAX);
2672	};	3034	};
2673		3035
2674	cfg_load;	3036	reload_config;
2675	db_init;	3037	db_init;
2676	load_extensions;	3038	load_extensions;
2677		3039
2678	$TICK_WATCHER->start;	3040	$TICK_WATCHER->start;
2679	Event::loop;	3041	Event::loop;
…		…
2695	},	3057	},
2696	);	3058	);
2697	}	3059	}
2698	}	3060	}
2699		3061
		3062	sub write_runtime {
		3063	my $runtime = "$LOCALDIR/runtime";
		3064
		3065	# first touch the runtime file to show we are still running:
		3066	# the fsync below can take a very very long time.
		3067
		3068	IO::AIO::aio_utime $runtime, undef, undef;
		3069
		3070	my $guard = cf::lock_acquire "write_runtime";
		3071
		3072	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3073	or return;
		3074
		3075	my $value = $cf::RUNTIME + 90 + 10;
		3076	# 10 is the runtime save interval, for a monotonic clock
		3077	# 60 allows for the watchdog to kill the server.
		3078
		3079	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3080	and return;
		3081
		3082	# always fsync - this file is important
		3083	aio_fsync $fh
		3084	and return;
		3085
		3086	# touch it again to show we are up-to-date
		3087	aio_utime $fh, undef, undef;
		3088
		3089	close $fh
		3090	or return;
		3091
		3092	aio_rename "$runtime~", $runtime
		3093	and return;
		3094
		3095	warn "runtime file written.\n";
		3096
		3097	1
		3098	}
		3099
2700	sub emergency_save() {	3100	sub emergency_save() {
2701	my $freeze_guard = cf::freeze_mainloop;	3101	my $freeze_guard = cf::freeze_mainloop;
2702		3102
2703	warn "enter emergency perl save\n";	3103	warn "enter emergency perl save\n";
2704		3104
…		…
2779	%EXT_CORO = ();	3179	%EXT_CORO = ();
2780		3180
2781	warn "removing commands";	3181	warn "removing commands";
2782	%COMMAND = ();	3182	%COMMAND = ();
2783		3183
2784	warn "removing ext commands";	3184	warn "removing ext/exti commands";
2785	%EXTCMD = ();	3185	%EXTCMD = ();
		3186	%EXTICMD = ();
2786		3187
2787	warn "unloading/nuking all extensions";	3188	warn "unloading/nuking all extensions";
2788	for my $pkg (@EXTS) {	3189	for my $pkg (@EXTS) {
2789	warn "... unloading $pkg";	3190	warn "... unloading $pkg";
2790		3191
…		…
2833	warn "reloading cf.pm";	3234	warn "reloading cf.pm";
2834	require cf;	3235	require cf;
2835	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3236	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2836		3237
2837	warn "loading config and database again";	3238	warn "loading config and database again";
2838	cf::cfg_load;	3239	cf::reload_config;
2839		3240
2840	warn "loading extensions";	3241	warn "loading extensions";
2841	cf::load_extensions;	3242	cf::load_extensions;
2842		3243
2843	warn "reattaching attachments to objects/players";	3244	warn "reattaching attachments to objects/players";

Diff Legend

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