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

Diff Legend

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