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

Diff Legend

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