ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.271 by root, Fri Jun 1 06:04:08 2007 UTC vs.
Revision 1.331 by root, Mon Aug 13 13:10:01 2007 UTC

…		…
20	use Coro::Signal;	20	use Coro::Signal;
21	use Coro::Semaphore;	21	use Coro::Semaphore;
22	use Coro::AIO;	22	use Coro::AIO;
23	use Coro::Storable;	23	use Coro::Storable;
24		24
		25	use JSON::XS 1.4 ();
25	use BDB ();	26	use BDB ();
26	use Data::Dumper;	27	use Data::Dumper;
27	use Digest::MD5;	28	use Digest::MD5;
28	use Fcntl;	29	use Fcntl;
29	use YAML::Syck ();	30	use YAML::Syck ();
30	use IO::AIO 2.32 ();	31	use IO::AIO 2.32 ();
31	use Time::HiRes;	32	use Time::HiRes;
32	use Compress::LZF;	33	use Compress::LZF;
		34	use Digest::MD5 ();
33		35
34	# configure various modules to our taste	36	# configure various modules to our taste
35	#	37	#
36	$Storable::canonical = 1; # reduce rsync transfers	38	$Storable::canonical = 1; # reduce rsync transfers
37	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator	39	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
…		…
49	our %COMMAND = ();	51	our %COMMAND = ();
50	our %COMMAND_TIME = ();	52	our %COMMAND_TIME = ();
51		53
52	our @EXTS = (); # list of extension package names	54	our @EXTS = (); # list of extension package names
53	our %EXTCMD = ();	55	our %EXTCMD = ();
		56	our %EXTICMD = ();
54	our %EXT_CORO = (); # coroutines bound to extensions	57	our %EXT_CORO = (); # coroutines bound to extensions
55	our %EXT_MAP = (); # pluggable maps	58	our %EXT_MAP = (); # pluggable maps
56		59
57	our $RELOAD; # number of reloads so far	60	our $RELOAD; # number of reloads so far
58	our @EVENT;	61	our @EVENT;
…		…
164		167
165	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only	168	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
166	returns directly I<after> the tick processing (and consequently, can only wake one process	169	returns directly I<after> the tick processing (and consequently, can only wake one process
167	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.	170	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
168		171
		172	=item @cf::INVOKE_RESULTS
		173
		174	This array contains the results of the last C<invoke ()> call. When
		175	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		176	that call.
		177
169	=back	178	=back
170		179
171	=cut	180	=cut
172		181
173	BEGIN {	182	BEGIN {
…		…
187	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	196	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
188	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	197	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
189	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	198	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
190	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	199	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
191	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	200	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		201	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
192	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	202	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
193		203
194	# we bless all objects into (empty) derived classes to force a method lookup	204	# we bless all objects into (empty) derived classes to force a method lookup
195	# within the Safe compartment.	205	# within the Safe compartment.
196	for my $pkg (qw(	206	for my $pkg (qw(
197	cf::global cf::attachable	207	cf::global cf::attachable
…		…
205	}	215	}
206		216
207	$Event::DIED = sub {	217	$Event::DIED = sub {
208	warn "error in event callback: @_";	218	warn "error in event callback: @_";
209	};	219	};
		220
		221	#############################################################################
210		222
211	=head2 UTILITY FUNCTIONS	223	=head2 UTILITY FUNCTIONS
212		224
213	=over 4	225	=over 4
214		226
…		…
233	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	245	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
234	$d	246	$d
235	} || "[unable to dump $_[0]: '$@']";	247	} || "[unable to dump $_[0]: '$@']";
236	}	248	}
237		249
238	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
239
240	=item $ref = cf::from_json $json	250	=item $ref = cf::from_json $json
241		251
242	Converts a JSON string into the corresponding perl data structure.	252	Converts a JSON string into the corresponding perl data structure.
243		253
244	=item $json = cf::to_json $ref	254	=item $json = cf::to_json $ref
245		255
246	Converts a perl data structure into its JSON representation.	256	Converts a perl data structure into its JSON representation.
		257
		258	=cut
		259
		260	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
		261
		262	sub to_json ($) { $json_coder->encode ($_[0]) }
		263	sub from_json ($) { $json_coder->decode ($_[0]) }
247		264
248	=item cf::lock_wait $string	265	=item cf::lock_wait $string
249		266
250	Wait until the given lock is available. See cf::lock_acquire.	267	Wait until the given lock is available. See cf::lock_acquire.
251		268
…		…
305	};	322	};
306	$TICK_WATCHER->stop;	323	$TICK_WATCHER->stop;
307	$guard	324	$guard
308	}	325	}
309		326
		327	=item cf::get_slot $time[, $priority[, $name]]
		328
		329	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		330	This call blocks and returns only when you have at least C<$time> seconds
		331	of cpu time till the next tick. The slot is only valid till the next cede.
		332
		333	The optional C<$name> can be used to identify the job to run. It might be
		334	used for statistical purposes and should identify the same time-class.
		335
		336	Useful for short background jobs.
		337
		338	=cut
		339
		340	our @SLOT_QUEUE;
		341	our $SLOT_QUEUE;
		342
		343	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		344	$SLOT_QUEUE = Coro::async {
		345	my $signal = new Coro::Signal;
		346
		347	while () {
		348	next_job:
		349	my $avail = cf::till_tick;
		350	if ($avail > 0.01) {
		351	for (0 .. $#SLOT_QUEUE) {
		352	if ($SLOT_QUEUE[$_][0] < $avail) {
		353	my $job = splice @SLOT_QUEUE, $_, 1, ();
		354	$job->[2]->send;
		355	Coro::cede;
		356	goto next_job;
		357	}
		358	}
		359	}
		360
		361	if (@SLOT_QUEUE) {
		362	# we do not use wait_For_tick() as it returns immediately when tick is inactive
		363	push @cf::WAIT_FOR_TICK, $signal;
		364	$signal->wait;
		365	} else {
		366	Coro::schedule;
		367	}
		368	}
		369	};
		370
		371	sub get_slot($;$$) {
		372	my ($time, $pri, $name) = @_;
		373
		374	$time = $TICK * .6 if $time > $TICK * .6;
		375	my $sig = new Coro::Signal;
		376
		377	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		378	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		379	$SLOT_QUEUE->ready;
		380	$sig->wait;
		381	}
		382
