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

Diff Legend

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