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.279 by root, Mon Jun 11 22:16:53 2007 UTC vs.
Revision 1.351 by root, Sun Sep 2 00:57:38 2007 UTC

…		…
10	use Event;	10	use Event;
11	use Opcode;	11	use Opcode;
12	use Safe;	12	use Safe;
13	use Safe::Hole;	13	use Safe::Hole;
14		14
15	use Coro 3.61 ();	15	use Coro 3.64 ();
16	use Coro::State;	16	use Coro::State;
17	use Coro::Handle;	17	use Coro::Handle;
18	use Coro::Event;	18	use Coro::Event;
19	use Coro::Timer;	19	use Coro::Timer;
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	use Coro::Util ();
24		25
		26	use JSON::XS ();
25	use BDB ();	27	use BDB ();
26	use Data::Dumper;	28	use Data::Dumper;
27	use Digest::MD5;	29	use Digest::MD5;
28	use Fcntl;	30	use Fcntl;
29	use YAML::Syck ();	31	use YAML::Syck ();
30	use IO::AIO 2.32 ();	32	use IO::AIO 2.32 ();
31	use Time::HiRes;	33	use Time::HiRes;
32	use Compress::LZF;	34	use Compress::LZF;
		35	use Digest::MD5 ();
33		36
34	# configure various modules to our taste	37	# configure various modules to our taste
35	#	38	#
36	$Storable::canonical = 1; # reduce rsync transfers	39	$Storable::canonical = 1; # reduce rsync transfers
37	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator	40	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
…		…
49	our %COMMAND = ();	52	our %COMMAND = ();
50	our %COMMAND_TIME = ();	53	our %COMMAND_TIME = ();
51		54
52	our @EXTS = (); # list of extension package names	55	our @EXTS = (); # list of extension package names
53	our %EXTCMD = ();	56	our %EXTCMD = ();
		57	our %EXTICMD = ();
54	our %EXT_CORO = (); # coroutines bound to extensions	58	our %EXT_CORO = (); # coroutines bound to extensions
55	our %EXT_MAP = (); # pluggable maps	59	our %EXT_MAP = (); # pluggable maps
56		60
57	our $RELOAD; # number of reloads so far	61	our $RELOAD; # number of reloads so far
58	our @EVENT;	62	our @EVENT;
…		…
164		168
165	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only	169	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	170	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.	171	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
168		172
		173	=item @cf::INVOKE_RESULTS
		174
		175	This array contains the results of the last C<invoke ()> call. When
		176	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		177	that call.
		178
169	=back	179	=back
170		180
171	=cut	181	=cut
172		182
173	BEGIN {	183	BEGIN {
…		…
206	}	216	}
207		217
208	$Event::DIED = sub {	218	$Event::DIED = sub {
209	warn "error in event callback: @_";	219	warn "error in event callback: @_";
210	};	220	};
		221
		222	#############################################################################
211		223
212	=head2 UTILITY FUNCTIONS	224	=head2 UTILITY FUNCTIONS
213		225
214	=over 4	226	=over 4
215		227
…		…
234	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	246	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
235	$d	247	$d
236	} || "[unable to dump $_[0]: '$@']";	248	} || "[unable to dump $_[0]: '$@']";
237	}	249	}
238		250
239	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
240
241	=item $ref = cf::from_json $json	251	=item $ref = cf::from_json $json
242		252
243	Converts a JSON string into the corresponding perl data structure.	253	Converts a JSON string into the corresponding perl data structure.
244		254
245	=item $json = cf::to_json $ref	255	=item $json = cf::to_json $ref
246		256
247	Converts a perl data structure into its JSON representation.	257	Converts a perl data structure into its JSON representation.
		258
		259	=cut
		260
		261	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
		262
		263	sub to_json ($) { $json_coder->encode ($_[0]) }
		264	sub from_json ($) { $json_coder->decode ($_[0]) }
248		265
249	=item cf::lock_wait $string	266	=item cf::lock_wait $string
250		267
251	Wait until the given lock is available. See cf::lock_acquire.	268	Wait until the given lock is available. See cf::lock_acquire.
252		269
…		…
254		271
255	Wait until the given lock is available and then acquires it and returns	272	Wait until the given lock is available and then acquires it and returns
256	a Coro::guard object. If the guard object gets destroyed (goes out of scope,	273	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
257	for example when the coroutine gets canceled), the lock is automatically	274	for example when the coroutine gets canceled), the lock is automatically
258	returned.	275	returned.
		276
		277	Locks are *not* recursive, locking from the same coro twice results in a
		278	deadlocked coro.
259		279
260	Lock names should begin with a unique identifier (for example, cf::map::find	280	Lock names should begin with a unique identifier (for example, cf::map::find
261	uses map_find and cf::map::load uses map_load).	281	uses map_find and cf::map::load uses map_load).
262		282
263	=item $locked = cf::lock_active $string	283	=item $locked = cf::lock_active $string
…		…
306	};	326	};
307	$TICK_WATCHER->stop;	327	$TICK_WATCHER->stop;
308	$guard	328	$guard
309	}	329	}
310		330
		331	=item cf::get_slot $time[, $priority[, $name]]
		332
		333	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		334	This call blocks and returns only when you have at least C<$time> seconds
		335	of cpu time till the next tick. The slot is only valid till the next cede.
		336
		337	The optional C<$name> can be used to identify the job to run. It might be
		338	used for statistical purposes and should identify the same time-class.
		339
		340	Useful for short background jobs.
		341
		342	=cut
		343
		344	our @SLOT_QUEUE;
		345	our $SLOT_QUEUE;
		346
		347	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		348	$SLOT_QUEUE = Coro::async {
		349	my $signal = new Coro::Signal;
		350
		351	while () {
		352	next_job:
		353	my $avail = cf::till_tick;
		354	if ($avail > 0.01) {
		355	for (0 .. $#SLOT_QUEUE) {
		356	if ($SLOT_QUEUE[$_][0] < $avail) {
		357	my $job = splice @SLOT_QUEUE, $_, 1, ();
		358	$job->[2]->send;
		359	Coro::cede;
		360	goto next_job;
		361	}
		362	}
		363	}
		364
		365	if (@SLOT_QUEUE) {
		366	# we do not use wait_For_tick() as it returns immediately when tick is inactive
		367	push @cf::WAIT_FOR_TICK, $signal;
		368	$signal->wait;
		369	} else {
		370	Coro::schedule;
		371	}
		372	}
		373	};
		374
		375	sub get_slot($;$$) {
		376	my ($time, $pri, $name) = @_;
		377
		378	$time = $TICK * .6 if $time > $TICK * .6;
		379	my $sig = new Coro::Signal;
		380
		381	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		382	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		383	$SLOT_QUEUE->ready;
		384	$sig->wait;
		385	}
		386
