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.105 by root, Sun Dec 31 17:17:23 2006 UTC vs.
Revision 1.419 by root, Sun Apr 13 01:34:09 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;
18	use Coro::AIO;	43	use Coro::AIO;
		44	use Coro::BDB;
		45	use Coro::Storable;
		46	use Coro::Util ();
19		47
		48	use JSON::XS 2.01 ();
		49	use BDB ();
		50	use Data::Dumper;
		51	use Digest::MD5;
20	use Fcntl;	52	use Fcntl;
		53	use YAML ();
21	use IO::AIO 2.31 ();	54	use IO::AIO 2.51 ();
22	use YAML::Syck ();
23	use Time::HiRes;	55	use Time::HiRes;
		56	use Compress::LZF;
		57	use Digest::MD5 ();
24		58
25	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
26		64
27	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
28	$YAML::Syck::ImplicitUnicode = 1;
29
30	$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
31		66
32	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	67	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
33		68
34	our %COMMAND = ();	69	our %COMMAND = ();
35	our %COMMAND_TIME = ();	70	our %COMMAND_TIME = ();
		71
		72	our @EXTS = (); # list of extension package names
36	our %EXTCMD = ();	73	our %EXTCMD = ();
		74	our %EXTICMD = ();
		75	our %EXT_CORO = (); # coroutines bound to extensions
		76	our %EXT_MAP = (); # pluggable maps
37		77
		78	our $RELOAD; # number of reloads so far
38	our @EVENT;	79	our @EVENT;
39	our $LIBDIR = datadir . "/ext";
40		80
41	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(!)
42	our $TICK_WATCHER;	95	our $AIO_POLL_WATCHER;
		96	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
43	our $NEXT_TICK;	97	our $NEXT_TICK;
44	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;
45		105
46	our %CFG;	106	our %CFG;
47		107
48	our $UPTIME; $UPTIME ||= time;	108	our $UPTIME; $UPTIME ||= time;
49	our $RUNTIME;	109	our $RUNTIME;
		110	our $NOW;
50		111
51	our %MAP; # all maps	112	our (%PLAYER, %PLAYER_LOADING); # all users
52	our $LINK_MAP; # the special {link} map	113	our (%MAP, %MAP_LOADING ); # all maps
53	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
54		123
55	binmode STDOUT;	124	binmode STDOUT;
56	binmode STDERR;	125	binmode STDERR;
57		126
58	# read virtual server time, if available	127	# read virtual server time, if available
59	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	128	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
60	open my $fh, "<", cf::localdir . "/runtime"	129	open my $fh, "<", "$LOCALDIR/runtime"
61	or die "unable to read runtime file: $!";	130	or die "unable to read runtime file: $!";
62	$RUNTIME = <$fh> + 0.;	131	$RUNTIME = <$fh> + 0.;
63	}	132	}
64		133
65	mkdir cf::localdir;	134	mkdir $_
66	mkdir cf::localdir . "/" . cf::playerdir;	135	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
67	mkdir cf::localdir . "/" . cf::tmpdir;
68	mkdir cf::localdir . "/" . cf::uniquedir;
69		136
70	our %EXT_CORO;	137	our $EMERGENCY_POSITION;
		138
		139	sub cf::map::normalise;
71		140
72	#############################################################################	141	#############################################################################
73		142
74	=head2 GLOBAL VARIABLES	143	=head2 GLOBAL VARIABLES
75		144
…		…
82	=item $cf::RUNTIME	151	=item $cf::RUNTIME
83		152
84	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
85	every server tick.	154	every server tick.
86		155
87	=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
88		159
89	The perl library directory, where extensions and cf-specific modules can	160	Various directories - "/etc", read-only install directory, perl-library
90	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.
91		164
92	=item $cf::NOW	165	=item $cf::NOW
93		166
94	The time of the last (current) server tick.	167	The time of the last (current) server tick.
95		168
96	=item $cf::TICK	169	=item $cf::TICK
97		170
98	The interval between server ticks, in seconds.	171	The interval between server ticks, in seconds.
99		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
100	=item %cf::CFG	183	=item %cf::CFG
101		184
102	Configuration for the server, loaded from C</etc/crossfire/config>, or	185	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
103	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.
104		199
105	=back	200	=back
106		201
107	=cut	202	=cut
108		203
109	BEGIN {	204	BEGIN {
110	*CORE::GLOBAL::warn = sub {	205	*CORE::GLOBAL::warn = sub {
111	my $msg = join "", @_;	206	my $msg = join "", @_;
112	utf8::encode $msg;
113		207
114	$msg .= "\n"	208	$msg .= "\n"
115	unless $msg =~ /\n$/;	209	unless $msg =~ /\n$/;
116		210
		211	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		212
117	LOG llevError, "cfperl: $msg";	213	LOG llevError, $msg;
118	};	214	};
119	}	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#?
120		231
121	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	232	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
122	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	233	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
123	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	234	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
124	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	235	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
125	@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';
126	@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)
127		239
128	# 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
129	# within the Safe compartment.	241	# within the Safe compartment.
130	for my $pkg (qw(	242	for my $pkg (qw(
131	cf::global cf::attachable	243	cf::global cf::attachable
…		…
136	)) {	248	)) {
137	no strict 'refs';	249	no strict 'refs';
138	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	250	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
139	}	251	}
140		252
141	$Event::DIED = sub {	253	$EV::DIED = sub {
142	warn "error in event callback: @_";	254	warn "error in event callback: @_";
143	};	255	};
144		256
145	my %ext_pkg;	257	#############################################################################
146	my @exts;
147	my @hook;
148		258
149	=head2 UTILITY FUNCTIONS	259	=head2 UTILITY FUNCTIONS
150		260
151	=over 4	261	=over 4
152		262
153	=cut	263	=item dumpval $ref
154		264
155	use JSON::Syck (); # TODO# replace by JSON::PC once working	265	=cut
156		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
157	=item $ref = cf::from_json $json	286	=item $ref = cf::decode_json $json
158		287
159	Converts a JSON string into the corresponding perl data structure.	288	Converts a JSON string into the corresponding perl data structure.
160		289
161	=cut
162
163	sub from_json($) {
164	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
165	JSON::Syck::Load $_[0]
166	}
167
168	=item $json = cf::to_json $ref	290	=item $json = cf::encode_json $ref
169		291
170	Converts a perl data structure into its JSON representation.	292	Converts a perl data structure into its JSON representation.
171		293
172	=cut	294	=cut
173		295
174	sub to_json($) {	296	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
175	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
176	JSON::Syck::Dump $_[0]
177	}
178		297
179	# main coro must never ever "block" except in Event	298	sub encode_json($) { $json_coder->encode ($_[0]) }
180	# sync_job ensures this by running the job in a coroutine	299	sub decode_json($) { $json_coder->decode ($_[0]) }
181	# and waiting in Event while the server is otherwise frozen	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
182	sub sync_job(&) {	467	sub sync_job(&) {
183	my ($job) = @_;	468	my ($job) = @_;
184		469
185	my $busy = 1;
186	my @res;
187
188	local $FREEZE = 1;
189
190	my $coro = Coro::async {
191	@res = eval { $job->() };
192	warn $@ if $@;
193	undef $busy;
194	};
195
196	if ($Coro::current == $Coro::main) {	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;
197	$coro->prio (Coro::PRIO_MAX);	488	})->prio (Coro::PRIO_MAX);
		489
198	while ($busy) {	490	while ($busy) {
		491	if (Coro::nready) {
199	Coro::cede_notself;	492	Coro::cede_notself;
200	Event::one_event unless Coro::nready;	493	} else {
		494	EV::loop EV::LOOP_ONESHOT;
201	}	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]
202	} else {	503	} else {
203	$coro->join;	504	# we are in another coroutine, how wonderful, everything just works
		505
		506	$job->()
204	}	507	}
205
206	wantarray ? @res : $res[0]
207	}	508	}
208		509
209	=item $coro = cf::coro { BLOCK }	510	=item $coro = cf::async_ext { BLOCK }
210		511
211	Creates and returns a new coro. This coro is automcatially being canceled	512	Like async, but this coro is automatically being canceled when the
212	when the extension calling this is being unloaded.	513	extension calling this is being unloaded.
213		514
214	=cut	515	=cut
215		516
216	sub coro(&) {	517	sub async_ext(&) {
217	my $cb = shift;	518	my $cb = shift;
218		519
219	my $coro; $coro = async {	520	my $coro = &Coro::async ($cb);
220	eval {
221	$cb->();
222	};
223	warn $@ if $@;
224	};
225		521
226	$coro->on_destroy (sub {	522	$coro->on_destroy (sub {
227	delete $EXT_CORO{$coro+0};	523	delete $EXT_CORO{$coro+0};
228	});	524	});
229	$EXT_CORO{$coro+0} = $coro;	525	$EXT_CORO{$coro+0} = $coro;
230		526
231	$coro	527	$coro
232	}	528	}
233		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
234	=back	719	=back
235		720
236	=cut	721	=cut
237		722
238	#############################################################################	723	#############################################################################
…		…
243	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")
244	to it. All such attachable objects support the following methods.	729	to it. All such attachable objects support the following methods.
245		730
246	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>
247	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
248	crossfire+).	733	Deliantra).
249		734
250	=over 4	735	=over 4
251		736
252	=item $attachable->attach ($attachment, key => $value...)	737	=item $attachable->attach ($attachment, key => $value...)
253		738
…		…
367	our @CB_TYPE = (); # registry for type (cf-object class) based events	852	our @CB_TYPE = (); # registry for type (cf-object class) based events
368	our @CB_MAP = ();	853	our @CB_MAP = ();
369		854
370	my %attachment;	855	my %attachment;
371		856
		857	sub cf::attachable::thawer_merge {
		858	# simply override everything except _meta
		859	local $_[0]{_meta};
		860	%{$_[0]} = %{$_[1]};
		861	}
		862
372	sub _attach_cb($$$$) {	863	sub _attach_cb($$$$) {
373	my ($registry, $event, $prio, $cb) = @_;	864	my ($registry, $event, $prio, $cb) = @_;
374		865
375	use sort 'stable';	866	use sort 'stable';
376		867
…		…
410	$registry = $CB_TYPE[$object_type] ||= [];	901	$registry = $CB_TYPE[$object_type] ||= [];
411		902
412	} elsif ($type eq "subtype") {	903	} elsif ($type eq "subtype") {
413	defined $object_type or Carp::croak "subtype specified without type";	904	defined $object_type or Carp::croak "subtype specified without type";
414	my $object_subtype = shift @arg;	905	my $object_subtype = shift @arg;
415	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	906	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
416		907
417	} elsif ($type eq "package") {	908	} elsif ($type eq "package") {
418	my $pkg = shift @arg;	909	my $pkg = shift @arg;
419		910
420	while (my ($name, $id) = each %cb_id) {	911	while (my ($name, $id) = each %cb_id) {
…		…
449	_attach $registry, $klass, @attach;	940	_attach $registry, $klass, @attach;
450	}	941	}
451		942
452	$obj->{$name} = \%arg;	943	$obj->{$name} = \%arg;
453	} else {	944	} else {
454	warn "object uses attachment '$name' that is not available, postponing.\n";	945	warn "object uses attachment '$name' which is not available, postponing.\n";
455	}	946	}
456		947
457	$obj->{_attachment}{$name} = undef;	948	$obj->{_attachment}{$name} = undef;
458	}	949	}
459		950
…		…
461	if (ref $_[0]) {	952	if (ref $_[0]) {
462	_object_attach @_;	953	_object_attach @_;
463	} else {	954	} else {
464	_attach shift->_attach_registry, @_;	955	_attach shift->_attach_registry, @_;
465	}	956	}
		957	_recalc_want;
