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.262 by root, Sat Apr 28 05:55:55 2007 UTC vs.
Revision 1.353 by root, Sun Sep 2 08:43:46 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;
…		…
90	our $LINK_MAP; # the special {link} map, which is always available	94	our $LINK_MAP; # the special {link} map, which is always available
91		95
92	# used to convert map paths into valid unix filenames by replacing / by ∕	96	# used to convert map paths into valid unix filenames by replacing / by ∕
93	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	97	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
94		98
		99	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		100	our $LOADAVG; # same thing, but with alpha-smoothing
		101	our $tick_start; # for load detecting purposes
		102
95	binmode STDOUT;	103	binmode STDOUT;
96	binmode STDERR;	104	binmode STDERR;
97		105
98	# read virtual server time, if available	106	# read virtual server time, if available
99	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {	107	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
…		…
139		147
140	=item $cf::TICK	148	=item $cf::TICK
141		149
142	The interval between server ticks, in seconds.	150	The interval between server ticks, in seconds.
143		151
		152	=item $cf::LOADAVG
		153
		154	The current CPU load on the server (alpha-smoothed), as a value between 0
		155	(none) and 1 (overloaded), indicating how much time is spent on processing
		156	objects per tick. Healthy values are < 0.5.
		157
		158	=item $cf::LOAD
		159
		160	The raw value load value from the last tick.
		161
144	=item %cf::CFG	162	=item %cf::CFG
145		163
146	Configuration for the server, loaded from C</etc/crossfire/config>, or	164	Configuration for the server, loaded from C</etc/crossfire/config>, or
147	from wherever your confdir points to.	165	from wherever your confdir points to.
148		166
149	=item cf::wait_for_tick, cf::wait_for_tick_begin	167	=item cf::wait_for_tick, cf::wait_for_tick_begin
150		168
151	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
152	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
153	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.
		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.
154		178
155	=back	179	=back
156		180
157	=cut	181	=cut
158		182
…		…
173	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	197	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
174	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	198	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
175	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	199	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
176	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	200	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
177	@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';
178	@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)
179		204
180	# 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
181	# within the Safe compartment.	206	# within the Safe compartment.
182	for my $pkg (qw(	207	for my $pkg (qw(
183	cf::global cf::attachable	208	cf::global cf::attachable
…		…
191	}	216	}
192		217
193	$Event::DIED = sub {	218	$Event::DIED = sub {
194	warn "error in event callback: @_";	219	warn "error in event callback: @_";
195	};	220	};
		221
		222	#############################################################################
196		223
197	=head2 UTILITY FUNCTIONS	224	=head2 UTILITY FUNCTIONS
198		225
199	=over 4	226	=over 4
200		227
…		…
219	$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;
220	$d	247	$d
221	} || "[unable to dump $_[0]: '$@']";	248	} || "[unable to dump $_[0]: '$@']";
222	}	249	}
223		250
224	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
225
226	=item $ref = cf::from_json $json	251	=item $ref = cf::from_json $json
227		252
228	Converts a JSON string into the corresponding perl data structure.	253	Converts a JSON string into the corresponding perl data structure.
229		254
230	=item $json = cf::to_json $ref	255	=item $json = cf::to_json $ref
231		256
232	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]) }
233		265
234	=item cf::lock_wait $string	266	=item cf::lock_wait $string
235		267
236	Wait until the given lock is available. See cf::lock_acquire.	268	Wait until the given lock is available. See cf::lock_acquire.
237		269
…		…
239		271
240	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
241	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,
242	for example when the coroutine gets canceled), the lock is automatically	274	for example when the coroutine gets canceled), the lock is automatically
243	returned.	275	returned.
		276
		277	Locks are *not* recursive, locking from the same coro twice results in a
		278	deadlocked coro.
244		279
245	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
246	uses map_find and cf::map::load uses map_load).	281	uses map_find and cf::map::load uses map_load).
247		282
248	=item $locked = cf::lock_active $string	283	=item $locked = cf::lock_active $string
…		…
291	};	326	};
292	$TICK_WATCHER->stop;	327	$TICK_WATCHER->stop;
293	$guard	328	$guard
294	}	329	}
295		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
296	=item cf::async { BLOCK }	387	=item cf::async { BLOCK }
297		388
298	Currently the same as Coro::async_pool, meaning you cannot use	389	Currently the same as Coro::async_pool, meaning you cannot use
299	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
300	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.
…		…
303		394
304	BEGIN { *async = \&Coro::async_pool }	395	BEGIN { *async = \&Coro::async_pool }
305		396
306	=item cf::sync_job { BLOCK }	397	=item cf::sync_job { BLOCK }
307		398
308	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)
309	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
310	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.
311		403
312	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
313	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
314	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
315	fast or be very important.	407	fast or be very important.
…		…
318		410
319	sub sync_job(&) {	411	sub sync_job(&) {
320	my ($job) = @_;	412	my ($job) = @_;
321		413
322	if ($Coro::current == $Coro::main) {	414	if ($Coro::current == $Coro::main) {
		415	my $time = Event::time;
		416
323	# this is the main coro, too bad, we have to block	417	# this is the main coro, too bad, we have to block
324	# till the operation succeeds, freezing the server :/	418	# till the operation succeeds, freezing the server :/
325		419
326	# TODO: use suspend/resume instead	420	# TODO: use suspend/resume instead
327	# (but this is cancel-safe)	421	# (but this is cancel-safe)
…		…
338		432
339	while ($busy) {	433	while ($busy) {
340	Coro::cede or Event::one_event;	434	Coro::cede or Event::one_event;
341	}	435	}
342		436
		437	$time = Event::time - $time;
		438
		439	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		440	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		441
		442	$tick_start += $time; # do not account sync jobs to server load
		443
343	wantarray ? @res : $res[0]	444	wantarray ? @res : $res[0]
344	} else {	445	} else {
345	# we are in another coroutine, how wonderful, everything just works	446	# we are in another coroutine, how wonderful, everything just works
346		447
347	$job->()	448	$job->()
…		…
366	$EXT_CORO{$coro+0} = $coro;	467	$EXT_CORO{$coro+0} = $coro;
367		468
368	$coro	469	$coro
369	}	470	}
370		471
371	sub write_runtime {	472	=item fork_call { }, $args
372	my $guard = cf::lock_acquire "write_runtime";
373		473
374	my $runtime = "$LOCALDIR/runtime";	474	Executes the given code block with the given arguments in a seperate
		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.
375		478
376	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	479	=cut
377	or return;
378		480
379	my $value = $cf::RUNTIME + 90 + 10;	481	sub fork_call(&@) {
380	# 10 is the runtime save interval, for a monotonic clock	482	my ($cb, @args) = @_;
381	# 60 allows for the watchdog to kill the server.
382		483
383	(aio_write $fh, 0, (length $value), $value, 0) <= 0	484	# we seemingly have to make a local copy of the whole thing,
384	and return;	485	# otherwise perl prematurely frees the stuff :/
		486	# TODO: investigate and fix (liekly this will be rather laborious)
385		487
386	# always fsync - this file is important	488	my @res = Coro::Util::fork_eval {
387	aio_fsync $fh	489	reset_signals;
388	and return;	490	&$cb
		491	}, @args;
389		492
390	close $fh	493	wantarray ? @res : $res[-1]
391	or return;	494	}
392		495
393	aio_rename "$runtime~", $runtime	496	=item $value = cf::db_get $family => $key
394	and return;
395		497
		498	Returns a single value from the environment database.
		499
		500	=item cf::db_put $family => $key => $value
		501
		502	Stores the given C<$value> in the family. It can currently store binary
		503	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		504
		505	=cut
		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	};
396	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"
397	}	610	}
398		611
399	=item cf::datalog type => key => value, ...	612	=item cf::datalog type => key => value, ...
400		613
401	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.
…		…
419	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")
420	to it. All such attachable objects support the following methods.	633	to it. All such attachable objects support the following methods.
421		634
422	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>
423	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
424	crossfire+).	637	Crossfire TRT).
425		638
426	=over 4	639	=over 4
427		640
428	=item $attachable->attach ($attachment, key => $value...)	641	=item $attachable->attach ($attachment, key => $value...)
429		642
…		…
592	$registry = $CB_TYPE[$object_type] ||= [];	805	$registry = $CB_TYPE[$object_type] ||= [];
593		806
594	} elsif ($type eq "subtype") {	807	} elsif ($type eq "subtype") {
595	defined $object_type or Carp::croak "subtype specified without type";	808	defined $object_type or Carp::croak "subtype specified without type";
596	my $object_subtype = shift @arg;	809	my $object_subtype = shift @arg;
597	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	810	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
598		811
599	} elsif ($type eq "package") {	812	} elsif ($type eq "package") {
600	my $pkg = shift @arg;	813	my $pkg = shift @arg;
601		814
602	while (my ($name, $id) = each %cb_id) {	815	while (my ($name, $id) = each %cb_id) {
…		…
631	_attach $registry, $klass, @attach;	844	_attach $registry, $klass, @attach;
632	}	845	}
633		846
634	$obj->{$name} = \%arg;	847	$obj->{$name} = \%arg;
635	} else {	848	} else {
636	warn "object uses attachment '$name' that is not available, postponing.\n";	849	warn "object uses attachment '$name' which is not available, postponing.\n";
637	}	850	}
638		851
639	$obj->{_attachment}{$name} = undef;	852	$obj->{_attachment}{$name} = undef;
640	}	853	}
641		854
…		…
643	if (ref $_[0]) {	856	if (ref $_[0]) {
644	_object_attach @_;	857	_object_attach @_;
645	} else {	858	} else {
646	_attach shift->_attach_registry, @_;	859	_attach shift->_attach_registry, @_;
647	}	860	}
		861	_recalc_want;