311	=item cf::async { BLOCK }	387	=item cf::async { BLOCK }
312		388
313	Currently the same as Coro::async_pool, meaning you cannot use	389	Currently the same as Coro::async_pool, meaning you cannot use
314	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only	390	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
315	thing you are allowed to do is call C<prio> on it.	391	thing you are allowed to do is call C<prio> on it.
…		…
318		394
319	BEGIN { *async = \&Coro::async_pool }	395	BEGIN { *async = \&Coro::async_pool }
320		396
321	=item cf::sync_job { BLOCK }	397	=item cf::sync_job { BLOCK }
322		398
323	The design of crossfire+ requires that the main coro ($Coro::main) is	399	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
324	always able to handle events or runnable, as crossfire+ is only partly	400	is always able to handle events or runnable, as Crossfire TRT is only
325	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	401	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		402	acceptable.
326		403
327	If it must be done, put the blocking parts into C<sync_job>. This will run	404	If it must be done, put the blocking parts into C<sync_job>. This will run
328	the given BLOCK in another coroutine while waiting for the result. The	405	the given BLOCK in another coroutine while waiting for the result. The
329	server will be frozen during this time, so the block should either finish	406	server will be frozen during this time, so the block should either finish
330	fast or be very important.	407	fast or be very important.
…		…
390	$EXT_CORO{$coro+0} = $coro;	467	$EXT_CORO{$coro+0} = $coro;
391		468
392	$coro	469	$coro
393	}	470	}
394		471
395	sub write_runtime {	472	=item fork_call { }, $args
396	my $runtime = "$LOCALDIR/runtime";
397		473
398	# first touch the runtime file to show we are still running:	474	Executes the given code block with the given arguments in a seperate
399	# the fsync below can take a very very long time.	475	process, returning the results. Everything must be serialisable with
		476	Coro::Storable. May, of course, block. Note that the executed sub may
		477	never block itself or use any form of Event handling.
400		478
401	IO::AIO::aio_utime $runtime, undef, undef;	479	=cut
402		480
403	my $guard = cf::lock_acquire "write_runtime";	481	sub fork_call(&@) {
		482	my ($cb, @args) = @_;
404		483
405	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	484	# we seemingly have to make a local copy of the whole thing,
406	or return;	485	# otherwise perl prematurely frees the stuff :/
		486	# TODO: investigate and fix (liekly this will be rather laborious)
407		487
408	my $value = $cf::RUNTIME + 90 + 10;	488	my @res = Coro::Util::fork_eval {
409	# 10 is the runtime save interval, for a monotonic clock	489	reset_signals;
410	# 60 allows for the watchdog to kill the server.	490	&$cb
		491	}, @args;
411		492
412	(aio_write $fh, 0, (length $value), $value, 0) <= 0	493	wantarray ? @res : $res[-1]
413	and return;	494	}
414		495
415	# always fsync - this file is important	496	=item $value = cf::db_get $family => $key
416	aio_fsync $fh
417	and return;
418		497
419	# touch it again to show we are up-to-date	498	Returns a single value from the environment database.
420	aio_utime $fh, undef, undef;
421		499
422	close $fh	500	=item cf::db_put $family => $key => $value
423	or return;
424		501
425	aio_rename "$runtime~", $runtime	502	Stores the given C<$value> in the family. It can currently store binary
426	and return;	503	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
427		504
428	warn "runtime file written.\n";	505	=cut
429		506
		507	our $DB;
		508
		509	sub db_init {
		510	unless ($DB) {
		511	$DB = BDB::db_create $DB_ENV;
		512
		513	cf::sync_job {
		514	eval {
		515	$DB->set_flags (BDB::CHKSUM);
		516
		517	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		518	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		519	cf::cleanup "db_open(db): $!" if $!;
		520	};
		521	cf::cleanup "db_open(db): $@" if $@;
		522	};
430	1	523	}
		524	}
		525
		526	sub db_get($$) {
		527	my $key = "$_[0]/$_[1]";
		528
		529	cf::sync_job {
		530	BDB::db_get $DB, undef, $key, my $data;
		531
		532	$! ? ()
		533	: $data
		534	}
		535	}
		536
		537	sub db_put($$$) {
		538	BDB::dbreq_pri 4;
		539	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		540	}
		541
		542	=item cf::cache $id => [$paths...], $processversion => $process
		543
		544	Generic caching function that returns the value of the resource $id,
		545	caching and regenerating as required.
		546
		547	This function can block.
		548
		549	=cut
		550
		551	sub cache {
		552	my ($id, $src, $processversion, $process) = @_;
		553
		554	my $meta =
		555	join "\x00",
		556	$processversion,
		557	map {
		558	aio_stat $_
		559	and Carp::croak "$_: $!";
		560
		561	($_, (stat _)[7,9])
		562	} @$src;
		563
		564	my $dbmeta = db_get cache => "$id/meta";
		565	if ($dbmeta ne $meta) {
		566	# changed, we may need to process
		567
		568	my @data;
		569	my $md5;
		570
		571	for (0 .. $#$src) {
		572	0 <= aio_load $src->[$_], $data[$_]
		573	or Carp::croak "$src->[$_]: $!";
		574	}
		575
		576	# if processing is expensive, check
		577	# checksum first
		578	if (1) {
		579	$md5 =
		580	join "\x00",
		581	$processversion,
		582	map {
		583	cf::cede_to_tick;
		584	($src->[$_], Digest::MD5::md5_hex $data[$_])
		585	} 0.. $#$src;
		586
		587
		588	my $dbmd5 = db_get cache => "$id/md5";
		589	if ($dbmd5 eq $md5) {
		590	db_put cache => "$id/meta", $meta;
		591
		592	return db_get cache => "$id/data";
		593	}
		594	}
		595
		596	my $t1 = Time::HiRes::time;
		597	my $data = $process->(\@data);
		598	my $t2 = Time::HiRes::time;
		599
		600	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		601
		602	db_put cache => "$id/data", $data;
		603	db_put cache => "$id/md5" , $md5;
		604	db_put cache => "$id/meta", $meta;
		605
		606	return $data;
		607	}
		608
		609	db_get cache => "$id/data"
431	}	610	}
432		611
433	=item cf::datalog type => key => value, ...	612	=item cf::datalog type => key => value, ...
434		613
435	Log a datalog packet of the given type with the given key-value pairs.	614	Log a datalog packet of the given type with the given key-value pairs.
…		…
453	attach callbacks/event handlers (a collection of which is called an "attachment")	632	attach callbacks/event handlers (a collection of which is called an "attachment")
454	to it. All such attachable objects support the following methods.	633	to it. All such attachable objects support the following methods.
455		634
456	In the following description, CLASS can be any of C<global>, C<object>	635	In the following description, CLASS can be any of C<global>, C<object>
457	C<player>, C<client> or C<map> (i.e. the attachable objects in	636	C<player>, C<client> or C<map> (i.e. the attachable objects in
458	crossfire+).	637	Crossfire TRT).
459		638
460	=over 4	639	=over 4
461		640
462	=item $attachable->attach ($attachment, key => $value...)	641	=item $attachable->attach ($attachment, key => $value...)
463		642
…		…
665	_attach $registry, $klass, @attach;	844	_attach $registry, $klass, @attach;
666	}	845	}
667		846
668	$obj->{$name} = \%arg;	847	$obj->{$name} = \%arg;
669	} else {	848	} else {
670	warn "object uses attachment '$name' that is not available, postponing.\n";	849	warn "object uses attachment '$name' which is not available, postponing.\n";
671	}	850	}
672		851
673	$obj->{_attachment}{$name} = undef;	852	$obj->{_attachment}{$name} = undef;
674	}	853	}
675		854
…		…
715	";	894	";
716	die if $@;	895	die if $@;
717	}	896	}
718		897
719	our $override;	898	our $override;
720	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	899	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
721		900
722	sub override {	901	sub override {
723	$override = 1;	902	$override = 1;
724	@invoke_results = ();	903	@INVOKE_RESULTS = (@_);
725	}	904	}
726		905
727	sub do_invoke {	906	sub do_invoke {
728	my $event = shift;	907	my $event = shift;
729	my $callbacks = shift;	908	my $callbacks = shift;
730		909
731	@invoke_results = ();	910	@INVOKE_RESULTS = ();
732		911
733	local $override;	912	local $override;
734		913
735	for (@$callbacks) {	914	for (@$callbacks) {
736	eval { &{$_->[1]} };	915	eval { &{$_->[1]} };
…		…
753		932
754	Generate an object-specific event with the given arguments.	933	Generate an object-specific event with the given arguments.
755		934
756	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	935	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
757	removed in future versions), and there is no public API to access override	936	removed in future versions), and there is no public API to access override
758	results (if you must, access C<@cf::invoke_results> directly).	937	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
759		938
760	=back	939	=back
761		940
762	=cut	941	=cut
763		942
764	#############################################################################	943	#############################################################################
765	# object support	944	# object support
		945	#
		946
		947	sub _can_merge {
		948	my ($ob1, $ob2) = @_;
		949
		950	local $Storable::canonical = 1;
		951	my $fob1 = Storable::freeze $ob1;
		952	my $fob2 = Storable::freeze $ob2;
		953
		954	$fob1 eq $fob2
		955	}
766		956
767	sub reattach {	957	sub reattach {
768	# basically do the same as instantiate, without calling instantiate	958	# basically do the same as instantiate, without calling instantiate
769	my ($obj) = @_;	959	my ($obj) = @_;
770		960
…		…
877	warn sprintf "loading %s (%d)\n",	1067	warn sprintf "loading %s (%d)\n",
878	$filename, length $data, scalar @{$av || []};	1068	$filename, length $data, scalar @{$av || []};
879	return ($data, $av);	1069	return ($data, $av);
880	}	1070	}
881		1071
		1072	=head2 COMMAND CALLBACKS
		1073
		1074	=over 4
		1075
		1076	=cut
		1077
882	#############################################################################	1078	#############################################################################
883	# command handling &c	1079	# command handling &c
884		1080
885	=item cf::register_command $name => \&callback($ob,$args);	1081	=item cf::register_command $name => \&callback($ob,$args);
886		1082
…		…
898	push @{ $COMMAND{$name} }, [$caller, $cb];	1094	push @{ $COMMAND{$name} }, [$caller, $cb];
899	}	1095	}
900		1096
901	=item cf::register_extcmd $name => \&callback($pl,$packet);	1097	=item cf::register_extcmd $name => \&callback($pl,$packet);
902		1098
903	Register a callbackf ro execution when the client sends an extcmd packet.	1099	Register a callback for execution when the client sends an (synchronous)
		1100	extcmd packet. Ext commands will be processed in the order they are
		1101	received by the server, like other user commands. The first argument is
		1102	the logged-in player. Ext commands can only be processed after a player
		1103	has logged in successfully.
