ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/cf.schmorp.de/server/lib/cf.pm

Comparing cf.schmorp.de/server/lib/cf.pm (file contents):
Revision 1.264 by root, Sun May 6 05:44:48 2007 UTC vs.
Revision 1.388 by root, Thu Oct 18 02:56:13 2007 UTC

…		…
4	use strict;	4	use strict;
5		5
6	use Symbol;	6	use Symbol;
7	use List::Util;	7	use List::Util;
8	use Socket;	8	use Socket;
9	use Storable;
10	use Event;	9	use Event;
11	use Opcode;	10	use Opcode;
12	use Safe;	11	use Safe;
13	use Safe::Hole;	12	use Safe::Hole;
		13	use Storable ();
14		14
15	use Coro 3.61 ();	15	use Coro 4.1 ();
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.51 ();
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;
…		…
76	our $NEXT_TICK;	80	our $NEXT_TICK;
77	our $NOW;	81	our $NOW;
78	our $USE_FSYNC = 1; # use fsync to write maps - default off	82	our $USE_FSYNC = 1; # use fsync to write maps - default off
79		83
80	our $BDB_POLL_WATCHER;	84	our $BDB_POLL_WATCHER;
		85	our $BDB_DEADLOCK_WATCHER;
		86	our $BDB_CHECKPOINT_WATCHER;
		87	our $BDB_TRICKLE_WATCHER;
81	our $DB_ENV;	88	our $DB_ENV;
82		89
83	our %CFG;	90	our %CFG;
84		91
85	our $UPTIME; $UPTIME ||= time;	92	our $UPTIME; $UPTIME ||= time;
86	our $RUNTIME;	93	our $RUNTIME;
87		94
88	our %PLAYER; # all users	95	our (%PLAYER, %PLAYER_LOADING); # all users
89	our %MAP; # all maps	96	our (%MAP, %MAP_LOADING ); # all maps
90	our $LINK_MAP; # the special {link} map, which is always available	97	our $LINK_MAP; # the special {link} map, which is always available
91		98
92	# used to convert map paths into valid unix filenames by replacing / by ∕	99	# used to convert map paths into valid unix filenames by replacing / by ∕
93	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	100	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		101
		102	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		103	our $LOADAVG; # same thing, but with alpha-smoothing
		104	our $tick_start; # for load detecting purposes
94		105
95	binmode STDOUT;	106	binmode STDOUT;
96	binmode STDERR;	107	binmode STDERR;
97		108
98	# read virtual server time, if available	109	# read virtual server time, if available
…		…
139		150
140	=item $cf::TICK	151	=item $cf::TICK
141		152
142	The interval between server ticks, in seconds.	153	The interval between server ticks, in seconds.
143		154
		155	=item $cf::LOADAVG
		156
		157	The current CPU load on the server (alpha-smoothed), as a value between 0
		158	(none) and 1 (overloaded), indicating how much time is spent on processing
		159	objects per tick. Healthy values are < 0.5.
		160
		161	=item $cf::LOAD
		162
		163	The raw value load value from the last tick.
		164
144	=item %cf::CFG	165	=item %cf::CFG
145		166
146	Configuration for the server, loaded from C</etc/crossfire/config>, or	167	Configuration for the server, loaded from C</etc/crossfire/config>, or
147	from wherever your confdir points to.	168	from wherever your confdir points to.
148		169
…		…
150		171
151	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only	172	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	173	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.	174	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
154		175
		176	=item @cf::INVOKE_RESULTS
		177
		178	This array contains the results of the last C<invoke ()> call. When
		179	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		180	that call.
		181
155	=back	182	=back
156		183
157	=cut	184	=cut
158		185
159	BEGIN {	186	BEGIN {
…		…
163	$msg .= "\n"	190	$msg .= "\n"
164	unless $msg =~ /\n$/;	191	unless $msg =~ /\n$/;
165		192
166	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;	193	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
167		194
168	utf8::encode $msg;
169	LOG llevError, $msg;	195	LOG llevError, $msg;
170	};	196	};
171	}	197	}
172		198
173	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	199	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
174	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	200	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
175	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	201	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
176	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	202	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
177	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	203	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		204	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
178	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	205	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
179		206
180	# we bless all objects into (empty) derived classes to force a method lookup	207	# we bless all objects into (empty) derived classes to force a method lookup
181	# within the Safe compartment.	208	# within the Safe compartment.
182	for my $pkg (qw(	209	for my $pkg (qw(
183	cf::global cf::attachable	210	cf::global cf::attachable
…		…
191	}	218	}
192		219
193	$Event::DIED = sub {	220	$Event::DIED = sub {
194	warn "error in event callback: @_";	221	warn "error in event callback: @_";
195	};	222	};
		223
		224	#############################################################################
196		225
197	=head2 UTILITY FUNCTIONS	226	=head2 UTILITY FUNCTIONS
198		227
199	=over 4	228	=over 4
200		229
…		…
219	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	248	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
220	$d	249	$d
221	} || "[unable to dump $_[0]: '$@']";	250	} || "[unable to dump $_[0]: '$@']";
222	}	251	}
223		252
224	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
225
226	=item $ref = cf::from_json $json	253	=item $ref = cf::from_json $json
227		254
228	Converts a JSON string into the corresponding perl data structure.	255	Converts a JSON string into the corresponding perl data structure.
229		256
230	=item $json = cf::to_json $ref	257	=item $json = cf::to_json $ref
231		258
232	Converts a perl data structure into its JSON representation.	259	Converts a perl data structure into its JSON representation.
		260
		261	=cut
		262
		263	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
		264
		265	sub to_json ($) { $json_coder->encode ($_[0]) }
		266	sub from_json ($) { $json_coder->decode ($_[0]) }
233		267
234	=item cf::lock_wait $string	268	=item cf::lock_wait $string
235		269
236	Wait until the given lock is available. See cf::lock_acquire.	270	Wait until the given lock is available. See cf::lock_acquire.
237		271
…		…
240	Wait until the given lock is available and then acquires it and returns	274	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,	275	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	276	for example when the coroutine gets canceled), the lock is automatically
243	returned.	277	returned.
244		278
		279	Locks are *not* recursive, locking from the same coro twice results in a
		280	deadlocked coro.
		281
245	Lock names should begin with a unique identifier (for example, cf::map::find	282	Lock names should begin with a unique identifier (for example, cf::map::find
246	uses map_find and cf::map::load uses map_load).	283	uses map_find and cf::map::load uses map_load).
247		284
248	=item $locked = cf::lock_active $string	285	=item $locked = cf::lock_active $string
249		286
250	Return true if the lock is currently active, i.e. somebody has locked it.	287	Return true if the lock is currently active, i.e. somebody has locked it.
251		288
252	=cut	289	=cut
253		290
254	our %LOCK;	291	our %LOCK;
		292	our %LOCKER;#d#
255		293
256	sub lock_wait($) {	294	sub lock_wait($) {
257	my ($key) = @_;	295	my ($key) = @_;
		296
		297	if ($LOCKER{$key} == $Coro::current) {#d#
		298	Carp::cluck "lock_wait($key) for already-acquired lock";#d#
		299	return;#d#
		300	}#d#
258		301
259	# wait for lock, if any	302	# wait for lock, if any
260	while ($LOCK{$key}) {	303	while ($LOCK{$key}) {
261	push @{ $LOCK{$key} }, $Coro::current;	304	push @{ $LOCK{$key} }, $Coro::current;
262	Coro::schedule;	305	Coro::schedule;
…		…
268		311
269	# wait, to be sure we are not locked	312	# wait, to be sure we are not locked
270	lock_wait $key;	313	lock_wait $key;
271		314
272	$LOCK{$key} = [];	315	$LOCK{$key} = [];
		316	$LOCKER{$key} = $Coro::current;#d#
273		317
274	Coro::guard {	318	Coro::guard {
		319	delete $LOCKER{$key};#d#
275	# wake up all waiters, to be on the safe side	320	# wake up all waiters, to be on the safe side
276	$_->ready for @{ delete $LOCK{$key} };	321	$_->ready for @{ delete $LOCK{$key} };
277	}	322	}
278	}	323	}
279		324
…		…
291	};	336	};
292	$TICK_WATCHER->stop;	337	$TICK_WATCHER->stop;
293	$guard	338	$guard
294	}	339	}
295		340
		341	=item cf::get_slot $time[, $priority[, $name]]
		342
		343	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		344	This call blocks and returns only when you have at least C<$time> seconds
		345	of cpu time till the next tick. The slot is only valid till the next cede.
		346
		347	The optional C<$name> can be used to identify the job to run. It might be
		348	used for statistical purposes and should identify the same time-class.
		349
		350	Useful for short background jobs.
		351
		352	=cut
		353
		354	our @SLOT_QUEUE;
		355	our $SLOT_QUEUE;
		356
		357	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		358	$SLOT_QUEUE = Coro::async {
		359	$Coro::current->desc ("timeslot manager");
		360
		361	my $signal = new Coro::Signal;
		362
		363	while () {
		364	next_job:
		365	my $avail = cf::till_tick;
		366	if ($avail > 0.01) {
		367	for (0 .. $#SLOT_QUEUE) {
		368	if ($SLOT_QUEUE[$_][0] < $avail) {
		369	my $job = splice @SLOT_QUEUE, $_, 1, ();
		370	$job->[2]->send;
		371	Coro::cede;
		372	goto next_job;
		373	}
		374	}
		375	}
		376
		377	if (@SLOT_QUEUE) {
		378	# we do not use wait_for_tick() as it returns immediately when tick is inactive
		379	push @cf::WAIT_FOR_TICK, $signal;
		380	$signal->wait;
		381	} else {
		382	Coro::schedule;
		383	}
		384	}
		385	};
		386
		387	sub get_slot($;$$) {
		388	my ($time, $pri, $name) = @_;
		389
		390	$time = $TICK * .6 if $time > $TICK * .6;
		391	my $sig = new Coro::Signal;
		392
		393	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		394	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		395	$SLOT_QUEUE->ready;
		396	$sig->wait;
		397	}
		398
