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.276 by root, Sun Jun 10 04:05:47 2007 UTC vs.
Revision 1.330 by elmex, Fri Aug 10 10:35:07 2007 UTC

…		…
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		24
		25	use JSON::XS 1.4 ();
25	use BDB ();	26	use BDB ();
26	use Data::Dumper;	27	use Data::Dumper;
27	use Digest::MD5;	28	use Digest::MD5;
28	use Fcntl;	29	use Fcntl;
29	use YAML::Syck ();	30	use YAML::Syck ();
30	use IO::AIO 2.32 ();	31	use IO::AIO 2.32 ();
31	use Time::HiRes;	32	use Time::HiRes;
32	use Compress::LZF;	33	use Compress::LZF;
		34	use Digest::MD5 ();
33		35
34	# configure various modules to our taste	36	# configure various modules to our taste
35	#	37	#
36	$Storable::canonical = 1; # reduce rsync transfers	38	$Storable::canonical = 1; # reduce rsync transfers
37	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator	39	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
…		…
49	our %COMMAND = ();	51	our %COMMAND = ();
50	our %COMMAND_TIME = ();	52	our %COMMAND_TIME = ();
51		53
52	our @EXTS = (); # list of extension package names	54	our @EXTS = (); # list of extension package names
53	our %EXTCMD = ();	55	our %EXTCMD = ();
		56	our %EXTICMD = ();
54	our %EXT_CORO = (); # coroutines bound to extensions	57	our %EXT_CORO = (); # coroutines bound to extensions
55	our %EXT_MAP = (); # pluggable maps	58	our %EXT_MAP = (); # pluggable maps
56		59
57	our $RELOAD; # number of reloads so far	60	our $RELOAD; # number of reloads so far
58	our @EVENT;	61	our @EVENT;
…		…
164		167
165	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only	168	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	169	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.	170	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
168		171
		172	=item @cf::INVOKE_RESULTS
		173
		174	This array contains the results of the last C<invoke ()> call. When
		175	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		176	that call.
		177
169	=back	178	=back
170		179
171	=cut	180	=cut
172		181
173	BEGIN {	182	BEGIN {
…		…
206	}	215	}
207		216
208	$Event::DIED = sub {	217	$Event::DIED = sub {
209	warn "error in event callback: @_";	218	warn "error in event callback: @_";
210	};	219	};
		220
		221	#############################################################################
211		222
212	=head2 UTILITY FUNCTIONS	223	=head2 UTILITY FUNCTIONS
213		224
214	=over 4	225	=over 4
215		226
…		…
234	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	245	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
235	$d	246	$d
236	} || "[unable to dump $_[0]: '$@']";	247	} || "[unable to dump $_[0]: '$@']";
237	}	248	}
238		249
239	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
240
241	=item $ref = cf::from_json $json	250	=item $ref = cf::from_json $json
242		251
243	Converts a JSON string into the corresponding perl data structure.	252	Converts a JSON string into the corresponding perl data structure.
244		253
245	=item $json = cf::to_json $ref	254	=item $json = cf::to_json $ref
246		255
247	Converts a perl data structure into its JSON representation.	256	Converts a perl data structure into its JSON representation.
		257
		258	=cut
		259
		260	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
		261
		262	sub to_json ($) { $json_coder->encode ($_[0]) }
		263	sub from_json ($) { $json_coder->decode ($_[0]) }
248		264
249	=item cf::lock_wait $string	265	=item cf::lock_wait $string
250		266
251	Wait until the given lock is available. See cf::lock_acquire.	267	Wait until the given lock is available. See cf::lock_acquire.
252		268
…		…
306	};	322	};
307	$TICK_WATCHER->stop;	323	$TICK_WATCHER->stop;
308	$guard	324	$guard
309	}	325	}
310		326
		327	=item cf::get_slot $time[, $priority[, $name]]
		328
		329	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		330	This call blocks and returns only when you have at least C<$time> seconds
		331	of cpu time till the next tick. The slot is only valid till the next cede.
		332
		333	The optional C<$name> can be used to identify the job to run. It might be
		334	used for statistical purposes and should identify the same time-class.
		335
		336	Useful for short background jobs.
		337
		338	=cut
		339
		340	our @SLOT_QUEUE;
		341	our $SLOT_QUEUE;
		342
		343	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		344	$SLOT_QUEUE = Coro::async {
		345	my $signal = new Coro::Signal;
		346
		347	while () {
		348	next_job:
		349	my $avail = cf::till_tick;
		350	if ($avail > 0.01) {
		351	for (0 .. $#SLOT_QUEUE) {
		352	if ($SLOT_QUEUE[$_][0] < $avail) {
		353	my $job = splice @SLOT_QUEUE, $_, 1, ();
		354	$job->[2]->send;
		355	Coro::cede;
		356	goto next_job;
		357	}
		358	}
		359	}
		360
		361	if (@SLOT_QUEUE) {
		362	# we do not use wait_For_tick() as it returns immediately when tick is inactive
		363	push @cf::WAIT_FOR_TICK, $signal;
		364	$signal->wait;
		365	} else {
		366	Coro::schedule;
		367	}
		368	}
		369	};
		370
		371	sub get_slot($;$$) {
		372	my ($time, $pri, $name) = @_;
		373
		374	$time = $TICK * .6 if $time > $TICK * .6;
		375	my $sig = new Coro::Signal;
		376
		377	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		378	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		379	$SLOT_QUEUE->ready;
		380	$sig->wait;
		381	}
		382