648	};	862	};
649		863
650	# all those should be optimised	864	# all those should be optimised
651	sub cf::attachable::detach {	865	sub cf::attachable::detach {
652	my ($obj, $name) = @_;	866	my ($obj, $name) = @_;
…		…
655	delete $obj->{_attachment}{$name};	869	delete $obj->{_attachment}{$name};
656	reattach ($obj);	870	reattach ($obj);
657	} else {	871	} else {
658	Carp::croak "cannot, currently, detach class attachments";	872	Carp::croak "cannot, currently, detach class attachments";
659	}	873	}
		874	_recalc_want;
660	};	875	};
661		876
662	sub cf::attachable::attached {	877	sub cf::attachable::attached {
663	my ($obj, $name) = @_;	878	my ($obj, $name) = @_;
664		879
…		…
679	";	894	";
680	die if $@;	895	die if $@;
681	}	896	}
682		897
683	our $override;	898	our $override;
684	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?
685		900
686	sub override {	901	sub override {
687	$override = 1;	902	$override = 1;
688	@invoke_results = ();	903	@INVOKE_RESULTS = (@_);
689	}	904	}
690		905
691	sub do_invoke {	906	sub do_invoke {
692	my $event = shift;	907	my $event = shift;
693	my $callbacks = shift;	908	my $callbacks = shift;
694		909
695	@invoke_results = ();	910	@INVOKE_RESULTS = ();
696		911
697	local $override;	912	local $override;
698		913
699	for (@$callbacks) {	914	for (@$callbacks) {
700	eval { &{$_->[1]} };	915	eval { &{$_->[1]} };
…		…
717		932
718	Generate an object-specific event with the given arguments.	933	Generate an object-specific event with the given arguments.
719		934
720	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
721	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
722	results (if you must, access C<@cf::invoke_results> directly).	937	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
723		938
724	=back	939	=back
725		940
726	=cut	941	=cut
727		942
728	#############################################################################	943	#############################################################################
729	# 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	}
730		956
731	sub reattach {	957	sub reattach {
732	# basically do the same as instantiate, without calling instantiate	958	# basically do the same as instantiate, without calling instantiate
733	my ($obj) = @_;	959	my ($obj) = @_;
734		960
…		…
837	or return;	1063	or return;
838	$av = eval { (Storable::thaw $av)->{objs} };	1064	$av = eval { (Storable::thaw $av)->{objs} };
839	}	1065	}
840		1066
841	warn sprintf "loading %s (%d)\n",	1067	warn sprintf "loading %s (%d)\n",
842	$filename, length $data, scalar @{$av || []};#d#	1068	$filename, length $data, scalar @{$av || []};
843	return ($data, $av);	1069	return ($data, $av);
844	}	1070	}
		1071
		1072	=head2 COMMAND CALLBACKS
		1073
		1074	=over 4
		1075
		1076	=cut
845		1077
846	#############################################################################	1078	#############################################################################
847	# command handling &c	1079	# command handling &c
848		1080
849	=item cf::register_command $name => \&callback($ob,$args);	1081	=item cf::register_command $name => \&callback($ob,$args);
…		…
862	push @{ $COMMAND{$name} }, [$caller, $cb];	1094	push @{ $COMMAND{$name} }, [$caller, $cb];
863	}	1095	}
864		1096
865	=item cf::register_extcmd $name => \&callback($pl,$packet);	1097	=item cf::register_extcmd $name => \&callback($pl,$packet);
866		1098
867	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.
868		1104
869	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
870	called.	1106	called.
871		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
872	=cut	1119	=cut
873		1120
874	sub register_extcmd {	1121	sub register_extcmd {
875	my ($name, $cb) = @_;	1122	my ($name, $cb) = @_;
876		1123
877	$EXTCMD{$name} = $cb;	1124	$EXTCMD{$name} = $cb;
		1125	}
		1126
		1127	sub register_exticmd {
		1128	my ($name, $cb) = @_;
		1129
		1130	$EXTICMD{$name} = $cb;
878	}	1131	}
879		1132
880	cf::player->attach (	1133	cf::player->attach (
881	on_command => sub {	1134	on_command => sub {
882	my ($pl, $name, $params) = @_;	1135	my ($pl, $name, $params) = @_;
…		…
891	cf::override;	1144	cf::override;
892	},	1145	},
893	on_extcmd => sub {	1146	on_extcmd => sub {
894	my ($pl, $buf) = @_;	1147	my ($pl, $buf) = @_;
895		1148
896	my $msg = eval { from_json $buf };	1149	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
897		1150
898	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
899	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1159	if (my $cb = $EXTCMD{$type}) {
900	if (my %reply = $cb->($pl, $msg)) {	1160	@reply = $cb->($pl, @payload);
901	$pl->ext_reply ($msg->{msgid}, %reply);
902	}
903	}	1161	}
		1162
		1163	$pl->ext_reply ($reply, @reply)
		1164	if $reply;
		1165
904	} else {	1166	} else {
905	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1167	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
906	}	1168	}
907		1169
908	cf::override;	1170	cf::override;
909	},	1171	},
910	);	1172	);
911		1173
912	sub load_extension {
913	my ($path) = @_;
914
915	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
916	my $base = $1;
917	my $pkg = $1;
918	$pkg =~ s/[^[:word:]]/_/g;
919	$pkg = "ext::$pkg";
920
921	warn "... loading '$path' into '$pkg'\n";
922
923	open my $fh, "<:utf8", $path
924	or die "$path: $!";
925
926	my $source =
927	"package $pkg; use strict; use utf8;\n"
928	. "#line 1 \"$path\"\n{\n"
929	. (do { local $/; <$fh> })
930	. "\n};\n1";
931
932	unless (eval $source) {
933	my $msg = $@ ? "$path: $@\n"
934	: "extension disabled.\n";
935	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
936	warn $@;
937	warn "mandatory extension failed to load, exiting.\n";
938	exit 1;
939	}
940	die $@;
941	}
942
943	push @EXTS, $pkg;
944	}
945
946	sub load_extensions {	1174	sub load_extensions {
		1175	cf::sync_job {
		1176	my %todo;
		1177
947	for my $ext (<$LIBDIR/*.ext>) {	1178	for my $path (<$LIBDIR/*.ext>) {
948	next unless -r $ext;	1179	next unless -r $path;
949	eval {	1180
950	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;
951	1	1238	}
952	} or warn "$ext not loaded: $@";	1239
		1240	skip:
		1241	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1242	unless $progress;
		1243	}
953	}	1244	};
954	}	1245	}
955		1246
956	#############################################################################	1247	#############################################################################
		1248
		1249	=back
957		1250
958	=head2 CORE EXTENSIONS	1251	=head2 CORE EXTENSIONS
959		1252
960	Functions and methods that extend core crossfire objects.	1253	Functions and methods that extend core crossfire objects.
961		1254
…		…
1032		1325
1033	aio_mkdir playerdir $pl, 0770;	1326	aio_mkdir playerdir $pl, 0770;
1034	$pl->{last_save} = $cf::RUNTIME;	1327	$pl->{last_save} = $cf::RUNTIME;
1035		1328
1036	$pl->save_pl ($path);	1329	$pl->save_pl ($path);
1037	Coro::cede;	1330	cf::cede_to_tick;
1038	}	1331	}
1039		1332
1040	sub new($) {	1333	sub new($) {
1041	my ($login) = @_;	1334	my ($login) = @_;
1042		1335
…		…
1046	$self->{deny_save} = 1;	1339	$self->{deny_save} = 1;
1047		1340
1048	$cf::PLAYER{$login} = $self;	1341	$cf::PLAYER{$login} = $self;
1049		1342
1050	$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 (@_);
1051	}	1354	}
1052		1355
1053	=item $pl->quit_character	1356	=item $pl->quit_character
1054		1357
1055	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
…		…
1149	}	1452	}
1150		1453
1151	\@paths	1454	\@paths
1152	}	1455	}
1153		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/(?<![BIUGHT])</&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	|| s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
		1478	# replace G<male|female> tags
		1479	|| s{G<([^>|]*)\|([^>]*)>}{
		1480	$self->gender ? $2 : $1
		1481	}ge
		1482	# replace H<hint text>
		1483	|| s{H<([^\>]*)>}
		1484	{
		1485	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1486	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1487	"")
		1488	[$self->{hintmode}]
		1489	}ge;
		1490
		1491	# create single paragraphs (very hackish)
		1492	s/(?<=\S)\n(?=\w)/ /g;
		1493
		1494	# compress some whitespace
		1495	s/\s+\n/\n/g; # ws line-ends
		1496	s/\n\n+/\n/g; # double lines
		1497	s/^\n+//; # beginning lines
		1498	s/\n+$//; # ending lines
		1499
		1500	$_
		1501	}
		1502
		1503	sub hintmode {
		1504	$_[0]{hintmode} = $_[1] if @_ > 1;
		1505	$_[0]{hintmode}
		1506	}
		1507
1154	=item $player->ext_reply ($msgid, %msg)	1508	=item $player->ext_reply ($msgid, @msg)
1155		1509
1156	Sends an ext reply to the player.	1510	Sends an ext reply to the player.
1157		1511
1158	=cut	1512	=cut
1159		1513
1160	sub ext_reply($$%) {	1514	sub ext_reply($$@) {
1161	my ($self, $id, %msg) = @_;	1515	my ($self, $id, @msg) = @_;
1162		1516
1163	$msg{msgid} = $id;	1517	$self->ns->ext_reply ($id, @msg)
1164
1165	$self->send ("ext " . cf::to_json \%msg);
1166	}	1518	}
1167		1519
1168	=item $player->ext_event ($type, %msg)	1520	=item $player->ext_msg ($type, @msg)
1169		1521
1170	Sends an ext event to the client.	1522	Sends an ext event to the client.
1171		1523
1172	=cut	1524	=cut
1173		1525
1174	sub ext_event($$%) {	1526	sub ext_msg($$@) {
1175	my ($self, $type, %msg) = @_;	1527	my ($self, $type, @msg) = @_;
1176		1528
1177	$self->ns->ext_event ($type, %msg);	1529	$self->ns->ext_msg ($type, @msg);
1178	}	1530	}
1179		1531
1180	=head3 cf::region	1532	=head3 cf::region
1181		1533
1182	=over 4	1534	=over 4
…		…
1185		1537
1186	package cf::region;	1538	package cf::region;
1187		1539
1188	=item cf::region::find_by_path $path	1540	=item cf::region::find_by_path $path
1189		1541
1190	Tries to decuce the probable region for a map knowing only its path.	1542	Tries to decuce the likely region for a map knowing only its path.
1191		1543
1192	=cut	1544	=cut
1193		1545
1194	sub find_by_path($) {	1546	sub find_by_path($) {
1195	my ($path) = @_;	1547	my ($path) = @_;
1196		1548
1197	my ($match, $specificity);	1549	my ($match, $specificity);
1198		1550
1199	for my $region (list) {	1551	for my $region (list) {
1200	if ($region->match && $path =~ $region->match) {	1552	if ($region->{match} && $path =~ $region->{match}) {
1201	($match, $specificity) = ($region, $region->specificity)	1553	($match, $specificity) = ($region, $region->specificity)
1202	if $region->specificity > $specificity;	1554	if $region->specificity > $specificity;
1203	}	1555	}
1204	}	1556	}
1205		1557
…		…
1269	my ($self, $merge) = @_;	1621	my ($self, $merge) = @_;
1270		1622
1271	# we have to keep some variables in memory intact	1623	# we have to keep some variables in memory intact
1272	local $self->{path};	1624	local $self->{path};
1273	local $self->{load_path};	1625	local $self->{load_path};
1274	local $self->{deny_save};
1275	local $self->{deny_reset};
1276		1626
1277	$self->SUPER::thawer_merge ($merge);	1627	$self->SUPER::thawer_merge ($merge);
1278	}	1628	}
1279		1629
1280	sub normalise {	1630	sub normalise {
…		…
1327	$self->init; # pass $1 etc.	1677	$self->init; # pass $1 etc.
1328	return $self;	1678	return $self;
1329	}	1679	}
1330	}	1680	}
1331		1681
1332	Carp::carp "unable to resolve path '$path' (base '$base').";	1682	Carp::cluck "unable to resolve path '$path' (base '$base').";
1333	()	1683	()
1334	}	1684	}
1335		1685
1336	sub init {	1686	sub init {
1337	my ($self) = @_;	1687	my ($self) = @_;
…		…
1378	sub change_all_map_light {	1728	sub change_all_map_light {
1379	my ($change) = @_;	1729	my ($change) = @_;
1380		1730
1381	$_->change_map_light ($change)	1731	$_->change_map_light ($change)
1382	for grep $_->outdoor, values %cf::MAP;	1732	for grep $_->outdoor, values %cf::MAP;
		1733	}
		1734
		1735	sub decay_objects {
		1736	my ($self) = @_;
		1737
		1738	return if $self->{deny_reset};
		1739
		1740	$self->do_decay_objects;
1383	}	1741	}
1384		1742
1385	sub unlink_save {	1743	sub unlink_save {
1386	my ($self) = @_;	1744	my ($self) = @_;
1387		1745
…		…
1445	$self->load_header_orig	1803	$self->load_header_orig
1446	or return;	1804	or return;
1447	$self->prepare_orig;	1805	$self->prepare_orig;
1448	}	1806	}
1449		1807
		1808	$self->{deny_reset} = 1
		1809	if $self->no_reset;
		1810
1450	$self->default_region (cf::region::find_by_path $self->{path})	1811	$self->default_region (cf::region::find_by_path $self->{path})
1451	unless $self->default_region;	1812	unless $self->default_region;
1452		1813
1453	1	1814	1
1454	}	1815	}
…		…
1469	$map->{last_save} = $cf::RUNTIME;	1830	$map->{last_save} = $cf::RUNTIME;
1470		1831
1471	$map->load_header	1832	$map->load_header
1472	or return;	1833	or return;
1473		1834
1474	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1835	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1475	# doing this can freeze the server in a sync job, obviously	1836	# doing this can freeze the server in a sync job, obviously
1476	#$cf::WAIT_FOR_TICK->wait;	1837	#$cf::WAIT_FOR_TICK->wait;
1477	$map->reset;	1838	$map->reset;
1478	undef $guard;	1839	undef $guard;
1479	return find $path;	1840	return find $path;
…		…
1492	local $self->{deny_reset} = 1; # loading can take a long time	1853	local $self->{deny_reset} = 1; # loading can take a long time
1493		1854
1494	my $path = $self->{path};	1855	my $path = $self->{path};
1495		1856
1496	{	1857	{
		1858	my $guard1 = cf::lock_acquire "map_data:$path";
1497	my $guard = cf::lock_acquire "map_load:$path";	1859	my $guard2 = cf::lock_acquire "map_load:$path";
1498		1860
1499	return if $self->in_memory != cf::MAP_SWAPPED;	1861	return if $self->in_memory != cf::MAP_SWAPPED;
1500		1862
1501	$self->in_memory (cf::MAP_LOADING);	1863	$self->in_memory (cf::MAP_LOADING);
1502		1864
1503	$self->alloc;	1865	$self->alloc;
1504		1866
1505	$self->pre_load;	1867	$self->pre_load;
1506	Coro::cede;	1868	cf::cede_to_tick;
1507		1869
1508	$self->_load_objects ($self->{load_path}, 1)	1870	$self->_load_objects ($self->{load_path}, 1)
1509	or return;	1871	or return;
1510		1872
1511	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1873	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
…		…
1517	$self->clear_unique_items;	1879	$self->clear_unique_items;
1518	$self->_load_objects ($uniq, 0);	1880	$self->_load_objects ($uniq, 0);
1519	}	1881	}
1520	}	1882	}
1521		1883
1522	Coro::cede;	1884	cf::cede_to_tick;
1523	# now do the right thing for maps	1885	# now do the right thing for maps
1524	$self->link_multipart_objects;	1886	$self->link_multipart_objects;
1525	$self->difficulty ($self->estimate_difficulty)	1887	$self->difficulty ($self->estimate_difficulty)
1526	unless $self->difficulty;	1888	unless $self->difficulty;
1527	Coro::cede;	1889	cf::cede_to_tick;
1528		1890
1529	unless ($self->{deny_activate}) {	1891	unless ($self->{deny_activate}) {
1530	$self->decay_objects;	1892	$self->decay_objects;
1531	$self->fix_auto_apply;	1893	$self->fix_auto_apply;
1532	$self->update_buttons;	1894	$self->update_buttons;
1533	Coro::cede;	1895	cf::cede_to_tick;
1534	$self->set_darkness_map;	1896	$self->set_darkness_map;
1535	Coro::cede;	1897	cf::cede_to_tick;
1536	$self->activate;	1898	$self->activate;
1537	}	1899	}
		1900
		1901	$self->{last_save} = $cf::RUNTIME;
		1902	$self->last_access ($cf::RUNTIME);
1538		1903
1539	$self->in_memory (cf::MAP_IN_MEMORY);	1904	$self->in_memory (cf::MAP_IN_MEMORY);
1540	}	1905	}
1541		1906
1542	$self->post_load;	1907	$self->post_load;
…		…
1546	my ($self, $ob) = @_;	1911	my ($self, $ob) = @_;
1547		1912
1548	return find "~" . $ob->name . "/" . $self->{path}	1913	return find "~" . $ob->name . "/" . $self->{path}
1549	if $self->per_player;	1914	if $self->per_player;
1550		1915
		1916	# return find "?party/" . $ob->name . "/" . $self->{path}
		1917	# if $self->per_party;
		1918
1551	$self	1919	$self
1552	}	1920	}
1553		1921
1554	# find and load all maps in the 3x3 area around a map	1922	# find and load all maps in the 3x3 area around a map
1555	sub load_diag {	1923	sub load_neighbours {
1556	my ($map) = @_;	1924	my ($map) = @_;
1557		1925
1558	my @diag; # diagonal neighbours	1926	my @neigh; # diagonal neighbours
1559		1927
1560	for (0 .. 3) {	1928	for (0 .. 3) {
1561	my $neigh = $map->tile_path ($_)	1929	my $neigh = $map->tile_path ($_)
1562	or next;	1930	or next;
1563	$neigh = find $neigh, $map	1931	$neigh = find $neigh, $map
1564	or next;	1932	or next;
1565	$neigh->load;	1933	$neigh->load;
1566		1934
		1935	push @neigh,
1567	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	1936	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1568	[$neigh->tile_path (($_ + 1) % 4), $neigh];	1937	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1569	}	1938	}
1570		1939
1571	for (@diag) {	1940	for (grep defined $_->[0], @neigh) {
		1941	my ($path, $origin) = @$_;
1572	my $neigh = find @$_	1942	my $neigh = find $path, $origin
1573	or next;	1943	or next;
1574	$neigh->load;	1944	$neigh->load;
1575	}	1945	}
1576	}	1946	}
1577		1947
…		…
1582	}	1952	}
1583		1953
1584	sub do_load_sync {	1954	sub do_load_sync {
1585	my ($map) = @_;	1955	my ($map) = @_;
1586		1956
		1957	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		1958	if $Coro::current == $Coro::main;
		1959
1587	cf::sync_job { $map->load };	1960	cf::sync_job { $map->load };
1588	}	1961	}
1589		1962
1590	our %MAP_PREFETCH;	1963	our %MAP_PREFETCH;
1591	our $MAP_PREFETCHER = undef;	1964	our $MAP_PREFETCHER = undef;
1592		1965
1593	sub find_async {	1966	sub find_async {
1594	my ($path, $origin) = @_;	1967	my ($path, $origin, $load) = @_;
1595		1968
1596	$path = normalise $path, $origin && $origin->{path};	1969	$path = normalise $path, $origin && $origin->{path};
1597		1970
1598	if (my $map = $cf::MAP{$path}) {	1971	if (my $map = $cf::MAP{$path}) {
1599	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	1972	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1600	}	1973	}
1601		1974
1602	undef $MAP_PREFETCH{$path};	1975	$MAP_PREFETCH{$path} |= $load;
		1976
1603	$MAP_PREFETCHER ||= cf::async {	1977	$MAP_PREFETCHER ||= cf::async {
1604	while (%MAP_PREFETCH) {	1978	while (%MAP_PREFETCH) {
1605	for my $path (keys %MAP_PREFETCH) {	1979	while (my ($k, $v) = each %MAP_PREFETCH) {
1606	my $map = find $path	1980	if (my $map = find $k) {
1607	or next;
1608	$map->load;	1981	$map->load if $v;
		1982	}
1609		1983
1610	delete $MAP_PREFETCH{$path};	1984	delete $MAP_PREFETCH{$k};
1611	}	1985	}
1612	}	1986	}
1613	undef $MAP_PREFETCHER;	1987	undef $MAP_PREFETCHER;
1614	};	1988	};
1615	$MAP_PREFETCHER->prio (6);	1989	$MAP_PREFETCHER->prio (6);
…		…
1618	}	1992	}
1619		1993
1620	sub save {	1994	sub save {
1621	my ($self) = @_;	1995	my ($self) = @_;
1622		1996
1623	my $lock = cf::lock_acquire "map_data:" . $self->path;	1997	my $lock = cf::lock_acquire "map_data:$self->{path}";
1624		1998
1625	$self->{last_save} = $cf::RUNTIME;	1999	$self->{last_save} = $cf::RUNTIME;
1626		2000
1627	return unless $self->dirty;	2001	return unless $self->dirty;
1628		2002
…		…
1651	my ($self) = @_;	2025	my ($self) = @_;
1652		2026
1653	# save first because save cedes	2027	# save first because save cedes
1654	$self->save;	2028	$self->save;
1655		2029
1656	my $lock = cf::lock_acquire "map_data:" . $self->path;	2030	my $lock = cf::lock_acquire "map_data:$self->{path}";
1657		2031
1658	return if $self->players;	2032	return if $self->players;
1659	return if $self->in_memory != cf::MAP_IN_MEMORY;	2033	return if $self->in_memory != cf::MAP_IN_MEMORY;
1660	return if $self->{deny_save};	2034	return if $self->{deny_save};
1661		2035
…		…
1665		2039
1666	sub reset_at {	2040	sub reset_at {
1667	my ($self) = @_;	2041	my ($self) = @_;
1668		2042
1669	# TODO: safety, remove and allow resettable per-player maps	2043	# TODO: safety, remove and allow resettable per-player maps
1670	return 1e99 if $self->isa ("ext::map_per_player");#d#
1671	return 1e99 if $self->{deny_reset};	2044	return 1e99 if $self->{deny_reset};
1672		2045
1673	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2046	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1674	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2047	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1675		2048
…		…
1686	my ($self) = @_;	2059	my ($self) = @_;
1687		2060
1688	my $lock = cf::lock_acquire "map_data:$self->{path}";	2061	my $lock = cf::lock_acquire "map_data:$self->{path}";
1689		2062
1690	return if $self->players;	2063	return if $self->players;
1691	return if $self->isa ("ext::map_per_player");#d#
1692		2064
1693	warn "resetting map ", $self->path;#d#	2065	warn "resetting map ", $self->path;
1694		2066
1695	$self->in_memory (cf::MAP_SWAPPED);	2067	$self->in_memory (cf::MAP_SWAPPED);
1696		2068
1697	# need to save uniques path	2069	# need to save uniques path
1698	unless ($self->{deny_save}) {	2070	unless ($self->{deny_save}) {
…		…
1715	my $nuke_counter = "aaaa";	2087	my $nuke_counter = "aaaa";
1716		2088
1717	sub nuke {	2089	sub nuke {
1718	my ($self) = @_;	2090	my ($self) = @_;
1719		2091
		2092	{
		2093	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2094
1720	delete $cf::MAP{$self->path};	2095	delete $cf::MAP{$self->path};
1721		2096
1722	$self->unlink_save;	2097	$self->unlink_save;
1723		2098
1724	bless $self, "cf::map";	2099	bless $self, "cf::map";
1725	delete $self->{deny_reset};	2100	delete $self->{deny_reset};
1726	$self->{deny_save} = 1;	2101	$self->{deny_save} = 1;
1727	$self->reset_timeout (1);	2102	$self->reset_timeout (1);
1728	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2103	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1729		2104
1730	$cf::MAP{$self->path} = $self;	2105	$cf::MAP{$self->path} = $self;
		2106	}
1731		2107
1732	$self->reset; # polite request, might not happen	2108	$self->reset; # polite request, might not happen
		2109	}
		2110
		2111	=item $maps = cf::map::tmp_maps
		2112
		2113	Returns an arrayref with all map paths of currently instantiated and saved
		2114	maps. May block.
		2115
		2116	=cut
		2117
		2118	sub tmp_maps() {
		2119	[
		2120	map {
		2121	utf8::decode $_;
		2122	/\.map$/
		2123	? normalise $_
		2124	: ()
		2125	} @{ aio_readdir $TMPDIR or [] }
		2126	]
		2127	}
		2128
		2129	=item $maps = cf::map::random_maps
		2130
		2131	Returns an arrayref with all map paths of currently instantiated and saved
		2132	random maps. May block.
		2133
		2134	=cut
		2135
		2136	sub random_maps() {
		2137	[
		2138	map {
		2139	utf8::decode $_;
		2140	/\.map$/
		2141	? normalise "?random/$_"
		2142	: ()
		2143	} @{ aio_readdir $RANDOMDIR or [] }
		2144	]
1733	}	2145	}
1734		2146
1735	=item cf::map::unique_maps	2147	=item cf::map::unique_maps
1736		2148
1737	Returns an arrayref of paths of all shared maps that have	2149	Returns an arrayref of paths of all shared maps that have
1738	instantiated unique items. May block.	2150	instantiated unique items. May block.
1739		2151
1740	=cut	2152	=cut
1741		2153
1742	sub unique_maps() {	2154	sub unique_maps() {
1743	my $files = aio_readdir $UNIQUEDIR	2155	[
1744	or return;	2156	map {
1745
1746	my @paths;
1747
1748	for (@$files) {
1749	utf8::decode $_;	2157	utf8::decode $_;
1750	next if /\.pst$/;	2158	/\.map$/
1751	next unless /^$PATH_SEP/o;	2159	? normalise $_
1752		2160	: ()
1753	push @paths, cf::map::normalise $_;	2161	} @{ aio_readdir $UNIQUEDIR or [] }
1754	}	2162	]
1755
1756	\@paths
1757	}	2163	}
1758		2164
1759	package cf;	2165	package cf;
1760		2166
1761	=back	2167	=back
…		…
1807		2213
1808	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2214	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1809		2215
1810	if ($self->{record_replies}) {	2216	if ($self->{record_replies}) {
1811	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2217	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2218
1812	} else {	2219	} else {
		2220	my $pl = $self->contr;
		2221
		2222	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2223	my $dialog = $pl->{npc_dialog};
		2224	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2225
		2226	} else {
1813	$msg = $npc->name . " says: $msg" if $npc;	2227	$msg = $npc->name . " says: $msg" if $npc;
1814	$self->message ($msg, $flags);	2228	$self->message ($msg, $flags);
		2229	}
1815	}	2230	}
		2231	}
		2232
		2233	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2234
		2235	=cut
		2236
		2237	sub cf::object::send_msg {
		2238	my $pl = shift->contr
		2239	or return;
		2240	$pl->send_msg (@_);
1816	}	2241	}
1817		2242
1818	=item $player_object->may ("access")	2243	=item $player_object->may ("access")
1819		2244
1820	Returns wether the given player is authorized to access resource "access"	2245	Returns wether the given player is authorized to access resource "access"
…		…
1867	$self->deactivate_recursive;	2292	$self->deactivate_recursive;
1868		2293
1869	return if UNIVERSAL::isa $self->map, "ext::map_link";	2294	return if UNIVERSAL::isa $self->map, "ext::map_link";
1870		2295
1871	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2296	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1872	if $self->map;	2297	if $self->map && $self->map->{path} ne "{link}";
1873		2298
1874	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2299	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1875	}	2300	}
1876		2301
1877	sub cf::object::player::leave_link {	2302	sub cf::object::player::leave_link {
1878	my ($self, $map, $x, $y) = @_;	2303	my ($self, $map, $x, $y) = @_;
		2304
		2305	return unless $self->contr->active;
1879		2306
1880	my $link_pos = delete $self->{_link_pos};	2307	my $link_pos = delete $self->{_link_pos};
1881		2308
1882	unless ($map) {	2309	unless ($map) {
1883	# restore original map position	2310	# restore original map position
…		…
1897	# use -1 or undef as default coordinates, not 0, 0	2324	# use -1 or undef as default coordinates, not 0, 0
1898	($x, $y) = ($map->enter_x, $map->enter_y)	2325	($x, $y) = ($map->enter_x, $map->enter_y)
1899	if $x <=0 && $y <= 0;	2326	if $x <=0 && $y <= 0;
1900		2327
1901	$map->load;	2328	$map->load;
1902	$map->load_diag;	2329	$map->load_neighbours;
1903		2330
1904	return unless $self->contr->active;	2331	return unless $self->contr->active;
1905	$self->activate_recursive;	2332	$self->activate_recursive;
1906		2333
1907	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2334	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1908	$self->enter_map ($map, $x, $y);	2335	$self->enter_map ($map, $x, $y);
1909	}	2336	}
1910		2337
1911	cf::player->attach (	2338	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1912	on_logout => sub {
1913	my ($pl) = @_;
1914		2339
1915	# abort map switching before logout	2340	Moves the player to the given map-path and coordinates by first freezing
1916	if ($pl->ob->{_link_pos}) {	2341	her, loading and preparing them map, calling the provided $check callback
1917	cf::sync_job {	2342	that has to return the map if sucecssful, and then unfreezes the player on
1918	$pl->ob->leave_link	2343	the new (success) or old (failed) map position. In either case, $done will
1919	};	2344	be called at the end of this process.
1920	}
1921	},
1922	on_login => sub {
1923	my ($pl) = @_;
1924		2345
1925	# try to abort aborted map switching on player login :)
1926	# should happen only on crashes
1927	if ($pl->ob->{_link_pos}) {
1928	$pl->ob->enter_link;
1929	(async {
1930	$pl->ob->reply (undef,
1931	"There was an internal problem at your last logout, "
1932	. "the server will try to bring you to your intended destination in a second.",
1933	cf::NDI_RED);
1934	# we need this sleep as the login has a concurrent enter_exit running
1935	# and this sleep increases chances of the player not ending up in scorn
1936	Coro::Timer::sleep 1;
1937	$pl->ob->leave_link;
1938	})->prio (2);
1939	}
1940	},
1941	);
1942
1943	=item $player_object->goto ($path, $x, $y)
1944
1945	=cut	2346	=cut
		2347
		2348	our $GOTOGEN;
1946		2349
1947	sub cf::object::player::goto {	2350	sub cf::object::player::goto {
1948	my ($self, $path, $x, $y) = @_;	2351	my ($self, $path, $x, $y, $check, $done) = @_;
		2352
		2353	# do generation counting so two concurrent goto's will be executed in-order
		2354	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1949		2355
1950	$self->enter_link;	2356	$self->enter_link;
1951		2357
1952	(async {	2358	(async {
1953	my $map = eval {	2359	my $map = eval {
1954	my $map = cf::map::find $path;	2360	my $map = cf::map::find $path;
		2361
		2362	if ($map) {
1955	$map = $map->customise_for ($self) if $map;	2363	$map = $map->customise_for ($self);
		2364	$map = $check->($map) if $check && $map;
		2365	} else {
		2366	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2367	}
		2368
1956	$map	2369	$map
		2370	};
		2371
		2372	if ($@) {
		2373	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2374	LOG llevError | logBacktrace, Carp::longmess $@;
1957	} or	2375	}
1958	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1959		2376
		2377	if ($gen == $self->{_goto_generation}) {
		2378	delete $self->{_goto_generation};
1960	$self->leave_link ($map, $x, $y);	2379	$self->leave_link ($map, $x, $y);
		2380	}
		2381
		2382	$done->() if $done;
1961	})->prio (1);	2383	})->prio (1);
1962	}	2384	}
1963		2385
1964	=item $player_object->enter_exit ($exit_object)	2386	=item $player_object->enter_exit ($exit_object)
1965		2387
…		…
2034	my $hp = $exit->stats->hp;	2456	my $hp = $exit->stats->hp;
2035	my $sp = $exit->stats->sp;	2457	my $sp = $exit->stats->sp;
2036		2458
2037	$self->enter_link;	2459	$self->enter_link;
2038		2460
		2461	# if exit is damned, update players death & WoR home-position
		2462	$self->contr->savebed ($slaying, $hp, $sp)
		2463	if $exit->flag (FLAG_DAMNED);
		2464
2039	(async {	2465	(async {
2040	$self->deactivate_recursive; # just to be sure	2466	$self->deactivate_recursive; # just to be sure
2041	unless (eval {	2467	unless (eval {
2042	$self->goto ($slaying, $hp, $sp);	2468	$self->goto ($slaying, $hp, $sp);
2043		2469
…		…
2070		2496
2071	utf8::encode $text;	2497	utf8::encode $text;
2072	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2498	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2073	}	2499	}
2074		2500
		2501	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2502
		2503	Send a drawinfo or msg packet to the client, formatting the msg for the
		2504	client if neccessary. C<$type> should be a string identifying the type of
		2505	the message, with C<log> being the default. If C<$color> is negative, suppress
		2506	the message unless the client supports the msg packet.
		2507
		2508	=cut
		2509
		2510	our %CHANNEL = (
		2511	"c/identify" => {
		2512	id => "identify",
		2513	title => "Identify",
		2514	reply => undef,
		2515	tooltip => "Items recently identified",
		2516	},
		2517	"c/examine" => {
		2518	id => "examine",
		2519	title => "Examine",
		2520	reply => undef,
		2521	tooltip => "Signs and other items you examined",
		2522	},
		2523	);
		2524
		2525	sub cf::client::send_msg {
		2526	my ($self, $channel, $msg, $color, @extra) = @_;
		2527
		2528	$msg = $self->pl->expand_cfpod ($msg);
		2529
		2530	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2531
		2532	# check predefined channels, for the benefit of C
		2533	$channel = $CHANNEL{$channel} if $CHANNEL{$channel};
		2534
		2535	if (ref $channel) {
		2536	# send meta info to client, if not yet sent
		2537	unless (exists $self->{channel}{$channel->{id}}) {
		2538	$self->{channel}{$channel->{id}} = $channel;
		2539	$self->ext_msg (channel_info => $channel)
		2540	if $self->can_msg;
		2541	}
		2542
		2543	$channel = $channel->{id};
		2544	}
		2545
		2546	return unless @extra || length $msg;
		2547
		2548	if ($self->can_msg) {
		2549	# default colour, mask it out
		2550	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2551	if $color & cf::NDI_DEF;
		2552
		2553	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2554	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2555	} else {
		2556	if ($color >= 0) {
		2557	# replace some tags by gcfclient-compatible ones
		2558	for ($msg) {
		2559	1 while
		2560	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2561	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2562	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2563	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2564	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2565	}
		2566
		2567	$color &= cf::NDI_COLOR_MASK;
		2568
		2569	utf8::encode $msg;
		2570
		2571	if (0 && $msg =~ /\[/) {
		2572	# COMMAND/INFO
		2573	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2574	} else {
		2575	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2576	$self->send_packet ("drawinfo $color $msg")
		2577	}
		2578	}
		2579	}
		2580	}
		2581
2075	=item $client->ext_event ($type, %msg)	2582	=item $client->ext_msg ($type, @msg)
2076		2583
2077	Sends an exti event to the client.	2584	Sends an ext event to the client.
2078		2585
2079	=cut	2586	=cut
2080		2587
2081	sub cf::client::ext_event($$%) {	2588	sub cf::client::ext_msg($$@) {
2082	my ($self, $type, %msg) = @_;	2589	my ($self, $type, @msg) = @_;
2083		2590
		2591	if ($self->extcmd == 2) {
		2592	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2593	} elsif ($self->extcmd == 1) { # TODO: remove
2084	$msg{msgtype} = "event_$type";	2594	push @msg, msgtype => "event_$type";
2085	$self->send_packet ("ext " . cf::to_json \%msg);	2595	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2596	}
		2597	}
		2598
		2599	=item $client->ext_reply ($msgid, @msg)
		2600
		2601	Sends an ext reply to the client.
		2602
		2603	=cut
		2604
		2605	sub cf::client::ext_reply($$@) {
		2606	my ($self, $id, @msg) = @_;
		2607
		2608	if ($self->extcmd == 2) {
		2609	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2610	} elsif ($self->extcmd == 1) {
		2611	#TODO: version 1, remove
		2612	unshift @msg, msgtype => "reply", msgid => $id;
		2613	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2614	}
2086	}	2615	}
2087		2616
2088	=item $success = $client->query ($flags, "text", \&cb)	2617	=item $success = $client->query ($flags, "text", \&cb)
2089		2618
2090	Queues a query to the client, calling the given callback with	2619	Queues a query to the client, calling the given callback with
2091	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2620	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2092	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2621	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2093		2622
2094	Queries can fail, so check the return code. Or don't, as queries will become	2623	Queries can fail, so check the return code. Or don't, as queries will
2095	reliable at some point in the future.	2624	become reliable at some point in the future.
2096		2625
2097	=cut	2626	=cut
2098		2627
2099	sub cf::client::query {	2628	sub cf::client::query {
2100	my ($self, $flags, $text, $cb) = @_;	2629	my ($self, $flags, $text, $cb) = @_;
…		…
2108	utf8::encode $text;	2637	utf8::encode $text;
2109	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2638	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2110		2639
2111	$self->send_packet ($self->{query_queue}[0][0])	2640	$self->send_packet ($self->{query_queue}[0][0])
2112	if @{ $self->{query_queue} } == 1;	2641	if @{ $self->{query_queue} } == 1;
		2642
		2643	1
2113	}	2644	}
2114		2645
2115	cf::client->attach (	2646	cf::client->attach (
		2647	on_connect => sub {
		2648	my ($ns) = @_;
		2649
		2650	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2651	},
2116	on_reply => sub {	2652	on_reply => sub {
2117	my ($ns, $msg) = @_;	2653	my ($ns, $msg) = @_;
2118		2654
2119	# this weird shuffling is so that direct followup queries	2655	# this weird shuffling is so that direct followup queries
2120	# get handled first	2656	# get handled first
…		…
2132	} else {	2668	} else {
2133	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2669	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2134	}	2670	}
2135	}	2671	}
2136	},	2672	},
		2673	on_exticmd => sub {
		2674	my ($ns, $buf) = @_;
		2675
		2676	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2677
		2678	if (ref $msg) {
		2679	my ($type, $reply, @payload) =
		2680	"ARRAY" eq ref $msg
		2681	? @$msg
		2682	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2683
		2684	my @reply;
		2685
		2686	if (my $cb = $EXTICMD{$type}) {
		2687	@reply = $cb->($ns, @payload);
		2688	}
		2689
		2690	$ns->ext_reply ($reply, @reply)
		2691	if $reply;
		2692
		2693	} else {
		2694	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2695	}
		2696
		2697	cf::override;
		2698	},
2137	);	2699	);
2138		2700
2139	=item $client->async (\&cb)	2701	=item $client->async (\&cb)
2140		2702
2141	Create a new coroutine, running the specified callback. The coroutine will	2703	Create a new coroutine, running the specified callback. The coroutine will
…		…
2182	our $safe = new Safe "safe";	2744	our $safe = new Safe "safe";
2183	our $safe_hole = new Safe::Hole;	2745	our $safe_hole = new Safe::Hole;
2184		2746
2185	$SIG{FPE} = 'IGNORE';	2747	$SIG{FPE} = 'IGNORE';
2186		2748
2187	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2749	$safe->permit_only (Opcode::opset qw(
		2750	:base_core :base_mem :base_orig :base_math
		2751	grepstart grepwhile mapstart mapwhile
		2752	sort time
		2753	));
2188		2754
2189	# here we export the classes and methods available to script code	2755	# here we export the classes and methods available to script code
2190		2756
2191	=pod	2757	=pod
2192		2758
2193	The following functions and methods are available within a safe environment:	2759	The following functions and methods are available within a safe environment:
2194		2760
2195	cf::object contr pay_amount pay_player map	2761	cf::object
		2762	contr pay_amount pay_player map x y force_find force_add
		2763	insert remove name archname title slaying race decrease_ob_nr
		2764
2196	cf::object::player player	2765	cf::object::player
2197	cf::player peaceful	2766	player
2198	cf::map trigger	2767
		2768	cf::player
		2769	peaceful
		2770
		2771	cf::map
		2772	trigger
2199		2773
2200	=cut	2774	=cut
2201		2775
2202	for (	2776	for (
2203	["cf::object" => qw(contr pay_amount pay_player map)],	2777	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2778	insert remove inv name archname title slaying race
		2779	decrease_ob_nr)],
2204	["cf::object::player" => qw(player)],	2780	["cf::object::player" => qw(player)],
2205	["cf::player" => qw(peaceful)],	2781	["cf::player" => qw(peaceful)],
2206	["cf::map" => qw(trigger)],	2782	["cf::map" => qw(trigger)],
2207	) {	2783	) {
2208	no strict 'refs';	2784	no strict 'refs';
…		…
2279	=back	2855	=back
2280		2856
2281	=cut	2857	=cut
2282		2858
2283	#############################################################################	2859	#############################################################################
2284
2285	=head2 EXTENSION DATABASE SUPPORT
2286
2287	Crossfire maintains a very simple database for extension use. It can
2288	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2289	convert to/from binary).
2290
2291	The parameter C<$family> should best start with the name of the extension
2292	using it, it should be unique.
2293
2294	=over 4
2295
2296	=item $value = cf::db_get $family => $key
2297
2298	Returns a single value from the database.
2299
2300	=item cf::db_put $family => $key => $value
2301
2302	Stores the given C<$value> in the family.
2303
2304	=cut
2305
2306	our $DB;
2307
2308	sub db_init {
2309	unless ($DB) {
2310	$DB = BDB::db_create $DB_ENV;
2311
2312	cf::sync_job {
2313	eval {
2314	$DB->set_flags (BDB::CHKSUM);
2315
2316	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2317	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2318	cf::cleanup "db_open(db): $!" if $!;
2319	};
2320	cf::cleanup "db_open(db): $@" if $@;
2321	};
2322	}
2323	}
2324
2325	sub db_get($$) {
2326	my $key = "$_[0]/$_[1]";
2327
2328	cf::sync_job {
2329	BDB::db_get $DB, undef, $key, my $data;
2330
2331	$! ? ()
2332	: $data
2333	}
2334	}
2335
2336	sub db_put($$$) {
2337	BDB::dbreq_pri 4;
2338	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2339	}
2340
2341	=item cf::cache $id => [$paths...], $processversion => $process
2342
2343	Generic caching function that returns the value of the resource $id,
2344	caching and regenerating as required.
2345
2346	This function can block.
2347
2348	=cut
2349
2350	sub cache {
2351	my ($id, $src, $processversion, $process) = @_;
2352
2353	my $meta =
2354	join "\x00",
2355	$processversion,
2356	map {
2357	aio_stat $_
2358	and Carp::croak "$_: $!";
2359
2360	($_, (stat _)[7,9])
2361	} @$src;
2362
2363	my $dbmeta = db_get cache => "$id/meta";
2364	if ($dbmeta ne $meta) {
2365	# changed, we may need to process
2366
2367	my @data;
2368	my $md5;
2369
2370	for (0 .. $#$src) {
2371	0 <= aio_load $src->[$_], $data[$_]
2372	or Carp::croak "$src->[$_]: $!";
2373	}
2374
2375	# if processing is expensive, check
2376	# checksum first
2377	if (1) {
2378	$md5 =
2379	join "\x00",
2380	$processversion,
2381	map {
2382	Coro::cede;
2383	($src->[$_], Digest::MD5::md5_hex $data[$_])
2384	} 0.. $#$src;
2385
2386
2387	my $dbmd5 = db_get cache => "$id/md5";
2388	if ($dbmd5 eq $md5) {
2389	db_put cache => "$id/meta", $meta;
2390
2391	return db_get cache => "$id/data";
2392	}
2393	}
2394
2395	my $t1 = Time::HiRes::time;
2396	my $data = $process->(\@data);
2397	my $t2 = Time::HiRes::time;
2398
2399	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2400
2401	db_put cache => "$id/data", $data;
2402	db_put cache => "$id/md5" , $md5;
2403	db_put cache => "$id/meta", $meta;
2404
2405	return $data;
2406	}
2407
2408	db_get cache => "$id/data"
2409	}
2410
2411	=item fork_call { }, $args
2412
2413	Executes the given code block with the given arguments in a seperate
2414	process, returning the results. Everything must be serialisable with
2415	Coro::Storable. May, of course, block. Note that the executed sub may
2416	never block itself or use any form of Event handling.
2417
2418	=cut
2419
2420	sub fork_call(&@) {
2421	my ($cb, @args) = @_;
2422
2423	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2424	# or die "socketpair: $!";
2425	pipe my $fh1, my $fh2
2426	or die "pipe: $!";
2427
2428	if (my $pid = fork) {
2429	close $fh2;
2430
2431	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2432	$res = Coro::Storable::thaw $res;
2433
2434	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2435
2436	die $$res unless "ARRAY" eq ref $res;
2437
2438	return wantarray ? @$res : $res->[-1];
2439	} else {
2440	reset_signals;
2441	local $SIG{__WARN__};
2442	local $SIG{__DIE__};
2443	eval {
2444	close $fh1;
2445
2446	my @res = eval { $cb->(@args) };
2447	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2448	};
2449
2450	warn $@ if $@;
2451	_exit 0;
2452	}
2453	}
2454
2455
2456
2457	#############################################################################
2458	# the server's init and main functions	2860	# the server's init and main functions
2459		2861
2460	sub load_facedata($) {	2862	sub load_facedata($) {
2461	my ($path) = @_;	2863	my ($path) = @_;
		2864
		2865	# HACK to clear player env face cache, we need some signal framework
		2866	# for this (global event?)
		2867	%ext::player_env::MUSIC_FACE_CACHE = ();
		2868
		2869	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2462		2870
2463	warn "loading facedata from $path\n";	2871	warn "loading facedata from $path\n";
2464		2872
2465	my $facedata;	2873	my $facedata;
2466	0 < aio_load $path, $facedata	2874	0 < aio_load $path, $facedata
…		…
2469	$facedata = Coro::Storable::thaw $facedata;	2877	$facedata = Coro::Storable::thaw $facedata;
2470		2878
2471	$facedata->{version} == 2	2879	$facedata->{version} == 2
2472	or cf::cleanup "$path: version mismatch, cannot proceed.";	2880	or cf::cleanup "$path: version mismatch, cannot proceed.";
2473		2881
		2882	# patch in the exptable
		2883	$facedata->{resource}{"res/exp_table"} = {
		2884	type => FT_RSRC,
		2885	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
		2886	};
		2887	cf::cede_to_tick;
		2888
2474	{	2889	{
2475	my $faces = $facedata->{faceinfo};	2890	my $faces = $facedata->{faceinfo};
2476		2891
2477	while (my ($face, $info) = each %$faces) {	2892	while (my ($face, $info) = each %$faces) {
2478	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2893	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2479	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2894	cf::face::set_visibility $idx, $info->{visibility};
		2895	cf::face::set_magicmap $idx, $info->{magicmap};
2480	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2896	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2481	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	2897	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2482	Coro::cede;	2898
		2899	cf::cede_to_tick;
2483	}	2900	}
2484		2901
2485	while (my ($face, $info) = each %$faces) {	2902	while (my ($face, $info) = each %$faces) {
2486	next unless $info->{smooth};	2903	next unless $info->{smooth};
2487	my $idx = cf::face::find $face	2904	my $idx = cf::face::find $face
2488	or next;	2905	or next;
2489	if (my $smooth = cf::face::find $info->{smooth}) {	2906	if (my $smooth = cf::face::find $info->{smooth}) {
		2907	cf::face::set_smooth $idx, $smooth;
2490	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	2908	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2491	} else {	2909	} else {
2492	warn "smooth face '$info->{smooth}' not found for face '$face'";	2910	warn "smooth face '$info->{smooth}' not found for face '$face'";
2493	}	2911	}
2494	Coro::cede;	2912
		2913	cf::cede_to_tick;
2495	}	2914	}
2496	}	2915	}
2497		2916
2498	{	2917	{
2499	my $anims = $facedata->{animinfo};	2918	my $anims = $facedata->{animinfo};
2500		2919
2501	while (my ($anim, $info) = each %$anims) {	2920	while (my ($anim, $info) = each %$anims) {
2502	cf::anim::set $anim, $info->{frames}, $info->{facings};	2921	cf::anim::set $anim, $info->{frames}, $info->{facings};
2503	Coro::cede;	2922	cf::cede_to_tick;
2504	}	2923	}
2505		2924
2506	cf::anim::invalidate_all; # d'oh	2925	cf::anim::invalidate_all; # d'oh
2507	}	2926	}
2508		2927
		2928	{
		2929	# TODO: for gcfclient pleasure, we should give resources
		2930	# that gcfclient doesn't grok a >10000 face index.
		2931	my $res = $facedata->{resource};
		2932
		2933	my $soundconf = delete $res->{"res/sound.conf"};
		2934
		2935	while (my ($name, $info) = each %$res) {
		2936	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2937	my $data;
		2938
		2939	if ($info->{type} & 1) {
		2940	# prepend meta info
		2941
		2942	my $meta = $enc->encode ({
		2943	name => $name,
		2944	%{ $info->{meta} || {} },
		2945	});
		2946
		2947	$data = pack "(w/a*)*", $meta, $info->{data};
		2948	} else {
		2949	$data = $info->{data};
		2950	}
		2951
		2952	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		2953	cf::face::set_type $idx, $info->{type};
		2954
		2955	cf::cede_to_tick;
		2956	}
		2957
		2958	if ($soundconf) {
		2959	$soundconf = $enc->decode (delete $soundconf->{data});
		2960
		2961	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2962	my $sound = $soundconf->{compat}[$_]
		2963	or next;
		2964
		2965	my $face = cf::face::find "sound/$sound->[1]";
		2966	cf::sound::set $sound->[0] => $face;
		2967	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2968	}
		2969
		2970	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2971	my $face = cf::face::find "sound/$v";
		2972	cf::sound::set $k => $face;
		2973	}
		2974	}
		2975	}
		2976
2509	1	2977	1
2510	}	2978	}
2511		2979
		2980	register_exticmd fx_want => sub {
		2981	my ($ns, $want) = @_;
		2982
		2983	while (my ($k, $v) = each %$want) {
		2984	$ns->fx_want ($k, $v);
		2985	}
		2986	};
		2987
2512	sub reload_regions {	2988	sub reload_regions {
		2989	# HACK to clear player env face cache, we need some signal framework
		2990	# for this (global event?)
		2991	%ext::player_env::MUSIC_FACE_CACHE = ();
		2992
2513	load_resource_file "$MAPDIR/regions"	2993	load_resource_file "$MAPDIR/regions"
2514	or die "unable to load regions file\n";	2994	or die "unable to load regions file\n";
		2995
		2996	for (cf::region::list) {
		2997	$_->{match} = qr/$_->{match}/
		2998	if exists $_->{match};
		2999	}
2515	}	3000	}
2516		3001
2517	sub reload_facedata {	3002	sub reload_facedata {
2518	load_facedata "$DATADIR/facedata"	3003	load_facedata "$DATADIR/facedata"
2519	or die "unable to load facedata\n";	3004	or die "unable to load facedata\n";
2520	}	3005	}
2521		3006
2522	sub reload_archetypes {	3007	sub reload_archetypes {
2523	load_resource_file "$DATADIR/archetypes"	3008	load_resource_file "$DATADIR/archetypes"
2524	or die "unable to load archetypes\n";	3009	or die "unable to load archetypes\n";
		3010	#d# NEED to laod twice to resolve forward references
		3011	# this really needs to be done in an extra post-pass
		3012	# (which needs to be synchronous, so solve it differently)
		3013	load_resource_file "$DATADIR/archetypes"
		3014	or die "unable to load archetypes\n";
2525	}	3015	}
2526		3016
2527	sub reload_treasures {	3017	sub reload_treasures {
2528	load_resource_file "$DATADIR/treasures"	3018	load_resource_file "$DATADIR/treasures"
2529	or die "unable to load treasurelists\n";	3019	or die "unable to load treasurelists\n";
…		…
2532	sub reload_resources {	3022	sub reload_resources {
2533	warn "reloading resource files...\n";	3023	warn "reloading resource files...\n";
2534		3024
2535	reload_regions;	3025	reload_regions;
2536	reload_facedata;	3026	reload_facedata;
		3027	#reload_archetypes;#d#
2537	reload_archetypes;	3028	reload_archetypes;
2538	reload_treasures;	3029	reload_treasures;
2539		3030
2540	warn "finished reloading resource files\n";	3031	warn "finished reloading resource files\n";
2541	}	3032	}
2542		3033
2543	sub init {	3034	sub init {
2544	reload_resources;	3035	reload_resources;
2545	}	3036	}
2546		3037
2547	sub cfg_load {	3038	sub reload_config {
2548	open my $fh, "<:utf8", "$CONFDIR/config"	3039	open my $fh, "<:utf8", "$CONFDIR/config"
2549	or return;	3040	or return;
2550		3041
2551	local $/;	3042	local $/;
2552	*CFG = YAML::Syck::Load <$fh>;	3043	*CFG = YAML::Syck::Load <$fh>;
…		…
2572	(async {	3063	(async {
2573	Event::one_event;	3064	Event::one_event;
2574	})->prio (Coro::PRIO_MAX);	3065	})->prio (Coro::PRIO_MAX);
2575	};	3066	};
2576		3067
2577	cfg_load;	3068	reload_config;
2578	db_init;	3069	db_init;
2579	load_extensions;	3070	load_extensions;
2580		3071
2581	$TICK_WATCHER->start;	3072	$TICK_WATCHER->start;
2582	Event::loop;	3073	Event::loop;
…		…
2598	},	3089	},
2599	);	3090	);
2600	}	3091	}
2601	}	3092	}
2602		3093
		3094	sub write_runtime {
		3095	my $runtime = "$LOCALDIR/runtime";
		3096
		3097	# first touch the runtime file to show we are still running:
		3098	# the fsync below can take a very very long time.
		3099
		3100	IO::AIO::aio_utime $runtime, undef, undef;
		3101
		3102	my $guard = cf::lock_acquire "write_runtime";
		3103
		3104	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3105	or return;
		3106
		3107	my $value = $cf::RUNTIME + 90 + 10;
		3108	# 10 is the runtime save interval, for a monotonic clock
		3109	# 60 allows for the watchdog to kill the server.
		3110
		3111	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3112	and return;
		3113
		3114	# always fsync - this file is important
		3115	aio_fsync $fh
		3116	and return;
		3117
		3118	# touch it again to show we are up-to-date
		3119	aio_utime $fh, undef, undef;
		3120
		3121	close $fh
		3122	or return;
		3123
		3124	aio_rename "$runtime~", $runtime
		3125	and return;
		3126
		3127	warn "runtime file written.\n";
		3128
		3129	1
		3130	}
		3131
2603	sub emergency_save() {	3132	sub emergency_save() {
2604	my $freeze_guard = cf::freeze_mainloop;	3133	my $freeze_guard = cf::freeze_mainloop;
2605		3134
2606	warn "enter emergency perl save\n";	3135	warn "enter emergency perl save\n";
2607		3136
…		…
2682	%EXT_CORO = ();	3211	%EXT_CORO = ();
2683		3212
2684	warn "removing commands";	3213	warn "removing commands";
2685	%COMMAND = ();	3214	%COMMAND = ();
2686		3215
2687	warn "removing ext commands";	3216	warn "removing ext/exti commands";
2688	%EXTCMD = ();	3217	%EXTCMD = ();
		3218	%EXTICMD = ();
2689		3219
2690	warn "unloading/nuking all extensions";	3220	warn "unloading/nuking all extensions";
2691	for my $pkg (@EXTS) {	3221	for my $pkg (@EXTS) {
2692	warn "... unloading $pkg";	3222	warn "... unloading $pkg";
2693		3223
…		…
2736	warn "reloading cf.pm";	3266	warn "reloading cf.pm";
2737	require cf;	3267	require cf;
2738	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3268	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2739		3269
2740	warn "loading config and database again";	3270	warn "loading config and database again";
2741	cf::cfg_load;	3271	cf::reload_config;
2742		3272
2743	warn "loading extensions";	3273	warn "loading extensions";
2744	cf::load_extensions;	3274	cf::load_extensions;
2745		3275
2746	warn "reattaching attachments to objects/players";	3276	warn "reattaching attachments to objects/players";
…		…
2811	my $signal = new Coro::Signal;	3341	my $signal = new Coro::Signal;
2812	push @WAIT_FOR_TICK_BEGIN, $signal;	3342	push @WAIT_FOR_TICK_BEGIN, $signal;
2813	$signal->wait;	3343	$signal->wait;
2814	}	3344	}
2815		3345
		3346	my $min = 1e6;#d#
		3347	my $avg = 10;
2816	$TICK_WATCHER = Event->timer (	3348	$TICK_WATCHER = Event->timer (
2817	reentrant => 0,	3349	reentrant => 0,
2818	parked => 1,	3350	parked => 1,
2819	prio => 0,	3351	prio => 0,
2820	at => $NEXT_TICK || $TICK,	3352	at => $NEXT_TICK || $TICK,
…		…
2824	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3356	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2825	unless ++$bug_warning > 10;	3357	unless ++$bug_warning > 10;
2826	return;	3358	return;
2827	}	3359	}
2828		3360
2829	$NOW = Event::time;	3361	$NOW = $tick_start = Event::time;
2830		3362
2831	cf::server_tick; # one server iteration	3363	cf::server_tick; # one server iteration
		3364
		3365	0 && sync_job {#d#
		3366	for(1..10) {
		3367	my $t = Event::time;
		3368	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3369	or die;
		3370
		3371	$map->width (50);
		3372	$map->height (50);
		3373	$map->alloc;
		3374	$map->_load_objects ("/tmp/x.map", 1);
		3375	my $t = Event::time - $t;
		3376
		3377	#next unless $t < 0.0013;#d#
		3378	if ($t < $min) {
		3379	$min = $t;
		3380	}
		3381	$avg = $avg * 0.99 + $t * 0.01;
		3382	}
		3383	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3384	exit 0;
		3385	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3386	};
2832		3387
2833	$RUNTIME += $TICK;	3388	$RUNTIME += $TICK;
2834	$NEXT_TICK += $TICK;	3389	$NEXT_TICK += $TICK;
2835		3390
2836	if ($NOW >= $NEXT_RUNTIME_WRITE) {	3391	if ($NOW >= $NEXT_RUNTIME_WRITE) {
…		…
2842	}	3397	}
2843		3398
2844	# my $AFTER = Event::time;	3399	# my $AFTER = Event::time;
2845	# warn $AFTER - $NOW;#d#	3400	# warn $AFTER - $NOW;#d#
2846		3401
		3402	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3403	$sig->send;
		3404	}
		3405	while (my $sig = shift @WAIT_FOR_TICK) {
		3406	$sig->send;
		3407	}
		3408
		3409	$NOW = Event::time;
		3410
2847	# if we are delayed by four ticks or more, skip them all	3411	# if we are delayed by four ticks or more, skip them all
2848	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3412	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2849		3413
2850	$TICK_WATCHER->at ($NEXT_TICK);	3414	$TICK_WATCHER->at ($NEXT_TICK);
2851	$TICK_WATCHER->start;	3415	$TICK_WATCHER->start;
2852		3416
2853	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {	3417	$LOAD = ($NOW - $tick_start) / $TICK;
2854	$sig->send;	3418	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2855	}
2856	while (my $sig = shift @WAIT_FOR_TICK) {
2857	$sig->send;
2858	}
2859		3419
2860	_post_tick;	3420	_post_tick;
		3421
		3422
2861	},	3423	},
2862	);	3424	);
2863		3425
2864	{	3426	{
2865	BDB::max_poll_time $TICK * 0.1;	3427	BDB::max_poll_time $TICK * 0.1;

Diff Legend

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