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

Diff Legend

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