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.324 by root, Sat Jul 28 14:23:17 2007 UTC

…		…
20	use Coro::Signal;	20	use Coro::Signal;
21	use Coro::Semaphore;	21	use Coro::Semaphore;
22	use Coro::AIO;	22	use Coro::AIO;
23	use Coro::Storable;	23	use Coro::Storable;
24		24
		25	use JSON::XS 1.4 ();
25	use BDB ();	26	use BDB ();
26	use Data::Dumper;	27	use Data::Dumper;
27	use Digest::MD5;	28	use Digest::MD5;
28	use Fcntl;	29	use Fcntl;
29	use YAML::Syck ();	30	use YAML::Syck ();
30	use IO::AIO 2.32 ();	31	use IO::AIO 2.32 ();
31	use Time::HiRes;	32	use Time::HiRes;
32	use Compress::LZF;	33	use Compress::LZF;
		34	use Digest::MD5 ();
33		35
34	# configure various modules to our taste	36	# configure various modules to our taste
35	#	37	#
36	$Storable::canonical = 1; # reduce rsync transfers	38	$Storable::canonical = 1; # reduce rsync transfers
37	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator	39	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
…		…
49	our %COMMAND = ();	51	our %COMMAND = ();
50	our %COMMAND_TIME = ();	52	our %COMMAND_TIME = ();
51		53
52	our @EXTS = (); # list of extension package names	54	our @EXTS = (); # list of extension package names
53	our %EXTCMD = ();	55	our %EXTCMD = ();
		56	our %EXTICMD = ();
54	our %EXT_CORO = (); # coroutines bound to extensions	57	our %EXT_CORO = (); # coroutines bound to extensions
55	our %EXT_MAP = (); # pluggable maps	58	our %EXT_MAP = (); # pluggable maps
56		59
57	our $RELOAD; # number of reloads so far	60	our $RELOAD; # number of reloads so far
58	our @EVENT;	61	our @EVENT;
…		…
164		167
165	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only	168	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
166	returns directly I<after> the tick processing (and consequently, can only wake one process	169	returns directly I<after> the tick processing (and consequently, can only wake one process
167	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.	170	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
168		171
		172	=item @cf::INVOKE_RESULTS
		173
		174	This array contains the results of the last C<invoke ()> call. When
		175	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		176	that call.
		177
169	=back	178	=back
170		179
171	=cut	180	=cut
172		181
173	BEGIN {	182	BEGIN {
…		…
187	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	196	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
188	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	197	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
189	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	198	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
190	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	199	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
191	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	200	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		201	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
192	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	202	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
193		203
194	# we bless all objects into (empty) derived classes to force a method lookup	204	# we bless all objects into (empty) derived classes to force a method lookup
195	# within the Safe compartment.	205	# within the Safe compartment.
196	for my $pkg (qw(	206	for my $pkg (qw(
197	cf::global cf::attachable	207	cf::global cf::attachable
…		…
205	}	215	}
206		216
207	$Event::DIED = sub {	217	$Event::DIED = sub {
208	warn "error in event callback: @_";	218	warn "error in event callback: @_";
209	};	219	};
		220
		221	#############################################################################
210		222
211	=head2 UTILITY FUNCTIONS	223	=head2 UTILITY FUNCTIONS
212		224
213	=over 4	225	=over 4
214		226
…		…
233	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	245	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
234	$d	246	$d
235	} || "[unable to dump $_[0]: '$@']";	247	} || "[unable to dump $_[0]: '$@']";
236	}	248	}
237		249
238	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
239
240	=item $ref = cf::from_json $json	250	=item $ref = cf::from_json $json
241		251
242	Converts a JSON string into the corresponding perl data structure.	252	Converts a JSON string into the corresponding perl data structure.
243		253
244	=item $json = cf::to_json $ref	254	=item $json = cf::to_json $ref
245		255
246	Converts a perl data structure into its JSON representation.	256	Converts a perl data structure into its JSON representation.
		257
		258	=cut
		259
		260	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
		261
		262	sub to_json ($) { $json_coder->encode ($_[0]) }
		263	sub from_json ($) { $json_coder->decode ($_[0]) }
247		264
248	=item cf::lock_wait $string	265	=item cf::lock_wait $string
249		266
250	Wait until the given lock is available. See cf::lock_acquire.	267	Wait until the given lock is available. See cf::lock_acquire.
251		268
…		…
305	};	322	};
306	$TICK_WATCHER->stop;	323	$TICK_WATCHER->stop;
307	$guard	324	$guard
308	}	325	}
309		326
		327	=item cf::get_slot $time[, $priority[, $name]]
		328
		329	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		330	This call blocks and returns only when you have at least C<$time> seconds
		331	of cpu time till the next tick. The slot is only valid till the next cede.
		332
		333	The optional C<$name> can be used to identify the job to run. It might be
		334	used for statistical purposes and should identify the same time-class.
		335
		336	Useful for short background jobs.
		337
		338	=cut
		339
		340	our @SLOT_QUEUE;
		341	our $SLOT_QUEUE;
		342
		343	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		344	$SLOT_QUEUE = Coro::async {
		345	my $signal = new Coro::Signal;
		346
		347	while () {
		348	next_job:
		349	my $avail = cf::till_tick;
		350	if ($avail > 0.01) {
		351	for (0 .. $#SLOT_QUEUE) {
		352	if ($SLOT_QUEUE[$_][0] < $avail) {
		353	my $job = splice @SLOT_QUEUE, $_, 1, ();
		354	$job->[2]->send;
		355	Coro::cede;
		356	goto next_job;
		357	}
		358	}
		359	}
		360
		361	if (@SLOT_QUEUE) {
		362	# we do not use wait_For_tick() as it returns immediately when tick is inactive
		363	push @cf::WAIT_FOR_TICK, $signal;
		364	$signal->wait;
		365	} else {
		366	Coro::schedule;
		367	}
		368	}
		369	};
		370
		371	sub get_slot($;$$) {
		372	my ($time, $pri, $name) = @_;
		373
		374	$time = $TICK * .6 if $time > $TICK * .6;
		375	my $sig = new Coro::Signal;
		376
		377	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		378	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		379	$SLOT_QUEUE->ready;
		380	$sig->wait;
		381	}
		382
