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.186 by root, Sat Jan 20 01:12:39 2007 UTC vs.
Revision 1.505 by root, Sun Jan 31 03:46:20 2010 UTC

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

Diff Legend

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