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.83 by root, Mon Dec 11 01:30:41 2006 UTC vs.
Revision 1.530 by root, Wed Apr 28 21:05:33 2010 UTC

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

Diff Legend

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