310	=item cf::async { BLOCK }	383	=item cf::async { BLOCK }
311		384
312	Currently the same as Coro::async_pool, meaning you cannot use	385	Currently the same as Coro::async_pool, meaning you cannot use
313	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only	386	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
314	thing you are allowed to do is call C<prio> on it.	387	thing you are allowed to do is call C<prio> on it.
…		…
317		390
318	BEGIN { *async = \&Coro::async_pool }	391	BEGIN { *async = \&Coro::async_pool }
319		392
320	=item cf::sync_job { BLOCK }	393	=item cf::sync_job { BLOCK }
321		394
322	The design of crossfire+ requires that the main coro ($Coro::main) is	395	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
323	always able to handle events or runnable, as crossfire+ is only partly	396	is always able to handle events or runnable, as Crossfire TRT is only
324	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	397	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		398	acceptable.
325		399
326	If it must be done, put the blocking parts into C<sync_job>. This will run	400	If it must be done, put the blocking parts into C<sync_job>. This will run
327	the given BLOCK in another coroutine while waiting for the result. The	401	the given BLOCK in another coroutine while waiting for the result. The
328	server will be frozen during this time, so the block should either finish	402	server will be frozen during this time, so the block should either finish
329	fast or be very important.	403	fast or be very important.
…		…
389	$EXT_CORO{$coro+0} = $coro;	463	$EXT_CORO{$coro+0} = $coro;
390		464
391	$coro	465	$coro
392	}	466	}
393		467
394	sub write_runtime {	468	=item fork_call { }, $args
395	my $runtime = "$LOCALDIR/runtime";
396		469
397	# first touch the runtime file to show we are still running:	470	Executes the given code block with the given arguments in a seperate
398	# the fsync below can take a very very long time.	471	process, returning the results. Everything must be serialisable with
		472	Coro::Storable. May, of course, block. Note that the executed sub may
		473	never block itself or use any form of Event handling.
399		474
400	if (my $fh = aio_open $runtime, O_WRONLY, 0) {	475	=cut
401	utime undef, undef, $fh;
402	}
403		476
404	my $guard = cf::lock_acquire "write_runtime";	477	sub _store_scalar {
405		478	open my $fh, ">", \my $buf
406	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	479	or die "fork_call: cannot open fh-to-buf in child : $!";
407	or return;	480	Storable::store_fd $_[0], $fh;
408
409	my $value = $cf::RUNTIME + 90 + 10;
410	# 10 is the runtime save interval, for a monotonic clock
411	# 60 allows for the watchdog to kill the server.
412
413	(aio_write $fh, 0, (length $value), $value, 0) <= 0
414	and return;
415
416	# always fsync - this file is important
417	aio_fsync $fh
418	and return;
419
420	# touch it again to show we are up-to-date
421	utime undef, undef, $fh;
422
423	close $fh	481	close $fh;
424	or return;
425		482
426	aio_rename "$runtime~", $runtime	483	$buf
427	and return;	484	}
428		485
429	warn "runtime file written.\n";#d#	486	sub fork_call(&@) {
		487	my ($cb, @args) = @_;
430		488
		489	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
		490	# or die "socketpair: $!";
		491	pipe my $fh1, my $fh2
		492	or die "pipe: $!";
		493
		494	if (my $pid = fork) {
		495	close $fh2;
		496
		497	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
		498	warn "pst<$res>" unless $res =~ /^pst/;
		499	$res = Coro::Storable::thaw $res;
		500
		501	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		502
		503	Carp::confess $$res unless "ARRAY" eq ref $res;
		504
		505	return wantarray ? @$res : $res->[-1];
		506	} else {
		507	reset_signals;
		508	local $SIG{__WARN__};
		509	local $SIG{__DIE__};
		510	# just in case, this hack effectively disables event
		511	# in the child. cleaner and slower would be canceling all watchers,
		512	# but this works for the time being.
		513	local $Coro::idle;
		514	$Coro::current->prio (Coro::PRIO_MAX);
		515
		516	eval {
		517	close $fh1;
		518
		519	my @res = eval { $cb->(@args) };
		520
		521	syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
		522	close $fh2;
		523	};
		524
		525	warn $@ if $@;
		526	_exit 0;
431	1	527	}
		528	}
		529
		530	=item $value = cf::db_get $family => $key
		531
		532	Returns a single value from the environment database.
		533
		534	=item cf::db_put $family => $key => $value
		535
		536	Stores the given C<$value> in the family. It can currently store binary
		537	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		538
		539	=cut
		540
		541	our $DB;
		542
		543	sub db_init {
		544	unless ($DB) {
		545	$DB = BDB::db_create $DB_ENV;
		546
		547	cf::sync_job {
		548	eval {
		549	$DB->set_flags (BDB::CHKSUM);
		550
		551	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		552	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		553	cf::cleanup "db_open(db): $!" if $!;
		554	};
		555	cf::cleanup "db_open(db): $@" if $@;
		556	};
		557	}
		558	}
		559
		560	sub db_get($$) {
		561	my $key = "$_[0]/$_[1]";
		562
		563	cf::sync_job {
		564	BDB::db_get $DB, undef, $key, my $data;
		565
		566	$! ? ()
		567	: $data
		568	}
		569	}
		570
		571	sub db_put($$$) {
		572	BDB::dbreq_pri 4;
		573	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		574	}
		575
		576	=item cf::cache $id => [$paths...], $processversion => $process
		577
		578	Generic caching function that returns the value of the resource $id,
		579	caching and regenerating as required.
		580
		581	This function can block.
		582
		583	=cut
		584
		585	sub cache {
		586	my ($id, $src, $processversion, $process) = @_;
		587
		588	my $meta =
		589	join "\x00",
		590	$processversion,
		591	map {
		592	aio_stat $_
		593	and Carp::croak "$_: $!";
		594
		595	($_, (stat _)[7,9])
		596	} @$src;
		597
		598	my $dbmeta = db_get cache => "$id/meta";
		599	if ($dbmeta ne $meta) {
		600	# changed, we may need to process
		601
		602	my @data;
		603	my $md5;
		604
		605	for (0 .. $#$src) {
		606	0 <= aio_load $src->[$_], $data[$_]
		607	or Carp::croak "$src->[$_]: $!";
		608	}
		609
		610	# if processing is expensive, check
		611	# checksum first
		612	if (1) {
		613	$md5 =
		614	join "\x00",
		615	$processversion,
		616	map {
		617	Coro::cede;
		618	($src->[$_], Digest::MD5::md5_hex $data[$_])
		619	} 0.. $#$src;
		620
		621
		622	my $dbmd5 = db_get cache => "$id/md5";
		623	if ($dbmd5 eq $md5) {
		624	db_put cache => "$id/meta", $meta;
		625
		626	return db_get cache => "$id/data";
		627	}
		628	}
		629
		630	my $t1 = Time::HiRes::time;
		631	my $data = $process->(\@data);
		632	my $t2 = Time::HiRes::time;
		633
		634	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		635
		636	db_put cache => "$id/data", $data;
		637	db_put cache => "$id/md5" , $md5;
		638	db_put cache => "$id/meta", $meta;
		639
		640	return $data;
		641	}
		642
		643	db_get cache => "$id/data"
432	}	644	}
433		645
434	=item cf::datalog type => key => value, ...	646	=item cf::datalog type => key => value, ...
435		647
436	Log a datalog packet of the given type with the given key-value pairs.	648	Log a datalog packet of the given type with the given key-value pairs.
…		…
454	attach callbacks/event handlers (a collection of which is called an "attachment")	666	attach callbacks/event handlers (a collection of which is called an "attachment")
455	to it. All such attachable objects support the following methods.	667	to it. All such attachable objects support the following methods.
456		668
457	In the following description, CLASS can be any of C<global>, C<object>	669	In the following description, CLASS can be any of C<global>, C<object>
458	C<player>, C<client> or C<map> (i.e. the attachable objects in	670	C<player>, C<client> or C<map> (i.e. the attachable objects in
459	crossfire+).	671	Crossfire TRT).
460		672
461	=over 4	673	=over 4
462		674
463	=item $attachable->attach ($attachment, key => $value...)	675	=item $attachable->attach ($attachment, key => $value...)
464		676
…		…
666	_attach $registry, $klass, @attach;	878	_attach $registry, $klass, @attach;
667	}	879	}
668		880
669	$obj->{$name} = \%arg;	881	$obj->{$name} = \%arg;
670	} else {	882	} else {
671	warn "object uses attachment '$name' that is not available, postponing.\n";	883	warn "object uses attachment '$name' which is not available, postponing.\n";
672	}	884	}
673		885
674	$obj->{_attachment}{$name} = undef;	886	$obj->{_attachment}{$name} = undef;
675	}	887	}
676		888
…		…
716	";	928	";
717	die if $@;	929	die if $@;
718	}	930	}
719		931
720	our $override;	932	our $override;
721	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	933	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
722		934
723	sub override {	935	sub override {
724	$override = 1;	936	$override = 1;
725	@invoke_results = ();	937	@INVOKE_RESULTS = (@_);
726	}	938	}
727		939
728	sub do_invoke {	940	sub do_invoke {
729	my $event = shift;	941	my $event = shift;
730	my $callbacks = shift;	942	my $callbacks = shift;
731		943
732	@invoke_results = ();	944	@INVOKE_RESULTS = ();
733		945
734	local $override;	946	local $override;
735		947
736	for (@$callbacks) {	948	for (@$callbacks) {
737	eval { &{$_->[1]} };	949	eval { &{$_->[1]} };
…		…
754		966
755	Generate an object-specific event with the given arguments.	967	Generate an object-specific event with the given arguments.
756		968
757	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	969	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
758	removed in future versions), and there is no public API to access override	970	removed in future versions), and there is no public API to access override
759	results (if you must, access C<@cf::invoke_results> directly).	971	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
760		972
761	=back	973	=back
762		974
763	=cut	975	=cut
764		976
765	#############################################################################	977	#############################################################################
766	# object support	978	# object support
		979	#
		980
		981	sub _can_merge {
		982	my ($ob1, $ob2) = @_;
		983
		984	local $Storable::canonical = 1;
		985	my $fob1 = Storable::freeze $ob1;
		986	my $fob2 = Storable::freeze $ob2;
		987
		988	$fob1 eq $fob2
		989	}
767		990
768	sub reattach {	991	sub reattach {
769	# basically do the same as instantiate, without calling instantiate	992	# basically do the same as instantiate, without calling instantiate
770	my ($obj) = @_;	993	my ($obj) = @_;
771		994
…		…
874	or return;	1097	or return;
875	$av = eval { (Storable::thaw $av)->{objs} };	1098	$av = eval { (Storable::thaw $av)->{objs} };
876	}	1099	}
877		1100
878	warn sprintf "loading %s (%d)\n",	1101	warn sprintf "loading %s (%d)\n",
879	$filename, length $data, scalar @{$av || []};#d#	1102	$filename, length $data, scalar @{$av || []};
880	return ($data, $av);	1103	return ($data, $av);
881	}	1104	}
		1105
		1106	=head2 COMMAND CALLBACKS
		1107
		1108	=over 4
		1109
		1110	=cut
