ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.270 by root, Sat May 26 15:44:06 2007 UTC vs.
Revision 1.322 by root, Fri Jul 27 10:10:51 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	if (my $fh = aio_open $runtime, O_WRONLY, 0) {	475	=cut
401	utime undef, undef, $fh;
402	}
403		476
404	my $guard = cf::lock_acquire "write_runtime";	477	sub _store_scalar {
405		478	open my $fh, ">", \my $buf
406	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	479	or die "fork_call: cannot open fh-to-buf in child : $!";
407	or return;	480	Storable::store_fd $_[0], $fh;
408
409	my $value = $cf::RUNTIME + 90 + 10;
410	# 10 is the runtime save interval, for a monotonic clock
411	# 60 allows for the watchdog to kill the server.
412
413	(aio_write $fh, 0, (length $value), $value, 0) <= 0
414	and return;
415
416	# always fsync - this file is important
417	aio_fsync $fh
418	and return;
419
420	# touch it again to show we are up-to-date
421	utime undef, undef, $fh;
422
423	close $fh	481	close $fh;
424	or return;
425		482
426	aio_rename "$runtime~", $runtime	483	$buf
427	and return;	484	}
428		485
429	warn "runtime file written.\n";#d#	486	sub fork_call(&@) {
		487	my ($cb, @args) = @_;
