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.68 by root, Tue Sep 12 23:45:16 2006 UTC vs.
Revision 1.448 by root, Fri Sep 19 05:30:23 2008 UTC

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

Diff Legend

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