882		1111
883	#############################################################################	1112	#############################################################################
884	# command handling &c	1113	# command handling &c
885		1114
886	=item cf::register_command $name => \&callback($ob,$args);	1115	=item cf::register_command $name => \&callback($ob,$args);
…		…
899	push @{ $COMMAND{$name} }, [$caller, $cb];	1128	push @{ $COMMAND{$name} }, [$caller, $cb];
900	}	1129	}
901		1130
902	=item cf::register_extcmd $name => \&callback($pl,$packet);	1131	=item cf::register_extcmd $name => \&callback($pl,$packet);
903		1132
904	Register a callbackf ro execution when the client sends an extcmd packet.	1133	Register a callback for execution when the client sends an (synchronous)
		1134	extcmd packet. Ext commands will be processed in the order they are
		1135	received by the server, like other user commands. The first argument is
		1136	the logged-in player. Ext commands can only be processed after a player
		1137	has logged in successfully.
905		1138
906	If the callback returns something, it is sent back as if reply was being	1139	If the callback returns something, it is sent back as if reply was being
907	called.	1140	called.
908		1141
		1142	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1143
		1144	Register a callback for execution when the client sends an (asynchronous)
		1145	exticmd packet. Exti commands are processed by the server as soon as they
		1146	are received, i.e. out of order w.r.t. other commands. The first argument
		1147	is a client socket. Exti commands can be received anytime, even before
		1148	log-in.
		1149
		1150	If the callback returns something, it is sent back as if reply was being
		1151	called.
		1152
