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.48 by root, Sun Aug 27 15:24:22 2006 UTC vs.
Revision 1.460 by root, Mon Dec 15 17:04:53 2008 UTC

		1	#
		2	# This file is part of Deliantra, the Roguelike Realtime MMORPG.
		3	#
		4	# Copyright (©) 2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
		5	#
		6	# Deliantra is free software: you can redistribute it and/or modify
		7	# it under the terms of the GNU General Public License as published by
		8	# the Free Software Foundation, either version 3 of the License, or
		9	# (at your option) any later version.
		10	#
		11	# This program is distributed in the hope that it will be useful,
		12	# but WITHOUT ANY WARRANTY; without even the implied warranty of
		13	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
		14	# GNU General Public License for more details.
		15	#
		16	# You should have received a copy of the GNU General Public License
		17	# along with this program. If not, see <http://www.gnu.org/licenses/>.
		18	#
		19	# The authors can be reached via e-mail to <support@deliantra.net>
		20	#
		21
1	package cf;	22	package cf;
		23
		24	use 5.10.0;
		25	use utf8;
		26	use strict "vars", "subs";
2		27
3	use Symbol;	28	use Symbol;
4	use List::Util;	29	use List::Util;
5	use Storable;	30	use Socket;
		31	use EV;
6	use Opcode;	32	use Opcode;
7	use Safe;	33	use Safe;
8	use Safe::Hole;	34	use Safe::Hole;
		35	use Storable ();
9		36
		37	use 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	_reload_1;	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 %PROP_TYPE;
21	our %PROP_IDX;
22	our $LIBDIR = maps_directory "perl";
23		90
24	our $TICK = MAX_TIME * 1e-6;	91	our $CONFDIR = confdir;
25	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
26	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
27		218
28	BEGIN {	219	BEGIN {
29	*CORE::GLOBAL::warn = sub {	220	*CORE::GLOBAL::warn = sub {
30	my $msg = join "", @_;	221	my $msg = join "", @_;
		222
31	$msg .= "\n"	223	$msg .= "\n"
32	unless $msg =~ /\n$/;	224	unless $msg =~ /\n$/;
33		225
34	print STDERR "cfperl: $msg";	226	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		227
35	LOG llevError, "cfperl: $msg";	228	LOG llevError, $msg;
36	};	229	};
37	}	230	}
38		231
39	my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!	232	$Coro::State::DIEHOOK = sub {
		233	return unless $^S eq 0; # "eq", not "=="
40		234
41	# generate property mutators	235	if ($Coro::current == $Coro::main) {#d#
42	sub prop_gen {	236	warn "DIEHOOK called in main context, Coro bug?\n";#d#
43	my ($prefix, $class) = @_;	237	return;#d#
		238	}#d#
44		239
45	no strict 'refs';	240	# kill coroutine otherwise
		241	warn Carp::longmess $_[0];
		242	Coro::terminate
		243	};
46		244
47	for my $prop (keys %PROP_TYPE) {	245	$SIG{__DIE__} = sub { }; #d#?
48	$prop =~ /^\Q$prefix\E_(.*$)/ or next;
49	my $sub = lc $1;
50		246
51	my $type = $PROP_TYPE{$prop};	247	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
52	my $idx = $PROP_IDX {$prop};	248	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
53		249	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
54	*{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {	250	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
55	$_[0]->get_property ($type, $idx)	251	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
56	};	252	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
57
58	*{"$class\::set_$sub"} = sub {
59	$_[0]->set_property ($type, $idx, $_[1]);
60	} unless $ignore_set{$prop};
61	}
62	}
63
64	# auto-generate most of the API
65
66	prop_gen OBJECT_PROP => "cf::object";
67	# CFAPI_OBJECT_ANIMATION?
68	prop_gen PLAYER_PROP => "cf::object::player";
69
70	prop_gen MAP_PROP => "cf::map";
71	prop_gen ARCH_PROP => "cf::arch";
72
73	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	253	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
74		254
75	# 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
76	# within the Safe compartment.	256	# within the Safe compartment.
77	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch)) {	257	for my $pkg (qw(
78	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	)) {
79	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	265	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
80	}	266	}
81		267
82	$Event::DIED = sub {	268	$EV::DIED = sub {
83	warn "error in event callback: @_";	269	warn "error in event callback: @_";
84	};	270	};
85		271
86	my %ext_pkg;
87	my @exts;
88	my @hook;
89	my %command;
90	my %extcmd;
91
92	#############################################################################	272	#############################################################################
93	# utility functions
94		273
95	use JSON::Syck (); # TODO# replace by JSON::PC once working	274	=head2 UTILITY FUNCTIONS
96		275
97	sub from_json($) {	276	=over 4
98	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
99	JSON::Syck::Load $_[0]
100	}
101		277
102	sub to_json($) {	278	=item dumpval $ref
103	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	279
104	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]: '$@']";
105	}	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
106		727
107	#############################################################################	728	#############################################################################
108	# "new" plug-in system
109		729
		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).
		739
		740	=over 4
		741
110	=item $object->attach ($attachment, key => $value...)	742	=item $attachable->attach ($attachment, key => $value...)
111		743
112	Attach a pre-registered attachment to an object.	744	=item $attachable->detach ($attachment)
113		745
114	=item $player->attach ($attachment, key => $value...)	746	Attach/detach a pre-registered attachment to a specific object and give it
		747	the specified key/value pairs as arguments.
115		748
116	Attach a pre-registered attachment to a player.	749	Example, attach a minesweeper attachment to the given object, making it a
		750	10x10 minesweeper game:
117		751
118	=item $map->attach ($attachment, key => $value...) # not yet persistent	752	$obj->attach (minesweeper => width => 10, height => 10);
119		753
120	Attach a pre-registered attachment to a map.	754	=item $bool = $attachable->attached ($name)
121		755
122	=item cf::attach_global ...	756	Checks wether the named attachment is currently attached to the object.
123		757
124	Attach handlers for global events.	758	=item cf::CLASS->attach ...
125		759
126	This and all following C<attach_*>-functions expect any number of the	760	=item cf::CLASS->detach ...
127	following handler/hook descriptions:	761
		762	Define an anonymous attachment and attach it to all objects of the given
		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:
128		796
129	=over 4	797	=over 4
130		798
131	=item prio => $number	799	=item prio => $number
132		800
…		…
134	by another C<prio> setting). Lower priority handlers get executed	802	by another C<prio> setting). Lower priority handlers get executed
135	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
136	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
137	unless you know what you are doing.	805	unless you know what you are doing.
138		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
139	=item on_I<event> => \&cb	813	=item on_I<event> => \&cb
140		814
141	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
142	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
143	handlers are recognised generally depends on the type of object these	817	handlers are recognised generally depends on the type of object these
…		…
152	package and register them. Only handlers for eevents supported by the	826	package and register them. Only handlers for eevents supported by the
153	object/class are recognised.	827	object/class are recognised.
154		828
155	=back	829	=back
156		830
157	=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:
158		833
159	Attach handlers for a specific object type (e.g. TRANSPORT) and	834	cf::object::attachment sockpuppet =>
160	subtype. If C<$subtype> is zero or undef, matches all objects of the given	835	on_skill_attack => sub {
161	type.	836	my ($self, $victim) = @_;
		837	...
		838	}
		839	}
162		840
163	=item cf::attach_to_objects ...	841	=item $attachable->valid
164		842
165	Attach handlers to all objects. Do not use this except for debugging or	843	Just because you have a perl object does not mean that the corresponding
166	very rare events, as handlers are (obviously) called for I<all> objects in	844	C-level object still exists. If you try to access an object that has no
167	the game.	845	valid C counterpart anymore you get an exception at runtime. This method
168		846	can be used to test for existence of the C object part without causing an
169	=item cf::attach_to_players ...	847	exception.
170
171	Attach handlers to all players.
172
173	=item cf::attach_to_maps ...
174
175	Attach handlers to all maps.
176
177	=item cf:register_attachment $name, ...
178		848
179	=cut	849	=cut
180		850
181	# the following variables are defined in .xs and must not be re-created	851	# the following variables are defined in .xs and must not be re-created
182	our @CB_GLOBAL = (); # registry for all global events	852	our @CB_GLOBAL = (); # registry for all global events
		853	our @CB_ATTACHABLE = (); # registry for all attachables
183	our @CB_OBJECT = (); # all objects (should not be used except in emergency)	854	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
184	our @CB_PLAYER = ();	855	our @CB_PLAYER = ();
		856	our @CB_CLIENT = ();
185	our @CB_TYPE = (); # registry for type (cf-object class) based events	857	our @CB_TYPE = (); # registry for type (cf-object class) based events
186	our @CB_MAP = ();	858	our @CB_MAP = ();
187		859
188	my %attachment;	860	my %attachment;
189		861
		862	sub cf::attachable::thawer_merge {
		863	# simply override everything except _meta
		864	local $_[0]{_meta};
		865	%{$_[0]} = %{$_[1]};
		866	}
		867
190	sub _attach_cb($\%$$$) {	868	sub _attach_cb($$$$) {
191	my ($registry, $undo, $event, $prio, $cb) = @_;	869	my ($registry, $event, $prio, $cb) = @_;
192		870
193	use sort 'stable';	871	use sort 'stable';
194		872
195	$cb = [$prio, $cb];	873	$cb = [$prio, $cb];
196		874
197	@{$registry->[$event]} = sort	875	@{$registry->[$event]} = sort
198	{ $a->[0] cmp $b->[0] }	876	{ $a->[0] cmp $b->[0] }
199	@{$registry->[$event] || []}, $cb;	877	@{$registry->[$event] || []}, $cb;
200
201	push @{$undo->{cb}}, [$event, $cb];
202	}	878	}
		879
		880	# hack
		881	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
