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.83 by root, Mon Dec 11 01:30:41 2006 UTC vs.
Revision 1.488 by root, Wed Oct 21 00:44:39 2009 UTC

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

Diff Legend

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