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.271 by root, Fri Jun 1 06:04:08 2007 UTC vs.
Revision 1.315 by root, Mon Jul 23 17:53:55 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 {
…		…
187	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	196	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
188	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	197	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
189	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	198	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
190	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	199	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
191	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	200	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		201	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
192	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	202	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
193		203
194	# we bless all objects into (empty) derived classes to force a method lookup	204	# we bless all objects into (empty) derived classes to force a method lookup
195	# within the Safe compartment.	205	# within the Safe compartment.
196	for my $pkg (qw(	206	for my $pkg (qw(
197	cf::global cf::attachable	207	cf::global cf::attachable
…		…
205	}	215	}
206		216
207	$Event::DIED = sub {	217	$Event::DIED = sub {
208	warn "error in event callback: @_";	218	warn "error in event callback: @_";
209	};	219	};
		220
		221	#############################################################################
210		222
211	=head2 UTILITY FUNCTIONS	223	=head2 UTILITY FUNCTIONS
212		224
213	=over 4	225	=over 4
214		226
…		…
233	$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;
234	$d	246	$d
235	} || "[unable to dump $_[0]: '$@']";	247	} || "[unable to dump $_[0]: '$@']";
236	}	248	}
237		249
238	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
239
240	=item $ref = cf::from_json $json	250	=item $ref = cf::from_json $json
241		251
242	Converts a JSON string into the corresponding perl data structure.	252	Converts a JSON string into the corresponding perl data structure.
243		253
244	=item $json = cf::to_json $ref	254	=item $json = cf::to_json $ref
245		255
246	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]) }
247		264
248	=item cf::lock_wait $string	265	=item cf::lock_wait $string
249		266
250	Wait until the given lock is available. See cf::lock_acquire.	267	Wait until the given lock is available. See cf::lock_acquire.
251		268
…		…
305	};	322	};
306	$TICK_WATCHER->stop;	323	$TICK_WATCHER->stop;
307	$guard	324	$guard
308	}	325	}
309		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
310	=item cf::async { BLOCK }	383	=item cf::async { BLOCK }
311		384
312	Currently the same as Coro::async_pool, meaning you cannot use	385	Currently the same as Coro::async_pool, meaning you cannot use
313	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only	386	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
314	thing you are allowed to do is call C<prio> on it.	387	thing you are allowed to do is call C<prio> on it.
…		…
317		390
318	BEGIN { *async = \&Coro::async_pool }	391	BEGIN { *async = \&Coro::async_pool }
319		392
320	=item cf::sync_job { BLOCK }	393	=item cf::sync_job { BLOCK }
321		394
322	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)
323	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
324	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.
325		399
326	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
327	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
328	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
329	fast or be very important.	403	fast or be very important.
…		…
389	$EXT_CORO{$coro+0} = $coro;	463	$EXT_CORO{$coro+0} = $coro;
390		464
391	$coro	465	$coro
392	}	466	}
393		467
394	sub write_runtime {	468	=item fork_call { }, $args
395	my $runtime = "$LOCALDIR/runtime";
396		469
397	# first touch the runtime file to show we are still running:	470	Executes the given code block with the given arguments in a seperate
398	# 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.
399		474
400	IO::AIO::aio_utime $runtime, undef, undef;	475	=cut
401		476
402	my $guard = cf::lock_acquire "write_runtime";	477	sub _store_scalar {
403		478	open my $fh, ">", \my $buf
404	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	479	or die "fork_call: cannot open fh-to-buf in child : $!";
405	or return;	480	Storable::store_fd $_[0], $fh;
406
407	my $value = $cf::RUNTIME + 90 + 10;
408	# 10 is the runtime save interval, for a monotonic clock
409	# 60 allows for the watchdog to kill the server.
410
411	(aio_write $fh, 0, (length $value), $value, 0) <= 0
412	and return;
413
414	# always fsync - this file is important
415	aio_fsync $fh
416	and return;
417
418	# touch it again to show we are up-to-date
419	aio_utime $fh, undef, undef;
420
421	close $fh	481	close $fh;
422	or return;
423		482
424	aio_rename "$runtime~", $runtime	483	$buf
425	and return;	484	}
426		485
427	warn "runtime file written.\n";#d#	486	sub fork_call(&@) {
		487	my ($cb, @args) = @_;
428		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;
429	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"
430	}	644	}
431		645
432	=item cf::datalog type => key => value, ...	646	=item cf::datalog type => key => value, ...
433		647
434	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.
…		…
452	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")
453	to it. All such attachable objects support the following methods.	667	to it. All such attachable objects support the following methods.
454		668
455	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>
456	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
457	crossfire+).	671	Crossfire TRT).
458		672
459	=over 4	673	=over 4
460		674
461	=item $attachable->attach ($attachment, key => $value...)	675	=item $attachable->attach ($attachment, key => $value...)
462		676
…		…
664	_attach $registry, $klass, @attach;	878	_attach $registry, $klass, @attach;
665	}	879	}
666		880
667	$obj->{$name} = \%arg;	881	$obj->{$name} = \%arg;
668	} else {	882	} else {
669	warn "object uses attachment '$name' that is not available, postponing.\n";	883	warn "object uses attachment '$name' which is not available, postponing.\n";
670	}	884	}
671		885
672	$obj->{_attachment}{$name} = undef;	886	$obj->{_attachment}{$name} = undef;
673	}	887	}
674		888
…		…
714	";	928	";
715	die if $@;	929	die if $@;
716	}	930	}
717		931
718	our $override;	932	our $override;
719	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?
720		934
721	sub override {	935	sub override {
722	$override = 1;	936	$override = 1;
723	@invoke_results = ();	937	@INVOKE_RESULTS = (@_);
724	}	938	}
725		939
726	sub do_invoke {	940	sub do_invoke {
727	my $event = shift;	941	my $event = shift;
728	my $callbacks = shift;	942	my $callbacks = shift;
729		943
730	@invoke_results = ();	944	@INVOKE_RESULTS = ();
731		945
732	local $override;	946	local $override;
733		947
734	for (@$callbacks) {	948	for (@$callbacks) {
735	eval { &{$_->[1]} };	949	eval { &{$_->[1]} };
…		…
752		966
753	Generate an object-specific event with the given arguments.	967	Generate an object-specific event with the given arguments.
754		968
755	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
756	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
757	results (if you must, access C<@cf::invoke_results> directly).	971	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
758		972
759	=back	973	=back
760		974
761	=cut	975	=cut
762		976
763	#############################################################################	977	#############################################################################
764	# 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	}
765		990
766	sub reattach {	991	sub reattach {
767	# basically do the same as instantiate, without calling instantiate	992	# basically do the same as instantiate, without calling instantiate
768	my ($obj) = @_;	993	my ($obj) = @_;
769		994
…		…
872	or return;	1097	or return;
873	$av = eval { (Storable::thaw $av)->{objs} };	1098	$av = eval { (Storable::thaw $av)->{objs} };
874	}	1099	}
875		1100
876	warn sprintf "loading %s (%d)\n",	1101	warn sprintf "loading %s (%d)\n",
877	$filename, length $data, scalar @{$av || []};#d#	1102	$filename, length $data, scalar @{$av || []};
878	return ($data, $av);	1103	return ($data, $av);
879	}	1104	}
		1105
		1106	=head2 COMMAND CALLBACKS
		1107
		1108	=over 4
		1109
		1110	=cut
880		1111
881	#############################################################################	1112	#############################################################################
882	# command handling &c	1113	# command handling &c
883		1114
884	=item cf::register_command $name => \&callback($ob,$args);	1115	=item cf::register_command $name => \&callback($ob,$args);
…		…
897	push @{ $COMMAND{$name} }, [$caller, $cb];	1128	push @{ $COMMAND{$name} }, [$caller, $cb];
898	}	1129	}
899		1130
900	=item cf::register_extcmd $name => \&callback($pl,$packet);	1131	=item cf::register_extcmd $name => \&callback($pl,$packet);
901		1132
902	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.
903		1138
904	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
905	called.	1140	called.
906		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
907	=cut	1153	=cut
908		1154
909	sub register_extcmd {	1155	sub register_extcmd {
910	my ($name, $cb) = @_;	1156	my ($name, $cb) = @_;
911		1157
912	$EXTCMD{$name} = $cb;	1158	$EXTCMD{$name} = $cb;
		1159	}
		1160
		1161	sub register_exticmd {
		1162	my ($name, $cb) = @_;
		1163
		1164	$EXTICMD{$name} = $cb;
913	}	1165	}
914		1166
915	cf::player->attach (	1167	cf::player->attach (
916	on_command => sub {	1168	on_command => sub {
917	my ($pl, $name, $params) = @_;	1169	my ($pl, $name, $params) = @_;
…		…
926	cf::override;	1178	cf::override;
927	},	1179	},
928	on_extcmd => sub {	1180	on_extcmd => sub {
929	my ($pl, $buf) = @_;	1181	my ($pl, $buf) = @_;
930		1182
931	my $msg = eval { from_json $buf };	1183	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
932		1184
933	if (ref $msg) {	1185	if (ref $msg) {
934	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1186	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
935	if (my %reply = $cb->($pl, $msg)) {	1187	if (my %reply = $cb->($pl, $msg)) {
936	$pl->ext_reply ($msg->{msgid}, %reply);	1188	$pl->ext_reply ($msg->{msgid}, %reply);
…		…
942		1194
943	cf::override;	1195	cf::override;
944	},	1196	},
945	);	1197	);
946		1198
947	sub load_extension {
948	my ($path) = @_;
949
950	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
951	my $base = $1;
952	my $pkg = $1;
953	$pkg =~ s/[^[:word:]]/_/g;
954	$pkg = "ext::$pkg";
955
956	warn "... loading '$path' into '$pkg'\n";
957
958	open my $fh, "<:utf8", $path
959	or die "$path: $!";
960
961	my $source =
962	"package $pkg; use strict; use utf8;\n"
963	. "#line 1 \"$path\"\n{\n"
964	. (do { local $/; <$fh> })
965	. "\n};\n1";
966
967	unless (eval $source) {
968	my $msg = $@ ? "$path: $@\n"
969	: "extension disabled.\n";
970	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
971	warn $@;
972	warn "mandatory extension failed to load, exiting.\n";
973	exit 1;
974	}
975	die $@;
976	}
977
978	push @EXTS, $pkg;
979	}
980
981	sub load_extensions {	1199	sub load_extensions {
		1200	cf::sync_job {
		1201	my %todo;
		1202
982	for my $ext (<$LIBDIR/*.ext>) {	1203	for my $path (<$LIBDIR/*.ext>) {
983	next unless -r $ext;	1204	next unless -r $path;
984	eval {	1205
985	load_extension $ext;	1206	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1207	my $base = $1;
		1208	my $pkg = $1;
		1209	$pkg =~ s/[^[:word:]]/_/g;
		1210	$pkg = "ext::$pkg";
		1211
		1212	open my $fh, "<:utf8", $path
		1213	or die "$path: $!";
		1214
		1215	my $source = do { local $/; <$fh> };
		1216
		1217	my %ext = (
		1218	path => $path,
		1219	base => $base,
		1220	pkg => $pkg,
		1221	);
		1222
		1223	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1224	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1225
		1226	$ext{source} =
		1227	"package $pkg; use strict; use utf8;\n"
		1228	. "#line 1 \"$path\"\n{\n"
		1229	. $source
		1230	. "\n};\n1";
		1231
		1232	$todo{$base} = \%ext;
		1233	}
		1234
		1235	my %done;
		1236	while (%todo) {
		1237	my $progress;
		1238
		1239	while (my ($k, $v) = each %todo) {
		1240	for (split /,\s*/, $v->{meta}{depends}) {
		1241	goto skip
		1242	unless exists $done{$_};
		1243	}
		1244
		1245	warn "... loading '$k' into '$v->{pkg}'\n";
		1246
		1247	unless (eval $v->{source}) {
		1248	my $msg = $@ ? "$v->{path}: $@\n"
		1249	: "$v->{base}: extension inactive.\n";
		1250
		1251	if (exists $v->{meta}{mandatory}) {
		1252	warn $msg;
		1253	warn "mandatory extension failed to load, exiting.\n";
		1254	exit 1;
		1255	}
		1256
		1257	warn $msg;
		1258	}
		1259
		1260	$done{$k} = delete $todo{$k};
		1261	push @EXTS, $v->{pkg};
		1262	$progress = 1;
986	1	1263	}
987	} or warn "$ext not loaded: $@";	1264
		1265	skip:
		1266	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1267	unless $progress;
		1268	}
988	}	1269	};
989	}	1270	}
990		1271
991	#############################################################################	1272	#############################################################################
		1273
		1274	=back