904		1104
905	If the callback returns something, it is sent back as if reply was being	1105	If the callback returns something, it is sent back as if reply was being
906	called.	1106	called.
907		1107
		1108	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1109
		1110	Register a callback for execution when the client sends an (asynchronous)
		1111	exticmd packet. Exti commands are processed by the server as soon as they
		1112	are received, i.e. out of order w.r.t. other commands. The first argument
		1113	is a client socket. Exti commands can be received anytime, even before
		1114	log-in.
		1115
		1116	If the callback returns something, it is sent back as if reply was being
		1117	called.
		1118
908	=cut	1119	=cut
909		1120
910	sub register_extcmd {	1121	sub register_extcmd {
911	my ($name, $cb) = @_;	1122	my ($name, $cb) = @_;
912		1123
913	$EXTCMD{$name} = $cb;	1124	$EXTCMD{$name} = $cb;
		1125	}
		1126
		1127	sub register_exticmd {
		1128	my ($name, $cb) = @_;
		1129
		1130	$EXTICMD{$name} = $cb;
914	}	1131	}
915		1132
916	cf::player->attach (	1133	cf::player->attach (
917	on_command => sub {	1134	on_command => sub {
918	my ($pl, $name, $params) = @_;	1135	my ($pl, $name, $params) = @_;
…		…
927	cf::override;	1144	cf::override;
928	},	1145	},
929	on_extcmd => sub {	1146	on_extcmd => sub {
930	my ($pl, $buf) = @_;	1147	my ($pl, $buf) = @_;
931		1148
932	my $msg = eval { from_json $buf };	1149	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933		1150
934	if (ref $msg) {	1151	if (ref $msg) {
		1152	my ($type, $reply, @payload) =
		1153	"ARRAY" eq ref $msg
		1154	? @$msg
		1155	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1156
		1157	my @reply;
		1158
935	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1159	if (my $cb = $EXTCMD{$type}) {
936	if (my %reply = $cb->($pl, $msg)) {	1160	@reply = $cb->($pl, @payload);
937	$pl->ext_reply ($msg->{msgid}, %reply);
938	}
939	}	1161	}
		1162
		1163	$pl->ext_reply ($reply, @reply)
		1164	if $reply;
		1165
940	} else {	1166	} else {
941	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1167	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
942	}	1168	}
943		1169
944	cf::override;	1170	cf::override;
…		…
1018	};	1244	};
1019	}	1245	}
1020		1246
1021	#############################################################################	1247	#############################################################################
1022		1248
		1249	=back
		1250
1023	=head2 CORE EXTENSIONS	1251	=head2 CORE EXTENSIONS
1024		1252
1025	Functions and methods that extend core crossfire objects.	1253	Functions and methods that extend core crossfire objects.
1026		1254
1027	=cut	1255	=cut
…		…
1097		1325
1098	aio_mkdir playerdir $pl, 0770;	1326	aio_mkdir playerdir $pl, 0770;
1099	$pl->{last_save} = $cf::RUNTIME;	1327	$pl->{last_save} = $cf::RUNTIME;
1100		1328
1101	$pl->save_pl ($path);	1329	$pl->save_pl ($path);
1102	Coro::cede;	1330	cf::cede_to_tick;
1103	}	1331	}
1104		1332
1105	sub new($) {	1333	sub new($) {
1106	my ($login) = @_;	1334	my ($login) = @_;
1107		1335
…		…
1111	$self->{deny_save} = 1;	1339	$self->{deny_save} = 1;
1112		1340
1113	$cf::PLAYER{$login} = $self;	1341	$cf::PLAYER{$login} = $self;
1114		1342
1115	$self	1343	$self
		1344	}
		1345
		1346	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1347
		1348	=cut
		1349
		1350	sub send_msg {
		1351	my $ns = shift->ns
		1352	or return;
		1353	$ns->send_msg (@_);
1116	}	1354	}
1117		1355
1118	=item $pl->quit_character	1356	=item $pl->quit_character
1119		1357
1120	Nukes the player without looking back. If logged in, the connection will	1358	Nukes the player without looking back. If logged in, the connection will
…		…
1214	}	1452	}
1215		1453
1216	\@paths	1454	\@paths
1217	}	1455	}
1218		1456
		1457	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1458
		1459	Expand crossfire pod fragments into protocol xml.
		1460
		1461	=cut
		1462
		1463	sub expand_cfpod {
		1464	((my $self), (local $_)) = @_;
		1465
		1466	# escape & and <
		1467	s/&/&amp;/g;
		1468	s/(?<![BIUGH])</&lt;/g;
		1469
		1470	# this is buggy, it needs to properly take care of nested <'s
		1471
		1472	1 while
		1473	# replace B<>, I<>, U<> etc.
		1474	s/B<([^\>]*)>/<b>$1<\/b>/
		1475	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1476	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1477	# replace G<male|female> tags
		1478	|| s{G<([^>|]*)\|([^>]*)>}{
		1479	$self->gender ? $2 : $1
		1480	}ge
		1481	# replace H<hint text>
		1482	|| s{H<([^\>]*)>}
		1483	{
		1484	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1485	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1486	"")
		1487	[$self->{hintmode}]
		1488	}ge;
		1489
		1490	# create single paragraphs (very hackish)
		1491	s/(?<=\S)\n(?=\w)/ /g;
		1492
		1493	# compress some whitespace
		1494	s/\s+\n/\n/g; # ws line-ends
		1495	s/\n\n+/\n/g; # double lines
		1496	s/^\n+//; # beginning lines
		1497	s/\n+$//; # ending lines
		1498
		1499	$_
		1500	}
		1501
		1502	sub hintmode {
		1503	$_[0]{hintmode} = $_[1] if @_ > 1;
		1504	$_[0]{hintmode}
		1505	}
		1506
