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

Diff Legend

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