296	=item cf::async { BLOCK }	399	=item cf::async { BLOCK }
297		400
298	Currently the same as Coro::async_pool, meaning you cannot use	401	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	402	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.	403	thing you are allowed to do is call C<prio> on it.
…		…
303		406
304	BEGIN { *async = \&Coro::async_pool }	407	BEGIN { *async = \&Coro::async_pool }
305		408
306	=item cf::sync_job { BLOCK }	409	=item cf::sync_job { BLOCK }
307		410
308	The design of crossfire+ requires that the main coro ($Coro::main) is	411	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	412	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.	413	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		414	acceptable.
311		415
312	If it must be done, put the blocking parts into C<sync_job>. This will run	416	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	417	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	418	server will be frozen during this time, so the block should either finish
315	fast or be very important.	419	fast or be very important.
…		…
318		422
319	sub sync_job(&) {	423	sub sync_job(&) {
320	my ($job) = @_;	424	my ($job) = @_;
321		425
322	if ($Coro::current == $Coro::main) {	426	if ($Coro::current == $Coro::main) {
		427	my $time = Event::time;
		428
323	# this is the main coro, too bad, we have to block	429	# this is the main coro, too bad, we have to block
324	# till the operation succeeds, freezing the server :/	430	# till the operation succeeds, freezing the server :/
325		431
		432	LOG llevError, Carp::longmess "sync job";#d#
		433
326	# TODO: use suspend/resume instead	434	# TODO: use suspend/resume instead
327	# (but this is cancel-safe)	435	# (but this is cancel-safe)
328	my $freeze_guard = freeze_mainloop;	436	my $freeze_guard = freeze_mainloop;
329		437
330	my $busy = 1;	438	my $busy = 1;
331	my @res;	439	my @res;
332		440
333	(async {	441	(async {
		442	$Coro::current->desc ("sync job coro");
334	@res = eval { $job->() };	443	@res = eval { $job->() };
335	warn $@ if $@;	444	warn $@ if $@;
336	undef $busy;	445	undef $busy;
337	})->prio (Coro::PRIO_MAX);	446	})->prio (Coro::PRIO_MAX);
338		447
339	while ($busy) {	448	while ($busy) {
		449	if (Coro::nready) {
		450	Coro::cede_notself;
		451	} else {
340	Coro::cede or Event::one_event;	452	Event::one_event;
341	}	453	}
		454	}
		455
		456	$time = Event::time - $time;
		457
		458	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		459	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		460
		461	$tick_start += $time; # do not account sync jobs to server load
342		462
343	wantarray ? @res : $res[0]	463	wantarray ? @res : $res[0]
344	} else {	464	} else {
345	# we are in another coroutine, how wonderful, everything just works	465	# we are in another coroutine, how wonderful, everything just works
346		466
…		…
366	$EXT_CORO{$coro+0} = $coro;	486	$EXT_CORO{$coro+0} = $coro;
367		487
368	$coro	488	$coro
369	}	489	}
370		490
371	sub write_runtime {	491	=item fork_call { }, $args
372	my $runtime = "$LOCALDIR/runtime";
373		492
374	# first touch the runtime file to show we are still running:	493	Executes the given code block with the given arguments in a seperate
375	# the fsync below can take a very very long time.	494	process, returning the results. Everything must be serialisable with
		495	Coro::Storable. May, of course, block. Note that the executed sub may
		496	never block itself or use any form of Event handling.
376		497
377	warn "touching runtime...\n";#d#	498	=cut
378	if (my $fh = aio_open $runtime, O_WRONLY, 0) {	499
379	utime undef, undef, $fh;	500	sub fork_call(&@) {
		501	my ($cb, @args) = @_;
		502
		503	# we seemingly have to make a local copy of the whole thing,
		504	# otherwise perl prematurely frees the stuff :/
		505	# TODO: investigate and fix (likely this will be rather laborious)
		506
		507	my @res = Coro::Util::fork_eval {
		508	reset_signals;
		509	&$cb
		510	}, @args;
		511
		512	wantarray ? @res : $res[-1]
		513	}
		514
		515	=item $value = cf::db_get $family => $key
		516
		517	Returns a single value from the environment database.
		518
		519	=item cf::db_put $family => $key => $value
		520
		521	Stores the given C<$value> in the family. It can currently store binary
		522	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		523
		524	=item $db = cf::db_table "name"
		525
		526	Create and/or open a new database table. The string must not be "db" and must be unique
		527	within each server.
		528
		529	=cut
		530
		531	sub db_table($) {
		532	my ($name) = @_;
		533	my $db = BDB::db_create $DB_ENV;
		534
		535	eval {
		536	$db->set_flags (BDB::CHKSUM);
		537
		538	utf8::encode $name;
		539	BDB::db_open $db, undef, $name, undef, BDB::BTREE,
		540	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		541	cf::cleanup "db_open(db): $!" if $!;
380	}	542	};
		543	cf::cleanup "db_open(db): $@" if $@;
381		544
382	my $guard = cf::lock_acquire "write_runtime";	545	$db
		546	}
383		547
384	warn "starting to write runtime...\n";#d#	548	our $DB;
385	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
386	or return;
387		549
388	my $value = $cf::RUNTIME + 90 + 10;	550	sub db_init {
389	# 10 is the runtime save interval, for a monotonic clock	551	cf::sync_job {
390	# 60 allows for the watchdog to kill the server.	552	$DB ||= db_table "db";
		553	};
		554	}
391		555
392	(aio_write $fh, 0, (length $value), $value, 0) <= 0	556	sub db_get($$) {
393	and return;	557	my $key = "$_[0]/$_[1]";
394		558
395	# always fsync - this file is important	559	cf::sync_job {
396	aio_fsync $fh	560	BDB::db_get $DB, undef, $key, my $data;
397	and return;
398		561
399	# touch it again to show we are up-to-date	562	$! ? ()
400	utime undef, undef, $fh;	563	: $data
401
402	close $fh
403	or return;
404
405	aio_rename "$runtime~", $runtime
406	and return;
407
408	warn "... done writing runtime.\n";#d#
409
410	1	564	}
		565	}
		566
		567	sub db_put($$$) {
		568	BDB::dbreq_pri 4;
		569	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		570	}
		571
		572	=item cf::cache $id => [$paths...], $processversion => $process
		573
		574	Generic caching function that returns the value of the resource $id,
		575	caching and regenerating as required.
		576
		577	This function can block.
		578
		579	=cut
		580
		581	sub cache {
		582	my ($id, $src, $processversion, $process) = @_;
		583
		584	my $meta =
		585	join "\x00",
		586	$processversion,
		587	map {
		588	aio_stat $_
		589	and Carp::croak "$_: $!";
		590
		591	($_, (stat _)[7,9])
		592	} @$src;
		593
		594	my $dbmeta = db_get cache => "$id/meta";
		595	if ($dbmeta ne $meta) {
		596	# changed, we may need to process
		597
		598	my @data;
		599	my $md5;
		600
		601	for (0 .. $#$src) {
		602	0 <= aio_load $src->[$_], $data[$_]
		603	or Carp::croak "$src->[$_]: $!";
		604	}
		605
		606	# if processing is expensive, check
		607	# checksum first
		608	if (1) {
		609	$md5 =
		610	join "\x00",
		611	$processversion,
		612	map {
		613	cf::cede_to_tick;
		614	($src->[$_], Digest::MD5::md5_hex $data[$_])
		615	} 0.. $#$src;
		616
		617
		618	my $dbmd5 = db_get cache => "$id/md5";
		619	if ($dbmd5 eq $md5) {
		620	db_put cache => "$id/meta", $meta;
		621
		622	return db_get cache => "$id/data";
		623	}
		624	}
		625
		626	my $t1 = Time::HiRes::time;
		627	my $data = $process->(\@data);
		628	my $t2 = Time::HiRes::time;
		629
		630	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		631
		632	db_put cache => "$id/data", $data;
		633	db_put cache => "$id/md5" , $md5;
		634	db_put cache => "$id/meta", $meta;
		635
		636	return $data;
		637	}
		638
		639	db_get cache => "$id/data"
411	}	640	}
412		641
413	=item cf::datalog type => key => value, ...	642	=item cf::datalog type => key => value, ...
414		643
415	Log a datalog packet of the given type with the given key-value pairs.	644	Log a datalog packet of the given type with the given key-value pairs.
…		…
433	attach callbacks/event handlers (a collection of which is called an "attachment")	662	attach callbacks/event handlers (a collection of which is called an "attachment")
434	to it. All such attachable objects support the following methods.	663	to it. All such attachable objects support the following methods.
435		664
436	In the following description, CLASS can be any of C<global>, C<object>	665	In the following description, CLASS can be any of C<global>, C<object>
437	C<player>, C<client> or C<map> (i.e. the attachable objects in	666	C<player>, C<client> or C<map> (i.e. the attachable objects in
438	crossfire+).	667	Crossfire TRT).
439		668
440	=over 4	669	=over 4
441		670
442	=item $attachable->attach ($attachment, key => $value...)	671	=item $attachable->attach ($attachment, key => $value...)
443		672
…		…
606	$registry = $CB_TYPE[$object_type] ||= [];	835	$registry = $CB_TYPE[$object_type] ||= [];
607		836
608	} elsif ($type eq "subtype") {	837	} elsif ($type eq "subtype") {
609	defined $object_type or Carp::croak "subtype specified without type";	838	defined $object_type or Carp::croak "subtype specified without type";
610	my $object_subtype = shift @arg;	839	my $object_subtype = shift @arg;
611	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	840	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
612		841
613	} elsif ($type eq "package") {	842	} elsif ($type eq "package") {
614	my $pkg = shift @arg;	843	my $pkg = shift @arg;
615		844
616	while (my ($name, $id) = each %cb_id) {	845	while (my ($name, $id) = each %cb_id) {
…		…
645	_attach $registry, $klass, @attach;	874	_attach $registry, $klass, @attach;
646	}	875	}
647		876
648	$obj->{$name} = \%arg;	877	$obj->{$name} = \%arg;
649	} else {	878	} else {
650	warn "object uses attachment '$name' that is not available, postponing.\n";	879	warn "object uses attachment '$name' which is not available, postponing.\n";
651	}	880	}
652		881
653	$obj->{_attachment}{$name} = undef;	882	$obj->{_attachment}{$name} = undef;
654	}	883	}
655		884
…		…
657	if (ref $_[0]) {	886	if (ref $_[0]) {
658	_object_attach @_;	887	_object_attach @_;
659	} else {	888	} else {
660	_attach shift->_attach_registry, @_;	889	_attach shift->_attach_registry, @_;
661	}	890	}
		891	_recalc_want;
662	};	892	};
663		893
664	# all those should be optimised	894	# all those should be optimised
665	sub cf::attachable::detach {	895	sub cf::attachable::detach {
666	my ($obj, $name) = @_;	896	my ($obj, $name) = @_;
…		…
669	delete $obj->{_attachment}{$name};	899	delete $obj->{_attachment}{$name};
670	reattach ($obj);	900	reattach ($obj);
671	} else {	901	} else {
672	Carp::croak "cannot, currently, detach class attachments";	902	Carp::croak "cannot, currently, detach class attachments";
673	}	903	}
		904	_recalc_want;
674	};	905	};
675		906
676	sub cf::attachable::attached {	907	sub cf::attachable::attached {
677	my ($obj, $name) = @_;	908	my ($obj, $name) = @_;
678		909
…		…
693	";	924	";
694	die if $@;	925	die if $@;
695	}	926	}
696		927
697	our $override;	928	our $override;
698	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	929	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
699		930
700	sub override {	931	sub override {
701	$override = 1;	932	$override = 1;
702	@invoke_results = ();	933	@INVOKE_RESULTS = (@_);
703	}	934	}
704		935
705	sub do_invoke {	936	sub do_invoke {
706	my $event = shift;	937	my $event = shift;
707	my $callbacks = shift;	938	my $callbacks = shift;
708		939
709	@invoke_results = ();	940	@INVOKE_RESULTS = ();
710		941
711	local $override;	942	local $override;
712		943
713	for (@$callbacks) {	944	for (@$callbacks) {
714	eval { &{$_->[1]} };	945	eval { &{$_->[1]} };
…		…
731		962
732	Generate an object-specific event with the given arguments.	963	Generate an object-specific event with the given arguments.
733		964
734	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	965	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
735	removed in future versions), and there is no public API to access override	966	removed in future versions), and there is no public API to access override
736	results (if you must, access C<@cf::invoke_results> directly).	967	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
737		968
738	=back	969	=back
739		970
740	=cut	971	=cut
741		972
742	#############################################################################	973	#############################################################################
743	# object support	974	# object support
		975
		976	sub _object_equal($$);
		977	sub _object_equal($$) {
		978	my ($a, $b) = @_;
		979
		980	return 0 unless (ref $a) eq (ref $b);
		981
		982	if ("HASH" eq ref $a) {
		983	my @ka = keys %$a;
		984	my @kb = keys %$b;
		985
		986	return 0 if @ka != @kb;
		987
		988	for (0 .. $#ka) {
		989	return 0 unless $ka[$_] eq $kb[$_];
		990	return 0 unless _object_equal $a->{$ka[$_]}, $b->{$kb[$_]};
		991	}
		992
		993	} elsif ("ARRAY" eq ref $a) {
		994
		995	return 0 if @$a != @$b;
		996
		997	for (0 .. $#$a) {
		998	return 0 unless _object_equal $a->[$_], $b->[$_];
		999	}
		1000
		1001	} elsif ($a ne $b) {
		1002	return 0;
		1003	}
		1004
		1005	1
		1006	}
		1007
		1008	our $SLOW_MERGES;#d#
		1009	sub _can_merge {
		1010	my ($ob1, $ob2) = @_;
		1011
		1012	++$SLOW_MERGES;#d#
		1013
		1014	# we do the slow way here
		1015	return _object_equal $ob1, $ob2
		1016	}
744		1017
745	sub reattach {	1018	sub reattach {
746	# basically do the same as instantiate, without calling instantiate	1019	# basically do the same as instantiate, without calling instantiate
747	my ($obj) = @_;	1020	my ($obj) = @_;
748		1021
…		…
795	sub object_freezer_save {	1068	sub object_freezer_save {
796	my ($filename, $rdata, $objs) = @_;	1069	my ($filename, $rdata, $objs) = @_;
797		1070
798	sync_job {	1071	sync_job {
799	if (length $$rdata) {	1072	if (length $$rdata) {
		1073	utf8::decode (my $decname = $filename);
800	warn sprintf "saving %s (%d,%d)\n",	1074	warn sprintf "saving %s (%d,%d)\n",
801	$filename, length $$rdata, scalar @$objs;	1075	$decname, length $$rdata, scalar @$objs;
802		1076
803	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1077	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
804	chmod SAVE_MODE, $fh;	1078	chmod SAVE_MODE, $fh;
805	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1079	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
806	aio_fsync $fh if $cf::USE_FSYNC;	1080	aio_fsync $fh if $cf::USE_FSYNC;
807	close $fh;	1081	close $fh;
808		1082
809	if (@$objs) {	1083	if (@$objs) {
810	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	1084	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
811	chmod SAVE_MODE, $fh;	1085	chmod SAVE_MODE, $fh;
812	my $data = Storable::nfreeze { version => 1, objs => $objs };	1086	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
813	aio_write $fh, 0, (length $data), $data, 0;	1087	aio_write $fh, 0, (length $data), $data, 0;
814	aio_fsync $fh if $cf::USE_FSYNC;	1088	aio_fsync $fh if $cf::USE_FSYNC;
815	close $fh;	1089	close $fh;
816	aio_rename "$filename.pst~", "$filename.pst";	1090	aio_rename "$filename.pst~", "$filename.pst";
817	}	1091	}
…		…
825	}	1099	}
826	} else {	1100	} else {
827	aio_unlink $filename;	1101	aio_unlink $filename;
828	aio_unlink "$filename.pst";	1102	aio_unlink "$filename.pst";
829	}	1103	}
830	}	1104	};
831	}	1105	}
832		1106
833	sub object_freezer_as_string {	1107	sub object_freezer_as_string {
834	my ($rdata, $objs) = @_;	1108	my ($rdata, $objs) = @_;
835		1109
…		…
847	or return;	1121	or return;
848		1122
849	unless (aio_stat "$filename.pst") {	1123	unless (aio_stat "$filename.pst") {
850	(aio_load "$filename.pst", $av) >= 0	1124	(aio_load "$filename.pst", $av) >= 0
851	or return;	1125	or return;
		1126
852	$av = eval { (Storable::thaw $av)->{objs} };	1127	my $st = eval { Coro::Storable::thaw $av };
		1128	$av = $st->{objs};
853	}	1129	}
854		1130
		1131	utf8::decode (my $decname = $filename);
855	warn sprintf "loading %s (%d)\n",	1132	warn sprintf "loading %s (%d,%d)\n",
856	$filename, length $data, scalar @{$av || []};#d#	1133	$decname, length $data, scalar @{$av || []};
		1134
857	return ($data, $av);	1135	($data, $av)
858	}	1136	}
		1137
		1138	=head2 COMMAND CALLBACKS
		1139
		1140	=over 4
		1141
		1142	=cut
859		1143
860	#############################################################################	1144	#############################################################################
861	# command handling &c	1145	# command handling &c
862		1146
863	=item cf::register_command $name => \&callback($ob,$args);	1147	=item cf::register_command $name => \&callback($ob,$args);
…		…
876	push @{ $COMMAND{$name} }, [$caller, $cb];	1160	push @{ $COMMAND{$name} }, [$caller, $cb];
877	}	1161	}
878		1162
879	=item cf::register_extcmd $name => \&callback($pl,$packet);	1163	=item cf::register_extcmd $name => \&callback($pl,$packet);
880		1164
881	Register a callbackf ro execution when the client sends an extcmd packet.	1165	Register a callback for execution when the client sends an (synchronous)
		1166	extcmd packet. Ext commands will be processed in the order they are
		1167	received by the server, like other user commands. The first argument is
		1168	the logged-in player. Ext commands can only be processed after a player
		1169	has logged in successfully.