311	=item cf::async { BLOCK }	383	=item cf::async { BLOCK }
312		384
313	Currently the same as Coro::async_pool, meaning you cannot use	385	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	386	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.	387	thing you are allowed to do is call C<prio> on it.
…		…
318		390
319	BEGIN { *async = \&Coro::async_pool }	391	BEGIN { *async = \&Coro::async_pool }
320		392
321	=item cf::sync_job { BLOCK }	393	=item cf::sync_job { BLOCK }
322		394
323	The design of crossfire+ requires that the main coro ($Coro::main) is	395	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	396	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.	397	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		398	acceptable.
326		399
327	If it must be done, put the blocking parts into C<sync_job>. This will run	400	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	401	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	402	server will be frozen during this time, so the block should either finish
330	fast or be very important.	403	fast or be very important.
…		…
390	$EXT_CORO{$coro+0} = $coro;	463	$EXT_CORO{$coro+0} = $coro;
391		464
392	$coro	465	$coro
393	}	466	}
394		467
395	sub write_runtime {	468	=item fork_call { }, $args
396	my $runtime = "$LOCALDIR/runtime";
397		469
398	# first touch the runtime file to show we are still running:	470	Executes the given code block with the given arguments in a seperate
399	# the fsync below can take a very very long time.	471	process, returning the results. Everything must be serialisable with
		472	Coro::Storable. May, of course, block. Note that the executed sub may
		473	never block itself or use any form of Event handling.
400		474
401	IO::AIO::aio_utime $runtime, undef, undef;	475	=cut
402		476
403	my $guard = cf::lock_acquire "write_runtime";	477	sub _store_scalar {
404		478	open my $fh, ">", \my $buf
405	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	479	or die "fork_call: cannot open fh-to-buf in child : $!";
406	or return;	480	Storable::store_fd $_[0], $fh;
407
408	my $value = $cf::RUNTIME + 90 + 10;
409	# 10 is the runtime save interval, for a monotonic clock
410	# 60 allows for the watchdog to kill the server.
411
412	(aio_write $fh, 0, (length $value), $value, 0) <= 0
413	and return;
414
415	# always fsync - this file is important
416	aio_fsync $fh
417	and return;
418
419	# touch it again to show we are up-to-date
420	aio_utime $fh, undef, undef;
421
422	close $fh	481	close $fh;
423	or return;
424		482
425	aio_rename "$runtime~", $runtime	483	$buf
426	and return;	484	}
427		485
428	warn "runtime file written.\n";	486	sub fork_call(&@) {
		487	my ($cb, @args) = @_;
429		488
		489	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
		490	# or die "socketpair: $!";
		491	pipe my $fh1, my $fh2
		492	or die "pipe: $!";
		493
		494	if (my $pid = fork) {
		495	close $fh2;
		496
		497	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
		498	warn "pst<$res>" unless $res =~ /^pst/;
		499	$res = Coro::Storable::thaw $res;
		500
		501	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		502
		503	Carp::confess $$res unless "ARRAY" eq ref $res;
		504
		505	return wantarray ? @$res : $res->[-1];
		506	} else {
		507	reset_signals;
		508	local $SIG{__WARN__};
		509	local $SIG{__DIE__};
		510	# just in case, this hack effectively disables event
		511	# in the child. cleaner and slower would be canceling all watchers,
		512	# but this works for the time being.
		513	local $Coro::idle;
		514	$Coro::current->prio (Coro::PRIO_MAX);
		515
		516	eval {
		517	close $fh1;
		518
		519	my @res = eval { $cb->(@args) };
		520
		521	syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
		522	close $fh2;
		523	};
		524
		525	warn $@ if $@;
		526	_exit 0;
430	1	527	}
		528	}
		529
		530	=item $value = cf::db_get $family => $key
		531
		532	Returns a single value from the environment database.
		533
		534	=item cf::db_put $family => $key => $value
		535
		536	Stores the given C<$value> in the family. It can currently store binary
		537	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		538
		539	=cut
		540
		541	our $DB;
		542
		543	sub db_init {
		544	unless ($DB) {
		545	$DB = BDB::db_create $DB_ENV;
		546
		547	cf::sync_job {
		548	eval {
		549	$DB->set_flags (BDB::CHKSUM);
		550
		551	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		552	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		553	cf::cleanup "db_open(db): $!" if $!;
		554	};
		555	cf::cleanup "db_open(db): $@" if $@;
		556	};
		557	}
		558	}
		559
		560	sub db_get($$) {
		561	my $key = "$_[0]/$_[1]";
		562
		563	cf::sync_job {
		564	BDB::db_get $DB, undef, $key, my $data;
		565
		566	$! ? ()
		567	: $data
		568	}
		569	}
		570
		571	sub db_put($$$) {
		572	BDB::dbreq_pri 4;
		573	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		574	}
		575
		576	=item cf::cache $id => [$paths...], $processversion => $process
		577
		578	Generic caching function that returns the value of the resource $id,
		579	caching and regenerating as required.
		580
		581	This function can block.
		582
		583	=cut
		584
		585	sub cache {
		586	my ($id, $src, $processversion, $process) = @_;
		587
		588	my $meta =
		589	join "\x00",
		590	$processversion,
		591	map {
		592	aio_stat $_
		593	and Carp::croak "$_: $!";
		594
		595	($_, (stat _)[7,9])
		596	} @$src;
		597
		598	my $dbmeta = db_get cache => "$id/meta";
		599	if ($dbmeta ne $meta) {
		600	# changed, we may need to process
		601
		602	my @data;
		603	my $md5;
		604
		605	for (0 .. $#$src) {
		606	0 <= aio_load $src->[$_], $data[$_]
		607	or Carp::croak "$src->[$_]: $!";
		608	}
		609
		610	# if processing is expensive, check
		611	# checksum first
		612	if (1) {
		613	$md5 =
		614	join "\x00",
		615	$processversion,
		616	map {
		617	Coro::cede;
		618	($src->[$_], Digest::MD5::md5_hex $data[$_])
		619	} 0.. $#$src;
		620
		621
		622	my $dbmd5 = db_get cache => "$id/md5";
		623	if ($dbmd5 eq $md5) {
		624	db_put cache => "$id/meta", $meta;
		625
		626	return db_get cache => "$id/data";
		627	}
		628	}
		629
		630	my $t1 = Time::HiRes::time;
		631	my $data = $process->(\@data);
		632	my $t2 = Time::HiRes::time;
		633
		634	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		635
		636	db_put cache => "$id/data", $data;
		637	db_put cache => "$id/md5" , $md5;
		638	db_put cache => "$id/meta", $meta;
		639
		640	return $data;
		641	}
		642
		643	db_get cache => "$id/data"
431	}	644	}
432		645
433	=item cf::datalog type => key => value, ...	646	=item cf::datalog type => key => value, ...
434		647
435	Log a datalog packet of the given type with the given key-value pairs.	648	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")	666	attach callbacks/event handlers (a collection of which is called an "attachment")
454	to it. All such attachable objects support the following methods.	667	to it. All such attachable objects support the following methods.
455		668
456	In the following description, CLASS can be any of C<global>, C<object>	669	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	670	C<player>, C<client> or C<map> (i.e. the attachable objects in
458	crossfire+).	671	Crossfire TRT).
459		672
460	=over 4	673	=over 4
461		674
462	=item $attachable->attach ($attachment, key => $value...)	675	=item $attachable->attach ($attachment, key => $value...)
463		676
…		…
665	_attach $registry, $klass, @attach;	878	_attach $registry, $klass, @attach;
666	}	879	}
667		880
668	$obj->{$name} = \%arg;	881	$obj->{$name} = \%arg;
669	} else {	882	} else {
670	warn "object uses attachment '$name' that is not available, postponing.\n";	883	warn "object uses attachment '$name' which is not available, postponing.\n";
671	}	884	}
672		885
673	$obj->{_attachment}{$name} = undef;	886	$obj->{_attachment}{$name} = undef;
674	}	887	}
675		888
…		…
715	";	928	";
716	die if $@;	929	die if $@;
717	}	930	}
718		931
719	our $override;	932	our $override;
720	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	933	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
721		934
722	sub override {	935	sub override {
723	$override = 1;	936	$override = 1;
724	@invoke_results = ();	937	@INVOKE_RESULTS = (@_);
725	}	938	}
726		939
727	sub do_invoke {	940	sub do_invoke {
728	my $event = shift;	941	my $event = shift;
729	my $callbacks = shift;	942	my $callbacks = shift;
730		943
731	@invoke_results = ();	944	@INVOKE_RESULTS = ();
732		945
733	local $override;	946	local $override;
734		947
735	for (@$callbacks) {	948	for (@$callbacks) {
736	eval { &{$_->[1]} };	949	eval { &{$_->[1]} };
…		…
753		966
754	Generate an object-specific event with the given arguments.	967	Generate an object-specific event with the given arguments.
755		968
756	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	969	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	970	removed in future versions), and there is no public API to access override
758	results (if you must, access C<@cf::invoke_results> directly).	971	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
759		972
760	=back	973	=back
761		974
762	=cut	975	=cut
763		976
764	#############################################################################	977	#############################################################################
765	# object support	978	# object support
		979	#
		980
		981	sub _can_merge {
		982	my ($ob1, $ob2) = @_;
		983
		984	local $Storable::canonical = 1;
		985	my $fob1 = Storable::freeze $ob1;
		986	my $fob2 = Storable::freeze $ob2;
		987
		988	$fob1 eq $fob2
		989	}
766		990
767	sub reattach {	991	sub reattach {
768	# basically do the same as instantiate, without calling instantiate	992	# basically do the same as instantiate, without calling instantiate
769	my ($obj) = @_;	993	my ($obj) = @_;
770		994
…		…
877	warn sprintf "loading %s (%d)\n",	1101	warn sprintf "loading %s (%d)\n",
878	$filename, length $data, scalar @{$av || []};	1102	$filename, length $data, scalar @{$av || []};
879	return ($data, $av);	1103	return ($data, $av);
880	}	1104	}
881		1105
		1106	=head2 COMMAND CALLBACKS
		1107
		1108	=over 4
		1109
		1110	=cut
		1111
882	#############################################################################	1112	#############################################################################
883	# command handling &c	1113	# command handling &c
884		1114
885	=item cf::register_command $name => \&callback($ob,$args);	1115	=item cf::register_command $name => \&callback($ob,$args);
886		1116
…		…
898	push @{ $COMMAND{$name} }, [$caller, $cb];	1128	push @{ $COMMAND{$name} }, [$caller, $cb];
899	}	1129	}
900		1130
901	=item cf::register_extcmd $name => \&callback($pl,$packet);	1131	=item cf::register_extcmd $name => \&callback($pl,$packet);
902		1132
903	Register a callbackf ro execution when the client sends an extcmd packet.	1133	Register a callback for execution when the client sends an (synchronous)
		1134	extcmd packet. Ext commands will be processed in the order they are
		1135	received by the server, like other user commands. The first argument is
		1136	the logged-in player. Ext commands can only be processed after a player
		1137	has logged in successfully.
904		1138
905	If the callback returns something, it is sent back as if reply was being	1139	If the callback returns something, it is sent back as if reply was being
906	called.	1140	called.
907		1141
		1142	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1143
		1144	Register a callback for execution when the client sends an (asynchronous)
		1145	exticmd packet. Exti commands are processed by the server as soon as they
		1146	are received, i.e. out of order w.r.t. other commands. The first argument
		1147	is a client socket. Exti commands can be received anytime, even before
		1148	log-in.
		1149
		1150	If the callback returns something, it is sent back as if reply was being
		1151	called.
		1152
908	=cut	1153	=cut
909		1154
910	sub register_extcmd {	1155	sub register_extcmd {
911	my ($name, $cb) = @_;	1156	my ($name, $cb) = @_;
912		1157
913	$EXTCMD{$name} = $cb;	1158	$EXTCMD{$name} = $cb;
		1159	}
		1160
		1161	sub register_exticmd {
		1162	my ($name, $cb) = @_;
		1163
		1164	$EXTICMD{$name} = $cb;
914	}	1165	}
915		1166
916	cf::player->attach (	1167	cf::player->attach (
917	on_command => sub {	1168	on_command => sub {
918	my ($pl, $name, $params) = @_;	1169	my ($pl, $name, $params) = @_;
…		…
927	cf::override;	1178	cf::override;
928	},	1179	},
929	on_extcmd => sub {	1180	on_extcmd => sub {
930	my ($pl, $buf) = @_;	1181	my ($pl, $buf) = @_;
931		1182
932	my $msg = eval { from_json $buf };	1183	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933		1184
934	if (ref $msg) {	1185	if (ref $msg) {
		1186	my ($type, $reply, @payload) =
		1187	"ARRAY" eq ref $msg
		1188	? @$msg
		1189	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1190
935	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1191	if (my $cb = $EXTCMD{$type}) {
936	if (my %reply = $cb->($pl, $msg)) {	1192	my @reply = $cb->($pl, @payload);
		1193
937	$pl->ext_reply ($msg->{msgid}, %reply);	1194	$pl->ext_reply ($reply, @reply)
938	}	1195	if $reply;
939	}	1196	}
940	} else {	1197	} else {
941	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1198	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
942	}	1199	}
943		1200
944	cf::override;	1201	cf::override;
945	},	1202	},
946	);	1203	);
947		1204
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 {	1205	sub load_extensions {
		1206	cf::sync_job {
		1207	my %todo;
		1208
983	for my $ext (<$LIBDIR/*.ext>) {	1209	for my $path (<$LIBDIR/*.ext>) {
984	next unless -r $ext;	1210	next unless -r $path;
985	eval {	1211
986	load_extension $ext;	1212	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1213	my $base = $1;
		1214	my $pkg = $1;
		1215	$pkg =~ s/[^[:word:]]/_/g;
		1216	$pkg = "ext::$pkg";
		1217
		1218	open my $fh, "<:utf8", $path
		1219	or die "$path: $!";
		1220
		1221	my $source = do { local $/; <$fh> };
		1222
		1223	my %ext = (
		1224	path => $path,
		1225	base => $base,
		1226	pkg => $pkg,
		1227	);
		1228
		1229	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1230	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1231
		1232	$ext{source} =
		1233	"package $pkg; use strict; use utf8;\n"
		1234	. "#line 1 \"$path\"\n{\n"
		1235	. $source
		1236	. "\n};\n1";
		1237
		1238	$todo{$base} = \%ext;
		1239	}
		1240
		1241	my %done;
		1242	while (%todo) {
		1243	my $progress;
		1244
		1245	while (my ($k, $v) = each %todo) {
		1246	for (split /,\s*/, $v->{meta}{depends}) {
		1247	goto skip
		1248	unless exists $done{$_};
		1249	}
		1250
		1251	warn "... loading '$k' into '$v->{pkg}'\n";
		1252
		1253	unless (eval $v->{source}) {
		1254	my $msg = $@ ? "$v->{path}: $@\n"
		1255	: "$v->{base}: extension inactive.\n";
		1256
		1257	if (exists $v->{meta}{mandatory}) {
		1258	warn $msg;
		1259	warn "mandatory extension failed to load, exiting.\n";
		1260	exit 1;
		1261	}
		1262
		1263	warn $msg;
		1264	}
		1265
		1266	$done{$k} = delete $todo{$k};
		1267	push @EXTS, $v->{pkg};
		1268	$progress = 1;
987	1	1269	}
988	} or warn "$ext not loaded: $@";	1270
		1271	skip:
		1272	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1273	unless $progress;
		1274	}
