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.272 by root, Sun Jun 3 15:32:50 2007 UTC vs.
Revision 1.314 by root, Mon Jul 23 16:53:15 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]
		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	Useful for short background jobs.
		334
		335	=cut
		336
		337	our @SLOT_QUEUE;
		338	our $SLOT_QUEUE;
		339
		340	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		341	$SLOT_QUEUE = Coro::async {
		342	my $signal = new Coro::Signal;
		343
		344	while () {
		345	next_job:
		346	my $avail = cf::till_tick;
		347	if ($avail > 0.01) {
		348	for (0 .. $#SLOT_QUEUE) {
		349	if ($SLOT_QUEUE[$_][0] < $avail) {
		350	my $job = splice @SLOT_QUEUE, $_, 1, ();
		351	$job->[2]->send;
		352	Coro::cede;
		353	goto next_job;
		354	}
		355	}
		356	}
		357
		358	if (@SLOT_QUEUE) {
		359	# we do not use wait_For_tick() as it returns immediately when tick is inactive
		360	push @cf::WAIT_FOR_TICK, $signal;
		361	$signal->wait;
		362	} else {
		363	Coro::schedule;
		364	}
		365	}
		366	};
		367
		368	sub get_slot($;$) {
		369	my ($time, $pri) = @_;
		370
		371	push @SLOT_QUEUE, [$time, $pri, my $sig = new Coro::Signal];
		372	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		373	$SLOT_QUEUE->ready;
		374	$sig->wait;
		375	}
		376
