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.80 by root, Tue Nov 7 16:30:55 2006 UTC vs.
Revision 1.542 by root, Wed May 5 09:05:03 2010 UTC

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

Diff Legend

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