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.274 by root, Tue Jun 5 13:05:02 2007 UTC vs.
Revision 1.338 by root, Tue Aug 21 01:07:47 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 1.4 ();
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
…		…
306	};	323	};
307	$TICK_WATCHER->stop;	324	$TICK_WATCHER->stop;
308	$guard	325	$guard
309	}	326	}
310		327
		328	=item cf::get_slot $time[, $priority[, $name]]
		329
		330	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		331	This call blocks and returns only when you have at least C<$time> seconds
		332	of cpu time till the next tick. The slot is only valid till the next cede.
		333
		334	The optional C<$name> can be used to identify the job to run. It might be
		335	used for statistical purposes and should identify the same time-class.
		336
		337	Useful for short background jobs.
		338
		339	=cut
		340
		341	our @SLOT_QUEUE;
		342	our $SLOT_QUEUE;
		343
		344	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		345	$SLOT_QUEUE = Coro::async {
		346	my $signal = new Coro::Signal;
		347
		348	while () {
		349	next_job:
		350	my $avail = cf::till_tick;
		351	if ($avail > 0.01) {
		352	for (0 .. $#SLOT_QUEUE) {
		353	if ($SLOT_QUEUE[$_][0] < $avail) {
		354	my $job = splice @SLOT_QUEUE, $_, 1, ();
		355	$job->[2]->send;
		356	Coro::cede;
		357	goto next_job;
		358	}
		359	}
		360	}
		361
		362	if (@SLOT_QUEUE) {
		363	# we do not use wait_For_tick() as it returns immediately when tick is inactive
		364	push @cf::WAIT_FOR_TICK, $signal;
		365	$signal->wait;
		366	} else {
		367	Coro::schedule;
		368	}
		369	}
		370	};
		371
		372	sub get_slot($;$$) {
		373	my ($time, $pri, $name) = @_;
		374
		375	$time = $TICK * .6 if $time > $TICK * .6;
		376	my $sig = new Coro::Signal;
		377
		378	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		379	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		380	$SLOT_QUEUE->ready;
		381	$sig->wait;
		382	}
		383
