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.7 by root, Tue Mar 7 13:44:43 2006 UTC vs.
Revision 1.359 by root, Sat Sep 8 18:15:55 2007 UTC

1	package cf;	1	package cf;
		2
		3	use utf8;
		4	use strict;
2		5
3	use Symbol;	6	use Symbol;
4	use List::Util;	7	use List::Util;
		8	use Socket;
5	use Storable;	9	use Storable;
		10	use Event;
		11	use Opcode;
		12	use Safe;
		13	use Safe::Hole;
6		14
7	use strict;	15	use Coro 3.64 ();
		16	use Coro::State;
		17	use Coro::Handle;
		18	use Coro::Event;
		19	use Coro::Timer;
		20	use Coro::Signal;
		21	use Coro::Semaphore;
		22	use Coro::AIO;
		23	use Coro::Storable;
		24	use Coro::Util ();
8		25
9	our %COMMAND;	26	use JSON::XS ();
		27	use BDB ();
		28	use Data::Dumper;
		29	use Digest::MD5;
		30	use Fcntl;
		31	use YAML::Syck ();
		32	use IO::AIO 2.32 ();
		33	use Time::HiRes;
		34	use Compress::LZF;
		35	use Digest::MD5 ();
		36
		37	# configure various modules to our taste
		38	#
		39	$Storable::canonical = 1; # reduce rsync transfers
		40	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		41	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		42
		43	$Event::Eval = 1; # no idea why this is required, but it is
		44
		45	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
		46	$YAML::Syck::ImplicitUnicode = 1;
		47
		48	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
		49
		50	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		51
		52	our %COMMAND = ();
		53	our %COMMAND_TIME = ();
		54
		55	our @EXTS = (); # list of extension package names
		56	our %EXTCMD = ();
		57	our %EXTICMD = ();
		58	our %EXT_CORO = (); # coroutines bound to extensions
		59	our %EXT_MAP = (); # pluggable maps
		60
		61	our $RELOAD; # number of reloads so far
