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

Diff Legend

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