310	=item cf::async { BLOCK }	377	=item cf::async { BLOCK }
311		378
312	Currently the same as Coro::async_pool, meaning you cannot use	379	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	380	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.	381	thing you are allowed to do is call C<prio> on it.
…		…
317		384
318	BEGIN { *async = \&Coro::async_pool }	385	BEGIN { *async = \&Coro::async_pool }
319		386
320	=item cf::sync_job { BLOCK }	387	=item cf::sync_job { BLOCK }
321		388
322	The design of crossfire+ requires that the main coro ($Coro::main) is	389	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	390	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.	391	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		392	acceptable.
325		393
326	If it must be done, put the blocking parts into C<sync_job>. This will run	394	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	395	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	396	server will be frozen during this time, so the block should either finish
329	fast or be very important.	397	fast or be very important.
…		…
389	$EXT_CORO{$coro+0} = $coro;	457	$EXT_CORO{$coro+0} = $coro;
390		458
391	$coro	459	$coro
392	}	460	}
393		461
394	sub write_runtime {	462	=item fork_call { }, $args
395	my $runtime = "$LOCALDIR/runtime";
396		463
397	# first touch the runtime file to show we are still running:	464	Executes the given code block with the given arguments in a seperate
398	# the fsync below can take a very very long time.	465	process, returning the results. Everything must be serialisable with
		466	Coro::Storable. May, of course, block. Note that the executed sub may
		467	never block itself or use any form of Event handling.
399		468
400	IO::AIO::aio_utime $runtime, undef, undef;	469	=cut
401		470
402	my $guard = cf::lock_acquire "write_runtime";	471	sub _store_scalar {
403		472	open my $fh, ">", \my $buf
404	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	473	or die "fork_call: cannot open fh-to-buf in child : $!";
405	or return;	474	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	475	close $fh;
422	or return;
423		476
424	aio_rename "$runtime~", $runtime	477	$buf
425	and return;	478	}
426		479
427	warn "runtime file written.\n";#d#	480	sub fork_call(&@) {
		481	my ($cb, @args) = @_;
428		482
		483	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
		484	# or die "socketpair: $!";
		485	pipe my $fh1, my $fh2
		486	or die "pipe: $!";
		487
		488	if (my $pid = fork) {
		489	close $fh2;
		490
		491	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
		492	warn "pst<$res>" unless $res =~ /^pst/;
		493	$res = Coro::Storable::thaw $res;
		494
		495	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		496
		497	Carp::confess $$res unless "ARRAY" eq ref $res;
		498
		499	return wantarray ? @$res : $res->[-1];
		500	} else {
		501	reset_signals;
		502	local $SIG{__WARN__};
		503	local $SIG{__DIE__};
		504	# just in case, this hack effectively disables event
		505	# in the child. cleaner and slower would be canceling all watchers,
		506	# but this works for the time being.
		507	local $Coro::idle;
		508	$Coro::current->prio (Coro::PRIO_MAX);
		509
		510	eval {
		511	close $fh1;
		512
		513	my @res = eval { $cb->(@args) };
		514
		515	syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
		516	close $fh2;
		517	};
		518
		519	warn $@ if $@;
		520	_exit 0;
429	1	521	}
		522	}
		523
		524	=item $value = cf::db_get $family => $key
		525
		526	Returns a single value from the environment database.
		527
		528	=item cf::db_put $family => $key => $value
		529
		530	Stores the given C<$value> in the family. It can currently store binary
		531	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		532
		533	=cut
		534
		535	our $DB;
		536
		537	sub db_init {
		538	unless ($DB) {
		539	$DB = BDB::db_create $DB_ENV;
		540
		541	cf::sync_job {
		542	eval {
		543	$DB->set_flags (BDB::CHKSUM);
		544
		545	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		546	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		547	cf::cleanup "db_open(db): $!" if $!;
		548	};
		549	cf::cleanup "db_open(db): $@" if $@;
		550	};
		551	}
		552	}
		553
		554	sub db_get($$) {
		555	my $key = "$_[0]/$_[1]";
		556
		557	cf::sync_job {
		558	BDB::db_get $DB, undef, $key, my $data;
		559
		560	$! ? ()
		561	: $data
		562	}
		563	}
		564
		565	sub db_put($$$) {
		566	BDB::dbreq_pri 4;
		567	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		568	}
		569
		570	=item cf::cache $id => [$paths...], $processversion => $process
		571
		572	Generic caching function that returns the value of the resource $id,
		573	caching and regenerating as required.
		574
		575	This function can block.
		576
		577	=cut
		578
		579	sub cache {
		580	my ($id, $src, $processversion, $process) = @_;
		581
		582	my $meta =
		583	join "\x00",
		584	$processversion,
		585	map {
		586	aio_stat $_
		587	and Carp::croak "$_: $!";
		588
		589	($_, (stat _)[7,9])
		590	} @$src;
		591
		592	my $dbmeta = db_get cache => "$id/meta";
		593	if ($dbmeta ne $meta) {
		594	# changed, we may need to process
		595
		596	my @data;
		597	my $md5;
		598
		599	for (0 .. $#$src) {
		600	0 <= aio_load $src->[$_], $data[$_]
		601	or Carp::croak "$src->[$_]: $!";
		602	}
		603
		604	# if processing is expensive, check
		605	# checksum first
		606	if (1) {
		607	$md5 =
		608	join "\x00",
		609	$processversion,
		610	map {
		611	Coro::cede;
		612	($src->[$_], Digest::MD5::md5_hex $data[$_])
		613	} 0.. $#$src;
		614
		615
		616	my $dbmd5 = db_get cache => "$id/md5";
		617	if ($dbmd5 eq $md5) {
		618	db_put cache => "$id/meta", $meta;
		619
		620	return db_get cache => "$id/data";
		621	}
		622	}
		623
		624	my $t1 = Time::HiRes::time;
		625	my $data = $process->(\@data);
		626	my $t2 = Time::HiRes::time;
		627
		628	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		629
		630	db_put cache => "$id/data", $data;
		631	db_put cache => "$id/md5" , $md5;
		632	db_put cache => "$id/meta", $meta;
		633
		634	return $data;
		635	}
		636
		637	db_get cache => "$id/data"
430	}	638	}
431		639
432	=item cf::datalog type => key => value, ...	640	=item cf::datalog type => key => value, ...
433		641
434	Log a datalog packet of the given type with the given key-value pairs.	642	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")	660	attach callbacks/event handlers (a collection of which is called an "attachment")
453	to it. All such attachable objects support the following methods.	661	to it. All such attachable objects support the following methods.
454		662
455	In the following description, CLASS can be any of C<global>, C<object>	663	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	664	C<player>, C<client> or C<map> (i.e. the attachable objects in
457	crossfire+).	665	Crossfire TRT).
458		666
459	=over 4	667	=over 4
460		668
461	=item $attachable->attach ($attachment, key => $value...)	669	=item $attachable->attach ($attachment, key => $value...)
462		670
…		…
664	_attach $registry, $klass, @attach;	872	_attach $registry, $klass, @attach;
665	}	873	}
666		874
667	$obj->{$name} = \%arg;	875	$obj->{$name} = \%arg;
668	} else {	876	} else {
669	warn "object uses attachment '$name' that is not available, postponing.\n";	877	warn "object uses attachment '$name' which is not available, postponing.\n";
670	}	878	}
671		879
672	$obj->{_attachment}{$name} = undef;	880	$obj->{_attachment}{$name} = undef;
673	}	881	}
674		882
…		…
714	";	922	";
715	die if $@;	923	die if $@;
716	}	924	}
717		925
718	our $override;	926	our $override;
719	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	927	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
720		928
721	sub override {	929	sub override {
722	$override = 1;	930	$override = 1;
723	@invoke_results = ();	931	@INVOKE_RESULTS = (@_);
724	}	932	}
725		933
726	sub do_invoke {	934	sub do_invoke {
727	my $event = shift;	935	my $event = shift;
728	my $callbacks = shift;	936	my $callbacks = shift;
729		937
730	@invoke_results = ();	938	@INVOKE_RESULTS = ();
731		939
732	local $override;	940	local $override;
733		941
734	for (@$callbacks) {	942	for (@$callbacks) {
735	eval { &{$_->[1]} };	943	eval { &{$_->[1]} };
…		…
752		960
753	Generate an object-specific event with the given arguments.	961	Generate an object-specific event with the given arguments.
754		962
755	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	963	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	964	removed in future versions), and there is no public API to access override
757	results (if you must, access C<@cf::invoke_results> directly).	965	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
758		966
759	=back	967	=back
760		968
761	=cut	969	=cut
762		970
763	#############################################################################	971	#############################################################################
764	# object support	972	# object support
		973	#
		974
		975	sub _can_merge {
		976	my ($ob1, $ob2) = @_;
		977
		978	local $Storable::canonical = 1;
		979	my $fob1 = Storable::freeze $ob1;
		980	my $fob2 = Storable::freeze $ob2;
		981
		982	$fob1 eq $fob2
		983	}
765		984
766	sub reattach {	985	sub reattach {
767	# basically do the same as instantiate, without calling instantiate	986	# basically do the same as instantiate, without calling instantiate
768	my ($obj) = @_;	987	my ($obj) = @_;
769		988
…		…
872	or return;	1091	or return;
873	$av = eval { (Storable::thaw $av)->{objs} };	1092	$av = eval { (Storable::thaw $av)->{objs} };
874	}	1093	}
875		1094
876	warn sprintf "loading %s (%d)\n",	1095	warn sprintf "loading %s (%d)\n",
877	$filename, length $data, scalar @{$av || []};#d#	1096	$filename, length $data, scalar @{$av || []};
878	return ($data, $av);	1097	return ($data, $av);
879	}	1098	}
		1099
		1100	=head2 COMMAND CALLBACKS
		1101
		1102	=over 4
		1103
		1104	=cut
880		1105
881	#############################################################################	1106	#############################################################################
882	# command handling &c	1107	# command handling &c
883		1108
884	=item cf::register_command $name => \&callback($ob,$args);	1109	=item cf::register_command $name => \&callback($ob,$args);
…		…
897	push @{ $COMMAND{$name} }, [$caller, $cb];	1122	push @{ $COMMAND{$name} }, [$caller, $cb];
898	}	1123	}
899		1124
900	=item cf::register_extcmd $name => \&callback($pl,$packet);	1125	=item cf::register_extcmd $name => \&callback($pl,$packet);
901		1126
902	Register a callbackf ro execution when the client sends an extcmd packet.	1127	Register a callback for execution when the client sends an (synchronous)
		1128	extcmd packet. Ext commands will be processed in the order they are
		1129	received by the server, like other user commands. The first argument is
		1130	the logged-in player. Ext commands can only be processed after a player
		1131	has logged in successfully.