992		1275
993	=head2 CORE EXTENSIONS	1276	=head2 CORE EXTENSIONS
994		1277
995	Functions and methods that extend core crossfire objects.	1278	Functions and methods that extend core crossfire objects.
996		1279
…		…
1184	}	1467	}
1185		1468
1186	\@paths	1469	\@paths
1187	}	1470	}
1188		1471
		1472	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1473
		1474	Expand crossfire pod fragments into protocol xml.
		1475
		1476	=cut
		1477
		1478	sub expand_cfpod {
		1479	((my $self), (local $_)) = @_;
		1480
		1481	# escape & and <
		1482	s/&/&amp;/g;
		1483	s/(?<![BIUGH])</&lt;/g;
		1484
		1485	# this is buggy, it needs to properly take care of nested <'s
		1486
		1487	1 while
		1488	# replace B<>, I<>, U<> etc.
		1489	s/B<([^\>]*)>/<b>$1<\/b>/
		1490	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1491	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1492	# replace G<male|female> tags
		1493	|| s{G<([^>|]*)\|([^>]*)>}{
		1494	$self->gender ? $2 : $1
		1495	}ge
		1496	# replace H<hint text>
		1497	|| s{H<([^\>]*)>}
		1498	{
		1499	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1500	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1501	"")
		1502	[$self->{hintmode}]
		1503	}ge;
		1504
		1505	# create single paragraphs (very hackish)
		1506	s/(?<=\S)\n(?=\w)/ /g;
		1507
		1508	# compress some whitespace
		1509	s/\s+\n/\n/g; # ws line-ends
		1510	s/\n\n+/\n/g; # double lines
		1511	s/^\n+//; # beginning lines
		1512	s/\n+$//; # ending lines
		1513
		1514	$_
		1515	}
		1516
		1517	sub hintmode {
		1518	$_[0]{hintmode} = $_[1] if @_ > 1;
		1519	$_[0]{hintmode}
		1520	}
		1521
