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.102 by root, Wed Dec 27 15:20:54 2006 UTC vs.
Revision 1.466 by root, Thu Jan 8 03:03:24 2009 UTC

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

Diff Legend

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