989	}	1275	};
990	}	1276	}
991		1277
992	#############################################################################	1278	#############################################################################
		1279
		1280	=back
993		1281
994	=head2 CORE EXTENSIONS	1282	=head2 CORE EXTENSIONS
995		1283
996	Functions and methods that extend core crossfire objects.	1284	Functions and methods that extend core crossfire objects.
997		1285
…		…
1084	$cf::PLAYER{$login} = $self;	1372	$cf::PLAYER{$login} = $self;
1085		1373
1086	$self	1374	$self
1087	}	1375	}
1088		1376
		1377	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1378
		1379	=cut
		1380
		1381	sub send_msg {
		1382	my $ns = shift->ns
		1383	or return;
		1384	$ns->send_msg (@_);
		1385	}
		1386
1089	=item $pl->quit_character	1387	=item $pl->quit_character
1090		1388
1091	Nukes the player without looking back. If logged in, the connection will	1389	Nukes the player without looking back. If logged in, the connection will
1092	be destroyed. May block for a long time.	1390	be destroyed. May block for a long time.
1093		1391
…		…
1185	}	1483	}
1186		1484
1187	\@paths	1485	\@paths
1188	}	1486	}
1189		1487
		1488	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1489
		1490	Expand crossfire pod fragments into protocol xml.
		1491
		1492	=cut
		1493
		1494	sub expand_cfpod {
		1495	((my $self), (local $_)) = @_;
		1496
		1497	# escape & and <
		1498	s/&/&amp;/g;
		1499	s/(?<![BIUGH])</&lt;/g;
		1500
		1501	# this is buggy, it needs to properly take care of nested <'s
		1502
		1503	1 while
		1504	# replace B<>, I<>, U<> etc.
		1505	s/B<([^\>]*)>/<b>$1<\/b>/
		1506	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1507	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1508	# replace G<male|female> tags
		1509	|| s{G<([^>|]*)\|([^>]*)>}{
		1510	$self->gender ? $2 : $1
		1511	}ge
		1512	# replace H<hint text>
		1513	|| s{H<([^\>]*)>}
		1514	{
		1515	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1516	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1517	"")
		1518	[$self->{hintmode}]
		1519	}ge;
		1520
		1521	# create single paragraphs (very hackish)
		1522	s/(?<=\S)\n(?=\w)/ /g;
		1523
		1524	# compress some whitespace
		1525	s/\s+\n/\n/g; # ws line-ends
		1526	s/\n\n+/\n/g; # double lines
		1527	s/^\n+//; # beginning lines
		1528	s/\n+$//; # ending lines
		1529
		1530	$_
		1531	}
		1532
		1533	sub hintmode {
		1534	$_[0]{hintmode} = $_[1] if @_ > 1;
		1535	$_[0]{hintmode}
		1536	}
		1537
