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

Diff Legend

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