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.184 by root, Fri Jan 19 22:47:57 2007 UTC vs.
Revision 1.498 by elmex, Tue Jan 5 16:16:37 2010 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 ();
		37	use Carp ();
12		38
		39	use Guard ();
13	use Coro 3.4 ();	40	use Coro ();
		41	use Coro::State;
		42	use Coro::Handle;
		43	use Coro::EV;
14	use Coro::Event;	44	use Coro::AnyEvent;
15	use Coro::Timer;	45	use Coro::Timer;
16	use Coro::Signal;	46	use Coro::Signal;
17	use Coro::Semaphore;	47	use Coro::Semaphore;
		48	use Coro::SemaphoreSet;
		49	use Coro::AnyEvent;
18	use Coro::AIO;	50	use Coro::AIO;
		51	use Coro::BDB 1.6;
		52	use Coro::Storable;
		53	use Coro::Util ();
19		54
		55	use JSON::XS 2.01 ();
		56	use BDB ();
20	use Data::Dumper;	57	use Data::Dumper;
21	use Digest::MD5;
22	use Fcntl;	58	use Fcntl;
23	use IO::AIO 2.32 ();
24	use YAML::Syck ();	59	use YAML::XS ();
		60	use IO::AIO ();
25	use Time::HiRes;	61	use Time::HiRes;
		62	use Compress::LZF;
		63	use Digest::MD5 ();
26		64
27	use Event; $Event::Eval = 1; # no idea why this is required, but it is	65	AnyEvent::detect;
		66
		67	# configure various modules to our taste
		68	#
		69	$Storable::canonical = 1; # reduce rsync transfers
		70	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		71
		72	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
		73
		74	# make sure c-lzf reinitialises itself
		75	Compress::LZF::set_serializer "Storable", "Storable::net_mstore", "Storable::mretrieve";
		76	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		77
		78	# strictly for debugging
		79	$SIG{QUIT} = sub { Carp::cluck "SIGQUIT" };
28		80
29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	81	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30
31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32	$YAML::Syck::ImplicitUnicode = 1;
33
34	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
35		82
36	our %COMMAND = ();	83	our %COMMAND = ();
37	our %COMMAND_TIME = ();	84	our %COMMAND_TIME = ();
38		85
39	our @EXTS = (); # list of extension package names	86	our @EXTS = (); # list of extension package names
40	our %EXTCMD = ();	87	our %EXTCMD = ();
		88	our %EXTICMD = ();
41	our %EXT_CORO = (); # coroutines bound to extensions	89	our %EXT_CORO = (); # coroutines bound to extensions
42	our %EXT_MAP = (); # pluggable maps	90	our %EXT_MAP = (); # pluggable maps
43		91
		92	our $RELOAD; # number of reloads so far, non-zero while in reload
44	our @EVENT;	93	our @EVENT;
45	our $LIBDIR = datadir . "/ext";	94	our @REFLECT; # set by XS
		95	our %REFLECT; # set by us
46		96
47	our $TICK = MAX_TIME * 1e-6;	97	our $CONFDIR = confdir;
48	our $TICK_WATCHER;	98	our $DATADIR = datadir;
49	our $AIO_POLL_WATCHER;	99	our $LIBDIR = "$DATADIR/ext";
50	our $WRITE_RUNTIME_WATCHER;	100	our $PODDIR = "$DATADIR/pod";
		101	our $MAPDIR = "$DATADIR/" . mapdir;
		102	our $LOCALDIR = localdir;
		103	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		104	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		105	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		106	our $RANDOMDIR = "$LOCALDIR/random";
		107	our $BDBDIR = "$LOCALDIR/db";
		108	our $PIDFILE = "$LOCALDIR/pid";
		109	our $RUNTIMEFILE = "$LOCALDIR/runtime";
		110
		111	our %RESOURCE;
		112
		113	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
		114	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
51	our $NEXT_TICK;	115	our $NEXT_TICK;
52	our $NOW;	116	our $USE_FSYNC = 1; # use fsync to write maps - default on
		117
		118	our $BDB_DEADLOCK_WATCHER;
		119	our $BDB_CHECKPOINT_WATCHER;
		120	our $BDB_TRICKLE_WATCHER;
		121	our $DB_ENV;
		122
		123	our @EXTRA_MODULES = qw(pod match mapscript);
53		124
54	our %CFG;	125	our %CFG;
55		126
56	our $UPTIME; $UPTIME ||= time;	127	our $UPTIME; $UPTIME ||= time;
57	our $RUNTIME;	128	our $RUNTIME;
		129	our $NOW;
58		130
59	our %PLAYER; # all users	131	our (%PLAYER, %PLAYER_LOADING); # all users
60	our %MAP; # all maps	132	our (%MAP, %MAP_LOADING ); # all maps
61	our $LINK_MAP; # the special {link} map, which is always available	133	our $LINK_MAP; # the special {link} map, which is always available
62	our $RANDOM_MAPS = cf::localdir . "/random";
63
64	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
65	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
66		134
67	# used to convert map paths into valid unix filenames by replacing / by ∕	135	# used to convert map paths into valid unix filenames by replacing / by ∕
68	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	136	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69		137
		138	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		139	our $LOADAVG; # same thing, but with alpha-smoothing
		140	our $JITTER; # average jitter
		141	our $TICK_START; # for load detecting purposes
		142
		143	our @POST_INIT;
		144
		145	our $REATTACH_ON_RELOAD; # set to true to force object reattach on reload (slow)
		146	our $REALLY_UNLOOP; # never set to true, please :)
		147
70	binmode STDOUT;	148	binmode STDOUT;
71	binmode STDERR;	149	binmode STDERR;
72		150
73	# read virtual server time, if available	151	# read virtual server time, if available
74	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	152	unless ($RUNTIME || !-e $RUNTIMEFILE) {
75	open my $fh, "<", cf::localdir . "/runtime"	153	open my $fh, "<", $RUNTIMEFILE
76	or die "unable to read runtime file: $!";	154	or die "unable to read $RUNTIMEFILE file: $!";
77	$RUNTIME = <$fh> + 0.;	155	$RUNTIME = <$fh> + 0.;
78	}	156	}
79		157
80	mkdir cf::localdir;	158	eval "sub TICK() { $TICK } 1" or die;
81	mkdir cf::localdir . "/" . cf::playerdir;	159
82	mkdir cf::localdir . "/" . cf::tmpdir;	160	mkdir $_
83	mkdir cf::localdir . "/" . cf::uniquedir;	161	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
84	mkdir $RANDOM_MAPS;
85		162
86	our $EMERGENCY_POSITION;	163	our $EMERGENCY_POSITION;
		164
		165	sub cf::map::normalise;
		166
		167	#############################################################################
		168
		169	%REFLECT = ();
		170	for (@REFLECT) {
		171	my $reflect = JSON::XS::decode_json $_;
		172	$REFLECT{$reflect->{class}} = $reflect;
		173	}
		174
		175	# this is decidedly evil
		176	$REFLECT{object}{flags} = { map +($_ => undef), grep $_, map /^FLAG_([A-Z0-9_]+)$/ && lc $1, keys %{"cf::"} };
87		177
88	#############################################################################	178	#############################################################################
89		179
90	=head2 GLOBAL VARIABLES	180	=head2 GLOBAL VARIABLES
91		181
…		…
98	=item $cf::RUNTIME	188	=item $cf::RUNTIME
99		189
100	The time this server has run, starts at 0 and is increased by $cf::TICK on	190	The time this server has run, starts at 0 and is increased by $cf::TICK on
101	every server tick.	191	every server tick.
102		192
103	=item $cf::LIBDIR	193	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		194	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		195	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
104		196
105	The perl library directory, where extensions and cf-specific modules can	197	Various directories - "/etc", read-only install directory, perl-library
106	be found. It will be added to C<@INC> automatically.	198	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		199	unique-items directory, player file directory, random maps directory and
		200	database environment.
107		201
108	=item $cf::NOW	202	=item $cf::NOW
109		203
110	The time of the last (current) server tick.	204	The time of the last (current) server tick.
111		205
112	=item $cf::TICK	206	=item $cf::TICK
113		207
114	The interval between server ticks, in seconds.	208	The interval between server ticks, in seconds.
115		209
		210	=item $cf::LOADAVG
		211
		212	The current CPU load on the server (alpha-smoothed), as a value between 0
		213	(none) and 1 (overloaded), indicating how much time is spent on processing
		214	objects per tick. Healthy values are < 0.5.
		215
		216	=item $cf::LOAD
		217
		218	The raw value load value from the last tick.
		219
116	=item %cf::CFG	220	=item %cf::CFG
117		221
118	Configuration for the server, loaded from C</etc/crossfire/config>, or	222	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
119	from wherever your confdir points to.	223	from wherever your confdir points to.
120		224
121	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	225	=item cf::wait_for_tick, cf::wait_for_tick_begin
122		226
123	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	227	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
124	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick	228	returns directly I<after> the tick processing (and consequently, can only wake one process
125	processing has been done. Call C<< ->wait >> on them to maximise the	229	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
126	window of cpu time available, or simply to synchronise to the server tick.	230
		231	=item @cf::INVOKE_RESULTS
		232
		233	This array contains the results of the last C<invoke ()> call. When
		234	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		235	that call.
		236
		237	=item %cf::REFLECT
		238
		239	Contains, for each (C++) class name, a hash reference with information
		240	about object members (methods, scalars, arrays and flags) and other
		241	metadata, which is useful for introspection.
127		242
128	=back	243	=back
129		244
130	=cut	245	=cut
131		246
132	BEGIN {	247	$Coro::State::WARNHOOK = sub {
133	*CORE::GLOBAL::warn = sub {
134	my $msg = join "", @_;	248	my $msg = join "", @_;
135	utf8::encode $msg;
136		249
137	$msg .= "\n"	250	$msg .= "\n"
138	unless $msg =~ /\n$/;	251	unless $msg =~ /\n$/;
139		252
		253	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		254
140	LOG llevError, $msg;	255	LOG llevError, $msg;
141	};	256	};
142	}	257
		258	$Coro::State::DIEHOOK = sub {
		259	return unless $^S eq 0; # "eq", not "=="
		260
		261	warn Carp::longmess $_[0];
		262
		263	if ($Coro::current == $Coro::main) {#d#
		264	warn "DIEHOOK called in main context, Coro bug?\n";#d#
		265	return;#d#
		266	}#d#
		267
		268	# kill coroutine otherwise
		269	Coro::terminate
		270	};
143		271
144	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	272	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
145	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	273	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
146	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	274	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
147	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	275	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
148	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	276	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		277	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
149	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	278	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
150		279
151	# we bless all objects into (empty) derived classes to force a method lookup	280	# we bless all objects into (empty) derived classes to force a method lookup
152	# within the Safe compartment.	281	# within the Safe compartment.
153	for my $pkg (qw(	282	for my $pkg (qw(
154	cf::global cf::attachable	283	cf::global cf::attachable
155	cf::object cf::object::player	284	cf::object cf::object::player
156	cf::client cf::player	285	cf::client cf::player
157	cf::arch cf::living	286	cf::arch cf::living
		287	cf::map cf::mapspace
158	cf::map cf::party cf::region	288	cf::party cf::region
159	)) {	289	)) {
160	no strict 'refs';
161	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	290	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
162	}	291	}
163		292
164	$Event::DIED = sub {	293	$EV::DIED = sub {
165	warn "error in event callback: @_";	294	Carp::cluck "error in event callback: @_";
166	};	295	};
		296
		297	#############################################################################
167		298
168	=head2 UTILITY FUNCTIONS	299	=head2 UTILITY FUNCTIONS
169		300
170	=over 4	301	=over 4
171		302
…		…
190	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	321	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
191	$d	322	$d
192	} || "[unable to dump $_[0]: '$@']";	323	} || "[unable to dump $_[0]: '$@']";
193	}	324	}
194		325
195	use JSON::Syck (); # TODO# replace by JSON::PC once working
196
197	=item $ref = cf::from_json $json	326	=item $ref = cf::decode_json $json
198		327
199	Converts a JSON string into the corresponding perl data structure.	328	Converts a JSON string into the corresponding perl data structure.
200		329
201	=cut
202
203	sub from_json($) {
204	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
205	JSON::Syck::Load $_[0]
206	}
207
208	=item $json = cf::to_json $ref	330	=item $json = cf::encode_json $ref
209		331
210	Converts a perl data structure into its JSON representation.	332	Converts a perl data structure into its JSON representation.
211		333
212	=cut	334	=cut
213		335
214	sub to_json($) {	336	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
215	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	337
216	JSON::Syck::Dump $_[0]	338	sub encode_json($) { $json_coder->encode ($_[0]) }
		339	sub decode_json($) { $json_coder->decode ($_[0]) }
		340
		341	=item cf::post_init { BLOCK }
		342
		343	Execute the given codeblock, I<after> all extensions have been (re-)loaded,
		344	but I<before> the server starts ticking again.
		345
		346	The cdoeblock will have a single boolean argument to indicate whether this
		347	is a reload or not.
		348
		349	=cut
		350
		351	sub post_init(&) {
		352	push @POST_INIT, shift;
217	}	353	}
218		354
219	=item cf::lock_wait $string	355	=item cf::lock_wait $string
220		356
221	Wait until the given lock is available. See cf::lock_acquire.	357	Wait until the given lock is available. See cf::lock_acquire.
222		358
223	=item my $lock = cf::lock_acquire $string	359	=item my $lock = cf::lock_acquire $string
224		360
225	Wait until the given lock is available and then acquires it and returns	361	Wait until the given lock is available and then acquires it and returns
226	a Coro::guard object. If the guard object gets destroyed (goes out of scope,	362	a L<Guard> object. If the guard object gets destroyed (goes out of scope,
227	for example when the coroutine gets canceled), the lock is automatically	363	for example when the coroutine gets canceled), the lock is automatically
228	returned.	364	returned.
229		365
		366	Locks are *not* recursive, locking from the same coro twice results in a
		367	deadlocked coro.
		368
