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

Diff Legend

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