1189	=item $player->ext_reply ($msgid, %msg)	1522	=item $player->ext_reply ($msgid, %msg)
1190		1523
1191	Sends an ext reply to the player.	1524	Sends an ext reply to the player.
1192		1525
1193	=cut	1526	=cut
1194		1527
1195	sub ext_reply($$%) {	1528	sub ext_reply($$%) {
1196	my ($self, $id, %msg) = @_;	1529	my ($self, $id, %msg) = @_;
1197		1530
1198	$msg{msgid} = $id;	1531	$msg{msgid} = $id;
1199		1532	$self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1200	$self->send ("ext " . cf::to_json \%msg);
1201	}	1533	}
1202		1534
1203	=item $player->ext_event ($type, %msg)	1535	=item $player->ext_event ($type, %msg)
1204		1536
1205	Sends an ext event to the client.	1537	Sends an ext event to the client.
…		…
1220		1552
1221	package cf::region;	1553	package cf::region;
1222		1554
1223	=item cf::region::find_by_path $path	1555	=item cf::region::find_by_path $path
1224		1556
1225	Tries to decuce the probable region for a map knowing only its path.	1557	Tries to decuce the likely region for a map knowing only its path.
1226		1558
1227	=cut	1559	=cut
1228		1560
1229	sub find_by_path($) {	1561	sub find_by_path($) {
1230	my ($path) = @_;	1562	my ($path) = @_;
1231		1563
1232	my ($match, $specificity);	1564	my ($match, $specificity);
1233		1565
1234	for my $region (list) {	1566	for my $region (list) {
1235	if ($region->match && $path =~ $region->match) {	1567	if ($region->{match} && $path =~ $region->{match}) {
1236	($match, $specificity) = ($region, $region->specificity)	1568	($match, $specificity) = ($region, $region->specificity)
1237	if $region->specificity > $specificity;	1569	if $region->specificity > $specificity;
1238	}	1570	}
1239	}	1571	}
1240		1572
…		…
1304	my ($self, $merge) = @_;	1636	my ($self, $merge) = @_;
1305		1637
1306	# we have to keep some variables in memory intact	1638	# we have to keep some variables in memory intact
1307	local $self->{path};	1639	local $self->{path};
1308	local $self->{load_path};	1640	local $self->{load_path};
1309	local $self->{deny_save};
1310	local $self->{deny_reset};
1311		1641
1312	$self->SUPER::thawer_merge ($merge);	1642	$self->SUPER::thawer_merge ($merge);
1313	}	1643	}
1314		1644
1315	sub normalise {	1645	sub normalise {
…		…
1362	$self->init; # pass $1 etc.	1692	$self->init; # pass $1 etc.
1363	return $self;	1693	return $self;
1364	}	1694	}
1365	}	1695	}
1366		1696
1367	Carp::carp "unable to resolve path '$path' (base '$base').";	1697	Carp::cluck "unable to resolve path '$path' (base '$base').";
1368	()	1698	()
1369	}	1699	}
1370		1700
1371	sub init {	1701	sub init {
1372	my ($self) = @_;	1702	my ($self) = @_;
…		…
1413	sub change_all_map_light {	1743	sub change_all_map_light {
1414	my ($change) = @_;	1744	my ($change) = @_;
1415		1745
1416	$_->change_map_light ($change)	1746	$_->change_map_light ($change)
1417	for grep $_->outdoor, values %cf::MAP;	1747	for grep $_->outdoor, values %cf::MAP;
		1748	}
		1749
		1750	sub decay_objects {
		1751	my ($self) = @_;
		1752
		1753	return if $self->{deny_reset};
		1754
		1755	$self->do_decay_objects;
1418	}	1756	}
1419		1757
1420	sub unlink_save {	1758	sub unlink_save {
1421	my ($self) = @_;	1759	my ($self) = @_;
1422		1760
…		…
1480	$self->load_header_orig	1818	$self->load_header_orig
1481	or return;	1819	or return;
1482	$self->prepare_orig;	1820	$self->prepare_orig;
1483	}	1821	}
1484		1822
		1823	$self->{deny_reset} = 1
		1824	if $self->no_reset;
		1825
1485	$self->default_region (cf::region::find_by_path $self->{path})	1826	$self->default_region (cf::region::find_by_path $self->{path})
1486	unless $self->default_region;	1827	unless $self->default_region;
1487		1828
1488	1	1829	1
1489	}	1830	}
…		…
1504	$map->{last_save} = $cf::RUNTIME;	1845	$map->{last_save} = $cf::RUNTIME;
1505		1846
1506	$map->load_header	1847	$map->load_header
1507	or return;	1848	or return;
1508		1849
1509	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1850	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1510	# doing this can freeze the server in a sync job, obviously	1851	# doing this can freeze the server in a sync job, obviously
1511	#$cf::WAIT_FOR_TICK->wait;	1852	#$cf::WAIT_FOR_TICK->wait;
1512	$map->reset;	1853	$map->reset;
1513	undef $guard;	1854	undef $guard;
1514	return find $path;	1855	return find $path;
…		…
1581	my ($self, $ob) = @_;	1922	my ($self, $ob) = @_;
1582		1923
1583	return find "~" . $ob->name . "/" . $self->{path}	1924	return find "~" . $ob->name . "/" . $self->{path}
1584	if $self->per_player;	1925	if $self->per_player;
1585		1926
		1927	# return find "?party/" . $ob->name . "/" . $self->{path}
		1928	# if $self->per_party;
		1929