311	=item cf::async { BLOCK }	384	=item cf::async { BLOCK }
312		385
313	Currently the same as Coro::async_pool, meaning you cannot use	386	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	387	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.	388	thing you are allowed to do is call C<prio> on it.
…		…
318		391
319	BEGIN { *async = \&Coro::async_pool }	392	BEGIN { *async = \&Coro::async_pool }
320		393
321	=item cf::sync_job { BLOCK }	394	=item cf::sync_job { BLOCK }
322		395
323	The design of crossfire+ requires that the main coro ($Coro::main) is	396	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
324	always able to handle events or runnable, as crossfire+ is only partly	397	is always able to handle events or runnable, as Crossfire TRT is only
325	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	398	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		399	acceptable.
326		400
327	If it must be done, put the blocking parts into C<sync_job>. This will run	401	If it must be done, put the blocking parts into C<sync_job>. This will run
328	the given BLOCK in another coroutine while waiting for the result. The	402	the given BLOCK in another coroutine while waiting for the result. The
329	server will be frozen during this time, so the block should either finish	403	server will be frozen during this time, so the block should either finish
330	fast or be very important.	404	fast or be very important.
…		…
390	$EXT_CORO{$coro+0} = $coro;	464	$EXT_CORO{$coro+0} = $coro;
391		465
392	$coro	466	$coro
393	}	467	}
394		468
395	sub write_runtime {	469	=item fork_call { }, $args
396	my $runtime = "$LOCALDIR/runtime";
397		470
398	# first touch the runtime file to show we are still running:	471	Executes the given code block with the given arguments in a seperate
399	# the fsync below can take a very very long time.	472	process, returning the results. Everything must be serialisable with
		473	Coro::Storable. May, of course, block. Note that the executed sub may
		474	never block itself or use any form of Event handling.
400		475
401	IO::AIO::aio_utime $runtime, undef, undef;	476	=cut
402		477
403	my $guard = cf::lock_acquire "write_runtime";	478	sub fork_call(&@) {
		479	my ($cb, @args) = @_;
404		480
405	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	481	# we seemingly have to make a local copy of the whole thing,
406	or return;	482	# otherwise perl prematurely frees the stuff :/
		483	# TODO: investigate and fix (liekly this will be rather laborious)
407		484
408	my $value = $cf::RUNTIME + 90 + 10;	485	my @res = Coro::Util::fork_eval {
409	# 10 is the runtime save interval, for a monotonic clock	486	reset_signals;
410	# 60 allows for the watchdog to kill the server.	487	&$cb
		488	}, @args;
411		489
412	(aio_write $fh, 0, (length $value), $value, 0) <= 0	490	wantarray ? @res : $res[-1]
413	and return;	491	}
414		492
415	# always fsync - this file is important	493	=item $value = cf::db_get $family => $key
416	aio_fsync $fh
417	and return;
418		494
419	# touch it again to show we are up-to-date	495	Returns a single value from the environment database.
420	aio_utime $fh, undef, undef;
421		496
422	close $fh	497	=item cf::db_put $family => $key => $value
423	or return;
424		498
425	aio_rename "$runtime~", $runtime	499	Stores the given C<$value> in the family. It can currently store binary
426	and return;	500	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
427		501
428	warn "runtime file written.\n";	502	=cut
429		503
		504	our $DB;
		505
		506	sub db_init {
		507	unless ($DB) {
		508	$DB = BDB::db_create $DB_ENV;
		509
		510	cf::sync_job {
		511	eval {
		512	$DB->set_flags (BDB::CHKSUM);
		513
		514	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		515	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		516	cf::cleanup "db_open(db): $!" if $!;
		517	};
		518	cf::cleanup "db_open(db): $@" if $@;
		519	};
430	1	520	}
		521	}
		522
		523	sub db_get($$) {
		524	my $key = "$_[0]/$_[1]";
		525
		526	cf::sync_job {
		527	BDB::db_get $DB, undef, $key, my $data;
		528
		529	$! ? ()
		530	: $data
		531	}
		532	}
		533
		534	sub db_put($$$) {
		535	BDB::dbreq_pri 4;
		536	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		537	}
		538
		539	=item cf::cache $id => [$paths...], $processversion => $process
		540
		541	Generic caching function that returns the value of the resource $id,
		542	caching and regenerating as required.
		543
		544	This function can block.
		545
		546	=cut
		547
		548	sub cache {
		549	my ($id, $src, $processversion, $process) = @_;
		550
		551	my $meta =
		552	join "\x00",
		553	$processversion,
		554	map {
		555	aio_stat $_
		556	and Carp::croak "$_: $!";
		557
		558	($_, (stat _)[7,9])
		559	} @$src;
		560
		561	my $dbmeta = db_get cache => "$id/meta";
		562	if ($dbmeta ne $meta) {
		563	# changed, we may need to process
		564
		565	my @data;
		566	my $md5;
		567
		568	for (0 .. $#$src) {
		569	0 <= aio_load $src->[$_], $data[$_]
		570	or Carp::croak "$src->[$_]: $!";
		571	}
		572
		573	# if processing is expensive, check
		574	# checksum first
		575	if (1) {
		576	$md5 =
		577	join "\x00",
		578	$processversion,
		579	map {
		580	Coro::cede;
		581	($src->[$_], Digest::MD5::md5_hex $data[$_])
		582	} 0.. $#$src;
		583
		584
		585	my $dbmd5 = db_get cache => "$id/md5";
		586	if ($dbmd5 eq $md5) {
		587	db_put cache => "$id/meta", $meta;
		588
		589	return db_get cache => "$id/data";
		590	}
		591	}
		592
		593	my $t1 = Time::HiRes::time;
		594	my $data = $process->(\@data);
		595	my $t2 = Time::HiRes::time;
		596
		597	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		598
		599	db_put cache => "$id/data", $data;
		600	db_put cache => "$id/md5" , $md5;
		601	db_put cache => "$id/meta", $meta;
		602
		603	return $data;
		604	}
		605
		606	db_get cache => "$id/data"
431	}	607	}
432		608
433	=item cf::datalog type => key => value, ...	609	=item cf::datalog type => key => value, ...
434		610
435	Log a datalog packet of the given type with the given key-value pairs.	611	Log a datalog packet of the given type with the given key-value pairs.
…		…
453	attach callbacks/event handlers (a collection of which is called an "attachment")	629	attach callbacks/event handlers (a collection of which is called an "attachment")
454	to it. All such attachable objects support the following methods.	630	to it. All such attachable objects support the following methods.
455		631
456	In the following description, CLASS can be any of C<global>, C<object>	632	In the following description, CLASS can be any of C<global>, C<object>
457	C<player>, C<client> or C<map> (i.e. the attachable objects in	633	C<player>, C<client> or C<map> (i.e. the attachable objects in
458	crossfire+).	634	Crossfire TRT).
459		635
460	=over 4	636	=over 4
461		637
462	=item $attachable->attach ($attachment, key => $value...)	638	=item $attachable->attach ($attachment, key => $value...)
463		639
…		…
665	_attach $registry, $klass, @attach;	841	_attach $registry, $klass, @attach;
666	}	842	}
667		843
668	$obj->{$name} = \%arg;	844	$obj->{$name} = \%arg;
669	} else {	845	} else {
670	warn "object uses attachment '$name' that is not available, postponing.\n";	846	warn "object uses attachment '$name' which is not available, postponing.\n";
671	}	847	}
672		848
673	$obj->{_attachment}{$name} = undef;	849	$obj->{_attachment}{$name} = undef;
674	}	850	}
675		851
…		…
715	";	891	";
716	die if $@;	892	die if $@;
717	}	893	}
718		894
719	our $override;	895	our $override;
720	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	896	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
721		897
722	sub override {	898	sub override {
723	$override = 1;	899	$override = 1;
724	@invoke_results = ();	900	@INVOKE_RESULTS = (@_);
725	}	901	}
726		902
727	sub do_invoke {	903	sub do_invoke {
728	my $event = shift;	904	my $event = shift;
729	my $callbacks = shift;	905	my $callbacks = shift;
730		906
731	@invoke_results = ();	907	@INVOKE_RESULTS = ();
732		908
733	local $override;	909	local $override;
734		910
735	for (@$callbacks) {	911	for (@$callbacks) {
736	eval { &{$_->[1]} };	912	eval { &{$_->[1]} };
…		…
753		929
754	Generate an object-specific event with the given arguments.	930	Generate an object-specific event with the given arguments.
755		931
756	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	932	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
757	removed in future versions), and there is no public API to access override	933	removed in future versions), and there is no public API to access override
758	results (if you must, access C<@cf::invoke_results> directly).	934	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
759		935
760	=back	936	=back
761		937
762	=cut	938	=cut
763		939
764	#############################################################################	940	#############################################################################
765	# object support	941	# object support
		942	#
		943
		944	sub _can_merge {
		945	my ($ob1, $ob2) = @_;
		946
		947	local $Storable::canonical = 1;
		948	my $fob1 = Storable::freeze $ob1;
		949	my $fob2 = Storable::freeze $ob2;
		950
		951	$fob1 eq $fob2
		952	}
766		953
767	sub reattach {	954	sub reattach {
768	# basically do the same as instantiate, without calling instantiate	955	# basically do the same as instantiate, without calling instantiate
769	my ($obj) = @_;	956	my ($obj) = @_;
770		957
…		…
877	warn sprintf "loading %s (%d)\n",	1064	warn sprintf "loading %s (%d)\n",
878	$filename, length $data, scalar @{$av || []};	1065	$filename, length $data, scalar @{$av || []};
879	return ($data, $av);	1066	return ($data, $av);
880	}	1067	}
881		1068
		1069	=head2 COMMAND CALLBACKS
		1070
		1071	=over 4
		1072
		1073	=cut
		1074
882	#############################################################################	1075	#############################################################################
883	# command handling &c	1076	# command handling &c
884		1077
885	=item cf::register_command $name => \&callback($ob,$args);	1078	=item cf::register_command $name => \&callback($ob,$args);
886		1079
…		…
898	push @{ $COMMAND{$name} }, [$caller, $cb];	1091	push @{ $COMMAND{$name} }, [$caller, $cb];
899	}	1092	}
900		1093
901	=item cf::register_extcmd $name => \&callback($pl,$packet);	1094	=item cf::register_extcmd $name => \&callback($pl,$packet);
902		1095
903	Register a callbackf ro execution when the client sends an extcmd packet.	1096	Register a callback for execution when the client sends an (synchronous)
		1097	extcmd packet. Ext commands will be processed in the order they are
		1098	received by the server, like other user commands. The first argument is
		1099	the logged-in player. Ext commands can only be processed after a player
		1100	has logged in successfully.
904		1101
905	If the callback returns something, it is sent back as if reply was being	1102	If the callback returns something, it is sent back as if reply was being
906	called.	1103	called.
907		1104
		1105	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1106
		1107	Register a callback for execution when the client sends an (asynchronous)
		1108	exticmd packet. Exti commands are processed by the server as soon as they
		1109	are received, i.e. out of order w.r.t. other commands. The first argument
		1110	is a client socket. Exti commands can be received anytime, even before
		1111	log-in.
		1112
		1113	If the callback returns something, it is sent back as if reply was being
		1114	called.
		1115