882		1170
883	If the callback returns something, it is sent back as if reply was being	1171	If the callback returns something, it is sent back as if reply was being
884	called.	1172	called.
885		1173
		1174	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1175
		1176	Register a callback for execution when the client sends an (asynchronous)
		1177	exticmd packet. Exti commands are processed by the server as soon as they
		1178	are received, i.e. out of order w.r.t. other commands. The first argument
		1179	is a client socket. Exti commands can be received anytime, even before
		1180	log-in.
		1181
		1182	If the callback returns something, it is sent back as if reply was being
		1183	called.
		1184
886	=cut	1185	=cut
887		1186
888	sub register_extcmd {	1187	sub register_extcmd {
889	my ($name, $cb) = @_;	1188	my ($name, $cb) = @_;
890		1189
891	$EXTCMD{$name} = $cb;	1190	$EXTCMD{$name} = $cb;
		1191	}
		1192
		1193	sub register_exticmd {
		1194	my ($name, $cb) = @_;
		1195
		1196	$EXTICMD{$name} = $cb;
892	}	1197	}
893		1198
894	cf::player->attach (	1199	cf::player->attach (
895	on_command => sub {	1200	on_command => sub {
896	my ($pl, $name, $params) = @_;	1201	my ($pl, $name, $params) = @_;
…		…
905	cf::override;	1210	cf::override;
906	},	1211	},
907	on_extcmd => sub {	1212	on_extcmd => sub {
908	my ($pl, $buf) = @_;	1213	my ($pl, $buf) = @_;
909		1214
910	my $msg = eval { from_json $buf };	1215	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
911		1216
912	if (ref $msg) {	1217	if (ref $msg) {
		1218	my ($type, $reply, @payload) =
		1219	"ARRAY" eq ref $msg
		1220	? @$msg
		1221	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1222
		1223	my @reply;
		1224
913	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1225	if (my $cb = $EXTCMD{$type}) {
914	if (my %reply = $cb->($pl, $msg)) {	1226	@reply = $cb->($pl, @payload);
915	$pl->ext_reply ($msg->{msgid}, %reply);
916	}
917	}	1227	}
		1228
		1229	$pl->ext_reply ($reply, @reply)
		1230	if $reply;
		1231
918	} else {	1232	} else {
919	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1233	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
920	}	1234	}
921		1235
922	cf::override;	1236	cf::override;
923	},	1237	},
924	);	1238	);
925		1239
926	sub load_extension {
927	my ($path) = @_;
928
929	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
930	my $base = $1;
931	my $pkg = $1;
932	$pkg =~ s/[^[:word:]]/_/g;
933	$pkg = "ext::$pkg";
934
935	warn "... loading '$path' into '$pkg'\n";
936
937	open my $fh, "<:utf8", $path
938	or die "$path: $!";
939
940	my $source =
941	"package $pkg; use strict; use utf8;\n"
942	. "#line 1 \"$path\"\n{\n"
943	. (do { local $/; <$fh> })
944	. "\n};\n1";
945
946	unless (eval $source) {
947	my $msg = $@ ? "$path: $@\n"
948	: "extension disabled.\n";
949	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
950	warn $@;
951	warn "mandatory extension failed to load, exiting.\n";
952	exit 1;
953	}
954	die $@;
955	}
956
957	push @EXTS, $pkg;
958	}
959
960	sub load_extensions {	1240	sub load_extensions {
		1241	cf::sync_job {
		1242	my %todo;
		1243
961	for my $ext (<$LIBDIR/*.ext>) {	1244	for my $path (<$LIBDIR/*.ext>) {
962	next unless -r $ext;	1245	next unless -r $path;
963	eval {	1246
964	load_extension $ext;	1247	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1248	my $base = $1;
		1249	my $pkg = $1;
		1250	$pkg =~ s/[^[:word:]]/_/g;
		1251	$pkg = "ext::$pkg";
		1252
		1253	open my $fh, "<:utf8", $path
		1254	or die "$path: $!";
		1255
		1256	my $source = do { local $/; <$fh> };
		1257
		1258	my %ext = (
		1259	path => $path,
		1260	base => $base,
		1261	pkg => $pkg,
		1262	);
		1263
		1264	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1265	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1266
		1267	$ext{source} =
		1268	"package $pkg; use strict; use utf8;\n"
		1269	. "#line 1 \"$path\"\n{\n"
		1270	. $source
		1271	. "\n};\n1";
		1272
		1273	$todo{$base} = \%ext;
		1274	}
		1275
		1276	my %done;
		1277	while (%todo) {
		1278	my $progress;
		1279
		1280	while (my ($k, $v) = each %todo) {
		1281	for (split /,\s*/, $v->{meta}{depends}) {
		1282	goto skip
		1283	unless exists $done{$_};
		1284	}
		1285
		1286	warn "... loading '$k' into '$v->{pkg}'\n";
		1287
		1288	unless (eval $v->{source}) {
		1289	my $msg = $@ ? "$v->{path}: $@\n"
		1290	: "$v->{base}: extension inactive.\n";
		1291
		1292	if (exists $v->{meta}{mandatory}) {
		1293	warn $msg;
		1294	warn "mandatory extension failed to load, exiting.\n";
		1295	exit 1;
		1296	}
		1297
		1298	warn $msg;
		1299	}
		1300
		1301	$done{$k} = delete $todo{$k};
		1302	push @EXTS, $v->{pkg};
		1303	$progress = 1;
965	1	1304	}
966	} or warn "$ext not loaded: $@";	1305
		1306	skip:
		1307	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1308	unless $progress;
		1309	}
967	}	1310	};
968	}	1311	}
969		1312
970	#############################################################################	1313	#############################################################################
971		1314
		1315	=back
		1316
972	=head2 CORE EXTENSIONS	1317	=head2 CORE EXTENSIONS
973		1318
974	Functions and methods that extend core crossfire objects.	1319	Functions and methods that extend core crossfire objects.
975		1320
976	=cut	1321	=cut
…		…
980	use Coro::AIO;	1325	use Coro::AIO;
981		1326
982	=head3 cf::player	1327	=head3 cf::player
983		1328
984	=over 4	1329	=over 4
		1330
		1331	=item cf::player::num_playing
		1332
		1333	Returns the official number of playing players, as per the Crossfire metaserver rules.
		1334
		1335	=cut
		1336
		1337	sub num_playing {
		1338	scalar grep
		1339	$_->ob->map
		1340	&& !$_->hidden
		1341	&& !$_->ob->flag (cf::FLAG_WIZ),
		1342	cf::player::list
		1343	}
985		1344
986	=item cf::player::find $login	1345	=item cf::player::find $login
987		1346
988	Returns the given player object, loading it if necessary (might block).	1347	Returns the given player object, loading it if necessary (might block).
989		1348
…		…
1025	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";	1384	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1026	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";	1385	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1027	aio_unlink +(playerdir $login) . "/$login.pl.pst";	1386	aio_unlink +(playerdir $login) . "/$login.pl.pst";
1028	aio_unlink +(playerdir $login) . "/$login.pl";	1387	aio_unlink +(playerdir $login) . "/$login.pl";
1029		1388
1030	my $pl = load_pl path $login	1389	my $f = new_from_file cf::object::thawer path $login
1031	or return;	1390	or return;
		1391
		1392	my $pl = cf::player::load_pl $f
		1393	or return;
		1394	local $cf::PLAYER_LOADING{$login} = $pl;
		1395	$f->resolve_delayed_derefs;
1032	$cf::PLAYER{$login} = $pl	1396	$cf::PLAYER{$login} = $pl
1033	}	1397	}
1034	}	1398	}
1035	}	1399	}
1036		1400
…		…
1046		1410
1047	aio_mkdir playerdir $pl, 0770;	1411	aio_mkdir playerdir $pl, 0770;
1048	$pl->{last_save} = $cf::RUNTIME;	1412	$pl->{last_save} = $cf::RUNTIME;
1049		1413
1050	$pl->save_pl ($path);	1414	$pl->save_pl ($path);
1051	Coro::cede;	1415	cf::cede_to_tick;
1052	}	1416	}
1053		1417
1054	sub new($) {	1418	sub new($) {
1055	my ($login) = @_;	1419	my ($login) = @_;
1056		1420
…		…
1060	$self->{deny_save} = 1;	1424	$self->{deny_save} = 1;
1061		1425
1062	$cf::PLAYER{$login} = $self;	1426	$cf::PLAYER{$login} = $self;
1063		1427
1064	$self	1428	$self
		1429	}
		1430
		1431	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1432
		1433	=cut
		1434
		1435	sub send_msg {
		1436	my $ns = shift->ns
		1437	or return;
		1438	$ns->send_msg (@_);
1065	}	1439	}
1066		1440
1067	=item $pl->quit_character	1441	=item $pl->quit_character
1068		1442
1069	Nukes the player without looking back. If logged in, the connection will	1443	Nukes the player without looking back. If logged in, the connection will
…		…
1124	or return [];	1498	or return [];
1125		1499
1126	my @logins;	1500	my @logins;
1127		1501
1128	for my $login (@$dirs) {	1502	for my $login (@$dirs) {
		1503	my $path = path $login;
		1504
		1505	# a .pst is a dead give-away for a valid player
		1506	unless (-e "$path.pst") {
1129	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1507	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1130	aio_read $fh, 0, 512, my $buf, 0 or next;	1508	aio_read $fh, 0, 512, my $buf, 0 or next;
1131	$buf !~ /^password -------------$/m or next; # official not-valid tag	1509	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1510	}
1132		1511
1133	utf8::decode $login;	1512	utf8::decode $login;
1134	push @logins, $login;	1513	push @logins, $login;
1135	}	1514	}
1136		1515
…		…
1163	}	1542	}
1164		1543
1165	\@paths	1544	\@paths
1166	}	1545	}
1167		1546
		1547	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1548
		1549	Expand crossfire pod fragments into protocol xml.
		1550
		1551	=cut
		1552
		1553	sub expand_cfpod {
		1554	((my $self), (local $_)) = @_;
		1555
		1556	# escape & and <
		1557	s/&/&amp;/g;
		1558	s/(?<![BIUGHT])</&lt;/g;
		1559
		1560	# this is buggy, it needs to properly take care of nested <'s
		1561
		1562	1 while
		1563	# replace B<>, I<>, U<> etc.
		1564	s/B<([^\>]*)>/<b>$1<\/b>/
		1565	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1566	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1567	|| s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
		1568	# replace G<male|female> tags
		1569	|| s{G<([^>|]*)\|([^>]*)>}{
		1570	$self->gender ? $2 : $1
		1571	}ge
		1572	# replace H<hint text>
		1573	|| s{H<([^\>]*)>}
		1574	{
		1575	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1576	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1577	"")
		1578	[$self->{hintmode}]
		1579	}ge;
		1580
		1581	# create single paragraphs (very hackish)
		1582	s/(?<=\S)\n(?=\w)/ /g;
		1583
		1584	# compress some whitespace
		1585	s/\s+\n/\n/g; # ws line-ends
		1586	s/\n\n+/\n/g; # double lines
		1587	s/^\n+//; # beginning lines
		1588	s/\n+$//; # ending lines
		1589
		1590	$_
		1591	}
		1592
		1593	sub hintmode {
		1594	$_[0]{hintmode} = $_[1] if @_ > 1;
		1595	$_[0]{hintmode}
		1596	}
		1597