1219	=item $player->ext_reply ($msgid, %msg)	1507	=item $player->ext_reply ($msgid, @msg)
1220		1508
1221	Sends an ext reply to the player.	1509	Sends an ext reply to the player.
1222		1510
1223	=cut	1511	=cut
1224		1512
1225	sub ext_reply($$%) {	1513	sub ext_reply($$@) {
1226	my ($self, $id, %msg) = @_;	1514	my ($self, $id, @msg) = @_;
1227		1515
1228	$msg{msgid} = $id;	1516	$self->ns->ext_reply ($id, @msg)
1229
1230	$self->send ("ext " . cf::to_json \%msg);
1231	}	1517	}
1232		1518
1233	=item $player->ext_event ($type, %msg)	1519	=item $player->ext_msg ($type, @msg)
1234		1520
1235	Sends an ext event to the client.	1521	Sends an ext event to the client.
1236		1522
1237	=cut	1523	=cut
1238		1524
1239	sub ext_event($$%) {	1525	sub ext_msg($$@) {
1240	my ($self, $type, %msg) = @_;	1526	my ($self, $type, @msg) = @_;
1241		1527
1242	$self->ns->ext_event ($type, %msg);	1528	$self->ns->ext_msg ($type, @msg);
1243	}	1529	}
1244		1530
1245	=head3 cf::region	1531	=head3 cf::region
1246		1532
1247	=over 4	1533	=over 4
…		…
1250		1536
1251	package cf::region;	1537	package cf::region;
1252		1538
1253	=item cf::region::find_by_path $path	1539	=item cf::region::find_by_path $path
1254		1540
1255	Tries to decuce the probable region for a map knowing only its path.	1541	Tries to decuce the likely region for a map knowing only its path.
1256		1542
1257	=cut	1543	=cut
1258		1544
1259	sub find_by_path($) {	1545	sub find_by_path($) {
1260	my ($path) = @_;	1546	my ($path) = @_;
1261		1547
1262	my ($match, $specificity);	1548	my ($match, $specificity);
1263		1549
1264	for my $region (list) {	1550	for my $region (list) {
1265	if ($region->match && $path =~ $region->match) {	1551	if ($region->{match} && $path =~ $region->{match}) {
1266	($match, $specificity) = ($region, $region->specificity)	1552	($match, $specificity) = ($region, $region->specificity)
1267	if $region->specificity > $specificity;	1553	if $region->specificity > $specificity;
1268	}	1554	}
1269	}	1555	}
1270		1556
…		…
1390	$self->init; # pass $1 etc.	1676	$self->init; # pass $1 etc.
1391	return $self;	1677	return $self;
1392	}	1678	}
1393	}	1679	}
1394		1680
1395	Carp::carp "unable to resolve path '$path' (base '$base').";	1681	Carp::cluck "unable to resolve path '$path' (base '$base').";
1396	()	1682	()
1397	}	1683	}
1398		1684
1399	sub init {	1685	sub init {
1400	my ($self) = @_;	1686	my ($self) = @_;
…		…
1566	local $self->{deny_reset} = 1; # loading can take a long time	1852	local $self->{deny_reset} = 1; # loading can take a long time
1567		1853
1568	my $path = $self->{path};	1854	my $path = $self->{path};
1569		1855
1570	{	1856	{
		1857	my $guard1 = cf::lock_acquire "map_data:$path";
1571	my $guard = cf::lock_acquire "map_load:$path";	1858	my $guard2 = cf::lock_acquire "map_load:$path";
1572		1859
1573	return if $self->in_memory != cf::MAP_SWAPPED;	1860	return if $self->in_memory != cf::MAP_SWAPPED;
1574		1861
1575	$self->in_memory (cf::MAP_LOADING);	1862	$self->in_memory (cf::MAP_LOADING);
1576		1863
1577	$self->alloc;	1864	$self->alloc;
1578		1865
1579	$self->pre_load;	1866	$self->pre_load;
1580	Coro::cede;	1867	cf::cede_to_tick;
1581		1868
1582	$self->_load_objects ($self->{load_path}, 1)	1869	$self->_load_objects ($self->{load_path}, 1)
1583	or return;	1870	or return;
1584		1871
1585	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1872	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
…		…
1591	$self->clear_unique_items;	1878	$self->clear_unique_items;
1592	$self->_load_objects ($uniq, 0);	1879	$self->_load_objects ($uniq, 0);
1593	}	1880	}
1594	}	1881	}
1595		1882
1596	Coro::cede;	1883	cf::cede_to_tick;
1597	# now do the right thing for maps	1884	# now do the right thing for maps
1598	$self->link_multipart_objects;	1885	$self->link_multipart_objects;
1599	$self->difficulty ($self->estimate_difficulty)	1886	$self->difficulty ($self->estimate_difficulty)
1600	unless $self->difficulty;	1887	unless $self->difficulty;
1601	Coro::cede;	1888	cf::cede_to_tick;
1602		1889
1603	unless ($self->{deny_activate}) {	1890	unless ($self->{deny_activate}) {
1604	$self->decay_objects;	1891	$self->decay_objects;
1605	$self->fix_auto_apply;	1892	$self->fix_auto_apply;
1606	$self->update_buttons;	1893	$self->update_buttons;
1607	Coro::cede;	1894	cf::cede_to_tick;
1608	$self->set_darkness_map;	1895	$self->set_darkness_map;
1609	Coro::cede;	1896	cf::cede_to_tick;
1610	$self->activate;	1897	$self->activate;
1611	}	1898	}
		1899
		1900	$self->{last_save} = $cf::RUNTIME;
		1901	$self->last_access ($cf::RUNTIME);
