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.265 by root, Fri May 11 08:00:00 2007 UTC vs.
Revision 1.354 by root, Sun Sep 2 12:26:54 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 {
…		…
187	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	197	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
188	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	198	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
189	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	199	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
190	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	200	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
191	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	201	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		202	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
192	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	203	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
193		204
194	# we bless all objects into (empty) derived classes to force a method lookup	205	# we bless all objects into (empty) derived classes to force a method lookup
195	# within the Safe compartment.	206	# within the Safe compartment.
196	for my $pkg (qw(	207	for my $pkg (qw(
197	cf::global cf::attachable	208	cf::global cf::attachable
…		…
205	}	216	}
206		217
207	$Event::DIED = sub {	218	$Event::DIED = sub {
208	warn "error in event callback: @_";	219	warn "error in event callback: @_";
209	};	220	};
		221
		222	#############################################################################
210		223
211	=head2 UTILITY FUNCTIONS	224	=head2 UTILITY FUNCTIONS
212		225
213	=over 4	226	=over 4
214		227
…		…
233	$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;
234	$d	247	$d
235	} || "[unable to dump $_[0]: '$@']";	248	} || "[unable to dump $_[0]: '$@']";
236	}	249	}
237		250
238	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
239
240	=item $ref = cf::from_json $json	251	=item $ref = cf::from_json $json
241		252
242	Converts a JSON string into the corresponding perl data structure.	253	Converts a JSON string into the corresponding perl data structure.
243		254
244	=item $json = cf::to_json $ref	255	=item $json = cf::to_json $ref
245		256
246	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]) }
247		265
248	=item cf::lock_wait $string	266	=item cf::lock_wait $string
249		267
250	Wait until the given lock is available. See cf::lock_acquire.	268	Wait until the given lock is available. See cf::lock_acquire.
251		269
…		…
253		271
254	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
255	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,
256	for example when the coroutine gets canceled), the lock is automatically	274	for example when the coroutine gets canceled), the lock is automatically
257	returned.	275	returned.
		276
		277	Locks are *not* recursive, locking from the same coro twice results in a
		278	deadlocked coro.
258		279
259	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
260	uses map_find and cf::map::load uses map_load).	281	uses map_find and cf::map::load uses map_load).
261		282
262	=item $locked = cf::lock_active $string	283	=item $locked = cf::lock_active $string
…		…
305	};	326	};
306	$TICK_WATCHER->stop;	327	$TICK_WATCHER->stop;
307	$guard	328	$guard
308	}	329	}
309		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
310	=item cf::async { BLOCK }	387	=item cf::async { BLOCK }
311		388
312	Currently the same as Coro::async_pool, meaning you cannot use	389	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	390	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.	391	thing you are allowed to do is call C<prio> on it.
…		…
317		394
318	BEGIN { *async = \&Coro::async_pool }	395	BEGIN { *async = \&Coro::async_pool }
319		396
320	=item cf::sync_job { BLOCK }	397	=item cf::sync_job { BLOCK }
321		398
322	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)
323	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
324	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.
325		403
326	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
327	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
328	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
329	fast or be very important.	407	fast or be very important.
…		…
356	Coro::cede or Event::one_event;	434	Coro::cede or Event::one_event;
357	}	435	}
358		436
359	$time = Event::time - $time;	437	$time = Event::time - $time;
360		438
361	LOG llevError | logBacktrace, "long sync job\n"	439	LOG llevError | logBacktrace, Carp::longmess "long sync job"
362	if $time > $TICK * 0.5;	440	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
363		441
364	$tick_start += $time; # do not account sync jobs to server load	442	$tick_start += $time; # do not account sync jobs to server load
365		443
366	wantarray ? @res : $res[0]	444	wantarray ? @res : $res[0]
367	} else {	445	} else {
…		…
389	$EXT_CORO{$coro+0} = $coro;	467	$EXT_CORO{$coro+0} = $coro;
390		468
391	$coro	469	$coro
392	}	470	}
393		471
394	sub write_runtime {	472	=item fork_call { }, $args
395	my $runtime = "$LOCALDIR/runtime";
396		473
397	# first touch the runtime file to show we are still running:	474	Executes the given code block with the given arguments in a seperate
398	# 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.
399		478
400	if (my $fh = aio_open $runtime, O_WRONLY, 0) {	479	=cut
401	utime undef, undef, $fh;
402	}
403		480
404	my $guard = cf::lock_acquire "write_runtime";	481	sub fork_call(&@) {
		482	my ($cb, @args) = @_;
405		483
406	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	484	# we seemingly have to make a local copy of the whole thing,
407	or return;	485	# otherwise perl prematurely frees the stuff :/
		486	# TODO: investigate and fix (liekly this will be rather laborious)
408		487
409	my $value = $cf::RUNTIME + 90 + 10;	488	my @res = Coro::Util::fork_eval {
410	# 10 is the runtime save interval, for a monotonic clock	489	reset_signals;
411	# 60 allows for the watchdog to kill the server.	490	&$cb
		491	}, @args;
412		492
413	(aio_write $fh, 0, (length $value), $value, 0) <= 0	493	wantarray ? @res : $res[-1]
414	and return;	494	}
415		495
416	# always fsync - this file is important	496	=item $value = cf::db_get $family => $key
417	aio_fsync $fh
418	and return;
419		497
420	# touch it again to show we are up-to-date	498	Returns a single value from the environment database.
421	utime undef, undef, $fh;
422		499
423	close $fh	500	=item cf::db_put $family => $key => $value
424	or return;
425		501
426	aio_rename "$runtime~", $runtime	502	Stores the given C<$value> in the family. It can currently store binary
427	and return;	503	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
428		504
429	warn "runtime file written.\n";#d#	505	=cut
430		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	};
431	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"
432	}	610	}
433		611
434	=item cf::datalog type => key => value, ...	612	=item cf::datalog type => key => value, ...
435		613
436	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.
…		…
454	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")
455	to it. All such attachable objects support the following methods.	633	to it. All such attachable objects support the following methods.
456		634
457	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>
458	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
459	crossfire+).	637	Crossfire TRT).
460		638
461	=over 4	639	=over 4
462		640
463	=item $attachable->attach ($attachment, key => $value...)	641	=item $attachable->attach ($attachment, key => $value...)
464		642
…		…
627	$registry = $CB_TYPE[$object_type] ||= [];	805	$registry = $CB_TYPE[$object_type] ||= [];
628		806
629	} elsif ($type eq "subtype") {	807	} elsif ($type eq "subtype") {
630	defined $object_type or Carp::croak "subtype specified without type";	808	defined $object_type or Carp::croak "subtype specified without type";
631	my $object_subtype = shift @arg;	809	my $object_subtype = shift @arg;
632	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	810	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
633		811
634	} elsif ($type eq "package") {	812	} elsif ($type eq "package") {
635	my $pkg = shift @arg;	813	my $pkg = shift @arg;
636		814
637	while (my ($name, $id) = each %cb_id) {	815	while (my ($name, $id) = each %cb_id) {
…		…
666	_attach $registry, $klass, @attach;	844	_attach $registry, $klass, @attach;
667	}	845	}
668		846
669	$obj->{$name} = \%arg;	847	$obj->{$name} = \%arg;
670	} else {	848	} else {
671	warn "object uses attachment '$name' that is not available, postponing.\n";	849	warn "object uses attachment '$name' which is not available, postponing.\n";
672	}	850	}
673		851
674	$obj->{_attachment}{$name} = undef;	852	$obj->{_attachment}{$name} = undef;
675	}	853	}
676		854
…		…
678	if (ref $_[0]) {	856	if (ref $_[0]) {
679	_object_attach @_;	857	_object_attach @_;
680	} else {	858	} else {
681	_attach shift->_attach_registry, @_;	859	_attach shift->_attach_registry, @_;
682	}	860	}
		861	_recalc_want;
683	};	862	};
684		863
685	# all those should be optimised	864	# all those should be optimised
686	sub cf::attachable::detach {	865	sub cf::attachable::detach {
687	my ($obj, $name) = @_;	866	my ($obj, $name) = @_;
…		…
690	delete $obj->{_attachment}{$name};	869	delete $obj->{_attachment}{$name};
691	reattach ($obj);	870	reattach ($obj);
692	} else {	871	} else {
693	Carp::croak "cannot, currently, detach class attachments";	872	Carp::croak "cannot, currently, detach class attachments";
694	}	873	}
		874	_recalc_want;