310	=item cf::async { BLOCK }	383	=item cf::async { BLOCK }
311		384
312	Currently the same as Coro::async_pool, meaning you cannot use	385	Currently the same as Coro::async_pool, meaning you cannot use
313	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only	386	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
314	thing you are allowed to do is call C<prio> on it.	387	thing you are allowed to do is call C<prio> on it.
…		…
317		390
318	BEGIN { *async = \&Coro::async_pool }	391	BEGIN { *async = \&Coro::async_pool }
319		392
320	=item cf::sync_job { BLOCK }	393	=item cf::sync_job { BLOCK }
321		394
322	The design of crossfire+ requires that the main coro ($Coro::main) is	395	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
323	always able to handle events or runnable, as crossfire+ is only partly	396	is always able to handle events or runnable, as Crossfire TRT is only
324	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	397	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		398	acceptable.
325		399
326	If it must be done, put the blocking parts into C<sync_job>. This will run	400	If it must be done, put the blocking parts into C<sync_job>. This will run
327	the given BLOCK in another coroutine while waiting for the result. The	401	the given BLOCK in another coroutine while waiting for the result. The
328	server will be frozen during this time, so the block should either finish	402	server will be frozen during this time, so the block should either finish
329	fast or be very important.	403	fast or be very important.
…		…
389	$EXT_CORO{$coro+0} = $coro;	463	$EXT_CORO{$coro+0} = $coro;
390		464
391	$coro	465	$coro
392	}	466	}
393		467
394	sub write_runtime {	468	=item fork_call { }, $args
395	my $runtime = "$LOCALDIR/runtime";
396		469
397	# first touch the runtime file to show we are still running:	470	Executes the given code block with the given arguments in a seperate
398	# the fsync below can take a very very long time.	471	process, returning the results. Everything must be serialisable with
		472	Coro::Storable. May, of course, block. Note that the executed sub may
		473	never block itself or use any form of Event handling.
399		474
400	IO::AIO::aio_utime $runtime, undef, undef;	475	=cut
401		476
402	my $guard = cf::lock_acquire "write_runtime";	477	sub _store_scalar {
403		478	open my $fh, ">", \my $buf
404	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	479	or die "fork_call: cannot open fh-to-buf in child : $!";
405	or return;	480	Storable::store_fd $_[0], $fh;
406
407	my $value = $cf::RUNTIME + 90 + 10;
408	# 10 is the runtime save interval, for a monotonic clock
409	# 60 allows for the watchdog to kill the server.
410
411	(aio_write $fh, 0, (length $value), $value, 0) <= 0
412	and return;
413
414	# always fsync - this file is important
415	aio_fsync $fh
416	and return;
417
418	# touch it again to show we are up-to-date
419	aio_utime $fh, undef, undef;
420
421	close $fh	481	close $fh;
422	or return;
423		482
424	aio_rename "$runtime~", $runtime	483	$buf
425	and return;	484	}
426		485
427	warn "runtime file written.\n";#d#	486	sub fork_call(&@) {
		487	my ($cb, @args) = @_;
428		488
		489	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
		490	# or die "socketpair: $!";
		491	pipe my $fh1, my $fh2
		492	or die "pipe: $!";
		493
		494	if (my $pid = fork) {
		495	close $fh2;
		496
		497	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
		498	warn "pst<$res>" unless $res =~ /^pst/;
		499	$res = Coro::Storable::thaw $res;
		500
		501	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		502
		503	Carp::confess $$res unless "ARRAY" eq ref $res;
		504
		505	return wantarray ? @$res : $res->[-1];
		506	} else {
		507	reset_signals;
		508	local $SIG{__WARN__};
		509	local $SIG{__DIE__};
		510	# just in case, this hack effectively disables event
		511	# in the child. cleaner and slower would be canceling all watchers,
		512	# but this works for the time being.
		513	local $Coro::idle;
		514	$Coro::current->prio (Coro::PRIO_MAX);
		515
		516	eval {
		517	close $fh1;
		518
		519	my @res = eval { $cb->(@args) };
		520
		521	syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
		522	close $fh2;
		523	};
		524
		525	warn $@ if $@;
		526	_exit 0;
429	1	527	}
		528	}
		529
		530	=item $value = cf::db_get $family => $key
		531
		532	Returns a single value from the environment database.
		533
		534	=item cf::db_put $family => $key => $value
		535
		536	Stores the given C<$value> in the family. It can currently store binary
		537	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		538
		539	=cut
		540
		541	our $DB;
		542
		543	sub db_init {
		544	unless ($DB) {
		545	$DB = BDB::db_create $DB_ENV;
		546
		547	cf::sync_job {
		548	eval {
		549	$DB->set_flags (BDB::CHKSUM);
		550
		551	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		552	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		553	cf::cleanup "db_open(db): $!" if $!;
		554	};
		555	cf::cleanup "db_open(db): $@" if $@;
		556	};
		557	}
		558	}
		559
		560	sub db_get($$) {
		561	my $key = "$_[0]/$_[1]";
		562
		563	cf::sync_job {
		564	BDB::db_get $DB, undef, $key, my $data;
		565
		566	$! ? ()
		567	: $data
		568	}
		569	}
		570
		571	sub db_put($$$) {
		572	BDB::dbreq_pri 4;
		573	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		574	}
		575
		576	=item cf::cache $id => [$paths...], $processversion => $process
		577
		578	Generic caching function that returns the value of the resource $id,
		579	caching and regenerating as required.
		580
		581	This function can block.
		582
		583	=cut
		584
		585	sub cache {
		586	my ($id, $src, $processversion, $process) = @_;
		587
		588	my $meta =
		589	join "\x00",
		590	$processversion,
		591	map {
		592	aio_stat $_
		593	and Carp::croak "$_: $!";
		594
		595	($_, (stat _)[7,9])
		596	} @$src;
		597
		598	my $dbmeta = db_get cache => "$id/meta";
		599	if ($dbmeta ne $meta) {
		600	# changed, we may need to process
		601
		602	my @data;
		603	my $md5;
		604
		605	for (0 .. $#$src) {
		606	0 <= aio_load $src->[$_], $data[$_]
		607	or Carp::croak "$src->[$_]: $!";
		608	}
		609
		610	# if processing is expensive, check
		611	# checksum first
		612	if (1) {
		613	$md5 =
		614	join "\x00",
		615	$processversion,
		616	map {
		617	Coro::cede;
		618	($src->[$_], Digest::MD5::md5_hex $data[$_])
		619	} 0.. $#$src;
		620
		621
		622	my $dbmd5 = db_get cache => "$id/md5";
		623	if ($dbmd5 eq $md5) {
		624	db_put cache => "$id/meta", $meta;
		625
		626	return db_get cache => "$id/data";
		627	}
		628	}
		629
		630	my $t1 = Time::HiRes::time;
		631	my $data = $process->(\@data);
		632	my $t2 = Time::HiRes::time;
		633
		634	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		635
		636	db_put cache => "$id/data", $data;
		637	db_put cache => "$id/md5" , $md5;
		638	db_put cache => "$id/meta", $meta;
		639
		640	return $data;
		641	}
		642
		643	db_get cache => "$id/data"
430	}	644	}
431		645
432	=item cf::datalog type => key => value, ...	646	=item cf::datalog type => key => value, ...
433		647
434	Log a datalog packet of the given type with the given key-value pairs.	648	Log a datalog packet of the given type with the given key-value pairs.
…		…
452	attach callbacks/event handlers (a collection of which is called an "attachment")	666	attach callbacks/event handlers (a collection of which is called an "attachment")
453	to it. All such attachable objects support the following methods.	667	to it. All such attachable objects support the following methods.
454		668
455	In the following description, CLASS can be any of C<global>, C<object>	669	In the following description, CLASS can be any of C<global>, C<object>
456	C<player>, C<client> or C<map> (i.e. the attachable objects in	670	C<player>, C<client> or C<map> (i.e. the attachable objects in
457	crossfire+).	671	Crossfire TRT).
458		672
459	=over 4	673	=over 4
460		674
461	=item $attachable->attach ($attachment, key => $value...)	675	=item $attachable->attach ($attachment, key => $value...)
462		676
…		…
664	_attach $registry, $klass, @attach;	878	_attach $registry, $klass, @attach;
665	}	879	}
666		880
667	$obj->{$name} = \%arg;	881	$obj->{$name} = \%arg;
668	} else {	882	} else {
669	warn "object uses attachment '$name' that is not available, postponing.\n";	883	warn "object uses attachment '$name' which is not available, postponing.\n";
670	}	884	}
671		885
672	$obj->{_attachment}{$name} = undef;	886	$obj->{_attachment}{$name} = undef;
673	}	887	}
674		888
…		…
714	";	928	";
715	die if $@;	929	die if $@;
716	}	930	}
717		931
718	our $override;	932	our $override;
719	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	933	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
720		934
721	sub override {	935	sub override {
722	$override = 1;	936	$override = 1;
723	@invoke_results = ();	937	@INVOKE_RESULTS = (@_);
724	}	938	}
725		939
726	sub do_invoke {	940	sub do_invoke {
727	my $event = shift;	941	my $event = shift;
728	my $callbacks = shift;	942	my $callbacks = shift;
729		943
730	@invoke_results = ();	944	@INVOKE_RESULTS = ();
731		945
732	local $override;	946	local $override;
733		947
734	for (@$callbacks) {	948	for (@$callbacks) {
735	eval { &{$_->[1]} };	949	eval { &{$_->[1]} };
…		…
752		966
753	Generate an object-specific event with the given arguments.	967	Generate an object-specific event with the given arguments.
754		968
755	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	969	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
756	removed in future versions), and there is no public API to access override	970	removed in future versions), and there is no public API to access override
757	results (if you must, access C<@cf::invoke_results> directly).	971	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
758		972
759	=back	973	=back
760		974
761	=cut	975	=cut
762		976
763	#############################################################################	977	#############################################################################
764	# object support	978	# object support
		979	#
		980
		981	sub _can_merge {
		982	my ($ob1, $ob2) = @_;
		983
		984	local $Storable::canonical = 1;
		985	my $fob1 = Storable::freeze $ob1;
		986	my $fob2 = Storable::freeze $ob2;
		987
		988	$fob1 eq $fob2
		989	}
765		990
766	sub reattach {	991	sub reattach {
767	# basically do the same as instantiate, without calling instantiate	992	# basically do the same as instantiate, without calling instantiate
768	my ($obj) = @_;	993	my ($obj) = @_;
769		994
…		…
872	or return;	1097	or return;
873	$av = eval { (Storable::thaw $av)->{objs} };	1098	$av = eval { (Storable::thaw $av)->{objs} };
874	}	1099	}
875		1100
876	warn sprintf "loading %s (%d)\n",	1101	warn sprintf "loading %s (%d)\n",
877	$filename, length $data, scalar @{$av || []};#d#	1102	$filename, length $data, scalar @{$av || []};
878	return ($data, $av);	1103	return ($data, $av);
879	}	1104	}
		1105
		1106	=head2 COMMAND CALLBACKS
		1107
		1108	=over 4
		1109
		1110	=cut