203		882
204	# attach handles attaching event callbacks	883	# attach handles attaching event callbacks
205	# the only thing the caller has to do is pass the correct	884	# the only thing the caller has to do is pass the correct
206	# registry (== where the callback attaches to).	885	# registry (== where the callback attaches to).
207	sub _attach(\@$@) {	886	sub _attach {
208	my ($registry, $klass, @arg) = @_;	887	my ($registry, $klass, @arg) = @_;
209		888
		889	my $object_type;
210	my $prio = 0;	890	my $prio = 0;
211
212	my %undo = (
213	registry => $registry,
214	cb => [],
215	);
216
217	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;	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	}
218		897
219	while (@arg) {	898	while (@arg) {
220	my $type = shift @arg;	899	my $type = shift @arg;
221		900
222	if ($type eq "prio") {	901	if ($type eq "prio") {
223	$prio = shift @arg;	902	$prio = shift @arg;
224		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
225	} elsif ($type eq "package") {	913	} elsif ($type eq "package") {
226	my $pkg = shift @arg;	914	my $pkg = shift @arg;
227		915
228	while (my ($name, $id) = each %cb_id) {	916	while (my ($name, $id) = each %cb_id) {
229	if (my $cb = $pkg->can ($name)) {	917	if (my $cb = $pkg->can ($name)) {
230	_attach_cb $registry, %undo, $id, $prio, $cb;	918	_attach_cb $registry, $id, $prio, $cb;
231	}	919	}
232	}	920	}
233		921
234	} elsif (exists $cb_id{$type}) {	922	} elsif (exists $cb_id{$type}) {
235	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;	923	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
236		924
237	} elsif (ref $type) {	925	} elsif (ref $type) {
238	warn "attaching objects not supported, ignoring.\n";	926	warn "attaching objects not supported, ignoring.\n";
239		927
240	} else {	928	} else {
241	shift @arg;	929	shift @arg;
242	warn "attach argument '$type' not supported, ignoring.\n";	930	warn "attach argument '$type' not supported, ignoring.\n";
243	}	931	}
244	}	932	}
245
246	\%undo
247	}	933	}
248		934
249	sub _attach_attachment {	935	sub _object_attach {
250	my ($obj, $name, %arg) = @_;	936	my ($obj, $name, %arg) = @_;
251		937
252	my $res;	938	return if exists $obj->{_attachment}{$name};
253		939
254	if (my $attach = $attachment{$name}) {	940	if (my $attach = $attachment{$name}) {
255	my $registry = $obj->registry;	941	my $registry = $obj->registry;
256		942
257	for (@$attach) {	943	for (@$attach) {
258	my ($klass, @attach) = @$_;	944	my ($klass, @attach) = @$_;
259	$res = _attach @$registry, $klass, @attach;	945	_attach $registry, $klass, @attach;
260	}	946	}
261		947
262	$obj->{$name} = \%arg;	948	$obj->{$name} = \%arg;
263	} else {	949	} else {
264	warn "object uses attachment '$name' that is not available, postponing.\n";	950	warn "object uses attachment '$name' which is not available, postponing.\n";
265	}	951	}
266		952
267	push @{$obj->{_attachment}}, $name;	953	$obj->{_attachment}{$name} = undef;
268
269	$res->{attachment} = $name;
270	$res
271	}	954	}
272		955
273	sub cf::object::attach {	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 {
274	my ($obj, $name, %arg) = @_;	967	my ($obj, $name) = @_;
275		968
276	_attach_attachment $obj, $name, %arg;	969	if (ref $obj) {
277	}	970	delete $obj->{_attachment}{$name};
		971	reattach ($obj);
		972	} else {
		973	Carp::croak "cannot, currently, detach class attachments";
		974	}
		975	_recalc_want;
		976	};
278		977
279	sub cf::player::attach {	978	sub cf::attachable::attached {
280	my ($obj, $name, %arg) = @_;	979	my ($obj, $name) = @_;
281		980
282	_attach_attachment KLASS_PLAYER, $obj, $name, %arg;	981	exists $obj->{_attachment}{$name}
283	}	982	}
284		983
285	sub cf::map::attach {	984	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
286	my ($obj, $name, %arg) = @_;	985	eval "#line " . __LINE__ . " 'cf.pm'
		986	sub cf::\L$klass\E::_attach_registry {
		987	(\\\@CB_$klass, KLASS_$klass)
		988	}
287		989
288	_attach_attachment KLASS_MAP, $obj, $name, %arg;	990	sub cf::\L$klass\E::attachment {
289	}
290
291	sub attach_global {
292	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
293	}
294
295	sub attach_to_type {
296	my $type = shift;
297	my $subtype = shift;
298
299	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
300	}
301
302	sub attach_to_objects {
303	_attach @CB_OBJECT, KLASS_OBJECT, @_
304	}
305
306	sub attach_to_players {
307	_attach @CB_PLAYER, KLASS_PLAYER, @_
308	}
309
310	sub attach_to_maps {
311	_attach @CB_MAP, KLASS_MAP, @_
312	}
313
314	sub register_attachment {
315	my $name = shift;	991	my \$name = shift;
316		992
317	$attachment{$name} = [[KLASS_OBJECT, @_]];	993	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		994	}
		995	";
		996	die if $@;
318	}	997	}
319		998
320	our $override;	999	our $override;
321	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	1000	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
322		1001
323	sub override {	1002	sub override {
324	$override = 1;	1003	$override = 1;
325	@invoke_results = ();	1004	@INVOKE_RESULTS = (@_);
326	}	1005	}
327		1006
328	sub do_invoke {	1007	sub do_invoke {
329	my $event = shift;	1008	my $event = shift;
330	my $callbacks = shift;	1009	my $callbacks = shift;
331		1010
332	@invoke_results = ();	1011	@INVOKE_RESULTS = ();
333		1012
334	local $override;	1013	local $override;
335		1014
336	for (@$callbacks) {	1015	for (@$callbacks) {
337	eval { &{$_->[1]} };	1016	eval { &{$_->[1]} };
338		1017
339	if ($@) {	1018	if ($@) {
340	warn "$@";	1019	warn "$@";
341	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	1020	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
342	override;	1021	override;
343	}	1022	}
344		1023
345	return 1 if $override;	1024	return 1 if $override;
346	}	1025	}
347		1026
348	0	1027	0
349	}	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
		1040	=back
		1041
		1042	=cut
350		1043
351	#############################################################################	1044	#############################################################################
352	# object support	1045	# object support
353		1046
354	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 {
355	my ($obj, $data) = @_;	1081	my ($ob1, $ob2) = @_;
356		1082
357	$data = from_json $data;	1083	++$SLOW_MERGES;#d#
358		1084
359	for (@$data) {	1085	# we do the slow way here
360	my ($name, $args) = @$_;	1086	return _object_equal $ob1, $ob2
361	attach $obj, $name, %{$args || {} };
362	}
363	}	1087	}
364		1088
365	# basically do the same as instantiate, without calling instantiate
366	sub reattach {	1089	sub reattach {
		1090	# basically do the same as instantiate, without calling instantiate
367	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
368	my $registry = $obj->registry;	1096	my $registry = $obj->registry;
369		1097
370	@$registry = ();	1098	@$registry = ();
371		1099
		1100	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
		1101
372	for my $name (@{ $obj->{_attachment} }) {	1102	for my $name (keys %{ $obj->{_attachment} || {} }) {
373	if (my $attach = $attachment{$name}) {	1103	if (my $attach = $attachment{$name}) {
374	for (@$attach) {	1104	for (@$attach) {
375	my ($klass, @attach) = @$_;	1105	my ($klass, @attach) = @$_;
376	_attach @$registry, $klass, @attach;	1106	_attach $registry, $klass, @attach;
377	}	1107	}
378	} else {	1108	} else {
379	warn "object uses attachment '$name' that is not available, postponing.\n";	1109	warn "object uses attachment '$name' that is not available, postponing.\n";
380	}	1110	}
381	}	1111	}
382	}	1112	}
383		1113
		1114	cf::attachable->attach (
		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,
		1128	on_clone => sub {
		1129	my ($src, $dst) = @_;
		1130
		1131	@{$dst->registry} = @{$src->registry};
		1132
		1133	%$dst = %$src;
		1134
		1135	%{$dst->{_attachment}} = %{$src->{_attachment}}
		1136	if exists $src->{_attachment};
		1137	},
		1138	);
		1139
384	sub object_freezer_save {	1140	sub object_freezer_save {
385	my ($filename, $objs) = @_;	1141	my ($filename, $rdata, $objs) = @_;
386		1142
387	$filename .= ".pst";	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;
388		1148
389	if (@$objs) {	1149	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
390	open my $fh, ">:raw", "$filename~";
391	chmod $fh, SAVE_MODE;	1150	aio_chmod $fh, SAVE_MODE;
392	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };	1151	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		1152	aio_fsync $fh if $cf::USE_FSYNC;
393	close $fh;	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
394	rename "$filename~", $filename;	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	}
395	} else {	1175	} else {
396	unlink $filename;	1176	aio_unlink $filename;
		1177	aio_unlink "$filename.pst";
		1178	}