1168	=item $player->ext_reply ($msgid, %msg)	1598	=item $player->ext_reply ($msgid, @msg)
1169		1599
1170	Sends an ext reply to the player.	1600	Sends an ext reply to the player.
1171		1601
1172	=cut	1602	=cut
1173		1603
1174	sub ext_reply($$%) {	1604	sub ext_reply($$@) {
1175	my ($self, $id, %msg) = @_;	1605	my ($self, $id, @msg) = @_;
1176		1606
1177	$msg{msgid} = $id;	1607	$self->ns->ext_reply ($id, @msg)
1178
1179	$self->send ("ext " . cf::to_json \%msg);
1180	}	1608	}
1181		1609
1182	=item $player->ext_event ($type, %msg)	1610	=item $player->ext_msg ($type, @msg)
1183		1611
1184	Sends an ext event to the client.	1612	Sends an ext event to the client.
1185		1613
1186	=cut	1614	=cut
1187		1615
1188	sub ext_event($$%) {	1616	sub ext_msg($$@) {
1189	my ($self, $type, %msg) = @_;	1617	my ($self, $type, @msg) = @_;
1190		1618
1191	$self->ns->ext_event ($type, %msg);	1619	$self->ns->ext_msg ($type, @msg);
1192	}	1620	}
1193		1621
1194	=head3 cf::region	1622	=head3 cf::region
1195		1623
1196	=over 4	1624	=over 4
…		…
1199		1627
1200	package cf::region;	1628	package cf::region;
1201		1629
1202	=item cf::region::find_by_path $path	1630	=item cf::region::find_by_path $path
1203		1631
1204	Tries to decuce the probable region for a map knowing only its path.	1632	Tries to decuce the likely region for a map knowing only its path.
1205		1633
1206	=cut	1634	=cut
1207		1635
1208	sub find_by_path($) {	1636	sub find_by_path($) {
1209	my ($path) = @_;	1637	my ($path) = @_;
1210		1638
1211	my ($match, $specificity);	1639	my ($match, $specificity);
1212		1640
1213	for my $region (list) {	1641	for my $region (list) {
1214	if ($region->match && $path =~ $region->match) {	1642	if ($region->{match} && $path =~ $region->{match}) {
1215	($match, $specificity) = ($region, $region->specificity)	1643	($match, $specificity) = ($region, $region->specificity)
1216	if $region->specificity > $specificity;	1644	if $region->specificity > $specificity;
1217	}	1645	}
1218	}	1646	}
1219		1647
…		…
1283	my ($self, $merge) = @_;	1711	my ($self, $merge) = @_;
1284		1712
1285	# we have to keep some variables in memory intact	1713	# we have to keep some variables in memory intact
1286	local $self->{path};	1714	local $self->{path};
1287	local $self->{load_path};	1715	local $self->{load_path};
1288	local $self->{deny_save};
1289	local $self->{deny_reset};
1290		1716
1291	$self->SUPER::thawer_merge ($merge);	1717	$self->SUPER::thawer_merge ($merge);
1292	}	1718	}
1293		1719
1294	sub normalise {	1720	sub normalise {
…		…
1341	$self->init; # pass $1 etc.	1767	$self->init; # pass $1 etc.
1342	return $self;	1768	return $self;
1343	}	1769	}
1344	}	1770	}
1345		1771
1346	Carp::carp "unable to resolve path '$path' (base '$base').";	1772	Carp::cluck "unable to resolve path '$path' (base '$base').";
1347	()	1773	()
1348	}	1774	}
1349		1775
1350	sub init {	1776	sub init {
1351	my ($self) = @_;	1777	my ($self) = @_;
…		…
1394		1820
1395	$_->change_map_light ($change)	1821	$_->change_map_light ($change)
1396	for grep $_->outdoor, values %cf::MAP;	1822	for grep $_->outdoor, values %cf::MAP;
1397	}	1823	}
1398		1824
		1825	sub decay_objects {
		1826	my ($self) = @_;
		1827
		1828	return if $self->{deny_reset};
		1829
		1830	$self->do_decay_objects;
		1831	}
		1832
1399	sub unlink_save {	1833	sub unlink_save {
1400	my ($self) = @_;	1834	my ($self) = @_;
1401		1835
1402	utf8::encode (my $save = $self->save_path);	1836	utf8::encode (my $save = $self->save_path);
1403	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1837	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
…		…
1406		1840
1407	sub load_header_from($) {	1841	sub load_header_from($) {
1408	my ($self, $path) = @_;	1842	my ($self, $path) = @_;
1409		1843
1410	utf8::encode $path;	1844	utf8::encode $path;
1411	#aio_open $path, O_RDONLY, 0	1845	my $f = new_from_file cf::object::thawer $path
1412	# or return;
1413
1414	$self->_load_header ($path)
1415	or return;	1846	or return;
		1847
		1848	$self->_load_header ($f)
		1849	or return;
		1850
		1851	local $MAP_LOADING{$self->{path}} = $self;
		1852	$f->resolve_delayed_derefs;
1416		1853
1417	$self->{load_path} = $path;	1854	$self->{load_path} = $path;
1418		1855
1419	1	1856	1
1420	}	1857	}
…		…
1459	$self->load_header_orig	1896	$self->load_header_orig
1460	or return;	1897	or return;
1461	$self->prepare_orig;	1898	$self->prepare_orig;
1462	}	1899	}
1463		1900
		1901	$self->{deny_reset} = 1
		1902	if $self->no_reset;
		1903
1464	$self->default_region (cf::region::find_by_path $self->{path})	1904	$self->default_region (cf::region::find_by_path $self->{path})
1465	unless $self->default_region;	1905	unless $self->default_region;
1466		1906
1467	1	1907	1
1468	}	1908	}
…		…
1471	sub find {	1911	sub find {
1472	my ($path, $origin) = @_;	1912	my ($path, $origin) = @_;
1473		1913
1474	$path = normalise $path, $origin && $origin->path;	1914	$path = normalise $path, $origin && $origin->path;
1475		1915
		1916	cf::lock_wait "map_data:$path";#d#remove
1476	cf::lock_wait "map_find:$path";	1917	cf::lock_wait "map_find:$path";
1477		1918
1478	$cf::MAP{$path} || do {	1919	$cf::MAP{$path} || do {
1479	my $guard = cf::lock_acquire "map_find:$path";	1920	my $guard1 = cf::lock_acquire "map_find:$path";
		1921	my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
		1922
1480	my $map = new_from_path cf::map $path	1923	my $map = new_from_path cf::map $path
1481	or return;	1924	or return;
1482		1925
1483	$map->{last_save} = $cf::RUNTIME;	1926	$map->{last_save} = $cf::RUNTIME;
1484		1927
1485	$map->load_header	1928	$map->load_header
1486	or return;	1929	or return;
1487		1930
1488	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1931	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1489	# doing this can freeze the server in a sync job, obviously	1932	# doing this can freeze the server in a sync job, obviously
1490	#$cf::WAIT_FOR_TICK->wait;	1933	#$cf::WAIT_FOR_TICK->wait;
		1934	undef $guard1;
		1935	undef $guard2;
1491	$map->reset;	1936	$map->reset;
1492	undef $guard;
1493	return find $path;	1937	return find $path;
1494	}	1938	}
1495		1939
1496	$cf::MAP{$path} = $map	1940	$cf::MAP{$path} = $map
1497	}	1941	}
…		…
1506	local $self->{deny_reset} = 1; # loading can take a long time	1950	local $self->{deny_reset} = 1; # loading can take a long time
1507		1951
1508	my $path = $self->{path};	1952	my $path = $self->{path};
1509		1953
1510	{	1954	{
1511	my $guard = cf::lock_acquire "map_load:$path";	1955	my $guard = cf::lock_acquire "map_data:$path";
1512		1956
		1957	return unless $self->valid;
1513	return if $self->in_memory != cf::MAP_SWAPPED;	1958	return unless $self->in_memory == cf::MAP_SWAPPED;
1514		1959
1515	$self->in_memory (cf::MAP_LOADING);	1960	$self->in_memory (cf::MAP_LOADING);
1516		1961
1517	$self->alloc;	1962	$self->alloc;
1518		1963
1519	$self->pre_load;	1964	$self->pre_load;
1520	Coro::cede;	1965	cf::cede_to_tick;
1521		1966
		1967	my $f = new_from_file cf::object::thawer $self->{load_path};
		1968	$f->skip_block;
1522	$self->_load_objects ($self->{load_path}, 1)	1969	$self->_load_objects ($f)
1523	or return;	1970	or return;
1524		1971
1525	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1972	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1526	if delete $self->{load_original};	1973	if delete $self->{load_original};
1527		1974
1528	if (my $uniq = $self->uniq_path) {	1975	if (my $uniq = $self->uniq_path) {
1529	utf8::encode $uniq;	1976	utf8::encode $uniq;
1530	if (aio_open $uniq, O_RDONLY, 0) {	1977	unless (aio_stat $uniq) {
		1978	if (my $f = new_from_file cf::object::thawer $uniq) {
1531	$self->clear_unique_items;	1979	$self->clear_unique_items;
1532	$self->_load_objects ($uniq, 0);	1980	$self->_load_objects ($f);
		1981	$f->resolve_delayed_derefs;
		1982	}
1533	}	1983	}
1534	}	1984	}
1535		1985
1536	Coro::cede;	1986	$f->resolve_delayed_derefs;
		1987
		1988	cf::cede_to_tick;
1537	# now do the right thing for maps	1989	# now do the right thing for maps
1538	$self->link_multipart_objects;	1990	$self->link_multipart_objects;
1539	$self->difficulty ($self->estimate_difficulty)	1991	$self->difficulty ($self->estimate_difficulty)
1540	unless $self->difficulty;	1992	unless $self->difficulty;
1541	Coro::cede;	1993	cf::cede_to_tick;
1542		1994
1543	unless ($self->{deny_activate}) {	1995	unless ($self->{deny_activate}) {
1544	$self->decay_objects;	1996	$self->decay_objects;
1545	$self->fix_auto_apply;	1997	$self->fix_auto_apply;
1546	$self->update_buttons;	1998	$self->update_buttons;
1547	Coro::cede;	1999	cf::cede_to_tick;
1548	$self->set_darkness_map;	2000	$self->set_darkness_map;
1549	Coro::cede;	2001	cf::cede_to_tick;
1550	$self->activate;	2002	$self->activate;
1551	}	2003	}
		2004
		2005	$self->{last_save} = $cf::RUNTIME;
		2006	$self->last_access ($cf::RUNTIME);
1552		2007
1553	$self->in_memory (cf::MAP_IN_MEMORY);	2008	$self->in_memory (cf::MAP_IN_MEMORY);
1554	}	2009	}
1555		2010
1556	$self->post_load;	2011	$self->post_load;
…		…
1560	my ($self, $ob) = @_;	2015	my ($self, $ob) = @_;
1561		2016
1562	return find "~" . $ob->name . "/" . $self->{path}	2017	return find "~" . $ob->name . "/" . $self->{path}
1563	if $self->per_player;	2018	if $self->per_player;
1564		2019
		2020	# return find "?party/" . $ob->name . "/" . $self->{path}
		2021	# if $self->per_party;
		2022
