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

Diff Legend

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