1612		1902
1613	$self->in_memory (cf::MAP_IN_MEMORY);	1903	$self->in_memory (cf::MAP_IN_MEMORY);
1614	}	1904	}
1615		1905
1616	$self->post_load;	1906	$self->post_load;
…		…
1627		1917
1628	$self	1918	$self
1629	}	1919	}
1630		1920
1631	# find and load all maps in the 3x3 area around a map	1921	# find and load all maps in the 3x3 area around a map
1632	sub load_diag {	1922	sub load_neighbours {
1633	my ($map) = @_;	1923	my ($map) = @_;
1634		1924
1635	my @diag; # diagonal neighbours	1925	my @neigh; # diagonal neighbours
1636		1926
1637	for (0 .. 3) {	1927	for (0 .. 3) {
1638	my $neigh = $map->tile_path ($_)	1928	my $neigh = $map->tile_path ($_)
1639	or next;	1929	or next;
1640	$neigh = find $neigh, $map	1930	$neigh = find $neigh, $map
1641	or next;	1931	or next;
1642	$neigh->load;	1932	$neigh->load;
1643		1933
		1934	push @neigh,
1644	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	1935	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1645	[$neigh->tile_path (($_ + 1) % 4), $neigh];	1936	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1646	}	1937	}
1647		1938
1648	for (@diag) {	1939	for (grep defined $_->[0], @neigh) {
		1940	my ($path, $origin) = @$_;
1649	my $neigh = find @$_	1941	my $neigh = find $path, $origin
1650	or next;	1942	or next;
1651	$neigh->load;	1943	$neigh->load;
1652	}	1944	}
1653	}	1945	}
1654		1946
…		…
1659	}	1951	}
1660		1952
1661	sub do_load_sync {	1953	sub do_load_sync {
1662	my ($map) = @_;	1954	my ($map) = @_;
1663		1955
		1956	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		1957	if $Coro::current == $Coro::main;
		1958
1664	cf::sync_job { $map->load };	1959	cf::sync_job { $map->load };
1665	}	1960	}
1666		1961
1667	our %MAP_PREFETCH;	1962	our %MAP_PREFETCH;
1668	our $MAP_PREFETCHER = undef;	1963	our $MAP_PREFETCHER = undef;
1669		1964
1670	sub find_async {	1965	sub find_async {
1671	my ($path, $origin) = @_;	1966	my ($path, $origin, $load) = @_;
1672		1967
1673	$path = normalise $path, $origin && $origin->{path};	1968	$path = normalise $path, $origin && $origin->{path};
1674		1969
1675	if (my $map = $cf::MAP{$path}) {	1970	if (my $map = $cf::MAP{$path}) {
1676	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	1971	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1677	}	1972	}
1678		1973
1679	undef $MAP_PREFETCH{$path};	1974	$MAP_PREFETCH{$path} |= $load;
		1975
1680	$MAP_PREFETCHER ||= cf::async {	1976	$MAP_PREFETCHER ||= cf::async {
1681	while (%MAP_PREFETCH) {	1977	while (%MAP_PREFETCH) {
1682	for my $path (keys %MAP_PREFETCH) {	1978	while (my ($k, $v) = each %MAP_PREFETCH) {
1683	my $map = find $path	1979	if (my $map = find $k) {
1684	or next;
1685	$map->load;	1980	$map->load if $v;
		1981	}
1686		1982
1687	delete $MAP_PREFETCH{$path};	1983	delete $MAP_PREFETCH{$k};
1688	}	1984	}
1689	}	1985	}
1690	undef $MAP_PREFETCHER;	1986	undef $MAP_PREFETCHER;
1691	};	1987	};
1692	$MAP_PREFETCHER->prio (6);	1988	$MAP_PREFETCHER->prio (6);
…		…
1695	}	1991	}
1696		1992
1697	sub save {	1993	sub save {
1698	my ($self) = @_;	1994	my ($self) = @_;
1699		1995
1700	my $lock = cf::lock_acquire "map_data:" . $self->path;	1996	my $lock = cf::lock_acquire "map_data:$self->{path}";
1701		1997
1702	$self->{last_save} = $cf::RUNTIME;	1998	$self->{last_save} = $cf::RUNTIME;
1703		1999
1704	return unless $self->dirty;	2000	return unless $self->dirty;
1705		2001
…		…
1728	my ($self) = @_;	2024	my ($self) = @_;
1729		2025
1730	# save first because save cedes	2026	# save first because save cedes
1731	$self->save;	2027	$self->save;
1732		2028
1733	my $lock = cf::lock_acquire "map_data:" . $self->path;	2029	my $lock = cf::lock_acquire "map_data:$self->{path}";
1734		2030
1735	return if $self->players;	2031	return if $self->players;
1736	return if $self->in_memory != cf::MAP_IN_MEMORY;	2032	return if $self->in_memory != cf::MAP_IN_MEMORY;
1737	return if $self->{deny_save};	2033	return if $self->{deny_save};
1738		2034
…		…
1790	my $nuke_counter = "aaaa";	2086	my $nuke_counter = "aaaa";
1791		2087
1792	sub nuke {	2088	sub nuke {
1793	my ($self) = @_;	2089	my ($self) = @_;
1794		2090
		2091	{
		2092	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2093
1795	delete $cf::MAP{$self->path};	2094	delete $cf::MAP{$self->path};
1796		2095
1797	$self->unlink_save;	2096	$self->unlink_save;
1798		2097
1799	bless $self, "cf::map";	2098	bless $self, "cf::map";
1800	delete $self->{deny_reset};	2099	delete $self->{deny_reset};
1801	$self->{deny_save} = 1;	2100	$self->{deny_save} = 1;
1802	$self->reset_timeout (1);	2101	$self->reset_timeout (1);
1803	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2102	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1804		2103
1805	$cf::MAP{$self->path} = $self;	2104	$cf::MAP{$self->path} = $self;
		2105	}
1806		2106
1807	$self->reset; # polite request, might not happen	2107	$self->reset; # polite request, might not happen
1808	}	2108	}
1809		2109
1810	=item $maps = cf::map::tmp_maps	2110	=item $maps = cf::map::tmp_maps
…		…
1912		2212
1913	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2213	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1914		2214
1915	if ($self->{record_replies}) {	2215	if ($self->{record_replies}) {
1916	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2216	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2217
1917	} else {	2218	} else {
		2219	my $pl = $self->contr;
		2220
		2221	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2222	my $dialog = $pl->{npc_dialog};
		2223	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2224
		2225	} else {
1918	$msg = $npc->name . " says: $msg" if $npc;	2226	$msg = $npc->name . " says: $msg" if $npc;
1919	$self->message ($msg, $flags);	2227	$self->message ($msg, $flags);
		2228	}
1920	}	2229	}
		2230	}
		2231
		2232	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2233
		2234	=cut
		2235
		2236	sub cf::object::send_msg {
		2237	my $pl = shift->contr
		2238	or return;
		2239	$pl->send_msg (@_);
1921	}	2240	}
1922		2241
1923	=item $player_object->may ("access")	2242	=item $player_object->may ("access")
1924		2243
1925	Returns wether the given player is authorized to access resource "access"	2244	Returns wether the given player is authorized to access resource "access"
…		…
2004	# use -1 or undef as default coordinates, not 0, 0	2323	# use -1 or undef as default coordinates, not 0, 0
2005	($x, $y) = ($map->enter_x, $map->enter_y)	2324	($x, $y) = ($map->enter_x, $map->enter_y)
2006	if $x <=0 && $y <= 0;	2325	if $x <=0 && $y <= 0;
2007		2326
2008	$map->load;	2327	$map->load;
2009	$map->load_diag;	2328	$map->load_neighbours;
2010		2329
2011	return unless $self->contr->active;	2330	return unless $self->contr->active;
2012	$self->activate_recursive;	2331	$self->activate_recursive;
2013		2332
2014	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2333	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2015	$self->enter_map ($map, $x, $y);	2334	$self->enter_map ($map, $x, $y);
2016	}	2335	}
2017		2336
2018	=item $player_object->goto ($path, $x, $y[, $check->($map)])	2337	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
2019		2338
2020	Moves the player to the given map-path and coordinates by first freezing	2339	Moves the player to the given map-path and coordinates by first freezing
2021	her, loading and preparing them map, calling the provided $check callback	2340	her, loading and preparing them map, calling the provided $check callback
2022	that has to return the map if sucecssful, and then unfreezes the player on	2341	that has to return the map if sucecssful, and then unfreezes the player on
2023	the new (success) or old (failed) map position.	2342	the new (success) or old (failed) map position. In either case, $done will
		2343	be called at the end of this process.
2024		2344
2025	=cut	2345	=cut
2026		2346
2027	our $GOTOGEN;	2347	our $GOTOGEN;
2028		2348
2029	sub cf::object::player::goto {	2349	sub cf::object::player::goto {
2030	my ($self, $path, $x, $y, $check) = @_;	2350	my ($self, $path, $x, $y, $check, $done) = @_;
2031		2351
2032	# do generation counting so two concurrent goto's will be executed in-order	2352	# do generation counting so two concurrent goto's will be executed in-order
2033	my $gen = $self->{_goto_generation} = ++$GOTOGEN;	2353	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
2034		2354
2035	$self->enter_link;	2355	$self->enter_link;
…		…
2055		2375
2056	if ($gen == $self->{_goto_generation}) {	2376	if ($gen == $self->{_goto_generation}) {
2057	delete $self->{_goto_generation};	2377	delete $self->{_goto_generation};
2058	$self->leave_link ($map, $x, $y);	2378	$self->leave_link ($map, $x, $y);
2059	}	2379	}
		2380
		2381	$done->() if $done;
2060	})->prio (1);	2382	})->prio (1);
2061	}	2383	}
2062		2384
2063	=item $player_object->enter_exit ($exit_object)	2385	=item $player_object->enter_exit ($exit_object)
2064		2386
…		…
2133	my $hp = $exit->stats->hp;	2455	my $hp = $exit->stats->hp;
2134	my $sp = $exit->stats->sp;	2456	my $sp = $exit->stats->sp;
2135		2457
2136	$self->enter_link;	2458	$self->enter_link;
2137		2459
		2460	# if exit is damned, update players death & WoR home-position
		2461	$self->contr->savebed ($slaying, $hp, $sp)
		2462	if $exit->flag (FLAG_DAMNED);
		2463