908	=cut	1116	=cut
909		1117
910	sub register_extcmd {	1118	sub register_extcmd {
911	my ($name, $cb) = @_;	1119	my ($name, $cb) = @_;
912		1120
913	$EXTCMD{$name} = $cb;	1121	$EXTCMD{$name} = $cb;
		1122	}
		1123
		1124	sub register_exticmd {
		1125	my ($name, $cb) = @_;
		1126
		1127	$EXTICMD{$name} = $cb;
914	}	1128	}
915		1129
916	cf::player->attach (	1130	cf::player->attach (
917	on_command => sub {	1131	on_command => sub {
918	my ($pl, $name, $params) = @_;	1132	my ($pl, $name, $params) = @_;
…		…
927	cf::override;	1141	cf::override;
928	},	1142	},
929	on_extcmd => sub {	1143	on_extcmd => sub {
930	my ($pl, $buf) = @_;	1144	my ($pl, $buf) = @_;
931		1145
932	my $msg = eval { from_json $buf };	1146	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933		1147
934	if (ref $msg) {	1148	if (ref $msg) {
		1149	my ($type, $reply, @payload) =
		1150	"ARRAY" eq ref $msg
		1151	? @$msg
		1152	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1153
		1154	my @reply;
		1155
935	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1156	if (my $cb = $EXTCMD{$type}) {
936	if (my %reply = $cb->($pl, $msg)) {	1157	@reply = $cb->($pl, @payload);
937	$pl->ext_reply ($msg->{msgid}, %reply);
938	}
939	}	1158	}
		1159
		1160	$pl->ext_reply ($reply, @reply)
		1161	if $reply;
		1162
940	} else {	1163	} else {
941	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1164	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
942	}	1165	}
943		1166
944	cf::override;	1167	cf::override;
945	},	1168	},
946	);	1169	);
947		1170
948	sub load_extension {
949	my ($path) = @_;
950
951	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
952	my $base = $1;
953	my $pkg = $1;
954	$pkg =~ s/[^[:word:]]/_/g;
955	$pkg = "ext::$pkg";
956
957	warn "... loading '$path' into '$pkg'\n";
958
959	open my $fh, "<:utf8", $path
960	or die "$path: $!";
961
962	my $source =
963	"package $pkg; use strict; use utf8;\n"
964	. "#line 1 \"$path\"\n{\n"
965	. (do { local $/; <$fh> })
966	. "\n};\n1";
967
968	unless (eval $source) {
969	my $msg = $@ ? "$path: $@\n"
970	: "extension disabled.\n";
971	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
972	warn $@;
973	warn "mandatory extension failed to load, exiting.\n";
974	exit 1;
975	}
976	die $@;
977	}
978
979	push @EXTS, $pkg;
980	}
981
982	sub load_extensions {	1171	sub load_extensions {
		1172	cf::sync_job {
		1173	my %todo;
		1174
983	for my $ext (<$LIBDIR/*.ext>) {	1175	for my $path (<$LIBDIR/*.ext>) {
984	next unless -r $ext;	1176	next unless -r $path;
985	eval {	1177
986	load_extension $ext;	1178	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1179	my $base = $1;
		1180	my $pkg = $1;
		1181	$pkg =~ s/[^[:word:]]/_/g;
		1182	$pkg = "ext::$pkg";
		1183
		1184	open my $fh, "<:utf8", $path
		1185	or die "$path: $!";
		1186
		1187	my $source = do { local $/; <$fh> };
		1188
		1189	my %ext = (
		1190	path => $path,
		1191	base => $base,
		1192	pkg => $pkg,
		1193	);
		1194
		1195	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1196	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1197
		1198	$ext{source} =
		1199	"package $pkg; use strict; use utf8;\n"
		1200	. "#line 1 \"$path\"\n{\n"
		1201	. $source
		1202	. "\n};\n1";
		1203
		1204	$todo{$base} = \%ext;
		1205	}
		1206
		1207	my %done;
		1208	while (%todo) {
		1209	my $progress;
		1210
		1211	while (my ($k, $v) = each %todo) {
		1212	for (split /,\s*/, $v->{meta}{depends}) {
		1213	goto skip
		1214	unless exists $done{$_};
		1215	}
		1216
		1217	warn "... loading '$k' into '$v->{pkg}'\n";
		1218
		1219	unless (eval $v->{source}) {
		1220	my $msg = $@ ? "$v->{path}: $@\n"
		1221	: "$v->{base}: extension inactive.\n";
		1222
		1223	if (exists $v->{meta}{mandatory}) {
		1224	warn $msg;
		1225	warn "mandatory extension failed to load, exiting.\n";
		1226	exit 1;
		1227	}
		1228
		1229	warn $msg;
		1230	}
		1231
		1232	$done{$k} = delete $todo{$k};
		1233	push @EXTS, $v->{pkg};
		1234	$progress = 1;
987	1	1235	}
988	} or warn "$ext not loaded: $@";	1236
		1237	skip:
		1238	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1239	unless $progress;
		1240	}
989	}	1241	};
990	}	1242	}
991		1243
992	#############################################################################	1244	#############################################################################
		1245
		1246	=back
993		1247
994	=head2 CORE EXTENSIONS	1248	=head2 CORE EXTENSIONS
995		1249
996	Functions and methods that extend core crossfire objects.	1250	Functions and methods that extend core crossfire objects.
997		1251
…		…
1084	$cf::PLAYER{$login} = $self;	1338	$cf::PLAYER{$login} = $self;
1085		1339
1086	$self	1340	$self
1087	}	1341	}
1088		1342
		1343	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1344
		1345	=cut
		1346
		1347	sub send_msg {
		1348	my $ns = shift->ns
		1349	or return;
		1350	$ns->send_msg (@_);
		1351	}
		1352
1089	=item $pl->quit_character	1353	=item $pl->quit_character
1090		1354
1091	Nukes the player without looking back. If logged in, the connection will	1355	Nukes the player without looking back. If logged in, the connection will
1092	be destroyed. May block for a long time.	1356	be destroyed. May block for a long time.
1093		1357
…		…
1185	}	1449	}
1186		1450
1187	\@paths	1451	\@paths
1188	}	1452	}
1189		1453
		1454	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1455
		1456	Expand crossfire pod fragments into protocol xml.
		1457
		1458	=cut
		1459
		1460	sub expand_cfpod {
		1461	((my $self), (local $_)) = @_;
		1462
		1463	# escape & and <
		1464	s/&/&amp;/g;
		1465	s/(?<![BIUGH])</&lt;/g;
		1466
		1467	# this is buggy, it needs to properly take care of nested <'s
		1468
		1469	1 while
		1470	# replace B<>, I<>, U<> etc.
		1471	s/B<([^\>]*)>/<b>$1<\/b>/
		1472	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1473	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1474	# replace G<male|female> tags
		1475	|| s{G<([^>|]*)\|([^>]*)>}{
		1476	$self->gender ? $2 : $1
		1477	}ge
		1478	# replace H<hint text>
		1479	|| s{H<([^\>]*)>}
		1480	{
		1481	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1482	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1483	"")
		1484	[$self->{hintmode}]
		1485	}ge;
		1486
		1487	# create single paragraphs (very hackish)
		1488	s/(?<=\S)\n(?=\w)/ /g;
		1489
		1490	# compress some whitespace
		1491	s/\s+\n/\n/g; # ws line-ends
		1492	s/\n\n+/\n/g; # double lines
		1493	s/^\n+//; # beginning lines
		1494	s/\n+$//; # ending lines
		1495
		1496	$_
		1497	}
		1498
		1499	sub hintmode {
		1500	$_[0]{hintmode} = $_[1] if @_ > 1;
		1501	$_[0]{hintmode}
		1502	}
		1503