903		1132
904	If the callback returns something, it is sent back as if reply was being	1133	If the callback returns something, it is sent back as if reply was being
905	called.	1134	called.
906		1135
		1136	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1137
		1138	Register a callback for execution when the client sends an (asynchronous)
		1139	exticmd packet. Exti commands are processed by the server as soon as they
		1140	are received, i.e. out of order w.r.t. other commands. The first argument
		1141	is a client socket. Exti commands can be received anytime, even before
		1142	log-in.
		1143
		1144	If the callback returns something, it is sent back as if reply was being
		1145	called.
		1146
907	=cut	1147	=cut
908		1148
909	sub register_extcmd {	1149	sub register_extcmd {
910	my ($name, $cb) = @_;	1150	my ($name, $cb) = @_;
911		1151
912	$EXTCMD{$name} = $cb;	1152	$EXTCMD{$name} = $cb;
		1153	}
		1154
		1155	sub register_exticmd {
		1156	my ($name, $cb) = @_;
		1157
		1158	$EXTICMD{$name} = $cb;
913	}	1159	}
914		1160
915	cf::player->attach (	1161	cf::player->attach (
916	on_command => sub {	1162	on_command => sub {
917	my ($pl, $name, $params) = @_;	1163	my ($pl, $name, $params) = @_;
…		…
926	cf::override;	1172	cf::override;
927	},	1173	},
928	on_extcmd => sub {	1174	on_extcmd => sub {
929	my ($pl, $buf) = @_;	1175	my ($pl, $buf) = @_;
930		1176
931	my $msg = eval { from_json $buf };	1177	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
932		1178
933	if (ref $msg) {	1179	if (ref $msg) {
934	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1180	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
935	if (my %reply = $cb->($pl, $msg)) {	1181	if (my %reply = $cb->($pl, $msg)) {
936	$pl->ext_reply ($msg->{msgid}, %reply);	1182	$pl->ext_reply ($msg->{msgid}, %reply);
…		…
942		1188
943	cf::override;	1189	cf::override;
944	},	1190	},
945	);	1191	);
946		1192
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 {	1193	sub load_extensions {
		1194	cf::sync_job {
		1195	my %todo;
		1196
982	for my $ext (<$LIBDIR/*.ext>) {	1197	for my $path (<$LIBDIR/*.ext>) {
983	next unless -r $ext;	1198	next unless -r $path;
984	eval {	1199
985	load_extension $ext;	1200	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1201	my $base = $1;
		1202	my $pkg = $1;
		1203	$pkg =~ s/[^[:word:]]/_/g;
		1204	$pkg = "ext::$pkg";
		1205
		1206	open my $fh, "<:utf8", $path
		1207	or die "$path: $!";
		1208
		1209	my $source = do { local $/; <$fh> };
		1210
		1211	my %ext = (
		1212	path => $path,
		1213	base => $base,
		1214	pkg => $pkg,
		1215	);
		1216
		1217	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1218	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1219
		1220	$ext{source} =
		1221	"package $pkg; use strict; use utf8;\n"
		1222	. "#line 1 \"$path\"\n{\n"
		1223	. $source
		1224	. "\n};\n1";
		1225
		1226	$todo{$base} = \%ext;
		1227	}
		1228
		1229	my %done;
		1230	while (%todo) {
		1231	my $progress;
		1232
		1233	while (my ($k, $v) = each %todo) {
		1234	for (split /,\s*/, $v->{meta}{depends}) {
		1235	goto skip
		1236	unless exists $done{$_};
		1237	}
		1238
		1239	warn "... loading '$k' into '$v->{pkg}'\n";
		1240
		1241	unless (eval $v->{source}) {
		1242	my $msg = $@ ? "$v->{path}: $@\n"
		1243	: "$v->{base}: extension inactive.\n";
		1244
		1245	if (exists $v->{meta}{mandatory}) {
		1246	warn $msg;
		1247	warn "mandatory extension failed to load, exiting.\n";
		1248	exit 1;
		1249	}
		1250
		1251	warn $msg;
		1252	}
		1253
		1254	$done{$k} = delete $todo{$k};
		1255	push @EXTS, $v->{pkg};
		1256	$progress = 1;
986	1	1257	}
987	} or warn "$ext not loaded: $@";	1258
		1259	skip:
		1260	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1261	unless $progress;
		1262	}
988	}	1263	};
989	}	1264	}
990		1265
991	#############################################################################	1266	#############################################################################
		1267
		1268	=back
