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.182 by root, Fri Jan 19 15:38:01 2007 UTC vs.
Revision 1.506 by root, Wed Feb 3 20:48:22 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 + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	574	=cut
355	(aio_write $fh, 0, (length $value), $value, 0) <= 0
356	and return;
357		575
358	aio_fsync $fh	576	sub fork_call(&@) {
359	and return;	577	my ($cb, @args) = @_;
360		578
361	close $fh	579	# we seemingly have to make a local copy of the whole thing,
362	or return;	580	# otherwise perl prematurely frees the stuff :/
		581	# TODO: investigate and fix (likely this will be rather laborious)
363		582
364	aio_rename "$runtime~", $runtime	583	my @res = Coro::Util::fork_eval {
365	and return;	584	reset_signals;
		585	&$cb
		586	}, @args;
366		587
		588	wantarray ? @res : $res[-1]
		589	}
		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
367	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 });
368	}	754	}
369		755
370	=back	756	=back
371		757
372	=cut	758	=cut
373		759
374	#############################################################################	760	#############################################################################
375		761
376	=head2 ATTACHABLE OBJECTS	762	=head2 ATTACHABLE OBJECTS
377		763
378	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
379	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")
380	to it. All such attachable objects support the following methods.	766	to it. All such attachable objects support the following methods.
381		767
382	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>
383	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
384	crossfire+).	770	Deliantra).
385		771
386	=over 4	772	=over 4
387		773
388	=item $attachable->attach ($attachment, key => $value...)	774	=item $attachable->attach ($attachment, key => $value...)
389		775
…		…
433	=item cf::CLASS::attachment $name, ...	819	=item cf::CLASS::attachment $name, ...
434		820
435	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
436	given CLASS can refer to this attachment.	822	given CLASS can refer to this attachment.
437		823
438	Some classes such as crossfire maps and objects can specify attachments	824	Some classes such as deliantra maps and objects can specify attachments
439	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.
440		826
441	These calls expect any number of the following handler/hook descriptions:	827	These calls expect any number of the following handler/hook descriptions:
442		828
443	=over 4	829	=over 4
…		…
552	$registry = $CB_TYPE[$object_type] ||= [];	938	$registry = $CB_TYPE[$object_type] ||= [];
553		939
554	} elsif ($type eq "subtype") {	940	} elsif ($type eq "subtype") {
555	defined $object_type or Carp::croak "subtype specified without type";	941	defined $object_type or Carp::croak "subtype specified without type";
556	my $object_subtype = shift @arg;	942	my $object_subtype = shift @arg;
557	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	943	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
558		944
559	} elsif ($type eq "package") {	945	} elsif ($type eq "package") {
560	my $pkg = shift @arg;	946	my $pkg = shift @arg;
561		947
562	while (my ($name, $id) = each %cb_id) {	948	while (my ($name, $id) = each %cb_id) {
…		…
591	_attach $registry, $klass, @attach;	977	_attach $registry, $klass, @attach;
592	}	978	}
593		979
594	$obj->{$name} = \%arg;	980	$obj->{$name} = \%arg;
595	} else {	981	} else {
596	warn "object uses attachment '$name' that is not available, postponing.\n";	982	warn "object uses attachment '$name' which is not available, postponing.\n";
597	}	983	}
598		984
599	$obj->{_attachment}{$name} = undef;	985	$obj->{_attachment}{$name} = undef;
600	}	986	}
601		987
…		…
603	if (ref $_[0]) {	989	if (ref $_[0]) {
604	_object_attach @_;	990	_object_attach @_;
605	} else {	991	} else {
606	_attach shift->_attach_registry, @_;	992	_attach shift->_attach_registry, @_;
607	}	993	}
		994	_recalc_want;
608	};	995	};
609		996
610	# all those should be optimised	997	# all those should be optimised
611	sub cf::attachable::detach {	998	sub cf::attachable::detach {
612	my ($obj, $name) = @_;	999	my ($obj, $name) = @_;
…		…
615	delete $obj->{_attachment}{$name};	1002	delete $obj->{_attachment}{$name};
616	reattach ($obj);	1003	reattach ($obj);
617	} else {	1004	} else {
618	Carp::croak "cannot, currently, detach class attachments";	1005	Carp::croak "cannot, currently, detach class attachments";
619	}	1006	}
		1007	_recalc_want;
620	};	1008	};
621		1009
622	sub cf::attachable::attached {	1010	sub cf::attachable::attached {
623	my ($obj, $name) = @_;	1011	my ($obj, $name) = @_;
624		1012
…		…
639	";	1027	";
640	die if $@;	1028	die if $@;
641	}	1029	}
642		1030
643	our $override;	1031	our $override;
644	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?
645		1033
646	sub override {	1034	sub override {
647	$override = 1;	1035	$override = 1;
648	@invoke_results = ();	1036	@INVOKE_RESULTS = (@_);
649	}	1037	}
650		1038
651	sub do_invoke {	1039	sub do_invoke {
652	my $event = shift;	1040	my $event = shift;
653	my $callbacks = shift;	1041	my $callbacks = shift;
654		1042
655	@invoke_results = ();	1043	@INVOKE_RESULTS = ();
656		1044
657	local $override;	1045	local $override;
658		1046
659	for (@$callbacks) {	1047	for (@$callbacks) {
660	eval { &{$_->[1]} };	1048	eval { &{$_->[1]} };
…		…
669	}	1057	}
670		1058
671	0	1059	0
672	}	1060	}
673		1061
674	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1062	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
675		1063
676	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1064	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
677		1065
678	Generate an object-specific event with the given arguments.	1066	Generate an object-specific event with the given arguments.
679		1067
680	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
681	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
682	results (if you must, access C<@cf::invoke_results> directly).	1070	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
683		1071
684	=back	1072	=back
685		1073
686	=cut	1074	=cut
687		1075
688	#############################################################################	1076	#############################################################################
689	# 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	}
690		1120
691	sub reattach {	1121	sub reattach {
692	# basically do the same as instantiate, without calling instantiate	1122	# basically do the same as instantiate, without calling instantiate
693	my ($obj) = @_;	1123	my ($obj) = @_;
694		1124
		1125	# no longer needed after getting rid of delete_package?
695	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
696		1127
697	my $registry = $obj->registry;	1128	my $registry = $obj->registry;
698		1129
699	@$registry = ();	1130	@$registry = ();
700		1131
…		…
715	cf::attachable->attach (	1146	cf::attachable->attach (
716	prio => -1000000,	1147	prio => -1000000,
717	on_instantiate => sub {	1148	on_instantiate => sub {
718	my ($obj, $data) = @_;	1149	my ($obj, $data) = @_;
719		1150
720	$data = from_json $data;	1151	$data = decode_json $data;
721		1152
722	for (@$data) {	1153	for (@$data) {
723	my ($name, $args) = @$_;	1154	my ($name, $args) = @$_;
724		1155
725	$obj->attach ($name, %{$args || {} });	1156	$obj->attach ($name, %{$args || {} });
…		…
741	sub object_freezer_save {	1172	sub object_freezer_save {
742	my ($filename, $rdata, $objs) = @_;	1173	my ($filename, $rdata, $objs) = @_;
743		1174
744	sync_job {	1175	sync_job {
745	if (length $$rdata) {	1176	if (length $$rdata) {
		1177	utf8::decode (my $decname = $filename);
746	warn sprintf "saving %s (%d,%d)\n",	1178	warn sprintf "saving %s (%d,%d)\n",
747	$filename, length $$rdata, scalar @$objs;	1179	$decname, length $$rdata, scalar @$objs;
748		1180
749	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1181	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
750	chmod SAVE_MODE, $fh;	1182	aio_chmod $fh, SAVE_MODE;
751	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;
752	aio_fsync $fh;	1186	aio_fsync $fh;
		1187	}
753	close $fh;	1188	aio_close $fh;
754		1189
755	if (@$objs) {	1190	if (@$objs) {
756	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) {
757	chmod SAVE_MODE, $fh;	1192	aio_chmod $fh, SAVE_MODE;
758	my $data = Storable::nfreeze { version => 1, objs => $objs };	1193	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
759	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;
760	aio_fsync $fh;	1197	aio_fsync $fh;
		1198	}
761	close $fh;	1199	aio_close $fh;
762	aio_rename "$filename.pst~", "$filename.pst";	1200	aio_rename "$filename.pst~", "$filename.pst";
763	}	1201	}
764	} else {	1202	} else {
765	aio_unlink "$filename.pst";	1203	aio_unlink "$filename.pst";
766	}	1204	}
767		1205
768	aio_rename "$filename~", $filename;	1206	aio_rename "$filename~", $filename;
		1207
		1208	$filename =~ s%/[^/]+$%%;
		1209	aio_pathsync $filename if $cf::USE_FSYNC;
769	} else {	1210	} else {
770	warn "FATAL: $filename~: $!\n";	1211	warn "unable to save objects: $filename~: $!\n";
771	}	1212	}
772	} else {	1213	} else {
773	aio_unlink $filename;	1214	aio_unlink $filename;
774	aio_unlink "$filename.pst";	1215	aio_unlink "$filename.pst";
775	}	1216	}
776	}	1217	};
777	}	1218	}
778		1219
779	sub object_freezer_as_string {	1220	sub object_freezer_as_string {
780	my ($rdata, $objs) = @_;	1221	my ($rdata, $objs) = @_;
781		1222
…		…
793	or return;	1234	or return;
794		1235
795	unless (aio_stat "$filename.pst") {	1236	unless (aio_stat "$filename.pst") {
796	(aio_load "$filename.pst", $av) >= 0	1237	(aio_load "$filename.pst", $av) >= 0
797	or return;	1238	or return;
		1239
798	$av = eval { (Storable::thaw $av)->{objs} };	1240	my $st = eval { Coro::Storable::thaw $av };
		1241	$av = $st->{objs};
799	}	1242	}
800		1243
		1244	utf8::decode (my $decname = $filename);
801	warn sprintf "loading %s (%d)\n",	1245	warn sprintf "loading %s (%d,%d)\n",
802	$filename, length $data, scalar @{$av || []};#d#	1246	$decname, length $data, scalar @{$av || []};
		1247
803	return ($data, $av);	1248	($data, $av)
804	}	1249	}
		1250
		1251	=head2 COMMAND CALLBACKS
		1252
		1253	=over 4
		1254
		1255	=cut
805		1256
806	#############################################################################	1257	#############################################################################
807	# command handling &c	1258	# command handling &c
808		1259
809	=item cf::register_command $name => \&callback($ob,$args);	1260	=item cf::register_command $name => \&callback($ob,$args);
…		…
822	push @{ $COMMAND{$name} }, [$caller, $cb];	1273	push @{ $COMMAND{$name} }, [$caller, $cb];
823	}	1274	}
824		1275
825	=item cf::register_extcmd $name => \&callback($pl,$packet);	1276	=item cf::register_extcmd $name => \&callback($pl,$packet);
826		1277
827	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.
828		1283
829	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
830	called.	1285	called.
831		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
832	=cut	1298	=cut
833		1299
834	sub register_extcmd {	1300	sub register_extcmd {
835	my ($name, $cb) = @_;	1301	my ($name, $cb) = @_;
836		1302
837	$EXTCMD{$name} = $cb;	1303	$EXTCMD{$name} = $cb;
838	}	1304	}
		1305
		1306	sub register_exticmd {
		1307	my ($name, $cb) = @_;
		1308
		1309	$EXTICMD{$name} = $cb;
		1310	}
		1311
		1312	use File::Glob ();