695	};	875	};
696		876
697	sub cf::attachable::attached {	877	sub cf::attachable::attached {
698	my ($obj, $name) = @_;	878	my ($obj, $name) = @_;
699		879
…		…
714	";	894	";
715	die if $@;	895	die if $@;
716	}	896	}
717		897
718	our $override;	898	our $override;
719	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?
720		900
721	sub override {	901	sub override {
722	$override = 1;	902	$override = 1;
723	@invoke_results = ();	903	@INVOKE_RESULTS = (@_);
724	}	904	}
725		905
726	sub do_invoke {	906	sub do_invoke {
727	my $event = shift;	907	my $event = shift;
728	my $callbacks = shift;	908	my $callbacks = shift;
729		909
730	@invoke_results = ();	910	@INVOKE_RESULTS = ();
731		911
732	local $override;	912	local $override;
733		913
734	for (@$callbacks) {	914	for (@$callbacks) {
735	eval { &{$_->[1]} };	915	eval { &{$_->[1]} };
…		…
752		932
753	Generate an object-specific event with the given arguments.	933	Generate an object-specific event with the given arguments.
754		934
755	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
756	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
757	results (if you must, access C<@cf::invoke_results> directly).	937	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
758		938
759	=back	939	=back
760		940
761	=cut	941	=cut
762		942
763	#############################################################################	943	#############################################################################
764	# 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	}
765		956
766	sub reattach {	957	sub reattach {
767	# basically do the same as instantiate, without calling instantiate	958	# basically do the same as instantiate, without calling instantiate
768	my ($obj) = @_;	959	my ($obj) = @_;
769		960
…		…
872	or return;	1063	or return;
873	$av = eval { (Storable::thaw $av)->{objs} };	1064	$av = eval { (Storable::thaw $av)->{objs} };
874	}	1065	}
875		1066
876	warn sprintf "loading %s (%d)\n",	1067	warn sprintf "loading %s (%d)\n",
877	$filename, length $data, scalar @{$av || []};#d#	1068	$filename, length $data, scalar @{$av || []};
878	return ($data, $av);	1069	return ($data, $av);
879	}	1070	}
		1071
		1072	=head2 COMMAND CALLBACKS
		1073
		1074	=over 4
		1075
		1076	=cut
880		1077
881	#############################################################################	1078	#############################################################################
882	# command handling &c	1079	# command handling &c
883		1080
884	=item cf::register_command $name => \&callback($ob,$args);	1081	=item cf::register_command $name => \&callback($ob,$args);
…		…
897	push @{ $COMMAND{$name} }, [$caller, $cb];	1094	push @{ $COMMAND{$name} }, [$caller, $cb];
898	}	1095	}
899		1096
900	=item cf::register_extcmd $name => \&callback($pl,$packet);	1097	=item cf::register_extcmd $name => \&callback($pl,$packet);
901		1098
902	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.
903		1104
904	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
905	called.	1106	called.
906		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
907	=cut	1119	=cut
908		1120
909	sub register_extcmd {	1121	sub register_extcmd {
910	my ($name, $cb) = @_;	1122	my ($name, $cb) = @_;
911		1123
912	$EXTCMD{$name} = $cb;	1124	$EXTCMD{$name} = $cb;
		1125	}
		1126
		1127	sub register_exticmd {
		1128	my ($name, $cb) = @_;
		1129
		1130	$EXTICMD{$name} = $cb;
913	}	1131	}
914		1132
915	cf::player->attach (	1133	cf::player->attach (
916	on_command => sub {	1134	on_command => sub {
917	my ($pl, $name, $params) = @_;	1135	my ($pl, $name, $params) = @_;
…		…
926	cf::override;	1144	cf::override;
927	},	1145	},
928	on_extcmd => sub {	1146	on_extcmd => sub {
929	my ($pl, $buf) = @_;	1147	my ($pl, $buf) = @_;
930		1148
931	my $msg = eval { from_json $buf };	1149	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
932		1150
933	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
934	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1159	if (my $cb = $EXTCMD{$type}) {
935	if (my %reply = $cb->($pl, $msg)) {	1160	@reply = $cb->($pl, @payload);
936	$pl->ext_reply ($msg->{msgid}, %reply);
937	}
938	}	1161	}
		1162
		1163	$pl->ext_reply ($reply, @reply)
		1164	if $reply;
		1165
939	} else {	1166	} else {
940	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1167	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
941	}	1168	}
942		1169
943	cf::override;	1170	cf::override;
944	},	1171	},
945	);	1172	);
946		1173
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 {	1174	sub load_extensions {
		1175	cf::sync_job {
		1176	my %todo;
		1177
982	for my $ext (<$LIBDIR/*.ext>) {	1178	for my $path (<$LIBDIR/*.ext>) {
983	next unless -r $ext;	1179	next unless -r $path;
984	eval {	1180
985	load_extension $ext;	1181	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1182	my $base = $1;
		1183	my $pkg = $1;
		1184	$pkg =~ s/[^[:word:]]/_/g;
		1185	$pkg = "ext::$pkg";
		1186
		1187	open my $fh, "<:utf8", $path
		1188	or die "$path: $!";
		1189
		1190	my $source = do { local $/; <$fh> };
		1191
		1192	my %ext = (
		1193	path => $path,
		1194	base => $base,
		1195	pkg => $pkg,
		1196	);
		1197
		1198	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1199	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1200
		1201	$ext{source} =
		1202	"package $pkg; use strict; use utf8;\n"
		1203	. "#line 1 \"$path\"\n{\n"
		1204	. $source
		1205	. "\n};\n1";
		1206
		1207	$todo{$base} = \%ext;
		1208	}
		1209
		1210	my %done;
		1211	while (%todo) {
		1212	my $progress;
		1213
		1214	while (my ($k, $v) = each %todo) {
		1215	for (split /,\s*/, $v->{meta}{depends}) {
		1216	goto skip
		1217	unless exists $done{$_};
		1218	}
		1219
		1220	warn "... loading '$k' into '$v->{pkg}'\n";
		1221
		1222	unless (eval $v->{source}) {
		1223	my $msg = $@ ? "$v->{path}: $@\n"
		1224	: "$v->{base}: extension inactive.\n";
		1225
		1226	if (exists $v->{meta}{mandatory}) {
		1227	warn $msg;
		1228	warn "mandatory extension failed to load, exiting.\n";
		1229	exit 1;
		1230	}
		1231
		1232	warn $msg;
		1233	}
		1234
		1235	$done{$k} = delete $todo{$k};
		1236	push @EXTS, $v->{pkg};
		1237	$progress = 1;
986	1	1238	}
987	} or warn "$ext not loaded: $@";	1239
		1240	skip:
		1241	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1242	unless $progress;
		1243	}
988	}	1244	};
989	}	1245	}
990		1246
991	#############################################################################	1247	#############################################################################
		1248
		1249	=back
992		1250
993	=head2 CORE EXTENSIONS	1251	=head2 CORE EXTENSIONS
994		1252
995	Functions and methods that extend core crossfire objects.	1253	Functions and methods that extend core crossfire objects.
996		1254
…		…
1067		1325
1068	aio_mkdir playerdir $pl, 0770;	1326	aio_mkdir playerdir $pl, 0770;
1069	$pl->{last_save} = $cf::RUNTIME;	1327	$pl->{last_save} = $cf::RUNTIME;
1070		1328
1071	$pl->save_pl ($path);	1329	$pl->save_pl ($path);
1072	Coro::cede;	1330	cf::cede_to_tick;
1073	}	1331	}
1074		1332
1075	sub new($) {	1333	sub new($) {
1076	my ($login) = @_;	1334	my ($login) = @_;
1077		1335
…		…
1081	$self->{deny_save} = 1;	1339	$self->{deny_save} = 1;
1082		1340
1083	$cf::PLAYER{$login} = $self;	1341	$cf::PLAYER{$login} = $self;
1084		1342
1085	$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 (@_);
1086	}	1354	}
1087		1355
1088	=item $pl->quit_character	1356	=item $pl->quit_character
1089		1357
1090	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
…		…
1145	or return [];	1413	or return [];
1146		1414
1147	my @logins;	1415	my @logins;
1148		1416
1149	for my $login (@$dirs) {	1417	for my $login (@$dirs) {
		1418	my $path = path $login;
		1419
		1420	# a .pst is a dead give-away for a valid player
		1421	unless (-e "$path.pst") {
1150	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1422	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1151	aio_read $fh, 0, 512, my $buf, 0 or next;	1423	aio_read $fh, 0, 512, my $buf, 0 or next;
1152	$buf !~ /^password -------------$/m or next; # official not-valid tag	1424	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1425	}
1153		1426
1154	utf8::decode $login;	1427	utf8::decode $login;
1155	push @logins, $login;	1428	push @logins, $login;
1156	}	1429	}
1157		1430
…		…
1184	}	1457	}
1185		1458
1186	\@paths	1459	\@paths
1187	}	1460	}
1188		1461
		1462	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1463
		1464	Expand crossfire pod fragments into protocol xml.
		1465
		1466	=cut
		1467
		1468	sub expand_cfpod {
		1469	((my $self), (local $_)) = @_;
		1470
		1471	# escape & and <
		1472	s/&/&amp;/g;
		1473	s/(?<![BIUGHT])</&lt;/g;
		1474
		1475	# this is buggy, it needs to properly take care of nested <'s
		1476
		1477	1 while
		1478	# replace B<>, I<>, U<> etc.
		1479	s/B<([^\>]*)>/<b>$1<\/b>/
		1480	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1481	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1482	|| s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
		1483	# replace G<male|female> tags
		1484	|| s{G<([^>|]*)\|([^>]*)>}{
		1485	$self->gender ? $2 : $1
		1486	}ge
		1487	# replace H<hint text>
		1488	|| s{H<([^\>]*)>}
		1489	{
		1490	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1491	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1492	"")
		1493	[$self->{hintmode}]
		1494	}ge;
		1495
		1496	# create single paragraphs (very hackish)
		1497	s/(?<=\S)\n(?=\w)/ /g;
		1498
		1499	# compress some whitespace
		1500	s/\s+\n/\n/g; # ws line-ends
		1501	s/\n\n+/\n/g; # double lines
		1502	s/^\n+//; # beginning lines
		1503	s/\n+$//; # ending lines
		1504
		1505	$_
		1506	}
		1507
		1508	sub hintmode {
		1509	$_[0]{hintmode} = $_[1] if @_ > 1;
		1510	$_[0]{hintmode}
		1511	}
		1512
