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.58 by root, Wed Aug 30 12:08:15 2006 UTC vs.
Revision 1.416 by root, Fri Apr 11 13:59:06 2008 UTC

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

Diff Legend

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