1190	=item $player->ext_reply ($msgid, %msg)	1538	=item $player->ext_reply ($msgid, @msg)
1191		1539
1192	Sends an ext reply to the player.	1540	Sends an ext reply to the player.
1193		1541
1194	=cut	1542	=cut
1195		1543
1196	sub ext_reply($$%) {	1544	sub ext_reply($$@) {
1197	my ($self, $id, %msg) = @_;	1545	my ($self, $id, @msg) = @_;
1198		1546
1199	$msg{msgid} = $id;	1547	if ($self->ns->extcmd == 2) {
1200		1548	$self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1201	$self->send ("ext " . cf::to_json \%msg);	1549	} elsif ($self->ns->extcmd == 1) {
		1550	#TODO: version 1, remove
		1551	unshift @msg, msgtype => "reply", msgid => $id;
		1552	$self->send ("ext " . $self->ns->{json_coder}->encode ({@msg}));
		1553	}
1202	}	1554	}
1203		1555
1204	=item $player->ext_event ($type, %msg)	1556	=item $player->ext_msg ($type, @msg)
1205		1557
1206	Sends an ext event to the client.	1558	Sends an ext event to the client.
1207		1559
1208	=cut	1560	=cut
1209		1561
1210	sub ext_event($$%) {	1562	sub ext_msg($$@) {
1211	my ($self, $type, %msg) = @_;	1563	my ($self, $type, @msg) = @_;
1212		1564
1213	$self->ns->ext_event ($type, %msg);	1565	$self->ns->ext_msg ($type, @msg);
1214	}	1566	}
1215		1567
1216	=head3 cf::region	1568	=head3 cf::region
1217		1569
1218	=over 4	1570	=over 4
…		…
1221		1573
1222	package cf::region;	1574	package cf::region;
1223		1575
1224	=item cf::region::find_by_path $path	1576	=item cf::region::find_by_path $path
1225		1577
1226	Tries to decuce the probable region for a map knowing only its path.	1578	Tries to decuce the likely region for a map knowing only its path.
1227		1579
1228	=cut	1580	=cut
1229		1581
1230	sub find_by_path($) {	1582	sub find_by_path($) {
1231	my ($path) = @_;	1583	my ($path) = @_;
1232		1584
1233	my ($match, $specificity);	1585	my ($match, $specificity);
1234		1586
1235	for my $region (list) {	1587	for my $region (list) {
1236	if ($region->match && $path =~ $region->match) {	1588	if ($region->{match} && $path =~ $region->{match}) {
1237	($match, $specificity) = ($region, $region->specificity)	1589	($match, $specificity) = ($region, $region->specificity)
1238	if $region->specificity > $specificity;	1590	if $region->specificity > $specificity;
1239	}	1591	}
1240	}	1592	}
1241		1593
…		…
1361	$self->init; # pass $1 etc.	1713	$self->init; # pass $1 etc.
1362	return $self;	1714	return $self;
1363	}	1715	}
1364	}	1716	}
1365		1717
1366	Carp::carp "unable to resolve path '$path' (base '$base').";	1718	Carp::cluck "unable to resolve path '$path' (base '$base').";
1367	()	1719	()
1368	}	1720	}
1369		1721
1370	sub init {	1722	sub init {
1371	my ($self) = @_;	1723	my ($self) = @_;
…		…
1579	$self->set_darkness_map;	1931	$self->set_darkness_map;
1580	Coro::cede;	1932	Coro::cede;
1581	$self->activate;	1933	$self->activate;
1582	}	1934	}
1583		1935
		1936	$self->{last_save} = $cf::RUNTIME;
		1937	$self->last_access ($cf::RUNTIME);
		1938
