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.269 by root, Tue May 22 21:35:26 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	if (my $fh = aio_open $runtime, O_WRONLY, 0) {	469	=cut
401	utime undef, undef, $fh;
402	}
403		470
404	my $guard = cf::lock_acquire "write_runtime";	471	sub _store_scalar {
405		472	open my $fh, ">", \my $buf
406	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	473	or die "fork_call: cannot open fh-to-buf in child : $!";
407	or return;	474	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	475	close $fh;
424	or return;
425		476
426	aio_rename "$runtime~", $runtime	477	$buf
427	and return;	478	}
428		479
429	warn "runtime file written.\n";#d#	480	sub fork_call(&@) {
		481	my ($cb, @args) = @_;
430		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;
431	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"
432	}	638	}
433		639
434	=item cf::datalog type => key => value, ...	640	=item cf::datalog type => key => value, ...
435		641
436	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.
…		…
454	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")
455	to it. All such attachable objects support the following methods.	661	to it. All such attachable objects support the following methods.
456		662
457	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>
458	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
459	crossfire+).	665	Crossfire TRT).
460		666
461	=over 4	667	=over 4
462		668
463	=item $attachable->attach ($attachment, key => $value...)	669	=item $attachable->attach ($attachment, key => $value...)
464		670
…		…
666	_attach $registry, $klass, @attach;	872	_attach $registry, $klass, @attach;
667	}	873	}
668		874
669	$obj->{$name} = \%arg;	875	$obj->{$name} = \%arg;
670	} else {	876	} else {
671	warn "object uses attachment '$name' that is not available, postponing.\n";	877	warn "object uses attachment '$name' which is not available, postponing.\n";
672	}	878	}
673		879
674	$obj->{_attachment}{$name} = undef;	880	$obj->{_attachment}{$name} = undef;
675	}	881	}
676		882
…		…
716	";	922	";
717	die if $@;	923	die if $@;
718	}	924	}
719		925
720	our $override;	926	our $override;
721	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?
722		928
723	sub override {	929	sub override {
724	$override = 1;	930	$override = 1;
725	@invoke_results = ();	931	@INVOKE_RESULTS = (@_);
726	}	932	}
727		933
728	sub do_invoke {	934	sub do_invoke {
729	my $event = shift;	935	my $event = shift;
730	my $callbacks = shift;	936	my $callbacks = shift;
731		937
732	@invoke_results = ();	938	@INVOKE_RESULTS = ();
733		939
734	local $override;	940	local $override;
735		941
736	for (@$callbacks) {	942	for (@$callbacks) {
737	eval { &{$_->[1]} };	943	eval { &{$_->[1]} };
…		…
754		960
755	Generate an object-specific event with the given arguments.	961	Generate an object-specific event with the given arguments.
756		962
757	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
758	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
759	results (if you must, access C<@cf::invoke_results> directly).	965	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
760		966
761	=back	967	=back
762		968
763	=cut	969	=cut
764		970
765	#############################################################################	971	#############################################################################
766	# 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	}
767		984
768	sub reattach {	985	sub reattach {
769	# basically do the same as instantiate, without calling instantiate	986	# basically do the same as instantiate, without calling instantiate
770	my ($obj) = @_;	987	my ($obj) = @_;
771		988
…		…
874	or return;	1091	or return;
875	$av = eval { (Storable::thaw $av)->{objs} };	1092	$av = eval { (Storable::thaw $av)->{objs} };
876	}	1093	}
877		1094
878	warn sprintf "loading %s (%d)\n",	1095	warn sprintf "loading %s (%d)\n",
879	$filename, length $data, scalar @{$av || []};#d#	1096	$filename, length $data, scalar @{$av || []};
880	return ($data, $av);	1097	return ($data, $av);
881	}	1098	}
		1099
		1100	=head2 COMMAND CALLBACKS
		1101
		1102	=over 4
		1103
		1104	=cut
882		1105
883	#############################################################################	1106	#############################################################################
884	# command handling &c	1107	# command handling &c
885		1108
886	=item cf::register_command $name => \&callback($ob,$args);	1109	=item cf::register_command $name => \&callback($ob,$args);
…		…
899	push @{ $COMMAND{$name} }, [$caller, $cb];	1122	push @{ $COMMAND{$name} }, [$caller, $cb];
900	}	1123	}
901		1124
902	=item cf::register_extcmd $name => \&callback($pl,$packet);	1125	=item cf::register_extcmd $name => \&callback($pl,$packet);
903		1126
904	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.
905		1132
906	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
907	called.	1134	called.
908		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
909	=cut	1147	=cut
910		1148
911	sub register_extcmd {	1149	sub register_extcmd {
912	my ($name, $cb) = @_;	1150	my ($name, $cb) = @_;
913		1151
914	$EXTCMD{$name} = $cb;	1152	$EXTCMD{$name} = $cb;
		1153	}
		1154
		1155	sub register_exticmd {
		1156	my ($name, $cb) = @_;
		1157
		1158	$EXTICMD{$name} = $cb;
915	}	1159	}
916		1160
917	cf::player->attach (	1161	cf::player->attach (
918	on_command => sub {	1162	on_command => sub {
919	my ($pl, $name, $params) = @_;	1163	my ($pl, $name, $params) = @_;
…		…
928	cf::override;	1172	cf::override;
929	},	1173	},
930	on_extcmd => sub {	1174	on_extcmd => sub {
931	my ($pl, $buf) = @_;	1175	my ($pl, $buf) = @_;
932		1176
933	my $msg = eval { from_json $buf };	1177	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
934		1178
935	if (ref $msg) {	1179	if (ref $msg) {
936	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1180	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
937	if (my %reply = $cb->($pl, $msg)) {	1181	if (my %reply = $cb->($pl, $msg)) {
938	$pl->ext_reply ($msg->{msgid}, %reply);	1182	$pl->ext_reply ($msg->{msgid}, %reply);
…		…
944		1188
945	cf::override;	1189	cf::override;
946	},	1190	},
947	);	1191	);
948		1192
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 {	1193	sub load_extensions {
		1194	cf::sync_job {
		1195	my %todo;
		1196
984	for my $ext (<$LIBDIR/*.ext>) {	1197	for my $path (<$LIBDIR/*.ext>) {
985	next unless -r $ext;	1198	next unless -r $path;
986	eval {	1199
987	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;
988	1	1257	}
989	} or warn "$ext not loaded: $@";	1258
		1259	skip:
		1260	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1261	unless $progress;
		1262	}
990	}	1263	};
991	}	1264	}
992		1265
993	#############################################################################	1266	#############################################################################
		1267
		1268	=back
994		1269
995	=head2 CORE EXTENSIONS	1270	=head2 CORE EXTENSIONS
996		1271
997	Functions and methods that extend core crossfire objects.	1272	Functions and methods that extend core crossfire objects.
998		1273
…		…
1186	}	1461	}
1187		1462
1188	\@paths	1463	\@paths
1189	}	1464	}
1190		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
1191	=item $player->ext_reply ($msgid, %msg)	1516	=item $player->ext_reply ($msgid, %msg)
1192		1517
1193	Sends an ext reply to the player.	1518	Sends an ext reply to the player.
1194		1519
1195	=cut	1520	=cut
1196		1521
1197	sub ext_reply($$%) {	1522	sub ext_reply($$%) {
1198	my ($self, $id, %msg) = @_;	1523	my ($self, $id, %msg) = @_;
1199		1524
1200	$msg{msgid} = $id;	1525	$msg{msgid} = $id;
1201		1526	$self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1202	$self->send ("ext " . cf::to_json \%msg);
1203	}	1527	}
1204		1528
1205	=item $player->ext_event ($type, %msg)	1529	=item $player->ext_event ($type, %msg)
1206		1530
1207	Sends an ext event to the client.	1531	Sends an ext event to the client.
…		…
1222		1546
1223	package cf::region;	1547	package cf::region;
1224		1548
1225	=item cf::region::find_by_path $path	1549	=item cf::region::find_by_path $path
1226		1550
1227	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.
1228		1552
1229	=cut	1553	=cut
1230		1554
1231	sub find_by_path($) {	1555	sub find_by_path($) {
1232	my ($path) = @_;	1556	my ($path) = @_;
1233		1557
1234	my ($match, $specificity);	1558	my ($match, $specificity);
1235		1559
1236	for my $region (list) {	1560	for my $region (list) {
1237	if ($region->match && $path =~ $region->match) {	1561	if ($region->{match} && $path =~ $region->{match}) {
1238	($match, $specificity) = ($region, $region->specificity)	1562	($match, $specificity) = ($region, $region->specificity)
1239	if $region->specificity > $specificity;	1563	if $region->specificity > $specificity;
1240	}	1564	}
1241	}	1565	}
1242		1566
…		…
1306	my ($self, $merge) = @_;	1630	my ($self, $merge) = @_;
1307		1631
1308	# we have to keep some variables in memory intact	1632	# we have to keep some variables in memory intact
1309	local $self->{path};	1633	local $self->{path};
1310	local $self->{load_path};	1634	local $self->{load_path};
1311	local $self->{deny_save};
1312	local $self->{deny_reset};
1313		1635
1314	$self->SUPER::thawer_merge ($merge);	1636	$self->SUPER::thawer_merge ($merge);
1315	}	1637	}
1316		1638
1317	sub normalise {	1639	sub normalise {
…		…
1364	$self->init; # pass $1 etc.	1686	$self->init; # pass $1 etc.
1365	return $self;	1687	return $self;
1366	}	1688	}
1367	}	1689	}
1368		1690
1369	Carp::carp "unable to resolve path '$path' (base '$base').";	1691	Carp::cluck "unable to resolve path '$path' (base '$base').";
1370	()	1692	()
1371	}	1693	}
1372		1694
1373	sub init {	1695	sub init {
1374	my ($self) = @_;	1696	my ($self) = @_;
…		…
1415	sub change_all_map_light {	1737	sub change_all_map_light {
1416	my ($change) = @_;	1738	my ($change) = @_;
1417		1739
1418	$_->change_map_light ($change)	1740	$_->change_map_light ($change)
1419	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;
1420	}	1750	}
1421		1751
1422	sub unlink_save {	1752	sub unlink_save {
1423	my ($self) = @_;	1753	my ($self) = @_;
1424		1754
…		…
1482	$self->load_header_orig	1812	$self->load_header_orig
1483	or return;	1813	or return;
1484	$self->prepare_orig;	1814	$self->prepare_orig;
1485	}	1815	}
1486		1816
		1817	$self->{deny_reset} = 1
		1818	if $self->no_reset;
		1819
1487	$self->default_region (cf::region::find_by_path $self->{path})	1820	$self->default_region (cf::region::find_by_path $self->{path})
1488	unless $self->default_region;	1821	unless $self->default_region;
1489		1822
1490	1	1823	1
1491	}	1824	}
…		…
1506	$map->{last_save} = $cf::RUNTIME;	1839	$map->{last_save} = $cf::RUNTIME;
1507		1840
1508	$map->load_header	1841	$map->load_header
1509	or return;	1842	or return;
1510		1843
1511	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1844	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1512	# doing this can freeze the server in a sync job, obviously	1845	# doing this can freeze the server in a sync job, obviously
1513	#$cf::WAIT_FOR_TICK->wait;	1846	#$cf::WAIT_FOR_TICK->wait;
1514	$map->reset;	1847	$map->reset;
1515	undef $guard;	1848	undef $guard;
1516	return find $path;	1849	return find $path;
…		…
1583	my ($self, $ob) = @_;	1916	my ($self, $ob) = @_;
1584		1917
1585	return find "~" . $ob->name . "/" . $self->{path}	1918	return find "~" . $ob->name . "/" . $self->{path}
1586	if $self->per_player;	1919	if $self->per_player;
1587		1920
		1921	# return find "?party/" . $ob->name . "/" . $self->{path}
		1922	# if $self->per_party;
		1923
1588	$self	1924	$self
1589	}	1925	}
1590		1926
1591	# 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
1592	sub load_diag {	1928	sub load_diag {
…		…
1638		1974
1639	undef $MAP_PREFETCH{$path};	1975	undef $MAP_PREFETCH{$path};
1640	$MAP_PREFETCHER ||= cf::async {	1976	$MAP_PREFETCHER ||= cf::async {
1641	while (%MAP_PREFETCH) {	1977	while (%MAP_PREFETCH) {
1642	for my $path (keys %MAP_PREFETCH) {	1978	for my $path (keys %MAP_PREFETCH) {
1643	my $map = find $path	1979	if (my $map = find $path) {
1644	or next;
1645	$map->load;	1980	$map->load;
		1981	}
1646		1982
1647	delete $MAP_PREFETCH{$path};	1983	delete $MAP_PREFETCH{$path};
1648	}	1984	}
1649	}	1985	}
1650	undef $MAP_PREFETCHER;	1986	undef $MAP_PREFETCHER;
…		…
1702		2038
1703	sub reset_at {	2039	sub reset_at {
1704	my ($self) = @_;	2040	my ($self) = @_;
1705		2041
1706	# TODO: safety, remove and allow resettable per-player maps	2042	# 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};	2043	return 1e99 if $self->{deny_reset};
1709		2044
1710	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2045	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1711	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;
1712		2047
…		…
1723	my ($self) = @_;	2058	my ($self) = @_;
1724		2059
1725	my $lock = cf::lock_acquire "map_data:$self->{path}";	2060	my $lock = cf::lock_acquire "map_data:$self->{path}";
1726		2061
1727	return if $self->players;	2062	return if $self->players;
1728	return if $self->isa ("ext::map_per_player");#d#
1729		2063
1730	warn "resetting map ", $self->path;#d#	2064	warn "resetting map ", $self->path;
1731		2065
1732	$self->in_memory (cf::MAP_SWAPPED);	2066	$self->in_memory (cf::MAP_SWAPPED);
1733		2067
1734	# need to save uniques path	2068	# need to save uniques path
1735	unless ($self->{deny_save}) {	2069	unless ($self->{deny_save}) {
…		…
1767	$cf::MAP{$self->path} = $self;	2101	$cf::MAP{$self->path} = $self;
1768		2102
1769	$self->reset; # polite request, might not happen	2103	$self->reset; # polite request, might not happen
1770	}	2104	}
1771		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
1772	=item cf::map::unique_maps	2142	=item cf::map::unique_maps
1773		2143
1774	Returns an arrayref of paths of all shared maps that have	2144	Returns an arrayref of paths of all shared maps that have
1775	instantiated unique items. May block.	2145	instantiated unique items. May block.
1776		2146
1777	=cut	2147	=cut
1778		2148
1779	sub unique_maps() {	2149	sub unique_maps() {
1780	my $files = aio_readdir $UNIQUEDIR	2150	[
1781	or return;	2151	map {
1782
1783	my @paths;
1784
1785	for (@$files) {
1786	utf8::decode $_;	2152	utf8::decode $_;
1787	next if /\.pst$/;	2153	/\.map$/
1788	next unless /^$PATH_SEP/o;	2154	? normalise $_
1789		2155	: ()
1790	push @paths, cf::map::normalise $_;	2156	} @{ aio_readdir $UNIQUEDIR or [] }
1791	}	2157	]
1792
1793	\@paths
1794	}	2158	}
1795		2159
1796	package cf;	2160	package cf;
1797		2161
1798	=back	2162	=back
…		…
1844		2208
1845	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2209	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1846		2210
1847	if ($self->{record_replies}) {	2211	if ($self->{record_replies}) {
1848	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2212	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2213
1849	} 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 {
1850	$msg = $npc->name . " says: $msg" if $npc;	2227	$msg = $npc->name . " says: $msg" if $npc;
1851	$self->message ($msg, $flags);	2228	$self->message ($msg, $flags);
		2229	}
1852	}	2230	}
1853	}	2231	}
1854		2232
1855	=item $player_object->may ("access")	2233	=item $player_object->may ("access")
1856		2234
…		…
1904	$self->deactivate_recursive;	2282	$self->deactivate_recursive;
1905		2283
1906	return if UNIVERSAL::isa $self->map, "ext::map_link";	2284	return if UNIVERSAL::isa $self->map, "ext::map_link";
1907		2285
1908	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2286	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1909	if $self->map;	2287	if $self->map && $self->map->{path} ne "{link}";
1910		2288
1911	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2289	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1912	}	2290	}
1913		2291
1914	sub cf::object::player::leave_link {	2292	sub cf::object::player::leave_link {
1915	my ($self, $map, $x, $y) = @_;	2293	my ($self, $map, $x, $y) = @_;
		2294
		2295	return unless $self->contr->active;
1916		2296
1917	my $link_pos = delete $self->{_link_pos};	2297	my $link_pos = delete $self->{_link_pos};
1918		2298
1919	unless ($map) {	2299	unless ($map) {
1920	# restore original map position	2300	# restore original map position
…		…
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	cf::player->attach (
1949	on_logout => sub {
1950	my ($pl) = @_;
1951
1952	# abort map switching before logout
1953	if ($pl->ob->{_link_pos}) {
1954	cf::sync_job {
1955	$pl->ob->leave_link
1956	};
1957	}
1958	},
1959	on_login => sub {
1960	my ($pl) = @_;
1961
1962	# try to abort aborted map switching on player login :)
1963	# should happen only on crashes
1964	if ($pl->ob->{_link_pos}) {
1965	$pl->ob->enter_link;
1966	(async {
1967	$pl->ob->reply (undef,
1968	"There was an internal problem at your last logout, "
1969	. "the server will try to bring you to your intended destination in a second.",
1970	cf::NDI_RED);
1971	# we need this sleep as the login has a concurrent enter_exit running
1972	# and this sleep increases chances of the player not ending up in scorn
1973	Coro::Timer::sleep 1;
1974	$pl->ob->leave_link;
1975	})->prio (2);
1976	}
1977	},
1978	);
1979
1980	=item $player_object->goto ($path, $x, $y[, $check->($map)])	2328	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1981		2329
1982	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
1983	her, loading and preparing them map, calling the provided $check callback	2331	her, loading and preparing them map, calling the provided $check callback
1984	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
1985	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.
1986		2335
1987	=cut	2336	=cut
		2337
		2338	our $GOTOGEN;
1988		2339
1989	sub cf::object::player::goto {	2340	sub cf::object::player::goto {
1990	my ($self, $path, $x, $y, $check) = @_;	2341	my ($self, $path, $x, $y, $check, $done) = @_;
		2342
		2343	# do generation counting so two concurrent goto's will be executed in-order
		2344	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1991		2345
1992	$self->enter_link;	2346	$self->enter_link;
1993		2347
1994	(async {	2348	(async {
1995	my $map = eval {	2349	my $map = eval {
…		…
2008	if ($@) {	2362	if ($@) {
2009	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);	2363	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2010	LOG llevError | logBacktrace, Carp::longmess $@;	2364	LOG llevError | logBacktrace, Carp::longmess $@;
2011	}	2365	}
2012		2366
		2367	if ($gen == $self->{_goto_generation}) {
		2368	delete $self->{_goto_generation};
2013	$self->leave_link ($map, $x, $y);	2369	$self->leave_link ($map, $x, $y);
		2370	}
		2371
		2372	$done->() if $done;
2014	})->prio (1);	2373	})->prio (1);
2015	}	2374	}
2016		2375
2017	=item $player_object->enter_exit ($exit_object)	2376	=item $player_object->enter_exit ($exit_object)
2018		2377
…		…
2087	my $hp = $exit->stats->hp;	2446	my $hp = $exit->stats->hp;
2088	my $sp = $exit->stats->sp;	2447	my $sp = $exit->stats->sp;
2089		2448
2090	$self->enter_link;	2449	$self->enter_link;
2091		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
2092	(async {	2455	(async {
2093	$self->deactivate_recursive; # just to be sure	2456	$self->deactivate_recursive; # just to be sure
2094	unless (eval {	2457	unless (eval {
2095	$self->goto ($slaying, $hp, $sp);	2458	$self->goto ($slaying, $hp, $sp);
2096		2459
…		…
2123		2486
2124	utf8::encode $text;	2487	utf8::encode $text;
2125	$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);
2126	}	2489	}
2127		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
2128	=item $client->ext_event ($type, %msg)	2543	=item $client->ext_event ($type, %msg)
2129		2544
2130	Sends an exti event to the client.	2545	Sends an ext event to the client.
2131		2546
2132	=cut	2547	=cut
2133		2548
2134	sub cf::client::ext_event($$%) {	2549	sub cf::client::ext_event($$%) {
2135	my ($self, $type, %msg) = @_;	2550	my ($self, $type, %msg) = @_;
2136		2551
		2552	return unless $self->extcmd;
		2553
2137	$msg{msgtype} = "event_$type";	2554	$msg{msgtype} = "event_$type";
2138	$self->send_packet ("ext " . cf::to_json \%msg);	2555	$self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2139	}	2556	}
2140		2557
2141	=item $success = $client->query ($flags, "text", \&cb)	2558	=item $success = $client->query ($flags, "text", \&cb)
2142		2559
2143	Queues a query to the client, calling the given callback with	2560	Queues a query to the client, calling the given callback with
2144	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>,
2145	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>.
2146		2563
2147	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
2148	reliable at some point in the future.	2565	become reliable at some point in the future.
2149		2566
2150	=cut	2567	=cut
2151		2568
2152	sub cf::client::query {	2569	sub cf::client::query {
2153	my ($self, $flags, $text, $cb) = @_;	2570	my ($self, $flags, $text, $cb) = @_;
…		…
2161	utf8::encode $text;	2578	utf8::encode $text;
2162	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2579	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2163		2580
2164	$self->send_packet ($self->{query_queue}[0][0])	2581	$self->send_packet ($self->{query_queue}[0][0])
2165	if @{ $self->{query_queue} } == 1;	2582	if @{ $self->{query_queue} } == 1;
		2583
		2584	1
2166	}	2585	}
2167		2586
2168	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	},
2169	on_reply => sub {	2593	on_reply => sub {
2170	my ($ns, $msg) = @_;	2594	my ($ns, $msg) = @_;
2171		2595
2172	# this weird shuffling is so that direct followup queries	2596	# this weird shuffling is so that direct followup queries
2173	# get handled first	2597	# get handled first
…		…
2185	} else {	2609	} else {
2186	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2610	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2187	}	2611	}
2188	}	2612	}
2189	},	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	},
2190	);	2632	);
2191		2633
2192	=item $client->async (\&cb)	2634	=item $client->async (\&cb)
2193		2635
2194	Create a new coroutine, running the specified callback. The coroutine will	2636	Create a new coroutine, running the specified callback. The coroutine will
…		…
2243		2685
2244	=pod	2686	=pod
2245		2687
2246	The following functions and methods are available within a safe environment:	2688	The following functions and methods are available within a safe environment:
2247		2689
2248	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
2249	cf::object::player player	2694	cf::object::player
2250	cf::player peaceful	2695	player
2251	cf::map trigger	2696
		2697	cf::player
		2698	peaceful
		2699
		2700	cf::map
		2701	trigger
2252		2702
2253	=cut	2703	=cut
2254		2704
2255	for (	2705	for (
2256	["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)],
2257	["cf::object::player" => qw(player)],	2708	["cf::object::player" => qw(player)],
2258	["cf::player" => qw(peaceful)],	2709	["cf::player" => qw(peaceful)],
2259	["cf::map" => qw(trigger)],	2710	["cf::map" => qw(trigger)],
2260	) {	2711	) {
2261	no strict 'refs';	2712	no strict 'refs';
…		…
2332	=back	2783	=back
2333		2784
2334	=cut	2785	=cut
2335		2786
2336	#############################################################################	2787	#############################################################################
2337
2338	=head2 EXTENSION DATABASE SUPPORT
2339
2340	Crossfire maintains a very simple database for extension use. It can
2341	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2342	convert to/from binary).
2343
2344	The parameter C<$family> should best start with the name of the extension
2345	using it, it should be unique.
2346
2347	=over 4
2348
2349	=item $value = cf::db_get $family => $key
2350
2351	Returns a single value from the database.
2352
2353	=item cf::db_put $family => $key => $value
2354
2355	Stores the given C<$value> in the family.
2356
2357	=cut
2358
2359	our $DB;
2360
2361	sub db_init {
2362	unless ($DB) {
2363	$DB = BDB::db_create $DB_ENV;
2364
2365	cf::sync_job {
2366	eval {
2367	$DB->set_flags (BDB::CHKSUM);
2368
2369	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2370	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2371	cf::cleanup "db_open(db): $!" if $!;
2372	};
2373	cf::cleanup "db_open(db): $@" if $@;
2374	};
2375	}
2376	}
2377
2378	sub db_get($$) {
2379	my $key = "$_[0]/$_[1]";
2380
2381	cf::sync_job {
2382	BDB::db_get $DB, undef, $key, my $data;
2383
2384	$! ? ()
2385	: $data
2386	}
2387	}
2388
2389	sub db_put($$$) {
2390	BDB::dbreq_pri 4;
2391	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2392	}
2393
2394	=item cf::cache $id => [$paths...], $processversion => $process
2395
2396	Generic caching function that returns the value of the resource $id,
2397	caching and regenerating as required.
2398
2399	This function can block.
2400
2401	=cut
2402
2403	sub cache {
2404	my ($id, $src, $processversion, $process) = @_;
2405
2406	my $meta =
2407	join "\x00",
2408	$processversion,
2409	map {
2410	aio_stat $_
2411	and Carp::croak "$_: $!";
2412
2413	($_, (stat _)[7,9])
2414	} @$src;
2415
2416	my $dbmeta = db_get cache => "$id/meta";
2417	if ($dbmeta ne $meta) {
2418	# changed, we may need to process
2419
2420	my @data;
2421	my $md5;
2422
2423	for (0 .. $#$src) {
2424	0 <= aio_load $src->[$_], $data[$_]
2425	or Carp::croak "$src->[$_]: $!";
2426	}
2427
2428	# if processing is expensive, check
2429	# checksum first
2430	if (1) {
2431	$md5 =
2432	join "\x00",
2433	$processversion,
2434	map {
2435	Coro::cede;
2436	($src->[$_], Digest::MD5::md5_hex $data[$_])
2437	} 0.. $#$src;
2438
2439
2440	my $dbmd5 = db_get cache => "$id/md5";
2441	if ($dbmd5 eq $md5) {
2442	db_put cache => "$id/meta", $meta;
2443
2444	return db_get cache => "$id/data";
2445	}
2446	}
2447
2448	my $t1 = Time::HiRes::time;
2449	my $data = $process->(\@data);
2450	my $t2 = Time::HiRes::time;
2451
2452	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2453
2454	db_put cache => "$id/data", $data;
2455	db_put cache => "$id/md5" , $md5;
2456	db_put cache => "$id/meta", $meta;
2457
2458	return $data;
2459	}
2460
2461	db_get cache => "$id/data"
2462	}
2463
2464	=item fork_call { }, $args
2465
2466	Executes the given code block with the given arguments in a seperate
2467	process, returning the results. Everything must be serialisable with
2468	Coro::Storable. May, of course, block. Note that the executed sub may
2469	never block itself or use any form of Event handling.
2470
2471	=cut
2472
2473	sub fork_call(&@) {
2474	my ($cb, @args) = @_;
2475
2476	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2477	# or die "socketpair: $!";
2478	pipe my $fh1, my $fh2
2479	or die "pipe: $!";
2480
2481	if (my $pid = fork) {
2482	close $fh2;
2483
2484	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2485	$res = Coro::Storable::thaw $res;
2486
2487	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2488
2489	die $$res unless "ARRAY" eq ref $res;
2490
2491	return wantarray ? @$res : $res->[-1];
2492	} else {
2493	reset_signals;
2494	local $SIG{__WARN__};
2495	local $SIG{__DIE__};
2496	eval {
2497	close $fh1;
2498
2499	my @res = eval { $cb->(@args) };
2500	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2501	};
2502
2503	warn $@ if $@;
2504	_exit 0;
2505	}
2506	}
2507
2508
2509
2510	#############################################################################
2511	# the server's init and main functions	2788	# the server's init and main functions
2512		2789
2513	sub load_facedata($) {	2790	sub load_facedata($) {
2514	my ($path) = @_;	2791	my ($path) = @_;
2515		2792
…		…
2527	{	2804	{
2528	my $faces = $facedata->{faceinfo};	2805	my $faces = $facedata->{faceinfo};
2529		2806
2530	while (my ($face, $info) = each %$faces) {	2807	while (my ($face, $info) = each %$faces) {
2531	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2808	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2532	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2809	cf::face::set_visibility $idx, $info->{visibility};
		2810	cf::face::set_magicmap $idx, $info->{magicmap};
2533	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2811	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2534	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	2812	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2535	Coro::cede;	2813
		2814	cf::cede_to_tick;
2536	}	2815	}
2537		2816
2538	while (my ($face, $info) = each %$faces) {	2817	while (my ($face, $info) = each %$faces) {
2539	next unless $info->{smooth};	2818	next unless $info->{smooth};
2540	my $idx = cf::face::find $face	2819	my $idx = cf::face::find $face
2541	or next;	2820	or next;
2542	if (my $smooth = cf::face::find $info->{smooth}) {	2821	if (my $smooth = cf::face::find $info->{smooth}) {
		2822	cf::face::set_smooth $idx, $smooth;
2543	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	2823	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2544	} else {	2824	} else {
2545	warn "smooth face '$info->{smooth}' not found for face '$face'";	2825	warn "smooth face '$info->{smooth}' not found for face '$face'";
2546	}	2826	}
2547	Coro::cede;	2827
		2828	cf::cede_to_tick;
2548	}	2829	}
2549	}	2830	}
2550		2831
2551	{	2832	{
2552	my $anims = $facedata->{animinfo};	2833	my $anims = $facedata->{animinfo};
2553		2834
2554	while (my ($anim, $info) = each %$anims) {	2835	while (my ($anim, $info) = each %$anims) {
2555	cf::anim::set $anim, $info->{frames}, $info->{facings};	2836	cf::anim::set $anim, $info->{frames}, $info->{facings};
2556	Coro::cede;	2837	cf::cede_to_tick;
2557	}	2838	}
2558		2839
2559	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	}
2560	}	2871	}
2561		2872
2562	1	2873	1
2563	}	2874	}
2564		2875
2565	sub reload_regions {	2876	sub reload_regions {
2566	load_resource_file "$MAPDIR/regions"	2877	load_resource_file "$MAPDIR/regions"
2567	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	}
2568	}	2884	}
2569		2885
2570	sub reload_facedata {	2886	sub reload_facedata {
2571	load_facedata "$DATADIR/facedata"	2887	load_facedata "$DATADIR/facedata"
2572	or die "unable to load facedata\n";	2888	or die "unable to load facedata\n";
2573	}	2889	}
2574		2890
2575	sub reload_archetypes {	2891	sub reload_archetypes {
2576	load_resource_file "$DATADIR/archetypes"	2892	load_resource_file "$DATADIR/archetypes"
2577	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";
2578	}	2899	}
2579		2900
2580	sub reload_treasures {	2901	sub reload_treasures {
2581	load_resource_file "$DATADIR/treasures"	2902	load_resource_file "$DATADIR/treasures"
2582	or die "unable to load treasurelists\n";	2903	or die "unable to load treasurelists\n";
…		…
2585	sub reload_resources {	2906	sub reload_resources {
2586	warn "reloading resource files...\n";	2907	warn "reloading resource files...\n";
2587		2908
2588	reload_regions;	2909	reload_regions;
2589	reload_facedata;	2910	reload_facedata;
		2911	#reload_archetypes;#d#
2590	reload_archetypes;	2912	reload_archetypes;
2591	reload_treasures;	2913	reload_treasures;
2592		2914
2593	warn "finished reloading resource files\n";	2915	warn "finished reloading resource files\n";
2594	}	2916	}
…		…
2651	},	2973	},
2652	);	2974	);
2653	}	2975	}
2654	}	2976	}
2655		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
2656	sub emergency_save() {	3016	sub emergency_save() {
2657	my $freeze_guard = cf::freeze_mainloop;	3017	my $freeze_guard = cf::freeze_mainloop;
2658		3018
2659	warn "enter emergency perl save\n";	3019	warn "enter emergency perl save\n";
2660		3020
…		…
2735	%EXT_CORO = ();	3095	%EXT_CORO = ();
2736		3096
2737	warn "removing commands";	3097	warn "removing commands";
2738	%COMMAND = ();	3098	%COMMAND = ();
2739		3099
2740	warn "removing ext commands";	3100	warn "removing ext/exti commands";
2741	%EXTCMD = ();	3101	%EXTCMD = ();
		3102	%EXTICMD = ();
2742		3103
2743	warn "unloading/nuking all extensions";	3104	warn "unloading/nuking all extensions";
2744	for my $pkg (@EXTS) {	3105	for my $pkg (@EXTS) {
2745	warn "... unloading $pkg";	3106	warn "... unloading $pkg";
2746		3107

Diff Legend

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