1565	$self	2023	$self
1566	}	2024	}
1567		2025
1568	# find and load all maps in the 3x3 area around a map	2026	# find and load all maps in the 3x3 area around a map
1569	sub load_diag {	2027	sub load_neighbours {
1570	my ($map) = @_;	2028	my ($map) = @_;
1571		2029
1572	my @diag; # diagonal neighbours	2030	my @neigh; # diagonal neighbours
1573		2031
1574	for (0 .. 3) {	2032	for (0 .. 3) {
1575	my $neigh = $map->tile_path ($_)	2033	my $neigh = $map->tile_path ($_)
1576	or next;	2034	or next;
1577	$neigh = find $neigh, $map	2035	$neigh = find $neigh, $map
1578	or next;	2036	or next;
1579	$neigh->load;	2037	$neigh->load;
1580		2038
		2039	push @neigh,
1581	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2040	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1582	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2041	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1583	}	2042	}
1584		2043
1585	for (@diag) {	2044	for (grep defined $_->[0], @neigh) {
		2045	my ($path, $origin) = @$_;
1586	my $neigh = find @$_	2046	my $neigh = find $path, $origin
1587	or next;	2047	or next;
1588	$neigh->load;	2048	$neigh->load;
1589	}	2049	}
1590	}	2050	}
1591		2051
…		…
1596	}	2056	}
1597		2057
1598	sub do_load_sync {	2058	sub do_load_sync {
1599	my ($map) = @_;	2059	my ($map) = @_;
1600		2060
		2061	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2062	if $Coro::current == $Coro::main;
		2063
1601	cf::sync_job { $map->load };	2064	cf::sync_job { $map->load };
1602	}	2065	}
1603		2066
1604	our %MAP_PREFETCH;	2067	our %MAP_PREFETCH;
1605	our $MAP_PREFETCHER = undef;	2068	our $MAP_PREFETCHER = undef;
1606		2069
1607	sub find_async {	2070	sub find_async {
1608	my ($path, $origin) = @_;	2071	my ($path, $origin, $load) = @_;
1609		2072
1610	$path = normalise $path, $origin && $origin->{path};	2073	$path = normalise $path, $origin && $origin->{path};
1611		2074
1612	if (my $map = $cf::MAP{$path}) {	2075	if (my $map = $cf::MAP{$path}) {
1613	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2076	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1614	}	2077	}
1615		2078
1616	undef $MAP_PREFETCH{$path};	2079	$MAP_PREFETCH{$path} |= $load;
		2080
1617	$MAP_PREFETCHER ||= cf::async {	2081	$MAP_PREFETCHER ||= cf::async {
		2082	$Coro::current->{desc} = "map prefetcher";
		2083
1618	while (%MAP_PREFETCH) {	2084	while (%MAP_PREFETCH) {
1619	for my $path (keys %MAP_PREFETCH) {	2085	while (my ($k, $v) = each %MAP_PREFETCH) {
1620	my $map = find $path	2086	if (my $map = find $k) {
1621	or next;
1622	$map->load;	2087	$map->load if $v;
		2088	}
1623		2089
1624	delete $MAP_PREFETCH{$path};	2090	delete $MAP_PREFETCH{$k};
1625	}	2091	}
1626	}	2092	}
1627	undef $MAP_PREFETCHER;	2093	undef $MAP_PREFETCHER;
1628	};	2094	};
1629	$MAP_PREFETCHER->prio (6);	2095	$MAP_PREFETCHER->prio (6);
…		…
1632	}	2098	}
1633		2099
1634	sub save {	2100	sub save {
1635	my ($self) = @_;	2101	my ($self) = @_;
1636		2102
1637	my $lock = cf::lock_acquire "map_data:" . $self->path;	2103	my $lock = cf::lock_acquire "map_data:$self->{path}";
1638		2104
1639	$self->{last_save} = $cf::RUNTIME;	2105	$self->{last_save} = $cf::RUNTIME;
1640		2106
1641	return unless $self->dirty;	2107	return unless $self->dirty;
1642		2108
…		…
1648	return if $self->{deny_save};	2114	return if $self->{deny_save};
1649		2115
1650	local $self->{last_access} = $self->last_access;#d#	2116	local $self->{last_access} = $self->last_access;#d#
1651		2117
1652	cf::async {	2118	cf::async {
		2119	$Coro::current->{desc} = "map player save";
1653	$_->contr->save for $self->players;	2120	$_->contr->save for $self->players;
1654	};	2121	};
1655		2122
1656	if ($uniq) {	2123	if ($uniq) {
1657	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2124	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
…		…
1665	my ($self) = @_;	2132	my ($self) = @_;
1666		2133
1667	# save first because save cedes	2134	# save first because save cedes
1668	$self->save;	2135	$self->save;
1669		2136
1670	my $lock = cf::lock_acquire "map_data:" . $self->path;	2137	my $lock = cf::lock_acquire "map_data:$self->{path}";
1671		2138
1672	return if $self->players;	2139	return if $self->players;
1673	return if $self->in_memory != cf::MAP_IN_MEMORY;	2140	return if $self->in_memory != cf::MAP_IN_MEMORY;
1674	return if $self->{deny_save};	2141	return if $self->{deny_save};
1675		2142
		2143	$self->in_memory (cf::MAP_SWAPPED);
		2144
		2145	$self->deactivate;
		2146	$_->clear_links_to ($self) for values %cf::MAP;
1676	$self->clear;	2147	$self->clear;
1677	$self->in_memory (cf::MAP_SWAPPED);
1678	}	2148	}
1679		2149
1680	sub reset_at {	2150	sub reset_at {
1681	my ($self) = @_;	2151	my ($self) = @_;
1682		2152
1683	# TODO: safety, remove and allow resettable per-player maps	2153	# TODO: safety, remove and allow resettable per-player maps
1684	return 1e99 if $self->isa ("ext::map_per_player");#d#
1685	return 1e99 if $self->{deny_reset};	2154	return 1e99 if $self->{deny_reset};
1686		2155
1687	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2156	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1688	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2157	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1689		2158
…		…
1700	my ($self) = @_;	2169	my ($self) = @_;
1701		2170
1702	my $lock = cf::lock_acquire "map_data:$self->{path}";	2171	my $lock = cf::lock_acquire "map_data:$self->{path}";
1703		2172
1704	return if $self->players;	2173	return if $self->players;
1705	return if $self->isa ("ext::map_per_player");#d#
1706		2174
1707	warn "resetting map ", $self->path;#d#	2175	warn "resetting map ", $self->path;
1708		2176
1709	$self->in_memory (cf::MAP_SWAPPED);	2177	$self->in_memory (cf::MAP_SWAPPED);
1710		2178
1711	# need to save uniques path	2179	# need to save uniques path
1712	unless ($self->{deny_save}) {	2180	unless ($self->{deny_save}) {
…		…
1716	if $uniq;	2184	if $uniq;
1717	}	2185	}
1718		2186
1719	delete $cf::MAP{$self->path};	2187	delete $cf::MAP{$self->path};
1720		2188
		2189	$self->deactivate;
		2190	$_->clear_links_to ($self) for values %cf::MAP;
1721	$self->clear;	2191	$self->clear;
1722
1723	$_->clear_links_to ($self) for values %cf::MAP;
1724		2192
1725	$self->unlink_save;	2193	$self->unlink_save;
1726	$self->destroy;	2194	$self->destroy;
1727	}	2195	}
1728		2196
1729	my $nuke_counter = "aaaa";	2197	my $nuke_counter = "aaaa";
1730		2198
1731	sub nuke {	2199	sub nuke {
1732	my ($self) = @_;	2200	my ($self) = @_;
1733		2201
		2202	{
		2203	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2204
1734	delete $cf::MAP{$self->path};	2205	delete $cf::MAP{$self->path};
1735		2206
1736	$self->unlink_save;	2207	$self->unlink_save;
1737		2208
1738	bless $self, "cf::map";	2209	bless $self, "cf::map";
1739	delete $self->{deny_reset};	2210	delete $self->{deny_reset};
1740	$self->{deny_save} = 1;	2211	$self->{deny_save} = 1;
1741	$self->reset_timeout (1);	2212	$self->reset_timeout (1);
1742	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2213	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1743		2214
1744	$cf::MAP{$self->path} = $self;	2215	$cf::MAP{$self->path} = $self;
		2216	}
1745		2217
1746	$self->reset; # polite request, might not happen	2218	$self->reset; # polite request, might not happen
		2219	}
		2220
		2221	=item $maps = cf::map::tmp_maps
		2222
		2223	Returns an arrayref with all map paths of currently instantiated and saved
		2224	maps. May block.
		2225
		2226	=cut
		2227
		2228	sub tmp_maps() {
		2229	[
		2230	map {
		2231	utf8::decode $_;
		2232	/\.map$/
		2233	? normalise $_
		2234	: ()
		2235	} @{ aio_readdir $TMPDIR or [] }
		2236	]
		2237	}
		2238
		2239	=item $maps = cf::map::random_maps
		2240
		2241	Returns an arrayref with all map paths of currently instantiated and saved
		2242	random maps. May block.
		2243
		2244	=cut
		2245
		2246	sub random_maps() {
		2247	[
		2248	map {
		2249	utf8::decode $_;
		2250	/\.map$/
		2251	? normalise "?random/$_"
		2252	: ()
		2253	} @{ aio_readdir $RANDOMDIR or [] }
		2254	]
1747	}	2255	}
1748		2256
1749	=item cf::map::unique_maps	2257	=item cf::map::unique_maps
1750		2258
1751	Returns an arrayref of paths of all shared maps that have	2259	Returns an arrayref of paths of all shared maps that have
1752	instantiated unique items. May block.	2260	instantiated unique items. May block.
1753		2261
1754	=cut	2262	=cut
1755		2263
1756	sub unique_maps() {	2264	sub unique_maps() {
1757	my $files = aio_readdir $UNIQUEDIR	2265	[
1758	or return;	2266	map {
1759
1760	my @paths;
1761
1762	for (@$files) {
1763	utf8::decode $_;	2267	utf8::decode $_;
1764	next if /\.pst$/;	2268	/\.map$/
1765	next unless /^$PATH_SEP/o;	2269	? normalise $_
1766		2270	: ()
1767	push @paths, cf::map::normalise $_;	2271	} @{ aio_readdir $UNIQUEDIR or [] }
1768	}	2272	]
1769
1770	\@paths
1771	}	2273	}
1772		2274
1773	package cf;	2275	package cf;
1774		2276
1775	=back	2277	=back
…		…
1793	map { $_, inv_recursive_ $_->inv } @_	2295	map { $_, inv_recursive_ $_->inv } @_
1794	}	2296	}
1795		2297
1796	sub inv_recursive {	2298	sub inv_recursive {
1797	inv_recursive_ inv $_[0]	2299	inv_recursive_ inv $_[0]
		2300	}
		2301
		2302	=item $ref = $ob->ref
		2303
		2304	creates and returns a persistent reference to an objetc that can be stored as a string.
		2305
		2306	=item $ob = cf::object::deref ($refstring)
		2307
		2308	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2309	even if the object actually exists. May block.
		2310
		2311	=cut
		2312
		2313	sub deref {
		2314	my ($ref) = @_;
		2315
		2316	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2317	my ($uuid, $name) = ($1, $2);
		2318	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2319	or return;
		2320	$pl->ob->uuid eq $uuid
		2321	or return;
		2322
		2323	$pl->ob
		2324	} else {
		2325	warn "$ref: cannot resolve object reference\n";
		2326	undef
		2327	}
1798	}	2328	}
1799		2329
1800	package cf;	2330	package cf;
1801		2331
1802	=back	2332	=back
…		…
1821		2351
1822	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2352	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1823		2353
1824	if ($self->{record_replies}) {	2354	if ($self->{record_replies}) {
1825	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2355	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2356
1826	} else {	2357	} else {
		2358	my $pl = $self->contr;
		2359
		2360	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2361	my $dialog = $pl->{npc_dialog};
		2362	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2363
		2364	} else {
1827	$msg = $npc->name . " says: $msg" if $npc;	2365	$msg = $npc->name . " says: $msg" if $npc;
1828	$self->message ($msg, $flags);	2366	$self->message ($msg, $flags);
		2367	}
1829	}	2368	}
		2369	}
		2370
		2371	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2372
		2373	=cut
		2374
		2375	sub cf::object::send_msg {
		2376	my $pl = shift->contr
		2377	or return;
		2378	$pl->send_msg (@_);
1830	}	2379	}
1831		2380
1832	=item $player_object->may ("access")	2381	=item $player_object->may ("access")
1833		2382
1834	Returns wether the given player is authorized to access resource "access"	2383	Returns wether the given player is authorized to access resource "access"
…		…
1881	$self->deactivate_recursive;	2430	$self->deactivate_recursive;
1882		2431
1883	return if UNIVERSAL::isa $self->map, "ext::map_link";	2432	return if UNIVERSAL::isa $self->map, "ext::map_link";
1884		2433
1885	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2434	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1886	if $self->map;	2435	if $self->map && $self->map->{path} ne "{link}";
1887		2436
1888	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2437	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1889	}	2438	}
1890		2439
1891	sub cf::object::player::leave_link {	2440	sub cf::object::player::leave_link {
1892	my ($self, $map, $x, $y) = @_;	2441	my ($self, $map, $x, $y) = @_;
		2442
		2443	return unless $self->contr->active;
1893		2444
1894	my $link_pos = delete $self->{_link_pos};	2445	my $link_pos = delete $self->{_link_pos};
1895		2446
1896	unless ($map) {	2447	unless ($map) {
1897	# restore original map position	2448	# restore original map position
…		…
1911	# use -1 or undef as default coordinates, not 0, 0	2462	# use -1 or undef as default coordinates, not 0, 0
1912	($x, $y) = ($map->enter_x, $map->enter_y)	2463	($x, $y) = ($map->enter_x, $map->enter_y)
1913	if $x <=0 && $y <= 0;	2464	if $x <=0 && $y <= 0;
1914		2465
1915	$map->load;	2466	$map->load;
1916	$map->load_diag;	2467	$map->load_neighbours;
1917		2468
1918	return unless $self->contr->active;	2469	return unless $self->contr->active;
1919	$self->activate_recursive;	2470	$self->activate_recursive;
1920		2471
1921	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2472	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1922	$self->enter_map ($map, $x, $y);	2473	$self->enter_map ($map, $x, $y);
1923	}	2474	}
1924		2475
1925	cf::player->attach (	2476	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1926	on_logout => sub {
1927	my ($pl) = @_;
1928		2477
1929	# abort map switching before logout	2478	Moves the player to the given map-path and coordinates by first freezing
1930	if ($pl->ob->{_link_pos}) {	2479	her, loading and preparing them map, calling the provided $check callback
1931	cf::sync_job {	2480	that has to return the map if sucecssful, and then unfreezes the player on
1932	$pl->ob->leave_link	2481	the new (success) or old (failed) map position. In either case, $done will
1933	};	2482	be called at the end of this process.
1934	}
1935	},
1936	on_login => sub {
1937	my ($pl) = @_;
1938		2483
1939	# try to abort aborted map switching on player login :)
1940	# should happen only on crashes
1941	if ($pl->ob->{_link_pos}) {
1942	$pl->ob->enter_link;
1943	(async {
1944	$pl->ob->reply (undef,
1945	"There was an internal problem at your last logout, "
1946	. "the server will try to bring you to your intended destination in a second.",
1947	cf::NDI_RED);
1948	# we need this sleep as the login has a concurrent enter_exit running
1949	# and this sleep increases chances of the player not ending up in scorn
1950	Coro::Timer::sleep 1;
1951	$pl->ob->leave_link;
1952	})->prio (2);
1953	}
1954	},
1955	);
1956
1957	=item $player_object->goto ($path, $x, $y)
1958
1959	=cut	2484	=cut
		2485
		2486	our $GOTOGEN;
1960		2487
1961	sub cf::object::player::goto {	2488	sub cf::object::player::goto {
1962	my ($self, $path, $x, $y) = @_;	2489	my ($self, $path, $x, $y, $check, $done) = @_;
		2490
		2491	# do generation counting so two concurrent goto's will be executed in-order
		2492	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1963		2493
1964	$self->enter_link;	2494	$self->enter_link;
1965		2495
1966	(async {	2496	(async {
		2497	$Coro::current->{desc} = "player::goto $path $x $y";
		2498
		2499	# *tag paths override both path and x|y
		2500	if ($path =~ /^\*(.*)$/) {
		2501	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2502	my $ob = $obs[rand @obs];
		2503
		2504	# see if we actually can go there
		2505	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2506	$ob = $obs[rand @obs];
		2507	} else {
		2508	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2509	}
		2510	# else put us there anyways for now #d#
		2511
		2512	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2513	} else {
		2514	($path, $x, $y) = (undef, undef, undef);
		2515	}
		2516	}
		2517
1967	my $map = eval {	2518	my $map = eval {
1968	my $map = cf::map::find $path;	2519	my $map = defined $path ? cf::map::find $path : undef;
		2520
		2521	if ($map) {
1969	$map = $map->customise_for ($self) if $map;	2522	$map = $map->customise_for ($self);
		2523	$map = $check->($map) if $check && $map;
		2524	} else {
		2525	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2526	}
		2527
1970	$map	2528	$map
		2529	};
		2530
		2531	if ($@) {
		2532	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2533	LOG llevError | logBacktrace, Carp::longmess $@;
1971	} or	2534	}
1972	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1973		2535
		2536	if ($gen == $self->{_goto_generation}) {
		2537	delete $self->{_goto_generation};
1974	$self->leave_link ($map, $x, $y);	2538	$self->leave_link ($map, $x, $y);
		2539	}
		2540
		2541	$done->() if $done;
1975	})->prio (1);	2542	})->prio (1);
1976	}	2543	}
1977		2544
1978	=item $player_object->enter_exit ($exit_object)	2545	=item $player_object->enter_exit ($exit_object)
1979		2546
…		…
2048	my $hp = $exit->stats->hp;	2615	my $hp = $exit->stats->hp;
2049	my $sp = $exit->stats->sp;	2616	my $sp = $exit->stats->sp;
2050		2617
2051	$self->enter_link;	2618	$self->enter_link;
2052		2619
		2620	# if exit is damned, update players death & WoR home-position
		2621	$self->contr->savebed ($slaying, $hp, $sp)
		2622	if $exit->flag (FLAG_DAMNED);
		2623