1586	$self	1930	$self
1587	}	1931	}
1588		1932
1589	# find and load all maps in the 3x3 area around a map	1933	# find and load all maps in the 3x3 area around a map
1590	sub load_diag {	1934	sub load_diag {
…		…
1636		1980
1637	undef $MAP_PREFETCH{$path};	1981	undef $MAP_PREFETCH{$path};
1638	$MAP_PREFETCHER ||= cf::async {	1982	$MAP_PREFETCHER ||= cf::async {
1639	while (%MAP_PREFETCH) {	1983	while (%MAP_PREFETCH) {
1640	for my $path (keys %MAP_PREFETCH) {	1984	for my $path (keys %MAP_PREFETCH) {
1641	my $map = find $path	1985	if (my $map = find $path) {
1642	or next;
1643	$map->load;	1986	$map->load;
		1987	}
1644		1988
1645	delete $MAP_PREFETCH{$path};	1989	delete $MAP_PREFETCH{$path};
1646	}	1990	}
1647	}	1991	}
1648	undef $MAP_PREFETCHER;	1992	undef $MAP_PREFETCHER;
…		…
1700		2044
1701	sub reset_at {	2045	sub reset_at {
1702	my ($self) = @_;	2046	my ($self) = @_;
1703		2047
1704	# TODO: safety, remove and allow resettable per-player maps	2048	# TODO: safety, remove and allow resettable per-player maps
1705	return 1e99 if $self->isa ("ext::map_per_player");#d#
1706	return 1e99 if $self->{deny_reset};	2049	return 1e99 if $self->{deny_reset};
1707		2050
1708	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2051	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1709	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2052	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1710		2053
…		…
1721	my ($self) = @_;	2064	my ($self) = @_;
1722		2065
1723	my $lock = cf::lock_acquire "map_data:$self->{path}";	2066	my $lock = cf::lock_acquire "map_data:$self->{path}";
1724		2067
1725	return if $self->players;	2068	return if $self->players;
1726	return if $self->isa ("ext::map_per_player");#d#
1727		2069
1728	warn "resetting map ", $self->path;#d#	2070	warn "resetting map ", $self->path;
1729		2071
1730	$self->in_memory (cf::MAP_SWAPPED);	2072	$self->in_memory (cf::MAP_SWAPPED);
1731		2073
1732	# need to save uniques path	2074	# need to save uniques path
1733	unless ($self->{deny_save}) {	2075	unless ($self->{deny_save}) {
…		…
1765	$cf::MAP{$self->path} = $self;	2107	$cf::MAP{$self->path} = $self;
1766		2108
1767	$self->reset; # polite request, might not happen	2109	$self->reset; # polite request, might not happen
1768	}	2110	}
1769		2111
		2112	=item $maps = cf::map::tmp_maps
		2113
		2114	Returns an arrayref with all map paths of currently instantiated and saved
		2115	maps. May block.
		2116
		2117	=cut
		2118
		2119	sub tmp_maps() {
		2120	[
		2121	map {
		2122	utf8::decode $_;
		2123	/\.map$/
		2124	? normalise $_
		2125	: ()
		2126	} @{ aio_readdir $TMPDIR or [] }
		2127	]
		2128	}
		2129
		2130	=item $maps = cf::map::random_maps
		2131
		2132	Returns an arrayref with all map paths of currently instantiated and saved
		2133	random maps. May block.
		2134
		2135	=cut
		2136
		2137	sub random_maps() {
		2138	[
		2139	map {
		2140	utf8::decode $_;
		2141	/\.map$/
		2142	? normalise "?random/$_"
		2143	: ()
		2144	} @{ aio_readdir $RANDOMDIR or [] }
		2145	]
		2146	}
		2147
1770	=item cf::map::unique_maps	2148	=item cf::map::unique_maps
1771		2149
1772	Returns an arrayref of paths of all shared maps that have	2150	Returns an arrayref of paths of all shared maps that have
1773	instantiated unique items. May block.	2151	instantiated unique items. May block.
1774		2152
1775	=cut	2153	=cut
1776		2154
1777	sub unique_maps() {	2155	sub unique_maps() {
1778	my $files = aio_readdir $UNIQUEDIR	2156	[
1779	or return;	2157	map {
1780
1781	my @paths;
1782
1783	for (@$files) {
1784	utf8::decode $_;	2158	utf8::decode $_;
1785	next if /\.pst$/;	2159	/\.map$/
1786	next unless /^$PATH_SEP/o;	2160	? normalise $_
1787		2161	: ()
1788	push @paths, cf::map::normalise $_;	2162	} @{ aio_readdir $UNIQUEDIR or [] }
1789	}	2163	]
1790
1791	\@paths
1792	}	2164	}
1793		2165
1794	package cf;	2166	package cf;
1795		2167
1796	=back	2168	=back
…		…
1842		2214
1843	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2215	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1844		2216
1845	if ($self->{record_replies}) {	2217	if ($self->{record_replies}) {
1846	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2218	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2219
1847	} else {	2220	} else {
		2221	my $pl = $self->contr;
		2222
		2223	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2224	my $diag = $pl->{npc_dialog};
		2225	$diag->{pl}->ext_reply (
		2226	$diag->{id},
		2227	msgtype => "reply",
		2228	msg => $diag->{pl}->expand_cfpod ($msg),
		2229	add_topics => []
		2230	);
		2231
		2232	} else {
1848	$msg = $npc->name . " says: $msg" if $npc;	2233	$msg = $npc->name . " says: $msg" if $npc;
1849	$self->message ($msg, $flags);	2234	$self->message ($msg, $flags);
		2235	}
1850	}	2236	}
1851	}	2237	}
1852		2238
1853	=item $player_object->may ("access")	2239	=item $player_object->may ("access")
1854		2240
…		…
1943		2329
1944	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2330	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1945	$self->enter_map ($map, $x, $y);	2331	$self->enter_map ($map, $x, $y);
1946	}	2332	}
1947		2333
1948	=item $player_object->goto ($path, $x, $y[, $check->($map)])	2334	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1949		2335
1950	Moves the player to the given map-path and coordinates by first freezing	2336	Moves the player to the given map-path and coordinates by first freezing
1951	her, loading and preparing them map, calling the provided $check callback	2337	her, loading and preparing them map, calling the provided $check callback
1952	that has to return the map if sucecssful, and then unfreezes the player on	2338	that has to return the map if sucecssful, and then unfreezes the player on
1953	the new (success) or old (failed) map position.	2339	the new (success) or old (failed) map position. In either case, $done will
		2340	be called at the end of this process.
1954		2341
1955	=cut	2342	=cut
1956		2343
1957	our $GOTOGEN;	2344	our $GOTOGEN;
1958		2345
1959	sub cf::object::player::goto {	2346	sub cf::object::player::goto {
1960	my ($self, $path, $x, $y, $check) = @_;	2347	my ($self, $path, $x, $y, $check, $done) = @_;
1961		2348
1962	# do generation counting so two concurrent goto's will be executed in-order	2349	# do generation counting so two concurrent goto's will be executed in-order
1963	my $gen = $self->{_goto_generation} = ++$GOTOGEN;	2350	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1964		2351
1965	$self->enter_link;	2352	$self->enter_link;
…		…
1985		2372
1986	if ($gen == $self->{_goto_generation}) {	2373	if ($gen == $self->{_goto_generation}) {
1987	delete $self->{_goto_generation};	2374	delete $self->{_goto_generation};
1988	$self->leave_link ($map, $x, $y);	2375	$self->leave_link ($map, $x, $y);
1989	}	2376	}
		2377
		2378	$done->() if $done;
1990	})->prio (1);	2379	})->prio (1);
1991	}	2380	}
1992		2381
1993	=item $player_object->enter_exit ($exit_object)	2382	=item $player_object->enter_exit ($exit_object)
1994		2383
…		…
2063	my $hp = $exit->stats->hp;	2452	my $hp = $exit->stats->hp;
2064	my $sp = $exit->stats->sp;	2453	my $sp = $exit->stats->sp;
2065		2454
2066	$self->enter_link;	2455	$self->enter_link;
2067		2456
		2457	# if exit is damned, update players death & WoR home-position
		2458	$self->contr->savebed ($slaying, $hp, $sp)
		2459	if $exit->flag (FLAG_DAMNED);
		2460