230	Lock names should begin with a unique identifier (for example, cf::map::find	369	Lock names should begin with a unique identifier (for example, cf::map::find
231	uses map_find and cf::map::load uses map_load).	370	uses map_find and cf::map::load uses map_load).
232		371
233	=cut	372	=item $locked = cf::lock_active $string
234		373
235	our %LOCK;	374	Return true if the lock is currently active, i.e. somebody has locked it.
		375
		376	=cut
		377
		378	our $LOCKS = new Coro::SemaphoreSet;
236		379
237	sub lock_wait($) {	380	sub lock_wait($) {
238	my ($key) = @_;	381	$LOCKS->wait ($_[0]);
239
240	# wait for lock, if any
241	while ($LOCK{$key}) {
242	push @{ $LOCK{$key} }, $Coro::current;
243	Coro::schedule;
244	}
245	}	382	}
246		383
247	sub lock_acquire($) {	384	sub lock_acquire($) {
248	my ($key) = @_;	385	$LOCKS->guard ($_[0])
		386	}
249		387
250	# wait, to be sure we are not locked	388	sub lock_active($) {
251	lock_wait $key;	389	$LOCKS->count ($_[0]) < 1
252
253	$LOCK{$key} = [];
254
255	Coro::guard {
256	# wake up all waiters, to be on the safe side
257	$_->ready for @{ delete $LOCK{$key} };
258	}
259	}	390	}
260		391
261	sub freeze_mainloop {	392	sub freeze_mainloop {
262	return unless $TICK_WATCHER->is_active;	393	tick_inhibit_inc;
263		394
264	my $guard = Coro::guard {	395	&Guard::guard (\&tick_inhibit_dec);
265	$TICK_WATCHER->start;	396	}
266	$WRITE_RUNTIME_WATCHER->start;	397
		398	=item cf::periodic $interval, $cb
		399
		400	Like EV::periodic, but randomly selects a starting point so that the actions
		401	get spread over timer.
		402
		403	=cut
		404
		405	sub periodic($$) {
		406	my ($interval, $cb) = @_;
		407
		408	my $start = rand List::Util::min 180, $interval;
		409
		410	EV::periodic $start, $interval, 0, $cb
		411	}
		412
		413	=item cf::get_slot $time[, $priority[, $name]]
		414
		415	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		416	This call blocks and returns only when you have at least C<$time> seconds
		417	of cpu time till the next tick. The slot is only valid till the next cede.
		418
		419	The optional C<$name> can be used to identify the job to run. It might be
		420	used for statistical purposes and should identify the same time-class.
		421
		422	Useful for short background jobs.
		423
		424	=cut
		425
		426	our @SLOT_QUEUE;
		427	our $SLOT_QUEUE;
		428
		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 path $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
		1754
1126	# mit "rum" bekleckern, nicht	1755	# mit "rum" bekleckern, nicht
1127	$self->_create_random_map (	1756	$self->_create_random_map (
1128	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1757	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1129	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1758	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1130	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1759	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
…		…
1137	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1766	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1138	(cf::region::find $rmp->{region}), $rmp->{custom}	1767	(cf::region::find $rmp->{region}), $rmp->{custom}
1139	)	1768	)
1140	}	1769	}
1141		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
1142	sub register {	1779	sub register {
1143	my (undef, $regex) = @_;	1780	my (undef, $regex, $prio) = @_;
1144	my $pkg = caller;	1781	my $pkg = caller;
1145		1782
1146	no strict;	1783	no strict;
1147	push @{"$pkg\::ISA"}, __PACKAGE__;	1784	push @{"$pkg\::ISA"}, __PACKAGE__;
1148		1785
1149	$EXT_MAP{$pkg} = qr<$regex>;	1786	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
1150	}	1787	}
1151		1788
1152	# also paths starting with '/'	1789	# also paths starting with '/'
1153	$EXT_MAP{"cf::map"} = qr{^(?=/)};	1790	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1154		1791
1155	sub thawer_merge {	1792	sub thawer_merge {
1156	my ($self, $merge) = @_;	1793	my ($self, $merge) = @_;
1157		1794
1158	# we have to keep some variables in memory intact	1795	# we have to keep some variables in memory intact
1159	local $self->{path};	1796	local $self->{path};
1160	local $self->{load_path};	1797	local $self->{load_path};
1161	local $self->{deny_save};
1162	local $self->{deny_reset};
1163		1798
1164	$self->SUPER::thawer_merge ($merge);	1799	$self->SUPER::thawer_merge ($merge);
1165	}	1800	}
1166		1801
1167	sub normalise {	1802	sub normalise {
1168	my ($path, $base) = @_;	1803	my ($path, $base) = @_;
		1804
		1805	$path = "$path"; # make sure its a string
		1806
		1807	$path =~ s/\.map$//;
1169		1808
1170	# map plan:	1809	# map plan:
1171	#	1810	#
1172	# /! non-realised random map exit (special hack!)	1811	# /! non-realised random map exit (special hack!)
1173	# {... are special paths that are not being touched	1812	# {... are special paths that are not being touched
…		…
1201		1840
1202	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
1203		1842
1204	$path = normalise $path, $base;	1843	$path = normalise $path, $base;
1205		1844
1206	for my $pkg (keys %EXT_MAP) {	1845	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1207	if ($path =~ $EXT_MAP{$pkg}) {	1846	if ($path =~ $EXT_MAP{$pkg}[1]) {
1208	my $self = bless cf::map::new, $pkg;	1847	my $self = bless cf::map::new, $pkg;
1209	$self->{path} = $path; $self->path ($path);	1848	$self->{path} = $path; $self->path ($path);
1210	$self->init; # pass $1 etc.	1849	$self->init; # pass $1 etc.
1211	return $self;	1850	return $self;
1212	}	1851	}
1213	}	1852	}
1214		1853
1215	Carp::carp "unable to resolve path '$path'.";	1854	Carp::cluck "unable to resolve path '$path' (base '$base').";
1216	()	1855	()
1217	}	1856	}
1218		1857
1219	sub init {	1858	sub init {
1220	my ($self) = @_;	1859	my ($self) = @_;
…		…
1235		1874
1236	# the original (read-only) location	1875	# the original (read-only) location
1237	sub load_path {	1876	sub load_path {
1238	my ($self) = @_;	1877	my ($self) = @_;
1239		1878
1240	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1879	"$MAPDIR/$self->{path}.map"
1241	}	1880	}
1242		1881
1243	# the temporary/swap location	1882	# the temporary/swap location
1244	sub save_path {	1883	sub save_path {
1245	my ($self) = @_;	1884	my ($self) = @_;
1246		1885
1247	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1886	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1248	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	1887	"$TMPDIR/$path.map"
1249	}	1888	}
1250		1889
1251	# the unique path, undef == no special unique path	1890	# the unique path, undef == no special unique path
1252	sub uniq_path {	1891	sub uniq_path {
1253	my ($self) = @_;	1892	my ($self) = @_;
1254		1893
1255	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1894	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1256	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1895	"$UNIQUEDIR/$path"
1257	}	1896	}
1258		1897
1259	# and all this just because we cannot iterate over	1898	sub decay_objects {
1260	# all maps in C++...
1261	sub change_all_map_light {
1262	my ($change) = @_;	1899	my ($self) = @_;
1263		1900
1264	$_->change_map_light ($change)	1901	return if $self->{deny_reset};
1265	for grep $_->outdoor, values %cf::MAP;	1902
		1903	$self->do_decay_objects;
1266	}	1904	}
1267		1905
1268	sub unlink_save {	1906	sub unlink_save {
1269	my ($self) = @_;	1907	my ($self) = @_;
1270		1908
…		…
1275		1913
1276	sub load_header_from($) {	1914	sub load_header_from($) {
1277	my ($self, $path) = @_;	1915	my ($self, $path) = @_;
1278		1916
1279	utf8::encode $path;	1917	utf8::encode $path;
1280	aio_open $path, O_RDONLY, 0	1918	my $f = new_from_file cf::object::thawer $path
1281	or return;	1919	or return;
1282		1920
1283	$self->_load_header ($path)	1921	$self->_load_header ($f)
1284	or return;	1922	or return;
1285		1923
		1924	local $MAP_LOADING{$self->{path}} = $self;
		1925	$f->resolve_delayed_derefs;
		1926
1286	$self->{load_path} = $path;	1927	$self->{load_path} = $path;
1287		1928
1288	1	1929	1
1289	}	1930	}
1290		1931
1291	sub load_orig {	1932	sub load_header_orig {
1292	my ($self) = @_;	1933	my ($self) = @_;
1293		1934
1294	$self->load_header_from ($self->load_path)	1935	$self->load_header_from ($self->load_path)
1295	}	1936	}
1296		1937
1297	sub load_temp {	1938	sub load_header_temp {
1298	my ($self) = @_;	1939	my ($self) = @_;
1299		1940
1300	$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;
1301	}	1961	}
1302		1962
1303	sub load_header {	1963	sub load_header {
1304	my ($self) = @_;	1964	my ($self) = @_;
1305		1965
1306	if ($self->load_temp) {	1966	if ($self->load_header_temp) {
1307	$self->last_access ((delete $self->{last_access})	1967	$self->prepare_temp;
1308	|| $cf::RUNTIME); #d#
1309	# safety
1310	$self->{instantiate_time} = $cf::RUNTIME
1311	if $self->{instantiate_time} > $cf::RUNTIME;
1312	} else {	1968	} else {
1313	$self->load_orig	1969	$self->load_header_orig
1314	or return;	1970	or return;
1315		1971	$self->prepare_orig;
1316	$self->{load_original} = 1;
1317	$self->{instantiate_time} = $cf::RUNTIME;
1318	$self->last_access ($cf::RUNTIME);
1319	$self->instantiate;
1320	}	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;
1321		1979
1322	1	1980	1
1323	}	1981	}
1324		1982
1325	sub find;	1983	sub find;
1326	sub find {	1984	sub find {
1327	my ($path, $origin) = @_;	1985	my ($path, $origin) = @_;
1328		1986
1329	$path = normalise $path, $origin && $origin->path;	1987	$path = normalise $path, $origin && $origin->path;
1330		1988
		1989	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1331	cf::lock_wait "map_find:$path";	1990	my $guard2 = cf::lock_acquire "map_find:$path";
1332		1991
1333	$cf::MAP{$path} || do {	1992	$cf::MAP{$path} || do {
1334	my $guard = cf::lock_acquire "map_find:$path";
1335	my $map = new_from_path cf::map $path	1993	my $map = new_from_path cf::map $path
1336	or return;	1994	or return;
1337		1995
1338	$map->{last_save} = $cf::RUNTIME;	1996	$map->{last_save} = $cf::RUNTIME;
1339		1997
1340	$map->load_header	1998	$map->load_header
1341	or return;	1999	or return;
1342		2000
1343	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
1344	$cf::WAIT_FOR_TICK->wait;	2003	#$cf::WAIT_FOR_TICK->wait;
		2004	undef $guard2;
		2005	undef $guard1;
1345	$map->reset;	2006	$map->reset;
1346	undef $guard;
1347	$map = find $path	2007	return find $path;
1348	or return;
1349	}	2008	}
1350		2009
1351	$cf::MAP{$path} = $map	2010	$cf::MAP{$path} = $map
1352	}	2011	}
1353	}	2012	}
		2013
		2014	sub pre_load { }
		2015	sub post_load { }
1354		2016
1355	sub load {	2017	sub load {
1356	my ($self) = @_;	2018	my ($self) = @_;
1357		2019
		2020	local $self->{deny_reset} = 1; # loading can take a long time
		2021
1358	my $path = $self->{path};	2022	my $path = $self->{path};
		2023
		2024	{
1359	my $guard = cf::lock_acquire "map_load:$path";	2025	my $guard = cf::lock_acquire "map_data:$path";
1360		2026
		2027	return unless $self->valid;
1361	return if $self->in_memory != cf::MAP_SWAPPED;	2028	return unless $self->in_memory == cf::MAP_SWAPPED;
1362		2029
1363	$self->in_memory (cf::MAP_LOADING);	2030	$self->in_memory (cf::MAP_LOADING);
1364		2031
1365	$self->alloc;	2032	$self->alloc;
1366	$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)
1367	or return;	2040	or return;
1368		2041
1369	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2042	$self->post_load_original
1370	if delete $self->{load_original};	2043	if delete $self->{load_original};
1371		2044
1372	if (my $uniq = $self->uniq_path) {	2045	if (my $uniq = $self->uniq_path) {
1373	utf8::encode $uniq;	2046	utf8::encode $uniq;
1374	if (aio_open $uniq, O_RDONLY, 0) {	2047	unless (aio_stat $uniq) {
		2048	if (my $f = new_from_file cf::object::thawer $uniq) {
1375	$self->clear_unique_items;	2049	$self->clear_unique_items;
1376	$self->_load_objects ($uniq, 0);	2050	$self->_load_objects ($f);
		2051	$f->resolve_delayed_derefs;
		2052	}
1377	}	2053	}
1378	}	2054	}
1379		2055
1380	Coro::cede;	2056	$f->resolve_delayed_derefs;
1381		2057
		2058	cf::cede_to_tick;
1382	# now do the right thing for maps	2059	# now do the right thing for maps
1383	$self->link_multipart_objects;	2060	$self->link_multipart_objects;
1384
1385	unless ($self->{deny_activate}) {
1386	$self->decay_objects;
1387	$self->fix_auto_apply;
1388	$self->update_buttons;
1389	Coro::cede;
1390	$self->set_darkness_map;
1391	$self->difficulty ($self->estimate_difficulty)	2061	$self->difficulty ($self->estimate_difficulty)
1392	unless $self->difficulty;	2062	unless $self->difficulty;
1393	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;
1394	$self->activate;	2070	$self->activate;
1395	}	2071	}
1396		2072
		2073	$self->{last_save} = $cf::RUNTIME;
		2074	$self->last_access ($cf::RUNTIME);
		2075
1397	$self->in_memory (cf::MAP_IN_MEMORY);	2076	$self->in_memory (cf::MAP_ACTIVE);
		2077	}
		2078
		2079	$self->post_load;
1398	}	2080	}
1399		2081
1400	sub customise_for {	2082	sub customise_for {
1401	my ($self, $ob) = @_;	2083	my ($self, $ob) = @_;
1402		2084
1403	return find "~" . $ob->name . "/" . $self->{path}	2085	return find "~" . $ob->name . "/" . $self->{path}
1404	if $self->per_player;	2086	if $self->per_player;
1405		2087
		2088	# return find "?party/" . $ob->name . "/" . $self->{path}
		2089	# if $self->per_party;
		2090
1406	$self	2091	$self
1407	}	2092	}
1408		2093
1409	# 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
1410	sub load_diag {	2095	sub load_neighbours {
1411	my ($map) = @_;	2096	my ($map) = @_;
1412		2097
1413	my @diag; # diagonal neighbours	2098	my @neigh; # diagonal neighbours
1414		2099
1415	for (0 .. 3) {	2100	for (0 .. 3) {
1416	my $neigh = $map->tile_path ($_)	2101	my $neigh = $map->tile_path ($_)
1417	or next;	2102	or next;
1418	$neigh = find $neigh, $map	2103	$neigh = find $neigh, $map
1419	or next;	2104	or next;
1420	$neigh->load;	2105	$neigh->load;
1421		2106
		2107	push @neigh,
1422	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2108	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1423	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2109	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1424	}	2110	}
1425		2111
1426	for (@diag) {	2112	for (grep defined $_->[0], @neigh) {
		2113	my ($path, $origin) = @$_;
1427	my $neigh = find @$_	2114	my $neigh = find $path, $origin
1428	or next;	2115	or next;
1429	$neigh->load;	2116	$neigh->load;
1430	}	2117	}
1431	}	2118	}
1432		2119
…		…
1437	}	2124	}
1438		2125
1439	sub do_load_sync {	2126	sub do_load_sync {
1440	my ($map) = @_;	2127	my ($map) = @_;
1441		2128
		2129	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2130	if $Coro::current == $Coro::main;
		2131
1442	cf::sync_job { $map->load };	2132	cf::sync_job { $map->load };
1443	}	2133	}
1444		2134
1445	our %MAP_PREFETCH;	2135	our %MAP_PREFETCH;
1446	our $MAP_PREFETCHER = undef;	2136	our $MAP_PREFETCHER = undef;
1447		2137
1448	sub find_async {	2138	sub find_async {
1449	my ($path, $origin) = @_;	2139	my ($path, $origin, $load) = @_;
1450		2140
1451	$path = normalise $path, $origin && $origin->{path};	2141	$path = normalise $path, $origin && $origin->{path};
1452		2142
1453	if (my $map = $cf::MAP{$path}) {	2143	if (my $map = $cf::MAP{$path}) {
1454	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2144	return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
1455	}	2145	}
1456		2146
1457	undef $MAP_PREFETCH{$path};	2147	$MAP_PREFETCH{$path} |= $load;
		2148
1458	$MAP_PREFETCHER ||= cf::async {	2149	$MAP_PREFETCHER ||= cf::async {
		2150	$Coro::current->{desc} = "map prefetcher";
		2151
1459	while (%MAP_PREFETCH) {	2152	while (%MAP_PREFETCH) {
1460	for my $path (keys %MAP_PREFETCH) {	2153	while (my ($k, $v) = each %MAP_PREFETCH) {
1461	my $map = find $path	2154	if (my $map = find $k) {
1462	or next;
1463	$map->load;	2155	$map->load if $v;
		2156	}
1464		2157
1465	delete $MAP_PREFETCH{$path};	2158	delete $MAP_PREFETCH{$k};
1466	}	2159	}
1467	}	2160	}
1468	undef $MAP_PREFETCHER;	2161	undef $MAP_PREFETCHER;
1469	};	2162	};
		2163	$MAP_PREFETCHER->prio (6);
1470		2164
1471	()	2165	()
1472	}	2166	}
1473		2167
1474	sub save {	2168	sub save {
1475	my ($self) = @_;	2169	my ($self) = @_;
1476		2170
1477	my $lock = cf::lock_acquire "map_data:" . $self->path;	2171	my $lock = cf::lock_acquire "map_data:$self->{path}";
1478		2172
1479	$self->{last_save} = $cf::RUNTIME;	2173	$self->{last_save} = $cf::RUNTIME;
1480		2174
1481	return unless $self->dirty;	2175	return unless $self->dirty;
1482		2176
…		…
1488	return if $self->{deny_save};	2182	return if $self->{deny_save};
1489		2183
1490	local $self->{last_access} = $self->last_access;#d#	2184	local $self->{last_access} = $self->last_access;#d#
1491		2185
1492	cf::async {	2186	cf::async {
		2187	$Coro::current->{desc} = "map player save";
1493	$_->contr->save for $self->players;	2188	$_->contr->save for $self->players;
1494	};	2189	};
		2190
		2191	cf::get_slot 0.02;
1495		2192
1496	if ($uniq) {	2193	if ($uniq) {
1497	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2194	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1498	$self->_save_objects ($uniq, cf::IO_UNIQUES);	2195	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1499	} else {	2196	} else {
…		…
1505	my ($self) = @_;	2202	my ($self) = @_;
1506		2203
1507	# save first because save cedes	2204	# save first because save cedes
1508	$self->save;	2205	$self->save;
1509		2206
1510	my $lock = cf::lock_acquire "map_data:" . $self->path;	2207	my $lock = cf::lock_acquire "map_data:$self->{path}";
1511		2208
1512	return if $self->players;	2209	return if $self->players;
1513	return if $self->in_memory != cf::MAP_IN_MEMORY;	2210	return if $self->in_memory != cf::MAP_ACTIVE;
1514	return if $self->{deny_save};	2211	return if $self->{deny_save};
1515		2212
		2213	$self->in_memory (cf::MAP_SWAPPED);
		2214
		2215	$self->deactivate;
		2216	$_->clear_links_to ($self) for values %cf::MAP;
1516	$self->clear;	2217	$self->clear;
1517	$self->in_memory (cf::MAP_SWAPPED);
1518	}	2218	}
1519		2219
1520	sub reset_at {	2220	sub reset_at {
1521	my ($self) = @_;	2221	my ($self) = @_;
1522		2222
1523	# TODO: safety, remove and allow resettable per-player maps	2223	# TODO: safety, remove and allow resettable per-player maps
1524	return 1e99 if $self->isa ("ext::map_per_player");#d#
1525	return 1e99 if $self->{deny_reset};	2224	return 1e99 if $self->{deny_reset};
1526		2225
1527	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2226	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1528	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;
1529		2228
…		…
1540	my ($self) = @_;	2239	my ($self) = @_;
1541		2240
1542	my $lock = cf::lock_acquire "map_data:$self->{path}";	2241	my $lock = cf::lock_acquire "map_data:$self->{path}";
1543		2242
1544	return if $self->players;	2243	return if $self->players;
1545	return if $self->isa ("ext::map_per_player");#d#
1546		2244
1547	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	}
1548		2256
1549	delete $cf::MAP{$self->path};	2257	delete $cf::MAP{$self->path};
1550		2258
1551	$self->in_memory (cf::MAP_SWAPPED);	2259	$self->deactivate;
		2260	$_->clear_links_to ($self) for values %cf::MAP;
1552	$self->clear;	2261	$self->clear;
1553
1554	$_->clear_links_to ($self) for values %cf::MAP;
1555		2262
1556	$self->unlink_save;	2263	$self->unlink_save;
1557	$self->destroy;	2264	$self->destroy;
1558	}	2265	}
1559		2266
1560	my $nuke_counter = "aaaa";	2267	my $nuke_counter = "aaaa";
1561		2268
1562	sub nuke {	2269	sub nuke {
1563	my ($self) = @_;	2270	my ($self) = @_;
1564		2271
		2272	{
		2273	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2274
1565	delete $cf::MAP{$self->path};	2275	delete $cf::MAP{$self->path};
1566		2276
1567	$self->unlink_save;	2277	$self->unlink_save;
1568		2278
1569	bless $self, "cf::map";	2279	bless $self, "cf::map";
1570	delete $self->{deny_reset};	2280	delete $self->{deny_reset};
1571	$self->{deny_save} = 1;	2281	$self->{deny_save} = 1;
1572	$self->reset_timeout (1);	2282	$self->reset_timeout (1);
1573	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2283	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1574		2284
1575	$cf::MAP{$self->path} = $self;	2285	$cf::MAP{$self->path} = $self;
		2286	}
1576		2287
1577	$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	]
1578	}	2325	}
1579		2326
1580	=item cf::map::unique_maps	2327	=item cf::map::unique_maps
1581		2328
1582	Returns an arrayref of paths of all shared maps that have	2329	Returns an arrayref of paths of all shared maps that have
1583	instantiated unique items. May block.	2330	instantiated unique items. May block.
1584		2331
1585	=cut	2332	=cut
1586		2333
1587	sub unique_maps() {	2334	sub unique_maps() {
1588	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2335	[
1589	or return;	2336	map {
1590
1591	my @paths;
1592
1593	for (@$files) {
1594	utf8::decode $_;	2337	utf8::decode $_;
1595	next if /\.pst$/;	2338	s/\.map$//; # TODO future compatibility hack
1596	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	}
1597		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 excluding F</styles> and F</editor>). May
		2350	block.
		2351
		2352	=cut
		2353
		2354	sub static_maps() {
		2355	my @dirs = "";
		2356	my @maps;
		2357
		2358	while (@dirs) {
		2359	my $dir = shift @dirs;
		2360
		2361	next if $dir eq "/styles" || $dir eq "/editor";
		2362
		2363	my ($dirs, $files) = Coro::AIO::aio_scandir "$MAPDIR$dir", 2
		2364	or return;
		2365
		2366	for (@$files) {
1598	s/\.map$//;	2367	s/\.map$// or next;
1599	push @paths, $_;	2368	utf8::decode $_;
1600	}	2369	push @maps, "$dir/$_";
		2370	}
1601		2371
1602	\@paths	2372	push @dirs, map "$dir/$_", @$dirs;
1603	}	2373	}
1604		2374
1605	package cf;	2375	\@maps
		2376	}
1606		2377
1607	=back	2378	=back
1608		2379
1609	=head3 cf::object	2380	=head3 cf::object
1610		2381
…		…
1614		2385
1615	=over 4	2386	=over 4
1616		2387
1617	=item $ob->inv_recursive	2388	=item $ob->inv_recursive
1618		2389
1619	Returns the inventory of the object _and_ their inventories, recursively.	2390	Returns the inventory of the object I<and> their inventories, recursively,
		2391	but I<not> the object itself.
1620		2392
1621	=cut	2393	=cut
1622		2394
1623	sub inv_recursive_;	2395	sub inv_recursive_;
1624	sub inv_recursive_ {	2396	sub inv_recursive_ {
…		…
1627		2399
1628	sub inv_recursive {	2400	sub inv_recursive {
1629	inv_recursive_ inv $_[0]	2401	inv_recursive_ inv $_[0]
1630	}	2402	}
1631		2403
		2404	=item $ref = $ob->ref
		2405
		2406	Creates and returns a persistent reference to an object that can be stored as a string.
		2407
		2408	=item $ob = cf::object::deref ($refstring)
		2409
		2410	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2411	even if the object actually exists. May block.
		2412
		2413	=cut
		2414
		2415	sub deref {
		2416	my ($ref) = @_;
		2417
		2418	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2419	my ($uuid, $name) = ($1, $2);
		2420	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2421	or return;
		2422	$pl->ob->uuid eq $uuid
		2423	or return;
		2424
		2425	$pl->ob
		2426	} else {
		2427	warn "$ref: cannot resolve object reference\n";
		2428	undef
		2429	}
		2430	}
		2431
1632	package cf;	2432	package cf;
1633		2433
1634	=back	2434	=back
1635		2435
1636	=head3 cf::object::player	2436	=head3 cf::object::player
…		…
1642	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	2442	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
1643	can be C<undef>. Does the right thing when the player is currently in a	2443	can be C<undef>. Does the right thing when the player is currently in a
1644	dialogue with the given NPC character.	2444	dialogue with the given NPC character.
1645		2445
1646	=cut	2446	=cut
		2447
		2448	our $SAY_CHANNEL = {
		2449	id => "say",
		2450	title => "Map",
		2451	reply => "say ",
		2452	tooltip => "Things said to and replied from NPCs near you and other players on the same map only.",
		2453	};
		2454
		2455	our $CHAT_CHANNEL = {
		2456	id => "chat",
		2457	title => "Chat",
		2458	reply => "chat ",
		2459	tooltip => "Player chat and shouts, global to the server.",
		2460	};
1647		2461
1648	# rough implementation of a future "reply" method that works	2462	# rough implementation of a future "reply" method that works
1649	# with dialog boxes.	2463	# with dialog boxes.
1650	#TODO: the first argument must go, split into a $npc->reply_to ( method	2464	#TODO: the first argument must go, split into a $npc->reply_to ( method
1651	sub cf::object::player::reply($$$;$) {	2465	sub cf::object::player::reply($$$;$) {
…		…
1653		2467
1654	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2468	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1655		2469
1656	if ($self->{record_replies}) {	2470	if ($self->{record_replies}) {
1657	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2471	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2472
1658	} else {	2473	} else {
		2474	my $pl = $self->contr;
		2475
		2476	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2477	my $dialog = $pl->{npc_dialog};
		2478	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2479
		2480	} else {
1659	$msg = $npc->name . " says: $msg" if $npc;	2481	$msg = $npc->name . " says: $msg" if $npc;
1660	$self->message ($msg, $flags);	2482	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2483	}
1661	}	2484	}
		2485	}
		2486
		2487	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2488
		2489	=cut
		2490
		2491	sub cf::object::send_msg {
		2492	my $pl = shift->contr
		2493	or return;
		2494	$pl->send_msg (@_);
1662	}	2495	}
1663		2496
1664	=item $player_object->may ("access")	2497	=item $player_object->may ("access")
1665		2498
1666	Returns wether the given player is authorized to access resource "access"	2499	Returns wether the given player is authorized to access resource "access"
…		…
1679		2512
1680	=item $player_object->enter_link	2513	=item $player_object->enter_link
1681		2514
1682	Freezes the player and moves him/her to a special map (C<{link}>).	2515	Freezes the player and moves him/her to a special map (C<{link}>).
1683		2516
1684	The player should be reasonably safe there for short amounts of time. You	2517	The player should be reasonably safe there for short amounts of time (e.g.
1685	I<MUST> call C<leave_link> as soon as possible, though.	2518	for loading a map). You I<MUST> call C<leave_link> as soon as possible,
		2519	though, as the palyer cannot control the character while it is on the link
		2520	map.
1686		2521
1687	Will never block.	2522	Will never block.
1688		2523
1689	=item $player_object->leave_link ($map, $x, $y)	2524	=item $player_object->leave_link ($map, $x, $y)
1690		2525
…		…
1698	=cut	2533	=cut
1699		2534
1700	sub link_map {	2535	sub link_map {
1701	unless ($LINK_MAP) {	2536	unless ($LINK_MAP) {
1702	$LINK_MAP = cf::map::find "{link}"	2537	$LINK_MAP = cf::map::find "{link}"
1703	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };	2538	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1704	$LINK_MAP->load;	2539	$LINK_MAP->load;
1705	}	2540	}
1706		2541
1707	$LINK_MAP	2542	$LINK_MAP
1708	}	2543	}
…		…
1713	$self->deactivate_recursive;	2548	$self->deactivate_recursive;
1714		2549
1715	return if UNIVERSAL::isa $self->map, "ext::map_link";	2550	return if UNIVERSAL::isa $self->map, "ext::map_link";
1716		2551
1717	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2552	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1718	if $self->map;	2553	if $self->map && $self->map->{path} ne "{link}";
1719		2554
1720	$self->enter_map ($LINK_MAP || link_map, 20, 20);	2555	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1721	}	2556	}
1722		2557
1723	sub cf::object::player::leave_link {	2558	sub cf::object::player::leave_link {
1724	my ($self, $map, $x, $y) = @_;	2559	my ($self, $map, $x, $y) = @_;
		2560
		2561	return unless $self->contr->active;
1725		2562
1726	my $link_pos = delete $self->{_link_pos};	2563	my $link_pos = delete $self->{_link_pos};
1727		2564
1728	unless ($map) {	2565	unless ($map) {
1729	# restore original map position	2566	# restore original map position
…		…
1740	($x, $y) = (-1, -1)	2577	($x, $y) = (-1, -1)
1741	unless (defined $x) && (defined $y);	2578	unless (defined $x) && (defined $y);
1742		2579
1743	# use -1 or undef as default coordinates, not 0, 0	2580	# use -1 or undef as default coordinates, not 0, 0
1744	($x, $y) = ($map->enter_x, $map->enter_y)	2581	($x, $y) = ($map->enter_x, $map->enter_y)
1745	if $x <=0 && $y <= 0;	2582	if $x <= 0 && $y <= 0;
1746		2583
1747	$map->load;	2584	$map->load;
1748	$map->load_diag;	2585	$map->load_neighbours;
1749		2586
1750	return unless $self->contr->active;	2587	return unless $self->contr->active;
		2588
		2589	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
		2590	$self->enter_map ($map, $x, $y);
		2591
		2592	# only activate afterwards, to support waiting in hooks
1751	$self->activate_recursive;	2593	$self->activate_recursive;
1752	$self->enter_map ($map, $x, $y);
1753	}	2594	}
1754		2595
1755	cf::player->attach (	2596	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1756	on_logout => sub {
1757	my ($pl) = @_;
1758		2597
1759	# abort map switching before logout	2598	Moves the player to the given map-path and coordinates by first freezing
1760	if ($pl->ob->{_link_pos}) {	2599	her, loading and preparing them map, calling the provided $check callback
1761	cf::sync_job {	2600	that has to return the map if sucecssful, and then unfreezes the player on
1762	$pl->ob->leave_link	2601	the new (success) or old (failed) map position. In either case, $done will
1763	};	2602	be called at the end of this process.
1764	}
1765	},
1766	on_login => sub {
1767	my ($pl) = @_;
1768		2603
1769	# try to abort aborted map switching on player login :)	2604	Note that $check will be called with a potentially non-loaded map, so if
1770	# should happen only on crashes	2605	it needs a loaded map it has to call C<< ->load >>.
1771	if ($pl->ob->{_link_pos}) {
1772	$pl->ob->enter_link;
1773	(async {
1774	# we need this sleep as the login has a concurrent enter_exit running
1775	# and this sleep increases chances of the player not ending up in scorn
1776	$pl->ob->reply (undef,
1777	"There was an internal problem at your last logout, "
1778	. "the server will try to bring you to your intended destination in a second.",
1779	cf::NDI_RED);
1780	Coro::Timer::sleep 1;
1781	$pl->ob->leave_link;
1782	})->prio (2);
1783	}
1784	},
1785	);
1786		2606
1787	=item $player_object->goto ($path, $x, $y)
1788
1789	=cut	2607	=cut
		2608
		2609	our $GOTOGEN;
1790		2610
1791	sub cf::object::player::goto {	2611	sub cf::object::player::goto {
1792	my ($self, $path, $x, $y) = @_;	2612	my ($self, $path, $x, $y, $check, $done) = @_;
		2613
		2614	# do generation counting so two concurrent goto's will be executed in-order
		2615	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1793		2616
1794	$self->enter_link;	2617	$self->enter_link;
1795		2618
1796	(async {	2619	(async {
1797	my $map = cf::map::find $path;	2620	$Coro::current->{desc} = "player::goto $path $x $y";
		2621
		2622	# *tag paths override both path and x|y
		2623	if ($path =~ /^\*(.*)$/) {
		2624	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2625	my $ob = $obs[rand @obs];
		2626
		2627	# see if we actually can go there
		2628	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2629	$ob = $obs[rand @obs];
		2630	} else {
		2631	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2632	}
		2633	# else put us there anyways for now #d#
		2634
		2635	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2636	} else {
		2637	($path, $x, $y) = (undef, undef, undef);
		2638	}
		2639	}
		2640
		2641	my $map = eval {
		2642	my $map = defined $path ? cf::map::find $path : undef;
		2643
		2644	if ($map) {
1798	$map = $map->customise_for ($self) if $map;	2645	$map = $map->customise_for ($self);
1799		2646	$map = $check->($map) if $check && $map;
1800	# warn "entering ", $map->path, " at ($x, $y)\n"	2647	} else {
1801	# if $map;
1802
1803	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2648	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2649	}
1804		2650
		2651	$map
		2652	};
		2653
		2654	if ($@) {
		2655	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2656	LOG llevError | logBacktrace, Carp::longmess $@;
		2657	}
		2658
		2659	if ($gen == $self->{_goto_generation}) {
		2660	delete $self->{_goto_generation};
1805	$self->leave_link ($map, $x, $y);	2661	$self->leave_link ($map, $x, $y);
		2662	}
		2663
		2664	$done->() if $done;
1806	})->prio (1);	2665	})->prio (1);
1807	}	2666	}
1808		2667
1809	=item $player_object->enter_exit ($exit_object)	2668	=item $player_object->enter_exit ($exit_object)
1810		2669
…		…
1830	}	2689	}
1831		2690
1832	sub prepare_random_map {	2691	sub prepare_random_map {
1833	my ($exit) = @_;	2692	my ($exit) = @_;
1834		2693
1835	my $guard = cf::lock_acquire "exit_prepare:$exit";
1836
1837	# all this does is basically replace the /! path by	2694	# all this does is basically replace the /! path by
1838	# a new random map path (?random/...) with a seed	2695	# a new random map path (?random/...) with a seed
1839	# that depends on the exit object	2696	# that depends on the exit object
1840		2697
1841	my $rmp = parse_random_map_params $exit->msg;	2698	my $rmp = parse_random_map_params $exit->msg;
1842		2699
1843	if ($exit->map) {	2700	if ($exit->map) {
1844	$rmp->{region} = $exit->map->region_name;	2701	$rmp->{region} = $exit->region->name;
1845	$rmp->{origin_map} = $exit->map->path;	2702	$rmp->{origin_map} = $exit->map->path;
1846	$rmp->{origin_x} = $exit->x;	2703	$rmp->{origin_x} = $exit->x;
1847	$rmp->{origin_y} = $exit->y;	2704	$rmp->{origin_y} = $exit->y;
		2705
		2706	$exit->map->touch;
1848	}	2707	}
1849		2708
1850	$rmp->{random_seed} ||= $exit->random_seed;	2709	$rmp->{random_seed} ||= $exit->random_seed;
1851		2710
1852	my $data = cf::to_json $rmp;	2711	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1853	my $md5 = Digest::MD5::md5_hex $data;	2712	my $md5 = Digest::MD5::md5_hex $data;
1854	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2713	my $meta = "$RANDOMDIR/$md5.meta";
1855		2714
1856	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2715	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1857	aio_write $fh, 0, (length $data), $data, 0;	2716	aio_write $fh, 0, (length $data), $data, 0;
1858	undef $fh;	2717	undef $fh;
1859	aio_rename "$meta~", $meta;	2718	aio_rename "$meta~", $meta;
1860		2719
		2720	my $slaying = "?random/$md5";
		2721
		2722	if ($exit->valid) {
1861	$exit->slaying ("?random/$md5");	2723	$exit->slaying ("?random/$md5");
1862	$exit->msg (undef);	2724	$exit->msg (undef);
		2725	}
1863	}	2726	}
1864	}	2727	}
1865		2728
1866	sub cf::object::player::enter_exit {	2729	sub cf::object::player::enter_exit {
1867	my ($self, $exit) = @_;	2730	my ($self, $exit) = @_;
…		…
1869	return unless $self->type == cf::PLAYER;	2732	return unless $self->type == cf::PLAYER;
1870		2733
1871	$self->enter_link;	2734	$self->enter_link;
1872		2735
1873	(async {	2736	(async {
1874	$self->deactivate_recursive; # just to be sure	2737	$Coro::current->{desc} = "enter_exit";
		2738
1875	unless (eval {	2739	unless (eval {
		2740	$self->deactivate_recursive; # just to be sure
		2741
		2742	# random map handling
		2743	{
		2744	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2745
1876	prepare_random_map $exit	2746	prepare_random_map $exit
1877	if $exit->slaying eq "/!";	2747	if $exit->slaying eq "/!";
		2748	}
1878		2749
1879	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;	2750	my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1880	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);	2751	my $x = $exit->stats->hp;
		2752	my $y = $exit->stats->sp;
1881		2753
		2754	$self->goto ($map, $x, $y);
		2755
		2756	# if exit is damned, update players death & WoR home-position
		2757	$self->contr->savebed ($map, $x, $y)
		2758	if $exit->flag (cf::FLAG_DAMNED);
		2759
1882	1;	2760	1
1883	}) {	2761	}) {
1884	$self->message ("Something went wrong deep within the crossfire server. "	2762	$self->message ("Something went wrong deep within the deliantra server. "
1885	. "I'll try to bring you back to the map you were before. "	2763	. "I'll try to bring you back to the map you were before. "
1886	. "Please report this to the dungeon master!",	2764	. "Please report this to the dungeon master!",
1887	cf::NDI_UNIQUE | cf::NDI_RED);	2765	cf::NDI_UNIQUE | cf::NDI_RED);
1888		2766
1889	warn "ERROR in enter_exit: $@";	2767	warn "ERROR in enter_exit: $@";
1890	$self->leave_link;	2768	$self->leave_link;
1891	}	2769	}
1892	})->prio (1);	2770	})->prio (1);
…		…
1905		2783
1906	sub cf::client::send_drawinfo {	2784	sub cf::client::send_drawinfo {
1907	my ($self, $text, $flags) = @_;	2785	my ($self, $text, $flags) = @_;
1908		2786
1909	utf8::encode $text;	2787	utf8::encode $text;
1910	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2788	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1911	}	2789	}
1912		2790
		2791	=item $client->send_big_packet ($pkt)
		2792
		2793	Like C<send_packet>, but tries to compress large packets, and fragments
		2794	them as required.
		2795
		2796	=cut
		2797
		2798	our $MAXFRAGSIZE = cf::MAXSOCKBUF - 64;
		2799
		2800	sub cf::client::send_big_packet {
		2801	my ($self, $pkt) = @_;
		2802
		2803	# try lzf for large packets
		2804	$pkt = "lzf " . Compress::LZF::compress $pkt
		2805	if 1024 <= length $pkt and $self->{can_lzf};
		2806
		2807	# split very large packets
		2808	if ($MAXFRAGSIZE < length $pkt and $self->{can_lzf}) {
		2809	$self->send_packet ("frag $_") for unpack "(a$MAXFRAGSIZE)*", $pkt;
		2810	$pkt = "frag";
		2811	}
		2812
		2813	$self->send_packet ($pkt);
		2814	}
		2815
		2816	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2817
		2818	Send a drawinfo or msg packet to the client, formatting the msg for the
		2819	client if neccessary. C<$type> should be a string identifying the type of
		2820	the message, with C<log> being the default. If C<$color> is negative, suppress
		2821	the message unless the client supports the msg packet.
		2822
		2823	=cut
		2824
		2825	# non-persistent channels (usually the info channel)
		2826	our %CHANNEL = (
		2827	"c/motd" => {
		2828	id => "infobox",
		2829	title => "MOTD",
		2830	reply => undef,
		2831	tooltip => "The message of the day",
		2832	},
		2833	"c/identify" => {
		2834	id => "infobox",
		2835	title => "Identify",
		2836	reply => undef,
		2837	tooltip => "Items recently identified",
		2838	},
		2839	"c/examine" => {
		2840	id => "infobox",
		2841	title => "Examine",
		2842	reply => undef,
		2843	tooltip => "Signs and other items you examined",
		2844	},
		2845	"c/shopinfo" => {
		2846	id => "infobox",
		2847	title => "Shop Info",
		2848	reply => undef,
		2849	tooltip => "What your bargaining skill tells you about the shop",
		2850	},
		2851	"c/book" => {
		2852	id => "infobox",
		2853	title => "Book",
		2854	reply => undef,
		2855	tooltip => "The contents of a note or book",
		2856	},
		2857	"c/lookat" => {
		2858	id => "infobox",
		2859	title => "Look",
		2860	reply => undef,
		2861	tooltip => "What you saw there",
		2862	},
		2863	"c/who" => {
		2864	id => "infobox",
		2865	title => "Players",
		2866	reply => undef,
		2867	tooltip => "Shows players who are currently online",
		2868	},
		2869	"c/body" => {
		2870	id => "infobox",
		2871	title => "Body Parts",
		2872	reply => undef,
		2873	tooltip => "Shows which body parts you posess and are available",
		2874	},
		2875	"c/statistics" => {
		2876	id => "infobox",
		2877	title => "Statistics",
		2878	reply => undef,
		2879	tooltip => "Shows your primary statistics",
		2880	},
		2881	"c/skills" => {
		2882	id => "infobox",
		2883	title => "Skills",
		2884	reply => undef,
		2885	tooltip => "Shows your experience per skill and item power",
		2886	},
		2887	"c/shopitems" => {
		2888	id => "infobox",
		2889	title => "Shop Items",
		2890	reply => undef,
		2891	tooltip => "Shows the items currently for sale in this shop",
		2892	},
		2893	"c/resistances" => {
		2894	id => "infobox",
		2895	title => "Resistances",
		2896	reply => undef,
		2897	tooltip => "Shows your resistances",
		2898	},
		2899	"c/pets" => {
		2900	id => "infobox",
		2901	title => "Pets",
		2902	reply => undef,
		2903	tooltip => "Shows information abotu your pets/a specific pet",
		2904	},
		2905	"c/perceiveself" => {
		2906	id => "infobox",
		2907	title => "Perceive Self",
		2908	reply => undef,
		2909	tooltip => "You gained detailed knowledge about yourself",
		2910	},
		2911	"c/uptime" => {
		2912	id => "infobox",
		2913	title => "Uptime",
		2914	reply => undef,
		2915	tooltip => "How long the server has been running since last restart",
		2916	},
		2917	"c/mapinfo" => {
		2918	id => "infobox",
		2919	title => "Map Info",
		2920	reply => undef,
		2921	tooltip => "Information related to the maps",
		2922	},
		2923	"c/party" => {
		2924	id => "party",
		2925	title => "Party",
		2926	reply => "gsay ",
		2927	tooltip => "Messages and chat related to your party",
		2928	},
		2929	"c/death" => {
		2930	id => "death",
		2931	title => "Death",
		2932	reply => undef,
		2933	tooltip => "Reason for and more info about your most recent death",
		2934	},
		2935	"c/say" => $SAY_CHANNEL,
		2936	"c/chat" => $CHAT_CHANNEL,
		2937	);
		2938
		2939	sub cf::client::send_msg {
		2940	my ($self, $channel, $msg, $color, @extra) = @_;
		2941
		2942	$msg = $self->pl->expand_cfpod ($msg)
		2943	unless $color & cf::NDI_VERBATIM;
		2944
		2945	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2946
		2947	# check predefined channels, for the benefit of C
		2948	if ($CHANNEL{$channel}) {
		2949	$channel = $CHANNEL{$channel};
		2950
		2951	$self->ext_msg (channel_info => $channel);
		2952	$channel = $channel->{id};
		2953
		2954	} elsif (ref $channel) {
		2955	# send meta info to client, if not yet sent
		2956	unless (exists $self->{channel}{$channel->{id}}) {
		2957	$self->{channel}{$channel->{id}} = $channel;
		2958	$self->ext_msg (channel_info => $channel);
		2959	}
		2960
		2961	$channel = $channel->{id};
		2962	}
		2963
		2964	return unless @extra || length $msg;
		2965
		2966	# default colour, mask it out
		2967	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2968	if $color & cf::NDI_DEF;
		2969
		2970	my $pkt = "msg "
		2971	. $self->{json_coder}->encode (
		2972	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
		2973	);
		2974
		2975	$self->send_big_packet ($pkt);
		2976	}
		2977
		2978	=item $client->ext_msg ($type, @msg)
		2979
		2980	Sends an ext event to the client.
		2981
		2982	=cut
		2983
		2984	sub cf::client::ext_msg($$@) {
		2985	my ($self, $type, @msg) = @_;
		2986
		2987	if ($self->extcmd == 2) {
		2988	$self->send_big_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2989	} elsif ($self->extcmd == 1) { # TODO: remove
		2990	push @msg, msgtype => "event_$type";
		2991	$self->send_big_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2992	}
		2993	}
		2994
		2995	=item $client->ext_reply ($msgid, @msg)
		2996
		2997	Sends an ext reply to the client.
		2998
		2999	=cut
		3000
		3001	sub cf::client::ext_reply($$@) {
		3002	my ($self, $id, @msg) = @_;
		3003
		3004	if ($self->extcmd == 2) {
		3005	$self->send_big_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		3006	} elsif ($self->extcmd == 1) {
		3007	#TODO: version 1, remove
		3008	unshift @msg, msgtype => "reply", msgid => $id;
		3009	$self->send_big_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		3010	}
		3011	}
1913		3012
1914	=item $success = $client->query ($flags, "text", \&cb)	3013	=item $success = $client->query ($flags, "text", \&cb)
1915		3014
1916	Queues a query to the client, calling the given callback with	3015	Queues a query to the client, calling the given callback with
1917	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	3016	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1918	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	3017	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1919		3018
1920	Queries can fail, so check the return code. Or don't, as queries will become	3019	Queries can fail, so check the return code. Or don't, as queries will
1921	reliable at some point in the future.	3020	become reliable at some point in the future.
1922		3021
1923	=cut	3022	=cut
1924		3023
1925	sub cf::client::query {	3024	sub cf::client::query {
1926	my ($self, $flags, $text, $cb) = @_;	3025	my ($self, $flags, $text, $cb) = @_;
…		…
1934	utf8::encode $text;	3033	utf8::encode $text;
1935	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	3034	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1936		3035
1937	$self->send_packet ($self->{query_queue}[0][0])	3036	$self->send_packet ($self->{query_queue}[0][0])
1938	if @{ $self->{query_queue} } == 1;	3037	if @{ $self->{query_queue} } == 1;
		3038
		3039	1
1939	}	3040	}
1940		3041
1941	cf::client->attach (	3042	cf::client->attach (
		3043	on_connect => sub {
		3044	my ($ns) = @_;
		3045
		3046	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		3047	},
1942	on_reply => sub {	3048	on_reply => sub {
1943	my ($ns, $msg) = @_;	3049	my ($ns, $msg) = @_;
1944		3050
1945	# this weird shuffling is so that direct followup queries	3051	# this weird shuffling is so that direct followup queries
1946	# get handled first	3052	# get handled first
1947	my $queue = delete $ns->{query_queue}	3053	my $queue = delete $ns->{query_queue}
1948	or return; # be conservative, not sure how that can happen, but we saw a crash here	3054	or return; # be conservative, not sure how that can happen, but we saw a crash here
1949		3055
1950	(shift @$queue)->[1]->($msg);	3056	(shift @$queue)->[1]->($msg);
		3057	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1951		3058
1952	push @{ $ns->{query_queue} }, @$queue;	3059	push @{ $ns->{query_queue} }, @$queue;
1953		3060
1954	if (@{ $ns->{query_queue} } == @$queue) {	3061	if (@{ $ns->{query_queue} } == @$queue) {
1955	if (@$queue) {	3062	if (@$queue) {
…		…
1957	} else {	3064	} else {
1958	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3065	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1959	}	3066	}
1960	}	3067	}
1961	},	3068	},
		3069	on_exticmd => sub {
		3070	my ($ns, $buf) = @_;
		3071
		3072	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		3073
		3074	if (ref $msg) {
		3075	my ($type, $reply, @payload) =
		3076	"ARRAY" eq ref $msg
		3077	? @$msg
		3078	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		3079
		3080	my @reply;
		3081
		3082	if (my $cb = $EXTICMD{$type}) {
		3083	@reply = $cb->($ns, @payload);
		3084	}
		3085
		3086	$ns->ext_reply ($reply, @reply)
		3087	if $reply;
		3088
		3089	} else {
		3090	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		3091	}
		3092
		3093	cf::override;
		3094	},
1962	);	3095	);
1963		3096
1964	=item $client->async (\&cb)	3097	=item $client->async (\&cb)
1965		3098
1966	Create a new coroutine, running the specified callback. The coroutine will	3099	Create a new coroutine, running the specified callback. The coroutine will
…		…
2007	our $safe = new Safe "safe";	3140	our $safe = new Safe "safe";
2008	our $safe_hole = new Safe::Hole;	3141	our $safe_hole = new Safe::Hole;
2009		3142
2010	$SIG{FPE} = 'IGNORE';	3143	$SIG{FPE} = 'IGNORE';
2011		3144
2012	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3145	$safe->permit_only (Opcode::opset qw(
		3146	:base_core :base_mem :base_orig :base_math :base_loop
		3147	grepstart grepwhile mapstart mapwhile
		3148	sort time
		3149	));
2013		3150
2014	# here we export the classes and methods available to script code	3151	# here we export the classes and methods available to script code
2015		3152
2016	=pod	3153	=pod
2017		3154
2018	The following fucntions and emthods are available within a safe environment:	3155	The following functions and methods are available within a safe environment:
2019		3156
2020	cf::object contr pay_amount pay_player map	3157	cf::object
		3158	contr pay_amount pay_player map x y force_find force_add destroy
		3159	insert remove name archname title slaying race decrease split
		3160	value
		3161
2021	cf::object::player player	3162	cf::object::player
2022	cf::player peaceful	3163	player
2023	cf::map trigger	3164
		3165	cf::player
		3166	peaceful
		3167
		3168	cf::map
		3169	trigger
2024		3170
2025	=cut	3171	=cut
2026		3172
2027	for (	3173	for (
2028	["cf::object" => qw(contr pay_amount pay_player map)],	3174	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3175	insert remove inv nrof name archname title slaying race
		3176	decrease split destroy change_exp value msg lore send_msg)],
2029	["cf::object::player" => qw(player)],	3177	["cf::object::player" => qw(player)],
2030	["cf::player" => qw(peaceful)],	3178	["cf::player" => qw(peaceful send_msg)],
2031	["cf::map" => qw(trigger)],	3179	["cf::map" => qw(trigger)],
2032	) {	3180	) {
2033	no strict 'refs';	3181	no strict 'refs';
2034	my ($pkg, @funs) = @$_;	3182	my ($pkg, @funs) = @$_;
2035	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3183	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
…		…
2052	my ($code, %vars) = @_;	3200	my ($code, %vars) = @_;
2053		3201
2054	my $qcode = $code;	3202	my $qcode = $code;
2055	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3203	$qcode =~ s/"/‟/g; # not allowed in #line filenames
2056	$qcode =~ s/\n/\\n/g;	3204	$qcode =~ s/\n/\\n/g;
		3205
		3206	%vars = (_dummy => 0) unless %vars;
2057		3207
2058	local $_;	3208	local $_;
2059	local @safe::cf::_safe_eval_args = values %vars;	3209	local @safe::cf::_safe_eval_args = values %vars;
2060		3210
2061	my $eval =	3211	my $eval =
…		…
2104	=back	3254	=back
2105		3255
2106	=cut	3256	=cut
2107		3257
2108	#############################################################################	3258	#############################################################################
		3259	# the server's init and main functions
2109		3260
2110	=head2 EXTENSION DATABASE SUPPORT	3261	sub load_facedata($) {
		3262	my ($path) = @_;
2111		3263
2112	Crossfire maintains a very simple database for extension use. It can	3264	# HACK to clear player env face cache, we need some signal framework
2113	currently store anything that can be serialised using Storable, which	3265	# for this (global event?)
2114	excludes objects.	3266	%ext::player_env::MUSIC_FACE_CACHE = ();
2115		3267
2116	The parameter C<$family> should best start with the name of the extension	3268	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2117	using it, it should be unique.
2118		3269
2119	=over 4	3270	warn "loading facedata from $path\n";
2120		3271
2121	=item $hashref = cf::db_get $family	3272	my $facedata;
		3273	0 < aio_load $path, $facedata
		3274	or die "$path: $!";
2122		3275
2123	Return a hashref for use by the extension C<$family>, which can be	3276	$facedata = Coro::Storable::thaw $facedata;
2124	modified. After modifications, you have to call C<cf::db_dirty> or
2125	C<cf::db_sync>.
2126		3277
2127	=item $value = cf::db_get $family => $key	3278	$facedata->{version} == 2
		3279	or cf::cleanup "$path: version mismatch, cannot proceed.";
2128		3280
2129	Returns a single value from the database	3281	# patch in the exptable
2130		3282	$facedata->{resource}{"res/exp_table"} = {
2131	=item cf::db_put $family => $hashref	3283	type => FT_RSRC,
2132		3284	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2133	Stores the given family hashref into the database. Updates are delayed, if
2134	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2135
2136	=item cf::db_put $family => $key => $value
2137
2138	Stores the given C<$value> in the family hash. Updates are delayed, if you
2139	want the data to be synced to disk immediately, use C<cf::db_sync>.
2140
2141	=item cf::db_dirty
2142
2143	Marks the database as dirty, to be updated at a later time.
2144
2145	=item cf::db_sync
2146
2147	Immediately write the database to disk I<if it is dirty>.
2148
2149	=cut
2150
2151	our $DB;
2152
2153	{
2154	my $path = cf::localdir . "/database.pst";
2155
2156	sub db_load() {
2157	$DB = stat $path ? Storable::retrieve $path : { };
2158	}
2159
2160	my $pid;
2161
2162	sub db_save() {
2163	waitpid $pid, 0 if $pid;
2164	if (0 == ($pid = fork)) {
2165	$DB->{_meta}{version} = 1;
2166	Storable::nstore $DB, "$path~";
2167	rename "$path~", $path;
2168	cf::_exit 0 if defined $pid;
2169	}
2170	}
2171
2172	my $dirty;
2173
2174	sub db_sync() {
2175	db_save if $dirty;
2176	undef $dirty;
2177	}
2178
2179	my $idle = Event->idle (min => 10, max => 20, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2180	db_sync;
2181	});	3285	};
		3286	cf::cede_to_tick;
2182		3287
2183	sub db_dirty() {
2184	$dirty = 1;
2185	$idle->start;
2186	}	3288	{
		3289	my $faces = $facedata->{faceinfo};
2187		3290
2188	sub db_get($;$) {	3291	while (my ($face, $info) = each %$faces) {
2189	@_ >= 2	3292	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2190	? $DB->{$_[0]}{$_[1]}
2191	: ($DB->{$_[0]} ||= { })
2192	}
2193		3293
2194	sub db_put($$;$) {	3294	cf::face::set_visibility $idx, $info->{visibility};
2195	if (@_ >= 3) {	3295	cf::face::set_magicmap $idx, $info->{magicmap};
2196	$DB->{$_[0]}{$_[1]} = $_[2];	3296	cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
2197	} else {	3297	cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
2198	$DB->{$_[0]} = $_[1];
2199	}
2200	db_dirty;
2201	}
2202		3298
2203	cf::global->attach (	3299	cf::cede_to_tick;
2204	prio => 10000,
2205	on_cleanup => sub {
2206	db_sync;
2207	},	3300	}
2208	);
2209	}
2210		3301
2211	#############################################################################	3302	while (my ($face, $info) = each %$faces) {
2212	# the server's main()	3303	next unless $info->{smooth};
2213		3304
2214	sub cfg_load {	3305	my $idx = cf::face::find $face
		3306	or next;
		3307
		3308	if (my $smooth = cf::face::find $info->{smooth}) {
		3309	cf::face::set_smooth $idx, $smooth;
		3310	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3311	} else {
		3312	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3313	}
		3314
		3315	cf::cede_to_tick;
		3316	}
		3317	}
		3318
		3319	{
		3320	my $anims = $facedata->{animinfo};
		3321
		3322	while (my ($anim, $info) = each %$anims) {
		3323	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3324	cf::cede_to_tick;
		3325	}
		3326
		3327	cf::anim::invalidate_all; # d'oh
		3328	}
		3329
		3330	{
		3331	my $res = $facedata->{resource};
		3332
		3333	while (my ($name, $info) = each %$res) {
		3334	if (defined $info->{type}) {
		3335	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3336
		3337	cf::face::set_data $idx, 0, $info->{data}, $info->{hash};
		3338	cf::face::set_type $idx, $info->{type};
		3339	} else {
		3340	$RESOURCE{$name} = $info;
		3341	}
		3342
		3343	cf::cede_to_tick;
		3344	}
		3345	}
		3346
		3347	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3348
		3349	1
		3350	}
		3351
		3352	cf::global->attach (on_resource_update => sub {
		3353	if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
		3354	$soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
		3355
		3356	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3357	my $sound = $soundconf->{compat}[$_]
		3358	or next;
		3359
		3360	my $face = cf::face::find "sound/$sound->[1]";
		3361	cf::sound::set $sound->[0] => $face;
		3362	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3363	}
		3364
		3365	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3366	my $face = cf::face::find "sound/$v";
		3367	cf::sound::set $k => $face;
		3368	}
		3369	}
		3370	});
		3371
		3372	register_exticmd fx_want => sub {
		3373	my ($ns, $want) = @_;
		3374
		3375	while (my ($k, $v) = each %$want) {
		3376	$ns->fx_want ($k, $v);
		3377	}
		3378	};
		3379
		3380	sub load_resource_file($) {
		3381	my $guard = lock_acquire "load_resource_file";
		3382
		3383	my $status = load_resource_file_ $_[0];
		3384	get_slot 0.1, 100;
		3385	cf::arch::commit_load;
		3386
		3387	$status
		3388	}
		3389
		3390	sub reload_regions {
		3391	# HACK to clear player env face cache, we need some signal framework
		3392	# for this (global event?)
		3393	%ext::player_env::MUSIC_FACE_CACHE = ();
		3394
		3395	load_resource_file "$MAPDIR/regions"
		3396	or die "unable to load regions file\n";
		3397
		3398	for (cf::region::list) {
		3399	$_->{match} = qr/$_->{match}/
		3400	if exists $_->{match};
		3401	}
		3402	}
		3403
		3404	sub reload_facedata {
		3405	load_facedata "$DATADIR/facedata"
		3406	or die "unable to load facedata\n";
		3407	}
		3408
		3409	sub reload_archetypes {
		3410	load_resource_file "$DATADIR/archetypes"
		3411	or die "unable to load archetypes\n";
		3412	}
		3413
		3414	sub reload_treasures {
		3415	load_resource_file "$DATADIR/treasures"
		3416	or die "unable to load treasurelists\n";
		3417	}
		3418
		3419	sub reload_resources {
		3420	warn "reloading resource files...\n";
		3421
		3422	reload_facedata;
		3423	reload_archetypes;
		3424	reload_regions;
		3425	reload_treasures;
		3426
		3427	warn "finished reloading resource files\n";
		3428	}
		3429
		3430	sub reload_config {
		3431	warn "reloading config file...\n";
		3432
2215	open my $fh, "<:utf8", cf::confdir . "/config"	3433	open my $fh, "<:utf8", "$CONFDIR/config"
2216	or return;	3434	or return;
2217		3435
2218	local $/;	3436	local $/;
2219	*CFG = YAML::Syck::Load <$fh>;	3437	*CFG = YAML::XS::Load scalar <$fh>;
2220		3438
2221	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3439	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2222		3440
2223	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	3441	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2224	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};	3442	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
…		…
2228	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"	3446	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2229	and die "WARNING: m(un)lockall failed: $!\n";	3447	and die "WARNING: m(un)lockall failed: $!\n";
2230	};	3448	};
2231	warn $@ if $@;	3449	warn $@ if $@;
2232	}	3450	}
		3451
		3452	warn "finished reloading resource files\n";
		3453	}
		3454
		3455	sub pidfile() {
		3456	sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
		3457	or die "$PIDFILE: $!";
		3458	flock $fh, &Fcntl::LOCK_EX
		3459	or die "$PIDFILE: flock: $!";
		3460	$fh
		3461	}
		3462
		3463	# make sure only one server instance is running at any one time
		3464	sub atomic {
		3465	my $fh = pidfile;
		3466
		3467	my $pid = <$fh>;
		3468	kill 9, $pid if $pid > 0;
		3469
		3470	seek $fh, 0, 0;
		3471	print $fh $$;
		3472	}
		3473
		3474	sub main_loop {
		3475	warn "EV::loop starting\n";
		3476	if (1) {
		3477	EV::loop;
		3478	}
		3479	warn "EV::loop returned\n";
		3480	goto &main_loop unless $REALLY_UNLOOP;
2233	}	3481	}
2234		3482
2235	sub main {	3483	sub main {
		3484	cf::init_globals; # initialise logging
		3485
		3486	LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
		3487	LOG llevInfo, "Copyright (C) 2005-2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
		3488	LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
		3489	LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
		3490
		3491	cf::init_experience;
		3492	cf::init_anim;
		3493	cf::init_attackmess;
		3494	cf::init_dynamic;
		3495
		3496	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3497
2236	# we must not ever block the main coroutine	3498	# we must not ever block the main coroutine
2237	local $Coro::idle = sub {	3499	local $Coro::idle = sub {
2238	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3500	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2239	(async {	3501	(async {
2240	Event::one_event;	3502	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3503	EV::loop EV::LOOP_ONESHOT;
2241	})->prio (Coro::PRIO_MAX);	3504	})->prio (Coro::PRIO_MAX);
2242	};	3505	};
2243		3506
2244	cfg_load;	3507	evthread_start IO::AIO::poll_fileno;
2245	db_load;	3508
		3509	cf::sync_job {
		3510	cf::load_settings;
		3511	cf::load_materials;
		3512
		3513	reload_resources;
		3514	reload_config;
		3515	db_init;
		3516
		3517	cf::init_uuid;
		3518	cf::init_signals;
		3519	cf::init_commands;
		3520	cf::init_skills;
		3521
		3522	cf::init_beforeplay;
		3523
		3524	atomic;
		3525
2246	load_extensions;	3526	load_extensions;
2247		3527
2248	$TICK_WATCHER->start;	3528	utime time, time, $RUNTIMEFILE;
2249	Event::loop;	3529
		3530	# no (long-running) fork's whatsoever before this point(!)
		3531	use POSIX ();
		3532	POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
		3533
		3534	(pop @POST_INIT)->(0) while @POST_INIT;
		3535	};
		3536
		3537	main_loop;
2250	}	3538	}
2251		3539
2252	#############################################################################	3540	#############################################################################
2253	# initialisation and cleanup	3541	# initialisation and cleanup
2254		3542
2255	# install some emergency cleanup handlers	3543	# install some emergency cleanup handlers
2256	BEGIN {	3544	BEGIN {
		3545	our %SIGWATCHER = ();
2257	for my $signal (qw(INT HUP TERM)) {	3546	for my $signal (qw(INT HUP TERM)) {
2258	Event->signal (	3547	$SIGWATCHER{$signal} = EV::signal $signal, sub {
2259	data => WF_AUTOCANCEL,
2260	signal => $signal,
2261	cb => sub {
2262	cf::cleanup "SIG$signal";	3548	cf::cleanup "SIG$signal";
2263	},
2264	);	3549	};
		3550	}
		3551	}
		3552
		3553	sub write_runtime_sync {
		3554	# first touch the runtime file to show we are still running:
		3555	# the fsync below can take a very very long time.
		3556
		3557	IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
		3558
		3559	my $guard = cf::lock_acquire "write_runtime";
		3560
		3561	my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT, 0644
		3562	or return;
		3563
		3564	my $value = $cf::RUNTIME + 90 + 10;
		3565	# 10 is the runtime save interval, for a monotonic clock
		3566	# 60 allows for the watchdog to kill the server.
		3567
		3568	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3569	and return;
		3570
		3571	# always fsync - this file is important
		3572	aio_fsync $fh
		3573	and return;
		3574
		3575	# touch it again to show we are up-to-date
		3576	aio_utime $fh, undef, undef;
		3577
		3578	close $fh
		3579	or return;
		3580
		3581	aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
		3582	and return;
		3583
		3584	warn "runtime file written.\n";
		3585
2265	}	3586	1
		3587	}
		3588
		3589	our $uuid_lock;
		3590	our $uuid_skip;
		3591
		3592	sub write_uuid_sync($) {
		3593	$uuid_skip ||= $_[0];
		3594
		3595	return if $uuid_lock;
		3596	local $uuid_lock = 1;
		3597
		3598	my $uuid = "$LOCALDIR/uuid";
		3599
		3600	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3601	or return;
		3602
		3603	my $value = uuid_seq uuid_cur;
		3604
		3605	unless ($value) {
		3606	warn "cowardly refusing to write zero uuid value!\n";
		3607	return;
		3608	}
		3609
		3610	my $value = uuid_str $value + $uuid_skip;
		3611	$uuid_skip = 0;
		3612
		3613	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3614	and return;
		3615
		3616	# always fsync - this file is important
		3617	aio_fsync $fh
		3618	and return;
		3619
		3620	close $fh
		3621	or return;
		3622
		3623	aio_rename "$uuid~", $uuid
		3624	and return;
		3625
		3626	warn "uuid file written ($value).\n";
		3627
		3628	1
		3629
		3630	}
		3631
		3632	sub write_uuid($$) {
		3633	my ($skip, $sync) = @_;
		3634
		3635	$sync ? write_uuid_sync $skip
		3636	: async { write_uuid_sync $skip };
2266	}	3637	}
2267		3638
2268	sub emergency_save() {	3639	sub emergency_save() {
2269	my $freeze_guard = cf::freeze_mainloop;	3640	my $freeze_guard = cf::freeze_mainloop;
2270		3641
2271	warn "enter emergency perl save\n";	3642	warn "emergency_perl_save: enter\n";
2272		3643
2273	cf::sync_job {	3644	cf::sync_job {
		3645	# this is a trade-off: we want to be very quick here, so
		3646	# save all maps without fsync, and later call a global sync
		3647	# (which in turn might be very very slow)
		3648	local $USE_FSYNC = 0;
		3649
2274	# use a peculiar iteration method to avoid tripping on perl	3650	# use a peculiar iteration method to avoid tripping on perl
2275	# refcount bugs in for. also avoids problems with players	3651	# refcount bugs in for. also avoids problems with players
2276	# and maps saved/destroyed asynchronously.	3652	# and maps saved/destroyed asynchronously.
2277	warn "begin emergency player save\n";	3653	warn "emergency_perl_save: begin player save\n";
2278	for my $login (keys %cf::PLAYER) {	3654	for my $login (keys %cf::PLAYER) {
2279	my $pl = $cf::PLAYER{$login} or next;	3655	my $pl = $cf::PLAYER{$login} or next;
2280	$pl->valid or next;	3656	$pl->valid or next;
		3657	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2281	$pl->save;	3658	$pl->save;
2282	}	3659	}
2283	warn "end emergency player save\n";	3660	warn "emergency_perl_save: end player save\n";
2284		3661
2285	warn "begin emergency map save\n";	3662	warn "emergency_perl_save: begin map save\n";
2286	for my $path (keys %cf::MAP) {	3663	for my $path (keys %cf::MAP) {
2287	my $map = $cf::MAP{$path} or next;	3664	my $map = $cf::MAP{$path} or next;
2288	$map->valid or next;	3665	$map->valid or next;
2289	$map->save;	3666	$map->save;
2290	}	3667	}
2291	warn "end emergency map save\n";	3668	warn "emergency_perl_save: end map save\n";
		3669
		3670	warn "emergency_perl_save: begin database checkpoint\n";
		3671	BDB::db_env_txn_checkpoint $DB_ENV;
		3672	warn "emergency_perl_save: end database checkpoint\n";
		3673
		3674	warn "emergency_perl_save: begin write uuid\n";
		3675	write_uuid_sync 1;
		3676	warn "emergency_perl_save: end write uuid\n";
2292	};	3677	};
2293		3678
		3679	warn "emergency_perl_save: starting sync()\n";
		3680	IO::AIO::aio_sync sub {
		3681	warn "emergency_perl_save: finished sync()\n";
		3682	};
		3683
2294	warn "leave emergency perl save\n";	3684	warn "emergency_perl_save: leave\n";
2295	}	3685	}
2296		3686
		3687	sub post_cleanup {
		3688	my ($make_core) = @_;
		3689
		3690	warn Carp::longmess "post_cleanup backtrace"
		3691	if $make_core;
		3692
		3693	my $fh = pidfile;
		3694	unlink $PIDFILE if <$fh> == $$;
		3695	}
		3696
		3697	# a safer delete_package, copied from Symbol
		3698	sub clear_package($) {
		3699	my $pkg = shift;
		3700
		3701	# expand to full symbol table name if needed
		3702	unless ($pkg =~ /^main::.*::$/) {
		3703	$pkg = "main$pkg" if $pkg =~ /^::/;
		3704	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		3705	$pkg .= '::' unless $pkg =~ /::$/;
		3706	}
		3707
		3708	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		3709	my $stem_symtab = *{$stem}{HASH};
		3710
		3711	defined $stem_symtab and exists $stem_symtab->{$leaf}
		3712	or return;
		3713
		3714	# clear all symbols
		3715	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		3716	for my $name (keys %$leaf_symtab) {
		3717	_gv_clear *{"$pkg$name"};
		3718	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		3719	}
		3720	warn "cleared package $pkg\n";#d#
		3721	}
		3722