1190	=item $player->ext_reply ($msgid, %msg)	1504	=item $player->ext_reply ($msgid, @msg)
1191		1505
1192	Sends an ext reply to the player.	1506	Sends an ext reply to the player.
1193		1507
1194	=cut	1508	=cut
1195		1509
1196	sub ext_reply($$%) {	1510	sub ext_reply($$@) {
1197	my ($self, $id, %msg) = @_;	1511	my ($self, $id, @msg) = @_;
1198		1512
1199	$msg{msgid} = $id;	1513	$self->ns->ext_reply ($id, @msg)
1200
1201	$self->send ("ext " . cf::to_json \%msg);
1202	}	1514	}
1203		1515
1204	=item $player->ext_event ($type, %msg)	1516	=item $player->ext_msg ($type, @msg)
1205		1517
1206	Sends an ext event to the client.	1518	Sends an ext event to the client.
1207		1519
1208	=cut	1520	=cut
1209		1521
1210	sub ext_event($$%) {	1522	sub ext_msg($$@) {
1211	my ($self, $type, %msg) = @_;	1523	my ($self, $type, @msg) = @_;
1212		1524
1213	$self->ns->ext_event ($type, %msg);	1525	$self->ns->ext_msg ($type, @msg);
1214	}	1526	}
1215		1527
1216	=head3 cf::region	1528	=head3 cf::region
1217		1529
1218	=over 4	1530	=over 4
…		…
1221		1533
1222	package cf::region;	1534	package cf::region;
1223		1535
1224	=item cf::region::find_by_path $path	1536	=item cf::region::find_by_path $path
1225		1537
1226	Tries to decuce the probable region for a map knowing only its path.	1538	Tries to decuce the likely region for a map knowing only its path.
1227		1539
1228	=cut	1540	=cut
1229		1541
1230	sub find_by_path($) {	1542	sub find_by_path($) {
1231	my ($path) = @_;	1543	my ($path) = @_;
1232		1544
1233	my ($match, $specificity);	1545	my ($match, $specificity);
1234		1546
1235	for my $region (list) {	1547	for my $region (list) {
1236	if ($region->match && $path =~ $region->match) {	1548	if ($region->{match} && $path =~ $region->{match}) {
1237	($match, $specificity) = ($region, $region->specificity)	1549	($match, $specificity) = ($region, $region->specificity)
1238	if $region->specificity > $specificity;	1550	if $region->specificity > $specificity;
1239	}	1551	}
1240	}	1552	}
1241		1553
…		…
1305	my ($self, $merge) = @_;	1617	my ($self, $merge) = @_;
1306		1618
1307	# we have to keep some variables in memory intact	1619	# we have to keep some variables in memory intact
1308	local $self->{path};	1620	local $self->{path};
1309	local $self->{load_path};	1621	local $self->{load_path};
1310	local $self->{deny_save};
1311	local $self->{deny_reset};
1312		1622
1313	$self->SUPER::thawer_merge ($merge);	1623	$self->SUPER::thawer_merge ($merge);
1314	}	1624	}
1315		1625
1316	sub normalise {	1626	sub normalise {
…		…
1363	$self->init; # pass $1 etc.	1673	$self->init; # pass $1 etc.
1364	return $self;	1674	return $self;
1365	}	1675	}
1366	}	1676	}
1367		1677
1368	Carp::carp "unable to resolve path '$path' (base '$base').";	1678	Carp::cluck "unable to resolve path '$path' (base '$base').";
1369	()	1679	()
1370	}	1680	}
1371		1681
1372	sub init {	1682	sub init {
1373	my ($self) = @_;	1683	my ($self) = @_;
…		…
1414	sub change_all_map_light {	1724	sub change_all_map_light {
1415	my ($change) = @_;	1725	my ($change) = @_;
1416		1726
1417	$_->change_map_light ($change)	1727	$_->change_map_light ($change)
1418	for grep $_->outdoor, values %cf::MAP;	1728	for grep $_->outdoor, values %cf::MAP;
		1729	}
		1730
		1731	sub decay_objects {
		1732	my ($self) = @_;
		1733
		1734	return if $self->{deny_reset};
		1735
		1736	$self->do_decay_objects;
1419	}	1737	}
1420		1738
1421	sub unlink_save {	1739	sub unlink_save {
1422	my ($self) = @_;	1740	my ($self) = @_;
1423		1741
…		…
1481	$self->load_header_orig	1799	$self->load_header_orig
1482	or return;	1800	or return;
1483	$self->prepare_orig;	1801	$self->prepare_orig;
1484	}	1802	}
1485		1803
		1804	$self->{deny_reset} = 1
		1805	if $self->no_reset;
		1806
1486	$self->default_region (cf::region::find_by_path $self->{path})	1807	$self->default_region (cf::region::find_by_path $self->{path})
1487	unless $self->default_region;	1808	unless $self->default_region;
1488		1809
1489	1	1810	1
1490	}	1811	}
…		…
1505	$map->{last_save} = $cf::RUNTIME;	1826	$map->{last_save} = $cf::RUNTIME;
1506		1827
1507	$map->load_header	1828	$map->load_header
1508	or return;	1829	or return;
1509		1830
1510	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1831	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1511	# doing this can freeze the server in a sync job, obviously	1832	# doing this can freeze the server in a sync job, obviously
1512	#$cf::WAIT_FOR_TICK->wait;	1833	#$cf::WAIT_FOR_TICK->wait;
1513	$map->reset;	1834	$map->reset;
1514	undef $guard;	1835	undef $guard;
1515	return find $path;	1836	return find $path;
…		…
1570	$self->set_darkness_map;	1891	$self->set_darkness_map;
1571	Coro::cede;	1892	Coro::cede;
1572	$self->activate;	1893	$self->activate;
1573	}	1894	}
1574		1895
		1896	$self->{last_save} = $cf::RUNTIME;
		1897	$self->last_access ($cf::RUNTIME);
		1898
1575	$self->in_memory (cf::MAP_IN_MEMORY);	1899	$self->in_memory (cf::MAP_IN_MEMORY);
1576	}	1900	}
1577		1901
1578	$self->post_load;	1902	$self->post_load;
1579	}	1903	}
…		…
1582	my ($self, $ob) = @_;	1906	my ($self, $ob) = @_;
1583		1907
1584	return find "~" . $ob->name . "/" . $self->{path}	1908	return find "~" . $ob->name . "/" . $self->{path}
1585	if $self->per_player;	1909	if $self->per_player;
1586		1910
		1911	# return find "?party/" . $ob->name . "/" . $self->{path}
		1912	# if $self->per_party;
		1913
