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.177 by root, Sun Jan 14 22:54:18 2007 UTC vs.
Revision 1.489 by root, Fri Oct 23 03:08:35 2009 UTC

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

Diff Legend

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