1584	$self->in_memory (cf::MAP_IN_MEMORY);	1939	$self->in_memory (cf::MAP_IN_MEMORY);
1585	}	1940	}
1586		1941
1587	$self->post_load;	1942	$self->post_load;
1588	}	1943	}
…		…
1649		2004
1650	undef $MAP_PREFETCH{$path};	2005	undef $MAP_PREFETCH{$path};
1651	$MAP_PREFETCHER ||= cf::async {	2006	$MAP_PREFETCHER ||= cf::async {
1652	while (%MAP_PREFETCH) {	2007	while (%MAP_PREFETCH) {
1653	for my $path (keys %MAP_PREFETCH) {	2008	for my $path (keys %MAP_PREFETCH) {
1654	my $map = find $path	2009	if (my $map = find $path) {
1655	or next;
1656	$map->load;	2010	$map->load;
		2011	}
1657		2012
1658	delete $MAP_PREFETCH{$path};	2013	delete $MAP_PREFETCH{$path};
1659	}	2014	}
1660	}	2015	}
1661	undef $MAP_PREFETCHER;	2016	undef $MAP_PREFETCHER;
…		…
1779	}	2134	}
1780		2135
1781	=item $maps = cf::map::tmp_maps	2136	=item $maps = cf::map::tmp_maps
1782		2137
1783	Returns an arrayref with all map paths of currently instantiated and saved	2138	Returns an arrayref with all map paths of currently instantiated and saved
1784	maps.	2139	maps. May block.
1785		2140
1786	=cut	2141	=cut
1787		2142
1788	sub tmp_maps() {	2143	sub tmp_maps() {
1789	[	2144	[
1790	map {	2145	map {
1791	utf8::decode $_;	2146	utf8::decode $_;
1792	!/\.(?:pst|meta)$/ && /^$PATH_SEP/o	2147	/\.map$/
1793	? normalise $_	2148	? normalise $_
1794	: ()	2149	: ()
1795	} @{ aio_readdir $TMPDIR or [] }	2150	} @{ aio_readdir $TMPDIR or [] }
1796	]	2151	]
1797	}	2152	}
1798		2153
		2154	=item $maps = cf::map::random_maps
		2155
		2156	Returns an arrayref with all map paths of currently instantiated and saved
		2157	random maps. May block.
		2158
		2159	=cut
		2160
		2161	sub random_maps() {
		2162	[
		2163	map {
		2164	utf8::decode $_;
		2165	/\.map$/
		2166	? normalise "?random/$_"
		2167	: ()
		2168	} @{ aio_readdir $RANDOMDIR or [] }
		2169	]
		2170	}
		2171
1799	=item cf::map::unique_maps	2172	=item cf::map::unique_maps
1800		2173
1801	Returns an arrayref of paths of all shared maps that have	2174	Returns an arrayref of paths of all shared maps that have
1802	instantiated unique items. May block.	2175	instantiated unique items. May block.
1803		2176
…		…
1805		2178
1806	sub unique_maps() {	2179	sub unique_maps() {
1807	[	2180	[
1808	map {	2181	map {
1809	utf8::decode $_;	2182	utf8::decode $_;
1810	!/\.(?:pst|meta)$/ && /^$PATH_SEP/o	2183	/\.map$/
1811	? normalise $_	2184	? normalise $_
1812	: ()	2185	: ()
1813	} @{ aio_readdir $UNIQUEDIR or [] }	2186	} @{ aio_readdir $UNIQUEDIR or [] }
1814	]	2187	]
1815	}	2188	}
…		…
1865		2238
1866	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2239	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1867		2240
1868	if ($self->{record_replies}) {	2241	if ($self->{record_replies}) {
1869	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2242	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2243
1870	} else {	2244	} else {
		2245	my $pl = $self->contr;
		2246
		2247	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2248	my $dialog = $pl->{npc_dialog};
		2249	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2250
		2251	} else {
1871	$msg = $npc->name . " says: $msg" if $npc;	2252	$msg = $npc->name . " says: $msg" if $npc;
1872	$self->message ($msg, $flags);	2253	$self->message ($msg, $flags);
		2254	}
1873	}	2255	}
		2256	}
		2257
		2258	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2259
		2260	=cut
		2261
		2262	sub cf::object::send_msg {
		2263	my $pl = shift->contr
		2264	or return;
		2265	$pl->send_msg (@_);
1874	}	2266	}
1875		2267
1876	=item $player_object->may ("access")	2268	=item $player_object->may ("access")
1877		2269
1878	Returns wether the given player is authorized to access resource "access"	2270	Returns wether the given player is authorized to access resource "access"
…		…
1966		2358
1967	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2359	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1968	$self->enter_map ($map, $x, $y);	2360	$self->enter_map ($map, $x, $y);
1969	}	2361	}
1970		2362
1971	=item $player_object->goto ($path, $x, $y[, $check->($map)])	2363	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1972		2364
1973	Moves the player to the given map-path and coordinates by first freezing	2365	Moves the player to the given map-path and coordinates by first freezing
1974	her, loading and preparing them map, calling the provided $check callback	2366	her, loading and preparing them map, calling the provided $check callback
1975	that has to return the map if sucecssful, and then unfreezes the player on	2367	that has to return the map if sucecssful, and then unfreezes the player on
1976	the new (success) or old (failed) map position.	2368	the new (success) or old (failed) map position. In either case, $done will
		2369	be called at the end of this process.
1977		2370
1978	=cut	2371	=cut
1979		2372
1980	our $GOTOGEN;	2373	our $GOTOGEN;
1981		2374
1982	sub cf::object::player::goto {	2375	sub cf::object::player::goto {
1983	my ($self, $path, $x, $y, $check) = @_;	2376	my ($self, $path, $x, $y, $check, $done) = @_;
1984		2377
1985	# do generation counting so two concurrent goto's will be executed in-order	2378	# do generation counting so two concurrent goto's will be executed in-order
1986	my $gen = $self->{_goto_generation} = ++$GOTOGEN;	2379	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1987		2380
1988	$self->enter_link;	2381	$self->enter_link;
…		…
2008		2401
2009	if ($gen == $self->{_goto_generation}) {	2402	if ($gen == $self->{_goto_generation}) {
2010	delete $self->{_goto_generation};	2403	delete $self->{_goto_generation};
2011	$self->leave_link ($map, $x, $y);	2404	$self->leave_link ($map, $x, $y);
2012	}	2405	}
		2406
		2407	$done->() if $done;
2013	})->prio (1);	2408	})->prio (1);
2014	}	2409	}
2015		2410
2016	=item $player_object->enter_exit ($exit_object)	2411	=item $player_object->enter_exit ($exit_object)
2017		2412
…		…
2086	my $hp = $exit->stats->hp;	2481	my $hp = $exit->stats->hp;
2087	my $sp = $exit->stats->sp;	2482	my $sp = $exit->stats->sp;
2088		2483
2089	$self->enter_link;	2484	$self->enter_link;
2090		2485
		2486	# if exit is damned, update players death & WoR home-position
		2487	$self->contr->savebed ($slaying, $hp, $sp)
		2488	if $exit->flag (FLAG_DAMNED);
		2489