1587	$self	1914	$self
1588	}	1915	}
1589		1916
1590	# find and load all maps in the 3x3 area around a map	1917	# find and load all maps in the 3x3 area around a map
1591	sub load_diag {	1918	sub load_neighbours {
1592	my ($map) = @_;	1919	my ($map) = @_;
1593		1920
1594	my @diag; # diagonal neighbours	1921	my @neigh; # diagonal neighbours
1595		1922
1596	for (0 .. 3) {	1923	for (0 .. 3) {
1597	my $neigh = $map->tile_path ($_)	1924	my $neigh = $map->tile_path ($_)
1598	or next;	1925	or next;
1599	$neigh = find $neigh, $map	1926	$neigh = find $neigh, $map
1600	or next;	1927	or next;
1601	$neigh->load;	1928	$neigh->load;
1602		1929
		1930	push @neigh,
1603	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	1931	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1604	[$neigh->tile_path (($_ + 1) % 4), $neigh];	1932	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1605	}	1933	}
1606		1934
1607	for (@diag) {	1935	for (grep defined $_->[0], @neigh) {
		1936	my ($path, $origin) = @$_;
1608	my $neigh = find @$_	1937	my $neigh = find $path, $origin
1609	or next;	1938	or next;
1610	$neigh->load;	1939	$neigh->load;
1611	}	1940	}
1612	}	1941	}
1613		1942
…		…
1637		1966
1638	undef $MAP_PREFETCH{$path};	1967	undef $MAP_PREFETCH{$path};
1639	$MAP_PREFETCHER ||= cf::async {	1968	$MAP_PREFETCHER ||= cf::async {
1640	while (%MAP_PREFETCH) {	1969	while (%MAP_PREFETCH) {
1641	for my $path (keys %MAP_PREFETCH) {	1970	for my $path (keys %MAP_PREFETCH) {
1642	my $map = find $path	1971	if (my $map = find $path) {
1643	or next;
1644	$map->load;	1972	$map->load;
		1973	}
1645		1974
1646	delete $MAP_PREFETCH{$path};	1975	delete $MAP_PREFETCH{$path};
1647	}	1976	}
1648	}	1977	}
1649	undef $MAP_PREFETCHER;	1978	undef $MAP_PREFETCHER;
…		…
1701		2030
1702	sub reset_at {	2031	sub reset_at {
1703	my ($self) = @_;	2032	my ($self) = @_;
1704		2033
1705	# TODO: safety, remove and allow resettable per-player maps	2034	# TODO: safety, remove and allow resettable per-player maps
1706	return 1e99 if $self->isa ("ext::map_per_player");#d#
1707	return 1e99 if $self->{deny_reset};	2035	return 1e99 if $self->{deny_reset};
1708		2036
1709	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2037	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1710	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2038	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1711		2039
…		…
1722	my ($self) = @_;	2050	my ($self) = @_;
1723		2051
1724	my $lock = cf::lock_acquire "map_data:$self->{path}";	2052	my $lock = cf::lock_acquire "map_data:$self->{path}";
1725		2053
1726	return if $self->players;	2054	return if $self->players;
1727	return if $self->isa ("ext::map_per_player");#d#
1728		2055
1729	warn "resetting map ", $self->path;	2056	warn "resetting map ", $self->path;
1730		2057
1731	$self->in_memory (cf::MAP_SWAPPED);	2058	$self->in_memory (cf::MAP_SWAPPED);
1732		2059
…		…
1766	$cf::MAP{$self->path} = $self;	2093	$cf::MAP{$self->path} = $self;
1767		2094
1768	$self->reset; # polite request, might not happen	2095	$self->reset; # polite request, might not happen
1769	}	2096	}
1770		2097
		2098	=item $maps = cf::map::tmp_maps
		2099
		2100	Returns an arrayref with all map paths of currently instantiated and saved
		2101	maps. May block.
		2102
		2103	=cut
		2104
		2105	sub tmp_maps() {
		2106	[
		2107	map {
		2108	utf8::decode $_;
		2109	/\.map$/
		2110	? normalise $_
		2111	: ()
		2112	} @{ aio_readdir $TMPDIR or [] }
		2113	]
		2114	}
		2115
		2116	=item $maps = cf::map::random_maps
		2117
		2118	Returns an arrayref with all map paths of currently instantiated and saved
		2119	random maps. May block.
		2120
		2121	=cut
		2122
		2123	sub random_maps() {
		2124	[
		2125	map {
		2126	utf8::decode $_;
		2127	/\.map$/
		2128	? normalise "?random/$_"
		2129	: ()
		2130	} @{ aio_readdir $RANDOMDIR or [] }
		2131	]
		2132	}
		2133
1771	=item cf::map::unique_maps	2134	=item cf::map::unique_maps
1772		2135
1773	Returns an arrayref of paths of all shared maps that have	2136	Returns an arrayref of paths of all shared maps that have
1774	instantiated unique items. May block.	2137	instantiated unique items. May block.
1775		2138
1776	=cut	2139	=cut
1777		2140
1778	sub unique_maps() {	2141	sub unique_maps() {
1779	my $files = aio_readdir $UNIQUEDIR	2142	[
1780	or return;	2143	map {
1781
1782	my @paths;
1783
1784	for (@$files) {
1785	utf8::decode $_;	2144	utf8::decode $_;
1786	next if /\.pst$/;	2145	/\.map$/
1787	next unless /^$PATH_SEP/o;	2146	? normalise $_
1788		2147	: ()
1789	push @paths, cf::map::normalise $_;	2148	} @{ aio_readdir $UNIQUEDIR or [] }
1790	}	2149	]
1791
1792	\@paths
1793	}	2150	}
1794		2151
1795	package cf;	2152	package cf;
1796		2153
1797	=back	2154	=back
…		…
1843		2200
1844	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2201	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1845		2202
1846	if ($self->{record_replies}) {	2203	if ($self->{record_replies}) {
1847	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2204	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2205
1848	} else {	2206	} else {
		2207	my $pl = $self->contr;
		2208
		2209	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2210	my $dialog = $pl->{npc_dialog};
		2211	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2212
		2213	} else {
1849	$msg = $npc->name . " says: $msg" if $npc;	2214	$msg = $npc->name . " says: $msg" if $npc;
1850	$self->message ($msg, $flags);	2215	$self->message ($msg, $flags);
		2216	}
1851	}	2217	}
		2218	}
		2219
		2220	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2221
		2222	=cut
		2223
		2224	sub cf::object::send_msg {
		2225	my $pl = shift->contr
		2226	or return;
		2227	$pl->send_msg (@_);
1852	}	2228	}
1853		2229
1854	=item $player_object->may ("access")	2230	=item $player_object->may ("access")
1855		2231
1856	Returns wether the given player is authorized to access resource "access"	2232	Returns wether the given player is authorized to access resource "access"
…		…
1935	# use -1 or undef as default coordinates, not 0, 0	2311	# use -1 or undef as default coordinates, not 0, 0
1936	($x, $y) = ($map->enter_x, $map->enter_y)	2312	($x, $y) = ($map->enter_x, $map->enter_y)
1937	if $x <=0 && $y <= 0;	2313	if $x <=0 && $y <= 0;
1938		2314
1939	$map->load;	2315	$map->load;
1940	$map->load_diag;	2316	$map->load_neighbours;
1941		2317
1942	return unless $self->contr->active;	2318	return unless $self->contr->active;
1943	$self->activate_recursive;	2319	$self->activate_recursive;
1944		2320
1945	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2321	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1946	$self->enter_map ($map, $x, $y);	2322	$self->enter_map ($map, $x, $y);
1947	}	2323	}
1948		2324
1949	=item $player_object->goto ($path, $x, $y[, $check->($map)])	2325	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1950		2326
1951	Moves the player to the given map-path and coordinates by first freezing	2327	Moves the player to the given map-path and coordinates by first freezing
1952	her, loading and preparing them map, calling the provided $check callback	2328	her, loading and preparing them map, calling the provided $check callback
1953	that has to return the map if sucecssful, and then unfreezes the player on	2329	that has to return the map if sucecssful, and then unfreezes the player on
1954	the new (success) or old (failed) map position.	2330	the new (success) or old (failed) map position. In either case, $done will
		2331	be called at the end of this process.
1955		2332
1956	=cut	2333	=cut
1957		2334
1958	our $GOTOGEN;	2335	our $GOTOGEN;
1959		2336
1960	sub cf::object::player::goto {	2337	sub cf::object::player::goto {
1961	my ($self, $path, $x, $y, $check) = @_;	2338	my ($self, $path, $x, $y, $check, $done) = @_;
1962		2339
1963	# do generation counting so two concurrent goto's will be executed in-order	2340	# do generation counting so two concurrent goto's will be executed in-order
1964	my $gen = $self->{_goto_generation} = ++$GOTOGEN;	2341	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1965		2342
1966	$self->enter_link;	2343	$self->enter_link;
…		…
1986		2363
1987	if ($gen == $self->{_goto_generation}) {	2364	if ($gen == $self->{_goto_generation}) {
1988	delete $self->{_goto_generation};	2365	delete $self->{_goto_generation};
1989	$self->leave_link ($map, $x, $y);	2366	$self->leave_link ($map, $x, $y);
1990	}	2367	}
		2368
		2369	$done->() if $done;
1991	})->prio (1);	2370	})->prio (1);
1992	}	2371	}
1993		2372
1994	=item $player_object->enter_exit ($exit_object)	2373	=item $player_object->enter_exit ($exit_object)
1995		2374
…		…
2064	my $hp = $exit->stats->hp;	2443	my $hp = $exit->stats->hp;
2065	my $sp = $exit->stats->sp;	2444	my $sp = $exit->stats->sp;
2066		2445
2067	$self->enter_link;	2446	$self->enter_link;
2068		2447
		2448	# if exit is damned, update players death & WoR home-position
		2449	$self->contr->savebed ($slaying, $hp, $sp)
		2450	if $exit->flag (FLAG_DAMNED);
		2451
