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.94 by root, Thu Dec 21 23:02:54 2006 UTC vs.
Revision 1.522 by root, Sat Apr 17 02:22:14 2010 UTC

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

Diff Legend

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