ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.254 by root, Thu Apr 19 11:12:45 2007 UTC vs.
Revision 1.389 by root, Sat Oct 20 04:39:57 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 {
…		…
161	my $msg = join "", @_;	188	my $msg = join "", @_;
162		189
163	$msg .= "\n"	190	$msg .= "\n"
164	unless $msg =~ /\n$/;	191	unless $msg =~ /\n$/;
165		192
166	$msg =~ s/([\x00-\x09\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 $guard = cf::lock_acquire "write_runtime";
373		492
374	my $runtime = "$LOCALDIR/runtime";	493	Executes the given code block with the given arguments in a seperate
		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.
375		497
376	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	498	=cut
377	or return;
378		499
379	my $value = $cf::RUNTIME + 90 + 10;	500	sub fork_call(&@) {
380	# 10 is the runtime save interval, for a monotonic clock	501	my ($cb, @args) = @_;
381	# 60 allows for the watchdog to kill the server.
382		502
383	(aio_write $fh, 0, (length $value), $value, 0) <= 0	503	# we seemingly have to make a local copy of the whole thing,
384	and return;	504	# otherwise perl prematurely frees the stuff :/
		505	# TODO: investigate and fix (likely this will be rather laborious)
385		506
386	# always fsync - this file is important	507	my @res = Coro::Util::fork_eval {
387	aio_fsync $fh	508	reset_signals;
388	and return;	509	&$cb
		510	}, @args;
389		511
390	close $fh	512	wantarray ? @res : $res[-1]
391	or return;	513	}
392		514
393	aio_rename "$runtime~", $runtime	515	=item $value = cf::db_get $family => $key
394	and return;
395		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 $!;
		542	};
		543	cf::cleanup "db_open(db): $@" if $@;
		544
		545	$db
		546	}
		547
		548	our $DB;
		549
		550	sub db_init {
		551	cf::sync_job {
		552	$DB ||= db_table "db";
		553	};
		554	}
		555
		556	sub db_get($$) {
		557	my $key = "$_[0]/$_[1]";
		558
		559	cf::sync_job {
		560	BDB::db_get $DB, undef, $key, my $data;
		561
		562	$! ? ()
		563	: $data
396	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"
397	}	640	}
398		641
399	=item cf::datalog type => key => value, ...	642	=item cf::datalog type => key => value, ...
400		643
401	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.
…		…
419	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")
420	to it. All such attachable objects support the following methods.	663	to it. All such attachable objects support the following methods.
421		664
422	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>
423	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
424	crossfire+).	667	Crossfire TRT).
425		668
426	=over 4	669	=over 4
427		670
428	=item $attachable->attach ($attachment, key => $value...)	671	=item $attachable->attach ($attachment, key => $value...)
429		672
…		…
592	$registry = $CB_TYPE[$object_type] ||= [];	835	$registry = $CB_TYPE[$object_type] ||= [];
593		836
594	} elsif ($type eq "subtype") {	837	} elsif ($type eq "subtype") {
595	defined $object_type or Carp::croak "subtype specified without type";	838	defined $object_type or Carp::croak "subtype specified without type";
596	my $object_subtype = shift @arg;	839	my $object_subtype = shift @arg;
597	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	840	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
598		841
599	} elsif ($type eq "package") {	842	} elsif ($type eq "package") {
600	my $pkg = shift @arg;	843	my $pkg = shift @arg;
601		844
602	while (my ($name, $id) = each %cb_id) {	845	while (my ($name, $id) = each %cb_id) {
…		…
631	_attach $registry, $klass, @attach;	874	_attach $registry, $klass, @attach;
632	}	875	}
633		876
634	$obj->{$name} = \%arg;	877	$obj->{$name} = \%arg;
635	} else {	878	} else {
636	warn "object uses attachment '$name' that is not available, postponing.\n";	879	warn "object uses attachment '$name' which is not available, postponing.\n";
637	}	880	}
638		881
639	$obj->{_attachment}{$name} = undef;	882	$obj->{_attachment}{$name} = undef;
640	}	883	}
641		884
…		…
643	if (ref $_[0]) {	886	if (ref $_[0]) {
644	_object_attach @_;	887	_object_attach @_;
645	} else {	888	} else {
646	_attach shift->_attach_registry, @_;	889	_attach shift->_attach_registry, @_;
647	}	890	}
		891	_recalc_want;
648	};	892	};
649		893
650	# all those should be optimised	894	# all those should be optimised
651	sub cf::attachable::detach {	895	sub cf::attachable::detach {
652	my ($obj, $name) = @_;	896	my ($obj, $name) = @_;
…		…
655	delete $obj->{_attachment}{$name};	899	delete $obj->{_attachment}{$name};
656	reattach ($obj);	900	reattach ($obj);
657	} else {	901	} else {
658	Carp::croak "cannot, currently, detach class attachments";	902	Carp::croak "cannot, currently, detach class attachments";
659	}	903	}
		904	_recalc_want;