909	=cut	1153	=cut
910		1154
911	sub register_extcmd {	1155	sub register_extcmd {
912	my ($name, $cb) = @_;	1156	my ($name, $cb) = @_;
913		1157
914	$EXTCMD{$name} = $cb;	1158	$EXTCMD{$name} = $cb;
		1159	}
		1160
		1161	sub register_exticmd {
		1162	my ($name, $cb) = @_;
		1163
		1164	$EXTICMD{$name} = $cb;
915	}	1165	}
916		1166
917	cf::player->attach (	1167	cf::player->attach (
918	on_command => sub {	1168	on_command => sub {
919	my ($pl, $name, $params) = @_;	1169	my ($pl, $name, $params) = @_;
…		…
928	cf::override;	1178	cf::override;
929	},	1179	},
930	on_extcmd => sub {	1180	on_extcmd => sub {
931	my ($pl, $buf) = @_;	1181	my ($pl, $buf) = @_;
932		1182
933	my $msg = eval { from_json $buf };	1183	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
934		1184
935	if (ref $msg) {	1185	if (ref $msg) {
		1186	my ($type, $reply, @payload) =
		1187	"ARRAY" eq ref $msg
		1188	? @$msg
		1189	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1190
936	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1191	if (my $cb = $EXTCMD{$type}) {
937	if (my %reply = $cb->($pl, $msg)) {	1192	my @reply = $cb->($pl, @payload);
		1193
938	$pl->ext_reply ($msg->{msgid}, %reply);	1194	$pl->ext_reply ($reply, @reply)
939	}	1195	if $reply;
940	}	1196	}
941	} else {	1197	} else {
942	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1198	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
943	}	1199	}
944		1200
945	cf::override;	1201	cf::override;
946	},	1202	},
947	);	1203	);
948		1204
949	sub load_extension {
950	my ($path) = @_;
951
952	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
953	my $base = $1;
954	my $pkg = $1;
955	$pkg =~ s/[^[:word:]]/_/g;
956	$pkg = "ext::$pkg";
957
958	warn "... loading '$path' into '$pkg'\n";
959
960	open my $fh, "<:utf8", $path
961	or die "$path: $!";
962
963	my $source =
964	"package $pkg; use strict; use utf8;\n"
965	. "#line 1 \"$path\"\n{\n"
966	. (do { local $/; <$fh> })
967	. "\n};\n1";
968
969	unless (eval $source) {
970	my $msg = $@ ? "$path: $@\n"
971	: "extension disabled.\n";
972	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
973	warn $@;
974	warn "mandatory extension failed to load, exiting.\n";
975	exit 1;
976	}
977	die $@;
978	}
979
980	push @EXTS, $pkg;
981	}
982
983	sub load_extensions {	1205	sub load_extensions {
		1206	cf::sync_job {
		1207	my %todo;
		1208
984	for my $ext (<$LIBDIR/*.ext>) {	1209	for my $path (<$LIBDIR/*.ext>) {
985	next unless -r $ext;	1210	next unless -r $path;
986	eval {	1211
987	load_extension $ext;	1212	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1213	my $base = $1;
		1214	my $pkg = $1;
		1215	$pkg =~ s/[^[:word:]]/_/g;
		1216	$pkg = "ext::$pkg";
		1217
		1218	open my $fh, "<:utf8", $path
		1219	or die "$path: $!";
		1220
		1221	my $source = do { local $/; <$fh> };
		1222
		1223	my %ext = (
		1224	path => $path,
		1225	base => $base,
		1226	pkg => $pkg,
		1227	);
		1228
		1229	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1230	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1231
		1232	$ext{source} =
		1233	"package $pkg; use strict; use utf8;\n"
		1234	. "#line 1 \"$path\"\n{\n"
		1235	. $source
		1236	. "\n};\n1";
		1237
		1238	$todo{$base} = \%ext;
		1239	}
		1240
		1241	my %done;
		1242	while (%todo) {
		1243	my $progress;
		1244
		1245	while (my ($k, $v) = each %todo) {
		1246	for (split /,\s*/, $v->{meta}{depends}) {
		1247	goto skip
		1248	unless exists $done{$_};
		1249	}
		1250
		1251	warn "... loading '$k' into '$v->{pkg}'\n";
		1252
		1253	unless (eval $v->{source}) {
		1254	my $msg = $@ ? "$v->{path}: $@\n"
		1255	: "$v->{base}: extension inactive.\n";
		1256
		1257	if (exists $v->{meta}{mandatory}) {
		1258	warn $msg;
		1259	warn "mandatory extension failed to load, exiting.\n";
		1260	exit 1;
		1261	}
		1262
		1263	warn $msg;
		1264	}
		1265
		1266	$done{$k} = delete $todo{$k};
		1267	push @EXTS, $v->{pkg};
		1268	$progress = 1;
988	1	1269	}
989	} or warn "$ext not loaded: $@";	1270
		1271	skip:
		1272	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1273	unless $progress;
		1274	}
990	}	1275	};
991	}	1276	}
992		1277
993	#############################################################################	1278	#############################################################################
		1279
		1280	=back
994		1281
995	=head2 CORE EXTENSIONS	1282	=head2 CORE EXTENSIONS
996		1283
997	Functions and methods that extend core crossfire objects.	1284	Functions and methods that extend core crossfire objects.
998		1285
…		…
1186	}	1473	}
1187		1474
1188	\@paths	1475	\@paths
1189	}	1476	}
1190		1477
		1478	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1479
		1480	Expand crossfire pod fragments into protocol xml.
		1481
		1482	=cut
		1483
		1484	sub expand_cfpod {
		1485	((my $self), (local $_)) = @_;
		1486
		1487	# escape & and <
		1488	s/&/&amp;/g;
		1489	s/(?<![BIUGH])</&lt;/g;
		1490
		1491	# this is buggy, it needs to properly take care of nested <'s
		1492
		1493	1 while
		1494	# replace B<>, I<>, U<> etc.
		1495	s/B<([^\>]*)>/<b>$1<\/b>/
		1496	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1497	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1498	# replace G<male|female> tags
		1499	|| s{G<([^>|]*)\|([^>]*)>}{
		1500	$self->gender ? $2 : $1
		1501	}ge
		1502	# replace H<hint text>
		1503	|| s{H<([^\>]*)>}
		1504	{
		1505	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1506	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1507	"")
		1508	[$self->{hintmode}]
		1509	}ge;
		1510
		1511	# create single paragraphs (very hackish)
		1512	s/(?<=\S)\n(?=\w)/ /g;
		1513
		1514	# compress some whitespace
		1515	s/\s+\n/\n/g; # ws line-ends
		1516	s/\n\n+/\n/g; # double lines
		1517	s/^\n+//; # beginning lines
		1518	s/\n+$//; # ending lines
		1519
		1520	$_
		1521	}
		1522
		1523	sub hintmode {
		1524	$_[0]{hintmode} = $_[1] if @_ > 1;
		1525	$_[0]{hintmode}
		1526	}
		1527