397	}	1179	};
		1180	}
		1181
		1182	sub object_freezer_as_string {
		1183	my ($rdata, $objs) = @_;
		1184
		1185	use Data::Dumper;
		1186
		1187	$$rdata . Dumper $objs
398	}	1188	}
399		1189
400	sub object_thawer_load {	1190	sub object_thawer_load {
401	my ($filename) = @_;	1191	my ($filename) = @_;
402		1192
403	open my $fh, "<:raw:perlio", "$filename.pst"	1193	my ($data, $av);
		1194
		1195	(aio_load $filename, $data) >= 0
404	or return;	1196	or return;
405		1197
406	eval { local $/; (Storable::thaw <$fh>)->{objs} }	1198	unless (aio_stat "$filename.pst") {
407	}	1199	(aio_load "$filename.pst", $av) >= 0
		1200	or return;
408		1201
409	attach_to_objects	1202	my $st = eval { Coro::Storable::thaw $av };
410	prio => -1000000,	1203	$av = $st->{objs};
411	on_clone => sub {
412	my ($src, $dst) = @_;
413
414	@{$dst->registry} = @{$src->registry};
415
416	%$dst = %$src;
417
418	$dst->{_attachment} = [@{ $src->{_attachment} }]
419	if exists $src->{_attachment};
420	},	1204	}
421	;	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
422		1218
423	#############################################################################	1219	#############################################################################
424	# old plug-in events	1220	# command handling &c
425		1221
426	sub inject_event {	1222	=item cf::register_command $name => \&callback($ob,$args);
427	my $extension = shift;
428	my $event_code = shift;
429		1223
430	my $cb = $hook[$event_code]{$extension}	1224	Register a callback for execution when the client sends the user command
431	or return;	1225	$name.
432		1226
433	&$cb	1227	=cut
434	}
435
436	sub inject_global_event {
437	my $event = shift;
438
439	my $cb = $hook[$event]
440	or return;
441
442	List::Util::max map &$_, values %$cb
443	}
444
445	sub inject_command {
446	my ($name, $obj, $params) = @_;
447
448	for my $cmd (@{ $command{$name} }) {
449	$cmd->[1]->($obj, $params);
450	}
451
452	-1
453	}
454		1228
455	sub register_command {	1229	sub register_command {
456	my ($name, $time, $cb) = @_;	1230	my ($name, $cb) = @_;
457		1231
458	my $caller = caller;	1232	my $caller = caller;
459	#warn "registering command '$name/$time' to '$caller'";	1233	#warn "registering command '$name/$time' to '$caller'";
460		1234
461	push @{ $command{$name} }, [$time, $cb, $caller];	1235	push @{ $COMMAND{$name} }, [$caller, $cb];
462	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
463	}	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
464		1261
465	sub register_extcmd {	1262	sub register_extcmd {
466	my ($name, $cb) = @_;	1263	my ($name, $cb) = @_;
467		1264
468	my $caller = caller;	1265	$EXTCMD{$name} = $cb;
469	#warn "registering extcmd '$name' to '$caller'";
470
471	$extcmd{$name} = [$cb, $caller];
472	}	1266	}
473		1267
474	sub register {	1268	sub register_exticmd {
475	my ($base, $pkg) = @_;	1269	my ($name, $cb) = @_;
476		1270
477	#TODO	1271	$EXTICMD{$name} = $cb;
478	}	1272	}
479		1273
480	sub load_extension {	1274	use File::Glob ();
481	my ($path) = @_;
482		1275
483	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1276	cf::player->attach (
484	my $base = $1;	1277	on_command => sub {
485	my $pkg = $1;	1278	my ($pl, $name, $params) = @_;
486	$pkg =~ s/[^[:word:]]/_/g;
487	$pkg = "ext::$pkg";
488		1279
489	warn "loading '$path' into '$pkg'\n";	1280	my $cb = $COMMAND{$name}
		1281	or return;
490		1282
491	open my $fh, "<:utf8", $path	1283	for my $cmd (@$cb) {
492	or die "$path: $!";	1284	$cmd->[1]->($pl->ob, $params);
493
494	my $source =
495	"package $pkg; use strict; use utf8;\n"
496	. "#line 1 \"$path\"\n{\n"
497	. (do { local $/; <$fh> })
498	. "\n};\n1";
499
500	eval $source
501	or die "$path: $@";
502
503	push @exts, $pkg;
504	$ext_pkg{$base} = $pkg;
505
506	# no strict 'refs';
507	# @{"$pkg\::ISA"} = ext::;
508
509	register $base, $pkg;
510	}
511
512	sub unload_extension {
513	my ($pkg) = @_;
514
515	warn "removing extension $pkg\n";
516
517	# remove hooks
518	#TODO
519	# for my $idx (0 .. $#PLUGIN_EVENT) {
520	# delete $hook[$idx]{$pkg};
521	# }
522
523	# remove commands
524	for my $name (keys %command) {
525	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
526
527	if (@cb) {
528	$command{$name} = \@cb;
529	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
530	} else {
531	delete $command{$name};
532	delete $COMMAND{"$name\000"};
533	}
534	}
535
536	# remove extcmds
537	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
538	delete $extcmd{$name};
539	}
540
541	if (my $cb = $pkg->can ("unload")) {
542	eval {
543	$cb->($pkg);
544	1
545	} or warn "$pkg unloaded, but with errors: $@";
546	}
547
548	Symbol::delete_package $pkg;
549	}
550
551	sub load_extensions {
552	my $LIBDIR = maps_directory "perl";
553
554	for my $ext (<$LIBDIR/*.ext>) {
555	next unless -r $ext;
556	eval {
557	load_extension $ext;
558	1
559	} or warn "$ext not loaded: $@";
560	}
561	}
562
563	sub _perl_reload(&) {
564	my ($msg) = @_;
565
566	$msg->("reloading...");
567
568	eval {
569	# 1. cancel all watchers
570	$_->cancel for Event::all_watchers;
571
572	# 2. unload all extensions
573	for (@exts) {
574	$msg->("unloading <$_>");
575	unload_extension $_;
576	}
577
578	# 3. unload all modules loaded from $LIBDIR
579	while (my ($k, $v) = each %INC) {
580	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
581
582	$msg->("removing <$k>");
583	delete $INC{$k};
584
585	$k =~ s/\.pm$//;
586	$k =~ s/\//::/g;
587
588	if (my $cb = $k->can ("unload_module")) {
589	$cb->();
590	}
591
592	Symbol::delete_package $k;
593	}
594
595	# 4. get rid of safe::, as good as possible
596	Symbol::delete_package "safe::$_"
597	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
598
599	# 5. remove register_script_function callbacks
600	# TODO
601
602	# 6. unload cf.pm "a bit"
603	delete $INC{"cf.pm"};
604
605	# don't, removes xs symbols, too,
606	# and global variables created in xs
607	#Symbol::delete_package __PACKAGE__;
608
609	# 7. reload cf.pm
610	$msg->("reloading cf.pm");
611	require cf;
612	};
613	$msg->($@) if $@;
614
615	$msg->("reloaded");
616	};
617
618	sub perl_reload() {
619	_perl_reload {
620	warn $_[0];
621	print "$_[0]\n";
622	};
623	}
624
625	register_command "perl-reload", 0, sub {
626	my ($who, $arg) = @_;
627
628	if ($who->flag (FLAG_WIZ)) {
629	_perl_reload {
630	warn $_[0];
631	$who->message ($_[0]);
632	};	1285	}
		1286
		1287	cf::override;
633	}	1288	},
634	};
635
636	#############################################################################
637	# extcmd framework, basically convert ext <msg>
638	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
639
640	attach_to_players
641	on_extcmd => sub {	1289	on_extcmd => sub {
642	my ($pl, $buf) = @_;	1290	my ($pl, $buf) = @_;
643		1291
644	my $msg = eval { from_json $buf };	1292	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
645		1293
646	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
647	if (my $cb = $extcmd{$msg->{msgtype}}) {	1302	if (my $cb = $EXTCMD{$type}) {
648	if (my %reply = $cb->[0]->($pl, $msg)) {	1303	@reply = $cb->($pl, @payload);
649	$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	# and all this just because we cannot iterate over
		1868	# all maps in C++...
		1869	sub change_all_map_light {
		1870	my ($change) = @_;
		1871
		1872	$_->change_map_light ($change)
		1873	for grep $_->outdoor, values %cf::MAP;
		1874	}
		1875
		1876	sub decay_objects {
		1877	my ($self) = @_;
		1878
		1879	return if $self->{deny_reset};
		1880
		1881	$self->do_decay_objects;
		1882	}
		1883
		1884	sub unlink_save {
		1885	my ($self) = @_;
		1886
		1887	utf8::encode (my $save = $self->save_path);
		1888	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1889	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1890	}
		1891
		1892	sub load_header_from($) {
		1893	my ($self, $path) = @_;
		1894
		1895	utf8::encode $path;
		1896	my $f = new_from_file cf::object::thawer $path
		1897	or return;
		1898
		1899	$self->_load_header ($f)
		1900	or return;
		1901
		1902	local $MAP_LOADING{$self->{path}} = $self;
		1903	$f->resolve_delayed_derefs;
		1904
		1905	$self->{load_path} = $path;
		1906
		1907	1
		1908	}
		1909
		1910	sub load_header_orig {
		1911	my ($self) = @_;
		1912
		1913	$self->load_header_from ($self->load_path)
		1914	}
		1915
		1916	sub load_header_temp {
		1917	my ($self) = @_;
		1918
		1919	$self->load_header_from ($self->save_path)
		1920	}
		1921
		1922	sub prepare_temp {
		1923	my ($self) = @_;
		1924
		1925	$self->last_access ((delete $self->{last_access})
		1926	|| $cf::RUNTIME); #d#
		1927	# safety
		1928	$self->{instantiate_time} = $cf::RUNTIME
		1929	if $self->{instantiate_time} > $cf::RUNTIME;
		1930	}
		1931
		1932	sub prepare_orig {
		1933	my ($self) = @_;
		1934
		1935	$self->{load_original} = 1;
		1936	$self->{instantiate_time} = $cf::RUNTIME;
		1937	$self->last_access ($cf::RUNTIME);
		1938	$self->instantiate;
		1939	}
		1940
		1941	sub load_header {
		1942	my ($self) = @_;
		1943
		1944	if ($self->load_header_temp) {
		1945	$self->prepare_temp;
		1946	} else {
		1947	$self->load_header_orig
		1948	or return;
		1949	$self->prepare_orig;
		1950	}
		1951
		1952	$self->{deny_reset} = 1
		1953	if $self->no_reset;
		1954
		1955	$self->default_region (cf::region::find_by_path $self->{path})
		1956	unless $self->default_region;
		1957
		1958	1
		1959	}
		1960
		1961	sub find;
		1962	sub find {
		1963	my ($path, $origin) = @_;
		1964
		1965	$path = normalise $path, $origin && $origin->path;
		1966
		1967	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
		1968	my $guard2 = cf::lock_acquire "map_find:$path";
		1969
		1970	$cf::MAP{$path} || do {
		1971	my $map = new_from_path cf::map $path
		1972	or return;
		1973
		1974	$map->{last_save} = $cf::RUNTIME;
		1975
		1976	$map->load_header
		1977	or return;
		1978
		1979	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1980	# doing this can freeze the server in a sync job, obviously
		1981	#$cf::WAIT_FOR_TICK->wait;
		1982	undef $guard2;
		1983	undef $guard1;
		1984	$map->reset;
		1985	return find $path;
		1986	}
		1987
		1988	$cf::MAP{$path} = $map
		1989	}
		1990	}
		1991
		1992	sub pre_load { }
		1993	sub post_load { }
		1994
		1995	sub load {
		1996	my ($self) = @_;
		1997
		1998	local $self->{deny_reset} = 1; # loading can take a long time
		1999
		2000	my $path = $self->{path};
		2001
		2002	{
		2003	my $guard = cf::lock_acquire "map_data:$path";
		2004
		2005	return unless $self->valid;
		2006	return unless $self->in_memory == cf::MAP_SWAPPED;
		2007
		2008	$self->in_memory (cf::MAP_LOADING);
		2009
		2010	$self->alloc;
		2011
		2012	$self->pre_load;
		2013	cf::cede_to_tick;
		2014
		2015	my $f = new_from_file cf::object::thawer $self->{load_path};
		2016	$f->skip_block;
		2017	$self->_load_objects ($f)
		2018	or return;
		2019
		2020	$self->post_load_original
		2021	if delete $self->{load_original};
		2022
		2023	if (my $uniq = $self->uniq_path) {
		2024	utf8::encode $uniq;
		2025	unless (aio_stat $uniq) {
		2026	if (my $f = new_from_file cf::object::thawer $uniq) {
		2027	$self->clear_unique_items;
		2028	$self->_load_objects ($f);
		2029	$f->resolve_delayed_derefs;
650	}	2030	}
651	}	2031	}
652	} else {
653	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
654	}	2032	}
655		2033
656	cf::override;	2034	$f->resolve_delayed_derefs;
		2035
		2036	cf::cede_to_tick;
		2037	# now do the right thing for maps
		2038	$self->link_multipart_objects;
		2039	$self->difficulty ($self->estimate_difficulty)
		2040	unless $self->difficulty;
		2041	cf::cede_to_tick;
		2042
		2043	unless ($self->{deny_activate}) {
		2044	$self->decay_objects;
		2045	$self->fix_auto_apply;
		2046	$self->update_buttons;
		2047	cf::cede_to_tick;
		2048	$self->set_darkness_map;
		2049	cf::cede_to_tick;
		2050	$self->activate;
		2051	}
		2052
		2053	$self->{last_save} = $cf::RUNTIME;
		2054	$self->last_access ($cf::RUNTIME);
		2055
		2056	$self->in_memory (cf::MAP_ACTIVE);
657	},	2057	}
658	;
659		2058
660	#############################################################################	2059	$self->post_load;
661	# load/save/clean perl data associated with a map	2060	}
662		2061
663	*cf::mapsupport::on_clean = sub {	2062	sub customise_for {
		2063	my ($self, $ob) = @_;
		2064
		2065	return find "~" . $ob->name . "/" . $self->{path}
		2066	if $self->per_player;
		2067
		2068	# return find "?party/" . $ob->name . "/" . $self->{path}
		2069	# if $self->per_party;
		2070
		2071	$self
		2072	}
		2073
		2074	# find and load all maps in the 3x3 area around a map
		2075	sub load_neighbours {
664	my ($map) = @_;	2076	my ($map) = @_;
665		2077
666	my $path = $map->tmpname;	2078	my @neigh; # diagonal neighbours
667	defined $path or return;
668		2079
669	unlink "$path.cfperl";	2080	for (0 .. 3) {
670	unlink "$path.pst";	2081	my $neigh = $map->tile_path ($_)
671	};	2082	or next;
		2083	$neigh = find $neigh, $map
		2084	or next;
		2085	$neigh->load;
672		2086
673	*cf::mapsupport::on_swapin =	2087	push @neigh,
674	*cf::mapsupport::on_load = sub {	2088	[$neigh->tile_path (($_ + 3) % 4), $neigh],
		2089	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		2090	}
		2091
		2092	for (grep defined $_->[0], @neigh) {
		2093	my ($path, $origin) = @$_;
		2094	my $neigh = find $path, $origin
		2095	or next;
		2096	$neigh->load;
		2097	}
		2098	}
		2099
		2100	sub find_sync {
		2101	my ($path, $origin) = @_;
		2102
		2103	cf::sync_job { find $path, $origin }
		2104	}
		2105
		2106	sub do_load_sync {
675	my ($map) = @_;	2107	my ($map) = @_;
676		2108
677	my $path = $map->tmpname;	2109	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
678	$path = $map->path unless defined $path;	2110	if $Coro::current == $Coro::main;
679		2111
680	open my $fh, "<:raw", "$path.cfperl"	2112	cf::sync_job { $map->load };
681	or return; # no perl data
682
683	my $data = Storable::thaw do { local $/; <$fh> };
684
685	$data->{version} <= 1
686	or return; # too new
687
688	$map->_set_obs ($data->{obs});
689	};
690
691	attach_to_maps prio => -10000, package => cf::mapsupport::;
692
693	#############################################################################
694	# load/save perl data associated with player->ob objects
695
696	sub all_objects(@) {
697	@_, map all_objects ($_->inv), @_
698	}	2113	}
699		2114
700	attach_to_players	2115	our %MAP_PREFETCH;
701	on_load => sub {	2116	our $MAP_PREFETCHER = undef;
702	my ($pl, $path) = @_;
703		2117
704	for my $o (all_objects $pl->ob) {	2118	sub find_async {
705	if (my $value = $o->get_ob_key_value ("_perl_data")) {	2119	my ($path, $origin, $load) = @_;
706	$o->set_ob_key_value ("_perl_data");
707		2120
708	%$o = %{ Storable::thaw pack "H*", $value };	2121	$path = normalise $path, $origin && $origin->{path};
		2122
		2123	if (my $map = $cf::MAP{$path}) {
		2124	return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
		2125	}
		2126
		2127	$MAP_PREFETCH{$path} |= $load;
		2128
		2129	$MAP_PREFETCHER ||= cf::async {
		2130	$Coro::current->{desc} = "map prefetcher";
		2131
		2132	while (%MAP_PREFETCH) {
		2133	while (my ($k, $v) = each %MAP_PREFETCH) {
		2134	if (my $map = find $k) {
		2135	$map->load if $v;
		2136	}
		2137
		2138	delete $MAP_PREFETCH{$k};
709	}	2139	}
710	}	2140	}
		2141	undef $MAP_PREFETCHER;
		2142	};
		2143	$MAP_PREFETCHER->prio (6);
		2144
		2145	()
		2146	}
		2147
		2148	sub save {
		2149	my ($self) = @_;
		2150
		2151	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2152
		2153	$self->{last_save} = $cf::RUNTIME;
		2154
		2155	return unless $self->dirty;
		2156
		2157	my $save = $self->save_path; utf8::encode $save;
		2158	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2159
		2160	$self->{load_path} = $save;
		2161
		2162	return if $self->{deny_save};
		2163
		2164	local $self->{last_access} = $self->last_access;#d#
		2165
		2166	cf::async {
		2167	$Coro::current->{desc} = "map player save";
		2168	$_->contr->save for $self->players;
		2169	};
		2170
		2171	cf::get_slot 0.02;
		2172
		2173	if ($uniq) {
		2174	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		2175	$self->_save_objects ($uniq, cf::IO_UNIQUES);
		2176	} else {
		2177	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
711	},	2178	}
712	;
713
714	#############################################################################
715	# core extensions - in perl
716
717	=item cf::player::exists $login
718
719	Returns true when the given account exists.
720
721	=cut
722
723	sub cf::player::exists($) {
724	cf::player::find $_[0]
725	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
726	}	2179	}
727		2180
		2181	sub swap_out {
		2182	my ($self) = @_;
		2183
		2184	# save first because save cedes
		2185	$self->save;
		2186
		2187	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2188
		2189	return if $self->players;
		2190	return if $self->in_memory != cf::MAP_ACTIVE;
		2191	return if $self->{deny_save};
		2192
		2193	$self->in_memory (cf::MAP_SWAPPED);
		2194
		2195	$self->deactivate;
		2196	$_->clear_links_to ($self) for values %cf::MAP;
		2197	$self->clear;
		2198	}
		2199
		2200	sub reset_at {
		2201	my ($self) = @_;
		2202
		2203	# TODO: safety, remove and allow resettable per-player maps
		2204	return 1e99 if $self->{deny_reset};
		2205
		2206	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		2207	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		2208
		2209	$time + $to
		2210	}
		2211
		2212	sub should_reset {
		2213	my ($self) = @_;
		2214
		2215	$self->reset_at <= $cf::RUNTIME
		2216	}
		2217
		2218	sub reset {
		2219	my ($self) = @_;
		2220
		2221	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2222
		2223	return if $self->players;
		2224
		2225	warn "resetting map ", $self->path;
		2226
		2227	$self->in_memory (cf::MAP_SWAPPED);
		2228
		2229	# need to save uniques path
		2230	unless ($self->{deny_save}) {
		2231	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2232
		2233	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2234	if $uniq;
		2235	}
		2236
		2237	delete $cf::MAP{$self->path};
		2238
		2239	$self->deactivate;
		2240	$_->clear_links_to ($self) for values %cf::MAP;
		2241	$self->clear;
		2242
		2243	$self->unlink_save;
		2244	$self->destroy;
		2245	}
		2246
		2247	my $nuke_counter = "aaaa";
		2248
		2249	sub nuke {
		2250	my ($self) = @_;
		2251
		2252	{
		2253	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2254
		2255	delete $cf::MAP{$self->path};
		2256
		2257	$self->unlink_save;
		2258
		2259	bless $self, "cf::map";
		2260	delete $self->{deny_reset};
		2261	$self->{deny_save} = 1;
		2262	$self->reset_timeout (1);
		2263	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2264
		2265	$cf::MAP{$self->path} = $self;
		2266	}
		2267
		2268	$self->reset; # polite request, might not happen
		2269	}
		2270
		2271	=item $maps = cf::map::tmp_maps
		2272
		2273	Returns an arrayref with all map paths of currently instantiated and saved
		2274	maps. May block.
		2275
		2276	=cut
		2277
		2278	sub tmp_maps() {
		2279	[
		2280	map {
		2281	utf8::decode $_;
		2282	/\.map$/
		2283	? normalise $_
		2284	: ()
		2285	} @{ aio_readdir $TMPDIR or [] }
		2286	]
		2287	}
		2288
		2289	=item $maps = cf::map::random_maps
		2290
		2291	Returns an arrayref with all map paths of currently instantiated and saved
		2292	random maps. May block.
		2293
		2294	=cut
		2295
		2296	sub random_maps() {
		2297	[
		2298	map {
		2299	utf8::decode $_;
		2300	/\.map$/
		2301	? normalise "?random/$_"
		2302	: ()
		2303	} @{ aio_readdir $RANDOMDIR or [] }
		2304	]
		2305	}
		2306
		2307	=item cf::map::unique_maps
		2308
		2309	Returns an arrayref of paths of all shared maps that have
		2310	instantiated unique items. May block.
		2311
		2312	=cut
		2313
		2314	sub unique_maps() {
		2315	[
		2316	map {
		2317	utf8::decode $_;
		2318	s/\.map$//; # TODO future compatibility hack
		2319	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
		2320	? ()
		2321	: normalise $_
		2322	} @{ aio_readdir $UNIQUEDIR or [] }
		2323	]
		2324	}
		2325
		2326	=back
		2327
		2328	=head3 cf::object
		2329
		2330	=cut
		2331
		2332	package cf::object;
		2333
		2334	=over 4
		2335
		2336	=item $ob->inv_recursive
		2337
		2338	Returns the inventory of the object I<and> their inventories, recursively,
		2339	but I<not> the object itself.
		2340
		2341	=cut
		2342
		2343	sub inv_recursive_;
		2344	sub inv_recursive_ {
		2345	map { $_, inv_recursive_ $_->inv } @_
		2346	}
		2347
		2348	sub inv_recursive {
		2349	inv_recursive_ inv $_[0]
		2350	}
		2351
		2352	=item $ref = $ob->ref
		2353
		2354	Creates and returns a persistent reference to an object that can be stored as a string.
		2355
		2356	=item $ob = cf::object::deref ($refstring)
		2357
		2358	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2359	even if the object actually exists. May block.
		2360
		2361	=cut
		2362
		2363	sub deref {
		2364	my ($ref) = @_;
		2365
		2366	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2367	my ($uuid, $name) = ($1, $2);
		2368	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2369	or return;
		2370	$pl->ob->uuid eq $uuid
		2371	or return;
		2372
		2373	$pl->ob
		2374	} else {
		2375	warn "$ref: cannot resolve object reference\n";
		2376	undef
		2377	}
		2378	}
		2379
		2380	package cf;
		2381
		2382	=back
		2383
		2384	=head3 cf::object::player
		2385
		2386	=over 4
		2387
728	=item $player->reply ($npc, $msg[, $flags])	2388	=item $player_object->reply ($npc, $msg[, $flags])
729		2389
730	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	2390	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
731	can be C<undef>. Does the right thing when the player is currently in a	2391	can be C<undef>. Does the right thing when the player is currently in a
732	dialogue with the given NPC character.	2392	dialogue with the given NPC character.
733		2393
734	=cut	2394	=cut
735		2395
		2396	our $SAY_CHANNEL = {
		2397	id => "say",
		2398	title => "Map",
		2399	reply => "say ",
		2400	tooltip => "Things said to and replied from npcs near you and other players on the same map only.",
		2401	};
		2402
		2403	our $CHAT_CHANNEL = {
		2404	id => "chat",
		2405	title => "Chat",
		2406	reply => "chat ",
		2407	tooltip => "Player chat and shouts, global to the server.",
		2408	};
		2409
736	# rough implementation of a future "reply" method that works	2410	# rough implementation of a future "reply" method that works
737	# with dialog boxes.	2411	# with dialog boxes.
		2412	#TODO: the first argument must go, split into a $npc->reply_to ( method
738	sub cf::object::player::reply($$$;$) {	2413	sub cf::object::player::reply($$$;$) {
739	my ($self, $npc, $msg, $flags) = @_;	2414	my ($self, $npc, $msg, $flags) = @_;
740		2415
741	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2416	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
742		2417
743	if ($self->{record_replies}) {	2418	if ($self->{record_replies}) {
744	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2419	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2420
745	} else {	2421	} else {
		2422	my $pl = $self->contr;
		2423
		2424	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2425	my $dialog = $pl->{npc_dialog};
		2426	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2427
		2428	} else {
746	$msg = $npc->name . " says: $msg" if $npc;	2429	$msg = $npc->name . " says: $msg" if $npc;
747	$self->message ($msg, $flags);	2430	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2431	}
		2432	}
		2433	}
		2434
		2435	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2436
		2437	=cut
		2438
		2439	sub cf::object::send_msg {
		2440	my $pl = shift->contr
		2441	or return;
		2442	$pl->send_msg (@_);
		2443	}
		2444
		2445	=item $player_object->may ("access")
		2446
		2447	Returns wether the given player is authorized to access resource "access"
		2448	(e.g. "command_wizcast").
		2449
		2450	=cut
		2451
		2452	sub cf::object::player::may {
		2453	my ($self, $access) = @_;
		2454
		2455	$self->flag (cf::FLAG_WIZ) ||
		2456	(ref $cf::CFG{"may_$access"}
		2457	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		2458	: $cf::CFG{"may_$access"})
		2459	}
		2460
		2461	=item $player_object->enter_link
		2462
		2463	Freezes the player and moves him/her to a special map (C<{link}>).
		2464
		2465	The player should be reasonably safe there for short amounts of time (e.g.
		2466	for loading a map). You I<MUST> call C<leave_link> as soon as possible,
		2467	though, as the palyer cannot control the character while it is on the link
		2468	map.
		2469
		2470	Will never block.
		2471
		2472	=item $player_object->leave_link ($map, $x, $y)
		2473
		2474	Moves the player out of the special C<{link}> map onto the specified
		2475	map. If the map is not valid (or omitted), the player will be moved back
		2476	to the location he/she was before the call to C<enter_link>, or, if that
		2477	fails, to the emergency map position.
		2478
		2479	Might block.
		2480
		2481	=cut
		2482
		2483	sub link_map {
		2484	unless ($LINK_MAP) {
		2485	$LINK_MAP = cf::map::find "{link}"
		2486	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2487	$LINK_MAP->load;
		2488	}
		2489
		2490	$LINK_MAP
		2491	}
		2492
		2493	sub cf::object::player::enter_link {
		2494	my ($self) = @_;
		2495
		2496	$self->deactivate_recursive;
		2497
		2498	return if UNIVERSAL::isa $self->map, "ext::map_link";
		2499
		2500	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		2501	if $self->map && $self->map->{path} ne "{link}";
		2502
		2503	$self->enter_map ($LINK_MAP || link_map, 10, 10);
		2504	}
		2505
		2506	sub cf::object::player::leave_link {
		2507	my ($self, $map, $x, $y) = @_;
		2508
		2509	return unless $self->contr->active;
		2510
		2511	my $link_pos = delete $self->{_link_pos};
		2512
		2513	unless ($map) {
		2514	# restore original map position
		2515	($map, $x, $y) = @{ $link_pos || [] };
		2516	$map = cf::map::find $map;
		2517
		2518	unless ($map) {
		2519	($map, $x, $y) = @$EMERGENCY_POSITION;
		2520	$map = cf::map::find $map
		2521	or die "FATAL: cannot load emergency map\n";
		2522	}
		2523	}
		2524
		2525	($x, $y) = (-1, -1)
		2526	unless (defined $x) && (defined $y);
		2527
		2528	# use -1 or undef as default coordinates, not 0, 0
		2529	($x, $y) = ($map->enter_x, $map->enter_y)
		2530	if $x <=0 && $y <= 0;
		2531
		2532	$map->load;
		2533	$map->load_neighbours;
		2534
		2535	return unless $self->contr->active;
		2536	$self->flag (cf::FLAG_DEBUG, 0);#d# temp
		2537	$self->activate_recursive;
		2538
		2539	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
		2540	$self->enter_map ($map, $x, $y);
		2541	}
		2542
		2543	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
		2544
		2545	Moves the player to the given map-path and coordinates by first freezing
		2546	her, loading and preparing them map, calling the provided $check callback
		2547	that has to return the map if sucecssful, and then unfreezes the player on
		2548	the new (success) or old (failed) map position. In either case, $done will
		2549	be called at the end of this process.
		2550
		2551	Note that $check will be called with a potentially non-loaded map, so if
		2552	it needs a loaded map it has to call C<< ->load >>.
		2553
		2554	=cut
		2555
		2556	our $GOTOGEN;
		2557
		2558	sub cf::object::player::goto {
		2559	my ($self, $path, $x, $y, $check, $done) = @_;
		2560
		2561	# do generation counting so two concurrent goto's will be executed in-order
		2562	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
		2563
		2564	$self->enter_link;
		2565
		2566	(async {
		2567	$Coro::current->{desc} = "player::goto $path $x $y";
		2568
		2569	# *tag paths override both path and x|y
		2570	if ($path =~ /^\*(.*)$/) {
		2571	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2572	my $ob = $obs[rand @obs];
		2573
		2574	# see if we actually can go there
		2575	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2576	$ob = $obs[rand @obs];
		2577	} else {
		2578	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2579	}
		2580	# else put us there anyways for now #d#
		2581
		2582	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2583	} else {
		2584	($path, $x, $y) = (undef, undef, undef);
		2585	}
		2586	}
		2587
		2588	my $map = eval {
		2589	my $map = defined $path ? cf::map::find $path : undef;
		2590
		2591	if ($map) {
		2592	$map = $map->customise_for ($self);
		2593	$map = $check->($map) if $check && $map;
		2594	} else {
		2595	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2596	}
		2597
		2598	$map
		2599	};
		2600
		2601	if ($@) {
		2602	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2603	LOG llevError | logBacktrace, Carp::longmess $@;
		2604	}
		2605
		2606	if ($gen == $self->{_goto_generation}) {
		2607	delete $self->{_goto_generation};
		2608	$self->leave_link ($map, $x, $y);
		2609	}
		2610
		2611	$done->() if $done;
		2612	})->prio (1);
		2613	}
		2614
		2615	=item $player_object->enter_exit ($exit_object)
		2616
		2617	=cut
		2618
		2619	sub parse_random_map_params {
		2620	my ($spec) = @_;
		2621
		2622	my $rmp = { # defaults
		2623	xsize => (cf::rndm 15, 40),
		2624	ysize => (cf::rndm 15, 40),
		2625	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2626	#layout => string,
748	}	2627	};
749	}
750		2628
		2629	for (split /\n/, $spec) {
		2630	my ($k, $v) = split /\s+/, $_, 2;
		2631
		2632	$rmp->{lc $k} = $v if (length $k) && (length $v);
		2633	}
		2634
		2635	$rmp
		2636	}
		2637
		2638	sub prepare_random_map {
		2639	my ($exit) = @_;
		2640
		2641	# all this does is basically replace the /! path by
		2642	# a new random map path (?random/...) with a seed
		2643	# that depends on the exit object
		2644
		2645	my $rmp = parse_random_map_params $exit->msg;
		2646
		2647	if ($exit->map) {
		2648	$rmp->{region} = $exit->region->name;
		2649	$rmp->{origin_map} = $exit->map->path;
		2650	$rmp->{origin_x} = $exit->x;
		2651	$rmp->{origin_y} = $exit->y;
		2652
		2653	$exit->map->touch;
		2654	}
		2655
		2656	$rmp->{random_seed} ||= $exit->random_seed;
		2657
		2658	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
		2659	my $md5 = Digest::MD5::md5_hex $data;
		2660	my $meta = "$RANDOMDIR/$md5.meta";
		2661
		2662	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		2663	aio_write $fh, 0, (length $data), $data, 0;
		2664	undef $fh;
		2665	aio_rename "$meta~", $meta;
		2666
		2667	my $slaying = "?random/$md5";
		2668
		2669	if ($exit->valid) {
		2670	$exit->slaying ("?random/$md5");
		2671	$exit->msg (undef);
		2672	}
		2673	}
		2674	}
		2675
		2676	sub cf::object::player::enter_exit {
		2677	my ($self, $exit) = @_;
		2678
		2679	return unless $self->type == cf::PLAYER;
		2680
		2681	$self->enter_link;
		2682
		2683	(async {
		2684	$Coro::current->{desc} = "enter_exit";
		2685
		2686	unless (eval {
		2687	$self->deactivate_recursive; # just to be sure
		2688
		2689	# random map handling
		2690	{
		2691	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2692
		2693	prepare_random_map $exit
		2694	if $exit->slaying eq "/!";
		2695	}
		2696
		2697	my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2698	my $x = $exit->stats->hp;
		2699	my $y = $exit->stats->sp;
		2700
		2701	$self->goto ($map, $x, $y);
		2702
		2703	# if exit is damned, update players death & WoR home-position
		2704	$self->contr->savebed ($map, $x, $y)
		2705	if $exit->flag (cf::FLAG_DAMNED);
		2706
		2707	1
		2708	}) {
		2709	$self->message ("Something went wrong deep within the deliantra server. "
		2710	. "I'll try to bring you back to the map you were before. "
		2711	. "Please report this to the dungeon master!",
		2712	cf::NDI_UNIQUE | cf::NDI_RED);
		2713
		2714	warn "ERROR in enter_exit: $@";
		2715	$self->leave_link;
		2716	}
		2717	})->prio (1);
		2718	}
		2719
		2720	=head3 cf::client
		2721
		2722	=over 4
		2723
		2724	=item $client->send_drawinfo ($text, $flags)
		2725
		2726	Sends a drawinfo packet to the client. Circumvents output buffering so
		2727	should not be used under normal circumstances.
		2728
		2729	=cut
		2730
		2731	sub cf::client::send_drawinfo {
		2732	my ($self, $text, $flags) = @_;
		2733
		2734	utf8::encode $text;
		2735	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
		2736	}
		2737
		2738	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2739
		2740	Send a drawinfo or msg packet to the client, formatting the msg for the
		2741	client if neccessary. C<$type> should be a string identifying the type of
		2742	the message, with C<log> being the default. If C<$color> is negative, suppress
		2743	the message unless the client supports the msg packet.
		2744
		2745	=cut
		2746
		2747	# non-persistent channels (usually the info channel)
		2748	our %CHANNEL = (
		2749	"c/identify" => {
		2750	id => "infobox",
		2751	title => "Identify",
		2752	reply => undef,
		2753	tooltip => "Items recently identified",
		2754	},
		2755	"c/examine" => {
		2756	id => "infobox",
		2757	title => "Examine",
		2758	reply => undef,
		2759	tooltip => "Signs and other items you examined",
		2760	},
		2761	"c/book" => {
		2762	id => "infobox",
		2763	title => "Book",
		2764	reply => undef,
		2765	tooltip => "The contents of a note or book",
		2766	},
		2767	"c/lookat" => {
		2768	id => "infobox",
		2769	title => "Look",
		2770	reply => undef,
		2771	tooltip => "What you saw there",
		2772	},
		2773	"c/who" => {
		2774	id => "infobox",
		2775	title => "Players",
		2776	reply => undef,
		2777	tooltip => "Shows players who are currently online",
		2778	},
		2779	"c/body" => {
		2780	id => "infobox",
		2781	title => "Body Parts",
		2782	reply => undef,
		2783	tooltip => "Shows which body parts you posess and are available",
		2784	},
		2785	"c/skills" => {
		2786	id => "infobox",
		2787	title => "Skills",
		2788	reply => undef,
		2789	tooltip => "Shows your experience per skill and item power",
		2790	},
		2791	"c/uptime" => {
		2792	id => "infobox",
		2793	title => "Uptime",
		2794	reply => undef,
		2795	tooltip => "How long the server has been running since last restart",
		2796	},
		2797	"c/mapinfo" => {
		2798	id => "infobox",
		2799	title => "Map Info",
		2800	reply => undef,
		2801	tooltip => "Information related to the maps",
		2802	},
		2803	"c/party" => {
		2804	id => "party",
		2805	title => "Party",
		2806	reply => "gsay ",
		2807	tooltip => "Messages and chat related to your party",
		2808	},
		2809	);
		2810
		2811	sub cf::client::send_msg {
		2812	my ($self, $channel, $msg, $color, @extra) = @_;
		2813
		2814	$msg = $self->pl->expand_cfpod ($msg)
		2815	unless $color & cf::NDI_VERBATIM;
		2816
		2817	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2818
		2819	# check predefined channels, for the benefit of C
		2820	if ($CHANNEL{$channel}) {
		2821	$channel = $CHANNEL{$channel};
		2822
		2823	$self->ext_msg (channel_info => $channel)
		2824	if $self->can_msg;
		2825
		2826	$channel = $channel->{id};
		2827
		2828	} elsif (ref $channel) {
		2829	# send meta info to client, if not yet sent
		2830	unless (exists $self->{channel}{$channel->{id}}) {
		2831	$self->{channel}{$channel->{id}} = $channel;
		2832	$self->ext_msg (channel_info => $channel)
		2833	if $self->can_msg;
		2834	}
		2835
		2836	$channel = $channel->{id};
		2837	}
		2838
		2839	return unless @extra || length $msg;
		2840
		2841	if ($self->can_msg) {
		2842	# default colour, mask it out
		2843	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2844	if $color & cf::NDI_DEF;
		2845
		2846	my $pkt = "msg "
		2847	. $self->{json_coder}->encode (
		2848	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
		2849	);
		2850
		2851	# try lzf for large packets
		2852	$pkt = "lzf " . Compress::LZF::compress $pkt
		2853	if 1024 <= length $pkt and $self->{can_lzf};
		2854
		2855	# split very large packets
		2856	if (8192 < length $pkt and $self->{can_lzf}) {
		2857	$self->send_packet ("frag $_") for unpack "(a8192)*", $pkt;
		2858	$pkt = "frag";
		2859	}
		2860
		2861	$self->send_packet ($pkt);
		2862	} else {
		2863	if ($color >= 0) {
		2864	# replace some tags by gcfclient-compatible ones
		2865	for ($msg) {
		2866	1 while
		2867	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2868	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2869	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2870	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2871	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2872	}
		2873
		2874	$color &= cf::NDI_COLOR_MASK;
		2875
		2876	utf8::encode $msg;
		2877
		2878	if (0 && $msg =~ /\[/) {
		2879	# COMMAND/INFO
		2880	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2881	} else {
		2882	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2883	$self->send_packet ("drawinfo $color $msg")
		2884	}
		2885	}
		2886	}
		2887	}
		2888
		2889	=item $client->ext_msg ($type, @msg)
		2890
		2891	Sends an ext event to the client.
		2892
		2893	=cut
		2894
		2895	sub cf::client::ext_msg($$@) {
		2896	my ($self, $type, @msg) = @_;
		2897
		2898	if ($self->extcmd == 2) {
		2899	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2900	} elsif ($self->extcmd == 1) { # TODO: remove
		2901	push @msg, msgtype => "event_$type";
		2902	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2903	}
		2904	}
		2905
751	=item $player->ext_reply ($msgid, $msgtype, %msg)	2906	=item $client->ext_reply ($msgid, @msg)
752		2907
753	Sends an ext reply to the player.	2908	Sends an ext reply to the client.
754		2909
755	=cut	2910	=cut
756		2911
757	sub cf::player::ext_reply($$$%) {	2912	sub cf::client::ext_reply($$@) {
758	my ($self, $id, %msg) = @_;	2913	my ($self, $id, @msg) = @_;
759		2914
760	$msg{msgid} = $id;	2915	if ($self->extcmd == 2) {
761		2916	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
762	$self->send ("ext " . to_json \%msg);	2917	} elsif ($self->extcmd == 1) {
		2918	#TODO: version 1, remove
		2919	unshift @msg, msgtype => "reply", msgid => $id;
		2920	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2921	}
763	}	2922	}
764		2923
765	#############################################################################	2924	=item $success = $client->query ($flags, "text", \&cb)
766	# map scripting support	2925
		2926	Queues a query to the client, calling the given callback with
		2927	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		2928	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		2929
		2930	Queries can fail, so check the return code. Or don't, as queries will
		2931	become reliable at some point in the future.
		2932
		2933	=cut
		2934
		2935	sub cf::client::query {
		2936	my ($self, $flags, $text, $cb) = @_;
		2937
		2938	return unless $self->state == ST_PLAYING
		2939	|| $self->state == ST_SETUP
		2940	|| $self->state == ST_CUSTOM;
		2941
		2942	$self->state (ST_CUSTOM);
		2943
		2944	utf8::encode $text;
		2945	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		2946
		2947	$self->send_packet ($self->{query_queue}[0][0])
		2948	if @{ $self->{query_queue} } == 1;
		2949
		2950	1
		2951	}
		2952
		2953	cf::client->attach (
		2954	on_connect => sub {
		2955	my ($ns) = @_;
		2956
		2957	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2958	},
		2959	on_reply => sub {
		2960	my ($ns, $msg) = @_;
		2961
		2962	# this weird shuffling is so that direct followup queries
		2963	# get handled first
		2964	my $queue = delete $ns->{query_queue}
		2965	or return; # be conservative, not sure how that can happen, but we saw a crash here
		2966
		2967	(shift @$queue)->[1]->($msg);
		2968	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
		2969
		2970	push @{ $ns->{query_queue} }, @$queue;
		2971
		2972	if (@{ $ns->{query_queue} } == @$queue) {
		2973	if (@$queue) {
		2974	$ns->send_packet ($ns->{query_queue}[0][0]);
		2975	} else {
		2976	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		2977	}
		2978	}
		2979	},
		2980	on_exticmd => sub {
		2981	my ($ns, $buf) = @_;
		2982
		2983	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2984
		2985	if (ref $msg) {
		2986	my ($type, $reply, @payload) =
		2987	"ARRAY" eq ref $msg
		2988	? @$msg
		2989	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2990
		2991	my @reply;
		2992
		2993	if (my $cb = $EXTICMD{$type}) {
		2994	@reply = $cb->($ns, @payload);
		2995	}
		2996
		2997	$ns->ext_reply ($reply, @reply)
		2998	if $reply;
		2999
		3000	} else {
		3001	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		3002	}
		3003
		3004	cf::override;
		3005	},
		3006	);
		3007
		3008	=item $client->async (\&cb)
		3009
		3010	Create a new coroutine, running the specified callback. The coroutine will
		3011	be automatically cancelled when the client gets destroyed (e.g. on logout,
		3012	or loss of connection).
		3013
		3014	=cut
		3015
		3016	sub cf::client::async {
		3017	my ($self, $cb) = @_;
		3018
		3019	my $coro = &Coro::async ($cb);
		3020
		3021	$coro->on_destroy (sub {
		3022	delete $self->{_coro}{$coro+0};
		3023	});
		3024
		3025	$self->{_coro}{$coro+0} = $coro;
		3026
		3027	$coro
		3028	}
		3029
		3030	cf::client->attach (
		3031	on_destroy => sub {
		3032	my ($ns) = @_;
		3033
		3034	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		3035	},
		3036	);
		3037
		3038	=back
		3039
		3040
		3041	=head2 SAFE SCRIPTING
		3042
		3043	Functions that provide a safe environment to compile and execute
		3044	snippets of perl code without them endangering the safety of the server
		3045	itself. Looping constructs, I/O operators and other built-in functionality
		3046	is not available in the safe scripting environment, and the number of
		3047	functions and methods that can be called is greatly reduced.
		3048
		3049	=cut
767		3050
768	our $safe = new Safe "safe";	3051	our $safe = new Safe "safe";
769	our $safe_hole = new Safe::Hole;	3052	our $safe_hole = new Safe::Hole;
770		3053
771	$SIG{FPE} = 'IGNORE';	3054	$SIG{FPE} = 'IGNORE';
772		3055
773	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3056	$safe->permit_only (Opcode::opset qw(
		3057	:base_core :base_mem :base_orig :base_math
		3058	grepstart grepwhile mapstart mapwhile
		3059	sort time
		3060	));
774		3061
775	# here we export the classes and methods available to script code	3062	# here we export the classes and methods available to script code
776		3063
		3064	=pod
		3065
		3066	The following functions and methods are available within a safe environment:
		3067
		3068	cf::object
		3069	contr pay_amount pay_player map x y force_find force_add destroy
		3070	insert remove name archname title slaying race decrease split
		3071
		3072	cf::object::player
		3073	player
		3074
		3075	cf::player
		3076	peaceful
		3077
		3078	cf::map
		3079	trigger
		3080
		3081	=cut
		3082
777	for (	3083	for (
778	["cf::object" => qw(contr pay_amount pay_player)],	3084	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3085	insert remove inv nrof name archname title slaying race
		3086	decrease split destroy change_exp)],
779	["cf::object::player" => qw(player)],	3087	["cf::object::player" => qw(player)],
780	["cf::player" => qw(peaceful)],	3088	["cf::player" => qw(peaceful)],
		3089	["cf::map" => qw(trigger)],
781	) {	3090	) {
782	no strict 'refs';	3091	no strict 'refs';
783	my ($pkg, @funs) = @$_;	3092	my ($pkg, @funs) = @$_;
784	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3093	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
785	for @funs;	3094	for @funs;
786	}	3095	}
		3096
		3097	=over 4
		3098
		3099	=item @retval = safe_eval $code, [var => value, ...]
		3100
		3101	Compiled and executes the given perl code snippet. additional var/value
		3102	pairs result in temporary local (my) scalar variables of the given name
		3103	that are available in the code snippet. Example:
		3104
		3105	my $five = safe_eval '$first + $second', first => 1, second => 4;
		3106
		3107	=cut
787		3108
788	sub safe_eval($;@) {	3109	sub safe_eval($;@) {
789	my ($code, %vars) = @_;	3110	my ($code, %vars) = @_;
790		3111
791	my $qcode = $code;	3112	my $qcode = $code;
…		…
814	}	3135	}
815		3136
816	wantarray ? @res : $res[0]	3137	wantarray ? @res : $res[0]
817	}	3138	}
818		3139
		3140	=item cf::register_script_function $function => $cb
		3141
		3142	Register a function that can be called from within map/npc scripts. The
		3143	function should be reasonably secure and should be put into a package name
		3144	like the extension.
		3145
		3146	Example: register a function that gets called whenever a map script calls
		3147	C<rent::overview>, as used by the C<rent> extension.
		3148
		3149	cf::register_script_function "rent::overview" => sub {
		3150	...
		3151	};
		3152
		3153	=cut
		3154
819	sub register_script_function {	3155	sub register_script_function {
820	my ($fun, $cb) = @_;	3156	my ($fun, $cb) = @_;
821		3157
822	no strict 'refs';	3158	no strict 'refs';
823	*{"safe::$fun"} = $safe_hole->wrap ($cb);	3159	*{"safe::$fun"} = $safe_hole->wrap ($cb);
824	}	3160	}
825		3161
		3162	=back
		3163
		3164	=cut
		3165
826	#############################################################################	3166	#############################################################################
827	# the server's main()	3167	# the server's init and main functions
		3168
		3169	sub load_facedata($) {
		3170	my ($path) = @_;
		3171
		3172	# HACK to clear player env face cache, we need some signal framework
		3173	# for this (global event?)
		3174	%ext::player_env::MUSIC_FACE_CACHE = ();
		3175
		3176	my $enc = JSON::XS->new->utf8->canonical->relaxed;
		3177
		3178	warn "loading facedata from $path\n";
		3179
		3180	my $facedata;
		3181	0 < aio_load $path, $facedata
		3182	or die "$path: $!";
		3183
		3184	$facedata = Coro::Storable::thaw $facedata;
		3185
		3186	$facedata->{version} == 2
		3187	or cf::cleanup "$path: version mismatch, cannot proceed.";
		3188
		3189	# patch in the exptable
		3190	$facedata->{resource}{"res/exp_table"} = {
		3191	type => FT_RSRC,
		3192	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
		3193	};
		3194	cf::cede_to_tick;
		3195
		3196	{
		3197	my $faces = $facedata->{faceinfo};
		3198
		3199	while (my ($face, $info) = each %$faces) {
		3200	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		3201
		3202	cf::face::set_visibility $idx, $info->{visibility};
		3203	cf::face::set_magicmap $idx, $info->{magicmap};
		3204	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
		3205	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
		3206
		3207	cf::cede_to_tick;
		3208	}
		3209
		3210	while (my ($face, $info) = each %$faces) {
		3211	next unless $info->{smooth};
		3212
		3213	my $idx = cf::face::find $face
		3214	or next;
		3215
		3216	if (my $smooth = cf::face::find $info->{smooth}) {
		3217	cf::face::set_smooth $idx, $smooth;
		3218	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3219	} else {
		3220	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3221	}
		3222
		3223	cf::cede_to_tick;
		3224	}
		3225	}
		3226
		3227	{
		3228	my $anims = $facedata->{animinfo};
		3229
		3230	while (my ($anim, $info) = each %$anims) {
		3231	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3232	cf::cede_to_tick;
		3233	}
		3234
		3235	cf::anim::invalidate_all; # d'oh
		3236	}
		3237
		3238	{
		3239	# TODO: for gcfclient pleasure, we should give resources
		3240	# that gcfclient doesn't grok a >10000 face index.
		3241	my $res = $facedata->{resource};
		3242
		3243	while (my ($name, $info) = each %$res) {
		3244	if (defined $info->{type}) {
		3245	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3246	my $data;
		3247
		3248	if ($info->{type} & 1) {
		3249	# prepend meta info
		3250
		3251	my $meta = $enc->encode ({
		3252	name => $name,
		3253	%{ $info->{meta} || {} },
		3254	});
		3255
		3256	$data = pack "(w/a*)*", $meta, $info->{data};
		3257	} else {
		3258	$data = $info->{data};
		3259	}
		3260
		3261	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3262	cf::face::set_type $idx, $info->{type};
		3263	} else {
		3264	$RESOURCE{$name} = $info;
		3265	}
		3266
		3267	cf::cede_to_tick;
		3268	}
		3269	}
		3270
		3271	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3272
		3273	1
		3274	}
		3275
		3276	cf::global->attach (on_resource_update => sub {
		3277	if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
		3278	$soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
		3279
		3280	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3281	my $sound = $soundconf->{compat}[$_]
		3282	or next;
		3283
		3284	my $face = cf::face::find "sound/$sound->[1]";
		3285	cf::sound::set $sound->[0] => $face;
		3286	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3287	}
		3288
		3289	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3290	my $face = cf::face::find "sound/$v";
		3291	cf::sound::set $k => $face;
		3292	}
		3293	}
		3294	});
		3295
		3296	register_exticmd fx_want => sub {
		3297	my ($ns, $want) = @_;
		3298
		3299	while (my ($k, $v) = each %$want) {
		3300	$ns->fx_want ($k, $v);
		3301	}
		3302	};
		3303
		3304	sub load_resource_file($) {
		3305	my $guard = lock_acquire "load_resource_file";
		3306
		3307	my $status = load_resource_file_ $_[0];
		3308	get_slot 0.1, 100;
		3309	cf::arch::commit_load;
		3310
		3311	$status
		3312	}
		3313
		3314	sub reload_regions {
		3315	# HACK to clear player env face cache, we need some signal framework
		3316	# for this (global event?)
		3317	%ext::player_env::MUSIC_FACE_CACHE = ();
		3318
		3319	load_resource_file "$MAPDIR/regions"
		3320	or die "unable to load regions file\n";
		3321
		3322	for (cf::region::list) {
		3323	$_->{match} = qr/$_->{match}/
		3324	if exists $_->{match};
		3325	}
		3326	}
		3327
		3328	sub reload_facedata {
		3329	load_facedata "$DATADIR/facedata"
		3330	or die "unable to load facedata\n";
		3331	}
		3332
		3333	sub reload_archetypes {
		3334	load_resource_file "$DATADIR/archetypes"
		3335	or die "unable to load archetypes\n";
		3336	}
		3337
		3338	sub reload_treasures {
		3339	load_resource_file "$DATADIR/treasures"
		3340	or die "unable to load treasurelists\n";
		3341	}
		3342
		3343	sub reload_resources {
		3344	warn "reloading resource files...\n";
		3345
		3346	reload_facedata;
		3347	reload_archetypes;
		3348	reload_regions;
		3349	reload_treasures;
		3350
		3351	warn "finished reloading resource files\n";
		3352	}
		3353
		3354	sub reload_config {
		3355	open my $fh, "<:utf8", "$CONFDIR/config"
		3356	or return;
		3357
		3358	local $/;
		3359	*CFG = YAML::Load <$fh>;
		3360
		3361	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		3362
		3363	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		3364	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		3365
		3366	if (exists $CFG{mlockall}) {
		3367	eval {
		3368	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		3369	and die "WARNING: m(un)lockall failed: $!\n";
		3370	};
		3371	warn $@ if $@;
		3372	}
		3373	}
		3374
		3375	sub pidfile() {
		3376	sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
		3377	or die "$PIDFILE: $!";
		3378	flock $fh, &Fcntl::LOCK_EX
		3379	or die "$PIDFILE: flock: $!";
		3380	$fh
		3381	}
		3382
		3383	# make sure only one server instance is running at any one time
		3384	sub atomic {
		3385	my $fh = pidfile;
		3386
		3387	my $pid = <$fh>;
		3388	kill 9, $pid if $pid > 0;
		3389
		3390	seek $fh, 0, 0;
		3391	print $fh $$;
		3392	}
828		3393
829	sub main {	3394	sub main {
		3395	cf::init_globals; # initialise logging
		3396
		3397	LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
		3398	LOG llevInfo, "Copyright (C) 2005-2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
		3399	LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
		3400	LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
		3401
		3402	cf::init_experience;
		3403	cf::init_anim;
		3404	cf::init_attackmess;
		3405	cf::init_dynamic;
		3406	cf::init_block;
		3407
		3408	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3409
		3410	# we must not ever block the main coroutine
		3411	local $Coro::idle = sub {
		3412	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		3413	(async {
		3414	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3415	EV::loop EV::LOOP_ONESHOT;
		3416	})->prio (Coro::PRIO_MAX);
		3417	};
		3418
		3419	evthread_start IO::AIO::poll_fileno;
		3420
		3421	cf::sync_job {
		3422	reload_resources;
		3423	reload_config;
		3424	db_init;
		3425
		3426	cf::load_settings;
		3427	cf::load_materials;
		3428	cf::init_uuid;
		3429	cf::init_signals;
		3430	cf::init_commands;
		3431	cf::init_skills;
		3432
		3433	cf::init_beforeplay;
		3434
		3435	atomic;
		3436
		3437	load_extensions;
		3438
		3439	utime time, time, $RUNTIMEFILE;
		3440
		3441	# no (long-running) fork's whatsoever before this point(!)
		3442	POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
		3443
		3444	(pop @POST_INIT)->(0) while @POST_INIT;
		3445	};
		3446
830	Event::loop;	3447	EV::loop;
831	}	3448	}
832		3449
833	#############################################################################	3450	#############################################################################
834	# initialisation	3451	# initialisation and cleanup
835		3452
836	register "<global>", __PACKAGE__;	3453	# install some emergency cleanup handlers
		3454	BEGIN {
		3455	our %SIGWATCHER = ();
		3456	for my $signal (qw(INT HUP TERM)) {
		3457	$SIGWATCHER{$signal} = EV::signal $signal, sub {
		3458	cf::cleanup "SIG$signal";
		3459	};
		3460	}
		3461	}
		3462
		3463	sub write_runtime_sync {
		3464	# first touch the runtime file to show we are still running:
		3465	# the fsync below can take a very very long time.
		3466
		3467	IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
		3468
		3469	my $guard = cf::lock_acquire "write_runtime";
		3470
		3471	my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT, 0644
		3472	or return;
		3473
		3474	my $value = $cf::RUNTIME + 90 + 10;
		3475	# 10 is the runtime save interval, for a monotonic clock
		3476	# 60 allows for the watchdog to kill the server.
		3477
		3478	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3479	and return;
		3480
		3481	# always fsync - this file is important
		3482	aio_fsync $fh
		3483	and return;
		3484
		3485	# touch it again to show we are up-to-date
		3486	aio_utime $fh, undef, undef;
		3487
		3488	close $fh
		3489	or return;
		3490
		3491	aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
		3492	and return;
		3493
		3494	warn "runtime file written.\n";
		3495
		3496	1
		3497	}
		3498
		3499	our $uuid_lock;
		3500	our $uuid_skip;
		3501
		3502	sub write_uuid_sync($) {
		3503	$uuid_skip ||= $_[0];
		3504
		3505	return if $uuid_lock;
		3506	local $uuid_lock = 1;
		3507
		3508	my $uuid = "$LOCALDIR/uuid";
		3509
		3510	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3511	or return;
		3512
		3513	my $value = uuid_seq uuid_cur;
		3514
		3515	unless ($value) {
		3516	warn "cowardly refusing to write zero uuid value!\n";
		3517	return;
		3518	}
		3519
		3520	my $value = uuid_str $value + $uuid_skip;
		3521	$uuid_skip = 0;
		3522
		3523	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3524	and return;
		3525
		3526	# always fsync - this file is important
		3527	aio_fsync $fh
		3528	and return;
		3529
		3530	close $fh
		3531	or return;
		3532
		3533	aio_rename "$uuid~", $uuid
		3534	and return;
		3535
		3536	warn "uuid file written ($value).\n";
		3537
		3538	1
		3539
		3540	}
		3541
		3542	sub write_uuid($$) {
		3543	my ($skip, $sync) = @_;
		3544
		3545	$sync ? write_uuid_sync $skip
		3546	: async { write_uuid_sync $skip };
		3547	}
		3548
		3549	sub emergency_save() {
		3550	my $freeze_guard = cf::freeze_mainloop;
		3551
		3552	warn "emergency_perl_save: enter\n";
		3553
		3554	cf::sync_job {
		3555	# this is a trade-off: we want to be very quick here, so
		3556	# save all maps without fsync, and later call a global sync
		3557	# (which in turn might be very very slow)
		3558	local $USE_FSYNC = 0;
		3559
		3560	# use a peculiar iteration method to avoid tripping on perl
		3561	# refcount bugs in for. also avoids problems with players
		3562	# and maps saved/destroyed asynchronously.
		3563	warn "emergency_perl_save: begin player save\n";
		3564	for my $login (keys %cf::PLAYER) {
		3565	my $pl = $cf::PLAYER{$login} or next;
		3566	$pl->valid or next;
		3567	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
		3568	$pl->save;
		3569	}
		3570	warn "emergency_perl_save: end player save\n";
		3571
		3572	warn "emergency_perl_save: begin map save\n";
		3573	for my $path (keys %cf::MAP) {
		3574	my $map = $cf::MAP{$path} or next;
		3575	$map->valid or next;
		3576	$map->save;
		3577	}
		3578	warn "emergency_perl_save: end map save\n";
		3579
		3580	warn "emergency_perl_save: begin database checkpoint\n";
		3581	BDB::db_env_txn_checkpoint $DB_ENV;
		3582	warn "emergency_perl_save: end database checkpoint\n";
		3583
		3584	warn "emergency_perl_save: begin write uuid\n";
		3585	write_uuid_sync 1;
		3586	warn "emergency_perl_save: end write uuid\n";
		3587	};
		3588
		3589	warn "emergency_perl_save: starting sync()\n";
		3590	IO::AIO::aio_sync sub {
		3591	warn "emergency_perl_save: finished sync()\n";
		3592	};
		3593
		3594	warn "emergency_perl_save: leave\n";
		3595	}
		3596
		3597	sub post_cleanup {
		3598	my ($make_core) = @_;
		3599
		3600	warn Carp::longmess "post_cleanup backtrace"
		3601	if $make_core;
		3602
		3603	my $fh = pidfile;
		3604	unlink $PIDFILE if <$fh> == $$;
		3605	}
		3606
		3607	# a safer delete_package, copied from Symbol
		3608	sub clear_package($) {
		3609	my $pkg = shift;
		3610
		3611	# expand to full symbol table name if needed
		3612	unless ($pkg =~ /^main::.*::$/) {
		3613	$pkg = "main$pkg" if $pkg =~ /^::/;
		3614	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		3615	$pkg .= '::' unless $pkg =~ /::$/;
		3616	}
		3617
		3618	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		3619	my $stem_symtab = *{$stem}{HASH};
		3620
		3621	defined $stem_symtab and exists $stem_symtab->{$leaf}
		3622	or return;
		3623
		3624	# clear all symbols
		3625	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		3626	for my $name (keys %$leaf_symtab) {
		3627	_gv_clear *{"$pkg$name"};
		3628	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		3629	}
		3630	warn "cleared package $pkg\n";#d#
		3631	}
		3632
		3633	sub do_reload_perl() {
		3634	# can/must only be called in main
		3635	if ($Coro::current != $Coro::main) {
		3636	warn "can only reload from main coroutine";
		3637	return;
		3638	}
		3639
		3640	return if $RELOAD++;
		3641
		3642	my $t1 = EV::time;
		3643
		3644	while ($RELOAD) {
		3645	warn "reloading...";
		3646
		3647	warn "entering sync_job";
		3648
		3649	cf::sync_job {
		3650	cf::write_runtime_sync; # external watchdog should not bark
		3651	cf::emergency_save;
		3652	cf::write_runtime_sync; # external watchdog should not bark
		3653
		3654	warn "syncing database to disk";
		3655	BDB::db_env_txn_checkpoint $DB_ENV;
		3656
		3657	# if anything goes wrong in here, we should simply crash as we already saved
		3658
		3659	warn "flushing outstanding aio requests";
		3660	while (IO::AIO::nreqs || BDB::nreqs) {
		3661	Coro::EV::timer_once 0.01; # let the sync_job do it's thing
		3662	}
		3663
		3664	warn "cancelling all extension coros";
		3665	$_->cancel for values %EXT_CORO;
		3666	%EXT_CORO = ();
		3667
		3668	warn "removing commands";
		3669	%COMMAND = ();
		3670
		3671	warn "removing ext/exti commands";
		3672	%EXTCMD = ();
		3673	%EXTICMD = ();
		3674
		3675	warn "unloading/nuking all extensions";
		3676	for my $pkg (@EXTS) {
		3677	warn "... unloading $pkg";
		3678
		3679	if (my $cb = $pkg->can ("unload")) {
		3680	eval {
		3681	$cb->($pkg);
		3682	1
		3683	} or warn "$pkg unloaded, but with errors: $@";
		3684	}
		3685
		3686	warn "... clearing $pkg";
		3687	clear_package $pkg;
		3688	}
		3689
		3690	warn "unloading all perl modules loaded from $LIBDIR";
		3691	while (my ($k, $v) = each %INC) {
		3692	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		3693
		3694	warn "... unloading $k";
		3695	delete $INC{$k};
		3696
		3697	$k =~ s/\.pm$//;
		3698	$k =~ s/\//::/g;
		3699
		3700	if (my $cb = $k->can ("unload_module")) {
		3701	$cb->();
		3702	}
		3703
		3704	clear_package $k;
		3705	}
		3706
		3707	warn "getting rid of safe::, as good as possible";
		3708	clear_package "safe::$_"
		3709	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
		3710
		3711	warn "unloading cf.pm \"a bit\"";
		3712	delete $INC{"cf.pm"};
		3713	delete $INC{"cf/pod.pm"};
		3714
		3715	# don't, removes xs symbols, too,
		3716	# and global variables created in xs
		3717	#clear_package __PACKAGE__;
		3718
		3719	warn "unload completed, starting to reload now";
		3720
		3721	warn "reloading cf.pm";
		3722	require cf;
		3723	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
		3724
		3725	warn "loading config and database again";
		3726	cf::reload_config;
		3727
		3728	warn "loading extensions";
		3729	cf::load_extensions;
		3730
		3731	if ($REATTACH_ON_RELOAD) {
		3732	warn "reattaching attachments to objects/players";
		3733	_global_reattach; # objects, sockets
		3734	warn "reattaching attachments to maps";
		3735	reattach $_ for values %MAP;
		3736	warn "reattaching attachments to players";
		3737	reattach $_ for values %PLAYER;
		3738	}
		3739
		3740	warn "running post_init jobs";
		3741	(pop @POST_INIT)->(1) while @POST_INIT;
		3742
		3743	warn "leaving sync_job";
		3744
		3745	1
		3746	} or do {
		3747	warn $@;
		3748	cf::cleanup "error while reloading, exiting.";
		3749	};
		3750
		3751	warn "reloaded";
		3752	--$RELOAD;
		3753	}
		3754
		3755	$t1 = EV::time - $t1;
		3756	warn "reload completed in ${t1}s\n";
		3757	};
		3758
		3759	our $RELOAD_WATCHER; # used only during reload
		3760
		3761	sub reload_perl() {
		3762	# doing reload synchronously and two reloads happen back-to-back,
		3763	# coro crashes during coro_state_free->destroy here.
		3764
		3765	$RELOAD_WATCHER ||= cf::async {
		3766	Coro::AIO::aio_wait cache_extensions;
		3767
		3768	$RELOAD_WATCHER = EV::timer $TICK * 1.5, 0, sub {
		3769	do_reload_perl;
		3770	undef $RELOAD_WATCHER;
		3771	};
		3772	};
		3773	}
		3774
		3775	register_command "reload" => sub {
		3776	my ($who, $arg) = @_;
		3777
		3778	if ($who->flag (FLAG_WIZ)) {
		3779	$who->message ("reloading server.");
		3780	async {
		3781	$Coro::current->{desc} = "perl_reload";
		3782	reload_perl;
		3783	};
		3784	}
		3785	};
837		3786
838	unshift @INC, $LIBDIR;	3787	unshift @INC, $LIBDIR;
839		3788
840	load_extensions;	3789	my $bug_warning = 0;
841		3790
842	$TICK_WATCHER = Event->timer (	3791	our @WAIT_FOR_TICK;
843	prio => 1,	3792	our @WAIT_FOR_TICK_BEGIN;
844	at => $NEXT_TICK || 1,	3793
845	cb => sub {	3794	sub wait_for_tick {
		3795	return if tick_inhibit || $Coro::current == $Coro::main;
		3796
		3797	my $signal = new Coro::Signal;
		3798	push @WAIT_FOR_TICK, $signal;
		3799	$signal->wait;
		3800	}
		3801
		3802	sub wait_for_tick_begin {
		3803	return if tick_inhibit || $Coro::current == $Coro::main;
		3804
		3805	my $signal = new Coro::Signal;
		3806	push @WAIT_FOR_TICK_BEGIN, $signal;
		3807	$signal->wait;
		3808	}
		3809
		3810	sub tick {
		3811	if ($Coro::current != $Coro::main) {
		3812	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3813	unless ++$bug_warning > 10;
		3814	return;
		3815	}
		3816
846	cf::server_tick; # one server iteration	3817	cf::server_tick; # one server iteration
847		3818
848	my $NOW = Event::time;	3819	if ($NOW >= $NEXT_RUNTIME_WRITE) {
849	$NEXT_TICK += $TICK;	3820	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
850		3821	Coro::async_pool {
851	# if we are delayed by four ticks, skip them all	3822	$Coro::current->{desc} = "runtime saver";
852	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	3823	write_runtime_sync
853		3824	or warn "ERROR: unable to write runtime file: $!";
854	$TICK_WATCHER->at ($NEXT_TICK);	3825	};
855	$TICK_WATCHER->start;
856	},	3826	}
857	);
858		3827
859	_reload_2;	3828	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3829	$sig->send;
		3830	}
		3831	while (my $sig = shift @WAIT_FOR_TICK) {
		3832	$sig->send;
		3833	}
		3834
		3835	$LOAD = ($NOW - $TICK_START) / $TICK;
		3836	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3837
		3838	if (0) {
		3839	if ($NEXT_TICK) {
		3840	my $jitter = $TICK_START - $NEXT_TICK;
		3841	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		3842	warn "jitter $JITTER\n";#d#
		3843	}
		3844	}
		3845	}
		3846
		3847	{
		3848	# configure BDB
		3849
		3850	BDB::min_parallel 8;
		3851	BDB::max_poll_reqs $TICK * 0.1;
		3852	$AnyEvent::BDB::WATCHER->priority (1);
		3853
		3854	unless ($DB_ENV) {
		3855	$DB_ENV = BDB::db_env_create;
		3856	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		3857	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		3858	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		3859	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3860	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3861
		3862	cf::sync_job {
		3863	eval {
		3864	BDB::db_env_open
		3865	$DB_ENV,
		3866	$BDBDIR,
		3867	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3868	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3869	0666;
		3870
		3871	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3872	};
		3873
		3874	cf::cleanup "db_env_open(db): $@" if $@;
		3875	};
		3876	}
		3877
		3878	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3879	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3880	};
		3881	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		3882	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3883	};
		3884	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3885	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3886	};
		3887	}
		3888
		3889	{
		3890	# configure IO::AIO
		3891
		3892	IO::AIO::min_parallel 8;
		3893	IO::AIO::max_poll_time $TICK * 0.1;
		3894	undef $AnyEvent::AIO::WATCHER;
		3895	}
		3896
		3897	my $_log_backtrace;
		3898
		3899	sub _log_backtrace {
		3900	my ($msg, @addr) = @_;
		3901
		3902	$msg =~ s/\n//;
		3903
		3904	# limit the # of concurrent backtraces
		3905	if ($_log_backtrace < 2) {
		3906	++$_log_backtrace;
		3907	my $perl_bt = Carp::longmess $msg;
		3908	async {
		3909	$Coro::current->{desc} = "abt $msg";
		3910
		3911	my @bt = fork_call {
		3912	@addr = map { sprintf "%x", $_ } @addr;
		3913	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3914	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3915	or die "addr2line: $!";
		3916
		3917	my @funcs;
		3918	my @res = <$fh>;
		3919	chomp for @res;
		3920	while (@res) {
		3921	my ($func, $line) = splice @res, 0, 2, ();
		3922	push @funcs, "[$func] $line";
		3923	}
		3924
		3925	@funcs
		3926	};
		3927
		3928	LOG llevInfo, "[ABT] $perl_bt\n";
		3929	LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
		3930	LOG llevInfo, "[ABT] $_\n" for @bt;
		3931	--$_log_backtrace;
		3932	};
		3933	} else {
		3934	LOG llevInfo, "[ABT] $msg\n";
		3935	LOG llevInfo, "[ABT] [suppressed]\n";
		3936	}
		3937	}
		3938
		3939	# load additional modules
		3940	use cf::pod;
		3941
		3942	END { cf::emergency_save }
860		3943
861	1	3944	1
862		3945

Diff Legend

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