880		1111
881	#############################################################################	1112	#############################################################################
882	# command handling &c	1113	# command handling &c
883		1114
884	=item cf::register_command $name => \&callback($ob,$args);	1115	=item cf::register_command $name => \&callback($ob,$args);
…		…
897	push @{ $COMMAND{$name} }, [$caller, $cb];	1128	push @{ $COMMAND{$name} }, [$caller, $cb];
898	}	1129	}
899		1130
900	=item cf::register_extcmd $name => \&callback($pl,$packet);	1131	=item cf::register_extcmd $name => \&callback($pl,$packet);
901		1132
902	Register a callbackf ro execution when the client sends an extcmd packet.	1133	Register a callback for execution when the client sends an (synchronous)
		1134	extcmd packet. Ext commands will be processed in the order they are
		1135	received by the server, like other user commands. The first argument is
		1136	the logged-in player. Ext commands can only be processed after a player
		1137	has logged in successfully.
903		1138
904	If the callback returns something, it is sent back as if reply was being	1139	If the callback returns something, it is sent back as if reply was being
905	called.	1140	called.
906		1141
		1142	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1143
		1144	Register a callback for execution when the client sends an (asynchronous)
		1145	exticmd packet. Exti commands are processed by the server as soon as they
		1146	are received, i.e. out of order w.r.t. other commands. The first argument
		1147	is a client socket. Exti commands can be received anytime, even before
		1148	log-in.
		1149
		1150	If the callback returns something, it is sent back as if reply was being
		1151	called.
		1152
