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

Diff Legend

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