2091	(async {	2490	(async {
2092	$self->deactivate_recursive; # just to be sure	2491	$self->deactivate_recursive; # just to be sure
2093	unless (eval {	2492	unless (eval {
2094	$self->goto ($slaying, $hp, $sp);	2493	$self->goto ($slaying, $hp, $sp);
2095		2494
…		…
2122		2521
2123	utf8::encode $text;	2522	utf8::encode $text;
2124	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2523	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2125	}	2524	}
2126		2525
		2526	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2527
		2528	Send a drawinfo or msg packet to the client, formatting the msg for the
		2529	client if neccessary. C<$type> should be a string identifying the type of
		2530	the message, with C<log> being the default. If C<$color> is negative, suppress
		2531	the message unless the client supports the msg packet.
		2532
		2533	=cut
		2534
		2535	sub cf::client::send_msg {
		2536	my ($self, $channel, $msg, $color, @extra) = @_;
		2537
		2538	$msg = $self->pl->expand_cfpod ($msg);
		2539
		2540	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2541
		2542	if (ref $channel) {
		2543	# send meta info to client, if not yet sent
		2544	unless (exists $self->{channel}{$channel->{id}}) {
		2545	$self->{channel}{$channel->{id}} = $channel;
		2546	$self->ext_msg (channel_info => $channel);
		2547	}
		2548
		2549	$channel = $channel->{id};
		2550	}
		2551
		2552	return unless @extra || length $msg;
		2553
		2554	if ($self->can_msg) {
		2555	# default colour, mask it out
		2556	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2557	if $color & cf::NDI_DEF;
		2558
		2559	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2560	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2561	} else {
		2562	if ($color >= 0) {
		2563	# replace some tags by gcfclient-compatible ones
		2564	for ($msg) {
		2565	1 while
		2566	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2567	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2568	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2569	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2570	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2571	}
		2572
		2573	$color &= cf::NDI_COLOR_MASK;
		2574
		2575	utf8::encode $msg;
		2576
		2577	if (0 && $msg =~ /\[/) {
		2578	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2579	} else {
		2580	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2581	$self->send_packet ("drawinfo $color $msg")
		2582	}
		2583	}
		2584	}
		2585	}
		2586
2127	=item $client->ext_event ($type, %msg)	2587	=item $client->ext_msg ($type, @msg)
2128		2588
2129	Sends an exti event to the client.	2589	Sends an ext event to the client.
2130		2590
2131	=cut	2591	=cut
2132		2592
2133	sub cf::client::ext_event($$%) {	2593	sub cf::client::ext_msg($$@) {
2134	my ($self, $type, %msg) = @_;	2594	my ($self, $type, @msg) = @_;
2135		2595
		2596	my $extcmd = $self->extcmd;
		2597
		2598	if ($extcmd == 2) {
		2599	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2600	} elsif ($extcmd == 1) { # TODO: remove
2136	$msg{msgtype} = "event_$type";	2601	push @msg, msgtype => "event_$type";
2137	$self->send_packet ("ext " . cf::to_json \%msg);	2602	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2603	}
2138	}	2604	}
2139		2605
2140	=item $success = $client->query ($flags, "text", \&cb)	2606	=item $success = $client->query ($flags, "text", \&cb)
2141		2607
2142	Queues a query to the client, calling the given callback with	2608	Queues a query to the client, calling the given callback with
2143	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2609	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2144	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2610	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2145		2611
2146	Queries can fail, so check the return code. Or don't, as queries will become	2612	Queries can fail, so check the return code. Or don't, as queries will
2147	reliable at some point in the future.	2613	become reliable at some point in the future.
2148		2614
2149	=cut	2615	=cut
2150		2616
2151	sub cf::client::query {	2617	sub cf::client::query {
2152	my ($self, $flags, $text, $cb) = @_;	2618	my ($self, $flags, $text, $cb) = @_;
…		…
2160	utf8::encode $text;	2626	utf8::encode $text;
2161	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2627	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2162		2628
2163	$self->send_packet ($self->{query_queue}[0][0])	2629	$self->send_packet ($self->{query_queue}[0][0])
2164	if @{ $self->{query_queue} } == 1;	2630	if @{ $self->{query_queue} } == 1;
		2631
		2632	1
2165	}	2633	}
2166		2634
2167	cf::client->attach (	2635	cf::client->attach (
		2636	on_connect => sub {
		2637	my ($ns) = @_;
		2638
		2639	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2640	},
2168	on_reply => sub {	2641	on_reply => sub {
2169	my ($ns, $msg) = @_;	2642	my ($ns, $msg) = @_;
2170		2643
2171	# this weird shuffling is so that direct followup queries	2644	# this weird shuffling is so that direct followup queries
2172	# get handled first	2645	# get handled first
…		…
2184	} else {	2657	} else {
2185	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2658	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2186	}	2659	}
2187	}	2660	}
2188	},	2661	},
		2662	on_exticmd => sub {
		2663	my ($ns, $buf) = @_;
		2664
		2665	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2666
		2667	if (ref $msg) {
		2668	my ($type, $reply, @payload) =
		2669	"ARRAY" eq ref $msg
		2670	? @$msg
		2671	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2672
		2673	if (my $cb = $EXTICMD{$type}) {
		2674	my @reply = $cb->($ns, @payload);
		2675
		2676	$ns->ext_reply ($reply, @reply)
		2677	if $reply;
		2678	}
		2679	} else {
		2680	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2681	}
		2682
		2683	cf::override;
		2684	},
2189	);	2685	);
2190		2686
2191	=item $client->async (\&cb)	2687	=item $client->async (\&cb)
2192		2688
2193	Create a new coroutine, running the specified callback. The coroutine will	2689	Create a new coroutine, running the specified callback. The coroutine will
…		…
2234	our $safe = new Safe "safe";	2730	our $safe = new Safe "safe";
2235	our $safe_hole = new Safe::Hole;	2731	our $safe_hole = new Safe::Hole;
2236		2732
2237	$SIG{FPE} = 'IGNORE';	2733	$SIG{FPE} = 'IGNORE';
2238		2734
2239	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2735	$safe->permit_only (Opcode::opset qw(
		2736	:base_core :base_mem :base_orig :base_math
		2737	grepstart grepwhile mapstart mapwhile
		2738	sort time
		2739	));
2240		2740
2241	# here we export the classes and methods available to script code	2741	# here we export the classes and methods available to script code
2242		2742
2243	=pod	2743	=pod
2244		2744
2245	The following functions and methods are available within a safe environment:	2745	The following functions and methods are available within a safe environment:
2246		2746
2247	cf::object contr pay_amount pay_player map	2747	cf::object
		2748	contr pay_amount pay_player map x y force_find force_add
		2749	insert remove name archname title slaying race
		2750
2248	cf::object::player player	2751	cf::object::player
2249	cf::player peaceful	2752	player
2250	cf::map trigger	2753
		2754	cf::player
		2755	peaceful
		2756
		2757	cf::map
		2758	trigger
2251		2759
2252	=cut	2760	=cut
2253		2761
2254	for (	2762	for (
2255	["cf::object" => qw(contr pay_amount pay_player map)],	2763	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2764	insert remove inv name archname title slaying race)],
2256	["cf::object::player" => qw(player)],	2765	["cf::object::player" => qw(player)],
2257	["cf::player" => qw(peaceful)],	2766	["cf::player" => qw(peaceful)],
2258	["cf::map" => qw(trigger)],	2767	["cf::map" => qw(trigger)],
2259	) {	2768	) {
2260	no strict 'refs';	2769	no strict 'refs';
…		…
2331	=back	2840	=back
2332		2841
2333	=cut	2842	=cut
2334		2843
2335	#############################################################################	2844	#############################################################################
2336
2337	=head2 EXTENSION DATABASE SUPPORT
2338
2339	Crossfire maintains a very simple database for extension use. It can
2340	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2341	convert to/from binary).
2342
2343	The parameter C<$family> should best start with the name of the extension
2344	using it, it should be unique.
2345
2346	=over 4
2347
2348	=item $value = cf::db_get $family => $key
2349
2350	Returns a single value from the database.
2351
2352	=item cf::db_put $family => $key => $value
2353
2354	Stores the given C<$value> in the family.
2355
2356	=cut
2357
2358	our $DB;
2359
2360	sub db_init {
2361	unless ($DB) {
2362	$DB = BDB::db_create $DB_ENV;
2363
2364	cf::sync_job {
2365	eval {
2366	$DB->set_flags (BDB::CHKSUM);
2367
2368	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2369	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2370	cf::cleanup "db_open(db): $!" if $!;
2371	};
2372	cf::cleanup "db_open(db): $@" if $@;
2373	};
2374	}
2375	}
2376
2377	sub db_get($$) {
2378	my $key = "$_[0]/$_[1]";
2379
2380	cf::sync_job {
2381	BDB::db_get $DB, undef, $key, my $data;
2382
2383	$! ? ()
2384	: $data
2385	}
2386	}
2387
2388	sub db_put($$$) {
2389	BDB::dbreq_pri 4;
2390	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2391	}
2392
2393	=item cf::cache $id => [$paths...], $processversion => $process
2394
2395	Generic caching function that returns the value of the resource $id,
2396	caching and regenerating as required.
2397
2398	This function can block.
2399
2400	=cut
2401
2402	sub cache {
2403	my ($id, $src, $processversion, $process) = @_;
2404
2405	my $meta =
2406	join "\x00",
2407	$processversion,
2408	map {
2409	aio_stat $_
2410	and Carp::croak "$_: $!";
2411
2412	($_, (stat _)[7,9])
2413	} @$src;
2414
2415	my $dbmeta = db_get cache => "$id/meta";
2416	if ($dbmeta ne $meta) {
2417	# changed, we may need to process
2418
2419	my @data;
2420	my $md5;
2421
2422	for (0 .. $#$src) {
2423	0 <= aio_load $src->[$_], $data[$_]
2424	or Carp::croak "$src->[$_]: $!";
2425	}
2426
2427	# if processing is expensive, check
2428	# checksum first
2429	if (1) {
2430	$md5 =
2431	join "\x00",
2432	$processversion,
2433	map {
2434	Coro::cede;
2435	($src->[$_], Digest::MD5::md5_hex $data[$_])
2436	} 0.. $#$src;
2437
2438
2439	my $dbmd5 = db_get cache => "$id/md5";
2440	if ($dbmd5 eq $md5) {
2441	db_put cache => "$id/meta", $meta;
2442
2443	return db_get cache => "$id/data";
2444	}
2445	}
2446
2447	my $t1 = Time::HiRes::time;
2448	my $data = $process->(\@data);
2449	my $t2 = Time::HiRes::time;
2450
2451	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2452
2453	db_put cache => "$id/data", $data;
2454	db_put cache => "$id/md5" , $md5;
2455	db_put cache => "$id/meta", $meta;
2456
2457	return $data;
2458	}
2459
2460	db_get cache => "$id/data"
2461	}
2462
2463	=item fork_call { }, $args
2464
2465	Executes the given code block with the given arguments in a seperate
2466	process, returning the results. Everything must be serialisable with
2467	Coro::Storable. May, of course, block. Note that the executed sub may
2468	never block itself or use any form of Event handling.
2469
2470	=cut
2471
2472	sub fork_call(&@) {
2473	my ($cb, @args) = @_;
2474
2475	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2476	# or die "socketpair: $!";
2477	pipe my $fh1, my $fh2
2478	or die "pipe: $!";
2479
2480	if (my $pid = fork) {
2481	close $fh2;
2482
2483	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2484	$res = Coro::Storable::thaw $res;
2485
2486	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2487
2488	die $$res unless "ARRAY" eq ref $res;
2489
2490	return wantarray ? @$res : $res->[-1];
2491	} else {
2492	reset_signals;
2493	local $SIG{__WARN__};
2494	local $SIG{__DIE__};
2495	eval {
2496	close $fh1;
2497
2498	my @res = eval { $cb->(@args) };
2499	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2500	};
2501
2502	warn $@ if $@;
2503	_exit 0;
2504	}
2505	}
2506
2507	#############################################################################
2508	# the server's init and main functions	2845	# the server's init and main functions
2509		2846
2510	sub load_facedata($) {	2847	sub load_facedata($) {
2511	my ($path) = @_;	2848	my ($path) = @_;
2512		2849
…		…
2524	{	2861	{
2525	my $faces = $facedata->{faceinfo};	2862	my $faces = $facedata->{faceinfo};
2526		2863
2527	while (my ($face, $info) = each %$faces) {	2864	while (my ($face, $info) = each %$faces) {
2528	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2865	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2529	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2866	cf::face::set_visibility $idx, $info->{visibility};
		2867	cf::face::set_magicmap $idx, $info->{magicmap};
2530	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2868	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2531	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	2869	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2532	Coro::cede;	2870
		2871	cf::cede_to_tick;
2533	}	2872	}
2534		2873
2535	while (my ($face, $info) = each %$faces) {	2874	while (my ($face, $info) = each %$faces) {
2536	next unless $info->{smooth};	2875	next unless $info->{smooth};
2537	my $idx = cf::face::find $face	2876	my $idx = cf::face::find $face
2538	or next;	2877	or next;
2539	if (my $smooth = cf::face::find $info->{smooth}) {	2878	if (my $smooth = cf::face::find $info->{smooth}) {
		2879	cf::face::set_smooth $idx, $smooth;
2540	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	2880	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2541	} else {	2881	} else {
2542	warn "smooth face '$info->{smooth}' not found for face '$face'";	2882	warn "smooth face '$info->{smooth}' not found for face '$face'";
2543	}	2883	}
2544	Coro::cede;	2884
		2885	cf::cede_to_tick;
2545	}	2886	}
2546	}	2887	}
2547		2888
2548	{	2889	{
2549	my $anims = $facedata->{animinfo};	2890	my $anims = $facedata->{animinfo};
2550		2891
2551	while (my ($anim, $info) = each %$anims) {	2892	while (my ($anim, $info) = each %$anims) {
2552	cf::anim::set $anim, $info->{frames}, $info->{facings};	2893	cf::anim::set $anim, $info->{frames}, $info->{facings};
2553	Coro::cede;	2894	cf::cede_to_tick;
2554	}	2895	}
2555		2896
2556	cf::anim::invalidate_all; # d'oh	2897	cf::anim::invalidate_all; # d'oh
2557	}	2898	}
2558		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	my $enc = JSON::XS->new->utf8->canonical;
		2905
		2906	my $soundconf = delete $res->{"res/sound.conf"};
		2907
		2908	while (my ($name, $info) = each %$res) {
		2909	my $meta = $enc->encode ({
		2910	name => $name,
		2911	%{ $info->{meta} || {} },
		2912	});
		2913
		2914	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2915
		2916	if ($info->{type} & 1) {
		2917	# prepend meta info
		2918
		2919	my $data = pack "(w/a*)*", $meta, $info->{data};
		2920	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2921
		2922	cf::face::set_data $idx, 0, $data, $chk;
		2923	} else {
		2924	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
		2925	}
		2926
		2927	cf::face::set_type $idx, $info->{type};
		2928
		2929	cf::cede_to_tick;
		2930	}
		2931
		2932	if ($soundconf) {
		2933	$soundconf = $enc->decode (delete $soundconf->{data});
		2934
		2935	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2936	my $sound = $soundconf->{compat}[$_]
		2937	or next;
		2938
		2939	my $face = cf::face::find "sound/$sound->[1]";
		2940	cf::sound::set $sound->[0] => $face;
		2941	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2942	}
		2943
		2944	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2945	my $face = cf::face::find "sound/$v";
		2946	cf::sound::set $k => $face;
		2947	}
		2948	}
		2949	}
		2950
2559	1	2951	1
2560	}	2952	}
		2953
		2954	register_exticmd fx_want => sub {
		2955	my ($ns, $want) = @_;
		2956
		2957	while (my ($k, $v) = each %$want) {
		2958	$ns->fx_want ($k, $v);
		2959	}
		2960	};
