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.40 by root, Fri Aug 25 15:21:57 2006 UTC vs.
Revision 1.541 by root, Tue May 4 23:33:16 2010 UTC

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

Diff Legend

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