660	};	905	};
661		906
662	sub cf::attachable::attached {	907	sub cf::attachable::attached {
663	my ($obj, $name) = @_;	908	my ($obj, $name) = @_;
664		909
…		…
679	";	924	";
680	die if $@;	925	die if $@;
681	}	926	}
682		927
683	our $override;	928	our $override;
684	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?
685		930
686	sub override {	931	sub override {
687	$override = 1;	932	$override = 1;
688	@invoke_results = ();	933	@INVOKE_RESULTS = (@_);
689	}	934	}
690		935
691	sub do_invoke {	936	sub do_invoke {
692	my $event = shift;	937	my $event = shift;
693	my $callbacks = shift;	938	my $callbacks = shift;
694		939
695	@invoke_results = ();	940	@INVOKE_RESULTS = ();
696		941
697	local $override;	942	local $override;
698		943
699	for (@$callbacks) {	944	for (@$callbacks) {
700	eval { &{$_->[1]} };	945	eval { &{$_->[1]} };
…		…
717		962
718	Generate an object-specific event with the given arguments.	963	Generate an object-specific event with the given arguments.
719		964
720	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
721	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
722	results (if you must, access C<@cf::invoke_results> directly).	967	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
723		968
724	=back	969	=back
725		970
726	=cut	971	=cut
727		972
728	#############################################################################	973	#############################################################################
729	# 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	}
730		1017
731	sub reattach {	1018	sub reattach {
732	# basically do the same as instantiate, without calling instantiate	1019	# basically do the same as instantiate, without calling instantiate
733	my ($obj) = @_;	1020	my ($obj) = @_;
734		1021
…		…
781	sub object_freezer_save {	1068	sub object_freezer_save {
782	my ($filename, $rdata, $objs) = @_;	1069	my ($filename, $rdata, $objs) = @_;
783		1070
784	sync_job {	1071	sync_job {
785	if (length $$rdata) {	1072	if (length $$rdata) {
		1073	utf8::decode (my $decname = $filename);
786	warn sprintf "saving %s (%d,%d)\n",	1074	warn sprintf "saving %s (%d,%d)\n",
787	$filename, length $$rdata, scalar @$objs;	1075	$decname, length $$rdata, scalar @$objs;
788		1076
789	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1077	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
790	chmod SAVE_MODE, $fh;	1078	chmod SAVE_MODE, $fh;
791	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1079	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
792	aio_fsync $fh if $cf::USE_FSYNC;	1080	aio_fsync $fh if $cf::USE_FSYNC;
793	close $fh;	1081	close $fh;
794		1082
795	if (@$objs) {	1083	if (@$objs) {
796	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) {
797	chmod SAVE_MODE, $fh;	1085	chmod SAVE_MODE, $fh;
798	my $data = Storable::nfreeze { version => 1, objs => $objs };	1086	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
799	aio_write $fh, 0, (length $data), $data, 0;	1087	aio_write $fh, 0, (length $data), $data, 0;
800	aio_fsync $fh if $cf::USE_FSYNC;	1088	aio_fsync $fh if $cf::USE_FSYNC;
801	close $fh;	1089	close $fh;
802	aio_rename "$filename.pst~", "$filename.pst";	1090	aio_rename "$filename.pst~", "$filename.pst";
803	}	1091	}
…		…
811	}	1099	}
812	} else {	1100	} else {
813	aio_unlink $filename;	1101	aio_unlink $filename;
814	aio_unlink "$filename.pst";	1102	aio_unlink "$filename.pst";
815	}	1103	}
816	}	1104	};
817	}	1105	}
818		1106
819	sub object_freezer_as_string {	1107	sub object_freezer_as_string {
820	my ($rdata, $objs) = @_;	1108	my ($rdata, $objs) = @_;
821		1109
…		…
833	or return;	1121	or return;
834		1122
835	unless (aio_stat "$filename.pst") {	1123	unless (aio_stat "$filename.pst") {
836	(aio_load "$filename.pst", $av) >= 0	1124	(aio_load "$filename.pst", $av) >= 0
837	or return;	1125	or return;
		1126
838	$av = eval { (Storable::thaw $av)->{objs} };	1127	my $st = eval { Coro::Storable::thaw $av };
		1128	$av = $st->{objs};
839	}	1129	}
840		1130
		1131	utf8::decode (my $decname = $filename);
841	warn sprintf "loading %s (%d)\n",	1132	warn sprintf "loading %s (%d,%d)\n",
842	$filename, length $data, scalar @{$av || []};#d#	1133	$decname, length $data, scalar @{$av || []};
		1134
843	return ($data, $av);	1135	($data, $av)
844	}	1136	}
		1137
		1138	=head2 COMMAND CALLBACKS
		1139
		1140	=over 4
		1141
		1142	=cut
845		1143
846	#############################################################################	1144	#############################################################################
847	# command handling &c	1145	# command handling &c
848		1146
849	=item cf::register_command $name => \&callback($ob,$args);	1147	=item cf::register_command $name => \&callback($ob,$args);
…		…
862	push @{ $COMMAND{$name} }, [$caller, $cb];	1160	push @{ $COMMAND{$name} }, [$caller, $cb];
863	}	1161	}
864		1162
865	=item cf::register_extcmd $name => \&callback($pl,$packet);	1163	=item cf::register_extcmd $name => \&callback($pl,$packet);
866		1164
867	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.
868		1170
869	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
870	called.	1172	called.
871		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
872	=cut	1185	=cut
873		1186
874	sub register_extcmd {	1187	sub register_extcmd {
875	my ($name, $cb) = @_;	1188	my ($name, $cb) = @_;
876		1189
877	$EXTCMD{$name} = $cb;	1190	$EXTCMD{$name} = $cb;
		1191	}
		1192
		1193	sub register_exticmd {
		1194	my ($name, $cb) = @_;
		1195
		1196	$EXTICMD{$name} = $cb;
878	}	1197	}
879		1198
880	cf::player->attach (	1199	cf::player->attach (
881	on_command => sub {	1200	on_command => sub {
882	my ($pl, $name, $params) = @_;	1201	my ($pl, $name, $params) = @_;
…		…
891	cf::override;	1210	cf::override;
892	},	1211	},
893	on_extcmd => sub {	1212	on_extcmd => sub {
894	my ($pl, $buf) = @_;	1213	my ($pl, $buf) = @_;
895		1214
896	my $msg = eval { from_json $buf };	1215	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
897		1216
898	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
899	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1225	if (my $cb = $EXTCMD{$type}) {
900	if (my %reply = $cb->($pl, $msg)) {	1226	@reply = $cb->($pl, @payload);
901	$pl->ext_reply ($msg->{msgid}, %reply);
902	}
903	}	1227	}
		1228
		1229	$pl->ext_reply ($reply, @reply)
		1230	if $reply;
		1231
904	} else {	1232	} else {
905	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1233	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
906	}	1234	}
907		1235
908	cf::override;	1236	cf::override;
909	},	1237	},
910	);	1238	);
911		1239
912	sub load_extension {
913	my ($path) = @_;
914
915	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
916	my $base = $1;
917	my $pkg = $1;
918	$pkg =~ s/[^[:word:]]/_/g;
919	$pkg = "ext::$pkg";
920
921	warn "... loading '$path' into '$pkg'\n";
922
923	open my $fh, "<:utf8", $path
924	or die "$path: $!";
925
926	my $source =
927	"package $pkg; use strict; use utf8;\n"
928	. "#line 1 \"$path\"\n{\n"
929	. (do { local $/; <$fh> })
930	. "\n};\n1";
931
932	unless (eval $source) {
933	my $msg = $@ ? "$path: $@\n"
934	: "extension disabled.\n";
935	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
936	warn $@;
937	warn "mandatory extension failed to load, exiting.\n";
938	exit 1;
939	}
940	die $@;
941	}
942
943	push @EXTS, $pkg;
944	}
945
946	sub load_extensions {	1240	sub load_extensions {
		1241	cf::sync_job {
		1242	my %todo;
		1243
947	for my $ext (<$LIBDIR/*.ext>) {	1244	for my $path (<$LIBDIR/*.ext>) {
948	next unless -r $ext;	1245	next unless -r $path;
949	eval {	1246
950	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;
951	1	1304	}
952	} or warn "$ext not loaded: $@";	1305
		1306	skip:
		1307	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1308	unless $progress;
		1309	}
953	}	1310	};
954	}	1311	}
955		1312
956	#############################################################################	1313	#############################################################################
957		1314
		1315	=back
		1316
958	=head2 CORE EXTENSIONS	1317	=head2 CORE EXTENSIONS
959		1318
960	Functions and methods that extend core crossfire objects.	1319	Functions and methods that extend core crossfire objects.
961		1320
962	=cut	1321	=cut
…		…
966	use Coro::AIO;	1325	use Coro::AIO;
967		1326
968	=head3 cf::player	1327	=head3 cf::player
969		1328
970	=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	}
971		1344
972	=item cf::player::find $login	1345	=item cf::player::find $login
973		1346
974	Returns the given player object, loading it if necessary (might block).	1347	Returns the given player object, loading it if necessary (might block).
975		1348
…		…
1011	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";	1384	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1012	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";	1385	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1013	aio_unlink +(playerdir $login) . "/$login.pl.pst";	1386	aio_unlink +(playerdir $login) . "/$login.pl.pst";
1014	aio_unlink +(playerdir $login) . "/$login.pl";	1387	aio_unlink +(playerdir $login) . "/$login.pl";
1015		1388
1016	my $pl = load_pl path $login	1389	my $f = new_from_file cf::object::thawer path $login
1017	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;
1018	$cf::PLAYER{$login} = $pl	1396	$cf::PLAYER{$login} = $pl
1019	}	1397	}
1020	}	1398	}
1021	}	1399	}
1022		1400
…		…
1032		1410
1033	aio_mkdir playerdir $pl, 0770;	1411	aio_mkdir playerdir $pl, 0770;
1034	$pl->{last_save} = $cf::RUNTIME;	1412	$pl->{last_save} = $cf::RUNTIME;
1035		1413
1036	$pl->save_pl ($path);	1414	$pl->save_pl ($path);
1037	Coro::cede;	1415	cf::cede_to_tick;
1038	}	1416	}
1039		1417
1040	sub new($) {	1418	sub new($) {
1041	my ($login) = @_;	1419	my ($login) = @_;
1042		1420
…		…
1046	$self->{deny_save} = 1;	1424	$self->{deny_save} = 1;
1047		1425
1048	$cf::PLAYER{$login} = $self;	1426	$cf::PLAYER{$login} = $self;
1049		1427
1050	$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 (@_);
1051	}	1439	}
1052		1440
1053	=item $pl->quit_character	1441	=item $pl->quit_character
1054		1442
1055	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
…		…
1110	or return [];	1498	or return [];
1111		1499
1112	my @logins;	1500	my @logins;
1113		1501
1114	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") {
1115	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1507	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1116	aio_read $fh, 0, 512, my $buf, 0 or next;	1508	aio_read $fh, 0, 512, my $buf, 0 or next;
1117	$buf !~ /^password -------------$/m or next; # official not-valid tag	1509	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1510	}
1118		1511
1119	utf8::decode $login;	1512	utf8::decode $login;
1120	push @logins, $login;	1513	push @logins, $login;
1121	}	1514	}
1122		1515
…		…
1149	}	1542	}
1150		1543
1151	\@paths	1544	\@paths
1152	}	1545	}
1153		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
1154	=item $player->ext_reply ($msgid, %msg)	1598	=item $player->ext_reply ($msgid, @msg)
1155		1599
1156	Sends an ext reply to the player.	1600	Sends an ext reply to the player.
1157		1601
1158	=cut	1602	=cut
1159		1603
1160	sub ext_reply($$%) {	1604	sub ext_reply($$@) {
1161	my ($self, $id, %msg) = @_;	1605	my ($self, $id, @msg) = @_;
1162		1606
1163	$msg{msgid} = $id;	1607	$self->ns->ext_reply ($id, @msg)
1164
1165	$self->send ("ext " . cf::to_json \%msg);
1166	}	1608	}
1167		1609
1168	=item $player->ext_event ($type, %msg)	1610	=item $player->ext_msg ($type, @msg)
1169		1611
1170	Sends an ext event to the client.	1612	Sends an ext event to the client.
1171		1613
1172	=cut	1614	=cut
1173		1615
1174	sub ext_event($$%) {	1616	sub ext_msg($$@) {
1175	my ($self, $type, %msg) = @_;	1617	my ($self, $type, @msg) = @_;
1176		1618
1177	$self->ns->ext_event ($type, %msg);	1619	$self->ns->ext_msg ($type, @msg);
1178	}	1620	}
1179		1621
1180	=head3 cf::region	1622	=head3 cf::region
1181		1623
1182	=over 4	1624	=over 4
…		…
1185		1627
1186	package cf::region;	1628	package cf::region;
1187		1629
1188	=item cf::region::find_by_path $path	1630	=item cf::region::find_by_path $path
1189		1631
1190	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.
1191		1633
1192	=cut	1634	=cut
1193		1635
1194	sub find_by_path($) {	1636	sub find_by_path($) {
1195	my ($path) = @_;	1637	my ($path) = @_;
1196		1638
1197	my ($match, $specificity);	1639	my ($match, $specificity);
1198		1640
1199	for my $region (list) {	1641	for my $region (list) {
1200	if ($region->match && $path =~ $region->match) {	1642	if ($region->{match} && $path =~ $region->{match}) {
1201	($match, $specificity) = ($region, $region->specificity)	1643	($match, $specificity) = ($region, $region->specificity)
1202	if $region->specificity > $specificity;	1644	if $region->specificity > $specificity;
1203	}	1645	}
1204	}	1646	}
1205		1647
…		…
1269	my ($self, $merge) = @_;	1711	my ($self, $merge) = @_;
1270		1712
1271	# we have to keep some variables in memory intact	1713	# we have to keep some variables in memory intact
1272	local $self->{path};	1714	local $self->{path};
1273	local $self->{load_path};	1715	local $self->{load_path};
1274	local $self->{deny_save};
1275	local $self->{deny_reset};
1276		1716
1277	$self->SUPER::thawer_merge ($merge);	1717	$self->SUPER::thawer_merge ($merge);
1278	}	1718	}
1279		1719
1280	sub normalise {	1720	sub normalise {
…		…
1327	$self->init; # pass $1 etc.	1767	$self->init; # pass $1 etc.
1328	return $self;	1768	return $self;
1329	}	1769	}
1330	}	1770	}
1331		1771
1332	Carp::carp "unable to resolve path '$path' (base '$base').";	1772	Carp::cluck "unable to resolve path '$path' (base '$base').";
1333	()	1773	()
1334	}	1774	}
1335		1775
1336	sub init {	1776	sub init {
1337	my ($self) = @_;	1777	my ($self) = @_;
…		…
1380		1820
1381	$_->change_map_light ($change)	1821	$_->change_map_light ($change)
1382	for grep $_->outdoor, values %cf::MAP;	1822	for grep $_->outdoor, values %cf::MAP;
1383	}	1823	}
1384		1824
		1825	sub decay_objects {
		1826	my ($self) = @_;
		1827
		1828	return if $self->{deny_reset};
		1829
		1830	$self->do_decay_objects;
		1831	}
		1832
1385	sub unlink_save {	1833	sub unlink_save {
1386	my ($self) = @_;	1834	my ($self) = @_;
1387		1835
1388	utf8::encode (my $save = $self->save_path);	1836	utf8::encode (my $save = $self->save_path);
1389	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1837	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
…		…
1392		1840
1393	sub load_header_from($) {	1841	sub load_header_from($) {
1394	my ($self, $path) = @_;	1842	my ($self, $path) = @_;
1395		1843
1396	utf8::encode $path;	1844	utf8::encode $path;
1397	#aio_open $path, O_RDONLY, 0	1845	my $f = new_from_file cf::object::thawer $path
1398	# or return;
1399
1400	$self->_load_header ($path)
1401	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;
1402		1853
1403	$self->{load_path} = $path;	1854	$self->{load_path} = $path;
1404		1855
1405	1	1856	1
1406	}	1857	}
…		…
1445	$self->load_header_orig	1896	$self->load_header_orig
1446	or return;	1897	or return;
1447	$self->prepare_orig;	1898	$self->prepare_orig;
1448	}	1899	}
1449		1900
		1901	$self->{deny_reset} = 1
		1902	if $self->no_reset;
		1903
1450	$self->default_region (cf::region::find_by_path $self->{path})	1904	$self->default_region (cf::region::find_by_path $self->{path})
1451	unless $self->default_region;	1905	unless $self->default_region;
1452		1906
1453	1	1907	1
1454	}	1908	}
…		…
1457	sub find {	1911	sub find {
1458	my ($path, $origin) = @_;	1912	my ($path, $origin) = @_;
1459		1913
1460	$path = normalise $path, $origin && $origin->path;	1914	$path = normalise $path, $origin && $origin->path;
1461		1915
		1916	cf::lock_wait "map_data:$path";#d#remove
1462	cf::lock_wait "map_find:$path";	1917	cf::lock_wait "map_find:$path";
1463		1918
1464	$cf::MAP{$path} || do {	1919	$cf::MAP{$path} || do {
1465	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
1466	my $map = new_from_path cf::map $path	1923	my $map = new_from_path cf::map $path
1467	or return;	1924	or return;
1468		1925
1469	$map->{last_save} = $cf::RUNTIME;	1926	$map->{last_save} = $cf::RUNTIME;
1470		1927
1471	$map->load_header	1928	$map->load_header
1472	or return;	1929	or return;
1473		1930
1474	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1931	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1475	# doing this can freeze the server in a sync job, obviously	1932	# doing this can freeze the server in a sync job, obviously
1476	#$cf::WAIT_FOR_TICK->wait;	1933	#$cf::WAIT_FOR_TICK->wait;
		1934	undef $guard1;
		1935	undef $guard2;
1477	$map->reset;	1936	$map->reset;
1478	undef $guard;
1479	return find $path;	1937	return find $path;
1480	}	1938	}
1481		1939
1482	$cf::MAP{$path} = $map	1940	$cf::MAP{$path} = $map
1483	}	1941	}
…		…
1490	my ($self) = @_;	1948	my ($self) = @_;
1491		1949
1492	local $self->{deny_reset} = 1; # loading can take a long time	1950	local $self->{deny_reset} = 1; # loading can take a long time
1493		1951
1494	my $path = $self->{path};	1952	my $path = $self->{path};
		1953
		1954	{
1495	my $guard = cf::lock_acquire "map_load:$path";	1955	my $guard = cf::lock_acquire "map_data:$path";
1496		1956
		1957	return unless $self->valid;
1497	return if $self->in_memory != cf::MAP_SWAPPED;	1958	return unless $self->in_memory == cf::MAP_SWAPPED;
1498		1959
1499	$self->in_memory (cf::MAP_LOADING);	1960	$self->in_memory (cf::MAP_LOADING);
1500		1961
1501	$self->alloc;	1962	$self->alloc;
1502		1963
1503	$self->pre_load;	1964	$self->pre_load;
1504	Coro::cede;	1965	cf::cede_to_tick;
1505		1966
1506	$self->_load_objects ($self->{load_path}, 1)	1967	my $f = new_from_file cf::object::thawer $self->{load_path};
		1968	$f->skip_block;
		1969	$self->_load_objects ($f)
1507	or return;	1970	or return;
1508		1971
1509	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1972	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1510	if delete $self->{load_original};	1973	if delete $self->{load_original};
1511		1974
1512	if (my $uniq = $self->uniq_path) {	1975	if (my $uniq = $self->uniq_path) {
1513	utf8::encode $uniq;	1976	utf8::encode $uniq;
1514	if (aio_open $uniq, O_RDONLY, 0) {	1977	unless (aio_stat $uniq) {
		1978	if (my $f = new_from_file cf::object::thawer $uniq) {
1515	$self->clear_unique_items;	1979	$self->clear_unique_items;
1516	$self->_load_objects ($uniq, 0);	1980	$self->_load_objects ($f);
		1981	$f->resolve_delayed_derefs;
		1982	}
1517	}	1983	}
1518	}	1984	}
1519		1985
1520	Coro::cede;	1986	$f->resolve_delayed_derefs;
		1987
		1988	cf::cede_to_tick;
1521	# now do the right thing for maps	1989	# now do the right thing for maps
1522	$self->link_multipart_objects;	1990	$self->link_multipart_objects;
1523	Coro::cede;
1524
1525	unless ($self->{deny_activate}) {
1526	$self->decay_objects;
1527	$self->fix_auto_apply;
1528	$self->update_buttons;
1529	Coro::cede;
1530	$self->set_darkness_map;
1531	$self->difficulty ($self->estimate_difficulty)	1991	$self->difficulty ($self->estimate_difficulty)
1532	unless $self->difficulty;	1992	unless $self->difficulty;
1533	Coro::cede;	1993	cf::cede_to_tick;
		1994
		1995	unless ($self->{deny_activate}) {
		1996	$self->decay_objects;
		1997	$self->fix_auto_apply;
		1998	$self->update_buttons;
		1999	cf::cede_to_tick;
		2000	$self->set_darkness_map;
		2001	cf::cede_to_tick;
1534	$self->activate;	2002	$self->activate;
1535	Coro::cede;	2003	}
		2004
		2005	$self->{last_save} = $cf::RUNTIME;
		2006	$self->last_access ($cf::RUNTIME);
		2007
		2008	$self->in_memory (cf::MAP_IN_MEMORY);
1536	}	2009	}
1537		2010
1538	$self->post_load;	2011	$self->post_load;
1539	Coro::cede;
1540
1541	$self->in_memory (cf::MAP_IN_MEMORY);
1542	}	2012	}
1543		2013
1544	sub customise_for {	2014	sub customise_for {
1545	my ($self, $ob) = @_;	2015	my ($self, $ob) = @_;
1546		2016
1547	return find "~" . $ob->name . "/" . $self->{path}	2017	return find "~" . $ob->name . "/" . $self->{path}
1548	if $self->per_player;	2018	if $self->per_player;
1549		2019
		2020	# return find "?party/" . $ob->name . "/" . $self->{path}
		2021	# if $self->per_party;
		2022
1550	$self	2023	$self
1551	}	2024	}
1552		2025
1553	# 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
1554	sub load_diag {	2027	sub load_neighbours {
1555	my ($map) = @_;	2028	my ($map) = @_;
1556		2029
1557	my @diag; # diagonal neighbours	2030	my @neigh; # diagonal neighbours
1558		2031
1559	for (0 .. 3) {	2032	for (0 .. 3) {
1560	my $neigh = $map->tile_path ($_)	2033	my $neigh = $map->tile_path ($_)
1561	or next;	2034	or next;
1562	$neigh = find $neigh, $map	2035	$neigh = find $neigh, $map
1563	or next;	2036	or next;
1564	$neigh->load;	2037	$neigh->load;
1565		2038
		2039	push @neigh,
1566	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2040	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1567	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2041	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1568	}	2042	}
1569		2043
1570	for (@diag) {	2044	for (grep defined $_->[0], @neigh) {
		2045	my ($path, $origin) = @$_;
1571	my $neigh = find @$_	2046	my $neigh = find $path, $origin
1572	or next;	2047	or next;
1573	$neigh->load;	2048	$neigh->load;
1574	}	2049	}
1575	}	2050	}
1576		2051
…		…
1581	}	2056	}
1582		2057
1583	sub do_load_sync {	2058	sub do_load_sync {
1584	my ($map) = @_;	2059	my ($map) = @_;
1585		2060
		2061	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2062	if $Coro::current == $Coro::main;
		2063
1586	cf::sync_job { $map->load };	2064	cf::sync_job { $map->load };
1587	}	2065	}
1588		2066
1589	our %MAP_PREFETCH;	2067	our %MAP_PREFETCH;
1590	our $MAP_PREFETCHER = undef;	2068	our $MAP_PREFETCHER = undef;
1591		2069
1592	sub find_async {	2070	sub find_async {
1593	my ($path, $origin) = @_;	2071	my ($path, $origin, $load) = @_;
1594		2072
1595	$path = normalise $path, $origin && $origin->{path};	2073	$path = normalise $path, $origin && $origin->{path};
1596		2074
1597	if (my $map = $cf::MAP{$path}) {	2075	if (my $map = $cf::MAP{$path}) {
1598	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2076	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1599	}	2077	}
1600		2078
1601	undef $MAP_PREFETCH{$path};	2079	$MAP_PREFETCH{$path} |= $load;
		2080
1602	$MAP_PREFETCHER ||= cf::async {	2081	$MAP_PREFETCHER ||= cf::async {
		2082	$Coro::current->{desc} = "map prefetcher";
		2083
1603	while (%MAP_PREFETCH) {	2084	while (%MAP_PREFETCH) {
1604	for my $path (keys %MAP_PREFETCH) {	2085	while (my ($k, $v) = each %MAP_PREFETCH) {
1605	my $map = find $path	2086	if (my $map = find $k) {
1606	or next;
1607	$map->load;	2087	$map->load if $v;
		2088	}
1608		2089
1609	delete $MAP_PREFETCH{$path};	2090	delete $MAP_PREFETCH{$k};
1610	}	2091	}
1611	}	2092	}
1612	undef $MAP_PREFETCHER;	2093	undef $MAP_PREFETCHER;
1613	};	2094	};
1614	$MAP_PREFETCHER->prio (6);	2095	$MAP_PREFETCHER->prio (6);
…		…
1617	}	2098	}
1618		2099
1619	sub save {	2100	sub save {
1620	my ($self) = @_;	2101	my ($self) = @_;
1621		2102
1622	my $lock = cf::lock_acquire "map_data:" . $self->path;	2103	my $lock = cf::lock_acquire "map_data:$self->{path}";
1623		2104
1624	$self->{last_save} = $cf::RUNTIME;	2105	$self->{last_save} = $cf::RUNTIME;
1625		2106
1626	return unless $self->dirty;	2107	return unless $self->dirty;
1627		2108
…		…
1633	return if $self->{deny_save};	2114	return if $self->{deny_save};
1634		2115
1635	local $self->{last_access} = $self->last_access;#d#	2116	local $self->{last_access} = $self->last_access;#d#
1636		2117
1637	cf::async {	2118	cf::async {
		2119	$Coro::current->{desc} = "map player save";
1638	$_->contr->save for $self->players;	2120	$_->contr->save for $self->players;
1639	};	2121	};
1640		2122
1641	if ($uniq) {	2123	if ($uniq) {
1642	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2124	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
…		…
1650	my ($self) = @_;	2132	my ($self) = @_;
1651		2133
1652	# save first because save cedes	2134	# save first because save cedes
1653	$self->save;	2135	$self->save;
1654		2136
1655	my $lock = cf::lock_acquire "map_data:" . $self->path;	2137	my $lock = cf::lock_acquire "map_data:$self->{path}";
1656		2138
1657	return if $self->players;	2139	return if $self->players;
1658	return if $self->in_memory != cf::MAP_IN_MEMORY;	2140	return if $self->in_memory != cf::MAP_IN_MEMORY;
1659	return if $self->{deny_save};	2141	return if $self->{deny_save};
1660		2142
		2143	$self->in_memory (cf::MAP_SWAPPED);
		2144
		2145	$self->deactivate;
		2146	$_->clear_links_to ($self) for values %cf::MAP;
1661	$self->clear;	2147	$self->clear;
1662	$self->in_memory (cf::MAP_SWAPPED);
1663	}	2148	}
1664		2149
1665	sub reset_at {	2150	sub reset_at {
1666	my ($self) = @_;	2151	my ($self) = @_;
1667		2152
1668	# TODO: safety, remove and allow resettable per-player maps	2153	# TODO: safety, remove and allow resettable per-player maps
1669	return 1e99 if $self->isa ("ext::map_per_player");#d#
1670	return 1e99 if $self->{deny_reset};	2154	return 1e99 if $self->{deny_reset};
1671		2155
1672	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2156	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1673	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;
1674		2158
…		…
1685	my ($self) = @_;	2169	my ($self) = @_;
1686		2170
1687	my $lock = cf::lock_acquire "map_data:$self->{path}";	2171	my $lock = cf::lock_acquire "map_data:$self->{path}";
1688		2172
1689	return if $self->players;	2173	return if $self->players;
1690	return if $self->isa ("ext::map_per_player");#d#
1691		2174
1692	warn "resetting map ", $self->path;#d#	2175	warn "resetting map ", $self->path;
1693		2176
1694	$self->in_memory (cf::MAP_SWAPPED);	2177	$self->in_memory (cf::MAP_SWAPPED);
1695		2178
1696	# need to save uniques path	2179	# need to save uniques path
1697	unless ($self->{deny_save}) {	2180	unless ($self->{deny_save}) {
…		…
1701	if $uniq;	2184	if $uniq;
1702	}	2185	}
1703		2186
1704	delete $cf::MAP{$self->path};	2187	delete $cf::MAP{$self->path};
1705		2188
		2189	$self->deactivate;
		2190	$_->clear_links_to ($self) for values %cf::MAP;
1706	$self->clear;	2191	$self->clear;
1707
1708	$_->clear_links_to ($self) for values %cf::MAP;
1709		2192
1710	$self->unlink_save;	2193	$self->unlink_save;
1711	$self->destroy;	2194	$self->destroy;
1712	}	2195	}
1713		2196
1714	my $nuke_counter = "aaaa";	2197	my $nuke_counter = "aaaa";
1715		2198
1716	sub nuke {	2199	sub nuke {
1717	my ($self) = @_;	2200	my ($self) = @_;
1718		2201
		2202	{
		2203	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2204
1719	delete $cf::MAP{$self->path};	2205	delete $cf::MAP{$self->path};
1720		2206
1721	$self->unlink_save;	2207	$self->unlink_save;
1722		2208
1723	bless $self, "cf::map";	2209	bless $self, "cf::map";
1724	delete $self->{deny_reset};	2210	delete $self->{deny_reset};
1725	$self->{deny_save} = 1;	2211	$self->{deny_save} = 1;
1726	$self->reset_timeout (1);	2212	$self->reset_timeout (1);
1727	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2213	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1728		2214
1729	$cf::MAP{$self->path} = $self;	2215	$cf::MAP{$self->path} = $self;
		2216	}
1730		2217
1731	$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	]
1732	}	2255	}
1733		2256
1734	=item cf::map::unique_maps	2257	=item cf::map::unique_maps
1735		2258
1736	Returns an arrayref of paths of all shared maps that have	2259	Returns an arrayref of paths of all shared maps that have
1737	instantiated unique items. May block.	2260	instantiated unique items. May block.
1738		2261
1739	=cut	2262	=cut
1740		2263
1741	sub unique_maps() {	2264	sub unique_maps() {
1742	my $files = aio_readdir $UNIQUEDIR	2265	[
1743	or return;	2266	map {
1744
1745	my @paths;
1746
1747	for (@$files) {
1748	utf8::decode $_;	2267	utf8::decode $_;
1749	next if /\.pst$/;	2268	/\.map$/
1750	next unless /^$PATH_SEP/o;	2269	? normalise $_
1751		2270	: ()
1752	push @paths, cf::map::normalise $_;	2271	} @{ aio_readdir $UNIQUEDIR or [] }
1753	}	2272	]
1754
1755	\@paths
1756	}	2273	}
1757		2274
1758	package cf;	2275	package cf;
1759		2276
1760	=back	2277	=back
…		…
1778	map { $_, inv_recursive_ $_->inv } @_	2295	map { $_, inv_recursive_ $_->inv } @_
1779	}	2296	}
1780		2297
1781	sub inv_recursive {	2298	sub inv_recursive {
1782	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	}
1783	}	2328	}
1784		2329
1785	package cf;	2330	package cf;
1786		2331
1787	=back	2332	=back
…		…
1806		2351
1807	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2352	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1808		2353
1809	if ($self->{record_replies}) {	2354	if ($self->{record_replies}) {
1810	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2355	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2356
1811	} 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 {
1812	$msg = $npc->name . " says: $msg" if $npc;	2365	$msg = $npc->name . " says: $msg" if $npc;
1813	$self->message ($msg, $flags);	2366	$self->message ($msg, $flags);
		2367	}
1814	}	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 (@_);
1815	}	2379	}
1816		2380
1817	=item $player_object->may ("access")	2381	=item $player_object->may ("access")
1818		2382
1819	Returns wether the given player is authorized to access resource "access"	2383	Returns wether the given player is authorized to access resource "access"
…		…
1866	$self->deactivate_recursive;	2430	$self->deactivate_recursive;
1867		2431
1868	return if UNIVERSAL::isa $self->map, "ext::map_link";	2432	return if UNIVERSAL::isa $self->map, "ext::map_link";
1869		2433
1870	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2434	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1871	if $self->map;	2435	if $self->map && $self->map->{path} ne "{link}";
1872		2436
1873	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2437	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1874	}	2438	}
1875		2439
1876	sub cf::object::player::leave_link {	2440	sub cf::object::player::leave_link {
1877	my ($self, $map, $x, $y) = @_;	2441	my ($self, $map, $x, $y) = @_;
		2442
		2443	return unless $self->contr->active;
1878		2444
1879	my $link_pos = delete $self->{_link_pos};	2445	my $link_pos = delete $self->{_link_pos};
1880		2446
1881	unless ($map) {	2447	unless ($map) {
1882	# restore original map position	2448	# restore original map position
…		…
1896	# use -1 or undef as default coordinates, not 0, 0	2462	# use -1 or undef as default coordinates, not 0, 0
1897	($x, $y) = ($map->enter_x, $map->enter_y)	2463	($x, $y) = ($map->enter_x, $map->enter_y)
1898	if $x <=0 && $y <= 0;	2464	if $x <=0 && $y <= 0;
1899		2465
1900	$map->load;	2466	$map->load;
1901	$map->load_diag;	2467	$map->load_neighbours;
1902		2468
1903	return unless $self->contr->active;	2469	return unless $self->contr->active;
1904	$self->activate_recursive;	2470	$self->activate_recursive;
1905		2471
1906	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2472	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1907	$self->enter_map ($map, $x, $y);	2473	$self->enter_map ($map, $x, $y);
1908	}	2474	}
1909		2475
1910	cf::player->attach (	2476	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1911	on_logout => sub {
1912	my ($pl) = @_;
1913		2477
1914	# abort map switching before logout	2478	Moves the player to the given map-path and coordinates by first freezing
1915	if ($pl->ob->{_link_pos}) {	2479	her, loading and preparing them map, calling the provided $check callback
1916	cf::sync_job {	2480	that has to return the map if sucecssful, and then unfreezes the player on
1917	$pl->ob->leave_link	2481	the new (success) or old (failed) map position. In either case, $done will
1918	};	2482	be called at the end of this process.
1919	}
1920	},
1921	on_login => sub {
1922	my ($pl) = @_;
1923		2483
1924	# try to abort aborted map switching on player login :)
1925	# should happen only on crashes
1926	if ($pl->ob->{_link_pos}) {
1927	$pl->ob->enter_link;
1928	(async {
1929	$pl->ob->reply (undef,
1930	"There was an internal problem at your last logout, "
1931	. "the server will try to bring you to your intended destination in a second.",
1932	cf::NDI_RED);
1933	# we need this sleep as the login has a concurrent enter_exit running
1934	# and this sleep increases chances of the player not ending up in scorn
1935	Coro::Timer::sleep 1;
1936	$pl->ob->leave_link;
1937	})->prio (2);
1938	}
1939	},
1940	);
1941
1942	=item $player_object->goto ($path, $x, $y)
1943
1944	=cut	2484	=cut
		2485
		2486	our $GOTOGEN;
1945		2487
1946	sub cf::object::player::goto {	2488	sub cf::object::player::goto {
1947	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;
1948		2493
1949	$self->enter_link;	2494	$self->enter_link;
1950		2495
1951	(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
1952	my $map = eval {	2518	my $map = eval {
1953	my $map = cf::map::find $path;	2519	my $map = defined $path ? cf::map::find $path : undef;
		2520
		2521	if ($map) {
1954	$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
1955	$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 $@;
1956	} or	2534	}
1957	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1958		2535
		2536	if ($gen == $self->{_goto_generation}) {
		2537	delete $self->{_goto_generation};
1959	$self->leave_link ($map, $x, $y);	2538	$self->leave_link ($map, $x, $y);
		2539	}
		2540
		2541	$done->() if $done;
1960	})->prio (1);	2542	})->prio (1);
1961	}	2543	}
1962		2544
1963	=item $player_object->enter_exit ($exit_object)	2545	=item $player_object->enter_exit ($exit_object)
1964		2546
…		…
2033	my $hp = $exit->stats->hp;	2615	my $hp = $exit->stats->hp;
2034	my $sp = $exit->stats->sp;	2616	my $sp = $exit->stats->sp;
2035		2617
2036	$self->enter_link;	2618	$self->enter_link;
2037		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
2038	(async {	2624	(async {
		2625	$Coro::current->{desc} = "enter_exit $slaying $hp $sp";
		2626
2039	$self->deactivate_recursive; # just to be sure	2627	$self->deactivate_recursive; # just to be sure
2040	unless (eval {	2628	unless (eval {
2041	$self->goto ($slaying, $hp, $sp);	2629	$self->goto ($slaying, $hp, $sp);
2042		2630
2043	1;	2631	1;
…		…
2069		2657
2070	utf8::encode $text;	2658	utf8::encode $text;
2071	$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);
2072	}	2660	}
2073		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/book" => {
		2685	id => "infobox",
		2686	title => "Book",
		2687	reply => undef,
		2688	tooltip => "The contents of a note or book",
		2689	},
		2690	"c/lookat" => {
		2691	id => "infobox",
		2692	title => "Look",
		2693	reply => undef,
		2694	tooltip => "What you saw there",
		2695	},
		2696	);
		2697
		2698	sub cf::client::send_msg {
		2699	my ($self, $channel, $msg, $color, @extra) = @_;
		2700
		2701	$msg = $self->pl->expand_cfpod ($msg);
		2702
		2703	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2704
		2705	# check predefined channels, for the benefit of C
		2706	if ($CHANNEL{$channel}) {
		2707	$channel = $CHANNEL{$channel};
		2708
		2709	$self->ext_msg (channel_info => $channel)
		2710	if $self->can_msg;
		2711
		2712	$channel = $channel->{id};
		2713
		2714	} elsif (ref $channel) {
		2715	# send meta info to client, if not yet sent
		2716	unless (exists $self->{channel}{$channel->{id}}) {
		2717	$self->{channel}{$channel->{id}} = $channel;
		2718	$self->ext_msg (channel_info => $channel)
		2719	if $self->can_msg;
		2720	}
		2721
		2722	$channel = $channel->{id};
		2723	}
		2724
		2725	return unless @extra || length $msg;
		2726
		2727	if ($self->can_msg) {
		2728	# default colour, mask it out
		2729	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2730	if $color & cf::NDI_DEF;
		2731
		2732	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2733	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2734	} else {
		2735	if ($color >= 0) {
		2736	# replace some tags by gcfclient-compatible ones
		2737	for ($msg) {
		2738	1 while
		2739	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2740	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2741	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2742	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2743	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2744	}
		2745
		2746	$color &= cf::NDI_COLOR_MASK;
		2747
		2748	utf8::encode $msg;
		2749
		2750	if (0 && $msg =~ /\[/) {
		2751	# COMMAND/INFO
		2752	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2753	} else {
		2754	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2755	$self->send_packet ("drawinfo $color $msg")
		2756	}
		2757	}
		2758	}
		2759	}
		2760
2074	=item $client->ext_event ($type, %msg)	2761	=item $client->ext_msg ($type, @msg)
2075		2762
2076	Sends an exti event to the client.	2763	Sends an ext event to the client.
2077		2764
2078	=cut	2765	=cut
2079		2766
2080	sub cf::client::ext_event($$%) {	2767	sub cf::client::ext_msg($$@) {
2081	my ($self, $type, %msg) = @_;	2768	my ($self, $type, @msg) = @_;
2082		2769
		2770	if ($self->extcmd == 2) {
		2771	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2772	} elsif ($self->extcmd == 1) { # TODO: remove
2083	$msg{msgtype} = "event_$type";	2773	push @msg, msgtype => "event_$type";
2084	$self->send_packet ("ext " . cf::to_json \%msg);	2774	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2775	}
		2776	}
		2777
		2778	=item $client->ext_reply ($msgid, @msg)
		2779
		2780	Sends an ext reply to the client.
		2781
		2782	=cut
		2783
		2784	sub cf::client::ext_reply($$@) {
		2785	my ($self, $id, @msg) = @_;
		2786
		2787	if ($self->extcmd == 2) {
		2788	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2789	} elsif ($self->extcmd == 1) {
		2790	#TODO: version 1, remove
		2791	unshift @msg, msgtype => "reply", msgid => $id;
		2792	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2793	}
2085	}	2794	}
2086		2795
2087	=item $success = $client->query ($flags, "text", \&cb)	2796	=item $success = $client->query ($flags, "text", \&cb)
2088		2797
2089	Queues a query to the client, calling the given callback with	2798	Queues a query to the client, calling the given callback with
2090	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2799	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2091	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2800	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2092		2801
2093	Queries can fail, so check the return code. Or don't, as queries will become	2802	Queries can fail, so check the return code. Or don't, as queries will
2094	reliable at some point in the future.	2803	become reliable at some point in the future.
2095		2804
2096	=cut	2805	=cut
2097		2806
2098	sub cf::client::query {	2807	sub cf::client::query {
2099	my ($self, $flags, $text, $cb) = @_;	2808	my ($self, $flags, $text, $cb) = @_;
…		…
2107	utf8::encode $text;	2816	utf8::encode $text;
2108	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2817	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2109		2818
2110	$self->send_packet ($self->{query_queue}[0][0])	2819	$self->send_packet ($self->{query_queue}[0][0])
2111	if @{ $self->{query_queue} } == 1;	2820	if @{ $self->{query_queue} } == 1;
		2821
		2822	1
2112	}	2823	}
2113		2824
2114	cf::client->attach (	2825	cf::client->attach (
		2826	on_connect => sub {
		2827	my ($ns) = @_;
		2828
		2829	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2830	},
2115	on_reply => sub {	2831	on_reply => sub {
2116	my ($ns, $msg) = @_;	2832	my ($ns, $msg) = @_;
2117		2833
2118	# this weird shuffling is so that direct followup queries	2834	# this weird shuffling is so that direct followup queries
2119	# get handled first	2835	# get handled first
…		…
2131	} else {	2847	} else {
2132	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2848	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2133	}	2849	}
2134	}	2850	}
2135	},	2851	},
		2852	on_exticmd => sub {
		2853	my ($ns, $buf) = @_;
		2854
		2855	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2856
		2857	if (ref $msg) {
		2858	my ($type, $reply, @payload) =
		2859	"ARRAY" eq ref $msg
		2860	? @$msg
		2861	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2862
		2863	my @reply;
		2864
		2865	if (my $cb = $EXTICMD{$type}) {
		2866	@reply = $cb->($ns, @payload);
		2867	}
		2868
		2869	$ns->ext_reply ($reply, @reply)
		2870	if $reply;
		2871
		2872	} else {
		2873	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2874	}
		2875
		2876	cf::override;
		2877	},
2136	);	2878	);
2137		2879
2138	=item $client->async (\&cb)	2880	=item $client->async (\&cb)
2139		2881
2140	Create a new coroutine, running the specified callback. The coroutine will	2882	Create a new coroutine, running the specified callback. The coroutine will
…		…
2181	our $safe = new Safe "safe";	2923	our $safe = new Safe "safe";
2182	our $safe_hole = new Safe::Hole;	2924	our $safe_hole = new Safe::Hole;
2183		2925
2184	$SIG{FPE} = 'IGNORE';	2926	$SIG{FPE} = 'IGNORE';
2185		2927
2186	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2928	$safe->permit_only (Opcode::opset qw(
		2929	:base_core :base_mem :base_orig :base_math
		2930	grepstart grepwhile mapstart mapwhile
		2931	sort time
		2932	));
2187		2933
2188	# here we export the classes and methods available to script code	2934	# here we export the classes and methods available to script code
2189		2935
2190	=pod	2936	=pod
2191		2937
2192	The following functions and methods are available within a safe environment:	2938	The following functions and methods are available within a safe environment:
2193		2939
2194	cf::object contr pay_amount pay_player map	2940	cf::object
		2941	contr pay_amount pay_player map x y force_find force_add destroy
		2942	insert remove name archname title slaying race decrease_ob_nr
		2943
2195	cf::object::player player	2944	cf::object::player
2196	cf::player peaceful	2945	player
2197	cf::map trigger	2946
		2947	cf::player
		2948	peaceful
		2949
		2950	cf::map
		2951	trigger
2198		2952
2199	=cut	2953	=cut
2200		2954
2201	for (	2955	for (
2202	["cf::object" => qw(contr pay_amount pay_player map)],	2956	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2957	insert remove inv name archname title slaying race
		2958	decrease_ob_nr destroy)],
2203	["cf::object::player" => qw(player)],	2959	["cf::object::player" => qw(player)],
2204	["cf::player" => qw(peaceful)],	2960	["cf::player" => qw(peaceful)],
2205	["cf::map" => qw(trigger)],	2961	["cf::map" => qw(trigger)],
2206	) {	2962	) {
2207	no strict 'refs';	2963	no strict 'refs';
…		…
2278	=back	3034	=back
2279		3035
2280	=cut	3036	=cut
2281		3037
2282	#############################################################################	3038	#############################################################################
2283
2284	=head2 EXTENSION DATABASE SUPPORT
2285
2286	Crossfire maintains a very simple database for extension use. It can
2287	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2288	convert to/from binary).
2289
2290	The parameter C<$family> should best start with the name of the extension
2291	using it, it should be unique.
2292
2293	=over 4
2294
2295	=item $value = cf::db_get $family => $key
2296
2297	Returns a single value from the database.
2298
2299	=item cf::db_put $family => $key => $value
2300
2301	Stores the given C<$value> in the family.
2302
2303	=cut
2304
2305	our $DB;
2306
2307	sub db_init {
2308	unless ($DB) {
2309	$DB = BDB::db_create $DB_ENV;
2310
2311	cf::sync_job {
2312	eval {
2313	$DB->set_flags (BDB::CHKSUM);
2314
2315	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2316	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2317	cf::cleanup "db_open(db): $!" if $!;
2318	};
2319	cf::cleanup "db_open(db): $@" if $@;
2320	};
2321	}
2322	}
2323
2324	sub db_get($$) {
2325	my $key = "$_[0]/$_[1]";
2326
2327	cf::sync_job {
2328	BDB::db_get $DB, undef, $key, my $data;
2329
2330	$! ? ()
2331	: $data
2332	}
2333	}
2334
2335	sub db_put($$$) {
2336	BDB::dbreq_pri 4;
2337	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2338	}
2339
2340	=item cf::cache $id => [$paths...], $processversion => $process
2341
2342	Generic caching function that returns the value of the resource $id,
2343	caching and regenerating as required.
2344
2345	This function can block.
2346
2347	=cut
2348
2349	sub cache {
2350	my ($id, $src, $processversion, $process) = @_;
2351
2352	my $meta =
2353	join "\x00",
2354	$processversion,
2355	map {
2356	aio_stat $_
2357	and Carp::croak "$_: $!";
2358
2359	($_, (stat _)[7,9])
2360	} @$src;
2361
2362	my $dbmeta = db_get cache => "$id/meta";
2363	if ($dbmeta ne $meta) {
2364	# changed, we may need to process
2365
2366	my @data;
2367	my $md5;
2368
2369	for (0 .. $#$src) {
2370	0 <= aio_load $src->[$_], $data[$_]
2371	or Carp::croak "$src->[$_]: $!";
2372	}
2373
2374	# if processing is expensive, check
2375	# checksum first
2376	if (1) {
2377	$md5 =
2378	join "\x00",
2379	$processversion,
2380	map {
2381	Coro::cede;
2382	($src->[$_], Digest::MD5::md5_hex $data[$_])
2383	} 0.. $#$src;
2384
2385
2386	my $dbmd5 = db_get cache => "$id/md5";
2387	if ($dbmd5 eq $md5) {
2388	db_put cache => "$id/meta", $meta;
2389
2390	return db_get cache => "$id/data";
2391	}
2392	}
2393
2394	my $t1 = Time::HiRes::time;
2395	my $data = $process->(\@data);
2396	my $t2 = Time::HiRes::time;
2397
2398	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2399
2400	db_put cache => "$id/data", $data;
2401	db_put cache => "$id/md5" , $md5;
2402	db_put cache => "$id/meta", $meta;
2403
2404	return $data;
2405	}
2406
2407	db_get cache => "$id/data"
2408	}
2409
2410	=item fork_call { }, $args
2411
2412	Executes the given code block with the given arguments in a seperate
2413	process, returning the results. Everything must be serialisable with
2414	Coro::Storable. May, of course, block. Note that the executed sub may
2415	never block itself or use any form of Event handling.
2416
2417	=cut
2418
2419	sub fork_call(&@) {
2420	my ($cb, @args) = @_;
2421
2422	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2423	# or die "socketpair: $!";
2424	pipe my $fh1, my $fh2
2425	or die "pipe: $!";
2426
2427	if (my $pid = fork) {
2428	close $fh2;
2429
2430	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2431	$res = Coro::Storable::thaw $res;
2432
2433	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2434
2435	die $$res unless "ARRAY" eq ref $res;
2436
2437	return wantarray ? @$res : $res->[-1];
2438	} else {
2439	local $SIG{__WARN__};
2440	eval {
2441	local $SIG{__DIE__};
2442	close $fh1;
2443
2444	my @res = eval { $cb->(@args) };
2445	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2446	};
2447
2448	warn $@ if $@;
2449	_exit 0;
2450	}
2451	}
2452
2453
2454
2455	#############################################################################
2456	# the server's init and main functions	3039	# the server's init and main functions
2457		3040
2458	sub load_facedata($) {	3041	sub load_facedata($) {
2459	my ($path) = @_;	3042	my ($path) = @_;
		3043
		3044	# HACK to clear player env face cache, we need some signal framework
		3045	# for this (global event?)
		3046	%ext::player_env::MUSIC_FACE_CACHE = ();
		3047
		3048	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2460		3049
2461	warn "loading facedata from $path\n";	3050	warn "loading facedata from $path\n";
2462		3051
2463	my $facedata;	3052	my $facedata;
2464	0 < aio_load $path, $facedata	3053	0 < aio_load $path, $facedata
…		…
2467	$facedata = Coro::Storable::thaw $facedata;	3056	$facedata = Coro::Storable::thaw $facedata;
2468		3057
2469	$facedata->{version} == 2	3058	$facedata->{version} == 2
2470	or cf::cleanup "$path: version mismatch, cannot proceed.";	3059	or cf::cleanup "$path: version mismatch, cannot proceed.";
2471		3060
		3061	# patch in the exptable
		3062	$facedata->{resource}{"res/exp_table"} = {
		3063	type => FT_RSRC,
		3064	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
		3065	};
		3066	cf::cede_to_tick;
		3067
2472	{	3068	{
2473	my $faces = $facedata->{faceinfo};	3069	my $faces = $facedata->{faceinfo};
2474		3070
2475	while (my ($face, $info) = each %$faces) {	3071	while (my ($face, $info) = each %$faces) {
2476	my $idx = (cf::face::find $face) || cf::face::alloc $face;	3072	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2477	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	3073	cf::face::set_visibility $idx, $info->{visibility};
		3074	cf::face::set_magicmap $idx, $info->{magicmap};
2478	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	3075	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2479	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	3076	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2480	Coro::cede;	3077
		3078	cf::cede_to_tick;
2481	}	3079	}
2482		3080
2483	while (my ($face, $info) = each %$faces) {	3081	while (my ($face, $info) = each %$faces) {
2484	next unless $info->{smooth};	3082	next unless $info->{smooth};
2485	my $idx = cf::face::find $face	3083	my $idx = cf::face::find $face
2486	or next;	3084	or next;
2487	if (my $smooth = cf::face::find $info->{smooth}) {	3085	if (my $smooth = cf::face::find $info->{smooth}) {
		3086	cf::face::set_smooth $idx, $smooth;
2488	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	3087	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2489	} else {	3088	} else {
2490	warn "smooth face '$info->{smooth}' not found for face '$face'";	3089	warn "smooth face '$info->{smooth}' not found for face '$face'";
2491	}	3090	}
2492	Coro::cede;	3091
		3092	cf::cede_to_tick;
2493	}	3093	}
2494	}	3094	}
2495		3095
2496	{	3096	{
2497	my $anims = $facedata->{animinfo};	3097	my $anims = $facedata->{animinfo};
2498		3098
2499	while (my ($anim, $info) = each %$anims) {	3099	while (my ($anim, $info) = each %$anims) {
2500	cf::anim::set $anim, $info->{frames}, $info->{facings};	3100	cf::anim::set $anim, $info->{frames}, $info->{facings};
2501	Coro::cede;	3101	cf::cede_to_tick;
2502	}	3102	}
2503		3103
2504	cf::anim::invalidate_all; # d'oh	3104	cf::anim::invalidate_all; # d'oh
2505	}	3105	}
2506		3106
		3107	{
		3108	# TODO: for gcfclient pleasure, we should give resources
		3109	# that gcfclient doesn't grok a >10000 face index.
		3110	my $res = $facedata->{resource};
		3111
		3112	my $soundconf = delete $res->{"res/sound.conf"};
		3113
		3114	while (my ($name, $info) = each %$res) {
		3115	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3116	my $data;
		3117
		3118	if ($info->{type} & 1) {
		3119	# prepend meta info
		3120
		3121	my $meta = $enc->encode ({
		3122	name => $name,
		3123	%{ $info->{meta} || {} },
		3124	});
		3125
		3126	$data = pack "(w/a*)*", $meta, $info->{data};
		3127	} else {
		3128	$data = $info->{data};
		3129	}
		3130
		3131	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3132	cf::face::set_type $idx, $info->{type};
		3133
		3134	cf::cede_to_tick;
		3135	}
		3136
		3137	if ($soundconf) {
		3138	$soundconf = $enc->decode (delete $soundconf->{data});
		3139
		3140	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3141	my $sound = $soundconf->{compat}[$_]
		3142	or next;
		3143
		3144	my $face = cf::face::find "sound/$sound->[1]";
		3145	cf::sound::set $sound->[0] => $face;
		3146	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3147	}
		3148
		3149	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3150	my $face = cf::face::find "sound/$v";
		3151	cf::sound::set $k => $face;
		3152	}
		3153	}
		3154	}
		3155
2507	1	3156	1
2508	}	3157	}
2509		3158
		3159	register_exticmd fx_want => sub {
		3160	my ($ns, $want) = @_;
		3161
		3162	while (my ($k, $v) = each %$want) {
		3163	$ns->fx_want ($k, $v);
		3164	}
		3165	};
		3166
2510	sub reload_regions {	3167	sub reload_regions {
		3168	# HACK to clear player env face cache, we need some signal framework
		3169	# for this (global event?)
		3170	%ext::player_env::MUSIC_FACE_CACHE = ();
		3171
2511	load_resource_file "$MAPDIR/regions"	3172	load_resource_file "$MAPDIR/regions"
2512	or die "unable to load regions file\n";	3173	or die "unable to load regions file\n";
		3174
		3175	for (cf::region::list) {
		3176	$_->{match} = qr/$_->{match}/
		3177	if exists $_->{match};
		3178	}
2513	}	3179	}
2514		3180
2515	sub reload_facedata {	3181	sub reload_facedata {
2516	load_facedata "$DATADIR/facedata"	3182	load_facedata "$DATADIR/facedata"
2517	or die "unable to load facedata\n";	3183	or die "unable to load facedata\n";
2518	}	3184	}
2519		3185
2520	sub reload_archetypes {	3186	sub reload_archetypes {
2521	load_resource_file "$DATADIR/archetypes"	3187	load_resource_file "$DATADIR/archetypes"
2522	or die "unable to load archetypes\n";	3188	or die "unable to load archetypes\n";
		3189	#d# NEED to laod twice to resolve forward references
		3190	# this really needs to be done in an extra post-pass
		3191	# (which needs to be synchronous, so solve it differently)
		3192	load_resource_file "$DATADIR/archetypes"
		3193	or die "unable to load archetypes\n";
2523	}	3194	}
2524		3195
2525	sub reload_treasures {	3196	sub reload_treasures {
2526	load_resource_file "$DATADIR/treasures"	3197	load_resource_file "$DATADIR/treasures"
2527	or die "unable to load treasurelists\n";	3198	or die "unable to load treasurelists\n";
…		…
2530	sub reload_resources {	3201	sub reload_resources {
2531	warn "reloading resource files...\n";	3202	warn "reloading resource files...\n";
2532		3203
2533	reload_regions;	3204	reload_regions;
2534	reload_facedata;	3205	reload_facedata;
		3206	#reload_archetypes;#d#
2535	reload_archetypes;	3207	reload_archetypes;
2536	reload_treasures;	3208	reload_treasures;
2537		3209
2538	warn "finished reloading resource files\n";	3210	warn "finished reloading resource files\n";
2539	}	3211	}
2540		3212
2541	sub init {	3213	sub init {
2542	reload_resources;	3214	reload_resources;
2543	}	3215	}
2544		3216
2545	sub cfg_load {	3217	sub reload_config {
2546	open my $fh, "<:utf8", "$CONFDIR/config"	3218	open my $fh, "<:utf8", "$CONFDIR/config"
2547	or return;	3219	or return;
2548		3220
2549	local $/;	3221	local $/;
2550	*CFG = YAML::Syck::Load <$fh>;	3222	*CFG = YAML::Syck::Load <$fh>;
…		…
2566	sub main {	3238	sub main {
2567	# we must not ever block the main coroutine	3239	# we must not ever block the main coroutine
2568	local $Coro::idle = sub {	3240	local $Coro::idle = sub {
2569	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3241	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2570	(async {	3242	(async {
		3243	$Coro::current->{desc} = "IDLE BUG HANDLER";
2571	Event::one_event;	3244	Event::one_event;
2572	})->prio (Coro::PRIO_MAX);	3245	})->prio (Coro::PRIO_MAX);
2573	};	3246	};
2574		3247
2575	cfg_load;	3248	reload_config;
2576	db_init;	3249	db_init;
2577	load_extensions;	3250	load_extensions;
2578		3251
2579	$TICK_WATCHER->start;	3252	$TICK_WATCHER->start;
2580	Event::loop;	3253	Event::loop;
…		…
2596	},	3269	},
2597	);	3270	);
2598	}	3271	}
2599	}	3272	}
2600		3273
		3274	sub write_runtime {
		3275	my $runtime = "$LOCALDIR/runtime";
		3276
		3277	# first touch the runtime file to show we are still running:
		3278	# the fsync below can take a very very long time.
		3279
		3280	IO::AIO::aio_utime $runtime, undef, undef;
		3281
		3282	my $guard = cf::lock_acquire "write_runtime";
		3283
		3284	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3285	or return;
		3286
		3287	my $value = $cf::RUNTIME + 90 + 10;
		3288	# 10 is the runtime save interval, for a monotonic clock
		3289	# 60 allows for the watchdog to kill the server.
		3290
		3291	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3292	and return;
		3293
		3294	# always fsync - this file is important
		3295	aio_fsync $fh
		3296	and return;
		3297
		3298	# touch it again to show we are up-to-date
		3299	aio_utime $fh, undef, undef;
		3300
		3301	close $fh
		3302	or return;
		3303
		3304	aio_rename "$runtime~", $runtime
		3305	and return;
		3306
		3307	warn "runtime file written.\n";
		3308
		3309	1
		3310	}
		3311
2601	sub emergency_save() {	3312	sub emergency_save() {
2602	my $freeze_guard = cf::freeze_mainloop;	3313	my $freeze_guard = cf::freeze_mainloop;
2603		3314
2604	warn "enter emergency perl save\n";	3315	warn "enter emergency perl save\n";
2605		3316
…		…
2609	# and maps saved/destroyed asynchronously.	3320	# and maps saved/destroyed asynchronously.
2610	warn "begin emergency player save\n";	3321	warn "begin emergency player save\n";
2611	for my $login (keys %cf::PLAYER) {	3322	for my $login (keys %cf::PLAYER) {
2612	my $pl = $cf::PLAYER{$login} or next;	3323	my $pl = $cf::PLAYER{$login} or next;
2613	$pl->valid or next;	3324	$pl->valid or next;
		3325	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2614	$pl->save;	3326	$pl->save;
2615	}	3327	}
2616	warn "end emergency player save\n";	3328	warn "end emergency player save\n";
2617		3329
2618	warn "begin emergency map save\n";	3330	warn "begin emergency map save\n";
…		…
2666		3378
2667	warn "flushing outstanding aio requests";	3379	warn "flushing outstanding aio requests";
2668	for (;;) {	3380	for (;;) {
2669	BDB::flush;	3381	BDB::flush;
2670	IO::AIO::flush;	3382	IO::AIO::flush;
2671	Coro::cede;	3383	Coro::cede_notself;
2672	last unless IO::AIO::nreqs || BDB::nreqs;	3384	last unless IO::AIO::nreqs || BDB::nreqs;
2673	warn "iterate...";	3385	warn "iterate...";
2674	}	3386	}
2675		3387
2676	++$RELOAD;	3388	++$RELOAD;
…		…
2680	%EXT_CORO = ();	3392	%EXT_CORO = ();
2681		3393
2682	warn "removing commands";	3394	warn "removing commands";
2683	%COMMAND = ();	3395	%COMMAND = ();
2684		3396
2685	warn "removing ext commands";	3397	warn "removing ext/exti commands";
2686	%EXTCMD = ();	3398	%EXTCMD = ();
		3399	%EXTICMD = ();
2687		3400
2688	warn "unloading/nuking all extensions";	3401	warn "unloading/nuking all extensions";
2689	for my $pkg (@EXTS) {	3402	for my $pkg (@EXTS) {
2690	warn "... unloading $pkg";	3403	warn "... unloading $pkg";
2691		3404
…		…
2734	warn "reloading cf.pm";	3447	warn "reloading cf.pm";
2735	require cf;	3448	require cf;
2736	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3449	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2737		3450
2738	warn "loading config and database again";	3451	warn "loading config and database again";
2739	cf::cfg_load;	3452	cf::reload_config;
2740		3453
2741	warn "loading extensions";	3454	warn "loading extensions";
2742	cf::load_extensions;	3455	cf::load_extensions;
2743		3456
2744	warn "reattaching attachments to objects/players";	3457	warn "reattaching attachments to objects/players";
…		…
2780	register_command "reload" => sub {	3493	register_command "reload" => sub {
2781	my ($who, $arg) = @_;	3494	my ($who, $arg) = @_;
2782		3495
2783	if ($who->flag (FLAG_WIZ)) {	3496	if ($who->flag (FLAG_WIZ)) {
2784	$who->message ("reloading server.");	3497	$who->message ("reloading server.");
		3498	async {
		3499	$Coro::current->{desc} = "perl_reload";
2785	async { reload_perl };	3500	reload_perl;
		3501	};
2786	}	3502	}
2787	};	3503	};
2788		3504
2789	unshift @INC, $LIBDIR;	3505	unshift @INC, $LIBDIR;
2790		3506
…		…
2822	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3538	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2823	unless ++$bug_warning > 10;	3539	unless ++$bug_warning > 10;
2824	return;	3540	return;
2825	}	3541	}
2826		3542
2827	$NOW = Event::time;	3543	$NOW = $tick_start = Event::time;
2828		3544
2829	cf::server_tick; # one server iteration	3545	cf::server_tick; # one server iteration
2830		3546
2831	$RUNTIME += $TICK;	3547	$RUNTIME += $TICK;
2832	$NEXT_TICK += $TICK;	3548	$NEXT_TICK += $TICK;
2833		3549
2834	if ($NOW >= $NEXT_RUNTIME_WRITE) {	3550	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2835	$NEXT_RUNTIME_WRITE = $NOW + 10;	3551	$NEXT_RUNTIME_WRITE = $NOW + 10;
2836	Coro::async_pool {	3552	Coro::async_pool {
		3553	$Coro::current->{desc} = "runtime saver";
2837	write_runtime	3554	write_runtime
2838	or warn "ERROR: unable to write runtime file: $!";	3555	or warn "ERROR: unable to write runtime file: $!";
2839	};	3556	};
2840	}	3557	}
2841		3558
2842	# my $AFTER = Event::time;	3559	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2843	# warn $AFTER - $NOW;#d#	3560	$sig->send;
		3561	}
		3562	while (my $sig = shift @WAIT_FOR_TICK) {
		3563	$sig->send;
		3564	}
		3565
		3566	$NOW = Event::time;
2844		3567
2845	# if we are delayed by four ticks or more, skip them all	3568	# if we are delayed by four ticks or more, skip them all
2846	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3569	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2847		3570
2848	$TICK_WATCHER->at ($NEXT_TICK);	3571	$TICK_WATCHER->at ($NEXT_TICK);
2849	$TICK_WATCHER->start;	3572	$TICK_WATCHER->start;
2850		3573
2851	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {	3574	$LOAD = ($NOW - $tick_start) / $TICK;
2852	$sig->send;	3575	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2853	}
2854	while (my $sig = shift @WAIT_FOR_TICK) {
2855	$sig->send;
2856	}
2857		3576
2858	_post_tick;	3577	_post_tick;
2859	},	3578	},
2860	);	3579	);
2861		3580
2862	{	3581	{
		3582	BDB::min_parallel 8;
2863	BDB::max_poll_time $TICK * 0.1;	3583	BDB::max_poll_time $TICK * 0.1;
2864	$BDB_POLL_WATCHER = Event->io (	3584	$BDB_POLL_WATCHER = Event->io (
2865	reentrant => 0,	3585	reentrant => 0,
2866	fd => BDB::poll_fileno,	3586	fd => BDB::poll_fileno,
2867	poll => 'r',	3587	poll => 'r',
2868	prio => 0,	3588	prio => 0,
2869	data => WF_AUTOCANCEL,	3589	data => WF_AUTOCANCEL,
2870	cb => \&BDB::poll_cb,	3590	cb => \&BDB::poll_cb,
2871	);	3591	);
2872	BDB::min_parallel 8;
2873		3592
2874	BDB::set_sync_prepare {	3593	BDB::set_sync_prepare {
2875	my $status;	3594	my $status;
2876	my $current = $Coro::current;	3595	my $current = $Coro::current;
2877	(	3596	(
…		…
2886	)	3605	)
2887	};	3606	};
2888		3607
2889	unless ($DB_ENV) {	3608	unless ($DB_ENV) {
2890	$DB_ENV = BDB::db_env_create;	3609	$DB_ENV = BDB::db_env_create;
		3610	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
		3611	| BDB::LOG_AUTOREMOVE, 1);
		3612	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3613	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
2891		3614
2892	cf::sync_job {	3615	cf::sync_job {
2893	eval {	3616	eval {
2894	BDB::db_env_open	3617	BDB::db_env_open
2895	$DB_ENV,	3618	$DB_ENV,
…		…
2897	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	3620	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2898	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3621	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2899	0666;	3622	0666;
2900		3623
2901	cf::cleanup "db_env_open($BDBDIR): $!" if $!;	3624	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2902
2903	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2904	$DB_ENV->set_lk_detect;
2905	};	3625	};
2906		3626
2907	cf::cleanup "db_env_open(db): $@" if $@;	3627	cf::cleanup "db_env_open(db): $@" if $@;
2908	};	3628	};
2909	}	3629	}
		3630
		3631	$BDB_DEADLOCK_WATCHER = Event->timer (
		3632	after => 3,
		3633	interval => 1,
		3634	hard => 1,
		3635	prio => 0,
		3636	data => WF_AUTOCANCEL,
		3637	cb => sub {
		3638	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3639	},
		3640	);
		3641	$BDB_CHECKPOINT_WATCHER = Event->timer (
		3642	after => 11,
		3643	interval => 60,
		3644	hard => 1,
		3645	prio => 0,
		3646	data => WF_AUTOCANCEL,
		3647	cb => sub {
		3648	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3649	},
		3650	);
		3651	$BDB_TRICKLE_WATCHER = Event->timer (
		3652	after => 5,
		3653	interval => 10,
		3654	hard => 1,
		3655	prio => 0,
		3656	data => WF_AUTOCANCEL,
		3657	cb => sub {
		3658	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3659	},
		3660	);
2910	}	3661	}
2911		3662
2912	{	3663	{
2913	IO::AIO::min_parallel 8;	3664	IO::AIO::min_parallel 8;
2914		3665
…		…
2917	$AIO_POLL_WATCHER = Event->io (	3668	$AIO_POLL_WATCHER = Event->io (
2918	reentrant => 0,	3669	reentrant => 0,
2919	data => WF_AUTOCANCEL,	3670	data => WF_AUTOCANCEL,
2920	fd => IO::AIO::poll_fileno,	3671	fd => IO::AIO::poll_fileno,
2921	poll => 'r',	3672	poll => 'r',
2922	prio => 6,	3673	prio => 0,
2923	cb => \&IO::AIO::poll_cb,	3674	cb => \&IO::AIO::poll_cb,
2924	);	3675	);
2925	}	3676	}
2926		3677
		3678	my $_log_backtrace;
		3679
		3680	sub _log_backtrace {
		3681	my ($msg, @addr) = @_;
		3682
		3683	$msg =~ s/\n//;
		3684
		3685	# limit the # of concurrent backtraces
		3686	if ($_log_backtrace < 2) {
		3687	++$_log_backtrace;
		3688	async {
		3689	$Coro::current->{desc} = "abt $msg";
		3690
		3691	my @bt = fork_call {
		3692	@addr = map { sprintf "%x", $_ } @addr;
		3693	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3694	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3695	or die "addr2line: $!";
		3696
		3697	my @funcs;
		3698	my @res = <$fh>;
		3699	chomp for @res;
		3700	while (@res) {
		3701	my ($func, $line) = splice @res, 0, 2, ();
		3702	push @funcs, "[$func] $line";
		3703	}
		3704
		3705	@funcs
		3706	};
		3707
		3708	LOG llevInfo, "[ABT] $msg\n";
		3709	LOG llevInfo, "[ABT] $_\n" for @bt;
		3710	--$_log_backtrace;
		3711	};
		3712	} else {
		3713	LOG llevInfo, "[ABT] $msg\n";
		3714	LOG llevInfo, "[ABT] [suppressed]\n";
		3715	}
		3716	}
		3717
2927	# load additional modules	3718	# load additional modules
2928	use cf::pod;	3719	use cf::pod;
2929		3720
2930	END { cf::emergency_save }	3721	END { cf::emergency_save }
2931		3722

Diff Legend

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