2561		2961
2562	sub reload_regions {	2962	sub reload_regions {
2563	load_resource_file "$MAPDIR/regions"	2963	load_resource_file "$MAPDIR/regions"
2564	or die "unable to load regions file\n";	2964	or die "unable to load regions file\n";
		2965
		2966	for (cf::region::list) {
		2967	$_->{match} = qr/$_->{match}/
		2968	if exists $_->{match};
		2969	}
2565	}	2970	}
2566		2971
2567	sub reload_facedata {	2972	sub reload_facedata {
2568	load_facedata "$DATADIR/facedata"	2973	load_facedata "$DATADIR/facedata"
2569	or die "unable to load facedata\n";	2974	or die "unable to load facedata\n";
2570	}	2975	}
2571		2976
2572	sub reload_archetypes {	2977	sub reload_archetypes {
		2978	load_resource_file "$DATADIR/archetypes"
		2979	or die "unable to load archetypes\n";
		2980	#d# NEED to laod twice to resolve forward references
		2981	# this really needs to be done in an extra post-pass
		2982	# (which needs to be synchronous, so solve it differently)
2573	load_resource_file "$DATADIR/archetypes"	2983	load_resource_file "$DATADIR/archetypes"
2574	or die "unable to load archetypes\n";	2984	or die "unable to load archetypes\n";
2575	}	2985	}
2576		2986
2577	sub reload_treasures {	2987	sub reload_treasures {
…		…
2649	},	3059	},
2650	);	3060	);
2651	}	3061	}
2652	}	3062	}
2653		3063
		3064	sub write_runtime {
		3065	my $runtime = "$LOCALDIR/runtime";
		3066
		3067	# first touch the runtime file to show we are still running:
		3068	# the fsync below can take a very very long time.
		3069
		3070	IO::AIO::aio_utime $runtime, undef, undef;
		3071
		3072	my $guard = cf::lock_acquire "write_runtime";
		3073
		3074	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3075	or return;
		3076
		3077	my $value = $cf::RUNTIME + 90 + 10;
		3078	# 10 is the runtime save interval, for a monotonic clock
		3079	# 60 allows for the watchdog to kill the server.
		3080
		3081	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3082	and return;
		3083
		3084	# always fsync - this file is important
		3085	aio_fsync $fh
		3086	and return;
		3087
		3088	# touch it again to show we are up-to-date
		3089	aio_utime $fh, undef, undef;
		3090
		3091	close $fh
		3092	or return;
		3093
		3094	aio_rename "$runtime~", $runtime
		3095	and return;
		3096
		3097	warn "runtime file written.\n";
		3098
		3099	1
		3100	}
		3101
2654	sub emergency_save() {	3102	sub emergency_save() {
2655	my $freeze_guard = cf::freeze_mainloop;	3103	my $freeze_guard = cf::freeze_mainloop;
2656		3104
2657	warn "enter emergency perl save\n";	3105	warn "enter emergency perl save\n";
2658		3106
…		…
2733	%EXT_CORO = ();	3181	%EXT_CORO = ();
2734		3182
2735	warn "removing commands";	3183	warn "removing commands";
2736	%COMMAND = ();	3184	%COMMAND = ();
2737		3185
2738	warn "removing ext commands";	3186	warn "removing ext/exti commands";
2739	%EXTCMD = ();	3187	%EXTCMD = ();
		3188	%EXTICMD = ();
2740		3189
2741	warn "unloading/nuking all extensions";	3190	warn "unloading/nuking all extensions";
2742	for my $pkg (@EXTS) {	3191	for my $pkg (@EXTS) {
2743	warn "... unloading $pkg";	3192	warn "... unloading $pkg";
2744		3193

Diff Legend

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