466	};	958	};
467		959
468	# all those should be optimised	960	# all those should be optimised
469	sub cf::attachable::detach {	961	sub cf::attachable::detach {
470	my ($obj, $name) = @_;	962	my ($obj, $name) = @_;
…		…
473	delete $obj->{_attachment}{$name};	965	delete $obj->{_attachment}{$name};
474	reattach ($obj);	966	reattach ($obj);
475	} else {	967	} else {
476	Carp::croak "cannot, currently, detach class attachments";	968	Carp::croak "cannot, currently, detach class attachments";
477	}	969	}
		970	_recalc_want;
478	};	971	};
479		972
480	sub cf::attachable::attached {	973	sub cf::attachable::attached {
481	my ($obj, $name) = @_;	974	my ($obj, $name) = @_;
482		975
…		…
497	";	990	";
498	die if $@;	991	die if $@;
499	}	992	}
500		993
501	our $override;	994	our $override;
502	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?
503		996
504	sub override {	997	sub override {
505	$override = 1;	998	$override = 1;
506	@invoke_results = ();	999	@INVOKE_RESULTS = (@_);
507	}	1000	}
508		1001
509	sub do_invoke {	1002	sub do_invoke {
510	my $event = shift;	1003	my $event = shift;
511	my $callbacks = shift;	1004	my $callbacks = shift;
512		1005
513	@invoke_results = ();	1006	@INVOKE_RESULTS = ();
514		1007
515	local $override;	1008	local $override;
516		1009
517	for (@$callbacks) {	1010	for (@$callbacks) {
518	eval { &{$_->[1]} };	1011	eval { &{$_->[1]} };
…		…
527	}	1020	}
528		1021
529	0	1022	0
530	}	1023	}
531		1024
532	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1025	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
533		1026
534	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1027	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
535		1028
536	Generate an object-specific event with the given arguments.	1029	Generate an object-specific event with the given arguments.
537		1030
538	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
539	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
540	results (if you must, access C<@cf::invoke_results> directly).	1033	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
541		1034
542	=back	1035	=back
543		1036
544	=cut	1037	=cut
545		1038
546	#############################################################################	1039	#############################################################################
547	# 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	}
548		1083
549	sub reattach {	1084	sub reattach {
550	# basically do the same as instantiate, without calling instantiate	1085	# basically do the same as instantiate, without calling instantiate
551	my ($obj) = @_;	1086	my ($obj) = @_;
		1087
		1088	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
552		1089
553	my $registry = $obj->registry;	1090	my $registry = $obj->registry;
554		1091
555	@$registry = ();	1092	@$registry = ();
556		1093
…		…
571	cf::attachable->attach (	1108	cf::attachable->attach (
572	prio => -1000000,	1109	prio => -1000000,
573	on_instantiate => sub {	1110	on_instantiate => sub {
574	my ($obj, $data) = @_;	1111	my ($obj, $data) = @_;
575		1112
576	$data = from_json $data;	1113	$data = decode_json $data;
577		1114
578	for (@$data) {	1115	for (@$data) {
579	my ($name, $args) = @$_;	1116	my ($name, $args) = @$_;
580		1117
581	$obj->attach ($name, %{$args || {} });	1118	$obj->attach ($name, %{$args || {} });
…		…
597	sub object_freezer_save {	1134	sub object_freezer_save {
598	my ($filename, $rdata, $objs) = @_;	1135	my ($filename, $rdata, $objs) = @_;
599		1136
600	sync_job {	1137	sync_job {
601	if (length $$rdata) {	1138	if (length $$rdata) {
		1139	utf8::decode (my $decname = $filename);
602	warn sprintf "saving %s (%d,%d)\n",	1140	warn sprintf "saving %s (%d,%d)\n",
603	$filename, length $$rdata, scalar @$objs;	1141	$decname, length $$rdata, scalar @$objs;
604		1142
605	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1143	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
606	chmod SAVE_MODE, $fh;	1144	chmod SAVE_MODE, $fh;
607	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1145	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
608	aio_fsync $fh;	1146	aio_fsync $fh if $cf::USE_FSYNC;
609	close $fh;	1147	close $fh;
610		1148
611	if (@$objs) {	1149	if (@$objs) {
612	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	1150	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
613	chmod SAVE_MODE, $fh;	1151	chmod SAVE_MODE, $fh;
614	my $data = Storable::nfreeze { version => 1, objs => $objs };	1152	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
615	aio_write $fh, 0, (length $data), $data, 0;	1153	aio_write $fh, 0, (length $data), $data, 0;
616	aio_fsync $fh;	1154	aio_fsync $fh if $cf::USE_FSYNC;
617	close $fh;	1155	close $fh;
618	aio_rename "$filename.pst~", "$filename.pst";	1156	aio_rename "$filename.pst~", "$filename.pst";
619	}	1157	}
620	} else {	1158	} else {
621	aio_unlink "$filename.pst";	1159	aio_unlink "$filename.pst";
…		…
627	}	1165	}
628	} else {	1166	} else {
629	aio_unlink $filename;	1167	aio_unlink $filename;
630	aio_unlink "$filename.pst";	1168	aio_unlink "$filename.pst";
631	}	1169	}
632	}	1170	};
633	}	1171	}
634		1172
635	sub object_freezer_as_string {	1173	sub object_freezer_as_string {
636	my ($rdata, $objs) = @_;	1174	my ($rdata, $objs) = @_;
637		1175
…		…
649	or return;	1187	or return;
650		1188
651	unless (aio_stat "$filename.pst") {	1189	unless (aio_stat "$filename.pst") {
652	(aio_load "$filename.pst", $av) >= 0	1190	(aio_load "$filename.pst", $av) >= 0
653	or return;	1191	or return;
		1192
654	$av = eval { (Storable::thaw <$av>)->{objs} };	1193	my $st = eval { Coro::Storable::thaw $av };
		1194	$av = $st->{objs};
655	}	1195	}
656		1196
		1197	utf8::decode (my $decname = $filename);
		1198	warn sprintf "loading %s (%d,%d)\n",
		1199	$decname, length $data, scalar @{$av || []};
		1200
657	return ($data, $av);	1201	($data, $av)
658	}	1202	}
		1203
		1204	=head2 COMMAND CALLBACKS
		1205
		1206	=over 4
		1207
		1208	=cut
659		1209
660	#############################################################################	1210	#############################################################################
661	# command handling &c	1211	# command handling &c
662		1212
663	=item cf::register_command $name => \&callback($ob,$args);	1213	=item cf::register_command $name => \&callback($ob,$args);
…		…
676	push @{ $COMMAND{$name} }, [$caller, $cb];	1226	push @{ $COMMAND{$name} }, [$caller, $cb];
677	}	1227	}
678		1228
679	=item cf::register_extcmd $name => \&callback($pl,$packet);	1229	=item cf::register_extcmd $name => \&callback($pl,$packet);
680		1230
681	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.
682		1236
683	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
684	called.	1238	called.
685		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
686	=cut	1251	=cut
687		1252
688	sub register_extcmd {	1253	sub register_extcmd {
689	my ($name, $cb) = @_;	1254	my ($name, $cb) = @_;
690		1255
691	my $caller = caller;
692	#warn "registering extcmd '$name' to '$caller'";
693
694	$EXTCMD{$name} = [$cb, $caller];	1256	$EXTCMD{$name} = $cb;
		1257	}
		1258
		1259	sub register_exticmd {
		1260	my ($name, $cb) = @_;
		1261
		1262	$EXTICMD{$name} = $cb;
695	}	1263	}
696		1264
697	cf::player->attach (	1265	cf::player->attach (
698	on_command => sub {	1266	on_command => sub {
699	my ($pl, $name, $params) = @_;	1267	my ($pl, $name, $params) = @_;
…		…
708	cf::override;	1276	cf::override;
709	},	1277	},
710	on_extcmd => sub {	1278	on_extcmd => sub {
711	my ($pl, $buf) = @_;	1279	my ($pl, $buf) = @_;
712		1280
713	my $msg = eval { from_json $buf };	1281	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
714		1282
715	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
716	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1291	if (my $cb = $EXTCMD{$type}) {
717	if (my %reply = $cb->[0]->($pl, $msg)) {	1292	@reply = $cb->($pl, @payload);
718	$pl->ext_reply ($msg->{msgid}, %reply);
719	}
720	}	1293	}
		1294
		1295	$pl->ext_reply ($reply, @reply)
		1296	if $reply;
		1297
721	} else {	1298	} else {
722	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1299	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
723	}	1300	}
724		1301
725	cf::override;	1302	cf::override;
726	},	1303	},
727	);	1304	);
728		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
		1781	my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
		1782
		1783	# mit "rum" bekleckern, nicht
		1784	$self->_create_random_map (
		1785	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1786	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1787	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1788	$rmp->{exit_on_final_map},
		1789	$rmp->{xsize}, $rmp->{ysize},
		1790	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1791	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1792	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1793	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1794	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1795	(cf::region::find $rmp->{region}), $rmp->{custom}
		1796	)
		1797	}
		1798
		1799	=item cf::map->register ($regex, $prio)
		1800
		1801	Register a handler for the map path matching the given regex at the
		1802	givne priority (higher is better, built-in handlers have priority 0, the
		1803	default).
		1804
		1805	=cut
		1806