2053	(async {	2624	(async {
		2625	$Coro::current->{desc} = "enter_exit $slaying $hp $sp";
		2626
2054	$self->deactivate_recursive; # just to be sure	2627	$self->deactivate_recursive; # just to be sure
2055	unless (eval {	2628	unless (eval {
2056	$self->goto ($slaying, $hp, $sp);	2629	$self->goto ($slaying, $hp, $sp);
2057		2630
2058	1;	2631	1;
…		…
2084		2657
2085	utf8::encode $text;	2658	utf8::encode $text;
2086	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2659	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2087	}	2660	}
2088		2661
		2662	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2663
		2664	Send a drawinfo or msg packet to the client, formatting the msg for the
		2665	client if neccessary. C<$type> should be a string identifying the type of
		2666	the message, with C<log> being the default. If C<$color> is negative, suppress
		2667	the message unless the client supports the msg packet.
		2668
		2669	=cut
		2670
		2671	our %CHANNEL = (
		2672	"c/identify" => {
		2673	id => "infobox",
		2674	title => "Identify",
		2675	reply => undef,
		2676	tooltip => "Items recently identified",
		2677	},
		2678	"c/examine" => {
		2679	id => "infobox",
		2680	title => "Examine",
		2681	reply => undef,
		2682	tooltip => "Signs and other items you examined",
		2683	},
		2684	"c/lookat" => {
		2685	id => "infobox",
		2686	title => "Look",
		2687	reply => undef,
		2688	tooltip => "What you saw there",
		2689	},
		2690	);
		2691
		2692	sub cf::client::send_msg {
		2693	my ($self, $channel, $msg, $color, @extra) = @_;
		2694
		2695	$msg = $self->pl->expand_cfpod ($msg);
		2696
		2697	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2698
		2699	# check predefined channels, for the benefit of C
		2700	if ($CHANNEL{$channel}) {
		2701	$channel = $CHANNEL{$channel};
		2702
		2703	$self->ext_msg (channel_info => $channel)
		2704	if $self->can_msg;
		2705
		2706	$channel = $channel->{id};
		2707
		2708	} elsif (ref $channel) {
		2709	# send meta info to client, if not yet sent
		2710	unless (exists $self->{channel}{$channel->{id}}) {
		2711	$self->{channel}{$channel->{id}} = $channel;
		2712	$self->ext_msg (channel_info => $channel)
		2713	if $self->can_msg;
		2714	}
		2715
		2716	$channel = $channel->{id};
		2717	}
		2718
		2719	return unless @extra || length $msg;
		2720
		2721	if ($self->can_msg) {
		2722	# default colour, mask it out
		2723	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2724	if $color & cf::NDI_DEF;
		2725
		2726	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2727	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2728	} else {
		2729	if ($color >= 0) {
		2730	# replace some tags by gcfclient-compatible ones
		2731	for ($msg) {
		2732	1 while
		2733	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2734	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2735	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2736	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2737	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2738	}
		2739
		2740	$color &= cf::NDI_COLOR_MASK;
		2741
		2742	utf8::encode $msg;
		2743
		2744	if (0 && $msg =~ /\[/) {
		2745	# COMMAND/INFO
		2746	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2747	} else {
		2748	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2749	$self->send_packet ("drawinfo $color $msg")
		2750	}
		2751	}
		2752	}
		2753	}
		2754
2089	=item $client->ext_event ($type, %msg)	2755	=item $client->ext_msg ($type, @msg)
2090		2756
2091	Sends an exti event to the client.	2757	Sends an ext event to the client.
2092		2758
2093	=cut	2759	=cut
2094		2760
2095	sub cf::client::ext_event($$%) {	2761	sub cf::client::ext_msg($$@) {
2096	my ($self, $type, %msg) = @_;	2762	my ($self, $type, @msg) = @_;
2097		2763
		2764	if ($self->extcmd == 2) {
		2765	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2766	} elsif ($self->extcmd == 1) { # TODO: remove
2098	$msg{msgtype} = "event_$type";	2767	push @msg, msgtype => "event_$type";
2099	$self->send_packet ("ext " . cf::to_json \%msg);	2768	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2769	}
		2770	}
		2771
		2772	=item $client->ext_reply ($msgid, @msg)
		2773
		2774	Sends an ext reply to the client.
		2775
		2776	=cut
		2777
		2778	sub cf::client::ext_reply($$@) {
		2779	my ($self, $id, @msg) = @_;
		2780
		2781	if ($self->extcmd == 2) {
		2782	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2783	} elsif ($self->extcmd == 1) {
		2784	#TODO: version 1, remove
		2785	unshift @msg, msgtype => "reply", msgid => $id;
		2786	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2787	}
2100	}	2788	}
2101		2789
2102	=item $success = $client->query ($flags, "text", \&cb)	2790	=item $success = $client->query ($flags, "text", \&cb)
2103		2791
2104	Queues a query to the client, calling the given callback with	2792	Queues a query to the client, calling the given callback with
2105	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2793	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2106	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2794	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2107		2795
2108	Queries can fail, so check the return code. Or don't, as queries will become	2796	Queries can fail, so check the return code. Or don't, as queries will
2109	reliable at some point in the future.	2797	become reliable at some point in the future.
2110		2798
2111	=cut	2799	=cut
2112		2800
2113	sub cf::client::query {	2801	sub cf::client::query {
2114	my ($self, $flags, $text, $cb) = @_;	2802	my ($self, $flags, $text, $cb) = @_;
…		…
2122	utf8::encode $text;	2810	utf8::encode $text;
2123	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2811	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2124		2812
2125	$self->send_packet ($self->{query_queue}[0][0])	2813	$self->send_packet ($self->{query_queue}[0][0])
2126	if @{ $self->{query_queue} } == 1;	2814	if @{ $self->{query_queue} } == 1;
		2815
		2816	1
2127	}	2817	}
2128		2818
2129	cf::client->attach (	2819	cf::client->attach (
		2820	on_connect => sub {
		2821	my ($ns) = @_;
		2822
		2823	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2824	},
2130	on_reply => sub {	2825	on_reply => sub {
2131	my ($ns, $msg) = @_;	2826	my ($ns, $msg) = @_;
2132		2827
2133	# this weird shuffling is so that direct followup queries	2828	# this weird shuffling is so that direct followup queries
2134	# get handled first	2829	# get handled first
…		…
2146	} else {	2841	} else {
2147	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2842	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2148	}	2843	}
2149	}	2844	}
2150	},	2845	},
		2846	on_exticmd => sub {
		2847	my ($ns, $buf) = @_;
		2848
		2849	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2850
		2851	if (ref $msg) {
		2852	my ($type, $reply, @payload) =
		2853	"ARRAY" eq ref $msg
		2854	? @$msg
		2855	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2856
		2857	my @reply;
		2858
		2859	if (my $cb = $EXTICMD{$type}) {
		2860	@reply = $cb->($ns, @payload);
		2861	}
		2862
		2863	$ns->ext_reply ($reply, @reply)
		2864	if $reply;
		2865
		2866	} else {
		2867	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2868	}
		2869
		2870	cf::override;
		2871	},
2151	);	2872	);
2152		2873
2153	=item $client->async (\&cb)	2874	=item $client->async (\&cb)
2154		2875
2155	Create a new coroutine, running the specified callback. The coroutine will	2876	Create a new coroutine, running the specified callback. The coroutine will
…		…
2196	our $safe = new Safe "safe";	2917	our $safe = new Safe "safe";
2197	our $safe_hole = new Safe::Hole;	2918	our $safe_hole = new Safe::Hole;
2198		2919
2199	$SIG{FPE} = 'IGNORE';	2920	$SIG{FPE} = 'IGNORE';
2200		2921
2201	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2922	$safe->permit_only (Opcode::opset qw(
		2923	:base_core :base_mem :base_orig :base_math
		2924	grepstart grepwhile mapstart mapwhile
		2925	sort time
		2926	));
2202		2927
2203	# here we export the classes and methods available to script code	2928	# here we export the classes and methods available to script code
2204		2929
2205	=pod	2930	=pod
2206		2931
2207	The following functions and methods are available within a safe environment:	2932	The following functions and methods are available within a safe environment:
2208		2933
2209	cf::object contr pay_amount pay_player map	2934	cf::object
		2935	contr pay_amount pay_player map x y force_find force_add destroy
		2936	insert remove name archname title slaying race decrease_ob_nr
		2937
2210	cf::object::player player	2938	cf::object::player
2211	cf::player peaceful	2939	player
2212	cf::map trigger	2940
		2941	cf::player
		2942	peaceful
		2943
		2944	cf::map
		2945	trigger
2213		2946
2214	=cut	2947	=cut
2215		2948
2216	for (	2949	for (
2217	["cf::object" => qw(contr pay_amount pay_player map)],	2950	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2951	insert remove inv name archname title slaying race
		2952	decrease_ob_nr destroy)],
2218	["cf::object::player" => qw(player)],	2953	["cf::object::player" => qw(player)],
2219	["cf::player" => qw(peaceful)],	2954	["cf::player" => qw(peaceful)],
2220	["cf::map" => qw(trigger)],	2955	["cf::map" => qw(trigger)],
2221	) {	2956	) {
2222	no strict 'refs';	2957	no strict 'refs';
…		…
2293	=back	3028	=back
2294		3029
2295	=cut	3030	=cut
2296		3031
2297	#############################################################################	3032	#############################################################################
2298
2299	=head2 EXTENSION DATABASE SUPPORT
2300
2301	Crossfire maintains a very simple database for extension use. It can
2302	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2303	convert to/from binary).
2304
2305	The parameter C<$family> should best start with the name of the extension
2306	using it, it should be unique.
2307
2308	=over 4
2309
2310	=item $value = cf::db_get $family => $key
2311
2312	Returns a single value from the database.
2313
2314	=item cf::db_put $family => $key => $value
2315
2316	Stores the given C<$value> in the family.
2317
2318	=cut
2319
2320	our $DB;
2321
2322	sub db_init {
2323	unless ($DB) {
2324	$DB = BDB::db_create $DB_ENV;
2325
2326	cf::sync_job {
2327	eval {
2328	$DB->set_flags (BDB::CHKSUM);
2329
2330	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2331	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2332	cf::cleanup "db_open(db): $!" if $!;
2333	};
2334	cf::cleanup "db_open(db): $@" if $@;
2335	};
2336	}
2337	}
2338
2339	sub db_get($$) {
2340	my $key = "$_[0]/$_[1]";
2341
2342	cf::sync_job {
2343	BDB::db_get $DB, undef, $key, my $data;
2344
2345	$! ? ()
2346	: $data
2347	}
2348	}
2349
2350	sub db_put($$$) {
2351	BDB::dbreq_pri 4;
2352	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2353	}
2354
2355	=item cf::cache $id => [$paths...], $processversion => $process
2356
2357	Generic caching function that returns the value of the resource $id,
2358	caching and regenerating as required.
2359
2360	This function can block.
2361
2362	=cut
2363
2364	sub cache {
2365	my ($id, $src, $processversion, $process) = @_;
2366
2367	my $meta =
2368	join "\x00",
2369	$processversion,
2370	map {
2371	aio_stat $_
2372	and Carp::croak "$_: $!";
2373
2374	($_, (stat _)[7,9])
2375	} @$src;
2376
2377	my $dbmeta = db_get cache => "$id/meta";
2378	if ($dbmeta ne $meta) {
2379	# changed, we may need to process
2380
2381	my @data;
2382	my $md5;
2383
2384	for (0 .. $#$src) {
2385	0 <= aio_load $src->[$_], $data[$_]
2386	or Carp::croak "$src->[$_]: $!";
2387	}
2388
2389	# if processing is expensive, check
2390	# checksum first
2391	if (1) {
2392	$md5 =
2393	join "\x00",
2394	$processversion,
2395	map {
2396	Coro::cede;
2397	($src->[$_], Digest::MD5::md5_hex $data[$_])
2398	} 0.. $#$src;
2399
2400
2401	my $dbmd5 = db_get cache => "$id/md5";
2402	if ($dbmd5 eq $md5) {
2403	db_put cache => "$id/meta", $meta;
2404
2405	return db_get cache => "$id/data";
2406	}
2407	}
2408
2409	my $t1 = Time::HiRes::time;
2410	my $data = $process->(\@data);
2411	my $t2 = Time::HiRes::time;
2412
2413	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2414
2415	db_put cache => "$id/data", $data;
2416	db_put cache => "$id/md5" , $md5;
2417	db_put cache => "$id/meta", $meta;
2418
2419	return $data;
2420	}
2421
2422	db_get cache => "$id/data"
2423	}
2424
2425	=item fork_call { }, $args
2426
2427	Executes the given code block with the given arguments in a seperate
2428	process, returning the results. Everything must be serialisable with
2429	Coro::Storable. May, of course, block. Note that the executed sub may
2430	never block itself or use any form of Event handling.
2431
2432	=cut
2433
2434	sub fork_call(&@) {
2435	my ($cb, @args) = @_;
2436
2437	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2438	# or die "socketpair: $!";
2439	pipe my $fh1, my $fh2
2440	or die "pipe: $!";
2441
2442	if (my $pid = fork) {
2443	close $fh2;
2444
2445	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2446	$res = Coro::Storable::thaw $res;
2447
2448	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2449
2450	die $$res unless "ARRAY" eq ref $res;
2451
2452	return wantarray ? @$res : $res->[-1];
2453	} else {
2454	reset_signals;
2455	local $SIG{__WARN__};
2456	local $SIG{__DIE__};
2457	eval {
2458	close $fh1;
2459
2460	my @res = eval { $cb->(@args) };
2461	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2462	};
2463
2464	warn $@ if $@;
2465	_exit 0;
2466	}
2467	}
2468
2469
2470
2471	#############################################################################
2472	# the server's init and main functions	3033	# the server's init and main functions
2473		3034
2474	sub load_facedata($) {	3035	sub load_facedata($) {
2475	my ($path) = @_;	3036	my ($path) = @_;
		3037
		3038	# HACK to clear player env face cache, we need some signal framework
		3039	# for this (global event?)
		3040	%ext::player_env::MUSIC_FACE_CACHE = ();
		3041
		3042	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2476		3043
2477	warn "loading facedata from $path\n";	3044	warn "loading facedata from $path\n";
2478		3045
2479	my $facedata;	3046	my $facedata;
2480	0 < aio_load $path, $facedata	3047	0 < aio_load $path, $facedata
…		…
2483	$facedata = Coro::Storable::thaw $facedata;	3050	$facedata = Coro::Storable::thaw $facedata;
2484		3051
2485	$facedata->{version} == 2	3052	$facedata->{version} == 2
2486	or cf::cleanup "$path: version mismatch, cannot proceed.";	3053	or cf::cleanup "$path: version mismatch, cannot proceed.";
2487		3054
		3055	# patch in the exptable
		3056	$facedata->{resource}{"res/exp_table"} = {
		3057	type => FT_RSRC,
		3058	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
		3059	};
		3060	cf::cede_to_tick;
		3061
2488	{	3062	{
2489	my $faces = $facedata->{faceinfo};	3063	my $faces = $facedata->{faceinfo};
2490		3064
2491	while (my ($face, $info) = each %$faces) {	3065	while (my ($face, $info) = each %$faces) {
2492	my $idx = (cf::face::find $face) || cf::face::alloc $face;	3066	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2493	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	3067	cf::face::set_visibility $idx, $info->{visibility};
		3068	cf::face::set_magicmap $idx, $info->{magicmap};
2494	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	3069	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2495	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	3070	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2496	Coro::cede;	3071
		3072	cf::cede_to_tick;
2497	}	3073	}
2498		3074
2499	while (my ($face, $info) = each %$faces) {	3075	while (my ($face, $info) = each %$faces) {
2500	next unless $info->{smooth};	3076	next unless $info->{smooth};
2501	my $idx = cf::face::find $face	3077	my $idx = cf::face::find $face
2502	or next;	3078	or next;
2503	if (my $smooth = cf::face::find $info->{smooth}) {	3079	if (my $smooth = cf::face::find $info->{smooth}) {
		3080	cf::face::set_smooth $idx, $smooth;
2504	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	3081	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2505	} else {	3082	} else {
2506	warn "smooth face '$info->{smooth}' not found for face '$face'";	3083	warn "smooth face '$info->{smooth}' not found for face '$face'";
2507	}	3084	}
2508	Coro::cede;	3085
		3086	cf::cede_to_tick;
2509	}	3087	}
2510	}	3088	}
2511		3089
2512	{	3090	{
2513	my $anims = $facedata->{animinfo};	3091	my $anims = $facedata->{animinfo};
2514		3092
2515	while (my ($anim, $info) = each %$anims) {	3093	while (my ($anim, $info) = each %$anims) {
2516	cf::anim::set $anim, $info->{frames}, $info->{facings};	3094	cf::anim::set $anim, $info->{frames}, $info->{facings};
2517	Coro::cede;	3095	cf::cede_to_tick;
2518	}	3096	}
2519		3097
2520	cf::anim::invalidate_all; # d'oh	3098	cf::anim::invalidate_all; # d'oh
2521	}	3099	}
2522		3100
		3101	{
		3102	# TODO: for gcfclient pleasure, we should give resources
		3103	# that gcfclient doesn't grok a >10000 face index.
		3104	my $res = $facedata->{resource};
		3105
		3106	my $soundconf = delete $res->{"res/sound.conf"};
		3107
		3108	while (my ($name, $info) = each %$res) {
		3109	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3110	my $data;
		3111
		3112	if ($info->{type} & 1) {
		3113	# prepend meta info
		3114
		3115	my $meta = $enc->encode ({
		3116	name => $name,
		3117	%{ $info->{meta} || {} },
		3118	});
		3119
		3120	$data = pack "(w/a*)*", $meta, $info->{data};
		3121	} else {
		3122	$data = $info->{data};
		3123	}
		3124
		3125	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3126	cf::face::set_type $idx, $info->{type};
		3127
		3128	cf::cede_to_tick;
		3129	}
		3130
		3131	if ($soundconf) {
		3132	$soundconf = $enc->decode (delete $soundconf->{data});
		3133
		3134	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3135	my $sound = $soundconf->{compat}[$_]
		3136	or next;
		3137
		3138	my $face = cf::face::find "sound/$sound->[1]";
		3139	cf::sound::set $sound->[0] => $face;
		3140	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3141	}
		3142
		3143	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3144	my $face = cf::face::find "sound/$v";
		3145	cf::sound::set $k => $face;
		3146	}
		3147	}
		3148	}
		3149
2523	1	3150	1
2524	}	3151	}
2525		3152
		3153	register_exticmd fx_want => sub {
		3154	my ($ns, $want) = @_;
		3155
		3156	while (my ($k, $v) = each %$want) {
		3157	$ns->fx_want ($k, $v);
		3158	}
		3159	};
		3160