1189	=item $player->ext_reply ($msgid, %msg)	1513	=item $player->ext_reply ($msgid, @msg)
1190		1514
1191	Sends an ext reply to the player.	1515	Sends an ext reply to the player.
1192		1516
1193	=cut	1517	=cut
1194		1518
1195	sub ext_reply($$%) {	1519	sub ext_reply($$@) {
1196	my ($self, $id, %msg) = @_;	1520	my ($self, $id, @msg) = @_;
1197		1521
1198	$msg{msgid} = $id;	1522	$self->ns->ext_reply ($id, @msg)
1199
1200	$self->send ("ext " . cf::to_json \%msg);
1201	}	1523	}
1202		1524
1203	=item $player->ext_event ($type, %msg)	1525	=item $player->ext_msg ($type, @msg)
1204		1526
1205	Sends an ext event to the client.	1527	Sends an ext event to the client.
1206		1528
1207	=cut	1529	=cut
1208		1530
1209	sub ext_event($$%) {	1531	sub ext_msg($$@) {
1210	my ($self, $type, %msg) = @_;	1532	my ($self, $type, @msg) = @_;
1211		1533
1212	$self->ns->ext_event ($type, %msg);	1534	$self->ns->ext_msg ($type, @msg);
1213	}	1535	}
1214		1536
1215	=head3 cf::region	1537	=head3 cf::region
1216		1538
1217	=over 4	1539	=over 4
…		…
1220		1542
1221	package cf::region;	1543	package cf::region;
1222		1544
1223	=item cf::region::find_by_path $path	1545	=item cf::region::find_by_path $path
1224		1546
1225	Tries to decuce the probable region for a map knowing only its path.	1547	Tries to decuce the likely region for a map knowing only its path.
1226		1548
1227	=cut	1549	=cut
1228		1550
1229	sub find_by_path($) {	1551	sub find_by_path($) {
1230	my ($path) = @_;	1552	my ($path) = @_;
1231		1553
1232	my ($match, $specificity);	1554	my ($match, $specificity);
1233		1555
1234	for my $region (list) {	1556	for my $region (list) {
1235	if ($region->match && $path =~ $region->match) {	1557	if ($region->{match} && $path =~ $region->{match}) {
1236	($match, $specificity) = ($region, $region->specificity)	1558	($match, $specificity) = ($region, $region->specificity)
1237	if $region->specificity > $specificity;	1559	if $region->specificity > $specificity;
1238	}	1560	}
1239	}	1561	}
1240		1562
…		…
1304	my ($self, $merge) = @_;	1626	my ($self, $merge) = @_;
1305		1627
1306	# we have to keep some variables in memory intact	1628	# we have to keep some variables in memory intact
1307	local $self->{path};	1629	local $self->{path};
1308	local $self->{load_path};	1630	local $self->{load_path};
1309	local $self->{deny_save};
1310	local $self->{deny_reset};
1311		1631
1312	$self->SUPER::thawer_merge ($merge);	1632	$self->SUPER::thawer_merge ($merge);
1313	}	1633	}
1314		1634
1315	sub normalise {	1635	sub normalise {
…		…
1362	$self->init; # pass $1 etc.	1682	$self->init; # pass $1 etc.
1363	return $self;	1683	return $self;
1364	}	1684	}
1365	}	1685	}
1366		1686
1367	Carp::carp "unable to resolve path '$path' (base '$base').";	1687	Carp::cluck "unable to resolve path '$path' (base '$base').";
1368	()	1688	()
1369	}	1689	}
1370		1690
1371	sub init {	1691	sub init {
1372	my ($self) = @_;	1692	my ($self) = @_;
…		…
1413	sub change_all_map_light {	1733	sub change_all_map_light {
1414	my ($change) = @_;	1734	my ($change) = @_;
1415		1735
1416	$_->change_map_light ($change)	1736	$_->change_map_light ($change)
1417	for grep $_->outdoor, values %cf::MAP;	1737	for grep $_->outdoor, values %cf::MAP;
		1738	}
		1739
		1740	sub decay_objects {
		1741	my ($self) = @_;
		1742
		1743	return if $self->{deny_reset};
		1744
		1745	$self->do_decay_objects;
1418	}	1746	}
1419		1747
1420	sub unlink_save {	1748	sub unlink_save {
1421	my ($self) = @_;	1749	my ($self) = @_;
1422		1750
…		…
1480	$self->load_header_orig	1808	$self->load_header_orig
1481	or return;	1809	or return;
1482	$self->prepare_orig;	1810	$self->prepare_orig;
1483	}	1811	}
1484		1812
		1813	$self->{deny_reset} = 1
		1814	if $self->no_reset;
		1815
1485	$self->default_region (cf::region::find_by_path $self->{path})	1816	$self->default_region (cf::region::find_by_path $self->{path})
1486	unless $self->default_region;	1817	unless $self->default_region;
1487		1818
1488	1	1819	1
1489	}	1820	}
…		…
1504	$map->{last_save} = $cf::RUNTIME;	1835	$map->{last_save} = $cf::RUNTIME;
1505		1836
1506	$map->load_header	1837	$map->load_header
1507	or return;	1838	or return;
1508		1839
1509	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1840	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1510	# doing this can freeze the server in a sync job, obviously	1841	# doing this can freeze the server in a sync job, obviously
1511	#$cf::WAIT_FOR_TICK->wait;	1842	#$cf::WAIT_FOR_TICK->wait;
1512	$map->reset;	1843	$map->reset;
1513	undef $guard;	1844	undef $guard;
1514	return find $path;	1845	return find $path;
…		…
1527	local $self->{deny_reset} = 1; # loading can take a long time	1858	local $self->{deny_reset} = 1; # loading can take a long time
1528		1859
1529	my $path = $self->{path};	1860	my $path = $self->{path};
1530		1861
1531	{	1862	{
		1863	my $guard1 = cf::lock_acquire "map_data:$path";
1532	my $guard = cf::lock_acquire "map_load:$path";	1864	my $guard2 = cf::lock_acquire "map_load:$path";
1533		1865
1534	return if $self->in_memory != cf::MAP_SWAPPED;	1866	return if $self->in_memory != cf::MAP_SWAPPED;
1535		1867
1536	$self->in_memory (cf::MAP_LOADING);	1868	$self->in_memory (cf::MAP_LOADING);
1537		1869
1538	$self->alloc;	1870	$self->alloc;
1539		1871
1540	$self->pre_load;	1872	$self->pre_load;
1541	Coro::cede;	1873	cf::cede_to_tick;
1542		1874
1543	$self->_load_objects ($self->{load_path}, 1)	1875	$self->_load_objects ($self->{load_path}, 1)
1544	or return;	1876	or return;
1545		1877
1546	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1878	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
…		…
1552	$self->clear_unique_items;	1884	$self->clear_unique_items;
1553	$self->_load_objects ($uniq, 0);	1885	$self->_load_objects ($uniq, 0);
1554	}	1886	}
1555	}	1887	}
1556		1888
1557	Coro::cede;	1889	cf::cede_to_tick;
1558	# now do the right thing for maps	1890	# now do the right thing for maps
1559	$self->link_multipart_objects;	1891	$self->link_multipart_objects;
1560	$self->difficulty ($self->estimate_difficulty)	1892	$self->difficulty ($self->estimate_difficulty)
1561	unless $self->difficulty;	1893	unless $self->difficulty;
1562	Coro::cede;	1894	cf::cede_to_tick;
1563		1895
1564	unless ($self->{deny_activate}) {	1896	unless ($self->{deny_activate}) {
1565	$self->decay_objects;	1897	$self->decay_objects;
1566	$self->fix_auto_apply;	1898	$self->fix_auto_apply;
1567	$self->update_buttons;	1899	$self->update_buttons;
1568	Coro::cede;	1900	cf::cede_to_tick;
1569	$self->set_darkness_map;	1901	$self->set_darkness_map;
1570	Coro::cede;	1902	cf::cede_to_tick;
1571	$self->activate;	1903	$self->activate;
1572	}	1904	}
		1905
		1906	$self->{last_save} = $cf::RUNTIME;
		1907	$self->last_access ($cf::RUNTIME);