839		1313
840	cf::player->attach (	1314	cf::player->attach (
841	on_command => sub {	1315	on_command => sub {
842	my ($pl, $name, $params) = @_;	1316	my ($pl, $name, $params) = @_;
843		1317
…		…
851	cf::override;	1325	cf::override;
852	},	1326	},
853	on_extcmd => sub {	1327	on_extcmd => sub {
854	my ($pl, $buf) = @_;	1328	my ($pl, $buf) = @_;
855		1329
856	my $msg = eval { from_json $buf };	1330	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
857		1331
858	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
859	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1340	if (my $cb = $EXTCMD{$type}) {
860	if (my %reply = $cb->($pl, $msg)) {	1341	@reply = $cb->($pl, @payload);
861	$pl->ext_reply ($msg->{msgid}, %reply);
862	}
863	}	1342	}
		1343
		1344	$pl->ext_reply ($reply, @reply)
		1345	if $reply;
		1346
864	} else {	1347	} else {
865	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1348	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
866	}	1349	}
867		1350
868	cf::override;	1351	cf::override;
869	},	1352	},
870	);	1353	);
871		1354
		1355	# "readahead" all extensions
872	sub load_extension {	1356	sub cache_extensions {
873	my ($path) = @_;	1357	my $grp = IO::AIO::aio_group;
874		1358
875	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1359	add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
876	my $base = $1;	1360	for (grep /\.ext$/, @{$_[0]}) {
877	my $pkg = $1;	1361	add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
878	$pkg =~ s/[^[:word:]]/_/g;
879	$pkg = "ext::$pkg";
880
881	warn "... loading '$path' into '$pkg'\n";
882
883	open my $fh, "<:utf8", $path
884	or die "$path: $!";
885
886	my $source =
887	"package $pkg; use strict; use utf8;\n"
888	. "#line 1 \"$path\"\n{\n"
889	. (do { local $/; <$fh> })
890	. "\n};\n1";
891
892	unless (eval $source) {
893	my $msg = $@ ? "$path: $@\n"
894	: "extension disabled.\n";
895	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
896	warn $@;
897	warn "mandatory extension failed to load, exiting.\n";
898	exit 1;
899	}	1362	}
900	die $@;
901	}	1363	};
902		1364
903	push @EXTS, $pkg;	1365	$grp
904	}	1366	}
905		1367
906	sub load_extensions {	1368	sub load_extensions {
		1369	cf::sync_job {
		1370	my %todo;
		1371
907	for my $ext (<$LIBDIR/*.ext>) {	1372	for my $path (<$LIBDIR/*.ext>) {
908	next unless -r $ext;	1373	next unless -r $path;
909	eval {	1374
910	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	}
911	1	1435	}
912	} 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	}
913	}	1446	};
914	}	1447	}
915		1448
916	#############################################################################	1449	#############################################################################
917		1450
		1451	=back
		1452
918	=head2 CORE EXTENSIONS	1453	=head2 CORE EXTENSIONS
919		1454
920	Functions and methods that extend core crossfire objects.	1455	Functions and methods that extend core deliantra objects.
921		1456
922	=cut	1457	=cut
923		1458
924	package cf::player;	1459	package cf::player;
925		1460
…		…
927		1462
928	=head3 cf::player	1463	=head3 cf::player
929		1464
930	=over 4	1465	=over 4
931		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
932	=item cf::player::find $login	1481	=item cf::player::find $login
933		1482
934	Returns the given player object, loading it if necessary (might block).	1483	Returns the given player object, loading it if necessary (might block).
935		1484
936	=cut	1485	=cut
937		1486
938	sub playerdir($) {	1487	sub playerdir($) {
939	cf::localdir	1488	"$PLAYERDIR/"
940	. "/"
941	. cf::playerdir
942	. "/"
943	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1489	. (ref $_[0] ? $_[0]->ob->name : $_[0])
944	}	1490	}
945		1491
946	sub path($) {	1492	sub path($) {
947	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1493	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
948		1494
949	(playerdir $login) . "/$login.pl"	1495	(playerdir $login) . "/playerdata"
950	}	1496	}
951		1497
952	sub find_active($) {	1498	sub find_active($) {
953	$cf::PLAYER{$_[0]}	1499	$cf::PLAYER{$_[0]}
954	and $cf::PLAYER{$_[0]}->active	1500	and $cf::PLAYER{$_[0]}->active
…		…
957		1503
958	sub exists($) {	1504	sub exists($) {
959	my ($login) = @_;	1505	my ($login) = @_;
960		1506
961	$cf::PLAYER{$login}	1507	$cf::PLAYER{$login}
962	or cf::sync_job { !aio_stat path $login }	1508	or !aio_stat path $login
963	}	1509	}
964		1510
965	sub find($) {	1511	sub find($) {
966	return $cf::PLAYER{$_[0]} || do {	1512	return $cf::PLAYER{$_[0]} || do {
967	my $login = $_[0];	1513	my $login = $_[0];
968		1514
969	my $guard = cf::lock_acquire "user_find:$login";	1515	my $guard = cf::lock_acquire "user_find:$login";
970		1516
971	$cf::PLAYER{$_[0]} || do {	1517	$cf::PLAYER{$_[0]} || do {
972	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
973	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;
974	$cf::PLAYER{$login} = $pl	1533	$cf::PLAYER{$login} = $pl
975	}	1534	}
976	}	1535	}
977	}	1536	}
978		1537
…		…
987	return if $pl->{deny_save};	1546	return if $pl->{deny_save};
988		1547
989	aio_mkdir playerdir $pl, 0770;	1548	aio_mkdir playerdir $pl, 0770;
990	$pl->{last_save} = $cf::RUNTIME;	1549	$pl->{last_save} = $cf::RUNTIME;
991		1550
		1551	cf::get_slot 0.01;
		1552
992	$pl->save_pl ($path);	1553	$pl->save_pl ($path);
993	Coro::cede;	1554	cf::cede_to_tick;
994	}	1555	}
995		1556
996	sub new($) {	1557	sub new($) {
997	my ($login) = @_;	1558	my ($login) = @_;
998		1559
…		…
1004	$cf::PLAYER{$login} = $self;	1565	$cf::PLAYER{$login} = $self;
1005		1566
1006	$self	1567	$self
1007	}	1568	}
1008		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
1009	=item $pl->quit_character	1580	=item $pl->quit_character
1010		1581
1011	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
1012	be destroyed. May block for a long time.	1583	be destroyed. May block for a long time.
1013		1584
1014	=cut	1585	=cut
1015		1586
1016	sub quit_character {	1587	sub quit_character {
1017	my ($pl) = @_;	1588	my ($pl) = @_;
1018		1589
		1590	my $name = $pl->ob->name;
		1591
1019	$pl->{deny_save} = 1;	1592	$pl->{deny_save} = 1;
1020	$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
1021		1594
1022	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1595	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1023	$pl->deactivate;	1596	$pl->deactivate;
		1597	my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
		1598	$pl->ob->check_score;
1024	$pl->invoke (cf::EVENT_PLAYER_QUIT);	1599	$pl->invoke (cf::EVENT_PLAYER_QUIT);
1025	$pl->ns->destroy if $pl->ns;	1600	$pl->ns->destroy if $pl->ns;
1026		1601
1027	my $path = playerdir $pl;	1602	my $path = playerdir $pl;
1028	my $temp = "$path~$cf::RUNTIME~deleting~";	1603	my $temp = "$path~$cf::RUNTIME~deleting~";
1029	aio_rename $path, $temp;	1604	aio_rename $path, $temp;
1030	delete $cf::PLAYER{$pl->ob->name};	1605	delete $cf::PLAYER{$pl->ob->name};
1031	$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
1032	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;
1033	}	1628	}
1034		1629
1035	=item cf::player::list_logins	1630	=item cf::player::list_logins
1036		1631
1037	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
1038	while and may block, so not sync_job-capable, ever.	1633	while and may block, so not sync_job-capable, ever.
1039		1634
1040	=cut	1635	=cut
1041		1636
1042	sub list_logins {	1637	sub list_logins {
1043	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1638	my $dirs = aio_readdir $PLAYERDIR
1044	or return [];	1639	or return [];
1045		1640
1046	my @logins;	1641	my @logins;
1047		1642
1048	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") {
1049	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1649	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1050	aio_read $fh, 0, 512, my $buf, 0 or next;	1650	aio_read $fh, 0, 512, my $buf, 0 or next;
1051	$buf !~ /^password -------------$/m or next; # official not-valid tag	1651	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1652	}
1052		1653
1053	utf8::decode $login;	1654	utf8::decode $login;
1054	push @logins, $login;	1655	push @logins, $login;
1055	}	1656	}
1056		1657
…		…
1064		1665
1065	=cut	1666	=cut
1066		1667
1067	sub maps($) {	1668	sub maps($) {
1068	my ($pl) = @_;	1669	my ($pl) = @_;
		1670
		1671	$pl = ref $pl ? $pl->ob->name : $pl;
1069		1672
1070	my $files = aio_readdir playerdir $pl	1673	my $files = aio_readdir playerdir $pl
1071	or return;	1674	or return;
1072		1675
1073	my @paths;	1676	my @paths;
…		…
1075	for (@$files) {	1678	for (@$files) {
1076	utf8::decode $_;	1679	utf8::decode $_;
1077	next if /\.(?:pl|pst)$/;	1680	next if /\.(?:pl|pst)$/;
1078	next unless /^$PATH_SEP/o;	1681	next unless /^$PATH_SEP/o;
1079		1682
1080	s/\.map$//;	1683	push @paths, cf::map::normalise "~$pl/$_";
1081	push @paths, "~" . $pl->ob->name . "/" . $_;
1082	}	1684	}
1083		1685
1084	\@paths	1686	\@paths
1085	}	1687	}
1086		1688
		1689	=item $protocol_xml = $player->expand_cfpod ($cfpod)
		1690
		1691	Expand deliantra pod fragments into protocol xml.
		1692
1087	=item $player->ext_reply ($msgid, $msgtype, %msg)	1693	=item $player->ext_reply ($msgid, @msg)
1088		1694
1089	Sends an ext reply to the player.	1695	Sends an ext reply to the player.
1090		1696
1091	=cut	1697	=cut
1092		1698
1093	sub ext_reply($$$%) {	1699	sub ext_reply($$@) {
1094	my ($self, $id, %msg) = @_;	1700	my ($self, $id, @msg) = @_;
1095		1701
1096	$msg{msgid} = $id;	1702	$self->ns->ext_reply ($id, @msg)
1097
1098	$self->send ("ext " . cf::to_json \%msg);
1099	}	1703	}
1100		1704
1101	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	}
1102		1745
1103	=back	1746	=back
1104
1105		1747
1106	=head3 cf::map	1748	=head3 cf::map
1107		1749
1108	=over 4	1750	=over 4
1109		1751
…		…
1121	our $MAX_RESET = 3600;	1763	our $MAX_RESET = 3600;
1122	our $DEFAULT_RESET = 3000;	1764	our $DEFAULT_RESET = 3000;
1123		1765
1124	sub generate_random_map {	1766	sub generate_random_map {
1125	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
1126	# mit "rum" bekleckern, nicht	1771	# mit "rum" bekleckern, nicht
1127	$self->_create_random_map (	1772	$self->_create_random_map (
1128	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1773	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1129	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1774	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1130	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1775	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
…		…
1137	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1782	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1138	(cf::region::find $rmp->{region}), $rmp->{custom}	1783	(cf::region::find $rmp->{region}), $rmp->{custom}
1139	)	1784	)
1140	}	1785	}
1141		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
1142	sub register {	1795	sub register {
1143	my (undef, $regex) = @_;	1796	my (undef, $regex, $prio) = @_;
1144	my $pkg = caller;	1797	my $pkg = caller;
1145		1798
1146	no strict;	1799	no strict;
1147	push @{"$pkg\::ISA"}, __PACKAGE__;	1800	push @{"$pkg\::ISA"}, __PACKAGE__;
1148		1801
1149	$EXT_MAP{$pkg} = qr<$regex>;	1802	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
1150	}	1803	}
1151		1804
1152	# also paths starting with '/'	1805	# also paths starting with '/'
1153	$EXT_MAP{"cf::map"} = qr{^(?=/)};	1806	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1154		1807
1155	sub thawer_merge {	1808	sub thawer_merge {
1156	my ($self, $merge) = @_;	1809	my ($self, $merge) = @_;
1157		1810
1158	# we have to keep some variables in memory intact	1811	# we have to keep some variables in memory intact
1159	local $self->{path};	1812	local $self->{path};
1160	local $self->{load_path};	1813	local $self->{load_path};
1161	local $self->{deny_save};
1162	local $self->{deny_reset};
1163		1814
1164	$self->SUPER::thawer_merge ($merge);	1815	$self->SUPER::thawer_merge ($merge);
1165	}	1816	}
1166		1817
1167	sub normalise {	1818	sub normalise {
1168	my ($path, $base) = @_;	1819	my ($path, $base) = @_;
		1820
		1821	$path = "$path"; # make sure its a string
		1822
		1823	$path =~ s/\.map$//;
1169		1824
1170	# map plan:	1825	# map plan:
1171	#	1826	#
1172	# /! non-realised random map exit (special hack!)	1827	# /! non-realised random map exit (special hack!)
1173	# {... are special paths that are not being touched	1828	# {... are special paths that are not being touched
…		…
1201		1856
1202	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
1203		1858
1204	$path = normalise $path, $base;	1859	$path = normalise $path, $base;
1205		1860
1206	for my $pkg (keys %EXT_MAP) {	1861	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1207	if ($path =~ $EXT_MAP{$pkg}) {	1862	if ($path =~ $EXT_MAP{$pkg}[1]) {
1208	my $self = bless cf::map::new, $pkg;	1863	my $self = bless cf::map::new, $pkg;
1209	$self->{path} = $path; $self->path ($path);	1864	$self->{path} = $path; $self->path ($path);
1210	$self->init; # pass $1 etc.	1865	$self->init; # pass $1 etc.
1211	return $self;	1866	return $self;
1212	}	1867	}
1213	}	1868	}
1214		1869
1215	Carp::carp "unable to resolve path '$path'.";	1870	Carp::cluck "unable to resolve path '$path' (base '$base').";
1216	()	1871	()
1217	}	1872	}
1218		1873
1219	sub init {	1874	sub init {
1220	my ($self) = @_;	1875	my ($self) = @_;
…		…
1235		1890
1236	# the original (read-only) location	1891	# the original (read-only) location
1237	sub load_path {	1892	sub load_path {
1238	my ($self) = @_;	1893	my ($self) = @_;
1239		1894
1240	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1895	"$MAPDIR/$self->{path}.map"
1241	}	1896	}
1242		1897
1243	# the temporary/swap location	1898	# the temporary/swap location
1244	sub save_path {	1899	sub save_path {
1245	my ($self) = @_;	1900	my ($self) = @_;
1246		1901
1247	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1902	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1248	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	1903	"$TMPDIR/$path.map"
1249	}	1904	}
1250		1905
1251	# the unique path, undef == no special unique path	1906	# the unique path, undef == no special unique path
1252	sub uniq_path {	1907	sub uniq_path {
1253	my ($self) = @_;	1908	my ($self) = @_;
1254		1909
1255	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1910	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1256	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1911	"$UNIQUEDIR/$path"
1257	}	1912	}
1258		1913
1259	# and all this just because we cannot iterate over	1914	sub decay_objects {
1260	# all maps in C++...
1261	sub change_all_map_light {
1262	my ($change) = @_;	1915	my ($self) = @_;
1263		1916
1264	$_->change_map_light ($change)	1917	return if $self->{deny_reset};
1265	for grep $_->outdoor, values %cf::MAP;	1918
		1919	$self->do_decay_objects;
1266	}	1920	}
1267		1921
1268	sub unlink_save {	1922	sub unlink_save {
1269	my ($self) = @_;	1923	my ($self) = @_;
1270		1924
…		…
1275		1929
1276	sub load_header_from($) {	1930	sub load_header_from($) {
1277	my ($self, $path) = @_;	1931	my ($self, $path) = @_;
1278		1932
1279	utf8::encode $path;	1933	utf8::encode $path;
1280	aio_open $path, O_RDONLY, 0	1934	my $f = new_from_file cf::object::thawer $path
1281	or return;	1935	or return;
1282		1936
1283	$self->_load_header ($path)	1937	$self->_load_header ($f)
1284	or return;	1938	or return;
1285		1939
		1940	local $MAP_LOADING{$self->{path}} = $self;
		1941	$f->resolve_delayed_derefs;
		1942
1286	$self->{load_path} = $path;	1943	$self->{load_path} = $path;
1287		1944
1288	1	1945	1
1289	}	1946	}
1290		1947
1291	sub load_orig {	1948	sub load_header_orig {
1292	my ($self) = @_;	1949	my ($self) = @_;
1293		1950
1294	$self->load_header_from ($self->load_path)	1951	$self->load_header_from ($self->load_path)
1295	}	1952	}
1296		1953
1297	sub load_temp {	1954	sub load_header_temp {
1298	my ($self) = @_;	1955	my ($self) = @_;
1299		1956
1300	$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;
1301	}	1977	}
1302		1978
1303	sub load_header {	1979	sub load_header {
1304	my ($self) = @_;	1980	my ($self) = @_;
1305		1981
1306	if ($self->load_temp) {	1982	if ($self->load_header_temp) {
1307	$self->last_access ((delete $self->{last_access})	1983	$self->prepare_temp;
1308	|| $cf::RUNTIME); #d#
1309	# safety
1310	$self->{instantiate_time} = $cf::RUNTIME
1311	if $self->{instantiate_time} > $cf::RUNTIME;
1312	} else {	1984	} else {
1313	$self->load_orig	1985	$self->load_header_orig
1314	or return;	1986	or return;
1315		1987	$self->prepare_orig;
1316	$self->{load_original} = 1;
1317	$self->{instantiate_time} = $cf::RUNTIME;
1318	$self->last_access ($cf::RUNTIME);
1319	$self->instantiate;
1320	}	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;
1321		1995
1322	1	1996	1
1323	}	1997	}
1324		1998
1325	sub find;	1999	sub find;
1326	sub find {	2000	sub find {
1327	my ($path, $origin) = @_;	2001	my ($path, $origin) = @_;
1328		2002
1329	$path = normalise $path, $origin && $origin->path;	2003	$path = normalise $path, $origin && $origin->path;
1330		2004
		2005	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1331	cf::lock_wait "map_find:$path";	2006	my $guard2 = cf::lock_acquire "map_find:$path";
1332		2007
1333	$cf::MAP{$path} || do {	2008	$cf::MAP{$path} || do {
1334	my $guard = cf::lock_acquire "map_find:$path";
1335	my $map = new_from_path cf::map $path	2009	my $map = new_from_path cf::map $path
1336	or return;	2010	or return;
1337		2011
1338	$map->{last_save} = $cf::RUNTIME;	2012	$map->{last_save} = $cf::RUNTIME;
1339		2013
1340	$map->load_header	2014	$map->load_header
1341	or return;	2015	or return;
1342		2016
1343	if ($map->should_reset) {	2017	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		2018	# doing this can freeze the server in a sync job, obviously
1344	$cf::WAIT_FOR_TICK->wait;	2019	#$cf::WAIT_FOR_TICK->wait;
		2020	undef $guard2;
		2021	undef $guard1;
1345	$map->reset;	2022	$map->reset;
1346	undef $guard;
1347	$map = find $path	2023	return find $path;
1348	or return;
1349	}	2024	}
1350		2025
1351	$cf::MAP{$path} = $map	2026	$cf::MAP{$path} = $map
1352	}	2027	}
1353	}	2028	}
		2029
		2030	sub pre_load { }
		2031	#sub post_load { } # XS
1354		2032
1355	sub load {	2033	sub load {
1356	my ($self) = @_;	2034	my ($self) = @_;
1357		2035
		2036	local $self->{deny_reset} = 1; # loading can take a long time
		2037
1358	my $path = $self->{path};	2038	my $path = $self->{path};
		2039
		2040	{
1359	my $guard = cf::lock_acquire "map_load:$path";	2041	my $guard = cf::lock_acquire "map_data:$path";
1360		2042
		2043	return unless $self->valid;
1361	return if $self->in_memory != cf::MAP_SWAPPED;	2044	return unless $self->in_memory == cf::MAP_SWAPPED;
1362		2045
1363	$self->in_memory (cf::MAP_LOADING);	2046	$self->in_memory (cf::MAP_LOADING);
1364		2047
1365	$self->alloc;	2048	$self->alloc;
1366	$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)
1367	or return;	2056	or return;
1368		2057
1369	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2058	$self->post_load_original
1370	if delete $self->{load_original};	2059	if delete $self->{load_original};
1371		2060
1372	if (my $uniq = $self->uniq_path) {	2061	if (my $uniq = $self->uniq_path) {
1373	utf8::encode $uniq;	2062	utf8::encode $uniq;
1374	if (aio_open $uniq, O_RDONLY, 0) {	2063	unless (aio_stat $uniq) {
		2064	if (my $f = new_from_file cf::object::thawer $uniq) {
1375	$self->clear_unique_items;	2065	$self->clear_unique_items;
1376	$self->_load_objects ($uniq, 0);	2066	$self->_load_objects ($f);
		2067	$f->resolve_delayed_derefs;
		2068	}
1377	}	2069	}
1378	}	2070	}
1379		2071
1380	Coro::cede;	2072	$f->resolve_delayed_derefs;
1381		2073
		2074	cf::cede_to_tick;
1382	# now do the right thing for maps	2075	# now do the right thing for maps
1383	$self->link_multipart_objects;	2076	$self->link_multipart_objects;
1384
1385	unless ($self->{deny_activate}) {
1386	$self->decay_objects;
1387	$self->fix_auto_apply;
1388	$self->update_buttons;
1389	Coro::cede;
1390	$self->set_darkness_map;
1391	$self->difficulty ($self->estimate_difficulty)	2077	$self->difficulty ($self->estimate_difficulty)
1392	unless $self->difficulty;	2078	unless $self->difficulty;
1393	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;
1394	$self->activate;	2086	$self->activate;
1395	}	2087	}
1396		2088
		2089	$self->{last_save} = $cf::RUNTIME;
		2090	$self->last_access ($cf::RUNTIME);
		2091
1397	$self->in_memory (cf::MAP_IN_MEMORY);	2092	$self->in_memory (cf::MAP_ACTIVE);
		2093	}
		2094
		2095	$self->post_load;
1398	}	2096	}
1399		2097
1400	sub customise_for {	2098	sub customise_for {
1401	my ($self, $ob) = @_;	2099	my ($self, $ob) = @_;
1402		2100
1403	return find "~" . $ob->name . "/" . $self->{path}	2101	return find "~" . $ob->name . "/" . $self->{path}
1404	if $self->per_player;	2102	if $self->per_player;
1405		2103
		2104	# return find "?party/" . $ob->name . "/" . $self->{path}
		2105	# if $self->per_party;
		2106
1406	$self	2107	$self
1407	}	2108	}
1408		2109
1409	# 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
1410	sub load_diag {	2111	sub load_neighbours {
1411	my ($map) = @_;	2112	my ($map) = @_;
1412		2113
1413	my @diag; # diagonal neighbours	2114	my @neigh; # diagonal neighbours
1414		2115
1415	for (0 .. 3) {	2116	for (0 .. 3) {
1416	my $neigh = $map->tile_path ($_)	2117	my $neigh = $map->tile_path ($_)
1417	or next;	2118	or next;
1418	$neigh = find $neigh, $map	2119	$neigh = find $neigh, $map
1419	or next;	2120	or next;
1420	$neigh->load;	2121	$neigh->load;
1421		2122
		2123	push @neigh,
1422	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2124	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1423	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2125	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1424	}	2126	}
1425		2127
1426	for (@diag) {	2128	for (grep defined $_->[0], @neigh) {
		2129	my ($path, $origin) = @$_;
1427	my $neigh = find @$_	2130	my $neigh = find $path, $origin
1428	or next;	2131	or next;
1429	$neigh->load;	2132	$neigh->load;
1430	}	2133	}
1431	}	2134	}
1432		2135
…		…
1437	}	2140	}
1438		2141
1439	sub do_load_sync {	2142	sub do_load_sync {
1440	my ($map) = @_;	2143	my ($map) = @_;
1441		2144
		2145	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2146	if $Coro::current == $Coro::main;
		2147
1442	cf::sync_job { $map->load };	2148	cf::sync_job { $map->load };
1443	}	2149	}
1444		2150
1445	our %MAP_PREFETCH;	2151	our %MAP_PREFETCH;
1446	our $MAP_PREFETCHER = Coro::async {	2152	our $MAP_PREFETCHER = undef;
1447	while () {
1448	for my $path (keys %MAP_PREFETCH) {
1449	my $map = find $path
1450	or next;
1451	$map->load;
1452
1453	delete $MAP_PREFETCH{$path};
1454	}
1455	Coro::schedule;
1456	}
1457	};
1458		2153
1459	sub find_async {	2154	sub find_async {
1460	my ($path, $origin) = @_;	2155	my ($path, $origin, $load) = @_;
1461		2156
1462	$path = normalise $path, $origin && $origin->{path};	2157	$path = normalise $path, $origin && $origin->{path};
1463		2158
1464	if (my $map = $cf::MAP{$path}) {	2159	if (my $map = $cf::MAP{$path}) {
1465	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2160	return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
		2161	}
		2162
		2163	$MAP_PREFETCH{$path} |= $load;
		2164
		2165	$MAP_PREFETCHER ||= cf::async {
		2166	$Coro::current->{desc} = "map prefetcher";
		2167
		2168	while (%MAP_PREFETCH) {
		2169	while (my ($k, $v) = each %MAP_PREFETCH) {
		2170	if (my $map = find $k) {
		2171	$map->load if $v;
		2172	}
		2173
		2174	delete $MAP_PREFETCH{$k};
		2175	}
		2176	}
		2177	undef $MAP_PREFETCHER;
1466	}	2178	};
1467
1468	$MAP_PREFETCH{$path} = 0;
1469	$MAP_PREFETCHER->ready;	2179	$MAP_PREFETCHER->prio (6);
1470		2180
1471	()	2181	()
1472	}	2182	}
1473		2183
1474	sub save {	2184	sub save {
1475	my ($self) = @_;	2185	my ($self) = @_;
1476		2186
1477	my $lock = cf::lock_acquire "map_data:" . $self->path;	2187	my $lock = cf::lock_acquire "map_data:$self->{path}";
1478		2188
1479	$self->{last_save} = $cf::RUNTIME;	2189	$self->{last_save} = $cf::RUNTIME;
1480		2190
1481	return unless $self->dirty;	2191	return unless $self->dirty;
1482		2192
…		…
1488	return if $self->{deny_save};	2198	return if $self->{deny_save};
1489		2199
1490	local $self->{last_access} = $self->last_access;#d#	2200	local $self->{last_access} = $self->last_access;#d#
1491		2201
1492	cf::async {	2202	cf::async {
		2203	$Coro::current->{desc} = "map player save";
1493	$_->contr->save for $self->players;	2204	$_->contr->save for $self->players;
1494	};	2205	};
		2206
		2207	cf::get_slot 0.02;
1495		2208
1496	if ($uniq) {	2209	if ($uniq) {
1497	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2210	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1498	$self->_save_objects ($uniq, cf::IO_UNIQUES);	2211	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1499	} else {	2212	} else {
…		…
1505	my ($self) = @_;	2218	my ($self) = @_;
1506		2219
1507	# save first because save cedes	2220	# save first because save cedes
1508	$self->save;	2221	$self->save;
1509		2222
1510	my $lock = cf::lock_acquire "map_data:" . $self->path;	2223	my $lock = cf::lock_acquire "map_data:$self->{path}";
1511		2224
1512	return if $self->players;	2225	return if $self->players;
1513	return if $self->in_memory != cf::MAP_IN_MEMORY;	2226	return if $self->in_memory != cf::MAP_ACTIVE;
1514	return if $self->{deny_save};	2227	return if $self->{deny_save};
1515		2228
		2229	$self->in_memory (cf::MAP_SWAPPED);
		2230
		2231	$self->deactivate;
		2232	$_->clear_links_to ($self) for values %cf::MAP;
1516	$self->clear;	2233	$self->clear;
1517	$self->in_memory (cf::MAP_SWAPPED);
1518	}	2234	}
1519		2235
1520	sub reset_at {	2236	sub reset_at {
1521	my ($self) = @_;	2237	my ($self) = @_;
1522		2238
1523	# TODO: safety, remove and allow resettable per-player maps	2239	# TODO: safety, remove and allow resettable per-player maps
1524	return 1e99 if $self->isa ("ext::map_per_player");#d#
1525	return 1e99 if $self->{deny_reset};	2240	return 1e99 if $self->{deny_reset};
1526		2241
1527	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2242	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1528	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;
1529		2244
…		…
1540	my ($self) = @_;	2255	my ($self) = @_;
1541		2256
1542	my $lock = cf::lock_acquire "map_data:$self->{path}";	2257	my $lock = cf::lock_acquire "map_data:$self->{path}";
1543		2258
1544	return if $self->players;	2259	return if $self->players;
1545	return if $self->isa ("ext::map_per_player");#d#
1546		2260
1547	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	}
1548		2272
1549	delete $cf::MAP{$self->path};	2273	delete $cf::MAP{$self->path};
1550		2274
1551	$self->in_memory (cf::MAP_SWAPPED);	2275	$self->deactivate;
		2276	$_->clear_links_to ($self) for values %cf::MAP;
1552	$self->clear;	2277	$self->clear;
1553
1554	$_->clear_links_to ($self) for values %cf::MAP;
1555		2278
1556	$self->unlink_save;	2279	$self->unlink_save;
1557	$self->destroy;	2280	$self->destroy;
1558	}	2281	}
1559		2282
1560	my $nuke_counter = "aaaa";	2283	my $nuke_counter = "aaaa";
1561		2284
1562	sub nuke {	2285	sub nuke {
1563	my ($self) = @_;	2286	my ($self) = @_;
1564		2287
		2288	{
		2289	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2290
1565	delete $cf::MAP{$self->path};	2291	delete $cf::MAP{$self->path};
1566		2292
1567	$self->unlink_save;	2293	$self->unlink_save;
1568		2294
1569	bless $self, "cf::map";	2295	bless $self, "cf::map";
1570	delete $self->{deny_reset};	2296	delete $self->{deny_reset};
1571	$self->{deny_save} = 1;	2297	$self->{deny_save} = 1;
1572	$self->reset_timeout (1);	2298	$self->reset_timeout (1);
1573	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2299	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1574		2300
1575	$cf::MAP{$self->path} = $self;	2301	$cf::MAP{$self->path} = $self;
		2302	}
1576		2303
1577	$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	]
1578	}	2341	}
1579		2342
1580	=item cf::map::unique_maps	2343	=item cf::map::unique_maps
1581		2344
1582	Returns an arrayref of paths of all shared maps that have	2345	Returns an arrayref of paths of all shared maps that have
1583	instantiated unique items. May block.	2346	instantiated unique items. May block.
1584		2347
1585	=cut	2348	=cut
1586		2349
1587	sub unique_maps() {	2350	sub unique_maps() {
1588	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2351	[
1589	or return;	2352	map {
1590
1591	my @paths;
1592
1593	for (@$files) {
1594	utf8::decode $_;	2353	utf8::decode $_;
1595	next if /\.pst$/;	2354	s/\.map$//; # TODO future compatibility hack
1596	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	}
1597		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) {
1598	s/\.map$//;	2383	s/\.map$// or next;
1599	push @paths, $_;	2384	utf8::decode $_;
1600	}	2385	push @maps, "$dir/$_";
		2386	}
1601		2387
1602	\@paths	2388	push @dirs, map "$dir/$_", @$dirs;
1603	}	2389	}
1604		2390
1605	package cf;	2391	\@maps
		2392	}
1606		2393
1607	=back	2394	=back
1608		2395
1609	=head3 cf::object	2396	=head3 cf::object
1610		2397
…		…
1614		2401
1615	=over 4	2402	=over 4
1616		2403
1617	=item $ob->inv_recursive	2404	=item $ob->inv_recursive
1618		2405
1619	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.
1620		2408
1621	=cut	2409	=cut
1622		2410
1623	sub inv_recursive_;	2411	sub inv_recursive_;
1624	sub inv_recursive_ {	2412	sub inv_recursive_ {
…		…
1627		2415
1628	sub inv_recursive {	2416	sub inv_recursive {
1629	inv_recursive_ inv $_[0]	2417	inv_recursive_ inv $_[0]
1630	}	2418	}
1631		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
1632	package cf;	2448	package cf;
1633		2449
1634	=back	2450	=back
1635		2451
1636	=head3 cf::object::player	2452	=head3 cf::object::player
…		…
1642	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>
1643	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
1644	dialogue with the given NPC character.	2460	dialogue with the given NPC character.
1645		2461
1646	=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	};
1647		2477
1648	# rough implementation of a future "reply" method that works	2478	# rough implementation of a future "reply" method that works
1649	# with dialog boxes.	2479	# with dialog boxes.
1650	#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
1651	sub cf::object::player::reply($$$;$) {	2481	sub cf::object::player::reply($$$;$) {
…		…
1653		2483
1654	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2484	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1655		2485
1656	if ($self->{record_replies}) {	2486	if ($self->{record_replies}) {
1657	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2487	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2488
1658	} 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 {
1659	$msg = $npc->name . " says: $msg" if $npc;	2497	$msg = $npc->name . " says: $msg" if $npc;
1660	$self->message ($msg, $flags);	2498	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2499	}
1661	}	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 (@_);
1662	}	2511	}
1663		2512
1664	=item $player_object->may ("access")	2513	=item $player_object->may ("access")
1665		2514
1666	Returns wether the given player is authorized to access resource "access"	2515	Returns wether the given player is authorized to access resource "access"
…		…
1679		2528
1680	=item $player_object->enter_link	2529	=item $player_object->enter_link
1681		2530
1682	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}>).
1683		2532
1684	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.
1685	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.
1686		2537
1687	Will never block.	2538	Will never block.
1688		2539
1689	=item $player_object->leave_link ($map, $x, $y)	2540	=item $player_object->leave_link ($map, $x, $y)
1690		2541
…		…
1698	=cut	2549	=cut
1699		2550
1700	sub link_map {	2551	sub link_map {
1701	unless ($LINK_MAP) {	2552	unless ($LINK_MAP) {
1702	$LINK_MAP = cf::map::find "{link}"	2553	$LINK_MAP = cf::map::find "{link}"
1703	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };	2554	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1704	$LINK_MAP->load;	2555	$LINK_MAP->load;
1705	}	2556	}
1706		2557
1707	$LINK_MAP	2558	$LINK_MAP
1708	}	2559	}
…		…
1713	$self->deactivate_recursive;	2564	$self->deactivate_recursive;
1714		2565
1715	return if UNIVERSAL::isa $self->map, "ext::map_link";	2566	return if UNIVERSAL::isa $self->map, "ext::map_link";
1716		2567
1717	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2568	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1718	if $self->map;	2569	if $self->map && $self->map->{path} ne "{link}";
1719		2570
1720	$self->enter_map ($LINK_MAP || link_map, 20, 20);	2571	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1721	}	2572	}
1722		2573
1723	sub cf::object::player::leave_link {	2574	sub cf::object::player::leave_link {
1724	my ($self, $map, $x, $y) = @_;	2575	my ($self, $map, $x, $y) = @_;
		2576
		2577	return unless $self->contr->active;
1725		2578
1726	my $link_pos = delete $self->{_link_pos};	2579	my $link_pos = delete $self->{_link_pos};
1727		2580
1728	unless ($map) {	2581	unless ($map) {
1729	# restore original map position	2582	# restore original map position
…		…
1740	($x, $y) = (-1, -1)	2593	($x, $y) = (-1, -1)
1741	unless (defined $x) && (defined $y);	2594	unless (defined $x) && (defined $y);
1742		2595
1743	# use -1 or undef as default coordinates, not 0, 0	2596	# use -1 or undef as default coordinates, not 0, 0
1744	($x, $y) = ($map->enter_x, $map->enter_y)	2597	($x, $y) = ($map->enter_x, $map->enter_y)
1745	if $x <=0 && $y <= 0;	2598	if $x <= 0 && $y <= 0;
1746		2599
1747	$map->load;	2600	$map->load;
1748	$map->load_diag;	2601	$map->load_neighbours;
1749		2602
1750	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
1751	$self->activate_recursive;	2609	$self->activate_recursive;
1752	$self->enter_map ($map, $x, $y);
1753	}	2610	}
1754		2611
1755	cf::player->attach (	2612	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1756	on_logout => sub {
1757	my ($pl) = @_;
1758		2613
1759	# abort map switching before logout	2614	Moves the player to the given map-path and coordinates by first freezing
1760	if ($pl->ob->{_link_pos}) {	2615	her, loading and preparing them map, calling the provided $check callback
1761	cf::sync_job {	2616	that has to return the map if sucecssful, and then unfreezes the player on
1762	$pl->ob->leave_link	2617	the new (success) or old (failed) map position. In either case, $done will
1763	};	2618	be called at the end of this process.
1764	}
1765	},
1766	on_login => sub {
1767	my ($pl) = @_;
1768		2619
1769	# try to abort aborted map switching on player login :)	2620	Note that $check will be called with a potentially non-loaded map, so if
1770	# should happen only on crashes	2621	it needs a loaded map it has to call C<< ->load >>.
1771	if ($pl->ob->{_link_pos}) {
1772	$pl->ob->enter_link;
1773	(async {
1774	# we need this sleep as the login has a concurrent enter_exit running
1775	# and this sleep increases chances of the player not ending up in scorn
1776	$pl->ob->reply (undef,
1777	"There was an internal problem at your last logout, "
1778	. "the server will try to bring you to your intended destination in a second.",
1779	cf::NDI_RED);
1780	Coro::Timer::sleep 1;
1781	$pl->ob->leave_link;
1782	})->prio (2);
1783	}
1784	},
1785	);
1786		2622
1787	=item $player_object->goto ($path, $x, $y)
1788
1789	=cut	2623	=cut
		2624
		2625	our $GOTOGEN;
1790		2626
1791	sub cf::object::player::goto {	2627	sub cf::object::player::goto {
1792	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;
1793		2632
1794	$self->enter_link;	2633	$self->enter_link;
1795		2634
1796	(async {	2635	(async {
1797	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) {
1798	$map = $map->customise_for ($self) if $map;	2661	$map = $map->customise_for ($self);
1799		2662	$map = $check->($map) if $check && $map;
1800	# warn "entering ", $map->path, " at ($x, $y)\n"	2663	} else {
1801	# if $map;
1802
1803	$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	}
1804		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};
1805	$self->leave_link ($map, $x, $y);	2677	$self->leave_link ($map, $x, $y);
		2678	}
		2679
		2680	$done->() if $done;
1806	})->prio (1);	2681	})->prio (1);
1807	}	2682	}
1808		2683
1809	=item $player_object->enter_exit ($exit_object)	2684	=item $player_object->enter_exit ($exit_object)
1810		2685
…		…
1830	}	2705	}
1831		2706
1832	sub prepare_random_map {	2707	sub prepare_random_map {
1833	my ($exit) = @_;	2708	my ($exit) = @_;
1834		2709
1835	my $guard = cf::lock_acquire "exit_prepare:$exit";
1836
1837	# all this does is basically replace the /! path by	2710	# all this does is basically replace the /! path by
1838	# a new random map path (?random/...) with a seed	2711	# a new random map path (?random/...) with a seed
1839	# that depends on the exit object	2712	# that depends on the exit object
1840		2713
1841	my $rmp = parse_random_map_params $exit->msg;	2714	my $rmp = parse_random_map_params $exit->msg;
1842		2715
1843	if ($exit->map) {	2716	if ($exit->map) {
1844	$rmp->{region} = $exit->map->region_name;	2717	$rmp->{region} = $exit->region->name;
1845	$rmp->{origin_map} = $exit->map->path;	2718	$rmp->{origin_map} = $exit->map->path;
1846	$rmp->{origin_x} = $exit->x;	2719	$rmp->{origin_x} = $exit->x;
1847	$rmp->{origin_y} = $exit->y;	2720	$rmp->{origin_y} = $exit->y;
		2721
		2722	$exit->map->touch;
1848	}	2723	}
1849		2724
1850	$rmp->{random_seed} ||= $exit->random_seed;	2725	$rmp->{random_seed} ||= $exit->random_seed;
1851		2726
1852	my $data = cf::to_json $rmp;	2727	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1853	my $md5 = Digest::MD5::md5_hex $data;	2728	my $md5 = Digest::MD5::md5_hex $data;
1854	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2729	my $meta = "$RANDOMDIR/$md5.meta";
1855		2730
1856	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2731	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1857	aio_write $fh, 0, (length $data), $data, 0;	2732	aio_write $fh, 0, (length $data), $data, 0;
1858	undef $fh;	2733	undef $fh;
1859	aio_rename "$meta~", $meta;	2734	aio_rename "$meta~", $meta;
1860		2735
		2736	my $slaying = "?random/$md5";
		2737
		2738	if ($exit->valid) {
1861	$exit->slaying ("?random/$md5");	2739	$exit->slaying ("?random/$md5");
1862	$exit->msg (undef);	2740	$exit->msg (undef);
		2741	}
1863	}	2742	}
1864	}	2743	}
1865		2744
1866	sub cf::object::player::enter_exit {	2745	sub cf::object::player::enter_exit {
1867	my ($self, $exit) = @_;	2746	my ($self, $exit) = @_;
…		…
1869	return unless $self->type == cf::PLAYER;	2748	return unless $self->type == cf::PLAYER;
1870		2749
1871	$self->enter_link;	2750	$self->enter_link;
1872		2751
1873	(async {	2752	(async {
1874	$self->deactivate_recursive; # just to be sure	2753	$Coro::current->{desc} = "enter_exit";
		2754
1875	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
1876	prepare_random_map $exit	2762	prepare_random_map $exit
1877	if $exit->slaying eq "/!";	2763	if $exit->slaying eq "/!";
		2764	}
1878		2765
1879	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;
1880	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);	2767	my $x = $exit->stats->hp;
		2768	my $y = $exit->stats->sp;
1881		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
1882	1;	2776	1
1883	}) {	2777	}) {
1884	$self->message ("Something went wrong deep within the crossfire server. "	2778	$self->message ("Something went wrong deep within the deliantra server. "
1885	. "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. "
1886	. "Please report this to the dungeon master!",	2780	. "Please report this to the dungeon master!",
1887	cf::NDI_UNIQUE | cf::NDI_RED);	2781	cf::NDI_UNIQUE | cf::NDI_RED);
1888		2782
1889	warn "ERROR in enter_exit: $@";	2783	warn "ERROR in enter_exit: $@";
1890	$self->leave_link;	2784	$self->leave_link;
1891	}	2785	}
1892	})->prio (1);	2786	})->prio (1);
…		…
1905		2799
1906	sub cf::client::send_drawinfo {	2800	sub cf::client::send_drawinfo {
1907	my ($self, $text, $flags) = @_;	2801	my ($self, $text, $flags) = @_;
1908		2802
1909	utf8::encode $text;	2803	utf8::encode $text;
1910	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2804	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1911	}	2805	}
1912		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	}
1913		3028
1914	=item $success = $client->query ($flags, "text", \&cb)	3029	=item $success = $client->query ($flags, "text", \&cb)
1915		3030
1916	Queues a query to the client, calling the given callback with	3031	Queues a query to the client, calling the given callback with
1917	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>,
1918	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>.
1919		3034
1920	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
1921	reliable at some point in the future.	3036	become reliable at some point in the future.
1922		3037
1923	=cut	3038	=cut
1924		3039
1925	sub cf::client::query {	3040	sub cf::client::query {
1926	my ($self, $flags, $text, $cb) = @_;	3041	my ($self, $flags, $text, $cb) = @_;
…		…
1934	utf8::encode $text;	3049	utf8::encode $text;
1935	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	3050	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1936		3051
1937	$self->send_packet ($self->{query_queue}[0][0])	3052	$self->send_packet ($self->{query_queue}[0][0])
1938	if @{ $self->{query_queue} } == 1;	3053	if @{ $self->{query_queue} } == 1;
		3054
		3055	1
1939	}	3056	}
1940		3057
1941	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	},
1942	on_reply => sub {	3064	on_reply => sub {
1943	my ($ns, $msg) = @_;	3065	my ($ns, $msg) = @_;
1944		3066
1945	# this weird shuffling is so that direct followup queries	3067	# this weird shuffling is so that direct followup queries
1946	# get handled first	3068	# get handled first
1947	my $queue = delete $ns->{query_queue}	3069	my $queue = delete $ns->{query_queue}
1948	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
1949		3071
1950	(shift @$queue)->[1]->($msg);	3072	(shift @$queue)->[1]->($msg);
		3073	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1951		3074
1952	push @{ $ns->{query_queue} }, @$queue;	3075	push @{ $ns->{query_queue} }, @$queue;
1953		3076
1954	if (@{ $ns->{query_queue} } == @$queue) {	3077	if (@{ $ns->{query_queue} } == @$queue) {
1955	if (@$queue) {	3078	if (@$queue) {
…		…
1957	} else {	3080	} else {
1958	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3081	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1959	}	3082	}
1960	}	3083	}
1961	},	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	},
1962	);	3111	);
1963		3112
1964	=item $client->async (\&cb)	3113	=item $client->async (\&cb)
1965		3114
1966	Create a new coroutine, running the specified callback. The coroutine will	3115	Create a new coroutine, running the specified callback. The coroutine will
…		…
2007	our $safe = new Safe "safe";	3156	our $safe = new Safe "safe";
2008	our $safe_hole = new Safe::Hole;	3157	our $safe_hole = new Safe::Hole;
2009		3158
2010	$SIG{FPE} = 'IGNORE';	3159	$SIG{FPE} = 'IGNORE';
2011		3160
2012	$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	));
2013		3166
2014	# here we export the classes and methods available to script code	3167	# here we export the classes and methods available to script code
2015		3168
2016	=pod	3169	=pod
2017		3170
2018	The following fucntions and emthods are available within a safe environment:	3171	The following functions and methods are available within a safe environment:
2019		3172
2020	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
2021	cf::object::player player	3178	cf::object::player
2022	cf::player peaceful	3179	player
2023	cf::map trigger	3180
		3181	cf::player
		3182	peaceful
		3183
		3184	cf::map
		3185	trigger
2024		3186
2025	=cut	3187	=cut
2026		3188
2027	for (	3189	for (
2028	["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)],
2029	["cf::object::player" => qw(player)],	3193	["cf::object::player" => qw(player)],
2030	["cf::player" => qw(peaceful)],	3194	["cf::player" => qw(peaceful send_msg)],
2031	["cf::map" => qw(trigger)],	3195	["cf::map" => qw(trigger)],
2032	) {	3196	) {
2033	no strict 'refs';	3197	no strict 'refs';
2034	my ($pkg, @funs) = @$_;	3198	my ($pkg, @funs) = @$_;
2035	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3199	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
…		…
2053		3217
2054	my $qcode = $code;	3218	my $qcode = $code;
2055	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3219	$qcode =~ s/"/‟/g; # not allowed in #line filenames
2056	$qcode =~ s/\n/\\n/g;	3220	$qcode =~ s/\n/\\n/g;
2057		3221
		3222	%vars = (_dummy => 0) unless %vars;
		3223
		3224	my @res;
2058	local $_;	3225	local $_;
2059	local @safe::cf::_safe_eval_args = values %vars;
2060		3226
2061	my $eval =	3227	my $eval =
2062	"do {\n"	3228	"do {\n"
2063	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	3229	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
2064	. "#line 0 \"{$qcode}\"\n"	3230	. "#line 0 \"{$qcode}\"\n"
2065	. $code	3231	. $code
2066	. "\n}"	3232	. "\n}"
2067	;	3233	;
2068		3234
		3235	if ($CFG{safe_eval}) {
2069	sub_generation_inc;	3236	sub_generation_inc;
		3237	local @safe::cf::_safe_eval_args = values %vars;
2070	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);	3238	@res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
2071	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	}
2072		3244
2073	if ($@) {	3245	if ($@) {
2074	warn "$@";	3246	warn "$@";
2075	warn "while executing safe code '$code'\n";	3247	warn "while executing safe code '$code'\n";
2076	warn "with arguments " . (join " ", %vars) . "\n";	3248	warn "with arguments " . (join " ", %vars) . "\n";
…		…
2095	=cut	3267	=cut
2096		3268
2097	sub register_script_function {	3269	sub register_script_function {
2098	my ($fun, $cb) = @_;	3270	my ($fun, $cb) = @_;
2099		3271
2100	no strict 'refs';	3272	$fun = "safe::$fun" if $CFG{safe_eval};
2101	*{"safe::$fun"} = $safe_hole->wrap ($cb);	3273	*$fun = $safe_hole->wrap ($cb);
2102	}	3274	}
2103		3275
2104	=back	3276	=back
2105		3277
2106	=cut	3278	=cut
2107		3279
2108	#############################################################################	3280	#############################################################################
		3281	# the server's init and main functions
2109		3282
2110	=head2 EXTENSION DATABASE SUPPORT	3283	sub load_facedata($) {
		3284	my ($path) = @_;
2111		3285
2112	Crossfire maintains a very simple database for extension use. It can	3286	# HACK to clear player env face cache, we need some signal framework
2113	currently store anything that can be serialised using Storable, which	3287	# for this (global event?)
2114	excludes objects.	3288	%ext::player_env::MUSIC_FACE_CACHE = ();
2115		3289
2116	The parameter C<$family> should best start with the name of the extension	3290	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2117	using it, it should be unique.
2118		3291
2119	=over 4	3292	warn "loading facedata from $path\n";
2120		3293
2121	=item $hashref = cf::db_get $family	3294	my $facedata;
		3295	0 < aio_load $path, $facedata
		3296	or die "$path: $!";
2122		3297
2123	Return a hashref for use by the extension C<$family>, which can be	3298	$facedata = Coro::Storable::thaw $facedata;
2124	modified. After modifications, you have to call C<cf::db_dirty> or
2125	C<cf::db_sync>.
2126		3299
2127	=item $value = cf::db_get $family => $key	3300	$facedata->{version} == 2
		3301	or cf::cleanup "$path: version mismatch, cannot proceed.";
2128		3302
2129	Returns a single value from the database	3303	# patch in the exptable
2130		3304	my $exp_table = $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]);
2131	=item cf::db_put $family => $hashref	3305	$facedata->{resource}{"res/exp_table"} = {
2132		3306	type => FT_RSRC,
2133	Stores the given family hashref into the database. Updates are delayed, if	3307	data => $exp_table,
2134	you want the data to be synced to disk immediately, use C<cf::db_sync>.	3308	hash => (Digest::MD5::md5 $exp_table),
2135
2136	=item cf::db_put $family => $key => $value
2137
2138	Stores the given C<$value> in the family hash. Updates are delayed, if you
2139	want the data to be synced to disk immediately, use C<cf::db_sync>.
2140
2141	=item cf::db_dirty
2142
2143	Marks the database as dirty, to be updated at a later time.
2144
2145	=item cf::db_sync
2146
2147	Immediately write the database to disk I<if it is dirty>.
2148
2149	=cut
2150
2151	our $DB;
2152
2153	{
2154	my $path = cf::localdir . "/database.pst";
2155
2156	sub db_load() {
2157	$DB = stat $path ? Storable::retrieve $path : { };
2158	}
2159
2160	my $pid;
2161
2162	sub db_save() {
2163	waitpid $pid, 0 if $pid;
2164	if (0 == ($pid = fork)) {
2165	$DB->{_meta}{version} = 1;
2166	Storable::nstore $DB, "$path~";
2167	rename "$path~", $path;
2168	cf::_exit 0 if defined $pid;
2169	}
2170	}
2171
2172	my $dirty;
2173
2174	sub db_sync() {
2175	db_save if $dirty;
2176	undef $dirty;
2177	}
2178
2179	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2180	db_sync;
2181	});	3309	};
		3310	cf::cede_to_tick;
2182		3311
2183	sub db_dirty() {
2184	$dirty = 1;
2185	$idle->start;
2186	}	3312	{
		3313	my $faces = $facedata->{faceinfo};
2187		3314
2188	sub db_get($;$) {	3315	while (my ($face, $info) = each %$faces) {
2189	@_ >= 2	3316	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2190	? $DB->{$_[0]}{$_[1]}
2191	: ($DB->{$_[0]} ||= { })
2192	}
2193		3317
2194	sub db_put($$;$) {	3318	cf::face::set_visibility $idx, $info->{visibility};
2195	if (@_ >= 3) {	3319	cf::face::set_magicmap $idx, $info->{magicmap};
2196	$DB->{$_[0]}{$_[1]} = $_[2];	3320	cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
2197	} else {	3321	cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
2198	$DB->{$_[0]} = $_[1];
2199	}
2200	db_dirty;
2201	}
2202		3322
2203	cf::global->attach (	3323	cf::cede_to_tick;
2204	prio => 10000,
2205	on_cleanup => sub {
2206	db_sync;
2207	},	3324	}
2208	);
2209	}
2210		3325
2211	#############################################################################	3326	while (my ($face, $info) = each %$faces) {
2212	# the server's main()	3327	next unless $info->{smooth};
2213		3328
2214	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
2215	open my $fh, "<:utf8", cf::confdir . "/config"	3457	open my $fh, "<:utf8", "$CONFDIR/config"
2216	or return;	3458	or return;
2217		3459
2218	local $/;	3460	local $/;
2219	*CFG = YAML::Syck::Load <$fh>;	3461	*CFG = YAML::XS::Load scalar <$fh>;
2220		3462
2221	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3463	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2222		3464
2223	$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};
2224	$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};
…		…
2228	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"	3470	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2229	and die "WARNING: m(un)lockall failed: $!\n";	3471	and die "WARNING: m(un)lockall failed: $!\n";
2230	};	3472	};
2231	warn $@ if $@;	3473	warn $@ if $@;
2232	}	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;
2233	}	3505	}
2234		3506
2235	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
2236	# we must not ever block the main coroutine	3522	# we must not ever block the main coroutine
2237	local $Coro::idle = sub {	3523	local $Coro::idle = sub {
2238	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#
2239	(async {	3525	(async {
2240	Event::one_event;	3526	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3527	EV::loop EV::LOOP_ONESHOT;
2241	})->prio (Coro::PRIO_MAX);	3528	})->prio (Coro::PRIO_MAX);
2242	};	3529	};
2243		3530
2244	cfg_load;	3531	evthread_start IO::AIO::poll_fileno;
2245	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
2246	load_extensions;	3550	load_extensions;
2247	Event::loop;	3551
		3552	utime time, time, $RUNTIMEFILE;
		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;
2248	}	3562	}
2249		3563
2250	#############################################################################	3564	#############################################################################
2251	# initialisation and cleanup	3565	# initialisation and cleanup
2252		3566
2253	# install some emergency cleanup handlers	3567	# install some emergency cleanup handlers
2254	BEGIN {	3568	BEGIN {
		3569	our %SIGWATCHER = ();
2255	for my $signal (qw(INT HUP TERM)) {	3570	for my $signal (qw(INT HUP TERM)) {
2256	Event->signal (	3571	$SIGWATCHER{$signal} = EV::signal $signal, sub {
2257	data => WF_AUTOCANCEL,
2258	signal => $signal,
2259	cb => sub {
2260	cf::cleanup "SIG$signal";	3572	cf::cleanup "SIG$signal";
2261	},
2262	);	3573	};
		3574	}
		3575	}
		3576
		3577	sub write_runtime_sync {
		3578	my $t0 = EV::time;
		3579
		3580	# first touch the runtime file to show we are still running:
		3581	# the fsync below can take a very very long time.
		3582
		3583	IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
		3584
		3585	my $guard = cf::lock_acquire "write_runtime";
		3586
		3587	my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644
		3588	or return;
		3589
		3590	my $value = $cf::RUNTIME + 90 + 10;
		3591	# 10 is the runtime save interval, for a monotonic clock
		3592	# 60 allows for the watchdog to kill the server.
		3593
		3594	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3595	and return;
		3596
		3597	# always fsync - this file is important
		3598	aio_fsync $fh
		3599	and return;
		3600
		3601	# touch it again to show we are up-to-date
		3602	aio_utime $fh, undef, undef;
		3603
		3604	close $fh
		3605	or return;
		3606
		3607	aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
		3608	and return;
		3609
		3610	warn sprintf "runtime file written (%gs).\n", EV::time - $t0;
		3611
2263	}	3612	1
		3613	}
		3614
		3615	our $uuid_lock;
		3616	our $uuid_skip;
		3617
		3618	sub write_uuid_sync($) {
		3619	$uuid_skip ||= $_[0];
		3620
		3621	return if $uuid_lock;
		3622	local $uuid_lock = 1;
		3623
		3624	my $uuid = "$LOCALDIR/uuid";
		3625
		3626	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3627	or return;
		3628
		3629	my $value = uuid_seq uuid_cur;
		3630
		3631	unless ($value) {
		3632	warn "cowardly refusing to write zero uuid value!\n";
		3633	return;
		3634	}
		3635
		3636	my $value = uuid_str $value + $uuid_skip;
		3637	$uuid_skip = 0;
		3638
		3639	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3640	and return;
		3641
		3642	# always fsync - this file is important
		3643	aio_fsync $fh
		3644	and return;
		3645
		3646	close $fh
		3647	or return;
		3648
		3649	aio_rename "$uuid~", $uuid
		3650	and return;
		3651
		3652	warn "uuid file written ($value).\n";
		3653
		3654	1
		3655
		3656	}
		3657
		3658	sub write_uuid($$) {
		3659	my ($skip, $sync) = @_;
		3660
		3661	$sync ? write_uuid_sync $skip
		3662	: async { write_uuid_sync $skip };
2264	}	3663	}
2265		3664
2266	sub emergency_save() {	3665	sub emergency_save() {
2267	my $freeze_guard = cf::freeze_mainloop;	3666	my $freeze_guard = cf::freeze_mainloop;
2268		3667
2269	warn "enter emergency perl save\n";	3668	warn "emergency_perl_save: enter\n";
2270		3669
2271	cf::sync_job {	3670	cf::sync_job {
		3671	# this is a trade-off: we want to be very quick here, so
		3672	# save all maps without fsync, and later call a global sync
		3673	# (which in turn might be very very slow)
		3674	local $USE_FSYNC = 0;
		3675
2272	# use a peculiar iteration method to avoid tripping on perl	3676	# use a peculiar iteration method to avoid tripping on perl
2273	# refcount bugs in for. also avoids problems with players	3677	# refcount bugs in for. also avoids problems with players
2274	# and maps saved/destroyed asynchronously.	3678	# and maps saved/destroyed asynchronously.
2275	warn "begin emergency player save\n";	3679	warn "emergency_perl_save: begin player save\n";
2276	for my $login (keys %cf::PLAYER) {	3680	for my $login (keys %cf::PLAYER) {
2277	my $pl = $cf::PLAYER{$login} or next;	3681	my $pl = $cf::PLAYER{$login} or next;
2278	$pl->valid or next;	3682	$pl->valid or next;
		3683	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2279	$pl->save;	3684	$pl->save;
2280	}	3685	}
2281	warn "end emergency player save\n";	3686	warn "emergency_perl_save: end player save\n";
2282		3687
2283	warn "begin emergency map save\n";	3688	warn "emergency_perl_save: begin map save\n";
2284	for my $path (keys %cf::MAP) {	3689	for my $path (keys %cf::MAP) {
2285	my $map = $cf::MAP{$path} or next;	3690	my $map = $cf::MAP{$path} or next;
2286	$map->valid or next;	3691	$map->valid or next;
2287	$map->save;	3692	$map->save;
2288	}	3693	}
2289	warn "end emergency map save\n";	3694	warn "emergency_perl_save: end map save\n";
		3695
		3696	warn "emergency_perl_save: begin database checkpoint\n";
		3697	BDB::db_env_txn_checkpoint $DB_ENV;
		3698	warn "emergency_perl_save: end database checkpoint\n";
		3699
		3700	warn "emergency_perl_save: begin write uuid\n";
		3701	write_uuid_sync 1;
		3702	warn "emergency_perl_save: end write uuid\n";
2290	};	3703	};
2291		3704
		3705	warn "emergency_perl_save: starting sync()\n";
		3706	IO::AIO::aio_sync sub {
		3707	warn "emergency_perl_save: finished sync()\n";
		3708	};
		3709
2292	warn "leave emergency perl save\n";	3710	warn "emergency_perl_save: leave\n";
2293	}	3711	}
2294		3712
		3713	sub post_cleanup {
		3714	my ($make_core) = @_;
		3715
		3716	warn Carp::longmess "post_cleanup backtrace"
		3717	if $make_core;
		3718
		3719	my $fh = pidfile;
		3720	unlink $PIDFILE if <$fh> == $$;
		3721	}
		3722
		3723	# a safer delete_package, copied from Symbol
		3724	sub clear_package($) {
		3725	my $pkg = shift;
		3726
		3727	# expand to full symbol table name if needed
		3728	unless ($pkg =~ /^main::.*::$/) {
		3729	$pkg = "main$pkg" if $pkg =~ /^::/;
		3730	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		3731	$pkg .= '::' unless $pkg =~ /::$/;
		3732	}
		3733
		3734	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		3735	my $stem_symtab = *{$stem}{HASH};
		3736
		3737	defined $stem_symtab and exists $stem_symtab->{$leaf}
		3738	or return;
		3739
		3740	# clear all symbols
		3741	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		3742	for my $name (keys %$leaf_symtab) {
		3743	_gv_clear *{"$pkg$name"};
		3744	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		3745	}
		3746	warn "cleared package $pkg\n";#d#
		3747	}
		3748
2295	sub reload() {	3749	sub do_reload_perl() {
2296	# can/must only be called in main	3750	# can/must only be called in main
2297	if ($Coro::current != $Coro::main) {	3751	if ($Coro::current != $Coro::main) {
2298	warn "can only reload from main coroutine\n";	3752	warn "can only reload from main coroutine";
2299	return;	3753	return;
2300	}	3754	}
2301		3755
		3756	return if $RELOAD++;
		3757
		3758	my $t1 = EV::time;
		3759
		3760	while ($RELOAD) {
2302	warn "reloading...";	3761	warn "reloading...";
2303		3762
2304	warn "freezing server";	3763	warn "entering sync_job";
2305	my $guard = freeze_mainloop;	3764
		3765	cf::sync_job {
		3766	cf::write_runtime_sync; # external watchdog should not bark
2306	cf::emergency_save;	3767	cf::emergency_save;
		3768	cf::write_runtime_sync; # external watchdog should not bark
2307		3769
2308	warn "sync database to disk";	3770	warn "syncing database to disk";
2309	cf::db_sync;	3771	BDB::db_env_txn_checkpoint $DB_ENV;
2310	IO::AIO::flush;
2311		3772
2312	eval {
2313	# if anything goes wrong in here, we should simply crash as we already saved	3773	# if anything goes wrong in here, we should simply crash as we already saved
2314		3774
2315	warn "cancel all watchers";	3775	warn "flushing outstanding aio requests";
2316	for (Event::all_watchers) {	3776	while (IO::AIO::nreqs || BDB::nreqs) {
2317	$_->cancel if $_->data & WF_AUTOCANCEL;	3777	Coro::EV::timer_once 0.01; # let the sync_job do it's thing
2318	}
2319
2320	warn "cancel all extension coros";
2321	$_->cancel for values %EXT_CORO;
2322	%EXT_CORO = ();
2323
2324	warn "remove commands";
2325	%COMMAND = ();
2326
2327	warn "remove ext commands";
2328	%EXTCMD = ();
2329
2330	warn "unload/nuke all extensions";
2331	for my $pkg (@EXTS) {
2332	warn "... unloading $pkg";
2333
2334	if (my $cb = $pkg->can ("unload")) {
2335	eval {
2336	$cb->($pkg);
2337	1
2338	} or warn "$pkg unloaded, but with errors: $@";
2339	}	3778	}
2340		3779
		3780	warn "cancelling all extension coros";
		3781	$_->cancel for values %EXT_CORO;
		3782	%EXT_CORO = ();
		3783
		3784	warn "removing commands";
		3785	%COMMAND = ();
		3786
		3787	warn "removing ext/exti commands";
		3788	%EXTCMD = ();
		3789	%EXTICMD = ();
		3790
		3791	warn "unloading/nuking all extensions";
		3792	for my $pkg (@EXTS) {
2341	warn "... nuking $pkg";	3793	warn "... unloading $pkg";
2342	Symbol::delete_package $pkg;
2343	}
2344		3794
2345	warn "unload all perl modules loaded from $LIBDIR";
2346	while (my ($k, $v) = each %INC) {
2347	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2348
2349	warn "removing <$k>";
2350	delete $INC{$k};
2351
2352	$k =~ s/\.pm$//;
2353	$k =~ s/\//::/g;
2354
2355	if (my $cb = $k->can ("unload_module")) {	3795	if (my $cb = $pkg->can ("unload")) {
		3796	eval {
2356	$cb->();	3797	$cb->($pkg);
		3798	1
		3799	} or warn "$pkg unloaded, but with errors: $@";
		3800	}
		3801
		3802	warn "... clearing $pkg";
		3803	clear_package $pkg;
2357	}	3804	}
2358		3805
2359	Symbol::delete_package $k;	3806	warn "unloading all perl modules loaded from $LIBDIR";
		3807	while (my ($k, $v) = each %INC) {
		3808	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		3809
		3810	warn "... unloading $k";
		3811	delete $INC{$k};
		3812
		3813	$k =~ s/\.pm$//;
		3814	$k =~ s/\//::/g;
		3815
		3816	if (my $cb = $k->can ("unload_module")) {
		3817	$cb->();
		3818	}
		3819
		3820	clear_package $k;
2360	}	3821	}
2361		3822
2362	warn "get rid of safe::, as good as possible";	3823	warn "getting rid of safe::, as good as possible";
2363	Symbol::delete_package "safe::$_"	3824	clear_package "safe::$_"
2364	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3825	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2365		3826
2366	warn "unload cf.pm \"a bit\"";	3827	warn "unloading cf.pm \"a bit\"";
2367	delete $INC{"cf.pm"};	3828	delete $INC{"cf.pm"};
		3829	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2368		3830
2369	# don't, removes xs symbols, too,	3831	# don't, removes xs symbols, too,
2370	# and global variables created in xs	3832	# and global variables created in xs
2371	#Symbol::delete_package __PACKAGE__;	3833	#clear_package __PACKAGE__;
2372		3834
		3835	warn "unload completed, starting to reload now";
		3836
2373	warn "reloading cf.pm";	3837	warn "reloading cf.pm";
2374	require cf;	3838	require cf;
2375	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3839	cf::_connect_to_perl_1;
2376		3840
2377	warn "load config and database again";	3841	warn "loading config and database again";
2378	cf::cfg_load;	3842	cf::reload_config;
2379	cf::db_load;
2380		3843
2381	warn "load extensions";	3844	warn "loading extensions";
2382	cf::load_extensions;	3845	cf::load_extensions;
2383		3846
		3847	if ($REATTACH_ON_RELOAD) {
2384	warn "reattach attachments to objects/players";	3848	warn "reattaching attachments to objects/players";
2385	_global_reattach;	3849	_global_reattach; # objects, sockets
2386	warn "reattach attachments to maps";	3850	warn "reattaching attachments to maps";
2387	reattach $_ for values %MAP;	3851	reattach $_ for values %MAP;
		3852	warn "reattaching attachments to players";
		3853	reattach $_ for values %PLAYER;
		3854	}
		3855
		3856	warn "running post_init jobs";
		3857	(pop @POST_INIT)->(1) while @POST_INIT;
		3858
		3859	warn "leaving sync_job";
		3860
		3861	1
		3862	} or do {
		3863	warn $@;
		3864	cf::cleanup "error while reloading, exiting.";
		3865	};
		3866
		3867	warn "reloaded";
		3868	--$RELOAD;
		3869	}
		3870
		3871	$t1 = EV::time - $t1;
		3872	warn "reload completed in ${t1}s\n";
		3873	};
		3874
		3875	our $RELOAD_WATCHER; # used only during reload
		3876
		3877	sub reload_perl() {
		3878	# doing reload synchronously and two reloads happen back-to-back,
		3879	# coro crashes during coro_state_free->destroy here.
		3880
		3881	$RELOAD_WATCHER ||= cf::async {
		3882	Coro::AIO::aio_wait cache_extensions;
		3883
		3884	$RELOAD_WATCHER = EV::timer $TICK * 1.5, 0, sub {
		3885	do_reload_perl;
		3886	undef $RELOAD_WATCHER;
		3887	};
2388	};	3888	};
2389		3889	}
2390	if ($@) {
2391	warn $@;
2392	warn "error while reloading, exiting.";
2393	exit 1;
2394	}
2395
2396	warn "reloaded";
2397	};
2398
2399	our $RELOAD_WATCHER; # used only during reload
2400		3890
2401	register_command "reload" => sub {	3891	register_command "reload" => sub {
2402	my ($who, $arg) = @_;	3892	my ($who, $arg) = @_;
2403		3893
2404	if ($who->flag (FLAG_WIZ)) {	3894	if ($who->flag (FLAG_WIZ)) {
2405	$who->message ("reloading server.");	3895	$who->message ("reloading server.");
2406		3896	async {
2407	# doing reload synchronously and two reloads happen back-to-back,	3897	$Coro::current->{desc} = "perl_reload";
2408	# coro crashes during coro_state_free->destroy here.
2409
2410	$RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub {
2411	reload;	3898	reload_perl;
2412	undef $RELOAD_WATCHER;
2413	});	3899	};
2414	}	3900	}
2415	};	3901	};
2416		3902
2417	unshift @INC, $LIBDIR;	3903	unshift @INC, $LIBDIR;
2418		3904
2419	$TICK_WATCHER = Event->timer (	3905	my $bug_warning = 0;
2420	reentrant => 0,
2421	prio => 0,
2422	at => $NEXT_TICK || $TICK,
2423	data => WF_AUTOCANCEL,
2424	cb => sub {
2425	$NOW = Event::time;
2426		3906
		3907	our @WAIT_FOR_TICK;
		3908	our @WAIT_FOR_TICK_BEGIN;
		3909
		3910	sub wait_for_tick {
		3911	return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
		3912
		3913	my $signal = new Coro::Signal;
		3914	push @WAIT_FOR_TICK, $signal;
		3915	$signal->wait;
		3916	}
		3917
		3918	sub wait_for_tick_begin {
		3919	return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
		3920
		3921	my $signal = new Coro::Signal;
		3922	push @WAIT_FOR_TICK_BEGIN, $signal;
		3923	$signal->wait;
		3924	}
		3925
		3926	sub tick {
		3927	if ($Coro::current != $Coro::main) {
		3928	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3929	unless ++$bug_warning > 10;
		3930	return;
		3931	}
		3932
2427	cf::server_tick; # one server iteration	3933	cf::server_tick; # one server iteration
2428	$RUNTIME += $TICK;
2429	$NEXT_TICK += $TICK;
2430		3934
2431	$WAIT_FOR_TICK->broadcast;	3935	#for(1..3e6){} EV::now_update; $NOW=EV::now; # generate load #d#
2432	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2433		3936
2434	# if we are delayed by four ticks or more, skip them all	3937	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2435	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3938	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2436		3939	Coro::async_pool {
2437	$TICK_WATCHER->at ($NEXT_TICK);	3940	$Coro::current->{desc} = "runtime saver";
2438	$TICK_WATCHER->start;
2439	},
2440	);
2441
2442	IO::AIO::max_poll_time $TICK * 0.2;
2443
2444	$AIO_POLL_WATCHER = Event->io (
2445	fd => IO::AIO::poll_fileno,
2446	poll => 'r',
2447	prio => 5,
2448	data => WF_AUTOCANCEL,
2449	cb => \&IO::AIO::poll_cb,
2450	);
2451
2452	$WRITE_RUNTIME_WATCHER = Event->timer (
2453	data => WF_AUTOCANCEL,
2454	after => 0,
2455	interval => 10,
2456	cb => sub {
2457	(Coro::unblock_sub {
2458	write_runtime	3941	write_runtime_sync
2459	or warn "ERROR: unable to write runtime file: $!";	3942	or warn "ERROR: unable to write runtime file: $!";
2460	})->();	3943	};
2461	},	3944	}
2462	);	3945
		3946	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3947	$sig->send;
		3948	}
		3949	while (my $sig = shift @WAIT_FOR_TICK) {
		3950	$sig->send;
		3951	}
		3952
		3953	$LOAD = ($NOW - $TICK_START) / $TICK;
		3954	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3955
		3956	if (0) {
		3957	if ($NEXT_TICK) {
		3958	my $jitter = $TICK_START - $NEXT_TICK;
		3959	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		3960	warn "jitter $JITTER\n";#d#
		3961	}
		3962	}
		3963	}
		3964
		3965	{
		3966	# configure BDB
		3967
		3968	BDB::min_parallel 16;
		3969	BDB::max_poll_reqs $TICK * 0.1;
		3970	$AnyEvent::BDB::WATCHER->priority (1);
		3971
		3972	unless ($DB_ENV) {
		3973	$DB_ENV = BDB::db_env_create;
		3974	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		3975	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		3976	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		3977	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3978	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3979
		3980	cf::sync_job {
		3981	eval {
		3982	BDB::db_env_open
		3983	$DB_ENV,
		3984	$BDBDIR,
		3985	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3986	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3987	0666;
		3988
		3989	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3990	};
		3991
		3992	cf::cleanup "db_env_open(db): $@" if $@;
		3993	};
		3994	}
		3995
		3996	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3997	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3998	};
		3999	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		4000	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		4001	};
		4002	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		4003	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		4004	};
		4005	}
		4006
		4007	{
		4008	# configure IO::AIO
		4009
		4010	IO::AIO::min_parallel 8;
		4011	IO::AIO::max_poll_time $TICK * 0.1;
		4012	undef $AnyEvent::AIO::WATCHER;
		4013	}
		4014
		4015	my $_log_backtrace;
		4016
		4017	sub _log_backtrace {
		4018	my ($msg, @addr) = @_;
		4019
		4020	$msg =~ s/\n//;
		4021
		4022	# limit the # of concurrent backtraces
		4023	if ($_log_backtrace < 2) {
		4024	++$_log_backtrace;
		4025	my $perl_bt = Carp::longmess $msg;
		4026	async {
		4027	$Coro::current->{desc} = "abt $msg";
		4028
		4029	my @bt = fork_call {
		4030	@addr = map { sprintf "%x", $_ } @addr;
		4031	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		4032	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		4033	or die "addr2line: $!";
		4034
		4035	my @funcs;
		4036	my @res = <$fh>;
		4037	chomp for @res;
		4038	while (@res) {
		4039	my ($func, $line) = splice @res, 0, 2, ();
		4040	push @funcs, "[$func] $line";
		4041	}
		4042
		4043	@funcs
		4044	};
		4045
		4046	LOG llevInfo, "[ABT] $perl_bt\n";
		4047	LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
		4048	LOG llevInfo, "[ABT] $_\n" for @bt;
		4049	--$_log_backtrace;
		4050	};
		4051	} else {
		4052	LOG llevInfo, "[ABT] $msg\n";
		4053	LOG llevInfo, "[ABT] [suppressed]\n";
		4054	}
		4055	}
		4056
		4057	# load additional modules
		4058	require "cf/$_.pm" for @EXTRA_MODULES;
		4059	cf::_connect_to_perl_2;
2463		4060
2464	END { cf::emergency_save }	4061	END { cf::emergency_save }
2465		4062
2466	1	4063	1
2467		4064

Diff Legend

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