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

Diff Legend

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