1573		1908
1574	$self->in_memory (cf::MAP_IN_MEMORY);	1909	$self->in_memory (cf::MAP_IN_MEMORY);
1575	}	1910	}
1576		1911
1577	$self->post_load;	1912	$self->post_load;
…		…
1581	my ($self, $ob) = @_;	1916	my ($self, $ob) = @_;
1582		1917
1583	return find "~" . $ob->name . "/" . $self->{path}	1918	return find "~" . $ob->name . "/" . $self->{path}
1584	if $self->per_player;	1919	if $self->per_player;
1585		1920
		1921	# return find "?party/" . $ob->name . "/" . $self->{path}
		1922	# if $self->per_party;
		1923
1586	$self	1924	$self
1587	}	1925	}
1588		1926
1589	# find and load all maps in the 3x3 area around a map	1927	# find and load all maps in the 3x3 area around a map
1590	sub load_diag {	1928	sub load_neighbours {
1591	my ($map) = @_;	1929	my ($map) = @_;
1592		1930
1593	my @diag; # diagonal neighbours	1931	my @neigh; # diagonal neighbours
1594		1932
1595	for (0 .. 3) {	1933	for (0 .. 3) {
1596	my $neigh = $map->tile_path ($_)	1934	my $neigh = $map->tile_path ($_)
1597	or next;	1935	or next;
1598	$neigh = find $neigh, $map	1936	$neigh = find $neigh, $map
1599	or next;	1937	or next;
1600	$neigh->load;	1938	$neigh->load;
1601		1939
		1940	push @neigh,
1602	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	1941	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1603	[$neigh->tile_path (($_ + 1) % 4), $neigh];	1942	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1604	}	1943	}
1605		1944
1606	for (@diag) {	1945	for (grep defined $_->[0], @neigh) {
		1946	my ($path, $origin) = @$_;
1607	my $neigh = find @$_	1947	my $neigh = find $path, $origin
1608	or next;	1948	or next;
1609	$neigh->load;	1949	$neigh->load;
1610	}	1950	}
1611	}	1951	}
1612		1952
…		…
1617	}	1957	}
1618		1958
1619	sub do_load_sync {	1959	sub do_load_sync {
1620	my ($map) = @_;	1960	my ($map) = @_;
1621		1961
		1962	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		1963	if $Coro::current == $Coro::main;
		1964
1622	cf::sync_job { $map->load };	1965	cf::sync_job { $map->load };
1623	}	1966	}
1624		1967
1625	our %MAP_PREFETCH;	1968	our %MAP_PREFETCH;
1626	our $MAP_PREFETCHER = undef;	1969	our $MAP_PREFETCHER = undef;
1627		1970
1628	sub find_async {	1971	sub find_async {
1629	my ($path, $origin) = @_;	1972	my ($path, $origin, $load) = @_;
1630		1973
1631	$path = normalise $path, $origin && $origin->{path};	1974	$path = normalise $path, $origin && $origin->{path};
1632		1975
1633	if (my $map = $cf::MAP{$path}) {	1976	if (my $map = $cf::MAP{$path}) {
1634	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	1977	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1635	}	1978	}
1636		1979
1637	undef $MAP_PREFETCH{$path};	1980	$MAP_PREFETCH{$path} |= $load;
		1981
1638	$MAP_PREFETCHER ||= cf::async {	1982	$MAP_PREFETCHER ||= cf::async {
1639	while (%MAP_PREFETCH) {	1983	while (%MAP_PREFETCH) {
1640	for my $path (keys %MAP_PREFETCH) {	1984	while (my ($k, $v) = each %MAP_PREFETCH) {
1641	my $map = find $path	1985	if (my $map = find $k) {
1642	or next;
1643	$map->load;	1986	$map->load if $v;
		1987	}
1644		1988
1645	delete $MAP_PREFETCH{$path};	1989	delete $MAP_PREFETCH{$k};
1646	}	1990	}
1647	}	1991	}
1648	undef $MAP_PREFETCHER;	1992	undef $MAP_PREFETCHER;
1649	};	1993	};
1650	$MAP_PREFETCHER->prio (6);	1994	$MAP_PREFETCHER->prio (6);
…		…
1653	}	1997	}
1654		1998
1655	sub save {	1999	sub save {
1656	my ($self) = @_;	2000	my ($self) = @_;
1657		2001
1658	my $lock = cf::lock_acquire "map_data:" . $self->path;	2002	my $lock = cf::lock_acquire "map_data:$self->{path}";
1659		2003
1660	$self->{last_save} = $cf::RUNTIME;	2004	$self->{last_save} = $cf::RUNTIME;
1661		2005
1662	return unless $self->dirty;	2006	return unless $self->dirty;
1663		2007
…		…
1686	my ($self) = @_;	2030	my ($self) = @_;
1687		2031
1688	# save first because save cedes	2032	# save first because save cedes
1689	$self->save;	2033	$self->save;
1690		2034
1691	my $lock = cf::lock_acquire "map_data:" . $self->path;	2035	my $lock = cf::lock_acquire "map_data:$self->{path}";
1692		2036
1693	return if $self->players;	2037	return if $self->players;
1694	return if $self->in_memory != cf::MAP_IN_MEMORY;	2038	return if $self->in_memory != cf::MAP_IN_MEMORY;
1695	return if $self->{deny_save};	2039	return if $self->{deny_save};
1696		2040
…		…
1700		2044
1701	sub reset_at {	2045	sub reset_at {
1702	my ($self) = @_;	2046	my ($self) = @_;
1703		2047
1704	# TODO: safety, remove and allow resettable per-player maps	2048	# 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};	2049	return 1e99 if $self->{deny_reset};
1707		2050
1708	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2051	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1709	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2052	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1710		2053
…		…
1721	my ($self) = @_;	2064	my ($self) = @_;
1722		2065
1723	my $lock = cf::lock_acquire "map_data:$self->{path}";	2066	my $lock = cf::lock_acquire "map_data:$self->{path}";
1724		2067
1725	return if $self->players;	2068	return if $self->players;
1726	return if $self->isa ("ext::map_per_player");#d#
1727		2069
1728	warn "resetting map ", $self->path;#d#	2070	warn "resetting map ", $self->path;
1729		2071
1730	$self->in_memory (cf::MAP_SWAPPED);	2072	$self->in_memory (cf::MAP_SWAPPED);
1731		2073
1732	# need to save uniques path	2074	# need to save uniques path
1733	unless ($self->{deny_save}) {	2075	unless ($self->{deny_save}) {
…		…
1750	my $nuke_counter = "aaaa";	2092	my $nuke_counter = "aaaa";
1751		2093
1752	sub nuke {	2094	sub nuke {
1753	my ($self) = @_;	2095	my ($self) = @_;
1754		2096
		2097	{
		2098	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2099
1755	delete $cf::MAP{$self->path};	2100	delete $cf::MAP{$self->path};
1756		2101
1757	$self->unlink_save;	2102	$self->unlink_save;
1758		2103
1759	bless $self, "cf::map";	2104	bless $self, "cf::map";
1760	delete $self->{deny_reset};	2105	delete $self->{deny_reset};
1761	$self->{deny_save} = 1;	2106	$self->{deny_save} = 1;
1762	$self->reset_timeout (1);	2107	$self->reset_timeout (1);
1763	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2108	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1764		2109
1765	$cf::MAP{$self->path} = $self;	2110	$cf::MAP{$self->path} = $self;
		2111	}
1766		2112
1767	$self->reset; # polite request, might not happen	2113	$self->reset; # polite request, might not happen
		2114	}
		2115
		2116	=item $maps = cf::map::tmp_maps
		2117
		2118	Returns an arrayref with all map paths of currently instantiated and saved
		2119	maps. May block.
		2120
		2121	=cut
		2122
		2123	sub tmp_maps() {
		2124	[
		2125	map {
		2126	utf8::decode $_;
		2127	/\.map$/
		2128	? normalise $_
		2129	: ()
		2130	} @{ aio_readdir $TMPDIR or [] }
		2131	]
		2132	}
		2133
		2134	=item $maps = cf::map::random_maps
		2135
		2136	Returns an arrayref with all map paths of currently instantiated and saved
		2137	random maps. May block.
		2138
		2139	=cut
		2140
		2141	sub random_maps() {
		2142	[
		2143	map {
		2144	utf8::decode $_;
		2145	/\.map$/
		2146	? normalise "?random/$_"
		2147	: ()
		2148	} @{ aio_readdir $RANDOMDIR or [] }
		2149	]
1768	}	2150	}
1769		2151
1770	=item cf::map::unique_maps	2152	=item cf::map::unique_maps
1771		2153
1772	Returns an arrayref of paths of all shared maps that have	2154	Returns an arrayref of paths of all shared maps that have
1773	instantiated unique items. May block.	2155	instantiated unique items. May block.
1774		2156
1775	=cut	2157	=cut
1776		2158
1777	sub unique_maps() {	2159	sub unique_maps() {
1778	my $files = aio_readdir $UNIQUEDIR	2160	[
1779	or return;	2161	map {
1780
1781	my @paths;
1782
1783	for (@$files) {
1784	utf8::decode $_;	2162	utf8::decode $_;
1785	next if /\.pst$/;	2163	/\.map$/
1786	next unless /^$PATH_SEP/o;	2164	? normalise $_
1787		2165	: ()
1788	push @paths, cf::map::normalise $_;	2166	} @{ aio_readdir $UNIQUEDIR or [] }
1789	}	2167	]
1790
1791	\@paths
1792	}	2168	}
1793		2169
1794	package cf;	2170	package cf;
1795		2171
1796	=back	2172	=back
…		…
1842		2218
1843	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2219	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1844		2220
1845	if ($self->{record_replies}) {	2221	if ($self->{record_replies}) {
1846	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2222	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2223
1847	} else {	2224	} else {
		2225	my $pl = $self->contr;
		2226
		2227	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2228	my $dialog = $pl->{npc_dialog};
		2229	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2230
		2231	} else {
1848	$msg = $npc->name . " says: $msg" if $npc;	2232	$msg = $npc->name . " says: $msg" if $npc;
1849	$self->message ($msg, $flags);	2233	$self->message ($msg, $flags);
		2234	}
1850	}	2235	}
		2236	}
		2237
		2238	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2239
		2240	=cut
		2241
		2242	sub cf::object::send_msg {
		2243	my $pl = shift->contr
		2244	or return;
		2245	$pl->send_msg (@_);
1851	}	2246	}
1852		2247
1853	=item $player_object->may ("access")	2248	=item $player_object->may ("access")
1854		2249
1855	Returns wether the given player is authorized to access resource "access"	2250	Returns wether the given player is authorized to access resource "access"
…		…
1902	$self->deactivate_recursive;	2297	$self->deactivate_recursive;
1903		2298
1904	return if UNIVERSAL::isa $self->map, "ext::map_link";	2299	return if UNIVERSAL::isa $self->map, "ext::map_link";
1905		2300
1906	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2301	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1907	if $self->map;	2302	if $self->map && $self->map->{path} ne "{link}";
1908		2303
1909	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2304	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1910	}	2305	}
1911		2306
1912	sub cf::object::player::leave_link {	2307	sub cf::object::player::leave_link {
1913	my ($self, $map, $x, $y) = @_;	2308	my ($self, $map, $x, $y) = @_;
		2309
		2310	return unless $self->contr->active;
1914		2311
1915	my $link_pos = delete $self->{_link_pos};	2312	my $link_pos = delete $self->{_link_pos};
1916		2313
1917	unless ($map) {	2314	unless ($map) {
1918	# restore original map position	2315	# restore original map position
…		…
1932	# use -1 or undef as default coordinates, not 0, 0	2329	# use -1 or undef as default coordinates, not 0, 0
1933	($x, $y) = ($map->enter_x, $map->enter_y)	2330	($x, $y) = ($map->enter_x, $map->enter_y)
1934	if $x <=0 && $y <= 0;	2331	if $x <=0 && $y <= 0;
1935		2332
1936	$map->load;	2333	$map->load;
1937	$map->load_diag;	2334	$map->load_neighbours;
1938		2335
1939	return unless $self->contr->active;	2336	return unless $self->contr->active;
1940	$self->activate_recursive;	2337	$self->activate_recursive;
1941		2338
1942	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2339	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1943	$self->enter_map ($map, $x, $y);	2340	$self->enter_map ($map, $x, $y);
1944	}	2341	}
1945		2342
1946	cf::player->attach (	2343	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1947	on_logout => sub {
1948	my ($pl) = @_;
1949		2344
1950	# abort map switching before logout	2345	Moves the player to the given map-path and coordinates by first freezing
1951	if ($pl->ob->{_link_pos}) {	2346	her, loading and preparing them map, calling the provided $check callback
1952	cf::sync_job {	2347	that has to return the map if sucecssful, and then unfreezes the player on
1953	$pl->ob->leave_link	2348	the new (success) or old (failed) map position. In either case, $done will
1954	};	2349	be called at the end of this process.
1955	}
1956	},
1957	on_login => sub {
1958	my ($pl) = @_;
1959		2350
1960	# try to abort aborted map switching on player login :)
1961	# should happen only on crashes
1962	if ($pl->ob->{_link_pos}) {
1963	$pl->ob->enter_link;
1964	(async {
1965	$pl->ob->reply (undef,
1966	"There was an internal problem at your last logout, "
1967	. "the server will try to bring you to your intended destination in a second.",
1968	cf::NDI_RED);
1969	# we need this sleep as the login has a concurrent enter_exit running
1970	# and this sleep increases chances of the player not ending up in scorn
1971	Coro::Timer::sleep 1;
1972	$pl->ob->leave_link;
1973	})->prio (2);
1974	}
1975	},
1976	);
1977
1978	=item $player_object->goto ($path, $x, $y)
1979
1980	=cut	2351	=cut
		2352
		2353	our $GOTOGEN;
1981		2354
1982	sub cf::object::player::goto {	2355	sub cf::object::player::goto {
1983	my ($self, $path, $x, $y) = @_;	2356	my ($self, $path, $x, $y, $check, $done) = @_;
		2357
		2358	# do generation counting so two concurrent goto's will be executed in-order
		2359	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1984		2360
1985	$self->enter_link;	2361	$self->enter_link;
1986		2362
1987	(async {	2363	(async {
1988	my $map = eval {	2364	my $map = eval {
1989	my $map = cf::map::find $path;	2365	my $map = cf::map::find $path;
		2366
		2367	if ($map) {
1990	$map = $map->customise_for ($self) if $map;	2368	$map = $map->customise_for ($self);
		2369	$map = $check->($map) if $check && $map;
		2370	} else {
		2371	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2372	}
		2373
1991	$map	2374	$map
		2375	};
		2376
		2377	if ($@) {
		2378	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2379	LOG llevError | logBacktrace, Carp::longmess $@;
1992	} or	2380	}
1993	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1994		2381
		2382	if ($gen == $self->{_goto_generation}) {
		2383	delete $self->{_goto_generation};
1995	$self->leave_link ($map, $x, $y);	2384	$self->leave_link ($map, $x, $y);
		2385	}
		2386
		2387	$done->() if $done;
1996	})->prio (1);	2388	})->prio (1);
1997	}	2389	}
1998		2390
1999	=item $player_object->enter_exit ($exit_object)	2391	=item $player_object->enter_exit ($exit_object)
2000		2392
…		…
2069	my $hp = $exit->stats->hp;	2461	my $hp = $exit->stats->hp;
2070	my $sp = $exit->stats->sp;	2462	my $sp = $exit->stats->sp;
2071		2463
2072	$self->enter_link;	2464	$self->enter_link;
2073		2465
		2466	# if exit is damned, update players death & WoR home-position
		2467	$self->contr->savebed ($slaying, $hp, $sp)
		2468	if $exit->flag (FLAG_DAMNED);
		2469
2074	(async {	2470	(async {
2075	$self->deactivate_recursive; # just to be sure	2471	$self->deactivate_recursive; # just to be sure
2076	unless (eval {	2472	unless (eval {
2077	$self->goto ($slaying, $hp, $sp);	2473	$self->goto ($slaying, $hp, $sp);
2078		2474
…		…
2105		2501
2106	utf8::encode $text;	2502	utf8::encode $text;
2107	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2503	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2108	}	2504	}
2109		2505
		2506	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2507
		2508	Send a drawinfo or msg packet to the client, formatting the msg for the
		2509	client if neccessary. C<$type> should be a string identifying the type of
		2510	the message, with C<log> being the default. If C<$color> is negative, suppress
		2511	the message unless the client supports the msg packet.
		2512
		2513	=cut
		2514
		2515	our %CHANNEL = (
		2516	"c/identify" => {
		2517	id => "identify",
		2518	title => "Identify",
		2519	reply => undef,
		2520	tooltip => "Items recently identified",
		2521	},
		2522	"c/examine" => {
		2523	id => "examine",
		2524	title => "Examine",
		2525	reply => undef,
		2526	tooltip => "Signs and other items you examined",
		2527	},
		2528	);
		2529
		2530	sub cf::client::send_msg {
		2531	my ($self, $channel, $msg, $color, @extra) = @_;
		2532
		2533	$msg = $self->pl->expand_cfpod ($msg);
		2534
		2535	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2536
		2537	# check predefined channels, for the benefit of C
		2538	$channel = $CHANNEL{$channel} if $CHANNEL{$channel};
		2539
		2540	if (ref $channel) {
		2541	# send meta info to client, if not yet sent
		2542	unless (exists $self->{channel}{$channel->{id}}) {
		2543	$self->{channel}{$channel->{id}} = $channel;
		2544	$self->ext_msg (channel_info => $channel)
		2545	if $self->can_msg;
		2546	}
		2547
		2548	$channel = $channel->{id};
		2549	}
		2550
		2551	return unless @extra || length $msg;
		2552
		2553	if ($self->can_msg) {
		2554	# default colour, mask it out
		2555	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2556	if $color & cf::NDI_DEF;
		2557
		2558	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2559	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2560	} else {
		2561	if ($color >= 0) {
		2562	# replace some tags by gcfclient-compatible ones
		2563	for ($msg) {
		2564	1 while
		2565	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2566	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2567	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2568	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2569	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2570	}
		2571
		2572	$color &= cf::NDI_COLOR_MASK;
		2573
		2574	utf8::encode $msg;
		2575
		2576	if (0 && $msg =~ /\[/) {
		2577	# COMMAND/INFO
		2578	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2579	} else {
		2580	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2581	$self->send_packet ("drawinfo $color $msg")
		2582	}
		2583	}
		2584	}
		2585	}
		2586
2110	=item $client->ext_event ($type, %msg)	2587	=item $client->ext_msg ($type, @msg)
2111		2588
2112	Sends an exti event to the client.	2589	Sends an ext event to the client.
2113		2590
2114	=cut	2591	=cut
2115		2592
2116	sub cf::client::ext_event($$%) {	2593	sub cf::client::ext_msg($$@) {
2117	my ($self, $type, %msg) = @_;	2594	my ($self, $type, @msg) = @_;
2118		2595
		2596	if ($self->extcmd == 2) {
		2597	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2598	} elsif ($self->extcmd == 1) { # TODO: remove
2119	$msg{msgtype} = "event_$type";	2599	push @msg, msgtype => "event_$type";
2120	$self->send_packet ("ext " . cf::to_json \%msg);	2600	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2601	}
		2602	}
		2603
		2604	=item $client->ext_reply ($msgid, @msg)
		2605
		2606	Sends an ext reply to the client.
		2607
		2608	=cut
		2609
		2610	sub cf::client::ext_reply($$@) {
		2611	my ($self, $id, @msg) = @_;
		2612
		2613	if ($self->extcmd == 2) {
		2614	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2615	} elsif ($self->extcmd == 1) {
		2616	#TODO: version 1, remove
		2617	unshift @msg, msgtype => "reply", msgid => $id;
		2618	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2619	}
2121	}	2620	}
2122		2621
2123	=item $success = $client->query ($flags, "text", \&cb)	2622	=item $success = $client->query ($flags, "text", \&cb)
2124		2623
2125	Queues a query to the client, calling the given callback with	2624	Queues a query to the client, calling the given callback with
2126	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2625	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2127	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2626	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2128		2627
2129	Queries can fail, so check the return code. Or don't, as queries will become	2628	Queries can fail, so check the return code. Or don't, as queries will
2130	reliable at some point in the future.	2629	become reliable at some point in the future.
2131		2630
2132	=cut	2631	=cut
2133		2632
2134	sub cf::client::query {	2633	sub cf::client::query {
2135	my ($self, $flags, $text, $cb) = @_;	2634	my ($self, $flags, $text, $cb) = @_;
…		…
2143	utf8::encode $text;	2642	utf8::encode $text;
2144	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2643	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2145		2644
2146	$self->send_packet ($self->{query_queue}[0][0])	2645	$self->send_packet ($self->{query_queue}[0][0])
2147	if @{ $self->{query_queue} } == 1;	2646	if @{ $self->{query_queue} } == 1;
		2647
		2648	1
2148	}	2649	}
2149		2650
2150	cf::client->attach (	2651	cf::client->attach (
		2652	on_connect => sub {
		2653	my ($ns) = @_;
		2654
		2655	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2656	},
2151	on_reply => sub {	2657	on_reply => sub {
2152	my ($ns, $msg) = @_;	2658	my ($ns, $msg) = @_;
2153		2659
2154	# this weird shuffling is so that direct followup queries	2660	# this weird shuffling is so that direct followup queries
2155	# get handled first	2661	# get handled first
…		…
2167	} else {	2673	} else {
2168	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2674	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2169	}	2675	}
2170	}	2676	}
2171	},	2677	},
		2678	on_exticmd => sub {
		2679	my ($ns, $buf) = @_;
		2680
		2681	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2682
		2683	if (ref $msg) {
		2684	my ($type, $reply, @payload) =
		2685	"ARRAY" eq ref $msg
		2686	? @$msg
		2687	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2688
		2689	my @reply;
		2690
		2691	if (my $cb = $EXTICMD{$type}) {
		2692	@reply = $cb->($ns, @payload);
		2693	}
		2694
		2695	$ns->ext_reply ($reply, @reply)
		2696	if $reply;
		2697
		2698	} else {
		2699	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2700	}
		2701
		2702	cf::override;
		2703	},
2172	);	2704	);
2173		2705
2174	=item $client->async (\&cb)	2706	=item $client->async (\&cb)
2175		2707
2176	Create a new coroutine, running the specified callback. The coroutine will	2708	Create a new coroutine, running the specified callback. The coroutine will
…		…
2217	our $safe = new Safe "safe";	2749	our $safe = new Safe "safe";
2218	our $safe_hole = new Safe::Hole;	2750	our $safe_hole = new Safe::Hole;
2219		2751
2220	$SIG{FPE} = 'IGNORE';	2752	$SIG{FPE} = 'IGNORE';
2221		2753
2222	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2754	$safe->permit_only (Opcode::opset qw(
		2755	:base_core :base_mem :base_orig :base_math
		2756	grepstart grepwhile mapstart mapwhile
		2757	sort time
		2758	));
2223		2759
2224	# here we export the classes and methods available to script code	2760	# here we export the classes and methods available to script code
2225		2761
2226	=pod	2762	=pod
2227		2763
2228	The following functions and methods are available within a safe environment:	2764	The following functions and methods are available within a safe environment:
2229		2765
2230	cf::object contr pay_amount pay_player map	2766	cf::object
		2767	contr pay_amount pay_player map x y force_find force_add
		2768	insert remove name archname title slaying race decrease_ob_nr
		2769
2231	cf::object::player player	2770	cf::object::player
2232	cf::player peaceful	2771	player
2233	cf::map trigger	2772
		2773	cf::player
		2774	peaceful
		2775
		2776	cf::map
		2777	trigger
2234		2778
2235	=cut	2779	=cut
2236		2780
2237	for (	2781	for (
2238	["cf::object" => qw(contr pay_amount pay_player map)],	2782	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2783	insert remove inv name archname title slaying race
		2784	decrease_ob_nr)],
2239	["cf::object::player" => qw(player)],	2785	["cf::object::player" => qw(player)],
2240	["cf::player" => qw(peaceful)],	2786	["cf::player" => qw(peaceful)],
2241	["cf::map" => qw(trigger)],	2787	["cf::map" => qw(trigger)],
2242	) {	2788	) {
2243	no strict 'refs';	2789	no strict 'refs';
…		…
2314	=back	2860	=back
2315		2861
2316	=cut	2862	=cut
2317		2863
2318	#############################################################################	2864	#############################################################################
2319
2320	=head2 EXTENSION DATABASE SUPPORT
2321
2322	Crossfire maintains a very simple database for extension use. It can
2323	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2324	convert to/from binary).
2325
2326	The parameter C<$family> should best start with the name of the extension
2327	using it, it should be unique.
2328
2329	=over 4
2330
2331	=item $value = cf::db_get $family => $key
2332
2333	Returns a single value from the database.
2334
2335	=item cf::db_put $family => $key => $value
2336
2337	Stores the given C<$value> in the family.
2338
2339	=cut
2340
2341	our $DB;
2342
2343	sub db_init {
2344	unless ($DB) {
2345	$DB = BDB::db_create $DB_ENV;
2346
2347	cf::sync_job {
2348	eval {
2349	$DB->set_flags (BDB::CHKSUM);
2350
2351	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2352	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2353	cf::cleanup "db_open(db): $!" if $!;
2354	};
2355	cf::cleanup "db_open(db): $@" if $@;
2356	};
2357	}
2358	}
2359
2360	sub db_get($$) {
2361	my $key = "$_[0]/$_[1]";
2362
2363	cf::sync_job {
2364	BDB::db_get $DB, undef, $key, my $data;
2365
2366	$! ? ()
2367	: $data
2368	}
2369	}
2370
2371	sub db_put($$$) {
2372	BDB::dbreq_pri 4;
2373	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2374	}
2375
2376	=item cf::cache $id => [$paths...], $processversion => $process
2377
2378	Generic caching function that returns the value of the resource $id,
2379	caching and regenerating as required.
2380
2381	This function can block.
2382
2383	=cut
2384
2385	sub cache {
2386	my ($id, $src, $processversion, $process) = @_;
2387
2388	my $meta =
2389	join "\x00",
2390	$processversion,
2391	map {
2392	aio_stat $_
2393	and Carp::croak "$_: $!";
2394
2395	($_, (stat _)[7,9])
2396	} @$src;
2397
2398	my $dbmeta = db_get cache => "$id/meta";
2399	if ($dbmeta ne $meta) {
2400	# changed, we may need to process
2401
2402	my @data;
2403	my $md5;
2404
2405	for (0 .. $#$src) {
2406	0 <= aio_load $src->[$_], $data[$_]
2407	or Carp::croak "$src->[$_]: $!";
2408	}
2409
2410	# if processing is expensive, check
2411	# checksum first
2412	if (1) {
2413	$md5 =
2414	join "\x00",
2415	$processversion,
2416	map {
2417	Coro::cede;
2418	($src->[$_], Digest::MD5::md5_hex $data[$_])
2419	} 0.. $#$src;
2420
2421
2422	my $dbmd5 = db_get cache => "$id/md5";
2423	if ($dbmd5 eq $md5) {
2424	db_put cache => "$id/meta", $meta;
2425
2426	return db_get cache => "$id/data";
2427	}
2428	}
2429
2430	my $t1 = Time::HiRes::time;
2431	my $data = $process->(\@data);
2432	my $t2 = Time::HiRes::time;
2433
2434	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2435
2436	db_put cache => "$id/data", $data;
2437	db_put cache => "$id/md5" , $md5;
2438	db_put cache => "$id/meta", $meta;
2439
2440	return $data;
2441	}
2442
2443	db_get cache => "$id/data"
2444	}
2445
2446	=item fork_call { }, $args
2447
2448	Executes the given code block with the given arguments in a seperate
2449	process, returning the results. Everything must be serialisable with
2450	Coro::Storable. May, of course, block. Note that the executed sub may
2451	never block itself or use any form of Event handling.
2452
2453	=cut
2454
2455	sub fork_call(&@) {
2456	my ($cb, @args) = @_;
2457
2458	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2459	# or die "socketpair: $!";
2460	pipe my $fh1, my $fh2
2461	or die "pipe: $!";
2462
2463	if (my $pid = fork) {
2464	close $fh2;
2465
2466	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2467	$res = Coro::Storable::thaw $res;
2468
2469	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2470
2471	die $$res unless "ARRAY" eq ref $res;
2472
2473	return wantarray ? @$res : $res->[-1];
2474	} else {
2475	reset_signals;
2476	local $SIG{__WARN__};
2477	local $SIG{__DIE__};
2478	eval {
2479	close $fh1;
2480
2481	my @res = eval { $cb->(@args) };
2482	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2483	};
2484
2485	warn $@ if $@;
2486	_exit 0;
2487	}
2488	}
2489
2490
2491
2492	#############################################################################
2493	# the server's init and main functions	2865	# the server's init and main functions
2494		2866
2495	sub load_facedata($) {	2867	sub load_facedata($) {
2496	my ($path) = @_;	2868	my ($path) = @_;
		2869
		2870	# HACK to clear player env face cache, we need some signal framework
		2871	# for this (global event?)
		2872	%ext::player_env::MUSIC_FACE_CACHE = ();
		2873
		2874	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2497		2875
2498	warn "loading facedata from $path\n";	2876	warn "loading facedata from $path\n";
2499		2877
2500	my $facedata;	2878	my $facedata;
2501	0 < aio_load $path, $facedata	2879	0 < aio_load $path, $facedata
…		…
2504	$facedata = Coro::Storable::thaw $facedata;	2882	$facedata = Coro::Storable::thaw $facedata;
2505		2883
2506	$facedata->{version} == 2	2884	$facedata->{version} == 2
2507	or cf::cleanup "$path: version mismatch, cannot proceed.";	2885	or cf::cleanup "$path: version mismatch, cannot proceed.";
2508		2886
		2887	# patch in the exptable
		2888	$facedata->{resource}{"res/exp_table"} = {
		2889	type => FT_RSRC,
		2890	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
		2891	};
		2892	cf::cede_to_tick;
		2893
2509	{	2894	{
2510	my $faces = $facedata->{faceinfo};	2895	my $faces = $facedata->{faceinfo};
2511		2896
2512	while (my ($face, $info) = each %$faces) {	2897	while (my ($face, $info) = each %$faces) {
2513	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2898	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2514	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2899	cf::face::set_visibility $idx, $info->{visibility};
		2900	cf::face::set_magicmap $idx, $info->{magicmap};
2515	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2901	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2516	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	2902	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2517	Coro::cede;	2903
		2904	cf::cede_to_tick;
2518	}	2905	}
2519		2906
2520	while (my ($face, $info) = each %$faces) {	2907	while (my ($face, $info) = each %$faces) {
2521	next unless $info->{smooth};	2908	next unless $info->{smooth};
2522	my $idx = cf::face::find $face	2909	my $idx = cf::face::find $face
2523	or next;	2910	or next;
2524	if (my $smooth = cf::face::find $info->{smooth}) {	2911	if (my $smooth = cf::face::find $info->{smooth}) {
		2912	cf::face::set_smooth $idx, $smooth;
2525	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	2913	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2526	} else {	2914	} else {
2527	warn "smooth face '$info->{smooth}' not found for face '$face'";	2915	warn "smooth face '$info->{smooth}' not found for face '$face'";
2528	}	2916	}
2529	Coro::cede;	2917
		2918	cf::cede_to_tick;
2530	}	2919	}
2531	}	2920	}
2532		2921
2533	{	2922	{
2534	my $anims = $facedata->{animinfo};	2923	my $anims = $facedata->{animinfo};
2535		2924
2536	while (my ($anim, $info) = each %$anims) {	2925	while (my ($anim, $info) = each %$anims) {
2537	cf::anim::set $anim, $info->{frames}, $info->{facings};	2926	cf::anim::set $anim, $info->{frames}, $info->{facings};
2538	Coro::cede;	2927	cf::cede_to_tick;
2539	}	2928	}
2540		2929
2541	cf::anim::invalidate_all; # d'oh	2930	cf::anim::invalidate_all; # d'oh
2542	}	2931	}
2543		2932
		2933	{
		2934	# TODO: for gcfclient pleasure, we should give resources
		2935	# that gcfclient doesn't grok a >10000 face index.
		2936	my $res = $facedata->{resource};
		2937
		2938	my $soundconf = delete $res->{"res/sound.conf"};
		2939
		2940	while (my ($name, $info) = each %$res) {
		2941	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2942	my $data;
		2943
		2944	if ($info->{type} & 1) {
		2945	# prepend meta info
		2946
		2947	my $meta = $enc->encode ({
		2948	name => $name,
		2949	%{ $info->{meta} || {} },
		2950	});
		2951
		2952	$data = pack "(w/a*)*", $meta, $info->{data};
		2953	} else {
		2954	$data = $info->{data};
		2955	}
		2956
		2957	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		2958	cf::face::set_type $idx, $info->{type};
		2959
		2960	cf::cede_to_tick;
		2961	}
		2962
		2963	if ($soundconf) {
		2964	$soundconf = $enc->decode (delete $soundconf->{data});
		2965
		2966	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2967	my $sound = $soundconf->{compat}[$_]
		2968	or next;
		2969
		2970	my $face = cf::face::find "sound/$sound->[1]";
		2971	cf::sound::set $sound->[0] => $face;
		2972	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2973	}
		2974
		2975	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2976	my $face = cf::face::find "sound/$v";
		2977	cf::sound::set $k => $face;
		2978	}
		2979	}
		2980	}
		2981
2544	1	2982	1
2545	}	2983	}
2546		2984
		2985	register_exticmd fx_want => sub {
		2986	my ($ns, $want) = @_;
		2987
		2988	while (my ($k, $v) = each %$want) {
		2989	$ns->fx_want ($k, $v);
		2990	}
		2991	};
		2992
2547	sub reload_regions {	2993	sub reload_regions {
		2994	# HACK to clear player env face cache, we need some signal framework
		2995	# for this (global event?)
		2996	%ext::player_env::MUSIC_FACE_CACHE = ();
		2997
2548	load_resource_file "$MAPDIR/regions"	2998	load_resource_file "$MAPDIR/regions"
2549	or die "unable to load regions file\n";	2999	or die "unable to load regions file\n";
		3000
		3001	for (cf::region::list) {
		3002	$_->{match} = qr/$_->{match}/
		3003	if exists $_->{match};
		3004	}
2550	}	3005	}
2551		3006
2552	sub reload_facedata {	3007	sub reload_facedata {
2553	load_facedata "$DATADIR/facedata"	3008	load_facedata "$DATADIR/facedata"
2554	or die "unable to load facedata\n";	3009	or die "unable to load facedata\n";
2555	}	3010	}
2556		3011
2557	sub reload_archetypes {	3012	sub reload_archetypes {
2558	load_resource_file "$DATADIR/archetypes"	3013	load_resource_file "$DATADIR/archetypes"
2559	or die "unable to load archetypes\n";	3014	or die "unable to load archetypes\n";
		3015	#d# NEED to laod twice to resolve forward references
		3016	# this really needs to be done in an extra post-pass
		3017	# (which needs to be synchronous, so solve it differently)
		3018	load_resource_file "$DATADIR/archetypes"
		3019	or die "unable to load archetypes\n";
2560	}	3020	}
2561		3021
2562	sub reload_treasures {	3022	sub reload_treasures {
2563	load_resource_file "$DATADIR/treasures"	3023	load_resource_file "$DATADIR/treasures"
2564	or die "unable to load treasurelists\n";	3024	or die "unable to load treasurelists\n";
…		…
2567	sub reload_resources {	3027	sub reload_resources {
2568	warn "reloading resource files...\n";	3028	warn "reloading resource files...\n";
2569		3029
2570	reload_regions;	3030	reload_regions;
2571	reload_facedata;	3031	reload_facedata;
		3032	#reload_archetypes;#d#
2572	reload_archetypes;	3033	reload_archetypes;
2573	reload_treasures;	3034	reload_treasures;
2574		3035
2575	warn "finished reloading resource files\n";	3036	warn "finished reloading resource files\n";
2576	}	3037	}
2577		3038
2578	sub init {	3039	sub init {
2579	reload_resources;	3040	reload_resources;
2580	}	3041	}
2581		3042
2582	sub cfg_load {	3043	sub reload_config {
2583	open my $fh, "<:utf8", "$CONFDIR/config"	3044	open my $fh, "<:utf8", "$CONFDIR/config"
2584	or return;	3045	or return;
2585		3046
2586	local $/;	3047	local $/;
2587	*CFG = YAML::Syck::Load <$fh>;	3048	*CFG = YAML::Syck::Load <$fh>;
…		…
2607	(async {	3068	(async {
2608	Event::one_event;	3069	Event::one_event;
2609	})->prio (Coro::PRIO_MAX);	3070	})->prio (Coro::PRIO_MAX);
2610	};	3071	};
2611		3072
2612	cfg_load;	3073	reload_config;
2613	db_init;	3074	db_init;
2614	load_extensions;	3075	load_extensions;
2615		3076
2616	$TICK_WATCHER->start;	3077	$TICK_WATCHER->start;
2617	Event::loop;	3078	Event::loop;
…		…
2633	},	3094	},
2634	);	3095	);
2635	}	3096	}
2636	}	3097	}
2637		3098
		3099	sub write_runtime {
		3100	my $runtime = "$LOCALDIR/runtime";
		3101
		3102	# first touch the runtime file to show we are still running:
		3103	# the fsync below can take a very very long time.
		3104
		3105	IO::AIO::aio_utime $runtime, undef, undef;
		3106
		3107	my $guard = cf::lock_acquire "write_runtime";
		3108
		3109	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3110	or return;
		3111
		3112	my $value = $cf::RUNTIME + 90 + 10;
		3113	# 10 is the runtime save interval, for a monotonic clock
		3114	# 60 allows for the watchdog to kill the server.
		3115
		3116	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3117	and return;
		3118
		3119	# always fsync - this file is important
		3120	aio_fsync $fh
		3121	and return;
		3122
		3123	# touch it again to show we are up-to-date
		3124	aio_utime $fh, undef, undef;
		3125
		3126	close $fh
		3127	or return;
		3128
		3129	aio_rename "$runtime~", $runtime
		3130	and return;
		3131
		3132	warn "runtime file written.\n";
		3133
		3134	1
		3135	}
		3136