2069	(async {	2452	(async {
2070	$self->deactivate_recursive; # just to be sure	2453	$self->deactivate_recursive; # just to be sure
2071	unless (eval {	2454	unless (eval {
2072	$self->goto ($slaying, $hp, $sp);	2455	$self->goto ($slaying, $hp, $sp);
2073		2456
…		…
2100		2483
2101	utf8::encode $text;	2484	utf8::encode $text;
2102	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2485	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2103	}	2486	}
2104		2487
		2488	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2489
		2490	Send a drawinfo or msg packet to the client, formatting the msg for the
		2491	client if neccessary. C<$type> should be a string identifying the type of
		2492	the message, with C<log> being the default. If C<$color> is negative, suppress
		2493	the message unless the client supports the msg packet.
		2494
		2495	=cut
		2496
		2497	sub cf::client::send_msg {
		2498	my ($self, $channel, $msg, $color, @extra) = @_;
		2499
		2500	$msg = $self->pl->expand_cfpod ($msg);
		2501
		2502	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2503
		2504	if (ref $channel) {
		2505	# send meta info to client, if not yet sent
		2506	unless (exists $self->{channel}{$channel->{id}}) {
		2507	$self->{channel}{$channel->{id}} = $channel;
		2508	$self->ext_msg (channel_info => $channel);
		2509	}
		2510
		2511	$channel = $channel->{id};
		2512	}
		2513
		2514	return unless @extra || length $msg;
		2515
		2516	if ($self->can_msg) {
		2517	# default colour, mask it out
		2518	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2519	if $color & cf::NDI_DEF;
		2520
		2521	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2522	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2523	} else {
		2524	if ($color >= 0) {
		2525	# replace some tags by gcfclient-compatible ones
		2526	for ($msg) {
		2527	1 while
		2528	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2529	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2530	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2531	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2532	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2533	}
		2534
		2535	$color &= cf::NDI_COLOR_MASK;
		2536
		2537	utf8::encode $msg;
		2538
		2539	if (0 && $msg =~ /\[/) {
		2540	# COMMAND/INFO
		2541	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2542	} else {
		2543	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2544	$self->send_packet ("drawinfo $color $msg")
		2545	}
		2546	}
		2547	}
		2548	}
		2549
2105	=item $client->ext_event ($type, %msg)	2550	=item $client->ext_msg ($type, @msg)
2106		2551
2107	Sends an exti event to the client.	2552	Sends an ext event to the client.
2108		2553
2109	=cut	2554	=cut
2110		2555
2111	sub cf::client::ext_event($$%) {	2556	sub cf::client::ext_msg($$@) {
2112	my ($self, $type, %msg) = @_;	2557	my ($self, $type, @msg) = @_;
2113		2558
		2559	my $extcmd = $self->extcmd;
		2560
		2561	if ($extcmd == 2) {
		2562	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2563	} elsif ($extcmd == 1) { # TODO: remove
2114	$msg{msgtype} = "event_$type";	2564	push @msg, msgtype => "event_$type";
2115	$self->send_packet ("ext " . cf::to_json \%msg);	2565	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2566	}
		2567	}
		2568
		2569	=item $client->ext_reply ($msgid, @msg)
		2570
		2571	Sends an ext reply to the client.
		2572
		2573	=cut
		2574
		2575	sub cf::client::ext_reply($$@) {
		2576	my ($self, $id, @msg) = @_;
		2577
		2578	if ($self->extcmd == 2) {
		2579	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2580	} elsif ($self->ns->extcmd == 1) {
		2581	#TODO: version 1, remove
		2582	unshift @msg, msgtype => "reply", msgid => $id;
		2583	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2584	}
2116	}	2585	}
2117		2586
2118	=item $success = $client->query ($flags, "text", \&cb)	2587	=item $success = $client->query ($flags, "text", \&cb)
2119		2588
2120	Queues a query to the client, calling the given callback with	2589	Queues a query to the client, calling the given callback with
2121	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2590	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2122	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2591	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2123		2592
2124	Queries can fail, so check the return code. Or don't, as queries will become	2593	Queries can fail, so check the return code. Or don't, as queries will
2125	reliable at some point in the future.	2594	become reliable at some point in the future.
2126		2595
2127	=cut	2596	=cut
2128		2597
2129	sub cf::client::query {	2598	sub cf::client::query {
2130	my ($self, $flags, $text, $cb) = @_;	2599	my ($self, $flags, $text, $cb) = @_;
…		…
2138	utf8::encode $text;	2607	utf8::encode $text;
2139	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2608	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2140		2609
2141	$self->send_packet ($self->{query_queue}[0][0])	2610	$self->send_packet ($self->{query_queue}[0][0])
2142	if @{ $self->{query_queue} } == 1;	2611	if @{ $self->{query_queue} } == 1;
		2612
		2613	1
2143	}	2614	}
2144		2615
2145	cf::client->attach (	2616	cf::client->attach (
		2617	on_connect => sub {
		2618	my ($ns) = @_;
		2619
		2620	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2621	},
2146	on_reply => sub {	2622	on_reply => sub {
2147	my ($ns, $msg) = @_;	2623	my ($ns, $msg) = @_;
2148		2624
2149	# this weird shuffling is so that direct followup queries	2625	# this weird shuffling is so that direct followup queries
2150	# get handled first	2626	# get handled first
…		…
2162	} else {	2638	} else {
2163	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2639	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2164	}	2640	}
2165	}	2641	}
2166	},	2642	},
		2643	on_exticmd => sub {
		2644	my ($ns, $buf) = @_;
		2645
		2646	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2647
		2648	if (ref $msg) {
		2649	my ($type, $reply, @payload) =
		2650	"ARRAY" eq ref $msg
		2651	? @$msg
		2652	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2653
		2654	my @reply;
		2655
		2656	if (my $cb = $EXTICMD{$type}) {
		2657	@reply = $cb->($ns, @payload);
		2658	}
		2659
		2660	$ns->ext_reply ($reply, @reply)
		2661	if $reply;
		2662
		2663	} else {
		2664	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2665	}
		2666
		2667	cf::override;
		2668	},
2167	);	2669	);
2168		2670
2169	=item $client->async (\&cb)	2671	=item $client->async (\&cb)
2170		2672
2171	Create a new coroutine, running the specified callback. The coroutine will	2673	Create a new coroutine, running the specified callback. The coroutine will
…		…
2212	our $safe = new Safe "safe";	2714	our $safe = new Safe "safe";
2213	our $safe_hole = new Safe::Hole;	2715	our $safe_hole = new Safe::Hole;
2214		2716
2215	$SIG{FPE} = 'IGNORE';	2717	$SIG{FPE} = 'IGNORE';
2216		2718
2217	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2719	$safe->permit_only (Opcode::opset qw(
		2720	:base_core :base_mem :base_orig :base_math
		2721	grepstart grepwhile mapstart mapwhile
		2722	sort time
		2723	));
2218		2724
2219	# here we export the classes and methods available to script code	2725	# here we export the classes and methods available to script code
2220		2726
2221	=pod	2727	=pod
2222		2728
2223	The following functions and methods are available within a safe environment:	2729	The following functions and methods are available within a safe environment:
2224		2730
2225	cf::object contr pay_amount pay_player map	2731	cf::object
		2732	contr pay_amount pay_player map x y force_find force_add
		2733	insert remove name archname title slaying race
		2734
2226	cf::object::player player	2735	cf::object::player
2227	cf::player peaceful	2736	player
2228	cf::map trigger	2737
		2738	cf::player
		2739	peaceful
		2740
		2741	cf::map
		2742	trigger
2229		2743
2230	=cut	2744	=cut
2231		2745
2232	for (	2746	for (
2233	["cf::object" => qw(contr pay_amount pay_player map)],	2747	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2748	insert remove inv name archname title slaying race)],
2234	["cf::object::player" => qw(player)],	2749	["cf::object::player" => qw(player)],
2235	["cf::player" => qw(peaceful)],	2750	["cf::player" => qw(peaceful)],
2236	["cf::map" => qw(trigger)],	2751	["cf::map" => qw(trigger)],
2237	) {	2752	) {
2238	no strict 'refs';	2753	no strict 'refs';
…		…
2309	=back	2824	=back
2310		2825
2311	=cut	2826	=cut
2312		2827
2313	#############################################################################	2828	#############################################################################
2314
2315	=head2 EXTENSION DATABASE SUPPORT
2316
2317	Crossfire maintains a very simple database for extension use. It can
2318	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2319	convert to/from binary).
2320
2321	The parameter C<$family> should best start with the name of the extension
2322	using it, it should be unique.
2323
2324	=over 4
2325
2326	=item $value = cf::db_get $family => $key
2327
2328	Returns a single value from the database.
2329
2330	=item cf::db_put $family => $key => $value
2331
2332	Stores the given C<$value> in the family.
2333
2334	=cut
2335
2336	our $DB;
2337
2338	sub db_init {
2339	unless ($DB) {
2340	$DB = BDB::db_create $DB_ENV;
2341
2342	cf::sync_job {
2343	eval {
2344	$DB->set_flags (BDB::CHKSUM);
2345
2346	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2347	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2348	cf::cleanup "db_open(db): $!" if $!;
2349	};
2350	cf::cleanup "db_open(db): $@" if $@;
2351	};
2352	}
2353	}
2354
2355	sub db_get($$) {
2356	my $key = "$_[0]/$_[1]";
2357
2358	cf::sync_job {
2359	BDB::db_get $DB, undef, $key, my $data;
2360
2361	$! ? ()
2362	: $data
2363	}
2364	}
2365
2366	sub db_put($$$) {
2367	BDB::dbreq_pri 4;
2368	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2369	}
2370
2371	=item cf::cache $id => [$paths...], $processversion => $process
2372
2373	Generic caching function that returns the value of the resource $id,
2374	caching and regenerating as required.
2375
2376	This function can block.
2377
2378	=cut
2379
2380	sub cache {
2381	my ($id, $src, $processversion, $process) = @_;
2382
2383	my $meta =
2384	join "\x00",
2385	$processversion,
2386	map {
2387	aio_stat $_
2388	and Carp::croak "$_: $!";
2389
2390	($_, (stat _)[7,9])
2391	} @$src;
2392
2393	my $dbmeta = db_get cache => "$id/meta";
2394	if ($dbmeta ne $meta) {
2395	# changed, we may need to process
2396
2397	my @data;
2398	my $md5;
2399
2400	for (0 .. $#$src) {
2401	0 <= aio_load $src->[$_], $data[$_]
2402	or Carp::croak "$src->[$_]: $!";
2403	}
2404
2405	# if processing is expensive, check
2406	# checksum first
2407	if (1) {
2408	$md5 =
2409	join "\x00",
2410	$processversion,
2411	map {
2412	Coro::cede;
2413	($src->[$_], Digest::MD5::md5_hex $data[$_])
2414	} 0.. $#$src;
2415
2416
2417	my $dbmd5 = db_get cache => "$id/md5";
2418	if ($dbmd5 eq $md5) {
2419	db_put cache => "$id/meta", $meta;
2420
2421	return db_get cache => "$id/data";
2422	}
2423	}
2424
2425	my $t1 = Time::HiRes::time;
2426	my $data = $process->(\@data);
2427	my $t2 = Time::HiRes::time;
2428
2429	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2430
2431	db_put cache => "$id/data", $data;
2432	db_put cache => "$id/md5" , $md5;
2433	db_put cache => "$id/meta", $meta;
2434
2435	return $data;
2436	}
2437
2438	db_get cache => "$id/data"
2439	}
2440
2441	=item fork_call { }, $args
2442
2443	Executes the given code block with the given arguments in a seperate
2444	process, returning the results. Everything must be serialisable with
2445	Coro::Storable. May, of course, block. Note that the executed sub may
2446	never block itself or use any form of Event handling.
2447
2448	=cut
2449
2450	sub fork_call(&@) {
2451	my ($cb, @args) = @_;
2452
2453	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2454	# or die "socketpair: $!";
2455	pipe my $fh1, my $fh2
2456	or die "pipe: $!";
2457
2458	if (my $pid = fork) {
2459	close $fh2;
2460
2461	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2462	$res = Coro::Storable::thaw $res;
2463
2464	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2465
2466	die $$res unless "ARRAY" eq ref $res;
2467
2468	return wantarray ? @$res : $res->[-1];
2469	} else {
2470	reset_signals;
2471	local $SIG{__WARN__};
2472	local $SIG{__DIE__};
2473	eval {
2474	close $fh1;
2475
2476	my @res = eval { $cb->(@args) };
2477	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2478	};
2479
2480	warn $@ if $@;
2481	_exit 0;
2482	}
2483	}
2484
2485	#############################################################################
2486	# the server's init and main functions	2829	# the server's init and main functions
2487		2830
2488	sub load_facedata($) {	2831	sub load_facedata($) {
2489	my ($path) = @_;	2832	my ($path) = @_;
		2833
		2834	my $enc = JSON::XS->new->utf8->canonical;
2490		2835
2491	warn "loading facedata from $path\n";	2836	warn "loading facedata from $path\n";
2492		2837
2493	my $facedata;	2838	my $facedata;
2494	0 < aio_load $path, $facedata	2839	0 < aio_load $path, $facedata
…		…
2497	$facedata = Coro::Storable::thaw $facedata;	2842	$facedata = Coro::Storable::thaw $facedata;
2498		2843
2499	$facedata->{version} == 2	2844	$facedata->{version} == 2
2500	or cf::cleanup "$path: version mismatch, cannot proceed.";	2845	or cf::cleanup "$path: version mismatch, cannot proceed.";
2501		2846
		2847	# patch in the exptable
		2848	$facedata->{resource}{"res/exp_table"} = {
		2849	type => FT_RSRC,
		2850	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
		2851	};
		2852	cf::cede_to_tick;
		2853
2502	{	2854	{
2503	my $faces = $facedata->{faceinfo};	2855	my $faces = $facedata->{faceinfo};
2504		2856
2505	while (my ($face, $info) = each %$faces) {	2857	while (my ($face, $info) = each %$faces) {
2506	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2858	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2507	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2859	cf::face::set_visibility $idx, $info->{visibility};
		2860	cf::face::set_magicmap $idx, $info->{magicmap};
2508	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2861	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2509	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	2862	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2510	Coro::cede;	2863
		2864	cf::cede_to_tick;
2511	}	2865	}
2512		2866
2513	while (my ($face, $info) = each %$faces) {	2867	while (my ($face, $info) = each %$faces) {
2514	next unless $info->{smooth};	2868	next unless $info->{smooth};
2515	my $idx = cf::face::find $face	2869	my $idx = cf::face::find $face
2516	or next;	2870	or next;
2517	if (my $smooth = cf::face::find $info->{smooth}) {	2871	if (my $smooth = cf::face::find $info->{smooth}) {
		2872	cf::face::set_smooth $idx, $smooth;
2518	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	2873	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2519	} else {	2874	} else {
2520	warn "smooth face '$info->{smooth}' not found for face '$face'";	2875	warn "smooth face '$info->{smooth}' not found for face '$face'";
2521	}	2876	}
2522	Coro::cede;	2877
		2878	cf::cede_to_tick;
2523	}	2879	}
2524	}	2880	}
2525		2881
2526	{	2882	{
2527	my $anims = $facedata->{animinfo};	2883	my $anims = $facedata->{animinfo};
2528		2884
2529	while (my ($anim, $info) = each %$anims) {	2885	while (my ($anim, $info) = each %$anims) {
2530	cf::anim::set $anim, $info->{frames}, $info->{facings};	2886	cf::anim::set $anim, $info->{frames}, $info->{facings};
2531	Coro::cede;	2887	cf::cede_to_tick;
2532	}	2888	}
2533		2889
2534	cf::anim::invalidate_all; # d'oh	2890	cf::anim::invalidate_all; # d'oh
2535	}	2891	}
2536		2892
		2893	{
		2894	# TODO: for gcfclient pleasure, we should give resources
		2895	# that gcfclient doesn't grok a >10000 face index.
		2896	my $res = $facedata->{resource};
		2897
		2898	my $soundconf = delete $res->{"res/sound.conf"};
		2899
		2900	while (my ($name, $info) = each %$res) {
		2901	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2902	my $data;
		2903
		2904	if ($info->{type} & 1) {
		2905	# prepend meta info
		2906
		2907	my $meta = $enc->encode ({
		2908	name => $name,
		2909	%{ $info->{meta} || {} },
		2910	});
		2911
		2912	$data = pack "(w/a*)*", $meta, $info->{data};
		2913	} else {
		2914	$data = $info->{data};
		2915	}
		2916
		2917	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		2918	cf::face::set_type $idx, $info->{type};
		2919
		2920	cf::cede_to_tick;
		2921	}
		2922
		2923	if ($soundconf) {
		2924	$soundconf = $enc->decode (delete $soundconf->{data});
		2925
		2926	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2927	my $sound = $soundconf->{compat}[$_]
		2928	or next;
		2929
		2930	my $face = cf::face::find "sound/$sound->[1]";
		2931	cf::sound::set $sound->[0] => $face;
		2932	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2933	}
		2934
		2935	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2936	my $face = cf::face::find "sound/$v";
		2937	cf::sound::set $k => $face;
		2938	}
		2939	}
		2940	}
		2941
2537	1	2942	1
2538	}	2943	}
		2944
		2945	register_exticmd fx_want => sub {
		2946	my ($ns, $want) = @_;
		2947
		2948	while (my ($k, $v) = each %$want) {
		2949	$ns->fx_want ($k, $v);
		2950	}
		2951	};