2526	sub reload_regions {	3161	sub reload_regions {
		3162	# HACK to clear player env face cache, we need some signal framework
		3163	# for this (global event?)
		3164	%ext::player_env::MUSIC_FACE_CACHE = ();
		3165
2527	load_resource_file "$MAPDIR/regions"	3166	load_resource_file "$MAPDIR/regions"
2528	or die "unable to load regions file\n";	3167	or die "unable to load regions file\n";
		3168
		3169	for (cf::region::list) {
		3170	$_->{match} = qr/$_->{match}/
		3171	if exists $_->{match};
		3172	}
2529	}	3173	}
2530		3174
2531	sub reload_facedata {	3175	sub reload_facedata {
2532	load_facedata "$DATADIR/facedata"	3176	load_facedata "$DATADIR/facedata"
2533	or die "unable to load facedata\n";	3177	or die "unable to load facedata\n";
2534	}	3178	}
2535		3179
2536	sub reload_archetypes {	3180	sub reload_archetypes {
2537	load_resource_file "$DATADIR/archetypes"	3181	load_resource_file "$DATADIR/archetypes"
2538	or die "unable to load archetypes\n";	3182	or die "unable to load archetypes\n";
		3183	#d# NEED to laod twice to resolve forward references
		3184	# this really needs to be done in an extra post-pass
		3185	# (which needs to be synchronous, so solve it differently)
		3186	load_resource_file "$DATADIR/archetypes"
		3187	or die "unable to load archetypes\n";
2539	}	3188	}
2540		3189
2541	sub reload_treasures {	3190	sub reload_treasures {
2542	load_resource_file "$DATADIR/treasures"	3191	load_resource_file "$DATADIR/treasures"
2543	or die "unable to load treasurelists\n";	3192	or die "unable to load treasurelists\n";
…		…
2546	sub reload_resources {	3195	sub reload_resources {
2547	warn "reloading resource files...\n";	3196	warn "reloading resource files...\n";
2548		3197
2549	reload_regions;	3198	reload_regions;
2550	reload_facedata;	3199	reload_facedata;
		3200	#reload_archetypes;#d#
2551	reload_archetypes;	3201	reload_archetypes;
2552	reload_treasures;	3202	reload_treasures;
2553		3203
2554	warn "finished reloading resource files\n";	3204	warn "finished reloading resource files\n";
2555	}	3205	}
2556		3206
2557	sub init {	3207	sub init {
2558	reload_resources;	3208	reload_resources;
2559	}	3209	}
2560		3210
2561	sub cfg_load {	3211	sub reload_config {
2562	open my $fh, "<:utf8", "$CONFDIR/config"	3212	open my $fh, "<:utf8", "$CONFDIR/config"
2563	or return;	3213	or return;
2564		3214
2565	local $/;	3215	local $/;
2566	*CFG = YAML::Syck::Load <$fh>;	3216	*CFG = YAML::Syck::Load <$fh>;
…		…
2582	sub main {	3232	sub main {
2583	# we must not ever block the main coroutine	3233	# we must not ever block the main coroutine
2584	local $Coro::idle = sub {	3234	local $Coro::idle = sub {
2585	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3235	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2586	(async {	3236	(async {
		3237	$Coro::current->{desc} = "IDLE BUG HANDLER";
2587	Event::one_event;	3238	Event::one_event;
2588	})->prio (Coro::PRIO_MAX);	3239	})->prio (Coro::PRIO_MAX);
2589	};	3240	};
2590		3241
2591	cfg_load;	3242	reload_config;
2592	db_init;	3243	db_init;
2593	load_extensions;	3244	load_extensions;
2594		3245
2595	$TICK_WATCHER->start;	3246	$TICK_WATCHER->start;
2596	Event::loop;	3247	Event::loop;
…		…
2612	},	3263	},
2613	);	3264	);
2614	}	3265	}
2615	}	3266	}
2616		3267
		3268	sub write_runtime {
		3269	my $runtime = "$LOCALDIR/runtime";
		3270
		3271	# first touch the runtime file to show we are still running:
		3272	# the fsync below can take a very very long time.
		3273
		3274	IO::AIO::aio_utime $runtime, undef, undef;
		3275
		3276	my $guard = cf::lock_acquire "write_runtime";
		3277
		3278	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3279	or return;
		3280
		3281	my $value = $cf::RUNTIME + 90 + 10;
		3282	# 10 is the runtime save interval, for a monotonic clock
		3283	# 60 allows for the watchdog to kill the server.
		3284
		3285	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3286	and return;
		3287
		3288	# always fsync - this file is important
		3289	aio_fsync $fh
		3290	and return;
		3291
		3292	# touch it again to show we are up-to-date
		3293	aio_utime $fh, undef, undef;
		3294
		3295	close $fh
		3296	or return;
		3297
		3298	aio_rename "$runtime~", $runtime
		3299	and return;
		3300
		3301	warn "runtime file written.\n";
		3302
		3303	1
		3304	}
		3305