2638	sub emergency_save() {	3137	sub emergency_save() {
2639	my $freeze_guard = cf::freeze_mainloop;	3138	my $freeze_guard = cf::freeze_mainloop;
2640		3139
2641	warn "enter emergency perl save\n";	3140	warn "enter emergency perl save\n";
2642		3141
…		…
2717	%EXT_CORO = ();	3216	%EXT_CORO = ();
2718		3217
2719	warn "removing commands";	3218	warn "removing commands";
2720	%COMMAND = ();	3219	%COMMAND = ();
2721		3220
2722	warn "removing ext commands";	3221	warn "removing ext/exti commands";
2723	%EXTCMD = ();	3222	%EXTCMD = ();
		3223	%EXTICMD = ();
2724		3224
2725	warn "unloading/nuking all extensions";	3225	warn "unloading/nuking all extensions";
2726	for my $pkg (@EXTS) {	3226	for my $pkg (@EXTS) {
2727	warn "... unloading $pkg";	3227	warn "... unloading $pkg";
2728		3228
…		…
2771	warn "reloading cf.pm";	3271	warn "reloading cf.pm";
2772	require cf;	3272	require cf;
2773	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3273	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2774		3274
2775	warn "loading config and database again";	3275	warn "loading config and database again";
2776	cf::cfg_load;	3276	cf::reload_config;
2777		3277
2778	warn "loading extensions";	3278	warn "loading extensions";
2779	cf::load_extensions;	3279	cf::load_extensions;
2780		3280
2781	warn "reattaching attachments to objects/players";	3281	warn "reattaching attachments to objects/players";
…		…
2846	my $signal = new Coro::Signal;	3346	my $signal = new Coro::Signal;
2847	push @WAIT_FOR_TICK_BEGIN, $signal;	3347	push @WAIT_FOR_TICK_BEGIN, $signal;
2848	$signal->wait;	3348	$signal->wait;
2849	}	3349	}
2850		3350
		3351	my $min = 1e6;#d#
		3352	my $avg = 10;
2851	$TICK_WATCHER = Event->timer (	3353	$TICK_WATCHER = Event->timer (
2852	reentrant => 0,	3354	reentrant => 0,
2853	parked => 1,	3355	parked => 1,
2854	prio => 0,	3356	prio => 0,
2855	at => $NEXT_TICK || $TICK,	3357	at => $NEXT_TICK || $TICK,
…		…
2862	}	3364	}
2863		3365
2864	$NOW = $tick_start = Event::time;	3366	$NOW = $tick_start = Event::time;
2865		3367
2866	cf::server_tick; # one server iteration	3368	cf::server_tick; # one server iteration
		3369
		3370	0 && sync_job {#d#
		3371	for(1..10) {
		3372	my $t = Event::time;
		3373	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3374	or die;
		3375
		3376	$map->width (50);
		3377	$map->height (50);
		3378	$map->alloc;
		3379	$map->_load_objects ("/tmp/x.map", 1);
		3380	my $t = Event::time - $t;
		3381
		3382	#next unless $t < 0.0013;#d#
		3383	if ($t < $min) {
		3384	$min = $t;
		3385	}
		3386	$avg = $avg * 0.99 + $t * 0.01;
		3387	}
		3388	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3389	exit 0;
		3390	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3391	};
2867		3392
2868	$RUNTIME += $TICK;	3393	$RUNTIME += $TICK;
2869	$NEXT_TICK += $TICK;	3394	$NEXT_TICK += $TICK;
2870		3395
2871	if ($NOW >= $NEXT_RUNTIME_WRITE) {	3396	if ($NOW >= $NEXT_RUNTIME_WRITE) {

Diff Legend

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