10	our @EVENT;	62	our @EVENT;
11	our %PROP_TYPE;	63
12	our %PROP_IDX;	64	our $CONFDIR = confdir;
		65	our $DATADIR = datadir;
		66	our $LIBDIR = "$DATADIR/ext";
		67	our $PODDIR = "$DATADIR/pod";
		68	our $MAPDIR = "$DATADIR/" . mapdir;
		69	our $LOCALDIR = localdir;
		70	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		71	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		72	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		73	our $RANDOMDIR = "$LOCALDIR/random";
		74	our $BDBDIR = "$LOCALDIR/db";
		75
		76	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
		77	our $TICK_WATCHER;
		78	our $AIO_POLL_WATCHER;
		79	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
		80	our $NEXT_TICK;
		81	our $NOW;
		82	our $USE_FSYNC = 1; # use fsync to write maps - default off
		83
		84	our $BDB_POLL_WATCHER;
		85	our $DB_ENV;
		86
		87	our %CFG;
		88
		89	our $UPTIME; $UPTIME ||= time;
		90	our $RUNTIME;
		91
		92	our (%PLAYER, %PLAYER_LOADING); # all users
		93	our (%MAP, %MAP_LOADING ); # all maps
		94	our $LINK_MAP; # the special {link} map, which is always available
		95
		96	# used to convert map paths into valid unix filenames by replacing / by ∕
		97	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		98
		99	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		100	our $LOADAVG; # same thing, but with alpha-smoothing
		101	our $tick_start; # for load detecting purposes
		102
		103	binmode STDOUT;
		104	binmode STDERR;
		105
		106	# read virtual server time, if available
		107	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
		108	open my $fh, "<", "$LOCALDIR/runtime"
		109	or die "unable to read runtime file: $!";
		110	$RUNTIME = <$fh> + 0.;
		111	}
		112
		113	mkdir $_
		114	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
		115
		116	our $EMERGENCY_POSITION;
		117
		118	sub cf::map::normalise;
		119
		120	#############################################################################
		121
		122	=head2 GLOBAL VARIABLES
		123
		124	=over 4
		125
		126	=item $cf::UPTIME
		127
		128	The timestamp of the server start (so not actually an uptime).
		129
		130	=item $cf::RUNTIME
		131
		132	The time this server has run, starts at 0 and is increased by $cf::TICK on
		133	every server tick.
		134
		135	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		136	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		137	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
		138
		139	Various directories - "/etc", read-only install directory, perl-library
		140	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		141	unique-items directory, player file directory, random maps directory and
		142	database environment.
		143
		144	=item $cf::NOW
		145
		146	The time of the last (current) server tick.
		147
		148	=item $cf::TICK
		149
		150	The interval between server ticks, in seconds.
		151
		152	=item $cf::LOADAVG
		153
		154	The current CPU load on the server (alpha-smoothed), as a value between 0
		155	(none) and 1 (overloaded), indicating how much time is spent on processing
		156	objects per tick. Healthy values are < 0.5.
		157
		158	=item $cf::LOAD
		159
		160	The raw value load value from the last tick.
		161
		162	=item %cf::CFG
		163
		164	Configuration for the server, loaded from C</etc/crossfire/config>, or
		165	from wherever your confdir points to.
		166
		167	=item cf::wait_for_tick, cf::wait_for_tick_begin
		168
		169	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
		170	returns directly I<after> the tick processing (and consequently, can only wake one process
		171	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
		172
		173	=item @cf::INVOKE_RESULTS
		174
		175	This array contains the results of the last C<invoke ()> call. When
		176	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		177	that call.
		178
		179	=back
		180
		181	=cut
13		182
14	BEGIN {	183	BEGIN {
15	@EVENT = map lc, @EVENT;
16
17	*CORE::GLOBAL::warn = sub {	184	*CORE::GLOBAL::warn = sub {
18	my $msg = join "", @_;	185	my $msg = join "", @_;
		186
19	$msg .= "\n"	187	$msg .= "\n"
20	unless $msg =~ /\n$/;	188	unless $msg =~ /\n$/;
21		189
22	print STDERR "cfperl: $msg";	190	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		191
		192	utf8::encode $msg;
23	LOG llevError, "cfperl: $msg";	193	LOG llevError, $msg;
24	};	194	};
25	}	195	}
26		196
27	# generate property mutators	197	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
28	sub prop_gen {	198	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
29	my ($prefix, $class) = @_;	199	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
		200	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
		201	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		202	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
		203	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
30		204
		205	# we bless all objects into (empty) derived classes to force a method lookup
		206	# within the Safe compartment.
		207	for my $pkg (qw(
		208	cf::global cf::attachable
		209	cf::object cf::object::player
		210	cf::client cf::player
		211	cf::arch cf::living
		212	cf::map cf::party cf::region
		213	)) {
31	no strict 'refs';	214	no strict 'refs';
		215	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
		216	}
32		217
33	for my $prop (keys %PROP_TYPE) {	218	$Event::DIED = sub {
34	$prop =~ /^\Q$prefix\E_(.*$)/ or next;	219	warn "error in event callback: @_";
		220	};
		221
		222	#############################################################################
		223
		224	=head2 UTILITY FUNCTIONS
		225
		226	=over 4
		227
		228	=item dumpval $ref
		229
		230	=cut
		231
		232	sub dumpval {
		233	eval {
		234	local $SIG{__DIE__};
		235	my $d;
		236	if (1) {
		237	$d = new Data::Dumper([$_[0]], ["*var"]);
		238	$d->Terse(1);
		239	$d->Indent(2);
		240	$d->Quotekeys(0);
		241	$d->Useqq(1);
		242	#$d->Bless(...);
		243	$d->Seen($_[1]) if @_ > 1;
		244	$d = $d->Dump();
		245	}
		246	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		247	$d
		248	} || "[unable to dump $_[0]: '$@']";
		249	}
		250
		251	=item $ref = cf::from_json $json
		252
		253	Converts a JSON string into the corresponding perl data structure.
		254
		255	=item $json = cf::to_json $ref
		256
		257	Converts a perl data structure into its JSON representation.
		258
		259	=cut
		260
		261	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
		262
		263	sub to_json ($) { $json_coder->encode ($_[0]) }
		264	sub from_json ($) { $json_coder->decode ($_[0]) }
		265
		266	=item cf::lock_wait $string
		267
		268	Wait until the given lock is available. See cf::lock_acquire.
		269
		270	=item my $lock = cf::lock_acquire $string
		271
		272	Wait until the given lock is available and then acquires it and returns
		273	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
		274	for example when the coroutine gets canceled), the lock is automatically
		275	returned.
		276
		277	Locks are *not* recursive, locking from the same coro twice results in a
		278	deadlocked coro.
		279
		280	Lock names should begin with a unique identifier (for example, cf::map::find
		281	uses map_find and cf::map::load uses map_load).
		282
		283	=item $locked = cf::lock_active $string
		284
		285	Return true if the lock is currently active, i.e. somebody has locked it.
		286
		287	=cut
		288
		289	our %LOCK;
		290	our %LOCKER;#d#
		291
		292	sub lock_wait($) {
		293	my ($key) = @_;
		294
		295	if ($LOCKER{$key} == $Coro::current) {#d#
		296	Carp::cluck "lock_wait($key) for already-acquired lock";#d#
		297	return;#d#
		298	}#d#
		299
		300	# wait for lock, if any
		301	while ($LOCK{$key}) {
		302	push @{ $LOCK{$key} }, $Coro::current;
		303	Coro::schedule;
		304	}
		305	}
		306
		307	sub lock_acquire($) {
		308	my ($key) = @_;
		309
		310	# wait, to be sure we are not locked
		311	lock_wait $key;
		312
		313	$LOCK{$key} = [];
		314	$LOCKER{$key} = $Coro::current;#d#
		315
		316	Coro::guard {
		317	delete $LOCKER{$key};#d#
		318	# wake up all waiters, to be on the safe side
		319	$_->ready for @{ delete $LOCK{$key} };
		320	}
		321	}
		322
		323	sub lock_active($) {
		324	my ($key) = @_;
		325
		326	! ! $LOCK{$key}
		327	}
		328
		329	sub freeze_mainloop {
		330	return unless $TICK_WATCHER->is_active;
		331
		332	my $guard = Coro::guard {
		333	$TICK_WATCHER->start;
		334	};
		335	$TICK_WATCHER->stop;
		336	$guard
		337	}
		338
		339	=item cf::get_slot $time[, $priority[, $name]]
		340
		341	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		342	This call blocks and returns only when you have at least C<$time> seconds
		343	of cpu time till the next tick. The slot is only valid till the next cede.
		344
		345	The optional C<$name> can be used to identify the job to run. It might be
		346	used for statistical purposes and should identify the same time-class.
		347
		348	Useful for short background jobs.
		349
		350	=cut
		351
		352	our @SLOT_QUEUE;
		353	our $SLOT_QUEUE;
		354
		355	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		356	$SLOT_QUEUE = Coro::async {
		357	my $signal = new Coro::Signal;
		358
		359	while () {
		360	next_job:
		361	my $avail = cf::till_tick;
		362	if ($avail > 0.01) {
		363	for (0 .. $#SLOT_QUEUE) {
		364	if ($SLOT_QUEUE[$_][0] < $avail) {
		365	my $job = splice @SLOT_QUEUE, $_, 1, ();
		366	$job->[2]->send;
		367	Coro::cede;
		368	goto next_job;
		369	}
		370	}
		371	}
		372
		373	if (@SLOT_QUEUE) {
		374	# we do not use wait_For_tick() as it returns immediately when tick is inactive
		375	push @cf::WAIT_FOR_TICK, $signal;
		376	$signal->wait;
		377	} else {
		378	Coro::schedule;
		379	}
		380	}
		381	};
		382
		383	sub get_slot($;$$) {
		384	my ($time, $pri, $name) = @_;
		385
		386	$time = $TICK * .6 if $time > $TICK * .6;
		387	my $sig = new Coro::Signal;
		388
		389	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		390	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		391	$SLOT_QUEUE->ready;
		392	$sig->wait;
		393	}
		394
		395	=item cf::async { BLOCK }
		396
		397	Currently the same as Coro::async_pool, meaning you cannot use
		398	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		399	thing you are allowed to do is call C<prio> on it.
		400
		401	=cut
		402
		403	BEGIN { *async = \&Coro::async_pool }
		404
		405	=item cf::sync_job { BLOCK }
		406
		407	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
		408	is always able to handle events or runnable, as Crossfire TRT is only
		409	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		410	acceptable.
		411
		412	If it must be done, put the blocking parts into C<sync_job>. This will run
		413	the given BLOCK in another coroutine while waiting for the result. The
		414	server will be frozen during this time, so the block should either finish
		415	fast or be very important.
		416
		417	=cut
		418
		419	sub sync_job(&) {
		420	my ($job) = @_;
		421
		422	if ($Coro::current == $Coro::main) {
		423	my $time = Event::time;
		424
		425	# this is the main coro, too bad, we have to block
		426	# till the operation succeeds, freezing the server :/
		427
		428	# TODO: use suspend/resume instead
		429	# (but this is cancel-safe)
		430	my $freeze_guard = freeze_mainloop;
		431
35	my $sub = lc $1;	432	my $busy = 1;
		433	my @res;
36		434
37	my $type = $PROP_TYPE{$prop};	435	(async {
38	my $idx = $PROP_IDX {$prop};	436	@res = eval { $job->() };
		437	warn $@ if $@;
		438	undef $busy;
		439	})->prio (Coro::PRIO_MAX);
39		440
40	*{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {	441	while ($busy) {
41	$_[0]->get_property ($type, $idx)	442	Coro::cede or Event::one_event;
		443	}
		444
		445	$time = Event::time - $time;
		446
		447	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		448	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		449
		450	$tick_start += $time; # do not account sync jobs to server load
		451
		452	wantarray ? @res : $res[0]
		453	} else {
		454	# we are in another coroutine, how wonderful, everything just works
		455
		456	$job->()
		457	}
		458	}
		459
		460	=item $coro = cf::async_ext { BLOCK }
		461
		462	Like async, but this coro is automatically being canceled when the
		463	extension calling this is being unloaded.
		464
		465	=cut
		466
		467	sub async_ext(&) {
		468	my $cb = shift;
		469
		470	my $coro = &Coro::async ($cb);
		471
		472	$coro->on_destroy (sub {
		473	delete $EXT_CORO{$coro+0};
		474	});
		475	$EXT_CORO{$coro+0} = $coro;
		476
		477	$coro
		478	}
		479
		480	=item fork_call { }, $args
		481
		482	Executes the given code block with the given arguments in a seperate
		483	process, returning the results. Everything must be serialisable with
		484	Coro::Storable. May, of course, block. Note that the executed sub may
		485	never block itself or use any form of Event handling.
		486
		487	=cut
		488
		489	sub fork_call(&@) {
		490	my ($cb, @args) = @_;
		491
		492	# we seemingly have to make a local copy of the whole thing,
		493	# otherwise perl prematurely frees the stuff :/
		494	# TODO: investigate and fix (likely this will be rather laborious)
		495
		496	my @res = Coro::Util::fork_eval {
		497	reset_signals;
		498	&$cb
		499	}, @args;
		500
		501	wantarray ? @res : $res[-1]
		502	}
		503
		504	=item $value = cf::db_get $family => $key
		505
		506	Returns a single value from the environment database.
		507
		508	=item cf::db_put $family => $key => $value
		509
		510	Stores the given C<$value> in the family. It can currently store binary
		511	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		512
		513	=cut
		514
		515	our $DB;
		516
		517	sub db_init {
		518	unless ($DB) {
		519	$DB = BDB::db_create $DB_ENV;
		520
		521	cf::sync_job {
		522	eval {
		523	$DB->set_flags (BDB::CHKSUM);
		524
		525	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		526	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		527	cf::cleanup "db_open(db): $!" if $!;
		528	};
		529	cf::cleanup "db_open(db): $@" if $@;
42	};	530	};
		531	}
		532	}
43		533
44	*{"$class\::set_$sub"} = sub {	534	sub db_get($$) {
45	$_[0]->set_property ($type, $idx, $_[1]);	535	my $key = "$_[0]/$_[1]";
		536
		537	cf::sync_job {
		538	BDB::db_get $DB, undef, $key, my $data;
		539
		540	$! ? ()
		541	: $data
		542	}
		543	}
		544
		545	sub db_put($$$) {
		546	BDB::dbreq_pri 4;
		547	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		548	}
		549
		550	=item cf::cache $id => [$paths...], $processversion => $process
		551
		552	Generic caching function that returns the value of the resource $id,
		553	caching and regenerating as required.
		554
		555	This function can block.
		556
		557	=cut
		558
		559	sub cache {
		560	my ($id, $src, $processversion, $process) = @_;
		561
		562	my $meta =
		563	join "\x00",
		564	$processversion,
		565	map {
		566	aio_stat $_
		567	and Carp::croak "$_: $!";
		568
		569	($_, (stat _)[7,9])
		570	} @$src;
		571
		572	my $dbmeta = db_get cache => "$id/meta";
		573	if ($dbmeta ne $meta) {
		574	# changed, we may need to process
		575
		576	my @data;
		577	my $md5;
		578
		579	for (0 .. $#$src) {
		580	0 <= aio_load $src->[$_], $data[$_]
		581	or Carp::croak "$src->[$_]: $!";
		582	}
		583
		584	# if processing is expensive, check
		585	# checksum first
		586	if (1) {
		587	$md5 =
		588	join "\x00",
		589	$processversion,
		590	map {
		591	cf::cede_to_tick;
		592	($src->[$_], Digest::MD5::md5_hex $data[$_])
		593	} 0.. $#$src;
		594
		595
		596	my $dbmd5 = db_get cache => "$id/md5";
		597	if ($dbmd5 eq $md5) {
		598	db_put cache => "$id/meta", $meta;
		599
		600	return db_get cache => "$id/data";
		601	}
		602	}
		603
		604	my $t1 = Time::HiRes::time;
		605	my $data = $process->(\@data);
		606	my $t2 = Time::HiRes::time;
		607
		608	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		609
		610	db_put cache => "$id/data", $data;
		611	db_put cache => "$id/md5" , $md5;
		612	db_put cache => "$id/meta", $meta;
		613
		614	return $data;
		615	}
		616
		617	db_get cache => "$id/data"
		618	}
		619
		620	=item cf::datalog type => key => value, ...
		621
		622	Log a datalog packet of the given type with the given key-value pairs.
		623
		624	=cut
		625
		626	sub datalog($@) {
		627	my ($type, %kv) = @_;
		628	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
		629	}
		630
		631	=back
		632
		633	=cut
		634
		635	#############################################################################
		636
		637	=head2 ATTACHABLE OBJECTS
		638
		639	Many objects in crossfire are so-called attachable objects. That means you can
		640	attach callbacks/event handlers (a collection of which is called an "attachment")
		641	to it. All such attachable objects support the following methods.
		642
		643	In the following description, CLASS can be any of C<global>, C<object>
		644	C<player>, C<client> or C<map> (i.e. the attachable objects in
		645	Crossfire TRT).
		646
		647	=over 4
		648
		649	=item $attachable->attach ($attachment, key => $value...)
		650
		651	=item $attachable->detach ($attachment)
		652
		653	Attach/detach a pre-registered attachment to a specific object and give it
		654	the specified key/value pairs as arguments.
		655
		656	Example, attach a minesweeper attachment to the given object, making it a
		657	10x10 minesweeper game:
		658
		659	$obj->attach (minesweeper => width => 10, height => 10);
		660
		661	=item $bool = $attachable->attached ($name)
		662
		663	Checks wether the named attachment is currently attached to the object.
		664
		665	=item cf::CLASS->attach ...
		666
		667	=item cf::CLASS->detach ...
		668
		669	Define an anonymous attachment and attach it to all objects of the given
		670	CLASS. See the next function for an explanation of its arguments.
		671
		672	You can attach to global events by using the C<cf::global> class.
		673
		674	Example, log all player logins:
		675
		676	cf::player->attach (
		677	on_login => sub {
		678	my ($pl) = @_;
		679	...
		680	},
		681	);
		682
		683	Example, attach to the jeweler skill:
		684
		685	cf::object->attach (
		686	type => cf::SKILL,
		687	subtype => cf::SK_JEWELER,
		688	on_use_skill => sub {
		689	my ($sk, $ob, $part, $dir, $msg) = @_;
		690	...
		691	},
		692	);
		693
		694	=item cf::CLASS::attachment $name, ...
		695
		696	Register an attachment by C<$name> through which attachable objects of the
		697	given CLASS can refer to this attachment.
		698
		699	Some classes such as crossfire maps and objects can specify attachments
		700	that are attached at load/instantiate time, thus the need for a name.
		701
		702	These calls expect any number of the following handler/hook descriptions:
		703
		704	=over 4
		705
		706	=item prio => $number
		707
		708	Set the priority for all following handlers/hooks (unless overwritten
		709	by another C<prio> setting). Lower priority handlers get executed
		710	earlier. The default priority is C<0>, and many built-in handlers are
		711	registered at priority C<-1000>, so lower priorities should not be used
		712	unless you know what you are doing.
		713
		714	=item type => $type
		715
		716	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		717	given type of objects only (the additional parameter C<subtype> can be
		718	used to further limit to the given subtype).
		719
		720	=item on_I<event> => \&cb
		721
		722	Call the given code reference whenever the named event happens (event is
		723	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
		724	handlers are recognised generally depends on the type of object these
		725	handlers attach to).
		726
		727	See F<include/eventinc.h> for the full list of events supported, and their
		728	class.
		729
		730	=item package => package::
		731
		732	Look for sub functions of the name C<< on_I<event> >> in the given
		733	package and register them. Only handlers for eevents supported by the
		734	object/class are recognised.
		735
		736	=back
		737
		738	Example, define an attachment called "sockpuppet" that calls the given
		739	event handler when a monster attacks:
		740
		741	cf::object::attachment sockpuppet =>
		742	on_skill_attack => sub {
		743	my ($self, $victim) = @_;
		744	...
		745	}
		746	}
		747
		748	=item $attachable->valid
		749
		750	Just because you have a perl object does not mean that the corresponding
		751	C-level object still exists. If you try to access an object that has no
		752	valid C counterpart anymore you get an exception at runtime. This method
		753	can be used to test for existence of the C object part without causing an
		754	exception.
		755
		756	=cut
		757
		758	# the following variables are defined in .xs and must not be re-created
		759	our @CB_GLOBAL = (); # registry for all global events
		760	our @CB_ATTACHABLE = (); # registry for all attachables
		761	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		762	our @CB_PLAYER = ();
		763	our @CB_CLIENT = ();
		764	our @CB_TYPE = (); # registry for type (cf-object class) based events
		765	our @CB_MAP = ();
		766
		767	my %attachment;
		768
		769	sub cf::attachable::thawer_merge {
		770	# simply override everything except _meta
		771	local $_[0]{_meta};
		772	%{$_[0]} = %{$_[1]};
		773	}
		774
		775	sub _attach_cb($$$$) {
		776	my ($registry, $event, $prio, $cb) = @_;
		777
		778	use sort 'stable';
		779
		780	$cb = [$prio, $cb];
		781
		782	@{$registry->[$event]} = sort
		783	{ $a->[0] cmp $b->[0] }
		784	@{$registry->[$event] || []}, $cb;
		785	}
		786
		787	# hack
		788	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
		789
		790	# attach handles attaching event callbacks
		791	# the only thing the caller has to do is pass the correct
		792	# registry (== where the callback attaches to).
		793	sub _attach {
		794	my ($registry, $klass, @arg) = @_;
		795
		796	my $object_type;
		797	my $prio = 0;
		798	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		799
		800	#TODO: get rid of this hack
		801	if ($attachable_klass{$klass}) {
		802	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		803	}
		804
		805	while (@arg) {
		806	my $type = shift @arg;
		807
		808	if ($type eq "prio") {
		809	$prio = shift @arg;
		810
		811	} elsif ($type eq "type") {
		812	$object_type = shift @arg;
		813	$registry = $CB_TYPE[$object_type] ||= [];
		814
		815	} elsif ($type eq "subtype") {
		816	defined $object_type or Carp::croak "subtype specified without type";
		817	my $object_subtype = shift @arg;
		818	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
		819
		820	} elsif ($type eq "package") {
		821	my $pkg = shift @arg;
		822
		823	while (my ($name, $id) = each %cb_id) {
		824	if (my $cb = $pkg->can ($name)) {
		825	_attach_cb $registry, $id, $prio, $cb;
		826	}
		827	}
		828
		829	} elsif (exists $cb_id{$type}) {
		830	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
		831
		832	} elsif (ref $type) {
		833	warn "attaching objects not supported, ignoring.\n";
		834
		835	} else {
		836	shift @arg;
		837	warn "attach argument '$type' not supported, ignoring.\n";
		838	}
		839	}
		840	}
		841
		842	sub _object_attach {
		843	my ($obj, $name, %arg) = @_;
		844
		845	return if exists $obj->{_attachment}{$name};
		846
		847	if (my $attach = $attachment{$name}) {
		848	my $registry = $obj->registry;
		849
		850	for (@$attach) {
		851	my ($klass, @attach) = @$_;
		852	_attach $registry, $klass, @attach;
		853	}
		854
		855	$obj->{$name} = \%arg;
		856	} else {
		857	warn "object uses attachment '$name' which is not available, postponing.\n";
		858	}
		859
		860	$obj->{_attachment}{$name} = undef;
		861	}
		862
		863	sub cf::attachable::attach {
		864	if (ref $_[0]) {
		865	_object_attach @_;
		866	} else {
		867	_attach shift->_attach_registry, @_;
		868	}
		869	_recalc_want;
		870	};
		871
		872	# all those should be optimised
		873	sub cf::attachable::detach {
		874	my ($obj, $name) = @_;
		875
		876	if (ref $obj) {
		877	delete $obj->{_attachment}{$name};
		878	reattach ($obj);
		879	} else {
		880	Carp::croak "cannot, currently, detach class attachments";
		881	}
		882	_recalc_want;
		883	};
		884
		885	sub cf::attachable::attached {
		886	my ($obj, $name) = @_;
		887
		888	exists $obj->{_attachment}{$name}
		889	}
		890
		891	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
		892	eval "#line " . __LINE__ . " 'cf.pm'
		893	sub cf::\L$klass\E::_attach_registry {
		894	(\\\@CB_$klass, KLASS_$klass)
		895	}
		896
		897	sub cf::\L$klass\E::attachment {
		898	my \$name = shift;
		899
		900	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		901	}
		902	";
		903	die if $@;
		904	}
		905
		906	our $override;
		907	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		908
		909	sub override {
		910	$override = 1;
		911	@INVOKE_RESULTS = (@_);
		912	}
		913
		914	sub do_invoke {
		915	my $event = shift;
		916	my $callbacks = shift;
		917
		918	@INVOKE_RESULTS = ();
		919
		920	local $override;
		921
		922	for (@$callbacks) {
		923	eval { &{$_->[1]} };
		924
		925	if ($@) {
		926	warn "$@";
		927	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		928	override;
		929	}
		930
		931	return 1 if $override;
		932	}
		933
		934	0
		935	}
		936
		937	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
		938
		939	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		940
		941	Generate an object-specific event with the given arguments.
		942
		943	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		944	removed in future versions), and there is no public API to access override
		945	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
		946
		947	=back
		948
		949	=cut
		950
		951	#############################################################################
		952	# object support
		953	#
		954
		955	sub _can_merge {
		956	my ($ob1, $ob2) = @_;
		957
		958	local $Storable::canonical = 1;
		959	my $fob1 = Storable::freeze $ob1;
		960	my $fob2 = Storable::freeze $ob2;
		961
		962	$fob1 eq $fob2
		963	}
		964
		965	sub reattach {
		966	# basically do the same as instantiate, without calling instantiate
		967	my ($obj) = @_;
		968
		969	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
		970
		971	my $registry = $obj->registry;
		972
		973	@$registry = ();
		974
		975	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
		976
		977	for my $name (keys %{ $obj->{_attachment} || {} }) {
		978	if (my $attach = $attachment{$name}) {
		979	for (@$attach) {
		980	my ($klass, @attach) = @$_;
		981	_attach $registry, $klass, @attach;
		982	}
		983	} else {
		984	warn "object uses attachment '$name' that is not available, postponing.\n";
		985	}
		986	}
		987	}
		988
		989	cf::attachable->attach (
		990	prio => -1000000,
		991	on_instantiate => sub {
		992	my ($obj, $data) = @_;
		993
		994	$data = from_json $data;
		995
		996	for (@$data) {
		997	my ($name, $args) = @$_;
		998
		999	$obj->attach ($name, %{$args || {} });
		1000	}
		1001	},
		1002	on_reattach => \&reattach,
		1003	on_clone => sub {
		1004	my ($src, $dst) = @_;
		1005
		1006	@{$dst->registry} = @{$src->registry};
		1007
		1008	%$dst = %$src;
		1009
		1010	%{$dst->{_attachment}} = %{$src->{_attachment}}
		1011	if exists $src->{_attachment};
		1012	},
		1013	);
		1014
		1015	sub object_freezer_save {
		1016	my ($filename, $rdata, $objs) = @_;
		1017
		1018	my $guard = cf::lock_acquire "io";
		1019
		1020	sync_job {
		1021	if (length $$rdata) {
		1022	warn sprintf "saving %s (%d,%d)\n",
		1023	$filename, length $$rdata, scalar @$objs;
		1024
		1025	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		1026	chmod SAVE_MODE, $fh;
		1027	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		1028	aio_fsync $fh if $cf::USE_FSYNC;
		1029	close $fh;
		1030
		1031	if (@$objs) {
		1032	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		1033	chmod SAVE_MODE, $fh;
		1034	my $data = Storable::nfreeze { version => 1, objs => $objs };
		1035	aio_write $fh, 0, (length $data), $data, 0;
		1036	aio_fsync $fh if $cf::USE_FSYNC;
		1037	close $fh;
		1038	aio_rename "$filename.pst~", "$filename.pst";
		1039	}
		1040	} else {
		1041	aio_unlink "$filename.pst";
		1042	}
		1043
		1044	aio_rename "$filename~", $filename;
		1045	} else {
		1046	warn "FATAL: $filename~: $!\n";
		1047	}
		1048	} else {
		1049	aio_unlink $filename;
		1050	aio_unlink "$filename.pst";
		1051	}
		1052	};
		1053
		1054	undef $guard;
		1055	}
		1056
		1057	sub object_freezer_as_string {
		1058	my ($rdata, $objs) = @_;
		1059
		1060	use Data::Dumper;
		1061
		1062	$$rdata . Dumper $objs
		1063	}
		1064
		1065	sub object_thawer_load {
		1066	my ($filename) = @_;
		1067
		1068	my ($data, $av);
		1069
		1070	my $guard = cf::lock_acquire "io";
		1071
		1072	(aio_load $filename, $data) >= 0
		1073	or return;
		1074
		1075	unless (aio_stat "$filename.pst") {
		1076	(aio_load "$filename.pst", $av) >= 0
		1077	or return;
		1078
		1079	undef $guard;
		1080	$av = eval { (Storable::thaw $av)->{objs} };
		1081	}
		1082
		1083	warn sprintf "loading %s (%d)\n",
		1084	$filename, length $data, scalar @{$av || []};
		1085
		1086	($data, $av)
		1087	}
		1088
		1089	=head2 COMMAND CALLBACKS
		1090
		1091	=over 4
		1092
		1093	=cut
		1094
		1095	#############################################################################
		1096	# command handling &c
		1097
		1098	=item cf::register_command $name => \&callback($ob,$args);
		1099
		1100	Register a callback for execution when the client sends the user command
		1101	$name.
		1102
		1103	=cut
		1104
		1105	sub register_command {
		1106	my ($name, $cb) = @_;
		1107
		1108	my $caller = caller;
		1109	#warn "registering command '$name/$time' to '$caller'";
		1110
		1111	push @{ $COMMAND{$name} }, [$caller, $cb];
		1112	}
		1113
		1114	=item cf::register_extcmd $name => \&callback($pl,$packet);
		1115
		1116	Register a callback for execution when the client sends an (synchronous)
		1117	extcmd packet. Ext commands will be processed in the order they are
		1118	received by the server, like other user commands. The first argument is
		1119	the logged-in player. Ext commands can only be processed after a player
		1120	has logged in successfully.
		1121
		1122	If the callback returns something, it is sent back as if reply was being
		1123	called.
		1124
		1125	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1126
		1127	Register a callback for execution when the client sends an (asynchronous)
		1128	exticmd packet. Exti commands are processed by the server as soon as they
		1129	are received, i.e. out of order w.r.t. other commands. The first argument
		1130	is a client socket. Exti commands can be received anytime, even before
		1131	log-in.
		1132
		1133	If the callback returns something, it is sent back as if reply was being
		1134	called.
		1135
		1136	=cut
		1137
		1138	sub register_extcmd {
		1139	my ($name, $cb) = @_;
		1140
		1141	$EXTCMD{$name} = $cb;
		1142	}
		1143
		1144	sub register_exticmd {
		1145	my ($name, $cb) = @_;
		1146
		1147	$EXTICMD{$name} = $cb;
		1148	}
		1149
		1150	cf::player->attach (
		1151	on_command => sub {
		1152	my ($pl, $name, $params) = @_;
		1153
		1154	my $cb = $COMMAND{$name}
		1155	or return;
		1156
		1157	for my $cmd (@$cb) {
		1158	$cmd->[1]->($pl->ob, $params);
		1159	}
		1160
		1161	cf::override;
		1162	},
		1163	on_extcmd => sub {
		1164	my ($pl, $buf) = @_;
		1165
		1166	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
		1167
		1168	if (ref $msg) {
		1169	my ($type, $reply, @payload) =
		1170	"ARRAY" eq ref $msg
		1171	? @$msg
		1172	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1173
		1174	my @reply;
		1175
		1176	if (my $cb = $EXTCMD{$type}) {
		1177	@reply = $cb->($pl, @payload);
		1178	}
		1179
		1180	$pl->ext_reply ($reply, @reply)
		1181	if $reply;
		1182
		1183	} else {
		1184	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		1185	}
		1186
		1187	cf::override;
		1188	},
		1189	);
		1190
		1191	sub load_extensions {
		1192	cf::sync_job {
		1193	my %todo;
		1194
		1195	for my $path (<$LIBDIR/*.ext>) {
		1196	next unless -r $path;
		1197
		1198	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1199	my $base = $1;
		1200	my $pkg = $1;
		1201	$pkg =~ s/[^[:word:]]/_/g;
		1202	$pkg = "ext::$pkg";
		1203
		1204	open my $fh, "<:utf8", $path
		1205	or die "$path: $!";
		1206
		1207	my $source = do { local $/; <$fh> };
		1208
		1209	my %ext = (
		1210	path => $path,
		1211	base => $base,
		1212	pkg => $pkg,
		1213	);
		1214
		1215	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1216	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1217
		1218	$ext{source} =
		1219	"package $pkg; use strict; use utf8;\n"
		1220	. "#line 1 \"$path\"\n{\n"
		1221	. $source
		1222	. "\n};\n1";
		1223
		1224	$todo{$base} = \%ext;
		1225	}
		1226
		1227	my %done;
		1228	while (%todo) {
		1229	my $progress;
		1230
		1231	while (my ($k, $v) = each %todo) {
		1232	for (split /,\s*/, $v->{meta}{depends}) {
		1233	goto skip
		1234	unless exists $done{$_};
		1235	}
		1236
		1237	warn "... loading '$k' into '$v->{pkg}'\n";
		1238
		1239	unless (eval $v->{source}) {
		1240	my $msg = $@ ? "$v->{path}: $@\n"
		1241	: "$v->{base}: extension inactive.\n";
		1242
		1243	if (exists $v->{meta}{mandatory}) {
		1244	warn $msg;
		1245	warn "mandatory extension failed to load, exiting.\n";
		1246	exit 1;
		1247	}
		1248
		1249	warn $msg;
		1250	}
		1251
		1252	$done{$k} = delete $todo{$k};
		1253	push @EXTS, $v->{pkg};
		1254	$progress = 1;
		1255	}
		1256
		1257	skip:
		1258	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1259	unless $progress;
		1260	}
		1261	};
		1262	}
		1263
		1264	#############################################################################
		1265
		1266	=back
		1267
		1268	=head2 CORE EXTENSIONS
		1269
		1270	Functions and methods that extend core crossfire objects.
		1271
		1272	=cut
		1273
		1274	package cf::player;
		1275
		1276	use Coro::AIO;
		1277
		1278	=head3 cf::player
		1279
		1280	=over 4
		1281
		1282	=item cf::player::find $login
		1283
		1284	Returns the given player object, loading it if necessary (might block).
		1285
		1286	=cut
		1287
		1288	sub playerdir($) {
		1289	"$PLAYERDIR/"
		1290	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		1291	}
		1292
		1293	sub path($) {
		1294	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		1295
		1296	(playerdir $login) . "/playerdata"
		1297	}
		1298
		1299	sub find_active($) {
		1300	$cf::PLAYER{$_[0]}
		1301	and $cf::PLAYER{$_[0]}->active
		1302	and $cf::PLAYER{$_[0]}
		1303	}
		1304
		1305	sub exists($) {
		1306	my ($login) = @_;
		1307
		1308	$cf::PLAYER{$login}
		1309	or cf::sync_job { !aio_stat path $login }
		1310	}
		1311
		1312	sub find($) {
		1313	return $cf::PLAYER{$_[0]} || do {
		1314	my $login = $_[0];
		1315
		1316	my $guard = cf::lock_acquire "user_find:$login";
		1317
		1318	$cf::PLAYER{$_[0]} || do {
		1319	# rename old playerfiles to new ones
		1320	#TODO: remove when no longer required
		1321	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1322	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1323	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1324	aio_unlink +(playerdir $login) . "/$login.pl";
		1325
		1326	my $f = new_from_file cf::object::thawer path $login
		1327	or return;
		1328
		1329	$f->next;
		1330	my $pl = cf::player::load_pl $f
		1331	or return;
		1332	local $cf::PLAYER_LOADING{$login} = $pl;
		1333	$f->resolve_delayed_derefs;
		1334	$cf::PLAYER{$login} = $pl
		1335	}
		1336	}
		1337	}
		1338
		1339	sub save($) {
		1340	my ($pl) = @_;
		1341
		1342	return if $pl->{deny_save};
		1343
		1344	my $path = path $pl;
		1345	my $guard = cf::lock_acquire "user_save:$path";
		1346
		1347	return if $pl->{deny_save};
		1348
		1349	aio_mkdir playerdir $pl, 0770;
		1350	$pl->{last_save} = $cf::RUNTIME;
		1351
		1352	$pl->save_pl ($path);
		1353	cf::cede_to_tick;
		1354	}
		1355
		1356	sub new($) {
		1357	my ($login) = @_;
		1358
		1359	my $self = create;
		1360
		1361	$self->ob->name ($login);
		1362	$self->{deny_save} = 1;
		1363
		1364	$cf::PLAYER{$login} = $self;
		1365
		1366	$self
		1367	}
		1368
		1369	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1370
		1371	=cut
		1372
		1373	sub send_msg {
		1374	my $ns = shift->ns
		1375	or return;
		1376	$ns->send_msg (@_);
		1377	}
		1378
		1379	=item $pl->quit_character
		1380
		1381	Nukes the player without looking back. If logged in, the connection will
		1382	be destroyed. May block for a long time.
		1383
		1384	=cut
		1385
		1386	sub quit_character {
		1387	my ($pl) = @_;
		1388
		1389	my $name = $pl->ob->name;
		1390
		1391	$pl->{deny_save} = 1;
		1392	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1393
		1394	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1395	$pl->deactivate;
		1396	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1397	$pl->ns->destroy if $pl->ns;
		1398
		1399	my $path = playerdir $pl;
		1400	my $temp = "$path~$cf::RUNTIME~deleting~";
		1401	aio_rename $path, $temp;
		1402	delete $cf::PLAYER{$pl->ob->name};
		1403	$pl->destroy;
		1404
		1405	my $prefix = qr<^~\Q$name\E/>;
		1406
		1407	# nuke player maps
		1408	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1409
		1410	IO::AIO::aio_rmtree $temp;
		1411	}
		1412
		1413	=item $pl->kick
		1414
		1415	Kicks a player out of the game. This destroys the connection.
		1416
		1417	=cut
		1418
		1419	sub kick {
		1420	my ($pl, $kicker) = @_;
		1421
		1422	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1423	$pl->killer ("kicked");
		1424	$pl->ns->destroy;
		1425	}
		1426
		1427	=item cf::player::list_logins
		1428
		1429	Returns am arrayref of all valid playernames in the system, can take a
		1430	while and may block, so not sync_job-capable, ever.
		1431
		1432	=cut
		1433
		1434	sub list_logins {
		1435	my $dirs = aio_readdir $PLAYERDIR
		1436	or return [];
		1437
		1438	my @logins;
		1439
		1440	for my $login (@$dirs) {
		1441	my $path = path $login;
		1442
		1443	# a .pst is a dead give-away for a valid player
		1444	unless (-e "$path.pst") {
		1445	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
		1446	aio_read $fh, 0, 512, my $buf, 0 or next;
		1447	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1448	}
		1449
		1450	utf8::decode $login;
		1451	push @logins, $login;
		1452	}
		1453
		1454	\@logins
		1455	}
		1456
		1457	=item $player->maps
		1458
		1459	Returns an arrayref of map paths that are private for this
		1460	player. May block.
		1461
		1462	=cut
		1463
		1464	sub maps($) {
		1465	my ($pl) = @_;
		1466
		1467	$pl = ref $pl ? $pl->ob->name : $pl;
		1468
		1469	my $files = aio_readdir playerdir $pl
		1470	or return;
		1471
		1472	my @paths;
		1473
		1474	for (@$files) {
		1475	utf8::decode $_;
		1476	next if /\.(?:pl|pst)$/;
		1477	next unless /^$PATH_SEP/o;
		1478
		1479	push @paths, cf::map::normalise "~$pl/$_";
		1480	}
		1481
		1482	\@paths
		1483	}
		1484
		1485	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1486
		1487	Expand crossfire pod fragments into protocol xml.
		1488
		1489	=cut
		1490
		1491	sub expand_cfpod {
		1492	((my $self), (local $_)) = @_;
		1493
		1494	# escape & and <
		1495	s/&/&amp;/g;
		1496	s/(?<![BIUGHT])</&lt;/g;
		1497
		1498	# this is buggy, it needs to properly take care of nested <'s
		1499
		1500	1 while
		1501	# replace B<>, I<>, U<> etc.
		1502	s/B<([^\>]*)>/<b>$1<\/b>/
		1503	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1504	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1505	|| s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
		1506	# replace G<male|female> tags
		1507	|| s{G<([^>|]*)\|([^>]*)>}{
		1508	$self->gender ? $2 : $1
		1509	}ge
		1510	# replace H<hint text>
		1511	|| s{H<([^\>]*)>}
		1512	{
		1513	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1514	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1515	"")
		1516	[$self->{hintmode}]
		1517	}ge;
		1518
		1519	# create single paragraphs (very hackish)
		1520	s/(?<=\S)\n(?=\w)/ /g;
		1521
		1522	# compress some whitespace
		1523	s/\s+\n/\n/g; # ws line-ends
		1524	s/\n\n+/\n/g; # double lines
		1525	s/^\n+//; # beginning lines
		1526	s/\n+$//; # ending lines
		1527
		1528	$_
		1529	}
		1530
		1531	sub hintmode {
		1532	$_[0]{hintmode} = $_[1] if @_ > 1;
		1533	$_[0]{hintmode}
		1534	}
		1535
		1536	=item $player->ext_reply ($msgid, @msg)
		1537
		1538	Sends an ext reply to the player.
		1539
		1540	=cut
		1541
		1542	sub ext_reply($$@) {
		1543	my ($self, $id, @msg) = @_;
		1544
		1545	$self->ns->ext_reply ($id, @msg)
		1546	}
		1547
		1548	=item $player->ext_msg ($type, @msg)
		1549
		1550	Sends an ext event to the client.
		1551
		1552	=cut
		1553
		1554	sub ext_msg($$@) {
		1555	my ($self, $type, @msg) = @_;
		1556
		1557	$self->ns->ext_msg ($type, @msg);
		1558	}
		1559
		1560	=head3 cf::region
		1561
		1562	=over 4
		1563
		1564	=cut
		1565
		1566	package cf::region;
		1567
		1568	=item cf::region::find_by_path $path
		1569
		1570	Tries to decuce the likely region for a map knowing only its path.
		1571
		1572	=cut
		1573
		1574	sub find_by_path($) {
		1575	my ($path) = @_;
		1576
		1577	my ($match, $specificity);
		1578
		1579	for my $region (list) {
		1580	if ($region->{match} && $path =~ $region->{match}) {
		1581	($match, $specificity) = ($region, $region->specificity)
		1582	if $region->specificity > $specificity;
		1583	}
		1584	}
		1585
		1586	$match
		1587	}
		1588
		1589	=back
		1590
		1591	=head3 cf::map
		1592
		1593	=over 4
		1594
		1595	=cut
		1596
		1597	package cf::map;
		1598
		1599	use Fcntl;
		1600	use Coro::AIO;
		1601
		1602	use overload
		1603	'""' => \&as_string,
		1604	fallback => 1;
		1605
		1606	our $MAX_RESET = 3600;
		1607	our $DEFAULT_RESET = 3000;
		1608
		1609	sub generate_random_map {
		1610	my ($self, $rmp) = @_;
		1611	# mit "rum" bekleckern, nicht
		1612	$self->_create_random_map (
		1613	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1614	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1615	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1616	$rmp->{exit_on_final_map},
		1617	$rmp->{xsize}, $rmp->{ysize},
		1618	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1619	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1620	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1621	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1622	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1623	(cf::region::find $rmp->{region}), $rmp->{custom}
		1624	)
		1625	}
		1626
		1627	=item cf::map->register ($regex, $prio)
		1628
		1629	Register a handler for the map path matching the given regex at the
		1630	givne priority (higher is better, built-in handlers have priority 0, the
		1631	default).
		1632
		1633	=cut
		1634
		1635	sub register {
		1636	my (undef, $regex, $prio) = @_;
		1637	my $pkg = caller;
		1638
		1639	no strict;
		1640	push @{"$pkg\::ISA"}, __PACKAGE__;
		1641
		1642	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1643	}
		1644
		1645	# also paths starting with '/'
		1646	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1647
		1648	sub thawer_merge {
		1649	my ($self, $merge) = @_;
		1650
		1651	# we have to keep some variables in memory intact
		1652	local $self->{path};
		1653	local $self->{load_path};
		1654
		1655	$self->SUPER::thawer_merge ($merge);
		1656	}
		1657
		1658	sub normalise {
		1659	my ($path, $base) = @_;
		1660
		1661	$path = "$path"; # make sure its a string
		1662
		1663	$path =~ s/\.map$//;
		1664
		1665	# map plan:
		1666	#
		1667	# /! non-realised random map exit (special hack!)
		1668	# {... are special paths that are not being touched
		1669	# ?xxx/... are special absolute paths
		1670	# ?random/... random maps
		1671	# /... normal maps
		1672	# ~user/... per-player map of a specific user
		1673
		1674	$path =~ s/$PATH_SEP/\//go;
		1675
		1676	# treat it as relative path if it starts with
		1677	# something that looks reasonable
		1678	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1679	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1680
		1681	$base =~ s{[^/]+/?$}{};
		1682	$path = "$base/$path";
		1683	}
		1684
		1685	for ($path) {
		1686	redo if s{//}{/};
		1687	redo if s{/\.?/}{/};
		1688	redo if s{/[^/]+/\.\./}{/};
		1689	}
		1690
		1691	$path
		1692	}
		1693
		1694	sub new_from_path {
		1695	my (undef, $path, $base) = @_;
		1696
		1697	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1698
		1699	$path = normalise $path, $base;
		1700
		1701	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1702	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1703	my $self = bless cf::map::new, $pkg;
		1704	$self->{path} = $path; $self->path ($path);
		1705	$self->init; # pass $1 etc.
		1706	return $self;
		1707	}
		1708	}
		1709
		1710	Carp::cluck "unable to resolve path '$path' (base '$base').";
		1711	()
		1712	}
		1713
		1714	sub init {
		1715	my ($self) = @_;
		1716
		1717	$self
		1718	}
		1719
		1720	sub as_string {
		1721	my ($self) = @_;
		1722
		1723	"$self->{path}"
		1724	}
		1725
		1726	# the displayed name, this is a one way mapping
		1727	sub visible_name {
		1728	&as_string
		1729	}
		1730
		1731	# the original (read-only) location
		1732	sub load_path {
		1733	my ($self) = @_;
		1734
		1735	"$MAPDIR/$self->{path}.map"
		1736	}
		1737
		1738	# the temporary/swap location
		1739	sub save_path {
		1740	my ($self) = @_;
		1741
		1742	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1743	"$TMPDIR/$path.map"
		1744	}
		1745
		1746	# the unique path, undef == no special unique path
		1747	sub uniq_path {
		1748	my ($self) = @_;
		1749
		1750	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1751	"$UNIQUEDIR/$path"
		1752	}
		1753
		1754	# and all this just because we cannot iterate over
		1755	# all maps in C++...
		1756	sub change_all_map_light {
		1757	my ($change) = @_;
		1758
		1759	$_->change_map_light ($change)
		1760	for grep $_->outdoor, values %cf::MAP;
		1761	}
		1762
		1763	sub decay_objects {
		1764	my ($self) = @_;
		1765
		1766	return if $self->{deny_reset};
		1767
		1768	$self->do_decay_objects;
		1769	}
		1770
		1771	sub unlink_save {
		1772	my ($self) = @_;
		1773
		1774	utf8::encode (my $save = $self->save_path);
		1775	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1776	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1777	}
		1778
		1779	sub load_header_from($) {
		1780	my ($self, $path) = @_;
		1781
		1782	utf8::encode $path;
		1783	my $f = new_from_file cf::object::thawer $path
		1784	or return;
		1785
		1786	$self->_load_header ($f)
		1787	or return;
		1788
		1789	local $MAP_LOADING{$self->{path}} = $self;
		1790	$f->resolve_delayed_derefs;
		1791
		1792	$self->{load_path} = $path;
		1793
		1794	1
		1795	}
		1796
		1797	sub load_header_orig {
		1798	my ($self) = @_;
		1799
		1800	$self->load_header_from ($self->load_path)
		1801	}
		1802
		1803	sub load_header_temp {
		1804	my ($self) = @_;
		1805
		1806	$self->load_header_from ($self->save_path)
		1807	}
		1808
		1809	sub prepare_temp {
		1810	my ($self) = @_;
		1811
		1812	$self->last_access ((delete $self->{last_access})
		1813	|| $cf::RUNTIME); #d#
		1814	# safety
		1815	$self->{instantiate_time} = $cf::RUNTIME
		1816	if $self->{instantiate_time} > $cf::RUNTIME;
		1817	}
		1818
		1819	sub prepare_orig {
		1820	my ($self) = @_;
		1821
		1822	$self->{load_original} = 1;
		1823	$self->{instantiate_time} = $cf::RUNTIME;
		1824	$self->last_access ($cf::RUNTIME);
		1825	$self->instantiate;
		1826	}
		1827
		1828	sub load_header {
		1829	my ($self) = @_;
		1830
		1831	if ($self->load_header_temp) {
		1832	$self->prepare_temp;
		1833	} else {
		1834	$self->load_header_orig
		1835	or return;
		1836	$self->prepare_orig;
		1837	}
		1838
		1839	$self->{deny_reset} = 1
		1840	if $self->no_reset;
		1841
		1842	$self->default_region (cf::region::find_by_path $self->{path})
		1843	unless $self->default_region;
		1844
		1845	1
		1846	}
		1847
		1848	sub find;
		1849	sub find {
		1850	my ($path, $origin) = @_;
		1851
		1852	$path = normalise $path, $origin && $origin->path;
		1853
		1854	cf::lock_wait "map_data:$path";#d#remove
		1855	cf::lock_wait "map_find:$path";
		1856
		1857	$cf::MAP{$path} || do {
		1858	my $guard1 = cf::lock_acquire "map_find:$path";
		1859	my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
		1860
		1861	my $map = new_from_path cf::map $path
		1862	or return;
		1863
		1864	$map->{last_save} = $cf::RUNTIME;
		1865
		1866	$map->load_header
		1867	or return;
		1868
		1869	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1870	# doing this can freeze the server in a sync job, obviously
		1871	#$cf::WAIT_FOR_TICK->wait;
		1872	undef $guard1;
		1873	undef $guard2;
		1874	$map->reset;
		1875	return find $path;
		1876	}
		1877
		1878	$cf::MAP{$path} = $map
		1879	}
		1880	}
		1881
		1882	sub pre_load { }
		1883	sub post_load { }
		1884
		1885	sub load {
		1886	my ($self) = @_;
		1887
		1888	local $self->{deny_reset} = 1; # loading can take a long time
		1889
		1890	my $path = $self->{path};
		1891
		1892	{
		1893	my $guard = cf::lock_acquire "map_data:$path";
		1894
		1895	return unless $self->valid;
		1896	return if $self->in_memory != cf::MAP_SWAPPED;
		1897
		1898	$self->in_memory (cf::MAP_LOADING);
		1899
		1900	$self->alloc;
		1901
		1902	$self->pre_load;
		1903	cf::cede_to_tick;
		1904
		1905	my $f = new_from_file cf::object::thawer $self->{load_path};
		1906	$f->skip_block;
		1907	$self->_load_objects ($f)
		1908	or return;
		1909
		1910	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1911	if delete $self->{load_original};
		1912
		1913	if (my $uniq = $self->uniq_path) {
		1914	utf8::encode $uniq;
		1915	unless (aio_stat $uniq) {
		1916	if (my $f = new_from_file cf::object::thawer $uniq) {
		1917	$self->clear_unique_items;
		1918	$self->_load_objects ($f);
		1919	$f->resolve_delayed_derefs;
		1920	}
		1921	}
		1922	}
		1923
		1924	$f->resolve_delayed_derefs;
		1925
		1926	cf::cede_to_tick;
		1927	# now do the right thing for maps
		1928	$self->link_multipart_objects;
		1929	$self->difficulty ($self->estimate_difficulty)
		1930	unless $self->difficulty;
		1931	cf::cede_to_tick;
		1932
		1933	unless ($self->{deny_activate}) {
		1934	$self->decay_objects;
		1935	$self->fix_auto_apply;
		1936	$self->update_buttons;
		1937	cf::cede_to_tick;
		1938	$self->set_darkness_map;
		1939	cf::cede_to_tick;
		1940	$self->activate;
		1941	}
		1942
		1943	$self->{last_save} = $cf::RUNTIME;
		1944	$self->last_access ($cf::RUNTIME);
		1945
		1946	$self->in_memory (cf::MAP_IN_MEMORY);
		1947	}
		1948
		1949	$self->post_load;
		1950	}
		1951
		1952	sub customise_for {
		1953	my ($self, $ob) = @_;
		1954
		1955	return find "~" . $ob->name . "/" . $self->{path}
		1956	if $self->per_player;
		1957
		1958	# return find "?party/" . $ob->name . "/" . $self->{path}
		1959	# if $self->per_party;
		1960
		1961	$self
		1962	}
		1963
		1964	# find and load all maps in the 3x3 area around a map
		1965	sub load_neighbours {
		1966	my ($map) = @_;
		1967
		1968	my @neigh; # diagonal neighbours
		1969
		1970	for (0 .. 3) {
		1971	my $neigh = $map->tile_path ($_)
		1972	or next;
		1973	$neigh = find $neigh, $map
		1974	or next;
		1975	$neigh->load;
		1976
		1977	push @neigh,
		1978	[$neigh->tile_path (($_ + 3) % 4), $neigh],
		1979	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1980	}
		1981
		1982	for (grep defined $_->[0], @neigh) {
		1983	my ($path, $origin) = @$_;
		1984	my $neigh = find $path, $origin
		1985	or next;
		1986	$neigh->load;
		1987	}
		1988	}
		1989
		1990	sub find_sync {
		1991	my ($path, $origin) = @_;
		1992
		1993	cf::sync_job { find $path, $origin }
		1994	}
		1995
		1996	sub do_load_sync {
		1997	my ($map) = @_;
		1998
		1999	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2000	if $Coro::current == $Coro::main;
		2001
		2002	cf::sync_job { $map->load };
		2003	}
		2004
		2005	our %MAP_PREFETCH;
		2006	our $MAP_PREFETCHER = undef;
		2007
		2008	sub find_async {
		2009	my ($path, $origin, $load) = @_;
		2010
		2011	$path = normalise $path, $origin && $origin->{path};
		2012
		2013	if (my $map = $cf::MAP{$path}) {
		2014	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
		2015	}
		2016
		2017	$MAP_PREFETCH{$path} |= $load;
		2018
		2019	$MAP_PREFETCHER ||= cf::async {
		2020	while (%MAP_PREFETCH) {
		2021	while (my ($k, $v) = each %MAP_PREFETCH) {
		2022	if (my $map = find $k) {
		2023	$map->load if $v;
		2024	}
		2025
		2026	delete $MAP_PREFETCH{$k};
		2027	}
		2028	}
		2029	undef $MAP_PREFETCHER;
		2030	};
		2031	$MAP_PREFETCHER->prio (6);
		2032
		2033	()
		2034	}
		2035
		2036	sub save {
		2037	my ($self) = @_;
		2038
		2039	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2040
		2041	$self->{last_save} = $cf::RUNTIME;
		2042
		2043	return unless $self->dirty;
		2044
		2045	my $save = $self->save_path; utf8::encode $save;
		2046	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2047
		2048	$self->{load_path} = $save;
		2049
		2050	return if $self->{deny_save};
		2051
		2052	local $self->{last_access} = $self->last_access;#d#
		2053
		2054	cf::async {
		2055	$_->contr->save for $self->players;
		2056	};
		2057
		2058	if ($uniq) {
		2059	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		2060	$self->_save_objects ($uniq, cf::IO_UNIQUES);
		2061	} else {
		2062	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
		2063	}
		2064	}
		2065
		2066	sub swap_out {
		2067	my ($self) = @_;
		2068
		2069	# save first because save cedes
		2070	$self->save;
		2071
		2072	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2073
		2074	return if $self->players;
		2075	return if $self->in_memory != cf::MAP_IN_MEMORY;
		2076	return if $self->{deny_save};
		2077
		2078	$self->in_memory (cf::MAP_SWAPPED);
		2079
		2080	$self->deactivate;
		2081	$_->clear_links_to ($self) for values %cf::MAP;
		2082	$self->clear;
		2083	}
		2084
		2085	sub reset_at {
		2086	my ($self) = @_;
		2087
		2088	# TODO: safety, remove and allow resettable per-player maps
		2089	return 1e99 if $self->{deny_reset};
		2090
		2091	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		2092	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		2093
		2094	$time + $to
		2095	}
		2096
		2097	sub should_reset {
		2098	my ($self) = @_;
		2099
		2100	$self->reset_at <= $cf::RUNTIME
		2101	}
		2102
		2103	sub reset {
		2104	my ($self) = @_;
		2105
		2106	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2107
		2108	return if $self->players;
		2109
		2110	warn "resetting map ", $self->path;
		2111
		2112	$self->in_memory (cf::MAP_SWAPPED);
		2113
		2114	# need to save uniques path
		2115	unless ($self->{deny_save}) {
		2116	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2117
		2118	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2119	if $uniq;
		2120	}
		2121
		2122	delete $cf::MAP{$self->path};
		2123
		2124	$self->deactivate;
		2125	$_->clear_links_to ($self) for values %cf::MAP;
		2126	$self->clear;
		2127
		2128	$self->unlink_save;
		2129	$self->destroy;
		2130	}
		2131
		2132	my $nuke_counter = "aaaa";
		2133
		2134	sub nuke {
		2135	my ($self) = @_;
		2136
		2137	{
		2138	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2139
		2140	delete $cf::MAP{$self->path};
		2141
		2142	$self->unlink_save;
		2143
		2144	bless $self, "cf::map";
		2145	delete $self->{deny_reset};
		2146	$self->{deny_save} = 1;
		2147	$self->reset_timeout (1);
		2148	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2149
		2150	$cf::MAP{$self->path} = $self;
		2151	}
		2152
		2153	$self->reset; # polite request, might not happen
		2154	}
		2155
		2156	=item $maps = cf::map::tmp_maps
		2157
		2158	Returns an arrayref with all map paths of currently instantiated and saved
		2159	maps. May block.
		2160
		2161	=cut
		2162
		2163	sub tmp_maps() {
		2164	[
		2165	map {
		2166	utf8::decode $_;
		2167	/\.map$/
		2168	? normalise $_
		2169	: ()
		2170	} @{ aio_readdir $TMPDIR or [] }
		2171	]
		2172	}
		2173
		2174	=item $maps = cf::map::random_maps
		2175
		2176	Returns an arrayref with all map paths of currently instantiated and saved
		2177	random maps. May block.
		2178
		2179	=cut
		2180
		2181	sub random_maps() {
		2182	[
		2183	map {
		2184	utf8::decode $_;
		2185	/\.map$/
		2186	? normalise "?random/$_"
		2187	: ()
		2188	} @{ aio_readdir $RANDOMDIR or [] }
		2189	]
		2190	}
		2191
		2192	=item cf::map::unique_maps
		2193
		2194	Returns an arrayref of paths of all shared maps that have
		2195	instantiated unique items. May block.
		2196
		2197	=cut
		2198
		2199	sub unique_maps() {
		2200	[
		2201	map {
		2202	utf8::decode $_;
		2203	/\.map$/
		2204	? normalise $_
		2205	: ()
		2206	} @{ aio_readdir $UNIQUEDIR or [] }
		2207	]
		2208	}
		2209
		2210	package cf;
		2211
		2212	=back
		2213
		2214	=head3 cf::object
		2215
		2216	=cut
		2217
		2218	package cf::object;
		2219
		2220	=over 4
		2221
		2222	=item $ob->inv_recursive
		2223
		2224	Returns the inventory of the object _and_ their inventories, recursively.
		2225
		2226	=cut
		2227
		2228	sub inv_recursive_;
		2229	sub inv_recursive_ {
		2230	map { $_, inv_recursive_ $_->inv } @_
		2231	}
		2232
		2233	sub inv_recursive {
		2234	inv_recursive_ inv $_[0]
		2235	}
		2236
		2237	=item $ref = $ob->ref
		2238
		2239	creates and returns a persistent reference to an objetc that can be stored as a string.
		2240
		2241	=item $ob = cf::object::deref ($refstring)
		2242
		2243	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2244	even if the object actually exists. May block.
		2245
		2246	=cut
		2247
		2248	sub deref {
		2249	my ($ref) = @_;
		2250
		2251	# temporary compatibility#TODO#remove
		2252	$ref =~ s{^<}{player/<};
		2253
		2254	if ($ref =~ m{^player\/(<1\.\d+>)/(.*)$}) {
		2255	my ($uuid, $name) = ($1, $2);
		2256	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2257	or return;
		2258	$pl->ob->uuid eq $uuid
		2259	or return;
		2260
		2261	$pl->ob
		2262	} else {
		2263	warn "$ref: cannot resolve object reference\n";
		2264	undef
		2265	}
		2266	}
		2267
		2268	package cf;
		2269
		2270	=back
		2271
		2272	=head3 cf::object::player
		2273
		2274	=over 4
		2275
		2276	=item $player_object->reply ($npc, $msg[, $flags])
		2277
		2278	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
		2279	can be C<undef>. Does the right thing when the player is currently in a
		2280	dialogue with the given NPC character.
		2281
		2282	=cut
		2283
		2284	# rough implementation of a future "reply" method that works
		2285	# with dialog boxes.
		2286	#TODO: the first argument must go, split into a $npc->reply_to ( method
		2287	sub cf::object::player::reply($$$;$) {
		2288	my ($self, $npc, $msg, $flags) = @_;
		2289
		2290	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
		2291
		2292	if ($self->{record_replies}) {
		2293	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2294
		2295	} else {
		2296	my $pl = $self->contr;
		2297
		2298	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2299	my $dialog = $pl->{npc_dialog};
		2300	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2301
		2302	} else {
		2303	$msg = $npc->name . " says: $msg" if $npc;
		2304	$self->message ($msg, $flags);
		2305	}
		2306	}
		2307	}
		2308
		2309	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2310
		2311	=cut
		2312
		2313	sub cf::object::send_msg {
		2314	my $pl = shift->contr
		2315	or return;
		2316	$pl->send_msg (@_);
		2317	}
		2318
		2319	=item $player_object->may ("access")
		2320
		2321	Returns wether the given player is authorized to access resource "access"
		2322	(e.g. "command_wizcast").
		2323
		2324	=cut
		2325
		2326	sub cf::object::player::may {
		2327	my ($self, $access) = @_;
		2328
		2329	$self->flag (cf::FLAG_WIZ) ||
		2330	(ref $cf::CFG{"may_$access"}
		2331	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		2332	: $cf::CFG{"may_$access"})
		2333	}
		2334
		2335	=item $player_object->enter_link
		2336
		2337	Freezes the player and moves him/her to a special map (C<{link}>).
		2338
		2339	The player should be reasonably safe there for short amounts of time. You
		2340	I<MUST> call C<leave_link> as soon as possible, though.
		2341
		2342	Will never block.
		2343
		2344	=item $player_object->leave_link ($map, $x, $y)
		2345
		2346	Moves the player out of the special C<{link}> map onto the specified
		2347	map. If the map is not valid (or omitted), the player will be moved back
		2348	to the location he/she was before the call to C<enter_link>, or, if that
		2349	fails, to the emergency map position.
		2350
		2351	Might block.
		2352
		2353	=cut
		2354
		2355	sub link_map {
		2356	unless ($LINK_MAP) {
		2357	$LINK_MAP = cf::map::find "{link}"
		2358	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2359	$LINK_MAP->load;
		2360	}
		2361
		2362	$LINK_MAP
		2363	}
		2364
		2365	sub cf::object::player::enter_link {
		2366	my ($self) = @_;
		2367
		2368	$self->deactivate_recursive;
		2369
		2370	return if UNIVERSAL::isa $self->map, "ext::map_link";
		2371
		2372	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		2373	if $self->map && $self->map->{path} ne "{link}";
		2374
		2375	$self->enter_map ($LINK_MAP || link_map, 10, 10);
		2376	}
		2377
		2378	sub cf::object::player::leave_link {
		2379	my ($self, $map, $x, $y) = @_;
		2380
		2381	return unless $self->contr->active;
		2382
		2383	my $link_pos = delete $self->{_link_pos};
		2384
		2385	unless ($map) {
		2386	# restore original map position
		2387	($map, $x, $y) = @{ $link_pos || [] };
		2388	$map = cf::map::find $map;
		2389
		2390	unless ($map) {
		2391	($map, $x, $y) = @$EMERGENCY_POSITION;
		2392	$map = cf::map::find $map
		2393	or die "FATAL: cannot load emergency map\n";
		2394	}
		2395	}
		2396
		2397	($x, $y) = (-1, -1)
		2398	unless (defined $x) && (defined $y);
		2399
		2400	# use -1 or undef as default coordinates, not 0, 0
		2401	($x, $y) = ($map->enter_x, $map->enter_y)
		2402	if $x <=0 && $y <= 0;
		2403
		2404	$map->load;
		2405	$map->load_neighbours;
		2406
		2407	return unless $self->contr->active;
		2408	$self->activate_recursive;
		2409
		2410	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
		2411	$self->enter_map ($map, $x, $y);
		2412	}
		2413
		2414	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
		2415
		2416	Moves the player to the given map-path and coordinates by first freezing
		2417	her, loading and preparing them map, calling the provided $check callback
		2418	that has to return the map if sucecssful, and then unfreezes the player on
		2419	the new (success) or old (failed) map position. In either case, $done will
		2420	be called at the end of this process.
		2421
		2422	=cut
		2423
		2424	our $GOTOGEN;
		2425
		2426	sub cf::object::player::goto {
		2427	my ($self, $path, $x, $y, $check, $done) = @_;
		2428
		2429	# do generation counting so two concurrent goto's will be executed in-order
		2430	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
		2431
		2432	$self->enter_link;
		2433
		2434	(async {
		2435	my $map = eval {
		2436	my $map = cf::map::find $path;
		2437
		2438	if ($map) {
		2439	$map = $map->customise_for ($self);
		2440	$map = $check->($map) if $check && $map;
		2441	} else {
		2442	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2443	}
		2444
		2445	$map
46	};	2446	};
		2447
		2448	if ($@) {
		2449	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2450	LOG llevError | logBacktrace, Carp::longmess $@;
		2451	}
		2452
		2453	if ($gen == $self->{_goto_generation}) {
		2454	delete $self->{_goto_generation};
		2455	$self->leave_link ($map, $x, $y);
		2456	}
		2457
		2458	$done->() if $done;
		2459	})->prio (1);
		2460	}
		2461
		2462	=item $player_object->enter_exit ($exit_object)
		2463
		2464	=cut
		2465
		2466	sub parse_random_map_params {
		2467	my ($spec) = @_;
		2468
		2469	my $rmp = { # defaults
		2470	xsize => (cf::rndm 15, 40),
		2471	ysize => (cf::rndm 15, 40),
		2472	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2473	#layout => string,
47	}	2474	};
48	}
49		2475
50	# auto-generate most of the API	2476	for (split /\n/, $spec) {
		2477	my ($k, $v) = split /\s+/, $_, 2;