2297	sub reload() {	3723	sub do_reload_perl() {
2298	# can/must only be called in main	3724	# can/must only be called in main
2299	if ($Coro::current != $Coro::main) {	3725	if ($Coro::current != $Coro::main) {
2300	warn "can only reload from main coroutine";	3726	warn "can only reload from main coroutine";
2301	return;	3727	return;
2302	}	3728	}
2303		3729
		3730	return if $RELOAD++;
		3731
		3732	my $t1 = EV::time;
		3733
		3734	while ($RELOAD) {
2304	warn "reloading...";	3735	warn "reloading...";
2305		3736
2306	warn "cancelling server ticker";	3737	warn "entering sync_job";
2307	$TICK_WATCHER->cancel;
2308		3738
		3739	cf::sync_job {
		3740	cf::write_runtime_sync; # external watchdog should not bark
2309	cf::emergency_save;	3741	cf::emergency_save;
		3742	cf::write_runtime_sync; # external watchdog should not bark
2310		3743
2311	eval {	3744	warn "syncing database to disk";
		3745	BDB::db_env_txn_checkpoint $DB_ENV;
		3746
2312	# if anything goes wrong in here, we should simply crash as we already saved	3747	# if anything goes wrong in here, we should simply crash as we already saved
2313		3748
2314	warn "syncing database to disk";
2315	cf::db_sync;
2316
2317	warn "cancelling all WF_AUTOCANCEL watchers";
2318	for (Event::all_watchers) {
2319	$_->cancel if $_->data & WF_AUTOCANCEL;
2320	}
2321
2322	warn "flushing outstanding aio requests";	3749	warn "flushing outstanding aio requests";
2323	for (;;) {	3750	while (IO::AIO::nreqs || BDB::nreqs) {
2324	IO::AIO::flush;	3751	Coro::EV::timer_once 0.01; # let the sync_job do it's thing
2325	Coro::cede;
2326	last unless IO::AIO::nreqs;
2327	warn "iterate...";
2328	}
2329
2330	warn "cancelling all extension coros";
2331	$_->cancel for values %EXT_CORO;
2332	%EXT_CORO = ();
2333
2334	warn "removing commands";
2335	%COMMAND = ();
2336
2337	warn "removing ext commands";
2338	%EXTCMD = ();
2339
2340	warn "unloading/nuking all extensions";
2341	for my $pkg (@EXTS) {
2342	warn "... unloading $pkg";
2343
2344	if (my $cb = $pkg->can ("unload")) {
2345	eval {
2346	$cb->($pkg);
2347	1
2348	} or warn "$pkg unloaded, but with errors: $@";
2349	}	3752	}
2350		3753
2351	warn "... nuking $pkg";	3754	warn "cancelling all extension coros";
2352	Symbol::delete_package $pkg;	3755	$_->cancel for values %EXT_CORO;
2353	}	3756	%EXT_CORO = ();
2354		3757
2355	warn "unloading all perl modules loaded from $LIBDIR";	3758	warn "removing commands";
2356	while (my ($k, $v) = each %INC) {	3759	%COMMAND = ();
2357	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2358		3760
		3761	warn "removing ext/exti commands";
		3762	%EXTCMD = ();
		3763	%EXTICMD = ();
		3764
		3765	warn "unloading/nuking all extensions";
		3766	for my $pkg (@EXTS) {
2359	warn "... unloading $k";	3767	warn "... unloading $pkg";
2360	delete $INC{$k};
2361		3768
2362	$k =~ s/\.pm$//;
2363	$k =~ s/\//::/g;
2364
2365	if (my $cb = $k->can ("unload_module")) {	3769	if (my $cb = $pkg->can ("unload")) {
		3770	eval {
2366	$cb->();	3771	$cb->($pkg);
		3772	1
		3773	} or warn "$pkg unloaded, but with errors: $@";
		3774	}
		3775
		3776	warn "... clearing $pkg";
		3777	clear_package $pkg;
2367	}	3778	}
2368		3779
2369	Symbol::delete_package $k;	3780	warn "unloading all perl modules loaded from $LIBDIR";
		3781	while (my ($k, $v) = each %INC) {
		3782	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		3783
		3784	warn "... unloading $k";
		3785	delete $INC{$k};
		3786
		3787	$k =~ s/\.pm$//;
		3788	$k =~ s/\//::/g;
		3789
		3790	if (my $cb = $k->can ("unload_module")) {
		3791	$cb->();
		3792	}
		3793
		3794	clear_package $k;
2370	}	3795	}
2371		3796
2372	warn "getting rid of safe::, as good as possible";	3797	warn "getting rid of safe::, as good as possible";
2373	Symbol::delete_package "safe::$_"	3798	clear_package "safe::$_"
2374	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3799	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2375		3800
2376	warn "unloading cf.pm \"a bit\"";	3801	warn "unloading cf.pm \"a bit\"";
2377	delete $INC{"cf.pm"};	3802	delete $INC{"cf.pm"};
		3803	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2378		3804
2379	# don't, removes xs symbols, too,	3805	# don't, removes xs symbols, too,
2380	# and global variables created in xs	3806	# and global variables created in xs
2381	#Symbol::delete_package __PACKAGE__;	3807	#clear_package __PACKAGE__;
2382		3808
2383	warn "unload completed, starting to reload now";	3809	warn "unload completed, starting to reload now";
2384		3810
2385	warn "reloading cf.pm";	3811	warn "reloading cf.pm";
2386	require cf;	3812	require cf;
2387	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3813	cf::_connect_to_perl_1;
2388		3814
2389	warn "loading config and database again";	3815	warn "loading config and database again";
2390	cf::cfg_load;	3816	cf::reload_config;
2391	cf::db_load;
2392		3817
2393	warn "loading extensions";	3818	warn "loading extensions";
2394	cf::load_extensions;	3819	cf::load_extensions;
2395		3820
		3821	if ($REATTACH_ON_RELOAD) {
2396	warn "reattaching attachments to objects/players";	3822	warn "reattaching attachments to objects/players";
2397	_global_reattach;	3823	_global_reattach; # objects, sockets
2398	warn "reattaching attachments to maps";	3824	warn "reattaching attachments to maps";
2399	reattach $_ for values %MAP;	3825	reattach $_ for values %MAP;
		3826	warn "reattaching attachments to players";
		3827	reattach $_ for values %PLAYER;
		3828	}
2400		3829
2401	warn "restarting server ticker";	3830	warn "running post_init jobs";
		3831	(pop @POST_INIT)->(1) while @POST_INIT;
2402		3832
2403	$TICK_WATCHER->start;	3833	warn "leaving sync_job";
		3834
		3835	1
		3836	} or do {
		3837	warn $@;
		3838	cf::cleanup "error while reloading, exiting.";
		3839	};
		3840
		3841	warn "reloaded";
		3842	--$RELOAD;
		3843	}
		3844
		3845	$t1 = EV::time - $t1;
		3846	warn "reload completed in ${t1}s\n";
		3847	};
		3848
		3849	our $RELOAD_WATCHER; # used only during reload
		3850
		3851	sub reload_perl() {
		3852	# doing reload synchronously and two reloads happen back-to-back,
		3853	# coro crashes during coro_state_free->destroy here.
		3854
		3855	$RELOAD_WATCHER ||= cf::async {
		3856	Coro::AIO::aio_wait cache_extensions;
		3857
		3858	$RELOAD_WATCHER = EV::timer $TICK * 1.5, 0, sub {
		3859	do_reload_perl;
		3860	undef $RELOAD_WATCHER;
		3861	};
2404	};	3862	};
2405		3863	}
2406	if ($@) {
2407	warn $@;
2408	warn "error while reloading, exiting.";
2409	exit 1;
2410	}
2411
2412	warn "reloaded";
2413	};
2414
2415	our $RELOAD_WATCHER; # used only during reload
2416		3864
2417	register_command "reload" => sub {	3865	register_command "reload" => sub {
2418	my ($who, $arg) = @_;	3866	my ($who, $arg) = @_;
2419		3867
2420	if ($who->flag (FLAG_WIZ)) {	3868	if ($who->flag (FLAG_WIZ)) {
2421	$who->message ("reloading server.");	3869	$who->message ("reloading server.");
2422		3870	async {
2423	# doing reload synchronously and two reloads happen back-to-back,	3871	$Coro::current->{desc} = "perl_reload";
2424	# coro crashes during coro_state_free->destroy here.
2425
2426	$RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub {
2427	reload;	3872	reload_perl;
2428	undef $RELOAD_WATCHER;
2429	});	3873	};
2430	}	3874	}
2431	};	3875	};
2432		3876
2433	unshift @INC, $LIBDIR;	3877	unshift @INC, $LIBDIR;
2434		3878
2435	my $bug_warning = 0;	3879	my $bug_warning = 0;
2436		3880
2437	$TICK_WATCHER = Event->timer (	3881	our @WAIT_FOR_TICK;
2438	reentrant => 0,	3882	our @WAIT_FOR_TICK_BEGIN;
2439	parked => 1,	3883
2440	prio => 0,	3884	sub wait_for_tick {
2441	at => $NEXT_TICK || $TICK,	3885	return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
2442	data => WF_AUTOCANCEL,	3886
2443	cb => sub {	3887	my $signal = new Coro::Signal;
		3888	push @WAIT_FOR_TICK, $signal;
		3889	$signal->wait;
		3890	}
		3891
		3892	sub wait_for_tick_begin {
		3893	return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
		3894
		3895	my $signal = new Coro::Signal;
		3896	push @WAIT_FOR_TICK_BEGIN, $signal;
		3897	$signal->wait;
		3898	}
		3899
		3900	sub tick {
2444	if ($Coro::current != $Coro::main) {	3901	if ($Coro::current != $Coro::main) {
2445	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3902	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2446	unless ++$bug_warning > 10;	3903	unless ++$bug_warning > 10;
2447	return;	3904	return;
2448	}	3905	}
2449		3906
2450	$NOW = Event::time;
2451
2452	cf::server_tick; # one server iteration	3907	cf::server_tick; # one server iteration
2453	$RUNTIME += $TICK;
2454	$NEXT_TICK += $TICK;
2455		3908
2456	$WAIT_FOR_TICK->broadcast;	3909	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2457	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3910	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2458		3911	Coro::async_pool {
2459	# if we are delayed by four ticks or more, skip them all	3912	$Coro::current->{desc} = "runtime saver";
2460	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2461
2462	$TICK_WATCHER->at ($NEXT_TICK);
2463	$TICK_WATCHER->start;
2464	},
2465	);
2466
2467	IO::AIO::max_poll_time $TICK * 0.2;
2468
2469	$AIO_POLL_WATCHER = Event->io (
2470	fd => IO::AIO::poll_fileno,
2471	poll => 'r',
2472	prio => 5,
2473	data => WF_AUTOCANCEL,
2474	cb => \&IO::AIO::poll_cb,
2475	);
2476
2477	$WRITE_RUNTIME_WATCHER = Event->timer (
2478	data => WF_AUTOCANCEL,
2479	after => 1,
2480	interval => 10,
2481	cb => Coro::unblock_sub {
2482	write_runtime	3913	write_runtime_sync
2483	or warn "ERROR: unable to write runtime file: $!";	3914	or warn "ERROR: unable to write runtime file: $!";
		3915	};
2484	},	3916	}
2485	);	3917
		3918	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3919	$sig->send;
		3920	}
		3921	while (my $sig = shift @WAIT_FOR_TICK) {
		3922	$sig->send;
		3923	}
		3924
		3925	$LOAD = ($NOW - $TICK_START) / $TICK;
		3926	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3927
		3928	if (0) {
		3929	if ($NEXT_TICK) {
		3930	my $jitter = $TICK_START - $NEXT_TICK;
		3931	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		3932	warn "jitter $JITTER\n";#d#
		3933	}
		3934	}
		3935	}
		3936
		3937	{
		3938	# configure BDB
		3939
		3940	BDB::min_parallel 8;
		3941	BDB::max_poll_reqs $TICK * 0.1;
		3942	$AnyEvent::BDB::WATCHER->priority (1);
		3943
		3944	unless ($DB_ENV) {
		3945	$DB_ENV = BDB::db_env_create;
		3946	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		3947	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		3948	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		3949	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3950	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3951
		3952	cf::sync_job {
		3953	eval {
		3954	BDB::db_env_open
		3955	$DB_ENV,
		3956	$BDBDIR,
		3957	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3958	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3959	0666;
		3960
		3961	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3962	};
		3963
		3964	cf::cleanup "db_env_open(db): $@" if $@;
		3965	};
		3966	}
		3967
		3968	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3969	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3970	};
		3971	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		3972	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3973	};
		3974	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3975	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3976	};
		3977	}
		3978
		3979	{
		3980	# configure IO::AIO
		3981
		3982	IO::AIO::min_parallel 8;
		3983	IO::AIO::max_poll_time $TICK * 0.1;
		3984	undef $AnyEvent::AIO::WATCHER;
		3985	}
		3986
		3987	my $_log_backtrace;
		3988
		3989	sub _log_backtrace {
		3990	my ($msg, @addr) = @_;
		3991
		3992	$msg =~ s/\n//;
		3993
		3994	# limit the # of concurrent backtraces
		3995	if ($_log_backtrace < 2) {
		3996	++$_log_backtrace;
		3997	my $perl_bt = Carp::longmess $msg;
		3998	async {
		3999	$Coro::current->{desc} = "abt $msg";
		4000
		4001	my @bt = fork_call {
		4002	@addr = map { sprintf "%x", $_ } @addr;
		4003	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		4004	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		4005	or die "addr2line: $!";
		4006
		4007	my @funcs;
		4008	my @res = <$fh>;
		4009	chomp for @res;
		4010	while (@res) {
		4011	my ($func, $line) = splice @res, 0, 2, ();
		4012	push @funcs, "[$func] $line";
		4013	}
		4014
		4015	@funcs
		4016	};
		4017
		4018	LOG llevInfo, "[ABT] $perl_bt\n";
		4019	LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
		4020	LOG llevInfo, "[ABT] $_\n" for @bt;
		4021	--$_log_backtrace;
		4022	};
		4023	} else {
		4024	LOG llevInfo, "[ABT] $msg\n";
		4025	LOG llevInfo, "[ABT] [suppressed]\n";
		4026	}
		4027	}
		4028
		4029	# load additional modules
		4030	require "cf/$_.pm" for @EXTRA_MODULES;
		4031	cf::_connect_to_perl_2;
2486		4032
2487	END { cf::emergency_save }	4033	END { cf::emergency_save }
2488		4034
2489	1	4035	1
2490		4036

Diff Legend

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