2138	(async {	2464	(async {
2139	$self->deactivate_recursive; # just to be sure	2465	$self->deactivate_recursive; # just to be sure
2140	unless (eval {	2466	unless (eval {
2141	$self->goto ($slaying, $hp, $sp);	2467	$self->goto ($slaying, $hp, $sp);
2142		2468
…		…
2169		2495
2170	utf8::encode $text;	2496	utf8::encode $text;
2171	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2497	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2172	}	2498	}
2173		2499
		2500	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2501
		2502	Send a drawinfo or msg packet to the client, formatting the msg for the
		2503	client if neccessary. C<$type> should be a string identifying the type of
		2504	the message, with C<log> being the default. If C<$color> is negative, suppress
		2505	the message unless the client supports the msg packet.
		2506
		2507	=cut
		2508
		2509	our %CHANNEL = (
		2510	"c/identify" => {
		2511	id => "identify",
		2512	title => "Identify",
		2513	reply => undef,
		2514	tooltip => "Items recently identified",
		2515	},
		2516	);
		2517
		2518	sub cf::client::send_msg {
		2519	my ($self, $channel, $msg, $color, @extra) = @_;
		2520
		2521	$msg = $self->pl->expand_cfpod ($msg);
		2522
		2523	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2524
		2525	# check predefined channels, for the benefit of C
		2526	$channel = $CHANNEL{$channel} if $CHANNEL{$channel};
		2527
		2528	if (ref $channel) {
		2529	# send meta info to client, if not yet sent
		2530	unless (exists $self->{channel}{$channel->{id}}) {
		2531	$self->{channel}{$channel->{id}} = $channel;
		2532	$self->ext_msg (channel_info => $channel);
		2533	}
		2534
		2535	$channel = $channel->{id};
		2536	}
		2537
		2538	return unless @extra || length $msg;
		2539
		2540	if ($self->can_msg) {
		2541	# default colour, mask it out
		2542	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2543	if $color & cf::NDI_DEF;
		2544
		2545	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2546	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2547	} else {
		2548	if ($color >= 0) {
		2549	# replace some tags by gcfclient-compatible ones
		2550	for ($msg) {
		2551	1 while
		2552	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2553	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2554	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2555	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2556	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2557	}
		2558
		2559	$color &= cf::NDI_COLOR_MASK;
		2560
		2561	utf8::encode $msg;
		2562
		2563	if (0 && $msg =~ /\[/) {
		2564	# COMMAND/INFO
		2565	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2566	} else {
		2567	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2568	$self->send_packet ("drawinfo $color $msg")
		2569	}
		2570	}
		2571	}
		2572	}
		2573
2174	=item $client->ext_event ($type, %msg)	2574	=item $client->ext_msg ($type, @msg)
2175		2575
2176	Sends an exti event to the client.	2576	Sends an ext event to the client.
2177		2577
2178	=cut	2578	=cut
2179		2579
2180	sub cf::client::ext_event($$%) {	2580	sub cf::client::ext_msg($$@) {
2181	my ($self, $type, %msg) = @_;	2581	my ($self, $type, @msg) = @_;
2182		2582
		2583	if ($self->extcmd == 2) {
		2584	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2585	} elsif ($self->extcmd == 1) { # TODO: remove
2183	$msg{msgtype} = "event_$type";	2586	push @msg, msgtype => "event_$type";
2184	$self->send_packet ("ext " . cf::to_json \%msg);	2587	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2588	}
		2589	}
		2590
		2591	=item $client->ext_reply ($msgid, @msg)
		2592
		2593	Sends an ext reply to the client.
		2594
		2595	=cut
		2596
		2597	sub cf::client::ext_reply($$@) {
		2598	my ($self, $id, @msg) = @_;
		2599
		2600	if ($self->extcmd == 2) {
		2601	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2602	} elsif ($self->extcmd == 1) {
		2603	#TODO: version 1, remove
		2604	unshift @msg, msgtype => "reply", msgid => $id;
		2605	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2606	}
2185	}	2607	}
2186		2608
2187	=item $success = $client->query ($flags, "text", \&cb)	2609	=item $success = $client->query ($flags, "text", \&cb)
2188		2610
2189	Queues a query to the client, calling the given callback with	2611	Queues a query to the client, calling the given callback with
2190	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2612	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2191	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2613	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2192		2614
2193	Queries can fail, so check the return code. Or don't, as queries will become	2615	Queries can fail, so check the return code. Or don't, as queries will
2194	reliable at some point in the future.	2616	become reliable at some point in the future.
2195		2617
2196	=cut	2618	=cut
2197		2619
2198	sub cf::client::query {	2620	sub cf::client::query {
2199	my ($self, $flags, $text, $cb) = @_;	2621	my ($self, $flags, $text, $cb) = @_;
…		…
2207	utf8::encode $text;	2629	utf8::encode $text;
2208	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2630	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2209		2631
2210	$self->send_packet ($self->{query_queue}[0][0])	2632	$self->send_packet ($self->{query_queue}[0][0])
2211	if @{ $self->{query_queue} } == 1;	2633	if @{ $self->{query_queue} } == 1;
		2634
		2635	1
2212	}	2636	}
2213		2637
2214	cf::client->attach (	2638	cf::client->attach (
		2639	on_connect => sub {
		2640	my ($ns) = @_;
		2641
		2642	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2643	},
2215	on_reply => sub {	2644	on_reply => sub {
2216	my ($ns, $msg) = @_;	2645	my ($ns, $msg) = @_;
2217		2646
2218	# this weird shuffling is so that direct followup queries	2647	# this weird shuffling is so that direct followup queries
2219	# get handled first	2648	# get handled first
…		…
2231	} else {	2660	} else {
2232	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2661	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2233	}	2662	}
2234	}	2663	}
2235	},	2664	},
		2665	on_exticmd => sub {
		2666	my ($ns, $buf) = @_;
		2667
		2668	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2669
		2670	if (ref $msg) {
		2671	my ($type, $reply, @payload) =
		2672	"ARRAY" eq ref $msg
		2673	? @$msg
		2674	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2675
		2676	my @reply;
		2677
		2678	if (my $cb = $EXTICMD{$type}) {
		2679	@reply = $cb->($ns, @payload);
		2680	}
		2681
		2682	$ns->ext_reply ($reply, @reply)
		2683	if $reply;
		2684
		2685	} else {
		2686	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2687	}
		2688
		2689	cf::override;
		2690	},
2236	);	2691	);
2237		2692
2238	=item $client->async (\&cb)	2693	=item $client->async (\&cb)
2239		2694
2240	Create a new coroutine, running the specified callback. The coroutine will	2695	Create a new coroutine, running the specified callback. The coroutine will
…		…
2281	our $safe = new Safe "safe";	2736	our $safe = new Safe "safe";
2282	our $safe_hole = new Safe::Hole;	2737	our $safe_hole = new Safe::Hole;
2283		2738
2284	$SIG{FPE} = 'IGNORE';	2739	$SIG{FPE} = 'IGNORE';
2285		2740
2286	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2741	$safe->permit_only (Opcode::opset qw(
		2742	:base_core :base_mem :base_orig :base_math
		2743	grepstart grepwhile mapstart mapwhile
		2744	sort time
		2745	));
2287		2746
2288	# here we export the classes and methods available to script code	2747	# here we export the classes and methods available to script code
2289		2748
2290	=pod	2749	=pod
2291		2750
2292	The following functions and methods are available within a safe environment:	2751	The following functions and methods are available within a safe environment:
2293		2752
2294	cf::object contr pay_amount pay_player map	2753	cf::object
		2754	contr pay_amount pay_player map x y force_find force_add
		2755	insert remove name archname title slaying race decrease_ob_nr
		2756
2295	cf::object::player player	2757	cf::object::player
2296	cf::player peaceful	2758	player
2297	cf::map trigger	2759
		2760	cf::player
		2761	peaceful
		2762
		2763	cf::map
		2764	trigger
2298		2765
2299	=cut	2766	=cut
2300		2767
2301	for (	2768	for (
2302	["cf::object" => qw(contr pay_amount pay_player map)],	2769	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2770	insert remove inv name archname title slaying race
		2771	decrease_ob_nr)],
2303	["cf::object::player" => qw(player)],	2772	["cf::object::player" => qw(player)],
2304	["cf::player" => qw(peaceful)],	2773	["cf::player" => qw(peaceful)],
2305	["cf::map" => qw(trigger)],	2774	["cf::map" => qw(trigger)],
2306	) {	2775	) {
2307	no strict 'refs';	2776	no strict 'refs';
…		…
2378	=back	2847	=back
2379		2848
2380	=cut	2849	=cut
2381		2850
2382	#############################################################################	2851	#############################################################################
2383
2384	=head2 EXTENSION DATABASE SUPPORT
2385
2386	Crossfire maintains a very simple database for extension use. It can
2387	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2388	convert to/from binary).
2389
2390	The parameter C<$family> should best start with the name of the extension
2391	using it, it should be unique.
2392
2393	=over 4
2394
2395	=item $value = cf::db_get $family => $key
2396
2397	Returns a single value from the database.
2398
2399	=item cf::db_put $family => $key => $value
2400
2401	Stores the given C<$value> in the family.
2402
2403	=cut
2404
2405	our $DB;
2406
2407	sub db_init {
2408	unless ($DB) {
2409	$DB = BDB::db_create $DB_ENV;
2410
2411	cf::sync_job {
2412	eval {
2413	$DB->set_flags (BDB::CHKSUM);
2414
2415	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2416	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2417	cf::cleanup "db_open(db): $!" if $!;
2418	};
2419	cf::cleanup "db_open(db): $@" if $@;
2420	};
2421	}
2422	}
2423
2424	sub db_get($$) {
2425	my $key = "$_[0]/$_[1]";
2426
2427	cf::sync_job {
2428	BDB::db_get $DB, undef, $key, my $data;
2429
2430	$! ? ()
2431	: $data
2432	}
2433	}
2434
2435	sub db_put($$$) {
2436	BDB::dbreq_pri 4;
2437	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2438	}
2439
2440	=item cf::cache $id => [$paths...], $processversion => $process
2441
2442	Generic caching function that returns the value of the resource $id,
2443	caching and regenerating as required.
2444
2445	This function can block.
2446
2447	=cut
2448
2449	sub cache {
2450	my ($id, $src, $processversion, $process) = @_;
2451
2452	my $meta =
2453	join "\x00",
2454	$processversion,
2455	map {
2456	aio_stat $_
2457	and Carp::croak "$_: $!";
2458
2459	($_, (stat _)[7,9])
2460	} @$src;
2461
2462	my $dbmeta = db_get cache => "$id/meta";
2463	if ($dbmeta ne $meta) {
2464	# changed, we may need to process
2465
2466	my @data;
2467	my $md5;
2468
2469	for (0 .. $#$src) {
2470	0 <= aio_load $src->[$_], $data[$_]
2471	or Carp::croak "$src->[$_]: $!";
2472	}
2473
2474	# if processing is expensive, check
2475	# checksum first
2476	if (1) {
2477	$md5 =
2478	join "\x00",
2479	$processversion,
2480	map {
2481	Coro::cede;
2482	($src->[$_], Digest::MD5::md5_hex $data[$_])
2483	} 0.. $#$src;
2484
2485
2486	my $dbmd5 = db_get cache => "$id/md5";
2487	if ($dbmd5 eq $md5) {
2488	db_put cache => "$id/meta", $meta;
2489
2490	return db_get cache => "$id/data";
2491	}
2492	}
2493
2494	my $t1 = Time::HiRes::time;
2495	my $data = $process->(\@data);
2496	my $t2 = Time::HiRes::time;
2497
2498	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2499
2500	db_put cache => "$id/data", $data;
2501	db_put cache => "$id/md5" , $md5;
2502	db_put cache => "$id/meta", $meta;
2503
2504	return $data;
2505	}
2506
2507	db_get cache => "$id/data"
2508	}
2509
2510	=item fork_call { }, $args
2511
2512	Executes the given code block with the given arguments in a seperate
2513	process, returning the results. Everything must be serialisable with
2514	Coro::Storable. May, of course, block. Note that the executed sub may
2515	never block itself or use any form of Event handling.
2516
2517	=cut
2518
2519	sub fork_call(&@) {
2520	my ($cb, @args) = @_;
2521
2522	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2523	# or die "socketpair: $!";
2524	pipe my $fh1, my $fh2
2525	or die "pipe: $!";
2526
2527	if (my $pid = fork) {
2528	close $fh2;
2529
2530	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2531	$res = Coro::Storable::thaw $res;
2532
2533	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2534
2535	die $$res unless "ARRAY" eq ref $res;
2536
2537	return wantarray ? @$res : $res->[-1];
2538	} else {
2539	reset_signals;
2540	local $SIG{__WARN__};
2541	local $SIG{__DIE__};
2542	eval {
2543	close $fh1;
2544
2545	my @res = eval { $cb->(@args) };
2546	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2547	};
2548
2549	warn $@ if $@;
2550	_exit 0;
2551	}
2552	}
2553
2554	#############################################################################
2555	# the server's init and main functions	2852	# the server's init and main functions
2556		2853
2557	sub load_facedata($) {	2854	sub load_facedata($) {
2558	my ($path) = @_;	2855	my ($path) = @_;
		2856
		2857	# HACK to clear player env face cache, we need some signal framework
		2858	# for this (global event?)
		2859	%ext::player_env::MUSIC_FACE_CACHE = ();
		2860
		2861	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2559		2862
2560	warn "loading facedata from $path\n";	2863	warn "loading facedata from $path\n";
2561		2864
2562	my $facedata;	2865	my $facedata;
2563	0 < aio_load $path, $facedata	2866	0 < aio_load $path, $facedata
…		…
2566	$facedata = Coro::Storable::thaw $facedata;	2869	$facedata = Coro::Storable::thaw $facedata;
2567		2870
2568	$facedata->{version} == 2	2871	$facedata->{version} == 2
2569	or cf::cleanup "$path: version mismatch, cannot proceed.";	2872	or cf::cleanup "$path: version mismatch, cannot proceed.";
2570		2873
		2874	# patch in the exptable
		2875	$facedata->{resource}{"res/exp_table"} = {
		2876	type => FT_RSRC,
		2877	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
		2878	};
		2879	cf::cede_to_tick;
		2880
2571	{	2881	{
2572	my $faces = $facedata->{faceinfo};	2882	my $faces = $facedata->{faceinfo};
2573		2883
2574	while (my ($face, $info) = each %$faces) {	2884	while (my ($face, $info) = each %$faces) {
2575	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2885	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2576	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2886	cf::face::set_visibility $idx, $info->{visibility};
		2887	cf::face::set_magicmap $idx, $info->{magicmap};
2577	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2888	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2578	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	2889	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2579	Coro::cede;	2890
		2891	cf::cede_to_tick;
2580	}	2892	}
2581		2893
2582	while (my ($face, $info) = each %$faces) {	2894	while (my ($face, $info) = each %$faces) {
2583	next unless $info->{smooth};	2895	next unless $info->{smooth};
2584	my $idx = cf::face::find $face	2896	my $idx = cf::face::find $face
2585	or next;	2897	or next;
2586	if (my $smooth = cf::face::find $info->{smooth}) {	2898	if (my $smooth = cf::face::find $info->{smooth}) {
		2899	cf::face::set_smooth $idx, $smooth;
2587	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	2900	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2588	} else {	2901	} else {
2589	warn "smooth face '$info->{smooth}' not found for face '$face'";	2902	warn "smooth face '$info->{smooth}' not found for face '$face'";
2590	}	2903	}
2591	Coro::cede;	2904
		2905	cf::cede_to_tick;
2592	}	2906	}
2593	}	2907	}
2594		2908
2595	{	2909	{
2596	my $anims = $facedata->{animinfo};	2910	my $anims = $facedata->{animinfo};
2597		2911
2598	while (my ($anim, $info) = each %$anims) {	2912	while (my ($anim, $info) = each %$anims) {
2599	cf::anim::set $anim, $info->{frames}, $info->{facings};	2913	cf::anim::set $anim, $info->{frames}, $info->{facings};
2600	Coro::cede;	2914	cf::cede_to_tick;
2601	}	2915	}
2602		2916
2603	cf::anim::invalidate_all; # d'oh	2917	cf::anim::invalidate_all; # d'oh
2604	}	2918	}
2605		2919
		2920	{
		2921	# TODO: for gcfclient pleasure, we should give resources
		2922	# that gcfclient doesn't grok a >10000 face index.
		2923	my $res = $facedata->{resource};
		2924
		2925	my $soundconf = delete $res->{"res/sound.conf"};
		2926
		2927	while (my ($name, $info) = each %$res) {
		2928	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2929	my $data;
		2930
		2931	if ($info->{type} & 1) {
		2932	# prepend meta info
		2933
		2934	my $meta = $enc->encode ({
		2935	name => $name,
		2936	%{ $info->{meta} || {} },
		2937	});
		2938
		2939	$data = pack "(w/a*)*", $meta, $info->{data};
		2940	} else {
		2941	$data = $info->{data};
		2942	}
		2943
		2944	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		2945	cf::face::set_type $idx, $info->{type};
		2946
		2947	cf::cede_to_tick;
		2948	}
		2949
		2950	if ($soundconf) {
		2951	$soundconf = $enc->decode (delete $soundconf->{data});
		2952
		2953	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2954	my $sound = $soundconf->{compat}[$_]
		2955	or next;
		2956
		2957	my $face = cf::face::find "sound/$sound->[1]";
		2958	cf::sound::set $sound->[0] => $face;
		2959	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2960	}
		2961
		2962	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2963	my $face = cf::face::find "sound/$v";
		2964	cf::sound::set $k => $face;
		2965	}
		2966	}
		2967	}
		2968
2606	1	2969	1
2607	}	2970	}
2608		2971
		2972	register_exticmd fx_want => sub {
		2973	my ($ns, $want) = @_;
		2974
		2975	while (my ($k, $v) = each %$want) {
		2976	$ns->fx_want ($k, $v);
		2977	}
		2978	};
		2979