430		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;
431	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"
432	}	644	}
433		645
434	=item cf::datalog type => key => value, ...	646	=item cf::datalog type => key => value, ...
435		647
436	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.
…		…
454	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")
455	to it. All such attachable objects support the following methods.	667	to it. All such attachable objects support the following methods.
456		668
457	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>
458	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
459	crossfire+).	671	Crossfire TRT).
460		672
461	=over 4	673	=over 4
462		674
463	=item $attachable->attach ($attachment, key => $value...)	675	=item $attachable->attach ($attachment, key => $value...)
464		676
…		…
666	_attach $registry, $klass, @attach;	878	_attach $registry, $klass, @attach;
667	}	879	}
668		880
669	$obj->{$name} = \%arg;	881	$obj->{$name} = \%arg;
670	} else {	882	} else {
671	warn "object uses attachment '$name' that is not available, postponing.\n";	883	warn "object uses attachment '$name' which is not available, postponing.\n";
672	}	884	}
673		885
674	$obj->{_attachment}{$name} = undef;	886	$obj->{_attachment}{$name} = undef;
675	}	887	}
676		888
…		…
716	";	928	";
717	die if $@;	929	die if $@;
718	}	930	}
719		931
720	our $override;	932	our $override;
721	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?
722		934
723	sub override {	935	sub override {
724	$override = 1;	936	$override = 1;
725	@invoke_results = ();	937	@INVOKE_RESULTS = (@_);
726	}	938	}
727		939
728	sub do_invoke {	940	sub do_invoke {
729	my $event = shift;	941	my $event = shift;
730	my $callbacks = shift;	942	my $callbacks = shift;
731		943
732	@invoke_results = ();	944	@INVOKE_RESULTS = ();
733		945
734	local $override;	946	local $override;
735		947
736	for (@$callbacks) {	948	for (@$callbacks) {
737	eval { &{$_->[1]} };	949	eval { &{$_->[1]} };
…		…
754		966
755	Generate an object-specific event with the given arguments.	967	Generate an object-specific event with the given arguments.
756		968
757	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
758	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
759	results (if you must, access C<@cf::invoke_results> directly).	971	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
760		972
761	=back	973	=back
762		974
763	=cut	975	=cut
764		976
765	#############################################################################	977	#############################################################################
766	# 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	}
767		990
768	sub reattach {	991	sub reattach {
769	# basically do the same as instantiate, without calling instantiate	992	# basically do the same as instantiate, without calling instantiate
770	my ($obj) = @_;	993	my ($obj) = @_;
771		994
…		…
874	or return;	1097	or return;
875	$av = eval { (Storable::thaw $av)->{objs} };	1098	$av = eval { (Storable::thaw $av)->{objs} };
876	}	1099	}
877		1100
878	warn sprintf "loading %s (%d)\n",	1101	warn sprintf "loading %s (%d)\n",
879	$filename, length $data, scalar @{$av || []};#d#	1102	$filename, length $data, scalar @{$av || []};
880	return ($data, $av);	1103	return ($data, $av);
881	}	1104	}
		1105
		1106	=head2 COMMAND CALLBACKS
		1107
		1108	=over 4
		1109
		1110	=cut
882		1111
883	#############################################################################	1112	#############################################################################
884	# command handling &c	1113	# command handling &c
885		1114
886	=item cf::register_command $name => \&callback($ob,$args);	1115	=item cf::register_command $name => \&callback($ob,$args);
…		…
899	push @{ $COMMAND{$name} }, [$caller, $cb];	1128	push @{ $COMMAND{$name} }, [$caller, $cb];
900	}	1129	}
901		1130
902	=item cf::register_extcmd $name => \&callback($pl,$packet);	1131	=item cf::register_extcmd $name => \&callback($pl,$packet);
903		1132
904	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.
905		1138
906	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
907	called.	1140	called.
908		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
909	=cut	1153	=cut
910		1154
911	sub register_extcmd {	1155	sub register_extcmd {
912	my ($name, $cb) = @_;	1156	my ($name, $cb) = @_;
913		1157
914	$EXTCMD{$name} = $cb;	1158	$EXTCMD{$name} = $cb;
		1159	}
		1160
		1161	sub register_exticmd {
		1162	my ($name, $cb) = @_;
		1163
		1164	$EXTICMD{$name} = $cb;
915	}	1165	}
916		1166
917	cf::player->attach (	1167	cf::player->attach (
918	on_command => sub {	1168	on_command => sub {
919	my ($pl, $name, $params) = @_;	1169	my ($pl, $name, $params) = @_;
…		…
928	cf::override;	1178	cf::override;
929	},	1179	},
930	on_extcmd => sub {	1180	on_extcmd => sub {
931	my ($pl, $buf) = @_;	1181	my ($pl, $buf) = @_;
932		1182
933	my $msg = eval { from_json $buf };	1183	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
934		1184
935	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
936	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1191	if (my $cb = $EXTCMD{$type}) {
937	if (my %reply = $cb->($pl, $msg)) {	1192	my @reply = $cb->($pl, @payload);
		1193
938	$pl->ext_reply ($msg->{msgid}, %reply);	1194	$pl->ext_reply ($reply, @reply)
939	}	1195	if $reply;
940	}	1196	}
941	} else {	1197	} else {
942	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1198	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
943	}	1199	}
944		1200
945	cf::override;	1201	cf::override;
946	},	1202	},
947	);	1203	);
948		1204
949	sub load_extension {
950	my ($path) = @_;
951
952	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
953	my $base = $1;
954	my $pkg = $1;
955	$pkg =~ s/[^[:word:]]/_/g;
956	$pkg = "ext::$pkg";
957
958	warn "... loading '$path' into '$pkg'\n";
959
960	open my $fh, "<:utf8", $path
961	or die "$path: $!";
962
963	my $source =
964	"package $pkg; use strict; use utf8;\n"
965	. "#line 1 \"$path\"\n{\n"
966	. (do { local $/; <$fh> })
967	. "\n};\n1";
968
969	unless (eval $source) {
970	my $msg = $@ ? "$path: $@\n"
971	: "extension disabled.\n";
972	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
973	warn $@;
974	warn "mandatory extension failed to load, exiting.\n";
975	exit 1;
976	}
977	die $@;
978	}
979
980	push @EXTS, $pkg;
981	}
982
983	sub load_extensions {	1205	sub load_extensions {
		1206	cf::sync_job {
		1207	my %todo;
		1208
984	for my $ext (<$LIBDIR/*.ext>) {	1209	for my $path (<$LIBDIR/*.ext>) {
985	next unless -r $ext;	1210	next unless -r $path;
986	eval {	1211
987	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;
988	1	1269	}
989	} or warn "$ext not loaded: $@";	1270
		1271	skip:
		1272	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1273	unless $progress;
		1274	}
990	}	1275	};
991	}	1276	}
992		1277
993	#############################################################################	1278	#############################################################################
		1279
		1280	=back
994		1281
995	=head2 CORE EXTENSIONS	1282	=head2 CORE EXTENSIONS
996		1283
997	Functions and methods that extend core crossfire objects.	1284	Functions and methods that extend core crossfire objects.
998		1285
…		…
1186	}	1473	}
1187		1474
1188	\@paths	1475	\@paths
1189	}	1476	}
1190		1477
		1478	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1479
		1480	Expand crossfire pod fragments into protocol xml.
		1481
		1482	=cut
		1483
		1484	sub expand_cfpod {
		1485	((my $self), (local $_)) = @_;
		1486
		1487	# escape & and <
		1488	s/&/&amp;/g;
		1489	s/(?<![BIUGH])</&lt;/g;
		1490
		1491	# this is buggy, it needs to properly take care of nested <'s
		1492
		1493	1 while
		1494	# replace B<>, I<>, U<> etc.
		1495	s/B<([^\>]*)>/<b>$1<\/b>/
		1496	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1497	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1498	# replace G<male|female> tags
		1499	|| s{G<([^>|]*)\|([^>]*)>}{
		1500	$self->gender ? $2 : $1
		1501	}ge
		1502	# replace H<hint text>
		1503	|| s{H<([^\>]*)>}
		1504	{
		1505	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1506	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1507	"")
		1508	[$self->{hintmode}]
		1509	}ge;
		1510
		1511	# create single paragraphs (very hackish)
		1512	s/(?<=\S)\n(?=\w)/ /g;
		1513
		1514	# compress some whitespace
		1515	s/\s+\n/\n/g; # ws line-ends
		1516	s/\n\n+/\n/g; # double lines
		1517	s/^\n+//; # beginning lines
		1518	s/\n+$//; # ending lines
		1519
		1520	$_
		1521	}
		1522
		1523	sub hintmode {
		1524	$_[0]{hintmode} = $_[1] if @_ > 1;
		1525	$_[0]{hintmode}
		1526	}
		1527
1191	=item $player->ext_reply ($msgid, %msg)	1528	=item $player->ext_reply ($msgid, @msg)
1192		1529
1193	Sends an ext reply to the player.	1530	Sends an ext reply to the player.
1194		1531
1195	=cut	1532	=cut
1196		1533
1197	sub ext_reply($$%) {	1534	sub ext_reply($$@) {
1198	my ($self, $id, %msg) = @_;	1535	my ($self, $id, @msg) = @_;
1199		1536
1200	$msg{msgid} = $id;	1537	if ($self->ns->extcmd == 2) {
1201		1538	$self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1202	$self->send ("ext " . cf::to_json \%msg);	1539	} elsif ($self->ns->extcmd == 1) {
		1540	#TODO: version 1, remove
		1541	unshift @msg, msgtype => "reply", msgid => $id;
		1542	$self->send ("ext " . $self->ns->{json_coder}->encode ({@msg}));
		1543	}
1203	}	1544	}
1204		1545
1205	=item $player->ext_event ($type, %msg)	1546	=item $player->ext_msg ($type, @msg)
1206		1547
1207	Sends an ext event to the client.	1548	Sends an ext event to the client.
1208		1549
1209	=cut	1550	=cut
1210		1551
1211	sub ext_event($$%) {	1552	sub ext_msg($$@) {
1212	my ($self, $type, %msg) = @_;	1553	my ($self, $type, @msg) = @_;
1213		1554
1214	$self->ns->ext_event ($type, %msg);	1555	$self->ns->ext_msg ($type, @msg);
1215	}	1556	}
1216		1557
1217	=head3 cf::region	1558	=head3 cf::region
1218		1559
1219	=over 4	1560	=over 4
…		…
1222		1563
1223	package cf::region;	1564	package cf::region;
1224		1565
1225	=item cf::region::find_by_path $path	1566	=item cf::region::find_by_path $path
1226		1567
1227	Tries to decuce the probable region for a map knowing only its path.	1568	Tries to decuce the likely region for a map knowing only its path.
1228		1569
1229	=cut	1570	=cut
1230		1571
1231	sub find_by_path($) {	1572	sub find_by_path($) {
1232	my ($path) = @_;	1573	my ($path) = @_;
1233		1574
1234	my ($match, $specificity);	1575	my ($match, $specificity);
1235		1576
1236	for my $region (list) {	1577	for my $region (list) {
1237	if ($region->match && $path =~ $region->match) {	1578	if ($region->{match} && $path =~ $region->{match}) {
1238	($match, $specificity) = ($region, $region->specificity)	1579	($match, $specificity) = ($region, $region->specificity)
1239	if $region->specificity > $specificity;	1580	if $region->specificity > $specificity;
1240	}	1581	}
1241	}	1582	}
1242		1583
…		…
1306	my ($self, $merge) = @_;	1647	my ($self, $merge) = @_;
1307		1648
1308	# we have to keep some variables in memory intact	1649	# we have to keep some variables in memory intact
1309	local $self->{path};	1650	local $self->{path};
1310	local $self->{load_path};	1651	local $self->{load_path};
1311	local $self->{deny_save};
1312	local $self->{deny_reset};
1313		1652
1314	$self->SUPER::thawer_merge ($merge);	1653	$self->SUPER::thawer_merge ($merge);
1315	}	1654	}
1316		1655
1317	sub normalise {	1656	sub normalise {
…		…
1364	$self->init; # pass $1 etc.	1703	$self->init; # pass $1 etc.
1365	return $self;	1704	return $self;
1366	}	1705	}
1367	}	1706	}
1368		1707
1369	Carp::carp "unable to resolve path '$path' (base '$base').";	1708	Carp::cluck "unable to resolve path '$path' (base '$base').";
1370	()	1709	()
1371	}	1710	}
1372		1711
1373	sub init {	1712	sub init {
1374	my ($self) = @_;	1713	my ($self) = @_;
…		…
1415	sub change_all_map_light {	1754	sub change_all_map_light {
1416	my ($change) = @_;	1755	my ($change) = @_;
1417		1756
1418	$_->change_map_light ($change)	1757	$_->change_map_light ($change)
1419	for grep $_->outdoor, values %cf::MAP;	1758	for grep $_->outdoor, values %cf::MAP;
		1759	}
		1760
		1761	sub decay_objects {
		1762	my ($self) = @_;
		1763
		1764	return if $self->{deny_reset};
		1765
		1766	$self->do_decay_objects;
1420	}	1767	}
1421		1768
1422	sub unlink_save {	1769	sub unlink_save {
1423	my ($self) = @_;	1770	my ($self) = @_;
1424		1771
…		…
1482	$self->load_header_orig	1829	$self->load_header_orig
1483	or return;	1830	or return;
1484	$self->prepare_orig;	1831	$self->prepare_orig;
1485	}	1832	}
1486		1833
		1834	$self->{deny_reset} = 1
		1835	if $self->no_reset;
		1836
1487	$self->default_region (cf::region::find_by_path $self->{path})	1837	$self->default_region (cf::region::find_by_path $self->{path})
1488	unless $self->default_region;	1838	unless $self->default_region;
1489		1839
1490	1	1840	1
1491	}	1841	}
…		…
1506	$map->{last_save} = $cf::RUNTIME;	1856	$map->{last_save} = $cf::RUNTIME;
1507		1857
1508	$map->load_header	1858	$map->load_header
1509	or return;	1859	or return;
1510		1860
1511	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1861	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1512	# doing this can freeze the server in a sync job, obviously	1862	# doing this can freeze the server in a sync job, obviously
1513	#$cf::WAIT_FOR_TICK->wait;	1863	#$cf::WAIT_FOR_TICK->wait;
1514	$map->reset;	1864	$map->reset;
1515	undef $guard;	1865	undef $guard;
1516	return find $path;	1866	return find $path;
…		…
1583	my ($self, $ob) = @_;	1933	my ($self, $ob) = @_;
1584		1934
1585	return find "~" . $ob->name . "/" . $self->{path}	1935	return find "~" . $ob->name . "/" . $self->{path}
1586	if $self->per_player;	1936	if $self->per_player;
1587		1937
		1938	# return find "?party/" . $ob->name . "/" . $self->{path}
		1939	# if $self->per_party;
		1940
1588	$self	1941	$self
1589	}	1942	}
1590		1943
1591	# find and load all maps in the 3x3 area around a map	1944	# find and load all maps in the 3x3 area around a map
1592	sub load_diag {	1945	sub load_diag {
…		…
1638		1991
1639	undef $MAP_PREFETCH{$path};	1992	undef $MAP_PREFETCH{$path};
1640	$MAP_PREFETCHER ||= cf::async {	1993	$MAP_PREFETCHER ||= cf::async {
1641	while (%MAP_PREFETCH) {	1994	while (%MAP_PREFETCH) {
1642	for my $path (keys %MAP_PREFETCH) {	1995	for my $path (keys %MAP_PREFETCH) {
1643	my $map = find $path	1996	if (my $map = find $path) {
1644	or next;
1645	$map->load;	1997	$map->load;
		1998	}
1646		1999
1647	delete $MAP_PREFETCH{$path};	2000	delete $MAP_PREFETCH{$path};
1648	}	2001	}
1649	}	2002	}
1650	undef $MAP_PREFETCHER;	2003	undef $MAP_PREFETCHER;
…		…
1702		2055
1703	sub reset_at {	2056	sub reset_at {
1704	my ($self) = @_;	2057	my ($self) = @_;
1705		2058
1706	# TODO: safety, remove and allow resettable per-player maps	2059	# TODO: safety, remove and allow resettable per-player maps
1707	return 1e99 if $self->isa ("ext::map_per_player");#d#
1708	return 1e99 if $self->{deny_reset};	2060	return 1e99 if $self->{deny_reset};
1709		2061
1710	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2062	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1711	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2063	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1712		2064
…		…
1723	my ($self) = @_;	2075	my ($self) = @_;
1724		2076
1725	my $lock = cf::lock_acquire "map_data:$self->{path}";	2077	my $lock = cf::lock_acquire "map_data:$self->{path}";
1726		2078
1727	return if $self->players;	2079	return if $self->players;
1728	return if $self->isa ("ext::map_per_player");#d#
1729		2080
1730	warn "resetting map ", $self->path;#d#	2081	warn "resetting map ", $self->path;
1731		2082
1732	$self->in_memory (cf::MAP_SWAPPED);	2083	$self->in_memory (cf::MAP_SWAPPED);
1733		2084
1734	# need to save uniques path	2085	# need to save uniques path
1735	unless ($self->{deny_save}) {	2086	unless ($self->{deny_save}) {
…		…
1767	$cf::MAP{$self->path} = $self;	2118	$cf::MAP{$self->path} = $self;
1768		2119
1769	$self->reset; # polite request, might not happen	2120	$self->reset; # polite request, might not happen
1770	}	2121	}
1771		2122
		2123	=item $maps = cf::map::tmp_maps
		2124
		2125	Returns an arrayref with all map paths of currently instantiated and saved
		2126	maps. May block.
		2127
		2128	=cut
		2129
		2130	sub tmp_maps() {
		2131	[
		2132	map {
		2133	utf8::decode $_;
		2134	/\.map$/
		2135	? normalise $_
		2136	: ()
		2137	} @{ aio_readdir $TMPDIR or [] }
		2138	]
		2139	}
		2140
		2141	=item $maps = cf::map::random_maps
		2142
		2143	Returns an arrayref with all map paths of currently instantiated and saved
		2144	random maps. May block.
		2145
		2146	=cut
		2147
		2148	sub random_maps() {
		2149	[
		2150	map {
		2151	utf8::decode $_;
		2152	/\.map$/
		2153	? normalise "?random/$_"
		2154	: ()
		2155	} @{ aio_readdir $RANDOMDIR or [] }
		2156	]
		2157	}
		2158
1772	=item cf::map::unique_maps	2159	=item cf::map::unique_maps
1773		2160
1774	Returns an arrayref of paths of all shared maps that have	2161	Returns an arrayref of paths of all shared maps that have
1775	instantiated unique items. May block.	2162	instantiated unique items. May block.
1776		2163
1777	=cut	2164	=cut
1778		2165
1779	sub unique_maps() {	2166	sub unique_maps() {
1780	my $files = aio_readdir $UNIQUEDIR	2167	[
1781	or return;	2168	map {
1782
1783	my @paths;
1784
1785	for (@$files) {
1786	utf8::decode $_;	2169	utf8::decode $_;
1787	next if /\.pst$/;	2170	/\.map$/
1788	next unless /^$PATH_SEP/o;	2171	? normalise $_
1789		2172	: ()
1790	push @paths, cf::map::normalise $_;	2173	} @{ aio_readdir $UNIQUEDIR or [] }
1791	}	2174	]
1792
1793	\@paths
1794	}	2175	}
1795		2176
1796	package cf;	2177	package cf;
1797		2178
1798	=back	2179	=back
…		…
1844		2225
1845	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2226	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1846		2227
1847	if ($self->{record_replies}) {	2228	if ($self->{record_replies}) {
1848	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2229	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2230
1849	} else {	2231	} else {
		2232	my $pl = $self->contr;
		2233
		2234	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2235	my $dialog = $pl->{npc_dialog};
		2236	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2237
		2238	} else {
1850	$msg = $npc->name . " says: $msg" if $npc;	2239	$msg = $npc->name . " says: $msg" if $npc;
1851	$self->message ($msg, $flags);	2240	$self->message ($msg, $flags);
		2241	}
1852	}	2242	}
1853	}	2243	}
1854		2244
1855	=item $player_object->may ("access")	2245	=item $player_object->may ("access")
1856		2246
…		…
1945		2335
1946	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2336	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1947	$self->enter_map ($map, $x, $y);	2337	$self->enter_map ($map, $x, $y);
1948	}	2338	}
1949		2339
1950	=item $player_object->goto ($path, $x, $y[, $check->($map)])	2340	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1951		2341
1952	Moves the player to the given map-path and coordinates by first freezing	2342	Moves the player to the given map-path and coordinates by first freezing
1953	her, loading and preparing them map, calling the provided $check callback	2343	her, loading and preparing them map, calling the provided $check callback
1954	that has to return the map if sucecssful, and then unfreezes the player on	2344	that has to return the map if sucecssful, and then unfreezes the player on
1955	the new (success) or old (failed) map position.	2345	the new (success) or old (failed) map position. In either case, $done will
		2346	be called at the end of this process.
1956		2347
1957	=cut	2348	=cut
1958		2349
1959	our $GOTOGEN;	2350	our $GOTOGEN;
1960		2351
1961	sub cf::object::player::goto {	2352	sub cf::object::player::goto {
1962	my ($self, $path, $x, $y, $check) = @_;	2353	my ($self, $path, $x, $y, $check, $done) = @_;
1963		2354
1964	# do generation counting so two concurrent goto's will be executed in-order	2355	# do generation counting so two concurrent goto's will be executed in-order
1965	my $gen = $self->{_goto_generation} = ++$GOTOGEN;	2356	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1966		2357
1967	$self->enter_link;	2358	$self->enter_link;
…		…
1987		2378
1988	if ($gen == $self->{_goto_generation}) {	2379	if ($gen == $self->{_goto_generation}) {
1989	delete $self->{_goto_generation};	2380	delete $self->{_goto_generation};
1990	$self->leave_link ($map, $x, $y);	2381	$self->leave_link ($map, $x, $y);
1991	}	2382	}
		2383
		2384	$done->() if $done;
1992	})->prio (1);	2385	})->prio (1);
1993	}	2386	}
1994		2387
1995	=item $player_object->enter_exit ($exit_object)	2388	=item $player_object->enter_exit ($exit_object)
1996		2389
…		…
2065	my $hp = $exit->stats->hp;	2458	my $hp = $exit->stats->hp;
2066	my $sp = $exit->stats->sp;	2459	my $sp = $exit->stats->sp;
2067		2460
2068	$self->enter_link;	2461	$self->enter_link;
2069		2462
		2463	# if exit is damned, update players death & WoR home-position
		2464	$self->contr->savebed ($slaying, $hp, $sp)
		2465	if $exit->flag (FLAG_DAMNED);
		2466
2070	(async {	2467	(async {
2071	$self->deactivate_recursive; # just to be sure	2468	$self->deactivate_recursive; # just to be sure
2072	unless (eval {	2469	unless (eval {
2073	$self->goto ($slaying, $hp, $sp);	2470	$self->goto ($slaying, $hp, $sp);
2074		2471
…		…
2101		2498
2102	utf8::encode $text;	2499	utf8::encode $text;
2103	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2500	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2104	}	2501	}
2105		2502
		2503	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2504
		2505	Send a drawinfo or msg packet to the client, formatting the msg for the
		2506	client if neccessary. C<$type> should be a string identifying the type of
		2507	the message, with C<log> being the default. If C<$color> is negative, suppress
		2508	the message unless the client supports the msg packet.
		2509
		2510	=cut
		2511
		2512	sub cf::client::send_msg {
		2513	my ($self, $channel, $msg, $color, @extra) = @_;
		2514
		2515	$msg = $self->pl->expand_cfpod ($msg);
		2516
		2517	$color &= ~cf::NDI_UNIQUE; # just in case...
		2518
		2519	if (ref $channel) {
		2520	# send meta info to client, if not yet sent
		2521	unless (exists $self->{channel}{$channel->{id}}) {
		2522	$self->{channel}{$channel->{id}} = $channel;
		2523	$self->ext_msg (channel_info => $channel);
		2524	}
		2525
		2526	$channel = $channel->{id};
		2527	}
		2528
		2529	return unless @extra || length $msg;
		2530
		2531	if ($self->can_msg) {
		2532	$self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
		2533	} else {
		2534	# replace some tags by gcfclient-compatible ones
		2535	for ($msg) {
		2536	1 while
		2537	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2538	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2539	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2540	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2541	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2542	}
		2543
		2544	if ($color >= 0) {
		2545	if (0 && $msg =~ /\[/) {
		2546	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2547	} else {
		2548	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2549	$self->send_packet ("drawinfo $color $msg")
		2550	}
		2551	}
		2552	}
		2553	}
		2554
2106	=item $client->ext_event ($type, %msg)	2555	=item $client->ext_msg ($type, @msg)
2107		2556
2108	Sends an exti event to the client.	2557	Sends an ext event to the client.
2109		2558
2110	=cut	2559	=cut
2111		2560
2112	sub cf::client::ext_event($$%) {	2561	sub cf::client::ext_msg($$@) {
2113	my ($self, $type, %msg) = @_;	2562	my ($self, $type, @msg) = @_;
2114		2563
		2564	my $extcmd = $self->extcmd;
		2565
		2566	if ($extcmd == 2) {
		2567	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2568	} elsif ($extcmd == 1) { # TODO: remove
2115	$msg{msgtype} = "event_$type";	2569	push @msg, msgtype => "event_$type";
2116	$self->send_packet ("ext " . cf::to_json \%msg);	2570	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2571	}
2117	}	2572	}
2118		2573
2119	=item $success = $client->query ($flags, "text", \&cb)	2574	=item $success = $client->query ($flags, "text", \&cb)
2120		2575
2121	Queues a query to the client, calling the given callback with	2576	Queues a query to the client, calling the given callback with
2122	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2577	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2123	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2578	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2124		2579
2125	Queries can fail, so check the return code. Or don't, as queries will become	2580	Queries can fail, so check the return code. Or don't, as queries will
2126	reliable at some point in the future.	2581	become reliable at some point in the future.
2127		2582
2128	=cut	2583	=cut
2129		2584
2130	sub cf::client::query {	2585	sub cf::client::query {
2131	my ($self, $flags, $text, $cb) = @_;	2586	my ($self, $flags, $text, $cb) = @_;
…		…
2139	utf8::encode $text;	2594	utf8::encode $text;
2140	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2595	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2141		2596
2142	$self->send_packet ($self->{query_queue}[0][0])	2597	$self->send_packet ($self->{query_queue}[0][0])
2143	if @{ $self->{query_queue} } == 1;	2598	if @{ $self->{query_queue} } == 1;
		2599
		2600	1
2144	}	2601	}
2145		2602
2146	cf::client->attach (	2603	cf::client->attach (
		2604	on_connect => sub {
		2605	my ($ns) = @_;
		2606
		2607	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2608	},
2147	on_reply => sub {	2609	on_reply => sub {
2148	my ($ns, $msg) = @_;	2610	my ($ns, $msg) = @_;
2149		2611
2150	# this weird shuffling is so that direct followup queries	2612	# this weird shuffling is so that direct followup queries
2151	# get handled first	2613	# get handled first
…		…
2163	} else {	2625	} else {
2164	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2626	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2165	}	2627	}
2166	}	2628	}
2167	},	2629	},
		2630	on_exticmd => sub {
		2631	my ($ns, $buf) = @_;
		2632
		2633	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2634
		2635	if (ref $msg) {
		2636	my ($type, $reply, @payload) =
		2637	"ARRAY" eq ref $msg
		2638	? @$msg
		2639	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2640
		2641	if (my $cb = $EXTICMD{$type}) {
		2642	my @reply = $cb->($ns, @payload);
		2643
		2644	$ns->ext_reply ($reply, @reply)
		2645	if $reply;
		2646	}
		2647	} else {
		2648	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2649	}
		2650
		2651	cf::override;
		2652	},
2168	);	2653	);
2169		2654
2170	=item $client->async (\&cb)	2655	=item $client->async (\&cb)
2171		2656
2172	Create a new coroutine, running the specified callback. The coroutine will	2657	Create a new coroutine, running the specified callback. The coroutine will
…		…
2221		2706
2222	=pod	2707	=pod
2223		2708
2224	The following functions and methods are available within a safe environment:	2709	The following functions and methods are available within a safe environment:
2225		2710
2226	cf::object contr pay_amount pay_player map	2711	cf::object
		2712	contr pay_amount pay_player map x y force_find force_add
		2713	insert remove
		2714
2227	cf::object::player player	2715	cf::object::player
2228	cf::player peaceful	2716	player
2229	cf::map trigger	2717
		2718	cf::player
		2719	peaceful
		2720
		2721	cf::map
		2722	trigger
2230		2723
2231	=cut	2724	=cut
2232		2725
2233	for (	2726	for (
2234	["cf::object" => qw(contr pay_amount pay_player map)],	2727	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2728	insert remove)],
2235	["cf::object::player" => qw(player)],	2729	["cf::object::player" => qw(player)],
2236	["cf::player" => qw(peaceful)],	2730	["cf::player" => qw(peaceful)],
2237	["cf::map" => qw(trigger)],	2731	["cf::map" => qw(trigger)],
2238	) {	2732	) {
2239	no strict 'refs';	2733	no strict 'refs';
…		…
2310	=back	2804	=back
2311		2805
2312	=cut	2806	=cut
2313		2807
2314	#############################################################################	2808	#############################################################################
2315
2316	=head2 EXTENSION DATABASE SUPPORT
2317
2318	Crossfire maintains a very simple database for extension use. It can
2319	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2320	convert to/from binary).
2321
2322	The parameter C<$family> should best start with the name of the extension
2323	using it, it should be unique.
2324
2325	=over 4
2326
2327	=item $value = cf::db_get $family => $key
2328
2329	Returns a single value from the database.
2330
2331	=item cf::db_put $family => $key => $value
2332
2333	Stores the given C<$value> in the family.
2334
2335	=cut
2336
2337	our $DB;
2338
2339	sub db_init {
2340	unless ($DB) {
2341	$DB = BDB::db_create $DB_ENV;
2342
2343	cf::sync_job {
2344	eval {
2345	$DB->set_flags (BDB::CHKSUM);
2346
2347	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2348	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2349	cf::cleanup "db_open(db): $!" if $!;
2350	};
2351	cf::cleanup "db_open(db): $@" if $@;
2352	};
2353	}
2354	}
2355
2356	sub db_get($$) {
2357	my $key = "$_[0]/$_[1]";
2358
2359	cf::sync_job {
2360	BDB::db_get $DB, undef, $key, my $data;
2361
2362	$! ? ()
2363	: $data
2364	}
2365	}
2366
2367	sub db_put($$$) {
2368	BDB::dbreq_pri 4;
2369	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2370	}
2371
2372	=item cf::cache $id => [$paths...], $processversion => $process
2373
2374	Generic caching function that returns the value of the resource $id,
2375	caching and regenerating as required.
2376
2377	This function can block.
2378
2379	=cut
2380
2381	sub cache {
2382	my ($id, $src, $processversion, $process) = @_;
2383
2384	my $meta =
2385	join "\x00",
2386	$processversion,
2387	map {
2388	aio_stat $_
2389	and Carp::croak "$_: $!";
2390
2391	($_, (stat _)[7,9])
2392	} @$src;
2393
2394	my $dbmeta = db_get cache => "$id/meta";
2395	if ($dbmeta ne $meta) {
2396	# changed, we may need to process
2397
2398	my @data;
2399	my $md5;
2400
2401	for (0 .. $#$src) {
2402	0 <= aio_load $src->[$_], $data[$_]
2403	or Carp::croak "$src->[$_]: $!";
2404	}
2405
2406	# if processing is expensive, check
2407	# checksum first
2408	if (1) {
2409	$md5 =
2410	join "\x00",
2411	$processversion,
2412	map {
2413	Coro::cede;
2414	($src->[$_], Digest::MD5::md5_hex $data[$_])
2415	} 0.. $#$src;
2416
2417
2418	my $dbmd5 = db_get cache => "$id/md5";
2419	if ($dbmd5 eq $md5) {
2420	db_put cache => "$id/meta", $meta;
2421
2422	return db_get cache => "$id/data";
2423	}
2424	}
2425
2426	my $t1 = Time::HiRes::time;
2427	my $data = $process->(\@data);
2428	my $t2 = Time::HiRes::time;
2429
2430	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2431
2432	db_put cache => "$id/data", $data;
2433	db_put cache => "$id/md5" , $md5;
2434	db_put cache => "$id/meta", $meta;
2435
2436	return $data;
2437	}
2438
2439	db_get cache => "$id/data"
2440	}
2441
2442	=item fork_call { }, $args
2443
2444	Executes the given code block with the given arguments in a seperate
2445	process, returning the results. Everything must be serialisable with
2446	Coro::Storable. May, of course, block. Note that the executed sub may
2447	never block itself or use any form of Event handling.
2448
2449	=cut
2450
2451	sub fork_call(&@) {
2452	my ($cb, @args) = @_;
2453
2454	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2455	# or die "socketpair: $!";
2456	pipe my $fh1, my $fh2
2457	or die "pipe: $!";
2458
2459	if (my $pid = fork) {
2460	close $fh2;
2461
2462	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2463	$res = Coro::Storable::thaw $res;
2464
2465	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2466
2467	die $$res unless "ARRAY" eq ref $res;
2468
2469	return wantarray ? @$res : $res->[-1];
2470	} else {
2471	reset_signals;
2472	local $SIG{__WARN__};
2473	local $SIG{__DIE__};
2474	eval {
2475	close $fh1;
2476
2477	my @res = eval { $cb->(@args) };
2478	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2479	};
2480
2481	warn $@ if $@;
2482	_exit 0;
2483	}
2484	}
2485
2486
2487
2488	#############################################################################
2489	# the server's init and main functions	2809	# the server's init and main functions
2490		2810
2491	sub load_facedata($) {	2811	sub load_facedata($) {
2492	my ($path) = @_;	2812	my ($path) = @_;
2493		2813
…		…
2505	{	2825	{
2506	my $faces = $facedata->{faceinfo};	2826	my $faces = $facedata->{faceinfo};
2507		2827
2508	while (my ($face, $info) = each %$faces) {	2828	while (my ($face, $info) = each %$faces) {
2509	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2829	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2510	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2830	cf::face::set_visibility $idx, $info->{visibility};
		2831	cf::face::set_magicmap $idx, $info->{magicmap};
2511	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2832	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2512	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	2833	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2513	Coro::cede;	2834
		2835	cf::cede_to_tick;
2514	}	2836	}
2515		2837
2516	while (my ($face, $info) = each %$faces) {	2838	while (my ($face, $info) = each %$faces) {
2517	next unless $info->{smooth};	2839	next unless $info->{smooth};
2518	my $idx = cf::face::find $face	2840	my $idx = cf::face::find $face
2519	or next;	2841	or next;
2520	if (my $smooth = cf::face::find $info->{smooth}) {	2842	if (my $smooth = cf::face::find $info->{smooth}) {
		2843	cf::face::set_smooth $idx, $smooth;
2521	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	2844	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2522	} else {	2845	} else {
2523	warn "smooth face '$info->{smooth}' not found for face '$face'";	2846	warn "smooth face '$info->{smooth}' not found for face '$face'";
2524	}	2847	}
2525	Coro::cede;	2848
		2849	cf::cede_to_tick;
2526	}	2850	}
2527	}	2851	}
2528		2852
2529	{	2853	{
2530	my $anims = $facedata->{animinfo};	2854	my $anims = $facedata->{animinfo};
2531		2855
2532	while (my ($anim, $info) = each %$anims) {	2856	while (my ($anim, $info) = each %$anims) {
2533	cf::anim::set $anim, $info->{frames}, $info->{facings};	2857	cf::anim::set $anim, $info->{frames}, $info->{facings};
2534	Coro::cede;	2858	cf::cede_to_tick;
2535	}	2859	}
2536		2860
2537	cf::anim::invalidate_all; # d'oh	2861	cf::anim::invalidate_all; # d'oh
2538	}	2862	}
2539		2863
		2864	{
		2865	# TODO: for gcfclient pleasure, we should give resources
		2866	# that gcfclient doesn't grok a >10000 face index.
		2867	my $res = $facedata->{resource};
		2868	my $enc = JSON::XS->new->utf8->canonical;
		2869
		2870	my $soundconf = delete $res->{"res/sound.conf"};
		2871
		2872	while (my ($name, $info) = each %$res) {
		2873	my $meta = $enc->encode ({
		2874	name => $name,
		2875	%{ $info->{meta} || {} },
		2876	});
		2877
		2878	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2879
		2880	if ($info->{type} & 1) {
		2881	# prepend meta info
		2882
		2883	my $data = pack "(w/a*)*", $meta, $info->{data};
		2884	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2885
		2886	cf::face::set_data $idx, 0, $data, $chk;
		2887	} else {
		2888	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
		2889	}
		2890
		2891	cf::face::set_type $idx, $info->{type};
		2892
		2893	cf::cede_to_tick;
		2894	}
		2895
		2896	if ($soundconf) {
		2897	$soundconf = $enc->decode (delete $soundconf->{data});
		2898
		2899	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2900	my $sound = $soundconf->{compat}[$_]
		2901	or next;
		2902
		2903	my $face = cf::face::find "sound/$sound->[1]";
		2904
		2905	cf::sound::set $sound->[0] => $face;
		2906	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2907	}
		2908
		2909	#TODO
		2910	}
		2911	}
		2912
2540	1	2913	1
2541	}	2914	}
		2915
		2916	register_exticmd fx_want => sub {
		2917	my ($ns, $want) = @_;
		2918
		2919	while (my ($k, $v) = each %$want) {
		2920	$ns->fx_want ($k, $v);
		2921	}
		2922	};
2542		2923
2543	sub reload_regions {	2924	sub reload_regions {
2544	load_resource_file "$MAPDIR/regions"	2925	load_resource_file "$MAPDIR/regions"
2545	or die "unable to load regions file\n";	2926	or die "unable to load regions file\n";
		2927
		2928	for (cf::region::list) {
		2929	$_->{match} = qr/$_->{match}/
		2930	if exists $_->{match};
		2931	}
2546	}	2932	}
2547		2933
2548	sub reload_facedata {	2934	sub reload_facedata {
2549	load_facedata "$DATADIR/facedata"	2935	load_facedata "$DATADIR/facedata"
2550	or die "unable to load facedata\n";	2936	or die "unable to load facedata\n";
2551	}	2937	}
2552		2938
2553	sub reload_archetypes {	2939	sub reload_archetypes {
2554	load_resource_file "$DATADIR/archetypes"	2940	load_resource_file "$DATADIR/archetypes"
2555	or die "unable to load archetypes\n";	2941	or die "unable to load archetypes\n";
		2942	#d# NEED to laod twice to resolve forward references
		2943	# this really needs to be done in an extra post-pass
		2944	# (which needs to be synchronous, so solve it differently)
		2945	load_resource_file "$DATADIR/archetypes"
		2946	or die "unable to load archetypes\n";
2556	}	2947	}
2557		2948
2558	sub reload_treasures {	2949	sub reload_treasures {
2559	load_resource_file "$DATADIR/treasures"	2950	load_resource_file "$DATADIR/treasures"
2560	or die "unable to load treasurelists\n";	2951	or die "unable to load treasurelists\n";
…		…
2563	sub reload_resources {	2954	sub reload_resources {
2564	warn "reloading resource files...\n";	2955	warn "reloading resource files...\n";
2565		2956
2566	reload_regions;	2957	reload_regions;
2567	reload_facedata;	2958	reload_facedata;
		2959	#reload_archetypes;#d#
2568	reload_archetypes;	2960	reload_archetypes;
2569	reload_treasures;	2961	reload_treasures;
2570		2962
2571	warn "finished reloading resource files\n";	2963	warn "finished reloading resource files\n";
2572	}	2964	}
…		…
2629	},	3021	},
2630	);	3022	);
2631	}	3023	}
2632	}	3024	}
2633		3025
		3026	sub write_runtime {
		3027	my $runtime = "$LOCALDIR/runtime";
		3028
		3029	# first touch the runtime file to show we are still running:
		3030	# the fsync below can take a very very long time.
		3031
		3032	IO::AIO::aio_utime $runtime, undef, undef;
		3033
		3034	my $guard = cf::lock_acquire "write_runtime";
		3035
		3036	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3037	or return;
		3038
		3039	my $value = $cf::RUNTIME + 90 + 10;
		3040	# 10 is the runtime save interval, for a monotonic clock
		3041	# 60 allows for the watchdog to kill the server.
		3042
		3043	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3044	and return;
		3045
		3046	# always fsync - this file is important
		3047	aio_fsync $fh
		3048	and return;
		3049
		3050	# touch it again to show we are up-to-date
		3051	aio_utime $fh, undef, undef;
		3052
		3053	close $fh
		3054	or return;
		3055
		3056	aio_rename "$runtime~", $runtime
		3057	and return;
		3058
		3059	warn "runtime file written.\n";
		3060
		3061	1
		3062	}
		3063
2634	sub emergency_save() {	3064	sub emergency_save() {
2635	my $freeze_guard = cf::freeze_mainloop;	3065	my $freeze_guard = cf::freeze_mainloop;
2636		3066
2637	warn "enter emergency perl save\n";	3067	warn "enter emergency perl save\n";
2638		3068
…		…
2713	%EXT_CORO = ();	3143	%EXT_CORO = ();
2714		3144
2715	warn "removing commands";	3145	warn "removing commands";
2716	%COMMAND = ();	3146	%COMMAND = ();
2717		3147
2718	warn "removing ext commands";	3148	warn "removing ext/exti commands";
2719	%EXTCMD = ();	3149	%EXTCMD = ();
		3150	%EXTICMD = ();
2720		3151
2721	warn "unloading/nuking all extensions";	3152	warn "unloading/nuking all extensions";
2722	for my $pkg (@EXTS) {	3153	for my $pkg (@EXTS) {
2723	warn "... unloading $pkg";	3154	warn "... unloading $pkg";
2724		3155

Diff Legend

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