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

Diff Legend

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