2539		2952
2540	sub reload_regions {	2953	sub reload_regions {
2541	load_resource_file "$MAPDIR/regions"	2954	load_resource_file "$MAPDIR/regions"
2542	or die "unable to load regions file\n";	2955	or die "unable to load regions file\n";
		2956
		2957	for (cf::region::list) {
		2958	$_->{match} = qr/$_->{match}/
		2959	if exists $_->{match};
		2960	}
2543	}	2961	}
2544		2962
2545	sub reload_facedata {	2963	sub reload_facedata {
2546	load_facedata "$DATADIR/facedata"	2964	load_facedata "$DATADIR/facedata"
2547	or die "unable to load facedata\n";	2965	or die "unable to load facedata\n";
2548	}	2966	}
2549		2967
2550	sub reload_archetypes {	2968	sub reload_archetypes {
		2969	load_resource_file "$DATADIR/archetypes"
		2970	or die "unable to load archetypes\n";
		2971	#d# NEED to laod twice to resolve forward references
		2972	# this really needs to be done in an extra post-pass
		2973	# (which needs to be synchronous, so solve it differently)
2551	load_resource_file "$DATADIR/archetypes"	2974	load_resource_file "$DATADIR/archetypes"
2552	or die "unable to load archetypes\n";	2975	or die "unable to load archetypes\n";
2553	}	2976	}
2554		2977
2555	sub reload_treasures {	2978	sub reload_treasures {
…		…
2627	},	3050	},
2628	);	3051	);
2629	}	3052	}
2630	}	3053	}
2631		3054
		3055	sub write_runtime {
		3056	my $runtime = "$LOCALDIR/runtime";
		3057
		3058	# first touch the runtime file to show we are still running:
		3059	# the fsync below can take a very very long time.
		3060
		3061	IO::AIO::aio_utime $runtime, undef, undef;
		3062
		3063	my $guard = cf::lock_acquire "write_runtime";
		3064
		3065	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3066	or return;
		3067
		3068	my $value = $cf::RUNTIME + 90 + 10;
		3069	# 10 is the runtime save interval, for a monotonic clock
		3070	# 60 allows for the watchdog to kill the server.
		3071
		3072	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3073	and return;
		3074
		3075	# always fsync - this file is important
		3076	aio_fsync $fh
		3077	and return;
		3078
		3079	# touch it again to show we are up-to-date
		3080	aio_utime $fh, undef, undef;
		3081
		3082	close $fh
		3083	or return;
		3084
		3085	aio_rename "$runtime~", $runtime
		3086	and return;
		3087
		3088	warn "runtime file written.\n";
		3089
		3090	1
		3091	}
		3092
2632	sub emergency_save() {	3093	sub emergency_save() {
2633	my $freeze_guard = cf::freeze_mainloop;	3094	my $freeze_guard = cf::freeze_mainloop;
2634		3095
2635	warn "enter emergency perl save\n";	3096	warn "enter emergency perl save\n";
2636		3097
…		…
2711	%EXT_CORO = ();	3172	%EXT_CORO = ();
2712		3173
2713	warn "removing commands";	3174	warn "removing commands";
2714	%COMMAND = ();	3175	%COMMAND = ();
2715		3176
2716	warn "removing ext commands";	3177	warn "removing ext/exti commands";
2717	%EXTCMD = ();	3178	%EXTCMD = ();
		3179	%EXTICMD = ();
2718		3180
2719	warn "unloading/nuking all extensions";	3181	warn "unloading/nuking all extensions";
2720	for my $pkg (@EXTS) {	3182	for my $pkg (@EXTS) {
2721	warn "... unloading $pkg";	3183	warn "... unloading $pkg";
2722		3184

Diff Legend

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