729	sub register {	1807	sub register {
		1808	my (undef, $regex, $prio) = @_;
		1809	my $pkg = caller;
		1810
		1811	no strict;
		1812	push @{"$pkg\::ISA"}, __PACKAGE__;
		1813
		1814	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1815	}
		1816
		1817	# also paths starting with '/'
		1818	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1819
		1820	sub thawer_merge {
730	my ($base, $pkg) = @_;	1821	my ($self, $merge) = @_;
731		1822
732	#TODO	1823	# we have to keep some variables in memory intact
733	}	1824	local $self->{path};
		1825	local $self->{load_path};
734		1826
735	sub load_extension {	1827	$self->SUPER::thawer_merge ($merge);
		1828	}
		1829
		1830	sub normalise {
736	my ($path) = @_;	1831	my ($path, $base) = @_;
737		1832
738	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1833	$path = "$path"; # make sure its a string
739	my $base = $1;
740	my $pkg = $1;
741	$pkg =~ s/[^[:word:]]/_/g;
742	$pkg = "ext::$pkg";
743		1834
744	warn "loading '$path' into '$pkg'\n";	1835	$path =~ s/\.map$//;
745		1836
746	open my $fh, "<:utf8", $path	1837	# map plan:
747	or die "$path: $!";	1838	#
		1839	# /! non-realised random map exit (special hack!)
		1840	# {... are special paths that are not being touched
		1841	# ?xxx/... are special absolute paths
		1842	# ?random/... random maps
		1843	# /... normal maps
		1844	# ~user/... per-player map of a specific user
748		1845
749	my $source =	1846	$path =~ s/$PATH_SEP/\//go;
750	"package $pkg; use strict; use utf8;\n"
751	. "#line 1 \"$path\"\n{\n"
752	. (do { local $/; <$fh> })
753	. "\n};\n1";
754		1847
755	eval $source	1848	# treat it as relative path if it starts with
756	or die $@ ? "$path: $@\n"	1849	# something that looks reasonable
757	: "extension disabled.\n";	1850	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1851	$base or Carp::carp "normalise called with relative path and no base: '$path'";
758		1852
759	push @exts, $pkg;	1853	$base =~ s{[^/]+/?$}{};
760	$ext_pkg{$base} = $pkg;	1854	$path = "$base/$path";
761
762	# no strict 'refs';
763	# @{"$pkg\::ISA"} = ext::;
764
765	register $base, $pkg;
766	}
767
768	sub unload_extension {
769	my ($pkg) = @_;
770
771	warn "removing extension $pkg\n";
772
773	# remove hooks
774	#TODO
775	# for my $idx (0 .. $#PLUGIN_EVENT) {
776	# delete $hook[$idx]{$pkg};
777	# }	1855	}
778		1856
779	# remove commands	1857	for ($path) {
780	for my $name (keys %COMMAND) {	1858	redo if s{//}{/};
781	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };	1859	redo if s{/\.?/}{/};
		1860	redo if s{/[^/]+/\.\./}{/};
		1861	}
782		1862
783	if (@cb) {	1863	$path
784	$COMMAND{$name} = \@cb;	1864	}
		1865
		1866	sub new_from_path {
		1867	my (undef, $path, $base) = @_;
		1868
		1869	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1870
		1871	$path = normalise $path, $base;
		1872
		1873	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1874	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1875	my $self = bless cf::map::new, $pkg;
		1876	$self->{path} = $path; $self->path ($path);
		1877	$self->init; # pass $1 etc.
		1878	return $self;
		1879	}
		1880	}
		1881
		1882	Carp::cluck "unable to resolve path '$path' (base '$base').";
		1883	()
		1884	}
		1885
		1886	sub init {
		1887	my ($self) = @_;
		1888
		1889	$self
		1890	}
		1891
		1892	sub as_string {
		1893	my ($self) = @_;
		1894
		1895	"$self->{path}"
		1896	}
		1897
		1898	# the displayed name, this is a one way mapping
		1899	sub visible_name {
		1900	&as_string
		1901	}
		1902
		1903	# the original (read-only) location
		1904	sub load_path {
		1905	my ($self) = @_;
		1906
		1907	"$MAPDIR/$self->{path}.map"
		1908	}
		1909
		1910	# the temporary/swap location
		1911	sub save_path {
		1912	my ($self) = @_;
		1913
		1914	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
		1915	"$TMPDIR/$path.map"
		1916	}
		1917
		1918	# the unique path, undef == no special unique path
		1919	sub uniq_path {
		1920	my ($self) = @_;
		1921
		1922	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
		1923	"$UNIQUEDIR/$path"
		1924	}
		1925
		1926	# and all this just because we cannot iterate over
		1927	# all maps in C++...
		1928	sub change_all_map_light {
		1929	my ($change) = @_;
		1930
		1931	$_->change_map_light ($change)
		1932	for grep $_->outdoor, values %cf::MAP;
		1933	}
		1934
		1935	sub decay_objects {
		1936	my ($self) = @_;
		1937
		1938	return if $self->{deny_reset};
		1939
		1940	$self->do_decay_objects;
		1941	}
		1942
		1943	sub unlink_save {
		1944	my ($self) = @_;
		1945
		1946	utf8::encode (my $save = $self->save_path);
		1947	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1948	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1949	}
		1950
		1951	sub load_header_from($) {
		1952	my ($self, $path) = @_;
		1953
		1954	utf8::encode $path;
		1955	my $f = new_from_file cf::object::thawer $path
		1956	or return;
		1957
		1958	$self->_load_header ($f)
		1959	or return;
		1960
		1961	local $MAP_LOADING{$self->{path}} = $self;
		1962	$f->resolve_delayed_derefs;
		1963
		1964	$self->{load_path} = $path;
		1965
		1966	1
		1967	}
		1968
		1969	sub load_header_orig {
		1970	my ($self) = @_;
		1971
		1972	$self->load_header_from ($self->load_path)
		1973	}
		1974
		1975	sub load_header_temp {
		1976	my ($self) = @_;
		1977
		1978	$self->load_header_from ($self->save_path)
		1979	}
		1980
		1981	sub prepare_temp {
		1982	my ($self) = @_;
		1983
		1984	$self->last_access ((delete $self->{last_access})
		1985	|| $cf::RUNTIME); #d#
		1986	# safety
		1987	$self->{instantiate_time} = $cf::RUNTIME
		1988	if $self->{instantiate_time} > $cf::RUNTIME;
		1989	}
		1990
		1991	sub prepare_orig {
		1992	my ($self) = @_;
		1993
		1994	$self->{load_original} = 1;
		1995	$self->{instantiate_time} = $cf::RUNTIME;
		1996	$self->last_access ($cf::RUNTIME);
		1997	$self->instantiate;
		1998	}
		1999
		2000	sub load_header {
		2001	my ($self) = @_;
		2002
		2003	if ($self->load_header_temp) {
		2004	$self->prepare_temp;
785	} else {	2005	} else {
786	delete $COMMAND{$name};	2006	$self->load_header_orig
787	}	2007	or return;
		2008	$self->prepare_orig;
		2009	}
		2010
		2011	$self->{deny_reset} = 1
		2012	if $self->no_reset;
		2013
		2014	$self->default_region (cf::region::find_by_path $self->{path})
		2015	unless $self->default_region;
		2016
788	}	2017	1
		2018	}