1191	=item $player->ext_reply ($msgid, %msg)	1528	=item $player->ext_reply ($msgid, @msg)
1192		1529
1193	Sends an ext reply to the player.	1530	Sends an ext reply to the player.
1194		1531
1195	=cut	1532	=cut
1196		1533
1197	sub ext_reply($$%) {	1534	sub ext_reply($$@) {
1198	my ($self, $id, %msg) = @_;	1535	my ($self, $id, @msg) = @_;
1199		1536
1200	$msg{msgid} = $id;	1537	if ($self->ns->extcmd == 2) {
1201		1538	$self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1202	$self->send ("ext " . cf::to_json \%msg);	1539	} elsif ($self->ns->extcmd == 1) {
		1540	#TODO: version 1, remove
		1541	unshift @msg, msgtype => "reply", msgid => $id;
		1542	$self->send ("ext " . $self->ns->{json_coder}->encode ({@msg}));
		1543	}
1203	}	1544	}
1204		1545
1205	=item $player->ext_event ($type, %msg)	1546	=item $player->ext_msg ($type, @msg)
1206		1547
1207	Sends an ext event to the client.	1548	Sends an ext event to the client.
1208		1549
1209	=cut	1550	=cut
1210		1551
1211	sub ext_event($$%) {	1552	sub ext_msg($$@) {
1212	my ($self, $type, %msg) = @_;	1553	my ($self, $type, @msg) = @_;
1213		1554
1214	$self->ns->ext_event ($type, %msg);	1555	$self->ns->ext_msg ($type, @msg);
1215	}	1556	}
1216		1557
1217	=head3 cf::region	1558	=head3 cf::region
1218		1559
1219	=over 4	1560	=over 4
…		…
1222		1563
1223	package cf::region;	1564	package cf::region;
1224		1565
1225	=item cf::region::find_by_path $path	1566	=item cf::region::find_by_path $path
1226		1567
1227	Tries to decuce the probable region for a map knowing only its path.	1568	Tries to decuce the likely region for a map knowing only its path.
1228		1569
1229	=cut	1570	=cut
1230		1571
1231	sub find_by_path($) {	1572	sub find_by_path($) {
1232	my ($path) = @_;	1573	my ($path) = @_;
1233		1574
1234	my ($match, $specificity);	1575	my ($match, $specificity);
1235		1576
1236	for my $region (list) {	1577	for my $region (list) {
1237	if ($region->match && $path =~ $region->match) {	1578	if ($region->{match} && $path =~ $region->{match}) {
1238	($match, $specificity) = ($region, $region->specificity)	1579	($match, $specificity) = ($region, $region->specificity)
1239	if $region->specificity > $specificity;	1580	if $region->specificity > $specificity;
1240	}	1581	}
1241	}	1582	}
1242		1583
…		…
1306	my ($self, $merge) = @_;	1647	my ($self, $merge) = @_;
1307		1648
1308	# we have to keep some variables in memory intact	1649	# we have to keep some variables in memory intact
1309	local $self->{path};	1650	local $self->{path};
1310	local $self->{load_path};	1651	local $self->{load_path};
1311	local $self->{deny_save};
1312	local $self->{deny_reset};
1313		1652
1314	$self->SUPER::thawer_merge ($merge);	1653	$self->SUPER::thawer_merge ($merge);
1315	}	1654	}
1316		1655
1317	sub normalise {	1656	sub normalise {
…		…
1364	$self->init; # pass $1 etc.	1703	$self->init; # pass $1 etc.
1365	return $self;	1704	return $self;
1366	}	1705	}
1367	}	1706	}
1368		1707
1369	Carp::carp "unable to resolve path '$path' (base '$base').";	1708	Carp::cluck "unable to resolve path '$path' (base '$base').";
1370	()	1709	()
1371	}	1710	}
1372		1711
1373	sub init {	1712	sub init {
1374	my ($self) = @_;	1713	my ($self) = @_;
…		…
1415	sub change_all_map_light {	1754	sub change_all_map_light {
1416	my ($change) = @_;	1755	my ($change) = @_;
1417		1756
1418	$_->change_map_light ($change)	1757	$_->change_map_light ($change)
1419	for grep $_->outdoor, values %cf::MAP;	1758	for grep $_->outdoor, values %cf::MAP;
		1759	}
		1760
		1761	sub decay_objects {
		1762	my ($self) = @_;
		1763
		1764	return if $self->{deny_reset};
		1765
		1766	$self->do_decay_objects;
1420	}	1767	}
1421		1768
1422	sub unlink_save {	1769	sub unlink_save {
1423	my ($self) = @_;	1770	my ($self) = @_;
1424		1771
…		…
1482	$self->load_header_orig	1829	$self->load_header_orig
1483	or return;	1830	or return;
1484	$self->prepare_orig;	1831	$self->prepare_orig;
1485	}	1832	}
1486		1833
		1834	$self->{deny_reset} = 1
		1835	if $self->no_reset;
		1836
1487	$self->default_region (cf::region::find_by_path $self->{path})	1837	$self->default_region (cf::region::find_by_path $self->{path})
1488	unless $self->default_region;	1838	unless $self->default_region;
1489		1839
1490	1	1840	1
1491	}	1841	}
…		…
1506	$map->{last_save} = $cf::RUNTIME;	1856	$map->{last_save} = $cf::RUNTIME;
1507		1857
1508	$map->load_header	1858	$map->load_header
1509	or return;	1859	or return;
1510		1860
1511	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1861	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1512	# doing this can freeze the server in a sync job, obviously	1862	# doing this can freeze the server in a sync job, obviously
1513	#$cf::WAIT_FOR_TICK->wait;	1863	#$cf::WAIT_FOR_TICK->wait;
1514	$map->reset;	1864	$map->reset;
1515	undef $guard;	1865	undef $guard;
1516	return find $path;	1866	return find $path;
…		…
1571	$self->set_darkness_map;	1921	$self->set_darkness_map;
1572	Coro::cede;	1922	Coro::cede;
1573	$self->activate;	1923	$self->activate;
1574	}	1924	}
1575		1925
		1926	$map->{last_save} = $cf::RUNTIME;
		1927	$map->last_access ($cf::RUNTIME);
		1928