51		2478
52	prop_gen OBJECT_PROP => "cf::object";	2479	$rmp->{lc $k} = $v if (length $k) && (length $v);
53	# CFAPI_OBJECT_ANIMATION?	2480	}
54	prop_gen PLAYER_PROP => "cf::object::player";
55		2481
56	prop_gen MAP_PROP => "cf::map";	2482	$rmp
57	prop_gen ARCH_PROP => "cf::arch";	2483	}
58		2484
59	# guessed hierarchies	2485	sub prepare_random_map {
		2486	my ($exit) = @_;
60		2487
61	@cf::object::player::ISA = 'cf::object';	2488	my $guard = cf::lock_acquire "exit_prepare:$exit";
62	@cf::object::map::ISA = 'cf::object';
63		2489
64	my %ext_pkg;	2490	# all this does is basically replace the /! path by
65	my @exts;	2491	# a new random map path (?random/...) with a seed
66	my @hook;	2492	# that depends on the exit object
67	my %command;
68		2493
69	sub inject_event {	2494	my $rmp = parse_random_map_params $exit->msg;
		2495
		2496	if ($exit->map) {
		2497	$rmp->{region} = $exit->region->name;
		2498	$rmp->{origin_map} = $exit->map->path;
		2499	$rmp->{origin_x} = $exit->x;
		2500	$rmp->{origin_y} = $exit->y;
		2501	}
		2502
		2503	$rmp->{random_seed} ||= $exit->random_seed;
		2504
		2505	my $data = cf::to_json $rmp;
		2506	my $md5 = Digest::MD5::md5_hex $data;
		2507	my $meta = "$RANDOMDIR/$md5.meta";
		2508
		2509	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		2510	aio_write $fh, 0, (length $data), $data, 0;
		2511	undef $fh;
		2512	aio_rename "$meta~", $meta;
		2513
		2514	$exit->slaying ("?random/$md5");
		2515	$exit->msg (undef);
		2516	}
		2517	}
		2518
		2519	sub cf::object::player::enter_exit {
		2520	my ($self, $exit) = @_;
		2521
		2522	return unless $self->type == cf::PLAYER;
		2523
		2524	if ($exit->slaying eq "/!") {
		2525	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2526	# the problem is that $exit might not survive long enough
		2527	# so it needs to be done right now, right here
		2528	cf::sync_job { prepare_random_map $exit };
		2529	}
		2530
		2531	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2532	my $hp = $exit->stats->hp;
		2533	my $sp = $exit->stats->sp;
		2534
		2535	$self->enter_link;
		2536
		2537	# if exit is damned, update players death & WoR home-position
		2538	$self->contr->savebed ($slaying, $hp, $sp)
		2539	if $exit->flag (FLAG_DAMNED);
		2540
		2541	(async {
		2542	$self->deactivate_recursive; # just to be sure
		2543	unless (eval {
		2544	$self->goto ($slaying, $hp, $sp);
		2545
		2546	1;
		2547	}) {
		2548	$self->message ("Something went wrong deep within the crossfire server. "
		2549	. "I'll try to bring you back to the map you were before. "
		2550	. "Please report this to the dungeon master!",
		2551	cf::NDI_UNIQUE | cf::NDI_RED);
		2552
		2553	warn "ERROR in enter_exit: $@";
		2554	$self->leave_link;
		2555	}
		2556	})->prio (1);
		2557	}
		2558
		2559	=head3 cf::client
		2560
		2561	=over 4
		2562
		2563	=item $client->send_drawinfo ($text, $flags)
		2564
		2565	Sends a drawinfo packet to the client. Circumvents output buffering so
		2566	should not be used under normal circumstances.
		2567
		2568	=cut
		2569
		2570	sub cf::client::send_drawinfo {
		2571	my ($self, $text, $flags) = @_;
		2572
		2573	utf8::encode $text;
		2574	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
		2575	}
		2576
		2577	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2578
		2579	Send a drawinfo or msg packet to the client, formatting the msg for the
		2580	client if neccessary. C<$type> should be a string identifying the type of
		2581	the message, with C<log> being the default. If C<$color> is negative, suppress
		2582	the message unless the client supports the msg packet.
		2583
		2584	=cut
		2585
		2586	our %CHANNEL = (
		2587	"c/identify" => {
		2588	id => "identify",
		2589	title => "Identify",
		2590	reply => undef,
		2591	tooltip => "Items recently identified",
		2592	},
		2593	"c/examine" => {
		2594	id => "examine",
		2595	title => "Examine",
		2596	reply => undef,
		2597	tooltip => "Signs and other items you examined",
		2598	},
		2599	);
		2600
		2601	sub cf::client::send_msg {
		2602	my ($self, $channel, $msg, $color, @extra) = @_;
		2603
		2604	$msg = $self->pl->expand_cfpod ($msg);
		2605
		2606	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2607
		2608	# check predefined channels, for the benefit of C
		2609	$channel = $CHANNEL{$channel} if $CHANNEL{$channel};
		2610
		2611	if (ref $channel) {
		2612	# send meta info to client, if not yet sent
		2613	unless (exists $self->{channel}{$channel->{id}}) {
		2614	$self->{channel}{$channel->{id}} = $channel;
		2615	$self->ext_msg (channel_info => $channel)
		2616	if $self->can_msg;
		2617	}
		2618
		2619	$channel = $channel->{id};
		2620	}
		2621
		2622	return unless @extra || length $msg;
		2623
		2624	if ($self->can_msg) {
		2625	# default colour, mask it out
		2626	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2627	if $color & cf::NDI_DEF;
		2628
		2629	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2630	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2631	} else {
		2632	if ($color >= 0) {
		2633	# replace some tags by gcfclient-compatible ones
		2634	for ($msg) {
		2635	1 while
		2636	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2637	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2638	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2639	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2640	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2641	}
		2642
		2643	$color &= cf::NDI_COLOR_MASK;
		2644
		2645	utf8::encode $msg;
		2646
		2647	if (0 && $msg =~ /\[/) {
		2648	# COMMAND/INFO
		2649	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2650	} else {
		2651	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2652	$self->send_packet ("drawinfo $color $msg")
		2653	}
		2654	}
		2655	}
		2656	}
		2657
		2658	=item $client->ext_msg ($type, @msg)
		2659
		2660	Sends an ext event to the client.
		2661
		2662	=cut
		2663
		2664	sub cf::client::ext_msg($$@) {
		2665	my ($self, $type, @msg) = @_;
		2666
		2667	if ($self->extcmd == 2) {
		2668	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2669	} elsif ($self->extcmd == 1) { # TODO: remove
		2670	push @msg, msgtype => "event_$type";
		2671	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2672	}
		2673	}
		2674
		2675	=item $client->ext_reply ($msgid, @msg)
		2676
		2677	Sends an ext reply to the client.
		2678
		2679	=cut
		2680
		2681	sub cf::client::ext_reply($$@) {
		2682	my ($self, $id, @msg) = @_;
		2683
		2684	if ($self->extcmd == 2) {
		2685	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2686	} elsif ($self->extcmd == 1) {
		2687	#TODO: version 1, remove
		2688	unshift @msg, msgtype => "reply", msgid => $id;
		2689	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2690	}
		2691	}
		2692
		2693	=item $success = $client->query ($flags, "text", \&cb)
		2694
		2695	Queues a query to the client, calling the given callback with
		2696	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		2697	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		2698
		2699	Queries can fail, so check the return code. Or don't, as queries will
		2700	become reliable at some point in the future.
		2701
		2702	=cut
		2703
		2704	sub cf::client::query {
		2705	my ($self, $flags, $text, $cb) = @_;
		2706
		2707	return unless $self->state == ST_PLAYING
		2708	|| $self->state == ST_SETUP
		2709	|| $self->state == ST_CUSTOM;
		2710
		2711	$self->state (ST_CUSTOM);
		2712
		2713	utf8::encode $text;
		2714	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		2715
		2716	$self->send_packet ($self->{query_queue}[0][0])
		2717	if @{ $self->{query_queue} } == 1;
		2718
		2719	1
		2720	}
		2721
		2722	cf::client->attach (
		2723	on_connect => sub {
		2724	my ($ns) = @_;
		2725
		2726	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2727	},
		2728	on_reply => sub {
		2729	my ($ns, $msg) = @_;
		2730
		2731	# this weird shuffling is so that direct followup queries
		2732	# get handled first
		2733	my $queue = delete $ns->{query_queue}
		2734	or return; # be conservative, not sure how that can happen, but we saw a crash here
		2735
		2736	(shift @$queue)->[1]->($msg);
		2737	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
		2738
		2739	push @{ $ns->{query_queue} }, @$queue;
		2740
		2741	if (@{ $ns->{query_queue} } == @$queue) {
		2742	if (@$queue) {
		2743	$ns->send_packet ($ns->{query_queue}[0][0]);
		2744	} else {
		2745	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		2746	}
		2747	}
		2748	},
		2749	on_exticmd => sub {
		2750	my ($ns, $buf) = @_;
		2751
		2752	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2753
		2754	if (ref $msg) {
		2755	my ($type, $reply, @payload) =
		2756	"ARRAY" eq ref $msg
		2757	? @$msg
		2758	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2759
		2760	my @reply;
		2761
		2762	if (my $cb = $EXTICMD{$type}) {
		2763	@reply = $cb->($ns, @payload);
		2764	}
		2765
		2766	$ns->ext_reply ($reply, @reply)
		2767	if $reply;
		2768
		2769	} else {
		2770	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2771	}
		2772
		2773	cf::override;
		2774	},
		2775	);
		2776
		2777	=item $client->async (\&cb)
		2778
		2779	Create a new coroutine, running the specified callback. The coroutine will
		2780	be automatically cancelled when the client gets destroyed (e.g. on logout,
		2781	or loss of connection).
		2782
		2783	=cut
		2784
		2785	sub cf::client::async {
		2786	my ($self, $cb) = @_;
		2787
		2788	my $coro = &Coro::async ($cb);
		2789
		2790	$coro->on_destroy (sub {
		2791	delete $self->{_coro}{$coro+0};
		2792	});
		2793
		2794	$self->{_coro}{$coro+0} = $coro;
		2795
		2796	$coro
		2797	}
		2798
		2799	cf::client->attach (
		2800	on_destroy => sub {
		2801	my ($ns) = @_;
		2802
		2803	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		2804	},
		2805	);
		2806
		2807	=back
		2808
		2809
		2810	=head2 SAFE SCRIPTING
		2811
		2812	Functions that provide a safe environment to compile and execute
		2813	snippets of perl code without them endangering the safety of the server
		2814	itself. Looping constructs, I/O operators and other built-in functionality
		2815	is not available in the safe scripting environment, and the number of
		2816	functions and methods that can be called is greatly reduced.
		2817
		2818	=cut
		2819
		2820	our $safe = new Safe "safe";
		2821	our $safe_hole = new Safe::Hole;
		2822
		2823	$SIG{FPE} = 'IGNORE';
		2824
		2825	$safe->permit_only (Opcode::opset qw(
		2826	:base_core :base_mem :base_orig :base_math
		2827	grepstart grepwhile mapstart mapwhile
		2828	sort time
		2829	));
		2830
		2831	# here we export the classes and methods available to script code
		2832
		2833	=pod
		2834
		2835	The following functions and methods are available within a safe environment:
		2836
		2837	cf::object
		2838	contr pay_amount pay_player map x y force_find force_add
		2839	insert remove name archname title slaying race decrease_ob_nr
		2840
		2841	cf::object::player
		2842	player
		2843
		2844	cf::player
		2845	peaceful
		2846
		2847	cf::map
		2848	trigger
		2849
		2850	=cut
		2851
		2852	for (
		2853	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2854	insert remove inv name archname title slaying race
		2855	decrease_ob_nr)],
		2856	["cf::object::player" => qw(player)],
		2857	["cf::player" => qw(peaceful)],
		2858	["cf::map" => qw(trigger)],
		2859	) {
		2860	no strict 'refs';
		2861	my ($pkg, @funs) = @$_;
		2862	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
		2863	for @funs;
		2864	}
		2865
		2866	=over 4
		2867
		2868	=item @retval = safe_eval $code, [var => value, ...]
		2869
		2870	Compiled and executes the given perl code snippet. additional var/value
		2871	pairs result in temporary local (my) scalar variables of the given name
		2872	that are available in the code snippet. Example:
		2873
		2874	my $five = safe_eval '$first + $second', first => 1, second => 4;
		2875
		2876	=cut
		2877
		2878	sub safe_eval($;@) {
		2879	my ($code, %vars) = @_;
		2880
		2881	my $qcode = $code;
		2882	$qcode =~ s/"/‟/g; # not allowed in #line filenames
		2883	$qcode =~ s/\n/\\n/g;
		2884
		2885	local $_;
		2886	local @safe::cf::_safe_eval_args = values %vars;
		2887
		2888	my $eval =
		2889	"do {\n"
		2890	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
		2891	. "#line 0 \"{$qcode}\"\n"
		2892	. $code
		2893	. "\n}"
		2894	;
		2895
		2896	sub_generation_inc;
		2897	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
		2898	sub_generation_inc;
		2899
		2900	if ($@) {
		2901	warn "$@";
		2902	warn "while executing safe code '$code'\n";
		2903	warn "with arguments " . (join " ", %vars) . "\n";
		2904	}
		2905
		2906	wantarray ? @res : $res[0]
		2907	}
		2908
		2909	=item cf::register_script_function $function => $cb
		2910
		2911	Register a function that can be called from within map/npc scripts. The
		2912	function should be reasonably secure and should be put into a package name
		2913	like the extension.
		2914
		2915	Example: register a function that gets called whenever a map script calls
		2916	C<rent::overview>, as used by the C<rent> extension.
		2917
		2918	cf::register_script_function "rent::overview" => sub {
		2919	...
		2920	};
		2921
		2922	=cut
		2923
		2924	sub register_script_function {
		2925	my ($fun, $cb) = @_;
		2926
		2927	no strict 'refs';
		2928	*{"safe::$fun"} = $safe_hole->wrap ($cb);
		2929	}
		2930
		2931	=back
		2932
		2933	=cut
		2934
		2935	#############################################################################
		2936	# the server's init and main functions
		2937
		2938	sub load_facedata($) {
70	my ($data) = @_;	2939	my ($path) = @_;
71		2940
72	my $cb = $hook[$data->{event_code}]{$data->{extension}}	2941	# HACK to clear player env face cache, we need some signal framework
		2942	# for this (global event?)
		2943	%ext::player_env::MUSIC_FACE_CACHE = ();
		2944
		2945	my $enc = JSON::XS->new->utf8->canonical->relaxed;
		2946
		2947	warn "loading facedata from $path\n";
		2948
		2949	my $facedata;
		2950	0 < aio_load $path, $facedata
		2951	or die "$path: $!";
		2952
		2953	$facedata = Coro::Storable::thaw $facedata;
		2954
		2955	$facedata->{version} == 2
		2956	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2957
		2958	# patch in the exptable
		2959	$facedata->{resource}{"res/exp_table"} = {
		2960	type => FT_RSRC,
		2961	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
		2962	};
		2963	cf::cede_to_tick;
		2964
		2965	{
		2966	my $faces = $facedata->{faceinfo};
		2967
		2968	while (my ($face, $info) = each %$faces) {
		2969	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2970	cf::face::set_visibility $idx, $info->{visibility};
		2971	cf::face::set_magicmap $idx, $info->{magicmap};
		2972	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
		2973	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
		2974
		2975	cf::cede_to_tick;
		2976	}
		2977
		2978	while (my ($face, $info) = each %$faces) {
		2979	next unless $info->{smooth};
		2980	my $idx = cf::face::find $face
		2981	or next;
		2982	if (my $smooth = cf::face::find $info->{smooth}) {
		2983	cf::face::set_smooth $idx, $smooth;
		2984	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2985	} else {
		2986	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2987	}
		2988
		2989	cf::cede_to_tick;
		2990	}
		2991	}
		2992
		2993	{
		2994	my $anims = $facedata->{animinfo};
		2995
		2996	while (my ($anim, $info) = each %$anims) {
		2997	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2998	cf::cede_to_tick;
		2999	}
		3000
		3001	cf::anim::invalidate_all; # d'oh
		3002	}
		3003
		3004	{
		3005	# TODO: for gcfclient pleasure, we should give resources
		3006	# that gcfclient doesn't grok a >10000 face index.
		3007	my $res = $facedata->{resource};
		3008
		3009	my $soundconf = delete $res->{"res/sound.conf"};
		3010
		3011	while (my ($name, $info) = each %$res) {
		3012	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3013	my $data;
		3014
		3015	if ($info->{type} & 1) {
		3016	# prepend meta info
		3017
		3018	my $meta = $enc->encode ({
		3019	name => $name,
		3020	%{ $info->{meta} || {} },
		3021	});
		3022
		3023	$data = pack "(w/a*)*", $meta, $info->{data};
		3024	} else {
		3025	$data = $info->{data};
		3026	}
		3027
		3028	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3029	cf::face::set_type $idx, $info->{type};
		3030
		3031	cf::cede_to_tick;
		3032	}
		3033
		3034	if ($soundconf) {
		3035	$soundconf = $enc->decode (delete $soundconf->{data});
		3036
		3037	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3038	my $sound = $soundconf->{compat}[$_]
		3039	or next;
		3040
		3041	my $face = cf::face::find "sound/$sound->[1]";
		3042	cf::sound::set $sound->[0] => $face;
		3043	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3044	}
		3045
		3046	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3047	my $face = cf::face::find "sound/$v";
		3048	cf::sound::set $k => $face;
		3049	}
		3050	}
		3051	}
		3052
		3053	1
		3054	}
		3055
		3056	register_exticmd fx_want => sub {
		3057	my ($ns, $want) = @_;
		3058
		3059	while (my ($k, $v) = each %$want) {
		3060	$ns->fx_want ($k, $v);
		3061	}
		3062	};
		3063
		3064	sub reload_regions {
		3065	# HACK to clear player env face cache, we need some signal framework
		3066	# for this (global event?)
		3067	%ext::player_env::MUSIC_FACE_CACHE = ();
		3068
		3069	load_resource_file "$MAPDIR/regions"
		3070	or die "unable to load regions file\n";
		3071
		3072	for (cf::region::list) {
		3073	$_->{match} = qr/$_->{match}/
		3074	if exists $_->{match};
		3075	}
		3076	}
		3077
		3078	sub reload_facedata {
		3079	load_facedata "$DATADIR/facedata"
		3080	or die "unable to load facedata\n";
		3081	}
		3082
		3083	sub reload_archetypes {
		3084	load_resource_file "$DATADIR/archetypes"
		3085	or die "unable to load archetypes\n";
		3086	#d# NEED to laod twice to resolve forward references
		3087	# this really needs to be done in an extra post-pass
		3088	# (which needs to be synchronous, so solve it differently)
		3089	load_resource_file "$DATADIR/archetypes"
		3090	or die "unable to load archetypes\n";
		3091	}
		3092
		3093	sub reload_treasures {
		3094	load_resource_file "$DATADIR/treasures"
		3095	or die "unable to load treasurelists\n";
		3096	}
		3097
		3098	sub reload_resources {
		3099	warn "reloading resource files...\n";
		3100
		3101	reload_regions;
		3102	reload_facedata;
		3103	#reload_archetypes;#d#
		3104	reload_archetypes;
		3105	reload_treasures;
		3106
		3107	warn "finished reloading resource files\n";
		3108	}
		3109
		3110	sub init {
		3111	reload_resources;
		3112	}
		3113
		3114	sub reload_config {
		3115	open my $fh, "<:utf8", "$CONFDIR/config"
73	or return;	3116	or return;
74		3117
75	$cb->($data)	3118	local $/;
76	}	3119	*CFG = YAML::Syck::Load <$fh>;
77		3120
78	sub inject_global_event {	3121	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
79	my ($data) = @_;
80		3122
81	my $cb = $hook[$data->{event_code}]	3123	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
82	or return;	3124	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
83		3125
84	$_->($data) for values %$cb;	3126	if (exists $CFG{mlockall}) {
85
86	()
87	}
88
89	sub inject_command {
90	my ($name, $obj, $params) = @_;
91
92	for my $cmd (@{ $command{$name} }) {
93	$cmd->[1]->($obj, $params);
94	}
95
96	-1
97	}
98
99	sub register_command {
100	my ($name, $time, $cb) = @_;
101
102	my $caller = caller;
103
104	warn "registering command '$name/$time' to '$caller'";
105
106	push @{ $command{$name} }, [$time, $cb, $caller];
107	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
108	}
109
110	sub register {
111	my ($base, $pkg) = @_;
112
113	for my $idx (0 .. $#EVENT) {
114	if (my $ref = $pkg->can ("on_$EVENT[$idx]")) {
115	warn "registering $EVENT[$idx] hook to '$pkg'\n";
116	$hook[$idx]{$base} = $ref;
117	}
118	}
119	}
120
121	sub load_extension {
122	my ($path) = @_;
123
124	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
125	my $base = $1;
126	my $pkg = $1;
127	$pkg =~ s/[^[:word:]]/_/g;
128	$pkg = "cf::ext::$pkg";
129
130	warn "loading '$path' into '$pkg'\n";
131
132	open my $fh, "<:utf8", $path
133	or die "$path: $!";
134
135	my $source =
136	"package $pkg; use strict; use utf8;\n"
137	. "#line 1 \"$path\"\n{\n"
138	. (do { local $/; <$fh> })
139	. "\n};\n1";
140
141	eval $source
142	or die "$path: $@";
143
144	push @exts, $pkg;
145	$ext_pkg{$base} = $pkg;
146
147	# no strict 'refs';
148	# @{"$pkg\::ISA"} = cf::ext::;
149
150	register $base, $pkg;
151	}
152
153	sub unload_extension {
154	my ($pkg) = @_;
155
156	warn "removing extension $pkg\n";
157
158	# remove hooks
159	for my $idx (0 .. $#EVENT) {
160	delete $hook[$idx]{$pkg};
161	}
162
163	# remove commands
164	for my $name (keys %command) {
165	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
166
167	if (@cb) {
168	$command{$name} = \@cb;
169	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
170	} else {
171	delete $command{$name};
172	delete $COMMAND{"$name\000"};
173	}
174	}
175
176	Symbol::delete_package $pkg;
177	}
178
179	sub load_extensions {
180	my $LIBDIR = maps_directory "perl";
181
182	for my $ext (<$LIBDIR/*.ext>) {
183	next unless -r $ext;
184	eval {	3127	eval {
185	load_extension $ext;	3128	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
186	1	3129	and die "WARNING: m(un)lockall failed: $!\n";
187	} or warn "$ext not loaded: $@";
188	}
189	}
190
191	register_command "perl-reload", 0, sub {
192	my ($who, $arg) = @_;
193
194	if ($who->flag (FLAG_WIZ)) {
195	$who->message ("reloading...");
196
197	warn "reloading...\n";
198	eval {
199	unload_extension $_ for @exts;
200	delete $INC{"cf.pm"};
201
202	# don't, removes xs symbols, too
203	#Symbol::delete_package $pkg;
204
205	require cf;
206	};	3130	};
207	warn $@ if $@;	3131	warn $@ if $@;
208	$who->message ($@) if $@;	3132	}
		3133	}
		3134
		3135	sub main {
		3136	# we must not ever block the main coroutine
		3137	local $Coro::idle = sub {
		3138	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		3139	(async {
		3140	Event::one_event;
		3141	})->prio (Coro::PRIO_MAX);
		3142	};
		3143
		3144	reload_config;
		3145	db_init;
		3146	load_extensions;
		3147
		3148	$TICK_WATCHER->start;
		3149	Event::loop;
		3150	}
		3151
		3152	#############################################################################
		3153	# initialisation and cleanup
		3154
		3155	# install some emergency cleanup handlers
		3156	BEGIN {
		3157	for my $signal (qw(INT HUP TERM)) {
		3158	Event->signal (
		3159	reentrant => 0,
		3160	data => WF_AUTOCANCEL,
		3161	signal => $signal,
		3162	prio => 0,
		3163	cb => sub {
		3164	cf::cleanup "SIG$signal";
		3165	},
		3166	);
		3167	}
		3168	}
		3169
		3170	sub write_runtime {
		3171	my $runtime = "$LOCALDIR/runtime";
		3172
		3173	# first touch the runtime file to show we are still running:
		3174	# the fsync below can take a very very long time.
		3175
		3176	IO::AIO::aio_utime $runtime, undef, undef;
		3177
		3178	my $guard = cf::lock_acquire "write_runtime";
		3179
		3180	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3181	or return;
		3182
		3183	my $value = $cf::RUNTIME + 90 + 10;
		3184	# 10 is the runtime save interval, for a monotonic clock
		3185	# 60 allows for the watchdog to kill the server.
		3186
		3187	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3188	and return;
		3189
		3190	# always fsync - this file is important
		3191	aio_fsync $fh
		3192	and return;
		3193
		3194	# touch it again to show we are up-to-date
		3195	aio_utime $fh, undef, undef;
		3196
		3197	close $fh
		3198	or return;
		3199
		3200	aio_rename "$runtime~", $runtime
		3201	and return;
		3202
		3203	warn "runtime file written.\n";
		3204
		3205	1
		3206	}
		3207
		3208	sub emergency_save() {
		3209	my $freeze_guard = cf::freeze_mainloop;
		3210
		3211	warn "enter emergency perl save\n";
		3212
		3213	cf::sync_job {
		3214	# use a peculiar iteration method to avoid tripping on perl
		3215	# refcount bugs in for. also avoids problems with players
		3216	# and maps saved/destroyed asynchronously.
		3217	warn "begin emergency player save\n";
		3218	for my $login (keys %cf::PLAYER) {
		3219	my $pl = $cf::PLAYER{$login} or next;
		3220	$pl->valid or next;
		3221	$pl->save;
		3222	}
		3223	warn "end emergency player save\n";
		3224
		3225	warn "begin emergency map save\n";
		3226	for my $path (keys %cf::MAP) {
		3227	my $map = $cf::MAP{$path} or next;
		3228	$map->valid or next;
		3229	$map->save;
		3230	}
		3231	warn "end emergency map save\n";
		3232
		3233	warn "begin emergency database checkpoint\n";
		3234	BDB::db_env_txn_checkpoint $DB_ENV;
		3235	warn "end emergency database checkpoint\n";
		3236	};
		3237
		3238	warn "leave emergency perl save\n";
		3239	}
		3240
		3241	sub post_cleanup {
		3242	my ($make_core) = @_;
		3243
		3244	warn Carp::longmess "post_cleanup backtrace"
		3245	if $make_core;
		3246	}
		3247
		3248	sub do_reload_perl() {
		3249	# can/must only be called in main
		3250	if ($Coro::current != $Coro::main) {
		3251	warn "can only reload from main coroutine";
		3252	return;
		3253	}
		3254
		3255	warn "reloading...";
		3256
		3257	warn "entering sync_job";
		3258
		3259	cf::sync_job {
		3260	cf::write_runtime; # external watchdog should not bark
		3261	cf::emergency_save;
		3262	cf::write_runtime; # external watchdog should not bark
		3263
		3264	warn "syncing database to disk";
		3265	BDB::db_env_txn_checkpoint $DB_ENV;
		3266
		3267	# if anything goes wrong in here, we should simply crash as we already saved
		3268
		3269	warn "cancelling all WF_AUTOCANCEL watchers";
		3270	for (Event::all_watchers) {
		3271	$_->cancel if $_->data & WF_AUTOCANCEL;
		3272	}
		3273
		3274	warn "flushing outstanding aio requests";
		3275	for (;;) {
		3276	BDB::flush;
		3277	IO::AIO::flush;
		3278	Coro::cede;
		3279	last unless IO::AIO::nreqs || BDB::nreqs;
		3280	warn "iterate...";
		3281	}
		3282
		3283	++$RELOAD;
		3284
		3285	warn "cancelling all extension coros";
		3286	$_->cancel for values %EXT_CORO;
		3287	%EXT_CORO = ();
		3288
		3289	warn "removing commands";
		3290	%COMMAND = ();
		3291
		3292	warn "removing ext/exti commands";
		3293	%EXTCMD = ();
		3294	%EXTICMD = ();
		3295
		3296	warn "unloading/nuking all extensions";
		3297	for my $pkg (@EXTS) {
		3298	warn "... unloading $pkg";
		3299
		3300	if (my $cb = $pkg->can ("unload")) {
		3301	eval {
		3302	$cb->($pkg);
		3303	1
		3304	} or warn "$pkg unloaded, but with errors: $@";
		3305	}
		3306
		3307	warn "... nuking $pkg";
		3308	Symbol::delete_package $pkg;
		3309	}
		3310
		3311	warn "unloading all perl modules loaded from $LIBDIR";
		3312	while (my ($k, $v) = each %INC) {
		3313	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		3314
		3315	warn "... unloading $k";
		3316	delete $INC{$k};
		3317
		3318	$k =~ s/\.pm$//;
		3319	$k =~ s/\//::/g;
		3320
		3321	if (my $cb = $k->can ("unload_module")) {
		3322	$cb->();
		3323	}
		3324
		3325	Symbol::delete_package $k;
		3326	}
		3327
		3328	warn "getting rid of safe::, as good as possible";
		3329	Symbol::delete_package "safe::$_"
		3330	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
		3331
		3332	warn "unloading cf.pm \"a bit\"";
		3333	delete $INC{"cf.pm"};
		3334	delete $INC{"cf/pod.pm"};
		3335
		3336	# don't, removes xs symbols, too,
		3337	# and global variables created in xs
		3338	#Symbol::delete_package __PACKAGE__;
		3339
		3340	warn "unload completed, starting to reload now";
		3341
		3342	warn "reloading cf.pm";
		3343	require cf;
		3344	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
		3345
		3346	warn "loading config and database again";
		3347	cf::reload_config;
		3348
		3349	warn "loading extensions";
		3350	cf::load_extensions;
		3351
		3352	warn "reattaching attachments to objects/players";
		3353	_global_reattach; # objects, sockets
		3354	warn "reattaching attachments to maps";
		3355	reattach $_ for values %MAP;
		3356	warn "reattaching attachments to players";
		3357	reattach $_ for values %PLAYER;
		3358
		3359	warn "leaving sync_job";
		3360
		3361	1
		3362	} or do {
		3363	warn $@;
		3364	warn "error while reloading, exiting.";
		3365	exit 1;
		3366	};
		3367
209	warn "reloaded\n";	3368	warn "reloaded";
		3369	};
210		3370
		3371	our $RELOAD_WATCHER; # used only during reload
		3372
		3373	sub reload_perl() {
		3374	# doing reload synchronously and two reloads happen back-to-back,
		3375	# coro crashes during coro_state_free->destroy here.
		3376
		3377	$RELOAD_WATCHER ||= Event->timer (
		3378	reentrant => 0,
		3379	after => 0,
		3380	data => WF_AUTOCANCEL,
		3381	cb => sub {
		3382	do_reload_perl;
		3383	undef $RELOAD_WATCHER;
		3384	},
		3385	);
		3386	}
		3387
		3388	register_command "reload" => sub {
		3389	my ($who, $arg) = @_;
		3390
		3391	if ($who->flag (FLAG_WIZ)) {
211	$who->message ("reloaded");	3392	$who->message ("reloading server.");
		3393	async { reload_perl };
		3394	}
		3395	};
		3396
		3397	unshift @INC, $LIBDIR;
		3398
		3399	my $bug_warning = 0;
		3400
		3401	our @WAIT_FOR_TICK;
		3402	our @WAIT_FOR_TICK_BEGIN;
		3403
		3404	sub wait_for_tick {
		3405	return unless $TICK_WATCHER->is_active;
		3406	return if $Coro::current == $Coro::main;
		3407
		3408	my $signal = new Coro::Signal;
		3409	push @WAIT_FOR_TICK, $signal;
		3410	$signal->wait;
		3411	}
		3412
		3413	sub wait_for_tick_begin {
		3414	return unless $TICK_WATCHER->is_active;
		3415	return if $Coro::current == $Coro::main;
		3416
		3417	my $signal = new Coro::Signal;
		3418	push @WAIT_FOR_TICK_BEGIN, $signal;
		3419	$signal->wait;
		3420	}
		3421
		3422	my $min = 1e6;#d#
		3423	my $avg = 10;
		3424	$TICK_WATCHER = Event->timer (
		3425	reentrant => 0,
		3426	parked => 1,
		3427	prio => 0,
		3428	at => $NEXT_TICK || $TICK,
		3429	data => WF_AUTOCANCEL,
		3430	cb => sub {
		3431	if ($Coro::current != $Coro::main) {
		3432	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3433	unless ++$bug_warning > 10;
		3434	return;
		3435	}
		3436
		3437	$NOW = $tick_start = Event::time;
		3438
		3439	cf::server_tick; # one server iteration
		3440
		3441	0 && sync_job {#d#
		3442	for(1..10) {
		3443	my $t = Event::time;
		3444	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3445	or die;
		3446
		3447	$map->width (50);
		3448	$map->height (50);
		3449	$map->alloc;
		3450	$map->_load_objects ("/tmp/x.map", 1); #TODO: does not work
		3451	my $t = Event::time - $t;
		3452
		3453	#next unless $t < 0.0013;#d#
		3454	if ($t < $min) {
		3455	$min = $t;
		3456	}
		3457	$avg = $avg * 0.99 + $t * 0.01;
		3458	}
		3459	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3460	exit 0;
		3461	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3462	};
		3463
		3464	$RUNTIME += $TICK;
		3465	$NEXT_TICK += $TICK;
		3466
		3467	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		3468	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3469	Coro::async_pool {
		3470	write_runtime
		3471	or warn "ERROR: unable to write runtime file: $!";
		3472	};
		3473	}
		3474
		3475	# my $AFTER = Event::time;
		3476	# warn $AFTER - $NOW;#d#
		3477
		3478	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3479	$sig->send;
		3480	}
		3481	while (my $sig = shift @WAIT_FOR_TICK) {
		3482	$sig->send;
		3483	}
		3484
		3485	$NOW = Event::time;
		3486
		3487	# if we are delayed by four ticks or more, skip them all
		3488	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
		3489
		3490	$TICK_WATCHER->at ($NEXT_TICK);
		3491	$TICK_WATCHER->start;
		3492
		3493	$LOAD = ($NOW - $tick_start) / $TICK;
		3494	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3495
		3496	_post_tick;
		3497
		3498
		3499	},
		3500	);
		3501
		3502	{
		3503	BDB::max_poll_time $TICK * 0.1;
		3504	$BDB_POLL_WATCHER = Event->io (
		3505	reentrant => 0,
		3506	fd => BDB::poll_fileno,
		3507	poll => 'r',
		3508	prio => 0,
		3509	data => WF_AUTOCANCEL,
		3510	cb => \&BDB::poll_cb,
		3511	);
		3512	BDB::min_parallel 8;
		3513
		3514	BDB::set_sync_prepare {
		3515	my $status;
		3516	my $current = $Coro::current;
		3517	(
		3518	sub {
		3519	$status = $!;
		3520	$current->ready; undef $current;
		3521	},
		3522	sub {
		3523	Coro::schedule while defined $current;
		3524	$! = $status;
		3525	},
		3526	)
		3527	};
		3528
		3529	unless ($DB_ENV) {
		3530	$DB_ENV = BDB::db_env_create;
		3531
		3532	cf::sync_job {
		3533	eval {
		3534	BDB::db_env_open
		3535	$DB_ENV,
		3536	$BDBDIR,
		3537	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3538	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3539	0666;
		3540
		3541	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3542
		3543	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3544	$DB_ENV->set_lk_detect;
		3545	};
		3546
		3547	cf::cleanup "db_env_open(db): $@" if $@;
		3548	};
		3549	}
		3550	}
		3551
		3552	{
		3553	IO::AIO::min_parallel 8;
		3554
		3555	undef $Coro::AIO::WATCHER;
		3556	IO::AIO::max_poll_time $TICK * 0.1;
		3557	$AIO_POLL_WATCHER = Event->io (
		3558	reentrant => 0,
		3559	data => WF_AUTOCANCEL,
		3560	fd => IO::AIO::poll_fileno,
		3561	poll => 'r',
		3562	prio => 6,
		3563	cb => \&IO::AIO::poll_cb,
		3564	);
		3565	}
		3566
		3567	my $_log_backtrace;
		3568
		3569	sub _log_backtrace {
		3570	my ($msg, @addr) = @_;
		3571
		3572	$msg =~ s/\n//;
		3573
		3574	# limit the # of concurrent backtraces
		3575	if ($_log_backtrace < 2) {
		3576	++$_log_backtrace;
		3577	async {
		3578	my @bt = fork_call {
		3579	@addr = map { sprintf "%x", $_ } @addr;
		3580	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3581	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3582	or die "addr2line: $!";
		3583
		3584	my @funcs;
		3585	my @res = <$fh>;
		3586	chomp for @res;
		3587	while (@res) {
		3588	my ($func, $line) = splice @res, 0, 2, ();
		3589	push @funcs, "[$func] $line";
		3590	}
		3591
		3592	@funcs
		3593	};
		3594
		3595	LOG llevInfo, "[ABT] $msg\n";
		3596	LOG llevInfo, "[ABT] $_\n" for @bt;
		3597	--$_log_backtrace;
		3598	};
212	} else {	3599	} else {
213	$who->message ("Intruder Alert!");	3600	LOG llevInfo, "[ABT] $msg\n";
		3601	LOG llevInfo, "[ABT] [suppressed]\n";
214	}	3602	}
215	};	3603	}
216		3604
217	*on_mapclean = sub {	3605	# load additional modules
218	my $map = shift->{map};	3606	use cf::pod;
219		3607
220	my $path = $map->tmpname;	3608	END { cf::emergency_save }
221	defined $path or return;
222
223	unlink "$path.cfperl";
224	};
225
226	*on_mapin =
227	*on_mapload = sub {
228	my $map = shift->{map};
229
230	my $path = $map->tmpname;
231	$path = $map->path unless defined $path;
232
233	open my $fh, "<:raw", "$path.cfperl"
234	or return; # no perl data
235
236	my $data = Storable::thaw do { local $/; <$fh> };
237
238	$data->{version} <= 1
239	or return; # too new
240
241	$map->_set_obs ($data->{obs});
242	};
243
244	*on_mapout = sub {
245	my $map = shift->{map};
246
247	my $path = $map->tmpname;
248	$path = $map->path unless defined $path;
249
250	my $obs = $map->_get_obs;
251
252	if (defined $obs) {
253	open my $fh, ">:raw", "$path.cfperl"
254	or die "$path.cfperl: $!";
255
256	print $fh Storable::nfreeze {
257	version => 1,
258	obs => $obs,
259	};
260
261	chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g*
262	} else {
263	unlink "$path.cfperl";
264	}
265	};
266
267	register "<global>", __PACKAGE__;
268
269	load_extensions;
270		3609
271	1	3610	1
272		3611

Diff Legend

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