2617	sub emergency_save() {	3306	sub emergency_save() {
2618	my $freeze_guard = cf::freeze_mainloop;	3307	my $freeze_guard = cf::freeze_mainloop;
2619		3308
2620	warn "enter emergency perl save\n";	3309	warn "enter emergency perl save\n";
2621		3310
…		…
2625	# and maps saved/destroyed asynchronously.	3314	# and maps saved/destroyed asynchronously.
2626	warn "begin emergency player save\n";	3315	warn "begin emergency player save\n";
2627	for my $login (keys %cf::PLAYER) {	3316	for my $login (keys %cf::PLAYER) {
2628	my $pl = $cf::PLAYER{$login} or next;	3317	my $pl = $cf::PLAYER{$login} or next;
2629	$pl->valid or next;	3318	$pl->valid or next;
		3319	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2630	$pl->save;	3320	$pl->save;
2631	}	3321	}
2632	warn "end emergency player save\n";	3322	warn "end emergency player save\n";
2633		3323
2634	warn "begin emergency map save\n";	3324	warn "begin emergency map save\n";
…		…
2682		3372
2683	warn "flushing outstanding aio requests";	3373	warn "flushing outstanding aio requests";
2684	for (;;) {	3374	for (;;) {
2685	BDB::flush;	3375	BDB::flush;
2686	IO::AIO::flush;	3376	IO::AIO::flush;
2687	Coro::cede;	3377	Coro::cede_notself;
2688	last unless IO::AIO::nreqs || BDB::nreqs;	3378	last unless IO::AIO::nreqs || BDB::nreqs;
2689	warn "iterate...";	3379	warn "iterate...";
2690	}	3380	}
2691		3381
2692	++$RELOAD;	3382	++$RELOAD;
…		…
2696	%EXT_CORO = ();	3386	%EXT_CORO = ();
2697		3387
2698	warn "removing commands";	3388	warn "removing commands";
2699	%COMMAND = ();	3389	%COMMAND = ();
2700		3390
2701	warn "removing ext commands";	3391	warn "removing ext/exti commands";
2702	%EXTCMD = ();	3392	%EXTCMD = ();
		3393	%EXTICMD = ();
2703		3394
2704	warn "unloading/nuking all extensions";	3395	warn "unloading/nuking all extensions";
2705	for my $pkg (@EXTS) {	3396	for my $pkg (@EXTS) {
2706	warn "... unloading $pkg";	3397	warn "... unloading $pkg";
2707		3398
…		…
2750	warn "reloading cf.pm";	3441	warn "reloading cf.pm";
2751	require cf;	3442	require cf;
2752	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3443	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2753		3444
2754	warn "loading config and database again";	3445	warn "loading config and database again";
2755	cf::cfg_load;	3446	cf::reload_config;
2756		3447
2757	warn "loading extensions";	3448	warn "loading extensions";
2758	cf::load_extensions;	3449	cf::load_extensions;
2759		3450
2760	warn "reattaching attachments to objects/players";	3451	warn "reattaching attachments to objects/players";
…		…
2796	register_command "reload" => sub {	3487	register_command "reload" => sub {
2797	my ($who, $arg) = @_;	3488	my ($who, $arg) = @_;
2798		3489
2799	if ($who->flag (FLAG_WIZ)) {	3490	if ($who->flag (FLAG_WIZ)) {
2800	$who->message ("reloading server.");	3491	$who->message ("reloading server.");
		3492	async {
		3493	$Coro::current->{desc} = "perl_reload";
2801	async { reload_perl };	3494	reload_perl;
		3495	};
2802	}	3496	}
2803	};	3497	};
2804		3498
2805	unshift @INC, $LIBDIR;	3499	unshift @INC, $LIBDIR;
2806		3500
…		…
2838	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3532	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2839	unless ++$bug_warning > 10;	3533	unless ++$bug_warning > 10;
2840	return;	3534	return;
2841	}	3535	}
2842		3536
2843	$NOW = Event::time;	3537	$NOW = $tick_start = Event::time;
2844		3538
2845	cf::server_tick; # one server iteration	3539	cf::server_tick; # one server iteration
2846		3540
2847	$RUNTIME += $TICK;	3541	$RUNTIME += $TICK;
2848	$NEXT_TICK += $TICK;	3542	$NEXT_TICK += $TICK;
2849		3543
2850	if ($NOW >= $NEXT_RUNTIME_WRITE) {	3544	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2851	$NEXT_RUNTIME_WRITE = $NOW + 10;	3545	$NEXT_RUNTIME_WRITE = $NOW + 10;
2852	Coro::async_pool {	3546	Coro::async_pool {
		3547	$Coro::current->{desc} = "runtime saver";
2853	write_runtime	3548	write_runtime
2854	or warn "ERROR: unable to write runtime file: $!";	3549	or warn "ERROR: unable to write runtime file: $!";
2855	};	3550	};
2856	}	3551	}
2857		3552
2858	# my $AFTER = Event::time;	3553	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2859	# warn $AFTER - $NOW;#d#	3554	$sig->send;
		3555	}
		3556	while (my $sig = shift @WAIT_FOR_TICK) {
		3557	$sig->send;
		3558	}
		3559
		3560	$NOW = Event::time;
2860		3561
2861	# if we are delayed by four ticks or more, skip them all	3562	# if we are delayed by four ticks or more, skip them all
2862	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3563	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2863		3564
2864	$TICK_WATCHER->at ($NEXT_TICK);	3565	$TICK_WATCHER->at ($NEXT_TICK);
2865	$TICK_WATCHER->start;	3566	$TICK_WATCHER->start;
2866		3567
2867	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {	3568	$LOAD = ($NOW - $tick_start) / $TICK;
2868	$sig->send;	3569	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2869	}
2870	while (my $sig = shift @WAIT_FOR_TICK) {
2871	$sig->send;
2872	}
2873		3570
2874	_post_tick;	3571	_post_tick;
2875	},	3572	},
2876	);	3573	);
2877		3574
2878	{	3575	{
		3576	BDB::min_parallel 8;
2879	BDB::max_poll_time $TICK * 0.1;	3577	BDB::max_poll_time $TICK * 0.1;
2880	$BDB_POLL_WATCHER = Event->io (	3578	$BDB_POLL_WATCHER = Event->io (
2881	reentrant => 0,	3579	reentrant => 0,
2882	fd => BDB::poll_fileno,	3580	fd => BDB::poll_fileno,
2883	poll => 'r',	3581	poll => 'r',
2884	prio => 0,	3582	prio => 0,
2885	data => WF_AUTOCANCEL,	3583	data => WF_AUTOCANCEL,
2886	cb => \&BDB::poll_cb,	3584	cb => \&BDB::poll_cb,
2887	);	3585	);
2888	BDB::min_parallel 8;
2889		3586
2890	BDB::set_sync_prepare {	3587	BDB::set_sync_prepare {
2891	my $status;	3588	my $status;
2892	my $current = $Coro::current;	3589	my $current = $Coro::current;
2893	(	3590	(
…		…
2902	)	3599	)
2903	};	3600	};
2904		3601
2905	unless ($DB_ENV) {	3602	unless ($DB_ENV) {
2906	$DB_ENV = BDB::db_env_create;	3603	$DB_ENV = BDB::db_env_create;
		3604	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
		3605	| BDB::LOG_AUTOREMOVE, 1);
		3606	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3607	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
2907		3608
2908	cf::sync_job {	3609	cf::sync_job {
2909	eval {	3610	eval {
2910	BDB::db_env_open	3611	BDB::db_env_open
2911	$DB_ENV,	3612	$DB_ENV,
…		…
2913	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	3614	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2914	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3615	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2915	0666;	3616	0666;
2916		3617
2917	cf::cleanup "db_env_open($BDBDIR): $!" if $!;	3618	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2918
2919	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2920	$DB_ENV->set_lk_detect;
2921	};	3619	};
2922		3620
2923	cf::cleanup "db_env_open(db): $@" if $@;	3621	cf::cleanup "db_env_open(db): $@" if $@;
2924	};	3622	};
2925	}	3623	}
		3624
		3625	$BDB_DEADLOCK_WATCHER = Event->timer (
		3626	after => 3,
		3627	interval => 1,
		3628	hard => 1,
		3629	prio => 0,
		3630	data => WF_AUTOCANCEL,
		3631	cb => sub {
		3632	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3633	},
		3634	);
		3635	$BDB_CHECKPOINT_WATCHER = Event->timer (
		3636	after => 11,
		3637	interval => 60,
		3638	hard => 1,
		3639	prio => 0,
		3640	data => WF_AUTOCANCEL,
		3641	cb => sub {
		3642	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3643	},
		3644	);
		3645	$BDB_TRICKLE_WATCHER = Event->timer (
		3646	after => 5,
		3647	interval => 10,
		3648	hard => 1,
		3649	prio => 0,
		3650	data => WF_AUTOCANCEL,
		3651	cb => sub {
		3652	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3653	},
		3654	);
2926	}	3655	}
2927		3656
2928	{	3657	{
2929	IO::AIO::min_parallel 8;	3658	IO::AIO::min_parallel 8;
2930		3659
…		…
2933	$AIO_POLL_WATCHER = Event->io (	3662	$AIO_POLL_WATCHER = Event->io (
2934	reentrant => 0,	3663	reentrant => 0,
2935	data => WF_AUTOCANCEL,	3664	data => WF_AUTOCANCEL,
2936	fd => IO::AIO::poll_fileno,	3665	fd => IO::AIO::poll_fileno,
2937	poll => 'r',	3666	poll => 'r',
2938	prio => 6,	3667	prio => 0,
2939	cb => \&IO::AIO::poll_cb,	3668	cb => \&IO::AIO::poll_cb,
2940	);	3669	);
2941	}	3670	}
2942		3671
2943	my $_log_backtrace;	3672	my $_log_backtrace;
…		…
2949		3678
2950	# limit the # of concurrent backtraces	3679	# limit the # of concurrent backtraces
2951	if ($_log_backtrace < 2) {	3680	if ($_log_backtrace < 2) {
2952	++$_log_backtrace;	3681	++$_log_backtrace;
2953	async {	3682	async {
		3683	$Coro::current->{desc} = "abt $msg";
		3684
2954	my @bt = fork_call {	3685	my @bt = fork_call {
2955	@addr = map { sprintf "%x", $_ } @addr;	3686	@addr = map { sprintf "%x", $_ } @addr;
2956	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;	3687	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
2957	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"	3688	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
2958	or die "addr2line: $!";	3689	or die "addr2line: $!";

Diff Legend

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