992		1269
993	=head2 CORE EXTENSIONS	1270	=head2 CORE EXTENSIONS
994		1271
995	Functions and methods that extend core crossfire objects.	1272	Functions and methods that extend core crossfire objects.
996		1273
…		…
1184	}	1461	}
1185		1462
1186	\@paths	1463	\@paths
1187	}	1464	}
1188		1465
		1466	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1467
		1468	Expand crossfire pod fragments into protocol xml.
		1469
		1470	=cut
		1471
		1472	sub expand_cfpod {
		1473	((my $self), (local $_)) = @_;
		1474
		1475	# escape & and <
		1476	s/&/&amp;/g;
		1477	s/(?<![BIUGH])</&lt;/g;
		1478
		1479	# this is buggy, it needs to properly take care of nested <'s
		1480
		1481	1 while
		1482	# replace B<>, I<>, U<> etc.
		1483	s/B<([^\>]*)>/<b>$1<\/b>/
		1484	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1485	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1486	# replace G<male|female> tags
		1487	|| s{G<([^>|]*)\|([^>]*)>}{
		1488	$self->gender ? $2 : $1
		1489	}ge
		1490	# replace H<hint text>
		1491	|| s{H<([^\>]*)>}
		1492	{
		1493	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1494	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1495	"")
		1496	[$self->{hintmode}]
		1497	}ge;
		1498
		1499	# create single paragraphs (very hackish)
		1500	s/(?<=\S)\n(?=\w)/ /g;
		1501
		1502	# compress some whitespace
		1503	s/\s+\n/\n/g; # ws line-ends
		1504	s/\n\n+/\n/g; # double lines
		1505	s/^\n+//; # beginning lines
		1506	s/\n+$//; # ending lines
		1507
		1508	$_
		1509	}
		1510
		1511	sub hintmode {
		1512	$_[0]{hintmode} = $_[1] if @_ > 1;
		1513	$_[0]{hintmode}
		1514	}
		1515
1189	=item $player->ext_reply ($msgid, %msg)	1516	=item $player->ext_reply ($msgid, %msg)
1190		1517
1191	Sends an ext reply to the player.	1518	Sends an ext reply to the player.
1192		1519
1193	=cut	1520	=cut
1194		1521
1195	sub ext_reply($$%) {	1522	sub ext_reply($$%) {
1196	my ($self, $id, %msg) = @_;	1523	my ($self, $id, %msg) = @_;
1197		1524
1198	$msg{msgid} = $id;	1525	$msg{msgid} = $id;
1199		1526	$self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1200	$self->send ("ext " . cf::to_json \%msg);
1201	}	1527	}
1202		1528
1203	=item $player->ext_event ($type, %msg)	1529	=item $player->ext_event ($type, %msg)
1204		1530
1205	Sends an ext event to the client.	1531	Sends an ext event to the client.
…		…
1220		1546
1221	package cf::region;	1547	package cf::region;
1222		1548
1223	=item cf::region::find_by_path $path	1549	=item cf::region::find_by_path $path
1224		1550
1225	Tries to decuce the probable region for a map knowing only its path.	1551	Tries to decuce the likely region for a map knowing only its path.
1226		1552
1227	=cut	1553	=cut
1228		1554
1229	sub find_by_path($) {	1555	sub find_by_path($) {
1230	my ($path) = @_;	1556	my ($path) = @_;
1231		1557
1232	my ($match, $specificity);	1558	my ($match, $specificity);
1233		1559
1234	for my $region (list) {	1560	for my $region (list) {
1235	if ($region->match && $path =~ $region->match) {	1561	if ($region->{match} && $path =~ $region->{match}) {
1236	($match, $specificity) = ($region, $region->specificity)	1562	($match, $specificity) = ($region, $region->specificity)
1237	if $region->specificity > $specificity;	1563	if $region->specificity > $specificity;
1238	}	1564	}
1239	}	1565	}
1240		1566
…		…
1304	my ($self, $merge) = @_;	1630	my ($self, $merge) = @_;
1305		1631
1306	# we have to keep some variables in memory intact	1632	# we have to keep some variables in memory intact
1307	local $self->{path};	1633	local $self->{path};
1308	local $self->{load_path};	1634	local $self->{load_path};
1309	local $self->{deny_save};
1310	local $self->{deny_reset};
1311		1635
1312	$self->SUPER::thawer_merge ($merge);	1636	$self->SUPER::thawer_merge ($merge);
1313	}	1637	}
1314		1638
1315	sub normalise {	1639	sub normalise {
…		…
1362	$self->init; # pass $1 etc.	1686	$self->init; # pass $1 etc.
1363	return $self;	1687	return $self;
1364	}	1688	}
1365	}	1689	}
1366		1690
1367	Carp::carp "unable to resolve path '$path' (base '$base').";	1691	Carp::cluck "unable to resolve path '$path' (base '$base').";
1368	()	1692	()
1369	}	1693	}
1370		1694
1371	sub init {	1695	sub init {
1372	my ($self) = @_;	1696	my ($self) = @_;
…		…
1413	sub change_all_map_light {	1737	sub change_all_map_light {
1414	my ($change) = @_;	1738	my ($change) = @_;
1415		1739
1416	$_->change_map_light ($change)	1740	$_->change_map_light ($change)
1417	for grep $_->outdoor, values %cf::MAP;	1741	for grep $_->outdoor, values %cf::MAP;
		1742	}
		1743
		1744	sub decay_objects {
		1745	my ($self) = @_;
		1746
		1747	return if $self->{deny_reset};
		1748
		1749	$self->do_decay_objects;
1418	}	1750	}
1419		1751
1420	sub unlink_save {	1752	sub unlink_save {
1421	my ($self) = @_;	1753	my ($self) = @_;
1422		1754
…		…
1480	$self->load_header_orig	1812	$self->load_header_orig
1481	or return;	1813	or return;
1482	$self->prepare_orig;	1814	$self->prepare_orig;
1483	}	1815	}
1484		1816
		1817	$self->{deny_reset} = 1
		1818	if $self->no_reset;
		1819
1485	$self->default_region (cf::region::find_by_path $self->{path})	1820	$self->default_region (cf::region::find_by_path $self->{path})
1486	unless $self->default_region;	1821	unless $self->default_region;
1487		1822
1488	1	1823	1
1489	}	1824	}
…		…
1504	$map->{last_save} = $cf::RUNTIME;	1839	$map->{last_save} = $cf::RUNTIME;
1505		1840
1506	$map->load_header	1841	$map->load_header
1507	or return;	1842	or return;
1508		1843
1509	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1844	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1510	# doing this can freeze the server in a sync job, obviously	1845	# doing this can freeze the server in a sync job, obviously
1511	#$cf::WAIT_FOR_TICK->wait;	1846	#$cf::WAIT_FOR_TICK->wait;
1512	$map->reset;	1847	$map->reset;
1513	undef $guard;	1848	undef $guard;
1514	return find $path;	1849	return find $path;
…		…
1581	my ($self, $ob) = @_;	1916	my ($self, $ob) = @_;
1582		1917
1583	return find "~" . $ob->name . "/" . $self->{path}	1918	return find "~" . $ob->name . "/" . $self->{path}
1584	if $self->per_player;	1919	if $self->per_player;
1585		1920
		1921	# return find "?party/" . $ob->name . "/" . $self->{path}
		1922	# if $self->per_party;
		1923