2609	sub reload_regions {	2980	sub reload_regions {
		2981	# HACK to clear player env face cache, we need some signal framework
		2982	# for this (global event?)
		2983	%ext::player_env::MUSIC_FACE_CACHE = ();
		2984
2610	load_resource_file "$MAPDIR/regions"	2985	load_resource_file "$MAPDIR/regions"
2611	or die "unable to load regions file\n";	2986	or die "unable to load regions file\n";
		2987
		2988	for (cf::region::list) {
		2989	$_->{match} = qr/$_->{match}/
		2990	if exists $_->{match};
		2991	}
2612	}	2992	}
2613		2993
2614	sub reload_facedata {	2994	sub reload_facedata {
2615	load_facedata "$DATADIR/facedata"	2995	load_facedata "$DATADIR/facedata"
2616	or die "unable to load facedata\n";	2996	or die "unable to load facedata\n";
2617	}	2997	}
2618		2998
2619	sub reload_archetypes {	2999	sub reload_archetypes {
		3000	load_resource_file "$DATADIR/archetypes"
		3001	or die "unable to load archetypes\n";
		3002	#d# NEED to laod twice to resolve forward references
		3003	# this really needs to be done in an extra post-pass
		3004	# (which needs to be synchronous, so solve it differently)
2620	load_resource_file "$DATADIR/archetypes"	3005	load_resource_file "$DATADIR/archetypes"
2621	or die "unable to load archetypes\n";	3006	or die "unable to load archetypes\n";
2622	}	3007	}
2623		3008
2624	sub reload_treasures {	3009	sub reload_treasures {
…		…
2640		3025
2641	sub init {	3026	sub init {
2642	reload_resources;	3027	reload_resources;
2643	}	3028	}
2644		3029
2645	sub cfg_load {	3030	sub reload_config {
2646	open my $fh, "<:utf8", "$CONFDIR/config"	3031	open my $fh, "<:utf8", "$CONFDIR/config"
2647	or return;	3032	or return;
2648		3033
2649	local $/;	3034	local $/;
2650	*CFG = YAML::Syck::Load <$fh>;	3035	*CFG = YAML::Syck::Load <$fh>;
…		…
2670	(async {	3055	(async {
2671	Event::one_event;	3056	Event::one_event;
2672	})->prio (Coro::PRIO_MAX);	3057	})->prio (Coro::PRIO_MAX);
2673	};	3058	};
2674		3059
2675	cfg_load;	3060	reload_config;
2676	db_init;	3061	db_init;
2677	load_extensions;	3062	load_extensions;
2678		3063
2679	$TICK_WATCHER->start;	3064	$TICK_WATCHER->start;
2680	Event::loop;	3065	Event::loop;
…		…
2696	},	3081	},
2697	);	3082	);
2698	}	3083	}
2699	}	3084	}
2700		3085
		3086	sub write_runtime {
		3087	my $runtime = "$LOCALDIR/runtime";
		3088
		3089	# first touch the runtime file to show we are still running:
		3090	# the fsync below can take a very very long time.
		3091
		3092	IO::AIO::aio_utime $runtime, undef, undef;
		3093
		3094	my $guard = cf::lock_acquire "write_runtime";
		3095
		3096	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3097	or return;
		3098
		3099	my $value = $cf::RUNTIME + 90 + 10;
		3100	# 10 is the runtime save interval, for a monotonic clock
		3101	# 60 allows for the watchdog to kill the server.
		3102
		3103	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3104	and return;
		3105
		3106	# always fsync - this file is important
		3107	aio_fsync $fh
		3108	and return;
		3109
		3110	# touch it again to show we are up-to-date
		3111	aio_utime $fh, undef, undef;
		3112
		3113	close $fh
		3114	or return;
		3115
		3116	aio_rename "$runtime~", $runtime
		3117	and return;
		3118
		3119	warn "runtime file written.\n";
		3120
		3121	1
		3122	}
		3123
