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

Diff Legend

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