1586	$self	1924	$self
1587	}	1925	}
1588		1926
1589	# find and load all maps in the 3x3 area around a map	1927	# find and load all maps in the 3x3 area around a map
1590	sub load_diag {	1928	sub load_diag {
…		…
1636		1974
1637	undef $MAP_PREFETCH{$path};	1975	undef $MAP_PREFETCH{$path};
1638	$MAP_PREFETCHER ||= cf::async {	1976	$MAP_PREFETCHER ||= cf::async {
1639	while (%MAP_PREFETCH) {	1977	while (%MAP_PREFETCH) {
1640	for my $path (keys %MAP_PREFETCH) {	1978	for my $path (keys %MAP_PREFETCH) {
1641	my $map = find $path	1979	if (my $map = find $path) {
1642	or next;
1643	$map->load;	1980	$map->load;
		1981	}
1644		1982
1645	delete $MAP_PREFETCH{$path};	1983	delete $MAP_PREFETCH{$path};
1646	}	1984	}
1647	}	1985	}
1648	undef $MAP_PREFETCHER;	1986	undef $MAP_PREFETCHER;
…		…
1700		2038
1701	sub reset_at {	2039	sub reset_at {
1702	my ($self) = @_;	2040	my ($self) = @_;
1703		2041
1704	# TODO: safety, remove and allow resettable per-player maps	2042	# 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};	2043	return 1e99 if $self->{deny_reset};
1707		2044
1708	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2045	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1709	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2046	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1710		2047
…		…
1721	my ($self) = @_;	2058	my ($self) = @_;
1722		2059
1723	my $lock = cf::lock_acquire "map_data:$self->{path}";	2060	my $lock = cf::lock_acquire "map_data:$self->{path}";
1724		2061
1725	return if $self->players;	2062	return if $self->players;
1726	return if $self->isa ("ext::map_per_player");#d#
1727		2063
1728	warn "resetting map ", $self->path;#d#	2064	warn "resetting map ", $self->path;
1729		2065
1730	$self->in_memory (cf::MAP_SWAPPED);	2066	$self->in_memory (cf::MAP_SWAPPED);
1731		2067
1732	# need to save uniques path	2068	# need to save uniques path
1733	unless ($self->{deny_save}) {	2069	unless ($self->{deny_save}) {
…		…
1765	$cf::MAP{$self->path} = $self;	2101	$cf::MAP{$self->path} = $self;
1766		2102
1767	$self->reset; # polite request, might not happen	2103	$self->reset; # polite request, might not happen
1768	}	2104	}
1769		2105
		2106	=item $maps = cf::map::tmp_maps
		2107
		2108	Returns an arrayref with all map paths of currently instantiated and saved
		2109	maps. May block.
		2110
		2111	=cut
		2112
		2113	sub tmp_maps() {
		2114	[
		2115	map {
		2116	utf8::decode $_;
		2117	/\.map$/
		2118	? normalise $_
		2119	: ()
		2120	} @{ aio_readdir $TMPDIR or [] }
		2121	]
		2122	}
		2123
		2124	=item $maps = cf::map::random_maps
		2125
		2126	Returns an arrayref with all map paths of currently instantiated and saved
		2127	random maps. May block.
		2128
		2129	=cut
		2130
		2131	sub random_maps() {
		2132	[
		2133	map {
		2134	utf8::decode $_;
		2135	/\.map$/
		2136	? normalise "?random/$_"
		2137	: ()
		2138	} @{ aio_readdir $RANDOMDIR or [] }
		2139	]
		2140	}
		2141
1770	=item cf::map::unique_maps	2142	=item cf::map::unique_maps
1771		2143
1772	Returns an arrayref of paths of all shared maps that have	2144	Returns an arrayref of paths of all shared maps that have
1773	instantiated unique items. May block.	2145	instantiated unique items. May block.
1774		2146
1775	=cut	2147	=cut
1776		2148
1777	sub unique_maps() {	2149	sub unique_maps() {
1778	my $files = aio_readdir $UNIQUEDIR	2150	[
1779	or return;	2151	map {
1780
1781	my @paths;
1782
1783	for (@$files) {
1784	utf8::decode $_;	2152	utf8::decode $_;
1785	next if /\.pst$/;	2153	/\.map$/
1786	next unless /^$PATH_SEP/o;	2154	? normalise $_
1787		2155	: ()
1788	push @paths, cf::map::normalise $_;	2156	} @{ aio_readdir $UNIQUEDIR or [] }
1789	}	2157	]
1790
1791	\@paths
1792	}	2158	}
1793		2159
1794	package cf;	2160	package cf;
1795		2161
1796	=back	2162	=back
…		…
1842		2208
1843	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2209	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1844		2210
1845	if ($self->{record_replies}) {	2211	if ($self->{record_replies}) {
1846	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2212	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2213
1847	} else {	2214	} else {
		2215	my $pl = $self->contr;
		2216
		2217	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2218	my $diag = $pl->{npc_dialog};
		2219	$diag->{pl}->ext_reply (
		2220	$diag->{id},
		2221	msgtype => "reply",
		2222	msg => $diag->{pl}->expand_cfpod ($msg),
		2223	add_topics => []
		2224	);
		2225
		2226	} else {
1848	$msg = $npc->name . " says: $msg" if $npc;	2227	$msg = $npc->name . " says: $msg" if $npc;
1849	$self->message ($msg, $flags);	2228	$self->message ($msg, $flags);
		2229	}
1850	}	2230	}
1851	}	2231	}
1852		2232
1853	=item $player_object->may ("access")	2233	=item $player_object->may ("access")
1854		2234
…		…
1943		2323
1944	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2324	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1945	$self->enter_map ($map, $x, $y);	2325	$self->enter_map ($map, $x, $y);
1946	}	2326	}
1947		2327
1948	=item $player_object->goto ($path, $x, $y[, $check->($map)])	2328	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1949		2329
1950	Moves the player to the given map-path and coordinates by first freezing	2330	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	2331	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	2332	that has to return the map if sucecssful, and then unfreezes the player on
1953	the new (success) or old (failed) map position.	2333	the new (success) or old (failed) map position. In either case, $done will
		2334	be called at the end of this process.
1954		2335
1955	=cut	2336	=cut
1956		2337
1957	our $GOTOGEN;	2338	our $GOTOGEN;
1958		2339
1959	sub cf::object::player::goto {	2340	sub cf::object::player::goto {
1960	my ($self, $path, $x, $y, $check) = @_;	2341	my ($self, $path, $x, $y, $check, $done) = @_;
1961		2342
1962	# do generation counting so two concurrent goto's will be executed in-order	2343	# do generation counting so two concurrent goto's will be executed in-order
1963	my $gen = $self->{_goto_generation} = ++$GOTOGEN;	2344	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1964		2345
1965	$self->enter_link;	2346	$self->enter_link;
…		…
1985		2366
1986	if ($gen == $self->{_goto_generation}) {	2367	if ($gen == $self->{_goto_generation}) {
1987	delete $self->{_goto_generation};	2368	delete $self->{_goto_generation};
1988	$self->leave_link ($map, $x, $y);	2369	$self->leave_link ($map, $x, $y);
1989	}	2370	}
		2371
		2372	$done->() if $done;
1990	})->prio (1);	2373	})->prio (1);
1991	}	2374	}
1992		2375
1993	=item $player_object->enter_exit ($exit_object)	2376	=item $player_object->enter_exit ($exit_object)
1994		2377
…		…
2063	my $hp = $exit->stats->hp;	2446	my $hp = $exit->stats->hp;
2064	my $sp = $exit->stats->sp;	2447	my $sp = $exit->stats->sp;
2065		2448
2066	$self->enter_link;	2449	$self->enter_link;
2067		2450
		2451	# if exit is damned, update players death & WoR home-position
		2452	$self->contr->savebed ($slaying, $hp, $sp)
		2453	if $exit->flag (FLAG_DAMNED);
		2454