789		2019
790	# remove extcmds	2020	sub find;
791	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {	2021	sub find {
792	delete $EXTCMD{$name};	2022	my ($path, $origin) = @_;
		2023
		2024	$path = normalise $path, $origin && $origin->path;
		2025
		2026	cf::lock_wait "map_data:$path";#d#remove
		2027	cf::lock_wait "map_find:$path";
		2028
		2029	$cf::MAP{$path} || do {
		2030	my $guard1 = cf::lock_acquire "map_find:$path";
		2031	my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
		2032
		2033	my $map = new_from_path cf::map $path
		2034	or return;
		2035
		2036	$map->{last_save} = $cf::RUNTIME;
		2037
		2038	$map->load_header
		2039	or return;
		2040
		2041	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		2042	# doing this can freeze the server in a sync job, obviously
		2043	#$cf::WAIT_FOR_TICK->wait;
		2044	undef $guard1;
		2045	undef $guard2;
		2046	$map->reset;
		2047	return find $path;
		2048	}
		2049
		2050	$cf::MAP{$path} = $map
		2051	}
		2052	}
		2053
		2054	sub pre_load { }
		2055	sub post_load { }
		2056
		2057	sub load {
		2058	my ($self) = @_;
		2059
		2060	local $self->{deny_reset} = 1; # loading can take a long time
		2061
		2062	my $path = $self->{path};
		2063
793	}	2064	{
		2065	my $guard = cf::lock_acquire "map_data:$path";
794		2066
795	if (my $cb = $pkg->can ("unload")) {	2067	return unless $self->valid;
796	eval {	2068	return unless $self->in_memory == cf::MAP_SWAPPED;
797	$cb->($pkg);	2069
		2070	$self->in_memory (cf::MAP_LOADING);
		2071
		2072	$self->alloc;
		2073
		2074	$self->pre_load;
		2075	cf::cede_to_tick;
		2076
		2077	my $f = new_from_file cf::object::thawer $self->{load_path};
		2078	$f->skip_block;
		2079	$self->_load_objects ($f)
		2080	or return;
		2081
		2082	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		2083	if delete $self->{load_original};
		2084
		2085	if (my $uniq = $self->uniq_path) {
		2086	utf8::encode $uniq;
		2087	unless (aio_stat $uniq) {
		2088	if (my $f = new_from_file cf::object::thawer $uniq) {
		2089	$self->clear_unique_items;
		2090	$self->_load_objects ($f);
		2091	$f->resolve_delayed_derefs;
		2092	}
798	1	2093	}
799	} or warn "$pkg unloaded, but with errors: $@";	2094	}
800	}
801		2095
802	Symbol::delete_package $pkg;	2096	$f->resolve_delayed_derefs;
803	}
804		2097
805	sub load_extensions {	2098	cf::cede_to_tick;
806	for my $ext (<$LIBDIR/*.ext>) {	2099	# now do the right thing for maps
807	next unless -r $ext;	2100	$self->link_multipart_objects;
808	eval {	2101	$self->difficulty ($self->estimate_difficulty)
809	load_extension $ext;	2102	unless $self->difficulty;
810	1	2103	cf::cede_to_tick;
811	} or warn "$ext not loaded: $@";
812	}
813	}
814		2104
815	#############################################################################	2105	unless ($self->{deny_activate}) {
816	# load/save/clean perl data associated with a map	2106	$self->decay_objects;
		2107	$self->fix_auto_apply;
		2108	$self->update_buttons;
		2109	cf::cede_to_tick;
		2110	$self->set_darkness_map;
		2111	cf::cede_to_tick;
		2112	$self->activate;
		2113	}
817		2114
818	*cf::mapsupport::on_clean = sub {	2115	$self->{last_save} = $cf::RUNTIME;
		2116	$self->last_access ($cf::RUNTIME);
		2117
		2118	$self->in_memory (cf::MAP_IN_MEMORY);
		2119	}
		2120
		2121	$self->post_load;
		2122	}
		2123
		2124	sub customise_for {
		2125	my ($self, $ob) = @_;
		2126
		2127	return find "~" . $ob->name . "/" . $self->{path}
		2128	if $self->per_player;
		2129
		2130	# return find "?party/" . $ob->name . "/" . $self->{path}
		2131	# if $self->per_party;
		2132
		2133	$self
		2134	}
		2135
		2136	# find and load all maps in the 3x3 area around a map
		2137	sub load_neighbours {
819	my ($map) = @_;	2138	my ($map) = @_;
820		2139
821	my $path = $map->tmpname;	2140	my @neigh; # diagonal neighbours
822	defined $path or return;
823		2141
824	unlink "$path.pst";	2142	for (0 .. 3) {
825	};	2143	my $neigh = $map->tile_path ($_)
		2144	or next;
		2145	$neigh = find $neigh, $map
		2146	or next;
		2147	$neigh->load;
826		2148
827	cf::map->attach (prio => -10000, package => cf::mapsupport::);	2149	push @neigh,
		2150	[$neigh->tile_path (($_ + 3) % 4), $neigh],
		2151	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		2152	}
828		2153
829	#############################################################################	2154	for (grep defined $_->[0], @neigh) {
830	# load/save perl data associated with player->ob objects	2155	my ($path, $origin) = @$_;
831		2156	my $neigh = find $path, $origin
832	sub all_objects(@) {	2157	or next;
833	@_, map all_objects ($_->inv), @_	2158	$neigh->load;
		2159	}
834	}	2160	}
835		2161
836	# TODO: compatibility cruft, remove when no longer needed	2162	sub find_sync {
837	cf::player->attach (	2163	my ($path, $origin) = @_;
838	on_load => sub {
839	my ($pl, $path) = @_;
840		2164
841	for my $o (all_objects $pl->ob) {	2165	cf::sync_job { find $path, $origin }
842	if (my $value = $o->get_ob_key_value ("_perl_data")) {	2166	}
843	$o->set_ob_key_value ("_perl_data");
844		2167
845	%$o = %{ Storable::thaw pack "H*", $value };	2168	sub do_load_sync {
		2169	my ($map) = @_;
		2170
		2171	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2172	if $Coro::current == $Coro::main;
		2173
		2174	cf::sync_job { $map->load };
		2175	}
		2176
		2177	our %MAP_PREFETCH;
		2178	our $MAP_PREFETCHER = undef;
		2179
		2180	sub find_async {
		2181	my ($path, $origin, $load) = @_;
		2182
		2183	$path = normalise $path, $origin && $origin->{path};
		2184
		2185	if (my $map = $cf::MAP{$path}) {
		2186	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
		2187	}
		2188
		2189	$MAP_PREFETCH{$path} |= $load;
		2190
		2191	$MAP_PREFETCHER ||= cf::async {
		2192	$Coro::current->{desc} = "map prefetcher";
		2193
		2194	while (%MAP_PREFETCH) {
		2195	while (my ($k, $v) = each %MAP_PREFETCH) {
		2196	if (my $map = find $k) {
		2197	$map->load if $v;
		2198	}
		2199
		2200	delete $MAP_PREFETCH{$k};
846	}	2201	}
847	}	2202	}
		2203	undef $MAP_PREFETCHER;
		2204	};
		2205	$MAP_PREFETCHER->prio (6);
		2206
		2207	()
		2208	}
		2209
		2210	sub save {
		2211	my ($self) = @_;
		2212
		2213	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2214
		2215	$self->{last_save} = $cf::RUNTIME;
		2216
		2217	return unless $self->dirty;
		2218
		2219	my $save = $self->save_path; utf8::encode $save;
		2220	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2221
		2222	$self->{load_path} = $save;
		2223
		2224	return if $self->{deny_save};
		2225
		2226	local $self->{last_access} = $self->last_access;#d#
		2227
		2228	cf::async {
		2229	$Coro::current->{desc} = "map player save";
		2230	$_->contr->save for $self->players;
		2231	};
		2232
		2233	if ($uniq) {
		2234	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		2235	$self->_save_objects ($uniq, cf::IO_UNIQUES);
		2236	} else {
		2237	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
848	},	2238	}
849	);	2239	}
850		2240
851	#############################################################################	2241	sub swap_out {
		2242	my ($self) = @_;
852		2243
853	=head2 CORE EXTENSIONS	2244	# save first because save cedes
		2245	$self->save;
854		2246
855	Functions and methods that extend core crossfire objects.	2247	my $lock = cf::lock_acquire "map_data:$self->{path}";
856		2248
857	=head3 cf::player	2249	return if $self->players;
		2250	return if $self->in_memory != cf::MAP_IN_MEMORY;
		2251	return if $self->{deny_save};
		2252
		2253	$self->in_memory (cf::MAP_SWAPPED);
		2254
		2255	$self->deactivate;
		2256	$_->clear_links_to ($self) for values %cf::MAP;
		2257	$self->clear;
		2258	}
		2259
		2260	sub reset_at {
		2261	my ($self) = @_;
		2262
		2263	# TODO: safety, remove and allow resettable per-player maps
		2264	return 1e99 if $self->{deny_reset};
		2265
		2266	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		2267	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		2268
		2269	$time + $to
		2270	}
		2271
		2272	sub should_reset {
		2273	my ($self) = @_;
		2274
		2275	$self->reset_at <= $cf::RUNTIME
		2276	}
		2277
		2278	sub reset {
		2279	my ($self) = @_;
		2280
		2281	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2282
		2283	return if $self->players;
		2284
		2285	warn "resetting map ", $self->path;
		2286
		2287	$self->in_memory (cf::MAP_SWAPPED);
		2288
		2289	# need to save uniques path
		2290	unless ($self->{deny_save}) {
		2291	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2292
		2293	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2294	if $uniq;
		2295	}
		2296
		2297	delete $cf::MAP{$self->path};
		2298
		2299	$self->deactivate;
		2300	$_->clear_links_to ($self) for values %cf::MAP;
		2301	$self->clear;
		2302
		2303	$self->unlink_save;
		2304	$self->destroy;
		2305	}
		2306
		2307	my $nuke_counter = "aaaa";
		2308
		2309	sub nuke {
		2310	my ($self) = @_;
		2311
		2312	{
		2313	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2314
		2315	delete $cf::MAP{$self->path};
		2316
		2317	$self->unlink_save;
		2318
		2319	bless $self, "cf::map";
		2320	delete $self->{deny_reset};
		2321	$self->{deny_save} = 1;
		2322	$self->reset_timeout (1);
		2323	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2324
		2325	$cf::MAP{$self->path} = $self;
		2326	}
		2327
		2328	$self->reset; # polite request, might not happen
		2329	}
		2330
		2331	=item $maps = cf::map::tmp_maps
		2332
		2333	Returns an arrayref with all map paths of currently instantiated and saved
		2334	maps. May block.
		2335
		2336	=cut
		2337
		2338	sub tmp_maps() {
		2339	[
		2340	map {
		2341	utf8::decode $_;
		2342	/\.map$/
		2343	? normalise $_
		2344	: ()
		2345	} @{ aio_readdir $TMPDIR or [] }
		2346	]
		2347	}
		2348
		2349	=item $maps = cf::map::random_maps
		2350
		2351	Returns an arrayref with all map paths of currently instantiated and saved
		2352	random maps. May block.
		2353
		2354	=cut
		2355
		2356	sub random_maps() {
		2357	[
		2358	map {
		2359	utf8::decode $_;
		2360	/\.map$/
		2361	? normalise "?random/$_"
		2362	: ()
		2363	} @{ aio_readdir $RANDOMDIR or [] }
		2364	]
		2365	}
		2366
		2367	=item cf::map::unique_maps
		2368
		2369	Returns an arrayref of paths of all shared maps that have
		2370	instantiated unique items. May block.
		2371
		2372	=cut
		2373
		2374	sub unique_maps() {
		2375	[
		2376	map {
		2377	utf8::decode $_;
		2378	s/\.map$//; # TODO future compatibility hack
		2379	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
		2380	? ()
		2381	: normalise $_
		2382	} @{ aio_readdir $UNIQUEDIR or [] }
		2383	]
		2384	}
		2385
		2386	=back
		2387
		2388	=head3 cf::object
		2389
		2390	=cut
		2391
		2392	package cf::object;
858		2393
859	=over 4	2394	=over 4
860		2395
861	=item cf::player::exists $login	2396	=item $ob->inv_recursive
862		2397
863	Returns true when the given account exists.	2398	Returns the inventory of the object I<and> their inventories, recursively,
		2399	but I<not> the object itself.
864		2400
865	=cut	2401	=cut
866		2402
867	sub cf::player::exists($) {	2403	sub inv_recursive_;
868	cf::player::find $_[0]	2404	sub inv_recursive_ {
869	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	2405	map { $_, inv_recursive_ $_->inv } @_
870	}	2406	}
871		2407
872	=item $player->ext_reply ($msgid, $msgtype, %msg)	2408	sub inv_recursive {
873		2409	inv_recursive_ inv $_[0]
874	Sends an ext reply to the player.
875
876	=cut
877
878	sub cf::player::ext_reply($$$%) {
879	my ($self, $id, %msg) = @_;
880
881	$msg{msgid} = $id;
882
883	$self->send ("ext " . to_json \%msg);
884	}	2410	}
		2411
		2412	=item $ref = $ob->ref
		2413
		2414	Creates and returns a persistent reference to an object that can be stored as a string.
		2415
		2416	=item $ob = cf::object::deref ($refstring)
		2417
		2418	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2419	even if the object actually exists. May block.
		2420
		2421	=cut
		2422
		2423	sub deref {
		2424	my ($ref) = @_;
		2425
		2426	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2427	my ($uuid, $name) = ($1, $2);
		2428	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2429	or return;
		2430	$pl->ob->uuid eq $uuid
		2431	or return;
		2432
		2433	$pl->ob
		2434	} else {
		2435	warn "$ref: cannot resolve object reference\n";
		2436	undef
		2437	}
		2438	}
		2439
		2440	package cf;
885		2441
886	=back	2442	=back
887		2443
888	=head3 cf::object::player	2444	=head3 cf::object::player
889		2445
…		…
905		2461
906	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2462	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
907		2463
908	if ($self->{record_replies}) {	2464	if ($self->{record_replies}) {
909	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2465	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2466
910	} else {	2467	} else {
		2468	my $pl = $self->contr;
		2469
		2470	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2471	my $dialog = $pl->{npc_dialog};
		2472	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2473
		2474	} else {
911	$msg = $npc->name . " says: $msg" if $npc;	2475	$msg = $npc->name . " says: $msg" if $npc;
912	$self->message ($msg, $flags);	2476	$self->message ($msg, $flags);
		2477	}
913	}	2478	}
		2479	}
		2480
		2481	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2482
		2483	=cut
		2484
		2485	sub cf::object::send_msg {
		2486	my $pl = shift->contr
		2487	or return;
		2488	$pl->send_msg (@_);
914	}	2489	}
915		2490
916	=item $player_object->may ("access")	2491	=item $player_object->may ("access")
917		2492
918	Returns wether the given player is authorized to access resource "access"	2493	Returns wether the given player is authorized to access resource "access"
…		…
927	(ref $cf::CFG{"may_$access"}	2502	(ref $cf::CFG{"may_$access"}
928	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	2503	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
929	: $cf::CFG{"may_$access"})	2504	: $cf::CFG{"may_$access"})
930	}	2505	}
931		2506
		2507	=item $player_object->enter_link
		2508
		2509	Freezes the player and moves him/her to a special map (C<{link}>).
		2510
		2511	The player should be reasonably safe there for short amounts of time. You
		2512	I<MUST> call C<leave_link> as soon as possible, though.
		2513
		2514	Will never block.
		2515
		2516	=item $player_object->leave_link ($map, $x, $y)
		2517
		2518	Moves the player out of the special C<{link}> map onto the specified
		2519	map. If the map is not valid (or omitted), the player will be moved back
		2520	to the location he/she was before the call to C<enter_link>, or, if that
		2521	fails, to the emergency map position.
		2522
		2523	Might block.
		2524
		2525	=cut
		2526
		2527	sub link_map {
		2528	unless ($LINK_MAP) {
		2529	$LINK_MAP = cf::map::find "{link}"
		2530	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2531	$LINK_MAP->load;
		2532	}
		2533
		2534	$LINK_MAP
		2535	}
		2536
		2537	sub cf::object::player::enter_link {
		2538	my ($self) = @_;
		2539
		2540	$self->deactivate_recursive;
		2541
		2542	return if UNIVERSAL::isa $self->map, "ext::map_link";
		2543
		2544	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		2545	if $self->map && $self->map->{path} ne "{link}";
		2546
		2547	$self->enter_map ($LINK_MAP || link_map, 10, 10);
		2548	}
		2549
		2550	sub cf::object::player::leave_link {
		2551	my ($self, $map, $x, $y) = @_;
		2552
		2553	return unless $self->contr->active;
		2554
		2555	my $link_pos = delete $self->{_link_pos};
		2556
		2557	unless ($map) {
		2558	# restore original map position
		2559	($map, $x, $y) = @{ $link_pos || [] };
		2560	$map = cf::map::find $map;
		2561
		2562	unless ($map) {
		2563	($map, $x, $y) = @$EMERGENCY_POSITION;
		2564	$map = cf::map::find $map
		2565	or die "FATAL: cannot load emergency map\n";
		2566	}
		2567	}
		2568
		2569	($x, $y) = (-1, -1)
		2570	unless (defined $x) && (defined $y);
		2571
		2572	# use -1 or undef as default coordinates, not 0, 0
		2573	($x, $y) = ($map->enter_x, $map->enter_y)
		2574	if $x <=0 && $y <= 0;
		2575
		2576	$map->load;
		2577	$map->load_neighbours;
		2578
		2579	return unless $self->contr->active;
		2580	$self->activate_recursive;
		2581
		2582	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
		2583	$self->enter_map ($map, $x, $y);
		2584	}
		2585
		2586	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
		2587
		2588	Moves the player to the given map-path and coordinates by first freezing
		2589	her, loading and preparing them map, calling the provided $check callback
		2590	that has to return the map if sucecssful, and then unfreezes the player on
		2591	the new (success) or old (failed) map position. In either case, $done will
		2592	be called at the end of this process.
		2593
		2594	=cut
		2595
		2596	our $GOTOGEN;
		2597
		2598	sub cf::object::player::goto {
		2599	my ($self, $path, $x, $y, $check, $done) = @_;
		2600
		2601	# do generation counting so two concurrent goto's will be executed in-order
		2602	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
		2603
		2604	$self->enter_link;
		2605
		2606	(async {
		2607	$Coro::current->{desc} = "player::goto $path $x $y";
		2608
		2609	# *tag paths override both path and x|y
		2610	if ($path =~ /^\*(.*)$/) {
		2611	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2612	my $ob = $obs[rand @obs];
		2613
		2614	# see if we actually can go there
		2615	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2616	$ob = $obs[rand @obs];
		2617	} else {
		2618	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2619	}
		2620	# else put us there anyways for now #d#
		2621
		2622	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2623	} else {
		2624	($path, $x, $y) = (undef, undef, undef);
		2625	}
		2626	}
		2627
		2628	my $map = eval {
		2629	my $map = defined $path ? cf::map::find $path : undef;
		2630
		2631	if ($map) {
		2632	$map = $map->customise_for ($self);
		2633	$map = $check->($map) if $check && $map;
		2634	} else {
		2635	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2636	}
		2637
		2638	$map
		2639	};
		2640
		2641	if ($@) {
		2642	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2643	LOG llevError | logBacktrace, Carp::longmess $@;
		2644	}
		2645
		2646	if ($gen == $self->{_goto_generation}) {
		2647	delete $self->{_goto_generation};
		2648	$self->leave_link ($map, $x, $y);
		2649	}
		2650
		2651	$done->() if $done;
		2652	})->prio (1);
		2653	}
		2654
		2655	=item $player_object->enter_exit ($exit_object)
		2656
		2657	=cut
		2658
		2659	sub parse_random_map_params {
		2660	my ($spec) = @_;
		2661
		2662	my $rmp = { # defaults
		2663	xsize => (cf::rndm 15, 40),
		2664	ysize => (cf::rndm 15, 40),
		2665	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2666	#layout => string,
		2667	};
		2668
		2669	for (split /\n/, $spec) {
		2670	my ($k, $v) = split /\s+/, $_, 2;
		2671
		2672	$rmp->{lc $k} = $v if (length $k) && (length $v);
		2673	}
		2674
		2675	$rmp
		2676	}
		2677
		2678	sub prepare_random_map {
		2679	my ($exit) = @_;
		2680
		2681	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2682
		2683	# all this does is basically replace the /! path by
		2684	# a new random map path (?random/...) with a seed
		2685	# that depends on the exit object
		2686
		2687	my $rmp = parse_random_map_params $exit->msg;
		2688
		2689	if ($exit->map) {
		2690	$rmp->{region} = $exit->region->name;
		2691	$rmp->{origin_map} = $exit->map->path;
		2692	$rmp->{origin_x} = $exit->x;
		2693	$rmp->{origin_y} = $exit->y;
		2694	}
		2695
		2696	$rmp->{random_seed} ||= $exit->random_seed;
		2697
		2698	my $data = cf::encode_json $rmp;
		2699	my $md5 = Digest::MD5::md5_hex $data;
		2700	my $meta = "$RANDOMDIR/$md5.meta";
		2701
		2702	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		2703	aio_write $fh, 0, (length $data), $data, 0;
		2704	undef $fh;
		2705	aio_rename "$meta~", $meta;
		2706
		2707	$exit->slaying ("?random/$md5");
		2708	$exit->msg (undef);
		2709	}
		2710	}
		2711
		2712	sub cf::object::player::enter_exit {
		2713	my ($self, $exit) = @_;
		2714
		2715	return unless $self->type == cf::PLAYER;
		2716
		2717	if ($exit->slaying eq "/!") {
		2718	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2719	# the problem is that $exit might not survive long enough
		2720	# so it needs to be done right now, right here
		2721	cf::sync_job { prepare_random_map $exit };
		2722	}
		2723
		2724	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2725	my $hp = $exit->stats->hp;
		2726	my $sp = $exit->stats->sp;
		2727
		2728	$self->enter_link;
		2729
		2730	# if exit is damned, update players death & WoR home-position
		2731	$self->contr->savebed ($slaying, $hp, $sp)
		2732	if $exit->flag (FLAG_DAMNED);
		2733
		2734	(async {
		2735	$Coro::current->{desc} = "enter_exit $slaying $hp $sp";
		2736
		2737	$self->deactivate_recursive; # just to be sure
		2738	unless (eval {
		2739	$self->goto ($slaying, $hp, $sp);
		2740
		2741	1;
		2742	}) {
		2743	$self->message ("Something went wrong deep within the crossfire server. "
		2744	. "I'll try to bring you back to the map you were before. "
		2745	. "Please report this to the dungeon master!",
		2746	cf::NDI_UNIQUE | cf::NDI_RED);
		2747
		2748	warn "ERROR in enter_exit: $@";
		2749	$self->leave_link;
		2750	}
		2751	})->prio (1);
		2752	}
		2753
932	=head3 cf::client	2754	=head3 cf::client
933		2755
934	=over 4	2756	=over 4
935		2757
936	=item $client->send_drawinfo ($text, $flags)	2758	=item $client->send_drawinfo ($text, $flags)
…		…
942		2764
943	sub cf::client::send_drawinfo {	2765	sub cf::client::send_drawinfo {
944	my ($self, $text, $flags) = @_;	2766	my ($self, $text, $flags) = @_;
945		2767
946	utf8::encode $text;	2768	utf8::encode $text;
947	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2769	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
948	}	2770	}
949		2771
		2772	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2773
		2774	Send a drawinfo or msg packet to the client, formatting the msg for the
		2775	client if neccessary. C<$type> should be a string identifying the type of
		2776	the message, with C<log> being the default. If C<$color> is negative, suppress
		2777	the message unless the client supports the msg packet.
		2778
		2779	=cut
		2780
		2781	# non-persistent channels (usually the info channel)
		2782	our %CHANNEL = (
		2783	"c/identify" => {
		2784	id => "infobox",
		2785	title => "Identify",
		2786	reply => undef,
		2787	tooltip => "Items recently identified",
		2788	},
		2789	"c/examine" => {
		2790	id => "infobox",
		2791	title => "Examine",
		2792	reply => undef,
		2793	tooltip => "Signs and other items you examined",
		2794	},
		2795	"c/book" => {
		2796	id => "infobox",
		2797	title => "Book",
		2798	reply => undef,
		2799	tooltip => "The contents of a note or book",
		2800	},
		2801	"c/lookat" => {
		2802	id => "infobox",
		2803	title => "Look",
		2804	reply => undef,
		2805	tooltip => "What you saw there",
		2806	},
		2807	"c/who" => {
		2808	id => "infobox",
		2809	title => "Players",
		2810	reply => undef,
		2811	tooltip => "Shows players who are currently online",
		2812	},
		2813	"c/body" => {
		2814	id => "infobox",
		2815	title => "Body Parts",
		2816	reply => undef,
		2817	tooltip => "Shows which body parts you posess and are available",
		2818	},
		2819	"c/uptime" => {
		2820	id => "infobox",
		2821	title => "Uptime",
		2822	reply => undef,
		2823	tooltip => "How long the server has been running since last restart",
		2824	},
		2825	"c/mapinfo" => {
		2826	id => "infobox",
		2827	title => "Map Info",
		2828	reply => undef,
		2829	tooltip => "Information related to the maps",
		2830	},
		2831	);
		2832
		2833	sub cf::client::send_msg {
		2834	my ($self, $channel, $msg, $color, @extra) = @_;
		2835
		2836	$msg = $self->pl->expand_cfpod ($msg);
		2837
		2838	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2839
		2840	# check predefined channels, for the benefit of C
		2841	if ($CHANNEL{$channel}) {
		2842	$channel = $CHANNEL{$channel};
		2843
		2844	$self->ext_msg (channel_info => $channel)
		2845	if $self->can_msg;
		2846
		2847	$channel = $channel->{id};
		2848
		2849	} elsif (ref $channel) {
		2850	# send meta info to client, if not yet sent
		2851	unless (exists $self->{channel}{$channel->{id}}) {
		2852	$self->{channel}{$channel->{id}} = $channel;
		2853	$self->ext_msg (channel_info => $channel)
		2854	if $self->can_msg;
		2855	}
		2856
		2857	$channel = $channel->{id};
		2858	}
		2859
		2860	return unless @extra || length $msg;
		2861
		2862	if ($self->can_msg) {
		2863	# default colour, mask it out
		2864	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2865	if $color & cf::NDI_DEF;
		2866
		2867	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2868	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2869	} else {
		2870	if ($color >= 0) {
		2871	# replace some tags by gcfclient-compatible ones
		2872	for ($msg) {
		2873	1 while
		2874	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2875	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2876	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2877	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2878	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2879	}
		2880
		2881	$color &= cf::NDI_COLOR_MASK;
		2882
		2883	utf8::encode $msg;
		2884
		2885	if (0 && $msg =~ /\[/) {
		2886	# COMMAND/INFO
		2887	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2888	} else {
		2889	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2890	$self->send_packet ("drawinfo $color $msg")
		2891	}
		2892	}
		2893	}
		2894	}
		2895
		2896	=item $client->ext_msg ($type, @msg)
		2897
		2898	Sends an ext event to the client.
		2899
		2900	=cut
		2901
		2902	sub cf::client::ext_msg($$@) {
		2903	my ($self, $type, @msg) = @_;
		2904
		2905	if ($self->extcmd == 2) {
		2906	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2907	} elsif ($self->extcmd == 1) { # TODO: remove
		2908	push @msg, msgtype => "event_$type";
		2909	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2910	}
		2911	}
		2912
		2913	=item $client->ext_reply ($msgid, @msg)
		2914
		2915	Sends an ext reply to the client.
		2916
		2917	=cut
		2918
		2919	sub cf::client::ext_reply($$@) {
		2920	my ($self, $id, @msg) = @_;
		2921
		2922	if ($self->extcmd == 2) {
		2923	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2924	} elsif ($self->extcmd == 1) {
		2925	#TODO: version 1, remove
		2926	unshift @msg, msgtype => "reply", msgid => $id;
		2927	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2928	}
		2929	}
950		2930
951	=item $success = $client->query ($flags, "text", \&cb)	2931	=item $success = $client->query ($flags, "text", \&cb)
952		2932
953	Queues a query to the client, calling the given callback with	2933	Queues a query to the client, calling the given callback with
954	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2934	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
955	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2935	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
956		2936
957	Queries can fail, so check the return code. Or don't, as queries will become	2937	Queries can fail, so check the return code. Or don't, as queries will
958	reliable at some point in the future.	2938	become reliable at some point in the future.
959		2939
960	=cut	2940	=cut
961		2941
962	sub cf::client::query {	2942	sub cf::client::query {
963	my ($self, $flags, $text, $cb) = @_;	2943	my ($self, $flags, $text, $cb) = @_;
…		…
971	utf8::encode $text;	2951	utf8::encode $text;
972	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2952	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
973		2953
974	$self->send_packet ($self->{query_queue}[0][0])	2954	$self->send_packet ($self->{query_queue}[0][0])
975	if @{ $self->{query_queue} } == 1;	2955	if @{ $self->{query_queue} } == 1;
		2956
		2957	1
976	}	2958	}
977		2959
978	cf::client->attach (	2960	cf::client->attach (
		2961	on_connect => sub {
		2962	my ($ns) = @_;
		2963
		2964	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2965	},
979	on_reply => sub {	2966	on_reply => sub {
980	my ($ns, $msg) = @_;	2967	my ($ns, $msg) = @_;
981		2968
982	# this weird shuffling is so that direct followup queries	2969	# this weird shuffling is so that direct followup queries
983	# get handled first	2970	# get handled first
984	my $queue = delete $ns->{query_queue};	2971	my $queue = delete $ns->{query_queue}
		2972	or return; # be conservative, not sure how that can happen, but we saw a crash here
985		2973
986	(shift @$queue)->[1]->($msg);	2974	(shift @$queue)->[1]->($msg);
		2975	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
987		2976
988	push @{ $ns->{query_queue} }, @$queue;	2977	push @{ $ns->{query_queue} }, @$queue;
989		2978
990	if (@{ $ns->{query_queue} } == @$queue) {	2979	if (@{ $ns->{query_queue} } == @$queue) {
991	if (@$queue) {	2980	if (@$queue) {
…		…
993	} else {	2982	} else {
994	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2983	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
995	}	2984	}
996	}	2985	}
997	},	2986	},
		2987	on_exticmd => sub {
		2988	my ($ns, $buf) = @_;
		2989
		2990	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2991
		2992	if (ref $msg) {
		2993	my ($type, $reply, @payload) =
		2994	"ARRAY" eq ref $msg
		2995	? @$msg
		2996	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2997
		2998	my @reply;
		2999
		3000	if (my $cb = $EXTICMD{$type}) {
		3001	@reply = $cb->($ns, @payload);
		3002	}
		3003
		3004	$ns->ext_reply ($reply, @reply)
		3005	if $reply;
		3006
		3007	} else {
		3008	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		3009	}
		3010
		3011	cf::override;
		3012	},
998	);	3013	);
999		3014
1000	=item $client->coro (\&cb)	3015	=item $client->async (\&cb)
1001		3016
1002	Create a new coroutine, running the specified callback. The coroutine will	3017	Create a new coroutine, running the specified callback. The coroutine will
1003	be automatically cancelled when the client gets destroyed (e.g. on logout,	3018	be automatically cancelled when the client gets destroyed (e.g. on logout,
1004	or loss of connection).	3019	or loss of connection).
1005		3020
1006	=cut	3021	=cut
1007		3022
1008	sub cf::client::coro {	3023	sub cf::client::async {
1009	my ($self, $cb) = @_;	3024	my ($self, $cb) = @_;
1010		3025
1011	my $coro; $coro = async {	3026	my $coro = &Coro::async ($cb);
1012	eval {
1013	$cb->();
1014	};
1015	warn $@ if $@;
1016	};
1017		3027
1018	$coro->on_destroy (sub {	3028	$coro->on_destroy (sub {
1019	delete $self->{_coro}{$coro+0};	3029	delete $self->{_coro}{$coro+0};
1020	});	3030	});
1021		3031
…		…
1048	our $safe = new Safe "safe";	3058	our $safe = new Safe "safe";
1049	our $safe_hole = new Safe::Hole;	3059	our $safe_hole = new Safe::Hole;
1050		3060
1051	$SIG{FPE} = 'IGNORE';	3061	$SIG{FPE} = 'IGNORE';
1052		3062
1053	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3063	$safe->permit_only (Opcode::opset qw(
		3064	:base_core :base_mem :base_orig :base_math
		3065	grepstart grepwhile mapstart mapwhile
		3066	sort time
		3067	));
1054		3068
1055	# here we export the classes and methods available to script code	3069	# here we export the classes and methods available to script code
1056		3070
1057	=pod	3071	=pod
1058		3072
1059	The following fucntions and emthods are available within a safe environment:	3073	The following functions and methods are available within a safe environment:
1060		3074
1061	cf::object contr pay_amount pay_player map	3075	cf::object
		3076	contr pay_amount pay_player map x y force_find force_add destroy
		3077	insert remove name archname title slaying race decrease_ob_nr
		3078
1062	cf::object::player player	3079	cf::object::player
1063	cf::player peaceful	3080	player
1064	cf::map trigger	3081
		3082	cf::player
		3083	peaceful
		3084
		3085	cf::map
		3086	trigger
1065		3087
1066	=cut	3088	=cut
1067		3089
1068	for (	3090	for (
1069	["cf::object" => qw(contr pay_amount pay_player map)],	3091	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3092	insert remove inv name archname title slaying race
		3093	decrease_ob_nr destroy)],
1070	["cf::object::player" => qw(player)],	3094	["cf::object::player" => qw(player)],
1071	["cf::player" => qw(peaceful)],	3095	["cf::player" => qw(peaceful)],
1072	["cf::map" => qw(trigger)],	3096	["cf::map" => qw(trigger)],
1073	) {	3097	) {
1074	no strict 'refs';	3098	no strict 'refs';
…		…
1145	=back	3169	=back
1146		3170
1147	=cut	3171	=cut
1148		3172
1149	#############################################################################	3173	#############################################################################
		3174	# the server's init and main functions
1150		3175
1151	=head2 EXTENSION DATABASE SUPPORT	3176	sub load_facedata($) {
		3177	my ($path) = @_;
1152		3178
1153	Crossfire maintains a very simple database for extension use. It can	3179	# HACK to clear player env face cache, we need some signal framework
1154	currently store anything that can be serialised using Storable, which	3180	# for this (global event?)
1155	excludes objects.	3181	%ext::player_env::MUSIC_FACE_CACHE = ();
1156		3182
1157	The parameter C<$family> should best start with the name of the extension	3183	my $enc = JSON::XS->new->utf8->canonical->relaxed;
1158	using it, it should be unique.
1159		3184
1160	=over 4	3185	warn "loading facedata from $path\n";
1161		3186
1162	=item $hashref = cf::db_get $family	3187	my $facedata;
		3188	0 < aio_load $path, $facedata
		3189	or die "$path: $!";
1163		3190
1164	Return a hashref for use by the extension C<$family>, which can be	3191	$facedata = Coro::Storable::thaw $facedata;
1165	modified. After modifications, you have to call C<cf::db_dirty> or
1166	C<cf::db_sync>.
1167		3192
1168	=item $value = cf::db_get $family => $key	3193	$facedata->{version} == 2
		3194	or cf::cleanup "$path: version mismatch, cannot proceed.";
1169		3195
1170	Returns a single value from the database	3196	# patch in the exptable
1171		3197	$facedata->{resource}{"res/exp_table"} = {
1172	=item cf::db_put $family => $hashref	3198	type => FT_RSRC,
1173		3199	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1174	Stores the given family hashref into the database. Updates are delayed, if
1175	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1176
1177	=item cf::db_put $family => $key => $value
1178
1179	Stores the given C<$value> in the family hash. Updates are delayed, if you
1180	want the data to be synced to disk immediately, use C<cf::db_sync>.
1181
1182	=item cf::db_dirty
1183
1184	Marks the database as dirty, to be updated at a later time.
1185
1186	=item cf::db_sync
1187
1188	Immediately write the database to disk I<if it is dirty>.
1189
1190	=cut
1191
1192	our $DB;
1193
1194	{
1195	my $path = cf::localdir . "/database.pst";
1196
1197	sub db_load() {
1198	warn "loading database $path\n";#d# remove later
1199	$DB = stat $path ? Storable::retrieve $path : { };
1200	}
1201
1202	my $pid;
1203
1204	sub db_save() {
1205	warn "saving database $path\n";#d# remove later
1206	waitpid $pid, 0 if $pid;
1207	if (0 == ($pid = fork)) {
1208	$DB->{_meta}{version} = 1;
1209	Storable::nstore $DB, "$path~";
1210	rename "$path~", $path;
1211	cf::_exit 0 if defined $pid;
1212	}
1213	}
1214
1215	my $dirty;
1216
1217	sub db_sync() {
1218	db_save if $dirty;
1219	undef $dirty;
1220	}
1221
1222	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1223	db_sync;
1224	});	3200	};
		3201	cf::cede_to_tick;
1225		3202
1226	sub db_dirty() {
1227	$dirty = 1;
1228	$idle->start;
1229	}	3203	{
		3204	my $faces = $facedata->{faceinfo};
1230		3205
1231	sub db_get($;$) {	3206	while (my ($face, $info) = each %$faces) {
1232	@_ >= 2	3207	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1233	? $DB->{$_[0]}{$_[1]}
1234	: ($DB->{$_[0]} ||= { })
1235	}
1236		3208
1237	sub db_put($$;$) {	3209	cf::face::set_visibility $idx, $info->{visibility};
1238	if (@_ >= 3) {	3210	cf::face::set_magicmap $idx, $info->{magicmap};
1239	$DB->{$_[0]}{$_[1]} = $_[2];	3211	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
1240	} else {	3212	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1241	$DB->{$_[0]} = $_[1];
1242	}
1243	db_dirty;
1244	}
1245		3213
1246	cf::global->attach (	3214	cf::cede_to_tick;
1247	prio => 10000,
1248	on_cleanup => sub {
1249	db_sync;
1250	},	3215	}
		3216
		3217	while (my ($face, $info) = each %$faces) {
		3218	next unless $info->{smooth};
		3219
		3220	my $idx = cf::face::find $face
		3221	or next;
		3222
		3223	if (my $smooth = cf::face::find $info->{smooth}) {
		3224	cf::face::set_smooth $idx, $smooth;
		3225	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3226	} else {
		3227	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3228	}
		3229
		3230	cf::cede_to_tick;
		3231	}
		3232	}
		3233
		3234	{
		3235	my $anims = $facedata->{animinfo};
		3236
		3237	while (my ($anim, $info) = each %$anims) {
		3238	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3239	cf::cede_to_tick;
		3240	}
		3241
		3242	cf::anim::invalidate_all; # d'oh
		3243	}
		3244
		3245	{
		3246	# TODO: for gcfclient pleasure, we should give resources
		3247	# that gcfclient doesn't grok a >10000 face index.
		3248	my $res = $facedata->{resource};
		3249
		3250	while (my ($name, $info) = each %$res) {
		3251	if (defined $info->{type}) {
		3252	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3253	my $data;
		3254
		3255	if ($info->{type} & 1) {
		3256	# prepend meta info
		3257
		3258	my $meta = $enc->encode ({
		3259	name => $name,
		3260	%{ $info->{meta} || {} },
		3261	});
		3262
		3263	$data = pack "(w/a*)*", $meta, $info->{data};
		3264	} else {
		3265	$data = $info->{data};
		3266	}
		3267
		3268	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3269	cf::face::set_type $idx, $info->{type};
		3270	} else {
		3271	$RESOURCE{$name} = $info;
		3272	}
		3273
		3274	cf::cede_to_tick;
		3275	}
		3276	}
		3277
		3278	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3279
		3280	1
		3281	}
		3282
		3283	cf::global->attach (on_resource_update => sub {
		3284	if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
		3285	$soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
		3286
		3287	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3288	my $sound = $soundconf->{compat}[$_]
		3289	or next;
		3290
		3291	my $face = cf::face::find "sound/$sound->[1]";
		3292	cf::sound::set $sound->[0] => $face;
		3293	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3294	}
		3295
		3296	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3297	my $face = cf::face::find "sound/$v";
		3298	cf::sound::set $k => $face;
		3299	}
		3300	}
		3301	});
		3302
		3303	register_exticmd fx_want => sub {
		3304	my ($ns, $want) = @_;
		3305
		3306	while (my ($k, $v) = each %$want) {
		3307	$ns->fx_want ($k, $v);
		3308	}
		3309	};
		3310
		3311	sub reload_regions {
		3312	# HACK to clear player env face cache, we need some signal framework
		3313	# for this (global event?)
		3314	%ext::player_env::MUSIC_FACE_CACHE = ();
		3315
		3316	load_resource_file "$MAPDIR/regions"
		3317	or die "unable to load regions file\n";
		3318
		3319	for (cf::region::list) {
		3320	$_->{match} = qr/$_->{match}/
		3321	if exists $_->{match};
		3322	}
		3323	}
		3324
		3325	sub reload_facedata {
		3326	load_facedata "$DATADIR/facedata"
		3327	or die "unable to load facedata\n";
		3328	}
		3329
		3330	sub reload_archetypes {
		3331	load_resource_file "$DATADIR/archetypes"
		3332	or die "unable to load archetypes\n";
		3333	#d# NEED to laod twice to resolve forward references
		3334	# this really needs to be done in an extra post-pass
		3335	# (which needs to be synchronous, so solve it differently)
		3336	load_resource_file "$DATADIR/archetypes"
		3337	or die "unable to load archetypes\n";
		3338	}
		3339
		3340	sub reload_treasures {
		3341	load_resource_file "$DATADIR/treasures"
		3342	or die "unable to load treasurelists\n";
		3343	}
		3344
		3345	sub reload_resources {
		3346	warn "reloading resource files...\n";
		3347
		3348	reload_regions;
		3349	reload_facedata;
		3350	#reload_archetypes;#d#
		3351	reload_archetypes;
		3352	reload_treasures;
		3353
		3354	warn "finished reloading resource files\n";
		3355	}
		3356
		3357	sub init {
		3358	reload_resources;
		3359	}
		3360
		3361	sub reload_config {
		3362	open my $fh, "<:utf8", "$CONFDIR/config"
		3363	or return;
		3364
		3365	local $/;
		3366	*CFG = YAML::Load <$fh>;
		3367
		3368	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		3369
		3370	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		3371	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		3372
		3373	if (exists $CFG{mlockall}) {
		3374	eval {
		3375	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		3376	and die "WARNING: m(un)lockall failed: $!\n";
		3377	};
		3378	warn $@ if $@;
		3379	}
		3380	}
		3381
		3382	sub main {
		3383	# we must not ever block the main coroutine
		3384	local $Coro::idle = sub {
		3385	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		3386	(async {
		3387	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3388	EV::loop EV::LOOP_ONESHOT;
		3389	})->prio (Coro::PRIO_MAX);
1251	);	3390	};
		3391
		3392	reload_config;
		3393	db_init;
		3394	load_extensions;
		3395
		3396	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3397	evthread_start IO::AIO::poll_fileno;
		3398	EV::loop;
1252	}	3399	}
1253		3400
1254	#############################################################################	3401	#############################################################################
1255	# the server's main()	3402	# initialisation and cleanup
1256		3403
1257	sub cfg_load {	3404	# install some emergency cleanup handlers
1258	open my $fh, "<:utf8", cf::confdir . "/config"	3405	BEGIN {
		3406	our %SIGWATCHER = ();
		3407	for my $signal (qw(INT HUP TERM)) {
		3408	$SIGWATCHER{$signal} = EV::signal $signal, sub {
		3409	cf::cleanup "SIG$signal";
		3410	};
		3411	}
		3412	}
		3413
		3414	sub write_runtime_sync {
		3415	my $runtime = "$LOCALDIR/runtime";
		3416
		3417	# first touch the runtime file to show we are still running:
		3418	# the fsync below can take a very very long time.
		3419
		3420	IO::AIO::aio_utime $runtime, undef, undef;
		3421
		3422	my $guard = cf::lock_acquire "write_runtime";
		3423
		3424	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
1259	or return;	3425	or return;
1260		3426
1261	local $/;	3427	my $value = $cf::RUNTIME + 90 + 10;
1262	*CFG = YAML::Syck::Load <$fh>;	3428	# 10 is the runtime save interval, for a monotonic clock
1263	}	3429	# 60 allows for the watchdog to kill the server.
1264		3430
1265	sub main {	3431	(aio_write $fh, 0, (length $value), $value, 0) <= 0
1266	cfg_load;	3432	and return;
1267	db_load;
1268	load_extensions;
1269	Event::loop;
1270	}
1271		3433
1272	#############################################################################	3434	# always fsync - this file is important
1273	# initialisation	3435	aio_fsync $fh
		3436	and return;
1274		3437
1275	sub _perl_reload() {	3438	# touch it again to show we are up-to-date
		3439	aio_utime $fh, undef, undef;
		3440
		3441	close $fh
		3442	or return;
		3443
		3444	aio_rename "$runtime~", $runtime
		3445	and return;
		3446
		3447	warn "runtime file written.\n";
		3448
		3449	1
		3450	}
		3451
		3452	our $uuid_lock;
		3453	our $uuid_skip;
		3454
		3455	sub write_uuid_sync($) {
		3456	$uuid_skip ||= $_[0];
		3457
		3458	return if $uuid_lock;
		3459	local $uuid_lock = 1;
		3460
		3461	my $uuid = "$LOCALDIR/uuid";
		3462
		3463	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3464	or return;
		3465
		3466	my $value = uuid_str $uuid_skip + uuid_seq uuid_cur;
		3467	$uuid_skip = 0;
		3468
		3469	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3470	and return;
		3471
		3472	# always fsync - this file is important
		3473	aio_fsync $fh
		3474	and return;
		3475
		3476	close $fh
		3477	or return;
		3478
		3479	aio_rename "$uuid~", $uuid
		3480	and return;
		3481
		3482	warn "uuid file written ($value).\n";
		3483
		3484	1
		3485
		3486	}
		3487
		3488	sub write_uuid($$) {
		3489	my ($skip, $sync) = @_;
		3490
		3491	$sync ? write_uuid_sync $skip
		3492	: async { write_uuid_sync $skip };
		3493	}
		3494
		3495	sub emergency_save() {
		3496	my $freeze_guard = cf::freeze_mainloop;
		3497
		3498	warn "enter emergency perl save\n";
		3499
		3500	cf::sync_job {
		3501	# use a peculiar iteration method to avoid tripping on perl
		3502	# refcount bugs in for. also avoids problems with players
		3503	# and maps saved/destroyed asynchronously.
		3504	warn "begin emergency player save\n";
		3505	for my $login (keys %cf::PLAYER) {
		3506	my $pl = $cf::PLAYER{$login} or next;
		3507	$pl->valid or next;
		3508	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
		3509	$pl->save;
		3510	}
		3511	warn "end emergency player save\n";
		3512
		3513	warn "begin emergency map save\n";
		3514	for my $path (keys %cf::MAP) {
		3515	my $map = $cf::MAP{$path} or next;
		3516	$map->valid or next;
		3517	$map->save;
		3518	}
		3519	warn "end emergency map save\n";
		3520
		3521	warn "begin emergency database checkpoint\n";
		3522	BDB::db_env_txn_checkpoint $DB_ENV;
		3523	warn "end emergency database checkpoint\n";
		3524
		3525	warn "begin write uuid\n";
		3526	write_uuid_sync 1;
		3527	warn "end write uuid\n";
		3528	};
		3529
		3530	warn "leave emergency perl save\n";
		3531	}
		3532
		3533	sub post_cleanup {
		3534	my ($make_core) = @_;
		3535
		3536	warn Carp::longmess "post_cleanup backtrace"
		3537	if $make_core;
		3538	}
		3539
		3540	sub do_reload_perl() {
		3541	# can/must only be called in main
		3542	if ($Coro::current != $Coro::main) {
		3543	warn "can only reload from main coroutine";
		3544	return;
		3545	}
		3546
1276	warn "reloading...";	3547	warn "reloading...";
1277		3548
1278	eval {	3549	warn "entering sync_job";
1279	local $FREEZE = 1;
1280		3550
		3551	cf::sync_job {
		3552	cf::write_runtime_sync; # external watchdog should not bark
1281	cf::emergency_save;	3553	cf::emergency_save;
		3554	cf::write_runtime_sync; # external watchdog should not bark
1282		3555
1283	# cancel all watchers	3556	warn "syncing database to disk";
1284	for (Event::all_watchers) {	3557	BDB::db_env_txn_checkpoint $DB_ENV;
1285	$_->cancel if $_->data & WF_AUTOCANCEL;
1286	}
1287		3558
		3559	# if anything goes wrong in here, we should simply crash as we already saved
		3560
		3561	warn "flushing outstanding aio requests";
		3562	for (;;) {
		3563	BDB::flush;
		3564	IO::AIO::flush;
		3565	Coro::cede_notself;
		3566	last unless IO::AIO::nreqs || BDB::nreqs;
		3567	warn "iterate...";
		3568	}
		3569
		3570	++$RELOAD;
		3571
1288	# cancel all extension coros	3572	warn "cancelling all extension coros";
1289	$_->cancel for values %EXT_CORO;	3573	$_->cancel for values %EXT_CORO;
1290	%EXT_CORO = ();	3574	%EXT_CORO = ();
1291		3575
1292	# unload all extensions	3576	warn "removing commands";
1293	for (@exts) {	3577	%COMMAND = ();
		3578
		3579	warn "removing ext/exti commands";
		3580	%EXTCMD = ();
		3581	%EXTICMD = ();
		3582
		3583	warn "unloading/nuking all extensions";
		3584	for my $pkg (@EXTS) {
1294	warn "unloading <$_>";	3585	warn "... unloading $pkg";
1295	unload_extension $_;	3586
		3587	if (my $cb = $pkg->can ("unload")) {
		3588	eval {
		3589	$cb->($pkg);
		3590	1
		3591	} or warn "$pkg unloaded, but with errors: $@";
1296	}	3592	}
1297		3593
		3594	warn "... nuking $pkg";
		3595	Symbol::delete_package $pkg;
		3596	}
		3597
1298	# unload all modules loaded from $LIBDIR	3598	warn "unloading all perl modules loaded from $LIBDIR";
1299	while (my ($k, $v) = each %INC) {	3599	while (my ($k, $v) = each %INC) {
1300	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3600	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1301		3601
1302	warn "removing <$k>";	3602	warn "... unloading $k";
1303	delete $INC{$k};	3603	delete $INC{$k};
1304		3604
1305	$k =~ s/\.pm$//;	3605	$k =~ s/\.pm$//;
1306	$k =~ s/\//::/g;	3606	$k =~ s/\//::/g;
1307		3607
…		…
1310	}	3610	}
1311		3611
1312	Symbol::delete_package $k;	3612	Symbol::delete_package $k;
1313	}	3613	}
1314		3614
1315	# sync database to disk
1316	cf::db_sync;
1317	IO::AIO::flush;
1318
1319	# get rid of safe::, as good as possible	3615	warn "getting rid of safe::, as good as possible";
1320	Symbol::delete_package "safe::$_"	3616	Symbol::delete_package "safe::$_"
1321	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3617	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1322		3618
1323	# remove register_script_function callbacks
1324	# TODO
1325
1326	# unload cf.pm "a bit"	3619	warn "unloading cf.pm \"a bit\"";
1327	delete $INC{"cf.pm"};	3620	delete $INC{"cf.pm"};
		3621	delete $INC{"cf/pod.pm"};
1328		3622
1329	# don't, removes xs symbols, too,	3623	# don't, removes xs symbols, too,
1330	# and global variables created in xs	3624	# and global variables created in xs
1331	#Symbol::delete_package __PACKAGE__;	3625	#Symbol::delete_package __PACKAGE__;
1332		3626
1333	# reload cf.pm	3627	warn "unload completed, starting to reload now";
		3628
1334	warn "reloading cf.pm";	3629	warn "reloading cf.pm";
1335	require cf;	3630	require cf;
1336	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3631	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1337		3632
1338	# load config and database again	3633	warn "loading config and database again";
1339	cf::cfg_load;	3634	cf::reload_config;
1340	cf::db_load;
1341		3635
1342	# load extensions
1343	warn "load extensions";	3636	warn "loading extensions";
1344	cf::load_extensions;	3637	cf::load_extensions;
1345		3638
1346	# reattach attachments to objects	3639	warn "reattaching attachments to objects/players";
1347	warn "reattach";	3640	_global_reattach; # objects, sockets
1348	_global_reattach;	3641	warn "reattaching attachments to maps";
		3642	reattach $_ for values %MAP;
		3643	warn "reattaching attachments to players";
		3644	reattach $_ for values %PLAYER;
		3645
		3646	warn "leaving sync_job";
		3647
		3648	1
		3649	} or do {
		3650	warn $@;
		3651	cf::cleanup "error while reloading, exiting.";
1349	};	3652	};
1350	warn $@ if $@;
1351		3653
1352	warn "reloaded";	3654	warn "reloaded";
1353	};	3655	};
1354		3656
1355	sub perl_reload() {	3657	our $RELOAD_WATCHER; # used only during reload
1356	_perl_reload;
1357	}
1358		3658
1359	register "<global>", __PACKAGE__;	3659	sub reload_perl() {
		3660	# doing reload synchronously and two reloads happen back-to-back,
		3661	# coro crashes during coro_state_free->destroy here.
1360		3662
		3663	$RELOAD_WATCHER ||= EV::timer 0, 0, sub {
		3664	do_reload_perl;
		3665	undef $RELOAD_WATCHER;
		3666	};
		3667	}
		3668
1361	register_command "perl-reload" => sub {	3669	register_command "reload" => sub {
1362	my ($who, $arg) = @_;	3670	my ($who, $arg) = @_;
1363		3671
1364	if ($who->flag (FLAG_WIZ)) {	3672	if ($who->flag (FLAG_WIZ)) {
1365	$who->message ("reloading...");	3673	$who->message ("reloading server.");
1366	_perl_reload;	3674	async {
		3675	$Coro::current->{desc} = "perl_reload";
		3676	reload_perl;
		3677	};
1367	}	3678	}
1368	};	3679	};
1369		3680
1370	unshift @INC, $LIBDIR;	3681	unshift @INC, $LIBDIR;
1371		3682
1372	$TICK_WATCHER = Event->timer (	3683	my $bug_warning = 0;
1373	reentrant => 0,	3684
1374	prio => 0,	3685	our @WAIT_FOR_TICK;
1375	at => $NEXT_TICK || $TICK,	3686	our @WAIT_FOR_TICK_BEGIN;
1376	data => WF_AUTOCANCEL,	3687
1377	cb => sub {	3688	sub wait_for_tick {
1378	unless ($FREEZE) {	3689	return if tick_inhibit;
		3690	return if $Coro::current == $Coro::main;
		3691
		3692	my $signal = new Coro::Signal;
		3693	push @WAIT_FOR_TICK, $signal;
		3694	$signal->wait;
		3695	}
		3696
		3697	sub wait_for_tick_begin {
		3698	return if tick_inhibit;
		3699	return if $Coro::current == $Coro::main;
		3700
		3701	my $signal = new Coro::Signal;
		3702	push @WAIT_FOR_TICK_BEGIN, $signal;
		3703	$signal->wait;
		3704	}
		3705
		3706	sub tick {
		3707	if ($Coro::current != $Coro::main) {
		3708	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3709	unless ++$bug_warning > 10;
		3710	return;
		3711	}
		3712
1379	cf::server_tick; # one server iteration	3713	cf::server_tick; # one server iteration
1380	$RUNTIME += $TICK;	3714
		3715	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		3716	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
		3717	Coro::async_pool {
		3718	$Coro::current->{desc} = "runtime saver";
		3719	write_runtime_sync
		3720	or warn "ERROR: unable to write runtime file: $!";
1381	}	3721	};
1382
1383	$NEXT_TICK += $TICK;
1384
1385	# if we are delayed by four ticks or more, skip them all
1386	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1387
1388	$TICK_WATCHER->at ($NEXT_TICK);
1389	$TICK_WATCHER->start;
1390	},	3722	}
1391	);
1392		3723
		3724	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3725	$sig->send;
		3726	}
		3727	while (my $sig = shift @WAIT_FOR_TICK) {
		3728	$sig->send;
		3729	}
		3730
		3731	$LOAD = ($NOW - $TICK_START) / $TICK;
		3732	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3733
		3734	if (0) {
		3735	if ($NEXT_TICK) {
		3736	my $jitter = $TICK_START - $NEXT_TICK;
		3737	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		3738	warn "jitter $JITTER\n";#d#
		3739	}
		3740	}
		3741	}
		3742
		3743	{
		3744	# configure BDB
		3745
		3746	BDB::min_parallel 8;
		3747	BDB::max_poll_reqs $TICK * 0.1;
		3748	$Coro::BDB::WATCHER->priority (1);
		3749
		3750	unless ($DB_ENV) {
		3751	$DB_ENV = BDB::db_env_create;
		3752	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
		3753	| BDB::LOG_AUTOREMOVE, 1);
		3754	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3755	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3756
		3757	cf::sync_job {
		3758	eval {
		3759	BDB::db_env_open
		3760	$DB_ENV,
		3761	$BDBDIR,
		3762	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3763	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3764	0666;
		3765
		3766	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3767	};
		3768
		3769	cf::cleanup "db_env_open(db): $@" if $@;
		3770	};
		3771	}
		3772
		3773	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3774	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3775	};
		3776	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		3777	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3778	};
		3779	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3780	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3781	};
		3782	}
		3783
		3784	{
		3785	# configure IO::AIO
		3786
		3787	IO::AIO::min_parallel 8;
1393	IO::AIO::max_poll_time $TICK * 0.2;	3788	IO::AIO::max_poll_time $TICK * 0.1;
		3789	$Coro::AIO::WATCHER->priority (1);
		3790	}
1394		3791
1395	Event->io (fd => IO::AIO::poll_fileno,	3792	my $_log_backtrace;
1396	poll => 'r',
1397	prio => 5,
1398	data => WF_AUTOCANCEL,
1399	cb => \&IO::AIO::poll_cb);
1400		3793
1401	# we must not ever block the main coroutine	3794	sub _log_backtrace {
1402	$Coro::idle = sub {	3795	my ($msg, @addr) = @_;
1403	#Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#	3796
1404	warn "FATAL: Coro::idle was called, major BUG\n";	3797	$msg =~ s/\n//;
1405	(Coro::unblock_sub {	3798
1406	Event::one_event;	3799	# limit the # of concurrent backtraces
1407	})->();	3800	if ($_log_backtrace < 2) {
1408	};	3801	++$_log_backtrace;
		3802	async {
		3803	$Coro::current->{desc} = "abt $msg";
		3804
		3805	my @bt = fork_call {
		3806	@addr = map { sprintf "%x", $_ } @addr;
		3807	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3808	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3809	or die "addr2line: $!";
		3810
		3811	my @funcs;
		3812	my @res = <$fh>;
		3813	chomp for @res;
		3814	while (@res) {
		3815	my ($func, $line) = splice @res, 0, 2, ();
		3816	push @funcs, "[$func] $line";
		3817	}
		3818
		3819	@funcs
		3820	};
		3821
		3822	LOG llevInfo, "[ABT] $msg\n";
		3823	LOG llevInfo, "[ABT] $_\n" for @bt;
		3824	--$_log_backtrace;
		3825	};
		3826	} else {
		3827	LOG llevInfo, "[ABT] $msg\n";
		3828	LOG llevInfo, "[ABT] [suppressed]\n";
		3829	}
		3830	}
		3831
		3832	# load additional modules
		3833	use cf::pod;
		3834
		3835	END { cf::emergency_save }
1409		3836
1410	1	3837	1
1411		3838

Diff Legend

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