1576	$self->in_memory (cf::MAP_IN_MEMORY);	1929	$self->in_memory (cf::MAP_IN_MEMORY);
1577	}	1930	}
1578		1931
1579	$self->post_load;	1932	$self->post_load;
1580	}	1933	}
…		…
1582	sub customise_for {	1935	sub customise_for {
1583	my ($self, $ob) = @_;	1936	my ($self, $ob) = @_;
1584		1937
1585	return find "~" . $ob->name . "/" . $self->{path}	1938	return find "~" . $ob->name . "/" . $self->{path}
1586	if $self->per_player;	1939	if $self->per_player;
		1940
		1941	# return find "?party/" . $ob->name . "/" . $self->{path}
		1942	# if $self->per_party;
1587		1943
1588	$self	1944	$self
1589	}	1945	}
1590		1946
1591	# find and load all maps in the 3x3 area around a map	1947	# find and load all maps in the 3x3 area around a map
…		…
1638		1994
1639	undef $MAP_PREFETCH{$path};	1995	undef $MAP_PREFETCH{$path};
1640	$MAP_PREFETCHER ||= cf::async {	1996	$MAP_PREFETCHER ||= cf::async {
1641	while (%MAP_PREFETCH) {	1997	while (%MAP_PREFETCH) {
1642	for my $path (keys %MAP_PREFETCH) {	1998	for my $path (keys %MAP_PREFETCH) {
1643	my $map = find $path	1999	if (my $map = find $path) {
1644	or next;
1645	$map->load;	2000	$map->load;
		2001	}
1646		2002
1647	delete $MAP_PREFETCH{$path};	2003	delete $MAP_PREFETCH{$path};
1648	}	2004	}
1649	}	2005	}
1650	undef $MAP_PREFETCHER;	2006	undef $MAP_PREFETCHER;
…		…
1702		2058
1703	sub reset_at {	2059	sub reset_at {
1704	my ($self) = @_;	2060	my ($self) = @_;
1705		2061
1706	# TODO: safety, remove and allow resettable per-player maps	2062	# 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};	2063	return 1e99 if $self->{deny_reset};
1709		2064
1710	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2065	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1711	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2066	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1712		2067
…		…
1723	my ($self) = @_;	2078	my ($self) = @_;
1724		2079
1725	my $lock = cf::lock_acquire "map_data:$self->{path}";	2080	my $lock = cf::lock_acquire "map_data:$self->{path}";
1726		2081
1727	return if $self->players;	2082	return if $self->players;
1728	return if $self->isa ("ext::map_per_player");#d#
1729		2083
1730	warn "resetting map ", $self->path;#d#	2084	warn "resetting map ", $self->path;
1731		2085
1732	$self->in_memory (cf::MAP_SWAPPED);	2086	$self->in_memory (cf::MAP_SWAPPED);
1733		2087
1734	# need to save uniques path	2088	# need to save uniques path
1735	unless ($self->{deny_save}) {	2089	unless ($self->{deny_save}) {
…		…
1767	$cf::MAP{$self->path} = $self;	2121	$cf::MAP{$self->path} = $self;
1768		2122
1769	$self->reset; # polite request, might not happen	2123	$self->reset; # polite request, might not happen
1770	}	2124	}
1771		2125
		2126	=item $maps = cf::map::tmp_maps
		2127
		2128	Returns an arrayref with all map paths of currently instantiated and saved
		2129	maps. May block.
		2130
		2131	=cut
		2132
		2133	sub tmp_maps() {
		2134	[
		2135	map {
		2136	utf8::decode $_;
		2137	/\.map$/
		2138	? normalise $_
		2139	: ()
		2140	} @{ aio_readdir $TMPDIR or [] }
		2141	]
		2142	}
		2143
		2144	=item $maps = cf::map::random_maps
		2145
		2146	Returns an arrayref with all map paths of currently instantiated and saved
		2147	random maps. May block.
		2148
		2149	=cut
		2150
		2151	sub random_maps() {
		2152	[
		2153	map {
		2154	utf8::decode $_;
		2155	/\.map$/
		2156	? normalise "?random/$_"
		2157	: ()
		2158	} @{ aio_readdir $RANDOMDIR or [] }
		2159	]
		2160	}
		2161
1772	=item cf::map::unique_maps	2162	=item cf::map::unique_maps
1773		2163
1774	Returns an arrayref of paths of all shared maps that have	2164	Returns an arrayref of paths of all shared maps that have
1775	instantiated unique items. May block.	2165	instantiated unique items. May block.
1776		2166
1777	=cut	2167	=cut
1778		2168
1779	sub unique_maps() {	2169	sub unique_maps() {
1780	my $files = aio_readdir $UNIQUEDIR	2170	[
1781	or return;	2171	map {
1782
1783	my @paths;
1784
1785	for (@$files) {
1786	utf8::decode $_;	2172	utf8::decode $_;
1787	next if /\.pst$/;	2173	/\.map$/
1788	next unless /^$PATH_SEP/o;	2174	? normalise $_
1789		2175	: ()
1790	push @paths, cf::map::normalise $_;	2176	} @{ aio_readdir $UNIQUEDIR or [] }
1791	}	2177	]
1792
1793	\@paths
1794	}	2178	}
1795		2179
1796	package cf;	2180	package cf;
1797		2181
1798	=back	2182	=back
…		…
1844		2228
1845	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2229	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1846		2230
1847	if ($self->{record_replies}) {	2231	if ($self->{record_replies}) {
1848	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2232	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2233
1849	} else {	2234	} else {
		2235	my $pl = $self->contr;
		2236
		2237	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2238	my $dialog = $pl->{npc_dialog};
		2239	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2240
		2241	} else {
1850	$msg = $npc->name . " says: $msg" if $npc;	2242	$msg = $npc->name . " says: $msg" if $npc;
1851	$self->message ($msg, $flags);	2243	$self->message ($msg, $flags);
		2244	}
1852	}	2245	}
1853	}	2246	}
1854		2247
1855	=item $player_object->may ("access")	2248	=item $player_object->may ("access")
1856		2249
…		…
1904	$self->deactivate_recursive;	2297	$self->deactivate_recursive;
1905		2298
1906	return if UNIVERSAL::isa $self->map, "ext::map_link";	2299	return if UNIVERSAL::isa $self->map, "ext::map_link";
1907		2300
1908	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2301	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1909	if $self->map;	2302	if $self->map && $self->map->{path} ne "{link}";
1910		2303
1911	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2304	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1912	}	2305	}
1913		2306
1914	sub cf::object::player::leave_link {	2307	sub cf::object::player::leave_link {
1915	my ($self, $map, $x, $y) = @_;	2308	my ($self, $map, $x, $y) = @_;
		2309
		2310	return unless $self->contr->active;
1916		2311
1917	my $link_pos = delete $self->{_link_pos};	2312	my $link_pos = delete $self->{_link_pos};
1918		2313
1919	unless ($map) {	2314	unless ($map) {
1920	# restore original map position	2315	# restore original map position
…		…
1943		2338
1944	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2339	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1945	$self->enter_map ($map, $x, $y);	2340	$self->enter_map ($map, $x, $y);
1946	}	2341	}
1947		2342
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)])	2343	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1981		2344
1982	Moves the player to the given map-path and coordinates by first freezing	2345	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	2346	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	2347	that has to return the map if sucecssful, and then unfreezes the player on
1985	the new (success) or old (failed) map position.	2348	the new (success) or old (failed) map position. In either case, $done will
		2349	be called at the end of this process.
1986		2350
1987	=cut	2351	=cut
		2352
		2353	our $GOTOGEN;