2068	(async {	2455	(async {
2069	$self->deactivate_recursive; # just to be sure	2456	$self->deactivate_recursive; # just to be sure
2070	unless (eval {	2457	unless (eval {
2071	$self->goto ($slaying, $hp, $sp);	2458	$self->goto ($slaying, $hp, $sp);
2072		2459
…		…
2099		2486
2100	utf8::encode $text;	2487	utf8::encode $text;
2101	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2488	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2102	}	2489	}
2103		2490
		2491	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2492
		2493	Send a drawinfo or msg packet to the client, formatting the msg for the
		2494	client if neccessary. C<$type> should be a string identifying the type of
		2495	the message, with C<log> being the default. If C<$color> is negative, suppress
		2496	the message unless the client supports the msg packet.
		2497
		2498	=cut
		2499
		2500	sub cf::client::send_msg {
		2501	my ($self, $channel, $msg, $color, @extra) = @_;
		2502
		2503	$msg = $self->pl->expand_cfpod ($msg);
		2504
		2505	$color &= ~cf::NDI_UNIQUE; # just in case...
		2506
		2507	if (ref $channel) {
		2508	# send meta info to client, if not yet sent
		2509	unless (exists $self->{channel}{$channel->{id}}) {
		2510	$self->{channel}{$channel->{id}} = $channel;
		2511	$self->ext_event (channel_info => %$channel);
		2512	}
		2513
		2514	$channel = $channel->{id};
		2515	}
		2516
		2517	return unless @extra || length $msg;
		2518
		2519	if ($self->can_msg) {
		2520	$self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
		2521	} else {
		2522	# replace some tags by gcfclient-compatible ones
		2523	for ($msg) {
		2524	1 while
		2525	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2526	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2527	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2528	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2529	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2530	}
		2531
		2532	if ($color >= 0) {
		2533	if (0 && $msg =~ /\[/) {
		2534	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2535	} else {
		2536	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2537	$self->send_packet ("drawinfo $color $msg")
		2538	}
		2539	}
		2540	}
		2541	}
		2542
2104	=item $client->ext_event ($type, %msg)	2543	=item $client->ext_event ($type, %msg)
2105		2544
2106	Sends an exti event to the client.	2545	Sends an ext event to the client.
2107		2546
2108	=cut	2547	=cut
2109		2548
2110	sub cf::client::ext_event($$%) {	2549	sub cf::client::ext_event($$%) {
2111	my ($self, $type, %msg) = @_;	2550	my ($self, $type, %msg) = @_;
2112		2551
		2552	return unless $self->extcmd;
		2553
2113	$msg{msgtype} = "event_$type";	2554	$msg{msgtype} = "event_$type";
2114	$self->send_packet ("ext " . cf::to_json \%msg);	2555	$self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2115	}	2556	}
2116		2557
2117	=item $success = $client->query ($flags, "text", \&cb)	2558	=item $success = $client->query ($flags, "text", \&cb)
2118		2559
2119	Queues a query to the client, calling the given callback with	2560	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>,	2561	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>.	2562	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2122		2563
2123	Queries can fail, so check the return code. Or don't, as queries will become	2564	Queries can fail, so check the return code. Or don't, as queries will
2124	reliable at some point in the future.	2565	become reliable at some point in the future.
2125		2566
2126	=cut	2567	=cut
2127		2568
2128	sub cf::client::query {	2569	sub cf::client::query {
2129	my ($self, $flags, $text, $cb) = @_;	2570	my ($self, $flags, $text, $cb) = @_;
…		…
2137	utf8::encode $text;	2578	utf8::encode $text;
2138	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2579	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2139		2580
2140	$self->send_packet ($self->{query_queue}[0][0])	2581	$self->send_packet ($self->{query_queue}[0][0])
2141	if @{ $self->{query_queue} } == 1;	2582	if @{ $self->{query_queue} } == 1;
		2583
		2584	1
2142	}	2585	}
2143		2586
2144	cf::client->attach (	2587	cf::client->attach (
		2588	on_connect => sub {
		2589	my ($ns) = @_;
		2590
		2591	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2592	},
2145	on_reply => sub {	2593	on_reply => sub {
2146	my ($ns, $msg) = @_;	2594	my ($ns, $msg) = @_;
2147		2595
2148	# this weird shuffling is so that direct followup queries	2596	# this weird shuffling is so that direct followup queries
2149	# get handled first	2597	# get handled first
…		…
2161	} else {	2609	} else {
2162	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2610	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2163	}	2611	}
2164	}	2612	}
2165	},	2613	},
		2614	on_exticmd => sub {
		2615	my ($ns, $buf) = @_;
		2616
		2617	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2618
		2619	if (ref $msg) {
		2620	if (my $cb = $EXTICMD{$msg->{msgtype}}) {
		2621	if (my %reply = $cb->($ns, $msg)) {
		2622	$reply{msgid} = $msg->{msgid};
		2623	$ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
		2624	}
		2625	}
		2626	} else {
		2627	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2628	}
		2629
		2630	cf::override;
		2631	},
2166	);	2632	);
2167		2633
2168	=item $client->async (\&cb)	2634	=item $client->async (\&cb)
2169		2635
2170	Create a new coroutine, running the specified callback. The coroutine will	2636	Create a new coroutine, running the specified callback. The coroutine will
…		…
2219		2685
2220	=pod	2686	=pod
2221		2687
2222	The following functions and methods are available within a safe environment:	2688	The following functions and methods are available within a safe environment:
2223		2689
2224	cf::object contr pay_amount pay_player map	2690	cf::object
		2691	contr pay_amount pay_player map x y force_find force_add
		2692	insert remove
		2693
2225	cf::object::player player	2694	cf::object::player
2226	cf::player peaceful	2695	player
2227	cf::map trigger	2696
		2697	cf::player
		2698	peaceful
		2699
		2700	cf::map
		2701	trigger
2228		2702
2229	=cut	2703	=cut
2230		2704
2231	for (	2705	for (
2232	["cf::object" => qw(contr pay_amount pay_player map)],	2706	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2707	insert remove)],
2233	["cf::object::player" => qw(player)],	2708	["cf::object::player" => qw(player)],
2234	["cf::player" => qw(peaceful)],	2709	["cf::player" => qw(peaceful)],
2235	["cf::map" => qw(trigger)],	2710	["cf::map" => qw(trigger)],
2236	) {	2711	) {
2237	no strict 'refs';	2712	no strict 'refs';
…		…
2308	=back	2783	=back
2309		2784
2310	=cut	2785	=cut
2311		2786
2312	#############################################################################	2787	#############################################################################
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	2788	# the server's init and main functions
2486		2789
2487	sub load_facedata($) {	2790	sub load_facedata($) {
2488	my ($path) = @_;	2791	my ($path) = @_;
2489		2792
…		…
2501	{	2804	{
2502	my $faces = $facedata->{faceinfo};	2805	my $faces = $facedata->{faceinfo};
2503		2806
2504	while (my ($face, $info) = each %$faces) {	2807	while (my ($face, $info) = each %$faces) {
2505	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2808	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2506	warn "$face $info->{magicmap}\n" if $face =~ /obol/;#d#
2507	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2809	cf::face::set_visibility $idx, $info->{visibility};
		2810	cf::face::set_magicmap $idx, $info->{magicmap};
2508	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2811	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2509	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	2812	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2510	Coro::cede;	2813
		2814	cf::cede_to_tick;
2511	}	2815	}
2512		2816
2513	while (my ($face, $info) = each %$faces) {	2817	while (my ($face, $info) = each %$faces) {
2514	next unless $info->{smooth};	2818	next unless $info->{smooth};
2515	my $idx = cf::face::find $face	2819	my $idx = cf::face::find $face
2516	or next;	2820	or next;
2517	if (my $smooth = cf::face::find $info->{smooth}) {	2821	if (my $smooth = cf::face::find $info->{smooth}) {
		2822	cf::face::set_smooth $idx, $smooth;
2518	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	2823	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2519	} else {	2824	} else {
2520	warn "smooth face '$info->{smooth}' not found for face '$face'";	2825	warn "smooth face '$info->{smooth}' not found for face '$face'";
2521	}	2826	}
2522	Coro::cede;	2827
		2828	cf::cede_to_tick;
2523	}	2829	}
2524	}	2830	}
2525		2831
2526	{	2832	{
2527	my $anims = $facedata->{animinfo};	2833	my $anims = $facedata->{animinfo};
2528		2834
2529	while (my ($anim, $info) = each %$anims) {	2835	while (my ($anim, $info) = each %$anims) {
2530	cf::anim::set $anim, $info->{frames}, $info->{facings};	2836	cf::anim::set $anim, $info->{frames}, $info->{facings};
2531	Coro::cede;	2837	cf::cede_to_tick;
2532	}	2838	}
2533		2839
2534	cf::anim::invalidate_all; # d'oh	2840	cf::anim::invalidate_all; # d'oh
		2841	}
		2842
		2843	{
		2844	# TODO: for gcfclient pleasure, we should give resources
		2845	# that gcfclient doesn't grok a >10000 face index.
		2846	my $res = $facedata->{resource};
		2847	my $enc = JSON::XS->new->utf8->canonical;
		2848
		2849	while (my ($name, $info) = each %$res) {
		2850	my $meta = $enc->encode ({
		2851	name => $name,
		2852	type => $info->{type},
		2853	copyright => $info->{copyright}, #TODO#
		2854	});
		2855
		2856	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2857
		2858	if ($name =~ /\.jpg$/) {
		2859	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
		2860	cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
		2861	} else {
		2862	my $data = pack "(w/a*)*", $meta, $info->{data};
		2863	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2864
		2865	cf::face::set_type $idx, 1;
		2866	cf::face::set_data $idx, 0, $data, $chk;
		2867	}
		2868
		2869	cf::cede_to_tick;
		2870	}
2535	}	2871	}
2536		2872
2537	1	2873	1
2538	}	2874	}
2539		2875
2540	sub reload_regions {	2876	sub reload_regions {
2541	load_resource_file "$MAPDIR/regions"	2877	load_resource_file "$MAPDIR/regions"
2542	or die "unable to load regions file\n";	2878	or die "unable to load regions file\n";
		2879
		2880	for (cf::region::list) {
		2881	$_->{match} = qr/$_->{match}/
		2882	if exists $_->{match};
		2883	}
2543	}	2884	}
2544		2885
2545	sub reload_facedata {	2886	sub reload_facedata {
2546	load_facedata "$DATADIR/facedata"	2887	load_facedata "$DATADIR/facedata"
2547	or die "unable to load facedata\n";	2888	or die "unable to load facedata\n";
2548	}	2889	}
2549		2890
2550	sub reload_archetypes {	2891	sub reload_archetypes {
2551	load_resource_file "$DATADIR/archetypes"	2892	load_resource_file "$DATADIR/archetypes"
2552	or die "unable to load archetypes\n";	2893	or die "unable to load archetypes\n";
		2894	#d# NEED to laod twice to resolve forward references
		2895	# this really needs to be done in an extra post-pass
		2896	# (which needs to be synchronous, so solve it differently)
		2897	load_resource_file "$DATADIR/archetypes"
		2898	or die "unable to load archetypes\n";
2553	}	2899	}
2554		2900
2555	sub reload_treasures {	2901	sub reload_treasures {
2556	load_resource_file "$DATADIR/treasures"	2902	load_resource_file "$DATADIR/treasures"
2557	or die "unable to load treasurelists\n";	2903	or die "unable to load treasurelists\n";
…		…
2560	sub reload_resources {	2906	sub reload_resources {
2561	warn "reloading resource files...\n";	2907	warn "reloading resource files...\n";
2562		2908
2563	reload_regions;	2909	reload_regions;
2564	reload_facedata;	2910	reload_facedata;
		2911	#reload_archetypes;#d#
2565	reload_archetypes;	2912	reload_archetypes;
2566	reload_treasures;	2913	reload_treasures;
2567		2914
2568	warn "finished reloading resource files\n";	2915	warn "finished reloading resource files\n";
2569	}	2916	}
…		…
2626	},	2973	},
2627	);	2974	);
2628	}	2975	}
2629	}	2976	}
2630		2977
		2978	sub write_runtime {
		2979	my $runtime = "$LOCALDIR/runtime";
		2980
		2981	# first touch the runtime file to show we are still running:
		2982	# the fsync below can take a very very long time.
		2983
		2984	IO::AIO::aio_utime $runtime, undef, undef;
		2985
		2986	my $guard = cf::lock_acquire "write_runtime";
		2987
		2988	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2989	or return;
		2990
		2991	my $value = $cf::RUNTIME + 90 + 10;
		2992	# 10 is the runtime save interval, for a monotonic clock
		2993	# 60 allows for the watchdog to kill the server.
		2994
		2995	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2996	and return;
		2997
		2998	# always fsync - this file is important
		2999	aio_fsync $fh
		3000	and return;
		3001
		3002	# touch it again to show we are up-to-date
		3003	aio_utime $fh, undef, undef;
		3004
		3005	close $fh
		3006	or return;
		3007
		3008	aio_rename "$runtime~", $runtime
		3009	and return;
		3010
		3011	warn "runtime file written.\n";
		3012
		3013	1
		3014	}
		3015
2631	sub emergency_save() {	3016	sub emergency_save() {
2632	my $freeze_guard = cf::freeze_mainloop;	3017	my $freeze_guard = cf::freeze_mainloop;
2633		3018
2634	warn "enter emergency perl save\n";	3019	warn "enter emergency perl save\n";
2635		3020
…		…
2710	%EXT_CORO = ();	3095	%EXT_CORO = ();
2711		3096
2712	warn "removing commands";	3097	warn "removing commands";
2713	%COMMAND = ();	3098	%COMMAND = ();
2714		3099
2715	warn "removing ext commands";	3100	warn "removing ext/exti commands";
2716	%EXTCMD = ();	3101	%EXTCMD = ();
		3102	%EXTICMD = ();
2717		3103
2718	warn "unloading/nuking all extensions";	3104	warn "unloading/nuking all extensions";
2719	for my $pkg (@EXTS) {	3105	for my $pkg (@EXTS) {
2720	warn "... unloading $pkg";	3106	warn "... unloading $pkg";
2721		3107

Diff Legend

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