2068	(async {	2461	(async {
2069	$self->deactivate_recursive; # just to be sure	2462	$self->deactivate_recursive; # just to be sure
2070	unless (eval {	2463	unless (eval {
2071	$self->goto ($slaying, $hp, $sp);	2464	$self->goto ($slaying, $hp, $sp);
2072		2465
…		…
2099		2492
2100	utf8::encode $text;	2493	utf8::encode $text;
2101	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2494	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2102	}	2495	}
2103		2496
		2497	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2498
		2499	Send a drawinfo or msg packet to the client, formatting the msg for the
		2500	client if neccessary. C<$type> should be a string identifying the type of
		2501	the message, with C<log> being the default. If C<$color> is negative, suppress
		2502	the message unless the client supports the msg packet.
		2503
		2504	=cut
		2505
		2506	sub cf::client::send_msg {
		2507	my ($self, $channel, $msg, $color, @extra) = @_;
		2508
		2509	$msg = $self->pl->expand_cfpod ($msg);
		2510
		2511	$color &= ~cf::NDI_UNIQUE; # just in case...
		2512
		2513	if (ref $channel) {
		2514	# send meta info to client, if not yet sent
		2515	unless (exists $self->{channel}{$channel->{id}}) {
		2516	$self->{channel}{$channel->{id}} = $channel;
		2517	$self->ext_event (channel_info => %$channel);
		2518	}
		2519
		2520	$channel = $channel->{id};
		2521	}
		2522
		2523	return unless @extra || length $msg;
		2524
		2525	if ($self->can_msg) {
		2526	$self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
		2527	} else {
		2528	# replace some tags by gcfclient-compatible ones
		2529	for ($msg) {
		2530	1 while
		2531	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2532	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2533	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2534	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2535	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2536	}
		2537
		2538	if ($color >= 0) {
		2539	if (0 && $msg =~ /\[/) {
		2540	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2541	} else {
		2542	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2543	$self->send_packet ("drawinfo $color $msg")
		2544	}
		2545	}
		2546	}
		2547	}
		2548
2104	=item $client->ext_event ($type, %msg)	2549	=item $client->ext_event ($type, %msg)
2105		2550
2106	Sends an exti event to the client.	2551	Sends an ext event to the client.
2107		2552
2108	=cut	2553	=cut
2109		2554
2110	sub cf::client::ext_event($$%) {	2555	sub cf::client::ext_event($$%) {
2111	my ($self, $type, %msg) = @_;	2556	my ($self, $type, %msg) = @_;
2112		2557
		2558	return unless $self->extcmd;
		2559
2113	$msg{msgtype} = "event_$type";	2560	$msg{msgtype} = "event_$type";
2114	$self->send_packet ("ext " . cf::to_json \%msg);	2561	$self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2115	}	2562	}
2116		2563
2117	=item $success = $client->query ($flags, "text", \&cb)	2564	=item $success = $client->query ($flags, "text", \&cb)
2118		2565
2119	Queues a query to the client, calling the given callback with	2566	Queues a query to the client, calling the given callback with
2120	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2567	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2121	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2568	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2122		2569
2123	Queries can fail, so check the return code. Or don't, as queries will become	2570	Queries can fail, so check the return code. Or don't, as queries will
2124	reliable at some point in the future.	2571	become reliable at some point in the future.
2125		2572
2126	=cut	2573	=cut
2127		2574
2128	sub cf::client::query {	2575	sub cf::client::query {
2129	my ($self, $flags, $text, $cb) = @_;	2576	my ($self, $flags, $text, $cb) = @_;
…		…
2137	utf8::encode $text;	2584	utf8::encode $text;
2138	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2585	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2139		2586
2140	$self->send_packet ($self->{query_queue}[0][0])	2587	$self->send_packet ($self->{query_queue}[0][0])
2141	if @{ $self->{query_queue} } == 1;	2588	if @{ $self->{query_queue} } == 1;
		2589
		2590	1
2142	}	2591	}
2143		2592
2144	cf::client->attach (	2593	cf::client->attach (
		2594	on_connect => sub {
		2595	my ($ns) = @_;
		2596
		2597	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2598	},
2145	on_reply => sub {	2599	on_reply => sub {
2146	my ($ns, $msg) = @_;	2600	my ($ns, $msg) = @_;
2147		2601
2148	# this weird shuffling is so that direct followup queries	2602	# this weird shuffling is so that direct followup queries
2149	# get handled first	2603	# get handled first
…		…
2161	} else {	2615	} else {
2162	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2616	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2163	}	2617	}
2164	}	2618	}
2165	},	2619	},
		2620	on_exticmd => sub {
		2621	my ($ns, $buf) = @_;
		2622
		2623	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2624
		2625	if (ref $msg) {
		2626	if (my $cb = $EXTICMD{$msg->{msgtype}}) {
		2627	if (my %reply = $cb->($ns, $msg)) {
		2628	$reply{msgid} = $msg->{msgid};
		2629	$ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
		2630	}
		2631	}
		2632	} else {
		2633	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2634	}
		2635
		2636	cf::override;
		2637	},
2166	);	2638	);
2167		2639
2168	=item $client->async (\&cb)	2640	=item $client->async (\&cb)
2169		2641
2170	Create a new coroutine, running the specified callback. The coroutine will	2642	Create a new coroutine, running the specified callback. The coroutine will
…		…
2219		2691
2220	=pod	2692	=pod
2221		2693
2222	The following functions and methods are available within a safe environment:	2694	The following functions and methods are available within a safe environment:
2223		2695
2224	cf::object contr pay_amount pay_player map	2696	cf::object
		2697	contr pay_amount pay_player map x y force_find force_add
		2698	insert remove
		2699
2225	cf::object::player player	2700	cf::object::player
2226	cf::player peaceful	2701	player
2227	cf::map trigger	2702
		2703	cf::player
		2704	peaceful
		2705
		2706	cf::map
		2707	trigger
2228		2708
2229	=cut	2709	=cut
2230		2710
2231	for (	2711	for (
2232	["cf::object" => qw(contr pay_amount pay_player map)],	2712	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2713	insert remove)],
2233	["cf::object::player" => qw(player)],	2714	["cf::object::player" => qw(player)],
2234	["cf::player" => qw(peaceful)],	2715	["cf::player" => qw(peaceful)],
2235	["cf::map" => qw(trigger)],	2716	["cf::map" => qw(trigger)],
2236	) {	2717	) {
2237	no strict 'refs';	2718	no strict 'refs';
…		…
2308	=back	2789	=back
2309		2790
2310	=cut	2791	=cut
2311		2792
2312	#############################################################################	2793	#############################################################################
2313
2314	=head2 EXTENSION DATABASE SUPPORT
2315
2316	Crossfire maintains a very simple database for extension use. It can
2317	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2318	convert to/from binary).
2319
2320	The parameter C<$family> should best start with the name of the extension
2321	using it, it should be unique.
2322
2323	=over 4
2324
2325	=item $value = cf::db_get $family => $key
2326
2327	Returns a single value from the database.
2328
2329	=item cf::db_put $family => $key => $value
2330
2331	Stores the given C<$value> in the family.
2332
2333	=cut
2334
2335	our $DB;
2336
2337	sub db_init {
2338	unless ($DB) {
2339	$DB = BDB::db_create $DB_ENV;
2340
2341	cf::sync_job {
2342	eval {
2343	$DB->set_flags (BDB::CHKSUM);
2344
2345	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2346	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2347	cf::cleanup "db_open(db): $!" if $!;
2348	};
2349	cf::cleanup "db_open(db): $@" if $@;
2350	};
2351	}
2352	}
2353
2354	sub db_get($$) {
2355	my $key = "$_[0]/$_[1]";
2356
2357	cf::sync_job {
2358	BDB::db_get $DB, undef, $key, my $data;
2359
2360	$! ? ()
2361	: $data
2362	}
2363	}
2364
2365	sub db_put($$$) {
2366	BDB::dbreq_pri 4;
2367	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2368	}
2369
2370	=item cf::cache $id => [$paths...], $processversion => $process
2371
2372	Generic caching function that returns the value of the resource $id,
2373	caching and regenerating as required.
2374
2375	This function can block.
2376
2377	=cut
2378
2379	sub cache {
2380	my ($id, $src, $processversion, $process) = @_;
2381
2382	my $meta =
2383	join "\x00",
2384	$processversion,
2385	map {
2386	aio_stat $_
2387	and Carp::croak "$_: $!";
2388
2389	($_, (stat _)[7,9])
2390	} @$src;
2391
2392	my $dbmeta = db_get cache => "$id/meta";
2393	if ($dbmeta ne $meta) {
2394	# changed, we may need to process
2395
2396	my @data;
2397	my $md5;
2398
2399	for (0 .. $#$src) {
2400	0 <= aio_load $src->[$_], $data[$_]
2401	or Carp::croak "$src->[$_]: $!";
2402	}
2403
2404	# if processing is expensive, check
2405	# checksum first
2406	if (1) {
2407	$md5 =
2408	join "\x00",
2409	$processversion,
2410	map {
2411	Coro::cede;
2412	($src->[$_], Digest::MD5::md5_hex $data[$_])
2413	} 0.. $#$src;
2414
2415
2416	my $dbmd5 = db_get cache => "$id/md5";
2417	if ($dbmd5 eq $md5) {
2418	db_put cache => "$id/meta", $meta;
2419
2420	return db_get cache => "$id/data";
2421	}
2422	}
2423
2424	my $t1 = Time::HiRes::time;
2425	my $data = $process->(\@data);
2426	my $t2 = Time::HiRes::time;
2427
2428	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2429
2430	db_put cache => "$id/data", $data;
2431	db_put cache => "$id/md5" , $md5;
2432	db_put cache => "$id/meta", $meta;
2433
2434	return $data;
2435	}
2436
2437	db_get cache => "$id/data"
2438	}
2439
2440	=item fork_call { }, $args
2441
2442	Executes the given code block with the given arguments in a seperate
2443	process, returning the results. Everything must be serialisable with
2444	Coro::Storable. May, of course, block. Note that the executed sub may
2445	never block itself or use any form of Event handling.
2446
2447	=cut
2448
2449	sub fork_call(&@) {
2450	my ($cb, @args) = @_;
2451
2452	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2453	# or die "socketpair: $!";
2454	pipe my $fh1, my $fh2
2455	or die "pipe: $!";
2456
2457	if (my $pid = fork) {
2458	close $fh2;
2459
2460	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2461	$res = Coro::Storable::thaw $res;
2462
2463	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2464
2465	die $$res unless "ARRAY" eq ref $res;
2466
2467	return wantarray ? @$res : $res->[-1];
2468	} else {
2469	reset_signals;
2470	local $SIG{__WARN__};
2471	local $SIG{__DIE__};
2472	eval {
2473	close $fh1;
2474
2475	my @res = eval { $cb->(@args) };
2476	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2477	};
2478
2479	warn $@ if $@;
2480	_exit 0;
2481	}
2482	}
2483
2484	#############################################################################
2485	# the server's init and main functions	2794	# the server's init and main functions
2486		2795
2487	sub load_facedata($) {	2796	sub load_facedata($) {
2488	my ($path) = @_;	2797	my ($path) = @_;
2489		2798
…		…
2501	{	2810	{
2502	my $faces = $facedata->{faceinfo};	2811	my $faces = $facedata->{faceinfo};
2503		2812
2504	while (my ($face, $info) = each %$faces) {	2813	while (my ($face, $info) = each %$faces) {
2505	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2814	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2506	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2815	cf::face::set_visibility $idx, $info->{visibility};
		2816	cf::face::set_magicmap $idx, $info->{magicmap};
2507	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2817	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2508	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	2818	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2509	Coro::cede;	2819
		2820	cf::cede_to_tick;
2510	}	2821	}
2511		2822
2512	while (my ($face, $info) = each %$faces) {	2823	while (my ($face, $info) = each %$faces) {
2513	next unless $info->{smooth};	2824	next unless $info->{smooth};
2514	my $idx = cf::face::find $face	2825	my $idx = cf::face::find $face
2515	or next;	2826	or next;
2516	if (my $smooth = cf::face::find $info->{smooth}) {	2827	if (my $smooth = cf::face::find $info->{smooth}) {
		2828	cf::face::set_smooth $idx, $smooth;
2517	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	2829	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2518	} else {	2830	} else {
2519	warn "smooth face '$info->{smooth}' not found for face '$face'";	2831	warn "smooth face '$info->{smooth}' not found for face '$face'";
2520	}	2832	}
2521	Coro::cede;	2833
		2834	cf::cede_to_tick;
2522	}	2835	}
2523	}	2836	}
2524		2837
2525	{	2838	{
2526	my $anims = $facedata->{animinfo};	2839	my $anims = $facedata->{animinfo};
2527		2840
2528	while (my ($anim, $info) = each %$anims) {	2841	while (my ($anim, $info) = each %$anims) {
2529	cf::anim::set $anim, $info->{frames}, $info->{facings};	2842	cf::anim::set $anim, $info->{frames}, $info->{facings};
2530	Coro::cede;	2843	cf::cede_to_tick;
2531	}	2844	}
2532		2845
2533	cf::anim::invalidate_all; # d'oh	2846	cf::anim::invalidate_all; # d'oh
		2847	}
		2848
		2849	{
		2850	# TODO: for gcfclient pleasure, we should give resources
		2851	# that gcfclient doesn't grok a >10000 face index.
		2852	my $res = $facedata->{resource};
		2853	my $enc = JSON::XS->new->utf8->canonical;
		2854
		2855	while (my ($name, $info) = each %$res) {
		2856	my $meta = $enc->encode ({
		2857	name => $name,
		2858	type => $info->{type},
		2859	copyright => $info->{copyright}, #TODO#
		2860	});
		2861
		2862	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2863
		2864	if ($name =~ /\.jpg$/) {
		2865	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
		2866	cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
		2867	} else {
		2868	my $data = pack "(w/a*)*", $meta, $info->{data};
		2869	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2870
		2871	cf::face::set_type $idx, 1;
		2872	cf::face::set_data $idx, 0, $data, $chk;
		2873	}
		2874
		2875	cf::cede_to_tick;
		2876	}
2534	}	2877	}
2535		2878
2536	1	2879	1
2537	}	2880	}
2538		2881
2539	sub reload_regions {	2882	sub reload_regions {
2540	load_resource_file "$MAPDIR/regions"	2883	load_resource_file "$MAPDIR/regions"
2541	or die "unable to load regions file\n";	2884	or die "unable to load regions file\n";
		2885
		2886	for (cf::region::list) {
		2887	$_->{match} = qr/$_->{match}/
		2888	if exists $_->{match};
		2889	}
2542	}	2890	}
2543		2891
2544	sub reload_facedata {	2892	sub reload_facedata {
2545	load_facedata "$DATADIR/facedata"	2893	load_facedata "$DATADIR/facedata"
2546	or die "unable to load facedata\n";	2894	or die "unable to load facedata\n";
2547	}	2895	}
2548		2896
2549	sub reload_archetypes {	2897	sub reload_archetypes {
2550	load_resource_file "$DATADIR/archetypes"	2898	load_resource_file "$DATADIR/archetypes"
2551	or die "unable to load archetypes\n";	2899	or die "unable to load archetypes\n";
		2900	#d# NEED to laod twice to resolve forward references
		2901	# this really needs to be done in an extra post-pass
		2902	# (which needs to be synchronous, so solve it differently)
		2903	load_resource_file "$DATADIR/archetypes"
		2904	or die "unable to load archetypes\n";
2552	}	2905	}
2553		2906
2554	sub reload_treasures {	2907	sub reload_treasures {
2555	load_resource_file "$DATADIR/treasures"	2908	load_resource_file "$DATADIR/treasures"
2556	or die "unable to load treasurelists\n";	2909	or die "unable to load treasurelists\n";
…		…
2559	sub reload_resources {	2912	sub reload_resources {
2560	warn "reloading resource files...\n";	2913	warn "reloading resource files...\n";
2561		2914
2562	reload_regions;	2915	reload_regions;
2563	reload_facedata;	2916	reload_facedata;
		2917	#reload_archetypes;#d#
2564	reload_archetypes;	2918	reload_archetypes;
2565	reload_treasures;	2919	reload_treasures;
2566		2920
2567	warn "finished reloading resource files\n";	2921	warn "finished reloading resource files\n";
2568	}	2922	}
…		…
2625	},	2979	},
2626	);	2980	);
2627	}	2981	}
2628	}	2982	}
2629		2983
		2984	sub write_runtime {
		2985	my $runtime = "$LOCALDIR/runtime";
		2986
		2987	# first touch the runtime file to show we are still running:
		2988	# the fsync below can take a very very long time.
		2989
		2990	IO::AIO::aio_utime $runtime, undef, undef;
		2991
		2992	my $guard = cf::lock_acquire "write_runtime";
		2993
		2994	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2995	or return;
		2996
		2997	my $value = $cf::RUNTIME + 90 + 10;
		2998	# 10 is the runtime save interval, for a monotonic clock
		2999	# 60 allows for the watchdog to kill the server.
		3000
		3001	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3002	and return;
		3003
		3004	# always fsync - this file is important
		3005	aio_fsync $fh
		3006	and return;
		3007
		3008	# touch it again to show we are up-to-date
		3009	aio_utime $fh, undef, undef;
		3010
		3011	close $fh
		3012	or return;
		3013
		3014	aio_rename "$runtime~", $runtime
		3015	and return;
		3016
		3017	warn "runtime file written.\n";
		3018
		3019	1
		3020	}
		3021
2630	sub emergency_save() {	3022	sub emergency_save() {
2631	my $freeze_guard = cf::freeze_mainloop;	3023	my $freeze_guard = cf::freeze_mainloop;
2632		3024
2633	warn "enter emergency perl save\n";	3025	warn "enter emergency perl save\n";
2634		3026
…		…
2709	%EXT_CORO = ();	3101	%EXT_CORO = ();
2710		3102
2711	warn "removing commands";	3103	warn "removing commands";
2712	%COMMAND = ();	3104	%COMMAND = ();
2713		3105
2714	warn "removing ext commands";	3106	warn "removing ext/exti commands";
2715	%EXTCMD = ();	3107	%EXTCMD = ();
		3108	%EXTICMD = ();
2716		3109
2717	warn "unloading/nuking all extensions";	3110	warn "unloading/nuking all extensions";
2718	for my $pkg (@EXTS) {	3111	for my $pkg (@EXTS) {
2719	warn "... unloading $pkg";	3112	warn "... unloading $pkg";
2720		3113

Diff Legend

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