1988		2354
1989	sub cf::object::player::goto {	2355	sub cf::object::player::goto {
1990	my ($self, $path, $x, $y, $check) = @_;	2356	my ($self, $path, $x, $y, $check, $done) = @_;
		2357
		2358	# do generation counting so two concurrent goto's will be executed in-order
		2359	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1991		2360
1992	$self->enter_link;	2361	$self->enter_link;
1993		2362
1994	(async {	2363	(async {
1995	my $map = eval {	2364	my $map = eval {
…		…
2008	if ($@) {	2377	if ($@) {
2009	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);	2378	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2010	LOG llevError | logBacktrace, Carp::longmess $@;	2379	LOG llevError | logBacktrace, Carp::longmess $@;
2011	}	2380	}
2012		2381
		2382	if ($gen == $self->{_goto_generation}) {
		2383	delete $self->{_goto_generation};
2013	$self->leave_link ($map, $x, $y);	2384	$self->leave_link ($map, $x, $y);
		2385	}
		2386
		2387	$done->() if $done;
2014	})->prio (1);	2388	})->prio (1);
2015	}	2389	}
2016		2390
2017	=item $player_object->enter_exit ($exit_object)	2391	=item $player_object->enter_exit ($exit_object)
2018		2392
…		…
2087	my $hp = $exit->stats->hp;	2461	my $hp = $exit->stats->hp;
2088	my $sp = $exit->stats->sp;	2462	my $sp = $exit->stats->sp;
2089		2463
2090	$self->enter_link;	2464	$self->enter_link;
2091		2465
		2466	# if exit is damned, update players death & WoR home-position
		2467	$self->contr->savebed ($slaying, $hp, $sp)
		2468	if $exit->flag (FLAG_DAMNED);
		2469
2092	(async {	2470	(async {
2093	$self->deactivate_recursive; # just to be sure	2471	$self->deactivate_recursive; # just to be sure
2094	unless (eval {	2472	unless (eval {
2095	$self->goto ($slaying, $hp, $sp);	2473	$self->goto ($slaying, $hp, $sp);
2096		2474
…		…
2123		2501
2124	utf8::encode $text;	2502	utf8::encode $text;
2125	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2503	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2126	}	2504	}
2127		2505
		2506	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2507
		2508	Send a drawinfo or msg packet to the client, formatting the msg for the
		2509	client if neccessary. C<$type> should be a string identifying the type of
		2510	the message, with C<log> being the default. If C<$color> is negative, suppress
		2511	the message unless the client supports the msg packet.
		2512
		2513	=cut
		2514
		2515	sub cf::client::send_msg {
		2516	my ($self, $channel, $msg, $color, @extra) = @_;
		2517
		2518	$msg = $self->pl->expand_cfpod ($msg);
		2519
		2520	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2521
		2522	if (ref $channel) {
		2523	# send meta info to client, if not yet sent
		2524	unless (exists $self->{channel}{$channel->{id}}) {
		2525	$self->{channel}{$channel->{id}} = $channel;
		2526	$self->ext_msg (channel_info => $channel);
		2527	}
		2528
		2529	$channel = $channel->{id};
		2530	}
		2531
		2532	return unless @extra || length $msg;
		2533
		2534	if ($self->can_msg) {
		2535	# default colour, mask it out
		2536	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2537	if $color & cf::NDI_DEF;
		2538
		2539	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2540	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2541	} else {
		2542	if ($color >= 0) {
		2543	# replace some tags by gcfclient-compatible ones
		2544	for ($msg) {
		2545	1 while
		2546	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2547	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2548	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2549	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2550	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2551	}
		2552
		2553	$color &= cf::NDI_COLOR_MASK;
		2554
		2555	if (0 && $msg =~ /\[/) {
		2556	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2557	} else {
		2558	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2559	$self->send_packet ("drawinfo $color $msg")
		2560	}
		2561	}
		2562	}
		2563	}
		2564
2128	=item $client->ext_event ($type, %msg)	2565	=item $client->ext_msg ($type, @msg)
2129		2566
2130	Sends an exti event to the client.	2567	Sends an ext event to the client.
2131		2568
2132	=cut	2569	=cut
2133		2570
2134	sub cf::client::ext_event($$%) {	2571	sub cf::client::ext_msg($$@) {
2135	my ($self, $type, %msg) = @_;	2572	my ($self, $type, @msg) = @_;
2136		2573
		2574	my $extcmd = $self->extcmd;
		2575
		2576	if ($extcmd == 2) {
		2577	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2578	} elsif ($extcmd == 1) { # TODO: remove
2137	$msg{msgtype} = "event_$type";	2579	push @msg, msgtype => "event_$type";
2138	$self->send_packet ("ext " . cf::to_json \%msg);	2580	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2581	}
2139	}	2582	}
2140		2583
2141	=item $success = $client->query ($flags, "text", \&cb)	2584	=item $success = $client->query ($flags, "text", \&cb)
2142		2585
2143	Queues a query to the client, calling the given callback with	2586	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>,	2587	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>.	2588	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2146		2589
2147	Queries can fail, so check the return code. Or don't, as queries will become	2590	Queries can fail, so check the return code. Or don't, as queries will
2148	reliable at some point in the future.	2591	become reliable at some point in the future.
2149		2592
2150	=cut	2593	=cut
2151		2594
2152	sub cf::client::query {	2595	sub cf::client::query {
2153	my ($self, $flags, $text, $cb) = @_;	2596	my ($self, $flags, $text, $cb) = @_;
…		…
2161	utf8::encode $text;	2604	utf8::encode $text;
2162	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2605	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2163		2606
2164	$self->send_packet ($self->{query_queue}[0][0])	2607	$self->send_packet ($self->{query_queue}[0][0])
2165	if @{ $self->{query_queue} } == 1;	2608	if @{ $self->{query_queue} } == 1;
		2609
		2610	1
2166	}	2611	}
2167		2612
2168	cf::client->attach (	2613	cf::client->attach (
		2614	on_connect => sub {
		2615	my ($ns) = @_;
		2616
		2617	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2618	},
2169	on_reply => sub {	2619	on_reply => sub {
2170	my ($ns, $msg) = @_;	2620	my ($ns, $msg) = @_;
2171		2621
2172	# this weird shuffling is so that direct followup queries	2622	# this weird shuffling is so that direct followup queries
2173	# get handled first	2623	# get handled first
…		…
2185	} else {	2635	} else {
2186	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2636	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2187	}	2637	}
2188	}	2638	}
2189	},	2639	},
		2640	on_exticmd => sub {
		2641	my ($ns, $buf) = @_;
		2642
		2643	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2644
		2645	if (ref $msg) {
		2646	my ($type, $reply, @payload) =
		2647	"ARRAY" eq ref $msg
		2648	? @$msg
		2649	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2650
		2651	if (my $cb = $EXTICMD{$type}) {
		2652	my @reply = $cb->($ns, @payload);
		2653
		2654	$ns->ext_reply ($reply, @reply)
		2655	if $reply;
		2656	}
		2657	} else {
		2658	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2659	}
		2660
		2661	cf::override;
		2662	},
2190	);	2663	);
2191		2664
2192	=item $client->async (\&cb)	2665	=item $client->async (\&cb)
2193		2666
2194	Create a new coroutine, running the specified callback. The coroutine will	2667	Create a new coroutine, running the specified callback. The coroutine will
…		…
2243		2716
2244	=pod	2717	=pod
2245		2718
2246	The following functions and methods are available within a safe environment:	2719	The following functions and methods are available within a safe environment:
2247		2720
2248	cf::object contr pay_amount pay_player map	2721	cf::object
		2722	contr pay_amount pay_player map x y force_find force_add
		2723	insert remove
		2724
2249	cf::object::player player	2725	cf::object::player
2250	cf::player peaceful	2726	player
2251	cf::map trigger	2727
		2728	cf::player
		2729	peaceful
		2730
		2731	cf::map
		2732	trigger
2252		2733
2253	=cut	2734	=cut
2254		2735
2255	for (	2736	for (
2256	["cf::object" => qw(contr pay_amount pay_player map)],	2737	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2738	insert remove)],
2257	["cf::object::player" => qw(player)],	2739	["cf::object::player" => qw(player)],
2258	["cf::player" => qw(peaceful)],	2740	["cf::player" => qw(peaceful)],
2259	["cf::map" => qw(trigger)],	2741	["cf::map" => qw(trigger)],
2260	) {	2742	) {
2261	no strict 'refs';	2743	no strict 'refs';
…		…
2332	=back	2814	=back
2333		2815
2334	=cut	2816	=cut
2335		2817
2336	#############################################################################	2818	#############################################################################
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	2819	# the server's init and main functions
2512		2820
2513	sub load_facedata($) {	2821	sub load_facedata($) {
2514	my ($path) = @_;	2822	my ($path) = @_;
2515		2823
…		…
2527	{	2835	{
2528	my $faces = $facedata->{faceinfo};	2836	my $faces = $facedata->{faceinfo};
2529		2837
2530	while (my ($face, $info) = each %$faces) {	2838	while (my ($face, $info) = each %$faces) {
2531	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2839	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2532	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2840	cf::face::set_visibility $idx, $info->{visibility};
		2841	cf::face::set_magicmap $idx, $info->{magicmap};
2533	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2842	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2534	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	2843	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2535	Coro::cede;	2844
		2845	cf::cede_to_tick;
2536	}	2846	}
2537		2847
2538	while (my ($face, $info) = each %$faces) {	2848	while (my ($face, $info) = each %$faces) {
2539	next unless $info->{smooth};	2849	next unless $info->{smooth};
2540	my $idx = cf::face::find $face	2850	my $idx = cf::face::find $face
2541	or next;	2851	or next;
2542	if (my $smooth = cf::face::find $info->{smooth}) {	2852	if (my $smooth = cf::face::find $info->{smooth}) {
		2853	cf::face::set_smooth $idx, $smooth;
2543	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	2854	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2544	} else {	2855	} else {
2545	warn "smooth face '$info->{smooth}' not found for face '$face'";	2856	warn "smooth face '$info->{smooth}' not found for face '$face'";
2546	}	2857	}
2547	Coro::cede;	2858
		2859	cf::cede_to_tick;
2548	}	2860	}
2549	}	2861	}
2550		2862
2551	{	2863	{
2552	my $anims = $facedata->{animinfo};	2864	my $anims = $facedata->{animinfo};
2553		2865
2554	while (my ($anim, $info) = each %$anims) {	2866	while (my ($anim, $info) = each %$anims) {
2555	cf::anim::set $anim, $info->{frames}, $info->{facings};	2867	cf::anim::set $anim, $info->{frames}, $info->{facings};
2556	Coro::cede;	2868	cf::cede_to_tick;
2557	}	2869	}
2558		2870
2559	cf::anim::invalidate_all; # d'oh	2871	cf::anim::invalidate_all; # d'oh
2560	}	2872	}
2561		2873
		2874	{
		2875	# TODO: for gcfclient pleasure, we should give resources
		2876	# that gcfclient doesn't grok a >10000 face index.
		2877	my $res = $facedata->{resource};
		2878	my $enc = JSON::XS->new->utf8->canonical;
		2879
		2880	my $soundconf = delete $res->{"res/sound.conf"};
		2881
		2882	while (my ($name, $info) = each %$res) {
		2883	my $meta = $enc->encode ({
		2884	name => $name,
		2885	%{ $info->{meta} || {} },
		2886	});
		2887
		2888	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2889
		2890	if ($info->{type} & 1) {
		2891	# prepend meta info
		2892
		2893	my $data = pack "(w/a*)*", $meta, $info->{data};
		2894	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2895
		2896	cf::face::set_data $idx, 0, $data, $chk;
		2897	} else {
		2898	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
		2899	}
		2900
		2901	cf::face::set_type $idx, $info->{type};
		2902
		2903	cf::cede_to_tick;
		2904	}
		2905
		2906	if ($soundconf) {
		2907	$soundconf = $enc->decode (delete $soundconf->{data});
		2908
		2909	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2910	my $sound = $soundconf->{compat}[$_]
		2911	or next;
		2912
		2913	my $face = cf::face::find "sound/$sound->[1]";
		2914
		2915	cf::sound::set $sound->[0] => $face;
		2916	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2917	}
		2918
		2919	#TODO
		2920	}
		2921	}
		2922
2562	1	2923	1
2563	}	2924	}
		2925
		2926	register_exticmd fx_want => sub {
		2927	my ($ns, $want) = @_;
		2928
		2929	while (my ($k, $v) = each %$want) {
		2930	$ns->fx_want ($k, $v);
		2931	}
		2932	};
2564		2933
2565	sub reload_regions {	2934	sub reload_regions {
2566	load_resource_file "$MAPDIR/regions"	2935	load_resource_file "$MAPDIR/regions"
2567	or die "unable to load regions file\n";	2936	or die "unable to load regions file\n";
		2937
		2938	for (cf::region::list) {
		2939	$_->{match} = qr/$_->{match}/
		2940	if exists $_->{match};
		2941	}
2568	}	2942	}
2569		2943
2570	sub reload_facedata {	2944	sub reload_facedata {
2571	load_facedata "$DATADIR/facedata"	2945	load_facedata "$DATADIR/facedata"
2572	or die "unable to load facedata\n";	2946	or die "unable to load facedata\n";
2573	}	2947	}
2574		2948
2575	sub reload_archetypes {	2949	sub reload_archetypes {
2576	load_resource_file "$DATADIR/archetypes"	2950	load_resource_file "$DATADIR/archetypes"
2577	or die "unable to load archetypes\n";	2951	or die "unable to load archetypes\n";
		2952	#d# NEED to laod twice to resolve forward references
		2953	# this really needs to be done in an extra post-pass
		2954	# (which needs to be synchronous, so solve it differently)
		2955	load_resource_file "$DATADIR/archetypes"
		2956	or die "unable to load archetypes\n";
2578	}	2957	}
2579		2958
2580	sub reload_treasures {	2959	sub reload_treasures {
2581	load_resource_file "$DATADIR/treasures"	2960	load_resource_file "$DATADIR/treasures"
2582	or die "unable to load treasurelists\n";	2961	or die "unable to load treasurelists\n";
…		…
2585	sub reload_resources {	2964	sub reload_resources {
2586	warn "reloading resource files...\n";	2965	warn "reloading resource files...\n";
2587		2966
2588	reload_regions;	2967	reload_regions;
2589	reload_facedata;	2968	reload_facedata;
		2969	#reload_archetypes;#d#
2590	reload_archetypes;	2970	reload_archetypes;
2591	reload_treasures;	2971	reload_treasures;
2592		2972
2593	warn "finished reloading resource files\n";	2973	warn "finished reloading resource files\n";
2594	}	2974	}
…		…
2651	},	3031	},
2652	);	3032	);
2653	}	3033	}
2654	}	3034	}
2655		3035
		3036	sub write_runtime {
		3037	my $runtime = "$LOCALDIR/runtime";
		3038
		3039	# first touch the runtime file to show we are still running:
		3040	# the fsync below can take a very very long time.
		3041
		3042	IO::AIO::aio_utime $runtime, undef, undef;
		3043
		3044	my $guard = cf::lock_acquire "write_runtime";
		3045
		3046	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3047	or return;
		3048
		3049	my $value = $cf::RUNTIME + 90 + 10;
		3050	# 10 is the runtime save interval, for a monotonic clock
		3051	# 60 allows for the watchdog to kill the server.
		3052
		3053	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3054	and return;
		3055
		3056	# always fsync - this file is important
		3057	aio_fsync $fh
		3058	and return;
		3059
		3060	# touch it again to show we are up-to-date
		3061	aio_utime $fh, undef, undef;
		3062
		3063	close $fh
		3064	or return;
		3065
		3066	aio_rename "$runtime~", $runtime
		3067	and return;
		3068
		3069	warn "runtime file written.\n";
		3070
		3071	1
		3072	}
		3073
2656	sub emergency_save() {	3074	sub emergency_save() {
2657	my $freeze_guard = cf::freeze_mainloop;	3075	my $freeze_guard = cf::freeze_mainloop;
2658		3076
2659	warn "enter emergency perl save\n";	3077	warn "enter emergency perl save\n";
2660		3078
…		…
2735	%EXT_CORO = ();	3153	%EXT_CORO = ();
2736		3154
2737	warn "removing commands";	3155	warn "removing commands";
2738	%COMMAND = ();	3156	%COMMAND = ();
2739		3157
2740	warn "removing ext commands";	3158	warn "removing ext/exti commands";
2741	%EXTCMD = ();	3159	%EXTCMD = ();
		3160	%EXTICMD = ();
2742		3161
2743	warn "unloading/nuking all extensions";	3162	warn "unloading/nuking all extensions";
2744	for my $pkg (@EXTS) {	3163	for my $pkg (@EXTS) {
2745	warn "... unloading $pkg";	3164	warn "... unloading $pkg";
2746		3165

Diff Legend

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