907	=cut	1153	=cut
908		1154
909	sub register_extcmd {	1155	sub register_extcmd {
910	my ($name, $cb) = @_;	1156	my ($name, $cb) = @_;
911		1157
912	$EXTCMD{$name} = $cb;	1158	$EXTCMD{$name} = $cb;
		1159	}
		1160
		1161	sub register_exticmd {
		1162	my ($name, $cb) = @_;
		1163
		1164	$EXTICMD{$name} = $cb;
913	}	1165	}
914		1166
915	cf::player->attach (	1167	cf::player->attach (
916	on_command => sub {	1168	on_command => sub {
917	my ($pl, $name, $params) = @_;	1169	my ($pl, $name, $params) = @_;
…		…
926	cf::override;	1178	cf::override;
927	},	1179	},
928	on_extcmd => sub {	1180	on_extcmd => sub {
929	my ($pl, $buf) = @_;	1181	my ($pl, $buf) = @_;
930		1182
931	my $msg = eval { from_json $buf };	1183	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
932		1184
933	if (ref $msg) {	1185	if (ref $msg) {
		1186	my ($type, $reply, @payload) =
		1187	"ARRAY" eq ref $msg
		1188	? @$msg
		1189	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1190
934	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1191	if (my $cb = $EXTCMD{$type}) {
935	if (my %reply = $cb->($pl, $msg)) {	1192	my @reply = $cb->($pl, @payload);
		1193
936	$pl->ext_reply ($msg->{msgid}, %reply);	1194	$pl->ext_reply ($reply, @reply)
937	}	1195	if $reply;
938	}	1196	}
939	} else {	1197	} else {
940	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1198	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
941	}	1199	}
942		1200
943	cf::override;	1201	cf::override;
944	},	1202	},
945	);	1203	);
946		1204
947	sub load_extension {
948	my ($path) = @_;
949
950	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
951	my $base = $1;
952	my $pkg = $1;
953	$pkg =~ s/[^[:word:]]/_/g;
954	$pkg = "ext::$pkg";
955
956	warn "... loading '$path' into '$pkg'\n";
957
958	open my $fh, "<:utf8", $path
959	or die "$path: $!";
960
961	my $source =
962	"package $pkg; use strict; use utf8;\n"
963	. "#line 1 \"$path\"\n{\n"
964	. (do { local $/; <$fh> })
965	. "\n};\n1";
966
967	unless (eval $source) {
968	my $msg = $@ ? "$path: $@\n"
969	: "extension disabled.\n";
970	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
971	warn $@;
972	warn "mandatory extension failed to load, exiting.\n";
973	exit 1;
974	}
975	die $@;
976	}
977
978	push @EXTS, $pkg;
979	}
980
981	sub load_extensions {	1205	sub load_extensions {
		1206	cf::sync_job {
		1207	my %todo;
		1208
982	for my $ext (<$LIBDIR/*.ext>) {	1209	for my $path (<$LIBDIR/*.ext>) {
983	next unless -r $ext;	1210	next unless -r $path;
984	eval {	1211
985	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;
986	1	1269	}
987	} or warn "$ext not loaded: $@";	1270
		1271	skip:
		1272	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1273	unless $progress;
		1274	}
988	}	1275	};
989	}	1276	}
990		1277
991	#############################################################################	1278	#############################################################################
		1279
		1280	=back
992		1281
993	=head2 CORE EXTENSIONS	1282	=head2 CORE EXTENSIONS
994		1283
995	Functions and methods that extend core crossfire objects.	1284	Functions and methods that extend core crossfire objects.
996		1285
…		…
1083	$cf::PLAYER{$login} = $self;	1372	$cf::PLAYER{$login} = $self;
1084		1373
1085	$self	1374	$self
1086	}	1375	}
1087		1376
		1377	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1378
		1379	=cut
		1380
		1381	sub send_msg {
		1382	my $ns = shift->ns
		1383	or return;
		1384	$ns->send_msg (@_);
		1385	}
		1386
1088	=item $pl->quit_character	1387	=item $pl->quit_character
1089		1388
1090	Nukes the player without looking back. If logged in, the connection will	1389	Nukes the player without looking back. If logged in, the connection will
1091	be destroyed. May block for a long time.	1390	be destroyed. May block for a long time.
1092		1391
…		…
1184	}	1483	}
1185		1484
1186	\@paths	1485	\@paths
1187	}	1486	}
1188		1487
		1488	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1489
		1490	Expand crossfire pod fragments into protocol xml.
		1491
		1492	=cut
		1493
		1494	sub expand_cfpod {
		1495	((my $self), (local $_)) = @_;
		1496
		1497	# escape & and <
		1498	s/&/&amp;/g;
		1499	s/(?<![BIUGH])</&lt;/g;
		1500
		1501	# this is buggy, it needs to properly take care of nested <'s
		1502
		1503	1 while
		1504	# replace B<>, I<>, U<> etc.
		1505	s/B<([^\>]*)>/<b>$1<\/b>/
		1506	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1507	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1508	# replace G<male|female> tags
		1509	|| s{G<([^>|]*)\|([^>]*)>}{
		1510	$self->gender ? $2 : $1
		1511	}ge
		1512	# replace H<hint text>
		1513	|| s{H<([^\>]*)>}
		1514	{
		1515	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1516	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1517	"")
		1518	[$self->{hintmode}]
		1519	}ge;
		1520
		1521	# create single paragraphs (very hackish)
		1522	s/(?<=\S)\n(?=\w)/ /g;
		1523
		1524	# compress some whitespace
		1525	s/\s+\n/\n/g; # ws line-ends
		1526	s/\n\n+/\n/g; # double lines
		1527	s/^\n+//; # beginning lines
		1528	s/\n+$//; # ending lines
		1529
		1530	$_
		1531	}
		1532
		1533	sub hintmode {
		1534	$_[0]{hintmode} = $_[1] if @_ > 1;
		1535	$_[0]{hintmode}
		1536	}
		1537
1189	=item $player->ext_reply ($msgid, %msg)	1538	=item $player->ext_reply ($msgid, @msg)
1190		1539
1191	Sends an ext reply to the player.	1540	Sends an ext reply to the player.
1192		1541
1193	=cut	1542	=cut
1194		1543
1195	sub ext_reply($$%) {	1544	sub ext_reply($$@) {
1196	my ($self, $id, %msg) = @_;	1545	my ($self, $id, @msg) = @_;
1197		1546
1198	$msg{msgid} = $id;	1547	if ($self->ns->extcmd == 2) {
1199		1548	$self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1200	$self->send ("ext " . cf::to_json \%msg);	1549	} elsif ($self->ns->extcmd == 1) {
		1550	#TODO: version 1, remove
		1551	unshift @msg, msgtype => "reply", msgid => $id;
		1552	$self->send ("ext " . $self->ns->{json_coder}->encode ({@msg}));
		1553	}
1201	}	1554	}
1202		1555
1203	=item $player->ext_event ($type, %msg)	1556	=item $player->ext_msg ($type, @msg)
1204		1557
1205	Sends an ext event to the client.	1558	Sends an ext event to the client.
1206		1559
1207	=cut	1560	=cut
1208		1561
1209	sub ext_event($$%) {	1562	sub ext_msg($$@) {
1210	my ($self, $type, %msg) = @_;	1563	my ($self, $type, @msg) = @_;
1211		1564
1212	$self->ns->ext_event ($type, %msg);	1565	$self->ns->ext_msg ($type, @msg);
1213	}	1566	}
1214		1567
1215	=head3 cf::region	1568	=head3 cf::region
1216		1569
1217	=over 4	1570	=over 4
…		…
1220		1573
1221	package cf::region;	1574	package cf::region;
1222		1575
1223	=item cf::region::find_by_path $path	1576	=item cf::region::find_by_path $path
1224		1577
1225	Tries to decuce the probable region for a map knowing only its path.	1578	Tries to decuce the likely region for a map knowing only its path.
1226		1579
1227	=cut	1580	=cut
1228		1581
1229	sub find_by_path($) {	1582	sub find_by_path($) {
1230	my ($path) = @_;	1583	my ($path) = @_;
1231		1584
1232	my ($match, $specificity);	1585	my ($match, $specificity);
1233		1586
1234	for my $region (list) {	1587	for my $region (list) {
1235	if ($region->match && $path =~ $region->match) {	1588	if ($region->{match} && $path =~ $region->{match}) {
1236	($match, $specificity) = ($region, $region->specificity)	1589	($match, $specificity) = ($region, $region->specificity)
1237	if $region->specificity > $specificity;	1590	if $region->specificity > $specificity;
1238	}	1591	}
1239	}	1592	}
1240		1593
…		…
1304	my ($self, $merge) = @_;	1657	my ($self, $merge) = @_;
1305		1658
1306	# we have to keep some variables in memory intact	1659	# we have to keep some variables in memory intact
1307	local $self->{path};	1660	local $self->{path};
1308	local $self->{load_path};	1661	local $self->{load_path};
1309	local $self->{deny_save};
1310	local $self->{deny_reset};
1311		1662
1312	$self->SUPER::thawer_merge ($merge);	1663	$self->SUPER::thawer_merge ($merge);
1313	}	1664	}
1314		1665
1315	sub normalise {	1666	sub normalise {
…		…
1362	$self->init; # pass $1 etc.	1713	$self->init; # pass $1 etc.
1363	return $self;	1714	return $self;
1364	}	1715	}
1365	}	1716	}
1366		1717
1367	Carp::carp "unable to resolve path '$path' (base '$base').";	1718	Carp::cluck "unable to resolve path '$path' (base '$base').";
1368	()	1719	()
1369	}	1720	}
1370		1721
1371	sub init {	1722	sub init {
1372	my ($self) = @_;	1723	my ($self) = @_;
…		…
1413	sub change_all_map_light {	1764	sub change_all_map_light {
1414	my ($change) = @_;	1765	my ($change) = @_;
1415		1766
1416	$_->change_map_light ($change)	1767	$_->change_map_light ($change)
1417	for grep $_->outdoor, values %cf::MAP;	1768	for grep $_->outdoor, values %cf::MAP;
		1769	}
		1770
		1771	sub decay_objects {
		1772	my ($self) = @_;
		1773
		1774	return if $self->{deny_reset};
		1775
		1776	$self->do_decay_objects;
1418	}	1777	}
1419		1778
1420	sub unlink_save {	1779	sub unlink_save {
1421	my ($self) = @_;	1780	my ($self) = @_;
1422		1781
…		…
1480	$self->load_header_orig	1839	$self->load_header_orig
1481	or return;	1840	or return;
1482	$self->prepare_orig;	1841	$self->prepare_orig;
1483	}	1842	}
1484		1843
		1844	$self->{deny_reset} = 1
		1845	if $self->no_reset;
		1846
1485	$self->default_region (cf::region::find_by_path $self->{path})	1847	$self->default_region (cf::region::find_by_path $self->{path})
1486	unless $self->default_region;	1848	unless $self->default_region;
1487		1849
1488	1	1850	1
1489	}	1851	}
…		…
1504	$map->{last_save} = $cf::RUNTIME;	1866	$map->{last_save} = $cf::RUNTIME;
1505		1867
1506	$map->load_header	1868	$map->load_header
1507	or return;	1869	or return;
1508		1870
1509	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1871	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1510	# doing this can freeze the server in a sync job, obviously	1872	# doing this can freeze the server in a sync job, obviously
1511	#$cf::WAIT_FOR_TICK->wait;	1873	#$cf::WAIT_FOR_TICK->wait;
1512	$map->reset;	1874	$map->reset;
1513	undef $guard;	1875	undef $guard;
1514	return find $path;	1876	return find $path;
…		…
1569	$self->set_darkness_map;	1931	$self->set_darkness_map;
1570	Coro::cede;	1932	Coro::cede;
1571	$self->activate;	1933	$self->activate;
1572	}	1934	}
1573		1935
		1936	$self->{last_save} = $cf::RUNTIME;
		1937	$self->last_access ($cf::RUNTIME);
		1938
1574	$self->in_memory (cf::MAP_IN_MEMORY);	1939	$self->in_memory (cf::MAP_IN_MEMORY);
1575	}	1940	}
1576		1941
1577	$self->post_load;	1942	$self->post_load;
1578	}	1943	}
…		…
1580	sub customise_for {	1945	sub customise_for {
1581	my ($self, $ob) = @_;	1946	my ($self, $ob) = @_;
1582		1947
1583	return find "~" . $ob->name . "/" . $self->{path}	1948	return find "~" . $ob->name . "/" . $self->{path}
1584	if $self->per_player;	1949	if $self->per_player;
		1950
		1951	# return find "?party/" . $ob->name . "/" . $self->{path}
		1952	# if $self->per_party;
1585		1953
1586	$self	1954	$self
1587	}	1955	}
1588		1956
1589	# find and load all maps in the 3x3 area around a map	1957	# find and load all maps in the 3x3 area around a map
…		…
1636		2004
1637	undef $MAP_PREFETCH{$path};	2005	undef $MAP_PREFETCH{$path};
1638	$MAP_PREFETCHER ||= cf::async {	2006	$MAP_PREFETCHER ||= cf::async {
1639	while (%MAP_PREFETCH) {	2007	while (%MAP_PREFETCH) {
1640	for my $path (keys %MAP_PREFETCH) {	2008	for my $path (keys %MAP_PREFETCH) {
1641	my $map = find $path	2009	if (my $map = find $path) {
1642	or next;
1643	$map->load;	2010	$map->load;
		2011	}
1644		2012
1645	delete $MAP_PREFETCH{$path};	2013	delete $MAP_PREFETCH{$path};
1646	}	2014	}
1647	}	2015	}
1648	undef $MAP_PREFETCHER;	2016	undef $MAP_PREFETCHER;
…		…
1700		2068
1701	sub reset_at {	2069	sub reset_at {
1702	my ($self) = @_;	2070	my ($self) = @_;
1703		2071
1704	# TODO: safety, remove and allow resettable per-player maps	2072	# TODO: safety, remove and allow resettable per-player maps
1705	return 1e99 if $self->isa ("ext::map_per_player");#d#
1706	return 1e99 if $self->{deny_reset};	2073	return 1e99 if $self->{deny_reset};
1707		2074
1708	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2075	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1709	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2076	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1710		2077
…		…
1721	my ($self) = @_;	2088	my ($self) = @_;
1722		2089
1723	my $lock = cf::lock_acquire "map_data:$self->{path}";	2090	my $lock = cf::lock_acquire "map_data:$self->{path}";
1724		2091
1725	return if $self->players;	2092	return if $self->players;
1726	return if $self->isa ("ext::map_per_player");#d#
1727		2093
1728	warn "resetting map ", $self->path;#d#	2094	warn "resetting map ", $self->path;
1729		2095
1730	$self->in_memory (cf::MAP_SWAPPED);	2096	$self->in_memory (cf::MAP_SWAPPED);
1731		2097
1732	# need to save uniques path	2098	# need to save uniques path
1733	unless ($self->{deny_save}) {	2099	unless ($self->{deny_save}) {
…		…
1765	$cf::MAP{$self->path} = $self;	2131	$cf::MAP{$self->path} = $self;
1766		2132
1767	$self->reset; # polite request, might not happen	2133	$self->reset; # polite request, might not happen
1768	}	2134	}
1769		2135
		2136	=item $maps = cf::map::tmp_maps
		2137
		2138	Returns an arrayref with all map paths of currently instantiated and saved
		2139	maps. May block.
		2140
		2141	=cut
		2142
		2143	sub tmp_maps() {
		2144	[
		2145	map {
		2146	utf8::decode $_;
		2147	/\.map$/
		2148	? normalise $_
		2149	: ()
		2150	} @{ aio_readdir $TMPDIR or [] }
		2151	]
		2152	}
		2153
		2154	=item $maps = cf::map::random_maps
		2155
		2156	Returns an arrayref with all map paths of currently instantiated and saved
		2157	random maps. May block.
		2158
		2159	=cut
		2160
		2161	sub random_maps() {
		2162	[
		2163	map {
		2164	utf8::decode $_;
		2165	/\.map$/
		2166	? normalise "?random/$_"
		2167	: ()
		2168	} @{ aio_readdir $RANDOMDIR or [] }
		2169	]
		2170	}
		2171
1770	=item cf::map::unique_maps	2172	=item cf::map::unique_maps
1771		2173
1772	Returns an arrayref of paths of all shared maps that have	2174	Returns an arrayref of paths of all shared maps that have
1773	instantiated unique items. May block.	2175	instantiated unique items. May block.
1774		2176
1775	=cut	2177	=cut
1776		2178
1777	sub unique_maps() {	2179	sub unique_maps() {
1778	my $files = aio_readdir $UNIQUEDIR	2180	[
1779	or return;	2181	map {
1780
1781	my @paths;
1782
1783	for (@$files) {
1784	utf8::decode $_;	2182	utf8::decode $_;
1785	next if /\.pst$/;	2183	/\.map$/
1786	next unless /^$PATH_SEP/o;	2184	? normalise $_
1787		2185	: ()
1788	push @paths, cf::map::normalise $_;	2186	} @{ aio_readdir $UNIQUEDIR or [] }
1789	}	2187	]
1790
1791	\@paths
1792	}	2188	}
1793		2189
1794	package cf;	2190	package cf;
1795		2191
1796	=back	2192	=back
…		…
1842		2238
1843	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2239	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1844		2240
1845	if ($self->{record_replies}) {	2241	if ($self->{record_replies}) {
1846	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2242	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2243
1847	} else {	2244	} else {
		2245	my $pl = $self->contr;
		2246
		2247	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2248	my $dialog = $pl->{npc_dialog};
		2249	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2250
		2251	} else {
1848	$msg = $npc->name . " says: $msg" if $npc;	2252	$msg = $npc->name . " says: $msg" if $npc;
1849	$self->message ($msg, $flags);	2253	$self->message ($msg, $flags);
		2254	}
1850	}	2255	}
		2256	}
		2257
		2258	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2259
		2260	=cut
		2261
		2262	sub cf::object::send_msg {
		2263	my $pl = shift->contr
		2264	or return;
		2265	$pl->send_msg (@_);
1851	}	2266	}
1852		2267
1853	=item $player_object->may ("access")	2268	=item $player_object->may ("access")
1854		2269
1855	Returns wether the given player is authorized to access resource "access"	2270	Returns wether the given player is authorized to access resource "access"
…		…
1943		2358
1944	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2359	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1945	$self->enter_map ($map, $x, $y);	2360	$self->enter_map ($map, $x, $y);
1946	}	2361	}
1947		2362
1948	=item $player_object->goto ($path, $x, $y[, $check->($map)])	2363	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1949		2364
1950	Moves the player to the given map-path and coordinates by first freezing	2365	Moves the player to the given map-path and coordinates by first freezing
1951	her, loading and preparing them map, calling the provided $check callback	2366	her, loading and preparing them map, calling the provided $check callback
1952	that has to return the map if sucecssful, and then unfreezes the player on	2367	that has to return the map if sucecssful, and then unfreezes the player on
1953	the new (success) or old (failed) map position.	2368	the new (success) or old (failed) map position. In either case, $done will
		2369	be called at the end of this process.
1954		2370
1955	=cut	2371	=cut
1956		2372
1957	our $GOTOGEN;	2373	our $GOTOGEN;
1958		2374
1959	sub cf::object::player::goto {	2375	sub cf::object::player::goto {
1960	my ($self, $path, $x, $y, $check) = @_;	2376	my ($self, $path, $x, $y, $check, $done) = @_;
1961		2377
1962	# do generation counting so two concurrent goto's will be executed in-order	2378	# do generation counting so two concurrent goto's will be executed in-order
1963	my $gen = $self->{_goto_generation} = ++$GOTOGEN;	2379	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1964		2380
1965	$self->enter_link;	2381	$self->enter_link;
…		…
1985		2401
1986	if ($gen == $self->{_goto_generation}) {	2402	if ($gen == $self->{_goto_generation}) {
1987	delete $self->{_goto_generation};	2403	delete $self->{_goto_generation};
1988	$self->leave_link ($map, $x, $y);	2404	$self->leave_link ($map, $x, $y);
1989	}	2405	}
		2406
		2407	$done->() if $done;
1990	})->prio (1);	2408	})->prio (1);
1991	}	2409	}
1992		2410
1993	=item $player_object->enter_exit ($exit_object)	2411	=item $player_object->enter_exit ($exit_object)
1994		2412
…		…
2063	my $hp = $exit->stats->hp;	2481	my $hp = $exit->stats->hp;
2064	my $sp = $exit->stats->sp;	2482	my $sp = $exit->stats->sp;
2065		2483
2066	$self->enter_link;	2484	$self->enter_link;
2067		2485
		2486	# if exit is damned, update players death & WoR home-position
		2487	$self->contr->savebed ($slaying, $hp, $sp)
		2488	if $exit->flag (FLAG_DAMNED);
		2489
2068	(async {	2490	(async {
2069	$self->deactivate_recursive; # just to be sure	2491	$self->deactivate_recursive; # just to be sure
2070	unless (eval {	2492	unless (eval {
2071	$self->goto ($slaying, $hp, $sp);	2493	$self->goto ($slaying, $hp, $sp);
2072		2494
…		…
2099		2521
2100	utf8::encode $text;	2522	utf8::encode $text;
2101	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2523	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2102	}	2524	}
2103		2525
		2526	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2527
		2528	Send a drawinfo or msg packet to the client, formatting the msg for the
		2529	client if neccessary. C<$type> should be a string identifying the type of
		2530	the message, with C<log> being the default. If C<$color> is negative, suppress
		2531	the message unless the client supports the msg packet.
		2532
		2533	=cut
		2534
		2535	sub cf::client::send_msg {
		2536	my ($self, $channel, $msg, $color, @extra) = @_;
		2537
		2538	$msg = $self->pl->expand_cfpod ($msg);
		2539
		2540	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2541
		2542	if (ref $channel) {
		2543	# send meta info to client, if not yet sent
		2544	unless (exists $self->{channel}{$channel->{id}}) {
		2545	$self->{channel}{$channel->{id}} = $channel;
		2546	$self->ext_msg (channel_info => $channel);
		2547	}
		2548
		2549	$channel = $channel->{id};
		2550	}
		2551
		2552	return unless @extra || length $msg;
		2553
		2554	if ($self->can_msg) {
		2555	# default colour, mask it out
		2556	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2557	if $color & cf::NDI_DEF;
		2558
		2559	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2560	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2561	} else {
		2562	if ($color >= 0) {
		2563	# replace some tags by gcfclient-compatible ones
		2564	for ($msg) {
		2565	1 while
		2566	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2567	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2568	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2569	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2570	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2571	}
		2572
		2573	$color &= cf::NDI_COLOR_MASK;
		2574
		2575	utf8::encode $msg;
		2576
		2577	if (0 && $msg =~ /\[/) {
		2578	# COMMAND/INFO
		2579	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2580	} else {
		2581	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2582	$self->send_packet ("drawinfo $color $msg")
		2583	}
		2584	}
		2585	}
		2586	}
		2587
2104	=item $client->ext_event ($type, %msg)	2588	=item $client->ext_msg ($type, @msg)
2105		2589
2106	Sends an exti event to the client.	2590	Sends an ext event to the client.
2107		2591
2108	=cut	2592	=cut
2109		2593
2110	sub cf::client::ext_event($$%) {	2594	sub cf::client::ext_msg($$@) {
2111	my ($self, $type, %msg) = @_;	2595	my ($self, $type, @msg) = @_;
2112		2596
		2597	my $extcmd = $self->extcmd;
		2598
		2599	if ($extcmd == 2) {
		2600	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2601	} elsif ($extcmd == 1) { # TODO: remove
2113	$msg{msgtype} = "event_$type";	2602	push @msg, msgtype => "event_$type";
2114	$self->send_packet ("ext " . cf::to_json \%msg);	2603	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2604	}
2115	}	2605	}
2116		2606
2117	=item $success = $client->query ($flags, "text", \&cb)	2607	=item $success = $client->query ($flags, "text", \&cb)
2118		2608
2119	Queues a query to the client, calling the given callback with	2609	Queues a query to the client, calling the given callback with
2120	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2610	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2121	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2611	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2122		2612
2123	Queries can fail, so check the return code. Or don't, as queries will become	2613	Queries can fail, so check the return code. Or don't, as queries will
2124	reliable at some point in the future.	2614	become reliable at some point in the future.
2125		2615
2126	=cut	2616	=cut
2127		2617
2128	sub cf::client::query {	2618	sub cf::client::query {
2129	my ($self, $flags, $text, $cb) = @_;	2619	my ($self, $flags, $text, $cb) = @_;
…		…
2137	utf8::encode $text;	2627	utf8::encode $text;
2138	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2628	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2139		2629
2140	$self->send_packet ($self->{query_queue}[0][0])	2630	$self->send_packet ($self->{query_queue}[0][0])
2141	if @{ $self->{query_queue} } == 1;	2631	if @{ $self->{query_queue} } == 1;
		2632
		2633	1
2142	}	2634	}
2143		2635
2144	cf::client->attach (	2636	cf::client->attach (
		2637	on_connect => sub {
		2638	my ($ns) = @_;
		2639
		2640	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2641	},
2145	on_reply => sub {	2642	on_reply => sub {
2146	my ($ns, $msg) = @_;	2643	my ($ns, $msg) = @_;
2147		2644
2148	# this weird shuffling is so that direct followup queries	2645	# this weird shuffling is so that direct followup queries
2149	# get handled first	2646	# get handled first
…		…
2161	} else {	2658	} else {
2162	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2659	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2163	}	2660	}
2164	}	2661	}
2165	},	2662	},
		2663	on_exticmd => sub {
		2664	my ($ns, $buf) = @_;
		2665
		2666	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2667
		2668	if (ref $msg) {
		2669	my ($type, $reply, @payload) =
		2670	"ARRAY" eq ref $msg
		2671	? @$msg
		2672	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2673
		2674	if (my $cb = $EXTICMD{$type}) {
		2675	my @reply = $cb->($ns, @payload);
		2676
		2677	$ns->ext_reply ($reply, @reply)
		2678	if $reply;
		2679	}
		2680	} else {
		2681	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2682	}
		2683
		2684	cf::override;
		2685	},
2166	);	2686	);
2167		2687
2168	=item $client->async (\&cb)	2688	=item $client->async (\&cb)
2169		2689
2170	Create a new coroutine, running the specified callback. The coroutine will	2690	Create a new coroutine, running the specified callback. The coroutine will
…		…
2211	our $safe = new Safe "safe";	2731	our $safe = new Safe "safe";
2212	our $safe_hole = new Safe::Hole;	2732	our $safe_hole = new Safe::Hole;
2213		2733
2214	$SIG{FPE} = 'IGNORE';	2734	$SIG{FPE} = 'IGNORE';
2215		2735
2216	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2736	$safe->permit_only (Opcode::opset qw(
		2737	:base_core :base_mem :base_orig :base_math
		2738	grepstart grepwhile mapstart mapwhile
		2739	sort time
		2740	));
2217		2741
2218	# here we export the classes and methods available to script code	2742	# here we export the classes and methods available to script code
2219		2743
2220	=pod	2744	=pod
2221		2745
2222	The following functions and methods are available within a safe environment:	2746	The following functions and methods are available within a safe environment:
2223		2747
2224	cf::object contr pay_amount pay_player map	2748	cf::object
		2749	contr pay_amount pay_player map x y force_find force_add
		2750	insert remove name archname title slaying race
		2751
2225	cf::object::player player	2752	cf::object::player
2226	cf::player peaceful	2753	player
2227	cf::map trigger	2754
		2755	cf::player
		2756	peaceful
		2757
		2758	cf::map
		2759	trigger
2228		2760
2229	=cut	2761	=cut
2230		2762
2231	for (	2763	for (
2232	["cf::object" => qw(contr pay_amount pay_player map)],	2764	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2765	insert remove inv name archname title slaying race)],
2233	["cf::object::player" => qw(player)],	2766	["cf::object::player" => qw(player)],
2234	["cf::player" => qw(peaceful)],	2767	["cf::player" => qw(peaceful)],
2235	["cf::map" => qw(trigger)],	2768	["cf::map" => qw(trigger)],
2236	) {	2769	) {
2237	no strict 'refs';	2770	no strict 'refs';
…		…
2308	=back	2841	=back
2309		2842
2310	=cut	2843	=cut
2311		2844
2312	#############################################################################	2845	#############################################################################
2313
2314	=head2 EXTENSION DATABASE SUPPORT
2315
2316	Crossfire maintains a very simple database for extension use. It can
2317	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2318	convert to/from binary).
2319
2320	The parameter C<$family> should best start with the name of the extension
2321	using it, it should be unique.
2322
2323	=over 4
2324
2325	=item $value = cf::db_get $family => $key
2326
2327	Returns a single value from the database.
2328
2329	=item cf::db_put $family => $key => $value
2330
2331	Stores the given C<$value> in the family.
2332
2333	=cut
2334
2335	our $DB;
2336
2337	sub db_init {
2338	unless ($DB) {
2339	$DB = BDB::db_create $DB_ENV;
2340
2341	cf::sync_job {
2342	eval {
2343	$DB->set_flags (BDB::CHKSUM);
2344
2345	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2346	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2347	cf::cleanup "db_open(db): $!" if $!;
2348	};
2349	cf::cleanup "db_open(db): $@" if $@;
2350	};
2351	}
2352	}
2353
2354	sub db_get($$) {
2355	my $key = "$_[0]/$_[1]";
2356
2357	cf::sync_job {
2358	BDB::db_get $DB, undef, $key, my $data;
2359
2360	$! ? ()
2361	: $data
2362	}
2363	}
2364
2365	sub db_put($$$) {
2366	BDB::dbreq_pri 4;
2367	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2368	}
2369
2370	=item cf::cache $id => [$paths...], $processversion => $process
2371
2372	Generic caching function that returns the value of the resource $id,
2373	caching and regenerating as required.
2374
2375	This function can block.
2376
2377	=cut
2378
2379	sub cache {
2380	my ($id, $src, $processversion, $process) = @_;
2381
2382	my $meta =
2383	join "\x00",
2384	$processversion,
2385	map {
2386	aio_stat $_
2387	and Carp::croak "$_: $!";
2388
2389	($_, (stat _)[7,9])
2390	} @$src;
2391
2392	my $dbmeta = db_get cache => "$id/meta";
2393	if ($dbmeta ne $meta) {
2394	# changed, we may need to process
2395
2396	my @data;
2397	my $md5;
2398
2399	for (0 .. $#$src) {
2400	0 <= aio_load $src->[$_], $data[$_]
2401	or Carp::croak "$src->[$_]: $!";
2402	}
2403
2404	# if processing is expensive, check
2405	# checksum first
2406	if (1) {
2407	$md5 =
2408	join "\x00",
2409	$processversion,
2410	map {
2411	Coro::cede;
2412	($src->[$_], Digest::MD5::md5_hex $data[$_])
2413	} 0.. $#$src;
2414
2415
2416	my $dbmd5 = db_get cache => "$id/md5";
2417	if ($dbmd5 eq $md5) {
2418	db_put cache => "$id/meta", $meta;
2419
2420	return db_get cache => "$id/data";
2421	}
2422	}
2423
2424	my $t1 = Time::HiRes::time;
2425	my $data = $process->(\@data);
2426	my $t2 = Time::HiRes::time;
2427
2428	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2429
2430	db_put cache => "$id/data", $data;
2431	db_put cache => "$id/md5" , $md5;
2432	db_put cache => "$id/meta", $meta;
2433
2434	return $data;
2435	}
2436
2437	db_get cache => "$id/data"
2438	}
2439
2440	=item fork_call { }, $args
2441
2442	Executes the given code block with the given arguments in a seperate
2443	process, returning the results. Everything must be serialisable with
2444	Coro::Storable. May, of course, block. Note that the executed sub may
2445	never block itself or use any form of Event handling.
2446
2447	=cut
2448
2449	sub fork_call(&@) {
2450	my ($cb, @args) = @_;
2451
2452	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2453	# or die "socketpair: $!";
2454	pipe my $fh1, my $fh2
2455	or die "pipe: $!";
2456
2457	if (my $pid = fork) {
2458	close $fh2;
2459
2460	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2461	$res = Coro::Storable::thaw $res;
2462
2463	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2464
2465	die $$res unless "ARRAY" eq ref $res;
2466
2467	return wantarray ? @$res : $res->[-1];
2468	} else {
2469	reset_signals;
2470	local $SIG{__WARN__};
2471	local $SIG{__DIE__};
2472	eval {
2473	close $fh1;
2474
2475	my @res = eval { $cb->(@args) };
2476	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2477	};
2478
2479	warn $@ if $@;
2480	_exit 0;
2481	}
2482	}
2483
2484	#############################################################################
2485	# the server's init and main functions	2846	# the server's init and main functions
2486		2847
2487	sub load_facedata($) {	2848	sub load_facedata($) {
2488	my ($path) = @_;	2849	my ($path) = @_;
2489		2850
…		…
2501	{	2862	{
2502	my $faces = $facedata->{faceinfo};	2863	my $faces = $facedata->{faceinfo};
2503		2864
2504	while (my ($face, $info) = each %$faces) {	2865	while (my ($face, $info) = each %$faces) {
2505	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2866	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2506	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2867	cf::face::set_visibility $idx, $info->{visibility};
		2868	cf::face::set_magicmap $idx, $info->{magicmap};
2507	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2869	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2508	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	2870	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2509	Coro::cede;	2871
		2872	cf::cede_to_tick;
2510	}	2873	}
2511		2874
2512	while (my ($face, $info) = each %$faces) {	2875	while (my ($face, $info) = each %$faces) {
2513	next unless $info->{smooth};	2876	next unless $info->{smooth};
2514	my $idx = cf::face::find $face	2877	my $idx = cf::face::find $face
2515	or next;	2878	or next;
2516	if (my $smooth = cf::face::find $info->{smooth}) {	2879	if (my $smooth = cf::face::find $info->{smooth}) {
		2880	cf::face::set_smooth $idx, $smooth;
2517	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	2881	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2518	} else {	2882	} else {
2519	warn "smooth face '$info->{smooth}' not found for face '$face'";	2883	warn "smooth face '$info->{smooth}' not found for face '$face'";
2520	}	2884	}
2521	Coro::cede;	2885
		2886	cf::cede_to_tick;
2522	}	2887	}
2523	}	2888	}
2524		2889
2525	{	2890	{
2526	my $anims = $facedata->{animinfo};	2891	my $anims = $facedata->{animinfo};
2527		2892
2528	while (my ($anim, $info) = each %$anims) {	2893	while (my ($anim, $info) = each %$anims) {
2529	cf::anim::set $anim, $info->{frames}, $info->{facings};	2894	cf::anim::set $anim, $info->{frames}, $info->{facings};
2530	Coro::cede;	2895	cf::cede_to_tick;
2531	}	2896	}
2532		2897
2533	cf::anim::invalidate_all; # d'oh	2898	cf::anim::invalidate_all; # d'oh
2534	}	2899	}
2535		2900
		2901	{
		2902	# TODO: for gcfclient pleasure, we should give resources
		2903	# that gcfclient doesn't grok a >10000 face index.
		2904	my $res = $facedata->{resource};
		2905	my $enc = JSON::XS->new->utf8->canonical;
		2906
		2907	my $soundconf = delete $res->{"res/sound.conf"};
		2908
		2909	while (my ($name, $info) = each %$res) {
		2910	my $meta = $enc->encode ({
		2911	name => $name,
		2912	%{ $info->{meta} || {} },
		2913	});
		2914
		2915	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2916
		2917	if ($info->{type} & 1) {
		2918	# prepend meta info
		2919
		2920	my $data = pack "(w/a*)*", $meta, $info->{data};
		2921	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2922
		2923	cf::face::set_data $idx, 0, $data, $chk;
		2924	} else {
		2925	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
		2926	}
		2927
		2928	cf::face::set_type $idx, $info->{type};
		2929
		2930	cf::cede_to_tick;
		2931	}
		2932
		2933	if ($soundconf) {
		2934	$soundconf = $enc->decode (delete $soundconf->{data});
		2935
		2936	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2937	my $sound = $soundconf->{compat}[$_]
		2938	or next;
		2939
		2940	my $face = cf::face::find "sound/$sound->[1]";
		2941	cf::sound::set $sound->[0] => $face;
		2942	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2943	}
		2944
		2945	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2946	my $face = cf::face::find "sound/$v";
		2947	cf::sound::set $k => $face;
		2948	}
		2949	}
		2950	}
		2951
2536	1	2952	1
2537	}	2953	}
		2954
		2955	register_exticmd fx_want => sub {
		2956	my ($ns, $want) = @_;
		2957
		2958	while (my ($k, $v) = each %$want) {
		2959	$ns->fx_want ($k, $v);
		2960	}
		2961	};
2538		2962
2539	sub reload_regions {	2963	sub reload_regions {
2540	load_resource_file "$MAPDIR/regions"	2964	load_resource_file "$MAPDIR/regions"
2541	or die "unable to load regions file\n";	2965	or die "unable to load regions file\n";
		2966
		2967	for (cf::region::list) {
		2968	$_->{match} = qr/$_->{match}/
		2969	if exists $_->{match};
		2970	}
2542	}	2971	}
2543		2972
2544	sub reload_facedata {	2973	sub reload_facedata {
2545	load_facedata "$DATADIR/facedata"	2974	load_facedata "$DATADIR/facedata"
2546	or die "unable to load facedata\n";	2975	or die "unable to load facedata\n";
2547	}	2976	}
2548		2977
2549	sub reload_archetypes {	2978	sub reload_archetypes {
2550	load_resource_file "$DATADIR/archetypes"	2979	load_resource_file "$DATADIR/archetypes"
2551	or die "unable to load archetypes\n";	2980	or die "unable to load archetypes\n";
		2981	#d# NEED to laod twice to resolve forward references
		2982	# this really needs to be done in an extra post-pass
		2983	# (which needs to be synchronous, so solve it differently)
		2984	load_resource_file "$DATADIR/archetypes"
		2985	or die "unable to load archetypes\n";
2552	}	2986	}
2553		2987
2554	sub reload_treasures {	2988	sub reload_treasures {
2555	load_resource_file "$DATADIR/treasures"	2989	load_resource_file "$DATADIR/treasures"
2556	or die "unable to load treasurelists\n";	2990	or die "unable to load treasurelists\n";
…		…
2559	sub reload_resources {	2993	sub reload_resources {
2560	warn "reloading resource files...\n";	2994	warn "reloading resource files...\n";
2561		2995
2562	reload_regions;	2996	reload_regions;
2563	reload_facedata;	2997	reload_facedata;
		2998	#reload_archetypes;#d#
2564	reload_archetypes;	2999	reload_archetypes;
2565	reload_treasures;	3000	reload_treasures;
2566		3001
2567	warn "finished reloading resource files\n";	3002	warn "finished reloading resource files\n";
2568	}	3003	}
…		…
2625	},	3060	},
2626	);	3061	);
2627	}	3062	}
2628	}	3063	}
2629		3064
		3065	sub write_runtime {
		3066	my $runtime = "$LOCALDIR/runtime";
		3067
		3068	# first touch the runtime file to show we are still running:
		3069	# the fsync below can take a very very long time.
		3070
		3071	IO::AIO::aio_utime $runtime, undef, undef;
		3072
		3073	my $guard = cf::lock_acquire "write_runtime";
		3074
		3075	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3076	or return;
		3077
		3078	my $value = $cf::RUNTIME + 90 + 10;
		3079	# 10 is the runtime save interval, for a monotonic clock
		3080	# 60 allows for the watchdog to kill the server.
		3081
		3082	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3083	and return;
		3084
		3085	# always fsync - this file is important
		3086	aio_fsync $fh
		3087	and return;
		3088
		3089	# touch it again to show we are up-to-date
		3090	aio_utime $fh, undef, undef;
		3091
		3092	close $fh
		3093	or return;
		3094
		3095	aio_rename "$runtime~", $runtime
		3096	and return;
		3097
		3098	warn "runtime file written.\n";
		3099
		3100	1
		3101	}
		3102
2630	sub emergency_save() {	3103	sub emergency_save() {
2631	my $freeze_guard = cf::freeze_mainloop;	3104	my $freeze_guard = cf::freeze_mainloop;
2632		3105
2633	warn "enter emergency perl save\n";	3106	warn "enter emergency perl save\n";
2634		3107
…		…
2709	%EXT_CORO = ();	3182	%EXT_CORO = ();
2710		3183
2711	warn "removing commands";	3184	warn "removing commands";
2712	%COMMAND = ();	3185	%COMMAND = ();
2713		3186
2714	warn "removing ext commands";	3187	warn "removing ext/exti commands";
2715	%EXTCMD = ();	3188	%EXTCMD = ();
		3189	%EXTICMD = ();
2716		3190
2717	warn "unloading/nuking all extensions";	3191	warn "unloading/nuking all extensions";
2718	for my $pkg (@EXTS) {	3192	for my $pkg (@EXTS) {
2719	warn "... unloading $pkg";	3193	warn "... unloading $pkg";
2720		3194

Diff Legend

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