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.92 by root, Thu Dec 21 06:42:28 2006 UTC vs.
Revision 1.505 by root, Sun Jan 31 03:46:20 2010 UTC

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

Diff Legend

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