2701	sub emergency_save() {	3124	sub emergency_save() {
2702	my $freeze_guard = cf::freeze_mainloop;	3125	my $freeze_guard = cf::freeze_mainloop;
2703		3126
2704	warn "enter emergency perl save\n";	3127	warn "enter emergency perl save\n";
2705		3128
…		…
2780	%EXT_CORO = ();	3203	%EXT_CORO = ();
2781		3204
2782	warn "removing commands";	3205	warn "removing commands";
2783	%COMMAND = ();	3206	%COMMAND = ();
2784		3207
2785	warn "removing ext commands";	3208	warn "removing ext/exti commands";
2786	%EXTCMD = ();	3209	%EXTCMD = ();
		3210	%EXTICMD = ();
2787		3211
2788	warn "unloading/nuking all extensions";	3212	warn "unloading/nuking all extensions";
2789	for my $pkg (@EXTS) {	3213	for my $pkg (@EXTS) {
2790	warn "... unloading $pkg";	3214	warn "... unloading $pkg";
2791		3215
…		…
2834	warn "reloading cf.pm";	3258	warn "reloading cf.pm";
2835	require cf;	3259	require cf;
2836	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3260	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2837		3261
2838	warn "loading config and database again";	3262	warn "loading config and database again";
2839	cf::cfg_load;	3263	cf::reload_config;
2840		3264
2841	warn "loading extensions";	3265	warn "loading extensions";
2842	cf::load_extensions;	3266	cf::load_extensions;
2843		3267
2844	warn "reattaching attachments to objects/players";	3268	warn "reattaching attachments to objects/players";

Diff Legend

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