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.196 by root, Sat Jan 27 23:59:29 2007 UTC vs.
Revision 1.501 by root, Sat Jan 16 23:27:21 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.5 ();	40	use Coro ();
		41	use Coro::State;
		42	use Coro::Handle;
		43	use Coro::EV;
14	use Coro::Event;	44	use Coro::AnyEvent;
15	use Coro::Timer;	45	use Coro::Timer;
16	use Coro::Signal;	46	use Coro::Signal;
17	use Coro::Semaphore;	47	use Coro::Semaphore;
		48	use Coro::SemaphoreSet;
		49	use Coro::AnyEvent;
18	use Coro::AIO;	50	use Coro::AIO;
		51	use Coro::BDB 1.6;
		52	use Coro::Storable;
		53	use Coro::Util ();
19		54
		55	use JSON::XS 2.01 ();
		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 + 90 + 10;	567	=cut
355	# 10 is the runtime save interval, for a monotonic clock
356	# 60 allows for the watchdog to kill the server.
357		568
358	(aio_write $fh, 0, (length $value), $value, 0) <= 0	569	sub fork_call(&@) {
359	and return;	570	my ($cb, @args) = @_;
360		571
361	aio_fsync $fh	572	# we seemingly have to make a local copy of the whole thing,
362	and return;	573	# otherwise perl prematurely frees the stuff :/
		574	# TODO: investigate and fix (likely this will be rather laborious)
363		575
364	close $fh	576	my @res = Coro::Util::fork_eval {
365	or return;	577	reset_signals;
		578	&$cb
		579	}, @args;
366		580
367	aio_rename "$runtime~", $runtime	581	wantarray ? @res : $res[-1]
368	and return;	582	}
369		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
370	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 });
371	}	747	}
372		748
373	=back	749	=back
374		750
375	=cut	751	=cut
376		752
377	#############################################################################	753	#############################################################################
378		754
379	=head2 ATTACHABLE OBJECTS	755	=head2 ATTACHABLE OBJECTS
380		756
381	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
382	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")
383	to it. All such attachable objects support the following methods.	759	to it. All such attachable objects support the following methods.
384		760
385	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>
386	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
387	crossfire+).	763	Deliantra).
388		764
389	=over 4	765	=over 4
390		766
391	=item $attachable->attach ($attachment, key => $value...)	767	=item $attachable->attach ($attachment, key => $value...)
392		768
…		…
436	=item cf::CLASS::attachment $name, ...	812	=item cf::CLASS::attachment $name, ...
437		813
438	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
439	given CLASS can refer to this attachment.	815	given CLASS can refer to this attachment.
440		816
441	Some classes such as crossfire maps and objects can specify attachments	817	Some classes such as deliantra maps and objects can specify attachments
442	that are attached at load/instantiate time, thus the need for a name.	818	that are attached at load/instantiate time, thus the need for a name.
443		819
444	These calls expect any number of the following handler/hook descriptions:	820	These calls expect any number of the following handler/hook descriptions:
445		821
446	=over 4	822	=over 4
…		…
555	$registry = $CB_TYPE[$object_type] ||= [];	931	$registry = $CB_TYPE[$object_type] ||= [];
556		932
557	} elsif ($type eq "subtype") {	933	} elsif ($type eq "subtype") {
558	defined $object_type or Carp::croak "subtype specified without type";	934	defined $object_type or Carp::croak "subtype specified without type";
559	my $object_subtype = shift @arg;	935	my $object_subtype = shift @arg;
560	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	936	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
561		937
562	} elsif ($type eq "package") {	938	} elsif ($type eq "package") {
563	my $pkg = shift @arg;	939	my $pkg = shift @arg;
564		940
565	while (my ($name, $id) = each %cb_id) {	941	while (my ($name, $id) = each %cb_id) {
…		…
594	_attach $registry, $klass, @attach;	970	_attach $registry, $klass, @attach;
595	}	971	}
596		972
597	$obj->{$name} = \%arg;	973	$obj->{$name} = \%arg;
598	} else {	974	} else {
599	warn "object uses attachment '$name' that is not available, postponing.\n";	975	warn "object uses attachment '$name' which is not available, postponing.\n";
600	}	976	}
601		977
602	$obj->{_attachment}{$name} = undef;	978	$obj->{_attachment}{$name} = undef;
603	}	979	}
604		980
…		…
606	if (ref $_[0]) {	982	if (ref $_[0]) {
607	_object_attach @_;	983	_object_attach @_;
608	} else {	984	} else {
609	_attach shift->_attach_registry, @_;	985	_attach shift->_attach_registry, @_;
610	}	986	}
		987	_recalc_want;
611	};	988	};
612		989
613	# all those should be optimised	990	# all those should be optimised
614	sub cf::attachable::detach {	991	sub cf::attachable::detach {
615	my ($obj, $name) = @_;	992	my ($obj, $name) = @_;
…		…
618	delete $obj->{_attachment}{$name};	995	delete $obj->{_attachment}{$name};
619	reattach ($obj);	996	reattach ($obj);
620	} else {	997	} else {
621	Carp::croak "cannot, currently, detach class attachments";	998	Carp::croak "cannot, currently, detach class attachments";
622	}	999	}
		1000	_recalc_want;
623	};	1001	};
624		1002
625	sub cf::attachable::attached {	1003	sub cf::attachable::attached {
626	my ($obj, $name) = @_;	1004	my ($obj, $name) = @_;
627		1005
…		…
642	";	1020	";
643	die if $@;	1021	die if $@;
644	}	1022	}
645		1023
646	our $override;	1024	our $override;
647	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?
648		1026
649	sub override {	1027	sub override {
650	$override = 1;	1028	$override = 1;
651	@invoke_results = ();	1029	@INVOKE_RESULTS = (@_);
652	}	1030	}
653		1031
654	sub do_invoke {	1032	sub do_invoke {
655	my $event = shift;	1033	my $event = shift;
656	my $callbacks = shift;	1034	my $callbacks = shift;
657		1035
658	@invoke_results = ();	1036	@INVOKE_RESULTS = ();
659		1037
660	local $override;	1038	local $override;
661		1039
662	for (@$callbacks) {	1040	for (@$callbacks) {
663	eval { &{$_->[1]} };	1041	eval { &{$_->[1]} };
…		…
672	}	1050	}
673		1051
674	0	1052	0
675	}	1053	}
676		1054
677	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1055	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
678		1056
679	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1057	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
680		1058
681	Generate an object-specific event with the given arguments.	1059	Generate an object-specific event with the given arguments.
682		1060
683	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
684	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
685	results (if you must, access C<@cf::invoke_results> directly).	1063	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
686		1064
687	=back	1065	=back
688		1066
689	=cut	1067	=cut
690		1068
691	#############################################################################	1069	#############################################################################
692	# 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	}
693		1113
694	sub reattach {	1114	sub reattach {
695	# basically do the same as instantiate, without calling instantiate	1115	# basically do the same as instantiate, without calling instantiate
696	my ($obj) = @_;	1116	my ($obj) = @_;
697		1117
		1118	# no longer needed after getting rid of delete_package?
698	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
699		1120
700	my $registry = $obj->registry;	1121	my $registry = $obj->registry;
701		1122
702	@$registry = ();	1123	@$registry = ();
703		1124
…		…
718	cf::attachable->attach (	1139	cf::attachable->attach (
719	prio => -1000000,	1140	prio => -1000000,
720	on_instantiate => sub {	1141	on_instantiate => sub {
721	my ($obj, $data) = @_;	1142	my ($obj, $data) = @_;
722		1143
723	$data = from_json $data;	1144	$data = decode_json $data;
724		1145
725	for (@$data) {	1146	for (@$data) {
726	my ($name, $args) = @$_;	1147	my ($name, $args) = @$_;
727		1148
728	$obj->attach ($name, %{$args || {} });	1149	$obj->attach ($name, %{$args || {} });
…		…
744	sub object_freezer_save {	1165	sub object_freezer_save {
745	my ($filename, $rdata, $objs) = @_;	1166	my ($filename, $rdata, $objs) = @_;
746		1167
747	sync_job {	1168	sync_job {
748	if (length $$rdata) {	1169	if (length $$rdata) {
		1170	utf8::decode (my $decname = $filename);
749	warn sprintf "saving %s (%d,%d)\n",	1171	warn sprintf "saving %s (%d,%d)\n",
750	$filename, length $$rdata, scalar @$objs;	1172	$decname, length $$rdata, scalar @$objs;
751		1173
752	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1174	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
753	chmod SAVE_MODE, $fh;	1175	aio_chmod $fh, SAVE_MODE;
754	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;
755	aio_fsync $fh;	1179	aio_fsync $fh;
		1180	}
756	close $fh;	1181	aio_close $fh;
757		1182
758	if (@$objs) {	1183	if (@$objs) {
759	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) {
760	chmod SAVE_MODE, $fh;	1185	aio_chmod $fh, SAVE_MODE;
761	my $data = Storable::nfreeze { version => 1, objs => $objs };	1186	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
762	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;
763	aio_fsync $fh;	1190	aio_fsync $fh;
		1191	}
764	close $fh;	1192	aio_close $fh;
765	aio_rename "$filename.pst~", "$filename.pst";	1193	aio_rename "$filename.pst~", "$filename.pst";
766	}	1194	}
767	} else {	1195	} else {
768	aio_unlink "$filename.pst";	1196	aio_unlink "$filename.pst";
769	}	1197	}
770		1198
771	aio_rename "$filename~", $filename;	1199	aio_rename "$filename~", $filename;
		1200
		1201	$filename =~ s%/[^/]+$%%;
		1202	aio_pathsync $filename if $cf::USE_FSYNC;
772	} else {	1203	} else {
773	warn "FATAL: $filename~: $!\n";	1204	warn "unable to save objects: $filename~: $!\n";
774	}	1205	}
775	} else {	1206	} else {
776	aio_unlink $filename;	1207	aio_unlink $filename;
777	aio_unlink "$filename.pst";	1208	aio_unlink "$filename.pst";
778	}	1209	}
779	}	1210	};
780	}	1211	}
781		1212
782	sub object_freezer_as_string {	1213	sub object_freezer_as_string {
783	my ($rdata, $objs) = @_;	1214	my ($rdata, $objs) = @_;
784		1215
…		…
796	or return;	1227	or return;
797		1228
798	unless (aio_stat "$filename.pst") {	1229	unless (aio_stat "$filename.pst") {
799	(aio_load "$filename.pst", $av) >= 0	1230	(aio_load "$filename.pst", $av) >= 0
800	or return;	1231	or return;
		1232
801	$av = eval { (Storable::thaw $av)->{objs} };	1233	my $st = eval { Coro::Storable::thaw $av };
		1234	$av = $st->{objs};
802	}	1235	}
803		1236
		1237	utf8::decode (my $decname = $filename);
804	warn sprintf "loading %s (%d)\n",	1238	warn sprintf "loading %s (%d,%d)\n",
805	$filename, length $data, scalar @{$av || []};#d#	1239	$decname, length $data, scalar @{$av || []};
		1240
806	return ($data, $av);	1241	($data, $av)
807	}	1242	}
		1243
		1244	=head2 COMMAND CALLBACKS
		1245
		1246	=over 4
		1247
		1248	=cut
808		1249
809	#############################################################################	1250	#############################################################################
810	# command handling &c	1251	# command handling &c
811		1252
812	=item cf::register_command $name => \&callback($ob,$args);	1253	=item cf::register_command $name => \&callback($ob,$args);
…		…
825	push @{ $COMMAND{$name} }, [$caller, $cb];	1266	push @{ $COMMAND{$name} }, [$caller, $cb];
826	}	1267	}
827		1268
828	=item cf::register_extcmd $name => \&callback($pl,$packet);	1269	=item cf::register_extcmd $name => \&callback($pl,$packet);
829		1270
830	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.
831		1276
832	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
833	called.	1278	called.
834		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
835	=cut	1291	=cut
836		1292
837	sub register_extcmd {	1293	sub register_extcmd {
838	my ($name, $cb) = @_;	1294	my ($name, $cb) = @_;
839		1295
840	$EXTCMD{$name} = $cb;	1296	$EXTCMD{$name} = $cb;
841	}	1297	}
		1298
		1299	sub register_exticmd {
		1300	my ($name, $cb) = @_;
		1301
		1302	$EXTICMD{$name} = $cb;
		1303	}
		1304
		1305	use File::Glob ();
842		1306
843	cf::player->attach (	1307	cf::player->attach (
844	on_command => sub {	1308	on_command => sub {
845	my ($pl, $name, $params) = @_;	1309	my ($pl, $name, $params) = @_;
846		1310
…		…
854	cf::override;	1318	cf::override;
855	},	1319	},
856	on_extcmd => sub {	1320	on_extcmd => sub {
857	my ($pl, $buf) = @_;	1321	my ($pl, $buf) = @_;
858		1322
859	my $msg = eval { from_json $buf };	1323	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
860		1324
861	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
862	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1333	if (my $cb = $EXTCMD{$type}) {
863	if (my %reply = $cb->($pl, $msg)) {	1334	@reply = $cb->($pl, @payload);
864	$pl->ext_reply ($msg->{msgid}, %reply);
865	}
866	}	1335	}
		1336
		1337	$pl->ext_reply ($reply, @reply)
		1338	if $reply;
		1339
867	} else {	1340	} else {
868	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1341	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
869	}	1342	}
870		1343
871	cf::override;	1344	cf::override;
872	},	1345	},
873	);	1346	);
874		1347
		1348	# "readahead" all extensions
875	sub load_extension {	1349	sub cache_extensions {
876	my ($path) = @_;	1350	my $grp = IO::AIO::aio_group;
877		1351
878	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1352	add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
879	my $base = $1;	1353	for (grep /\.ext$/, @{$_[0]}) {
880	my $pkg = $1;	1354	add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
881	$pkg =~ s/[^[:word:]]/_/g;
882	$pkg = "ext::$pkg";
883
884	warn "... loading '$path' into '$pkg'\n";
885
886	open my $fh, "<:utf8", $path
887	or die "$path: $!";
888
889	my $source =
890	"package $pkg; use strict; use utf8;\n"
891	. "#line 1 \"$path\"\n{\n"
892	. (do { local $/; <$fh> })
893	. "\n};\n1";
894
895	unless (eval $source) {
896	my $msg = $@ ? "$path: $@\n"
897	: "extension disabled.\n";
898	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
899	warn $@;
900	warn "mandatory extension failed to load, exiting.\n";
901	exit 1;
902	}	1355	}
903	die $@;
904	}	1356	};
905		1357
906	push @EXTS, $pkg;	1358	$grp
907	}	1359	}
908		1360
909	sub load_extensions {	1361	sub load_extensions {
		1362	cf::sync_job {
		1363	my %todo;
		1364
910	for my $ext (<$LIBDIR/*.ext>) {	1365	for my $path (<$LIBDIR/*.ext>) {
911	next unless -r $ext;	1366	next unless -r $path;
912	eval {	1367
913	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;
914	1	1424	}
915	} or warn "$ext not loaded: $@";	1425
		1426	skip:
		1427	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1428	unless $progress;
		1429	}
916	}	1430	};
917	}	1431	}
918		1432
919	#############################################################################	1433	#############################################################################
920		1434
		1435	=back
		1436
921	=head2 CORE EXTENSIONS	1437	=head2 CORE EXTENSIONS
922		1438
923	Functions and methods that extend core crossfire objects.	1439	Functions and methods that extend core deliantra objects.
924		1440
925	=cut	1441	=cut
926		1442
927	package cf::player;	1443	package cf::player;
928		1444
…		…
930		1446
931	=head3 cf::player	1447	=head3 cf::player
932		1448
933	=over 4	1449	=over 4
934		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
935	=item cf::player::find $login	1465	=item cf::player::find $login
936		1466
937	Returns the given player object, loading it if necessary (might block).	1467	Returns the given player object, loading it if necessary (might block).
938		1468
939	=cut	1469	=cut
940		1470
941	sub playerdir($) {	1471	sub playerdir($) {
942	cf::localdir	1472	"$PLAYERDIR/"
943	. "/"
944	. cf::playerdir
945	. "/"
946	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1473	. (ref $_[0] ? $_[0]->ob->name : $_[0])
947	}	1474	}
948		1475
949	sub path($) {	1476	sub path($) {
950	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1477	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
951		1478
952	(playerdir $login) . "/$login.pl"	1479	(playerdir $login) . "/playerdata"
953	}	1480	}
954		1481
955	sub find_active($) {	1482	sub find_active($) {
956	$cf::PLAYER{$_[0]}	1483	$cf::PLAYER{$_[0]}
957	and $cf::PLAYER{$_[0]}->active	1484	and $cf::PLAYER{$_[0]}->active
…		…
960		1487
961	sub exists($) {	1488	sub exists($) {
962	my ($login) = @_;	1489	my ($login) = @_;
963		1490
964	$cf::PLAYER{$login}	1491	$cf::PLAYER{$login}
965	or cf::sync_job { !aio_stat path $login }	1492	or !aio_stat path $login
966	}	1493	}
967		1494
968	sub find($) {	1495	sub find($) {
969	return $cf::PLAYER{$_[0]} || do {	1496	return $cf::PLAYER{$_[0]} || do {
970	my $login = $_[0];	1497	my $login = $_[0];
971		1498
972	my $guard = cf::lock_acquire "user_find:$login";	1499	my $guard = cf::lock_acquire "user_find:$login";
973		1500
974	$cf::PLAYER{$_[0]} || do {	1501	$cf::PLAYER{$_[0]} || do {
975	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
976	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;
977	$cf::PLAYER{$login} = $pl	1517	$cf::PLAYER{$login} = $pl
978	}	1518	}
979	}	1519	}
980	}	1520	}
981		1521
…		…
990	return if $pl->{deny_save};	1530	return if $pl->{deny_save};
991		1531
992	aio_mkdir playerdir $pl, 0770;	1532	aio_mkdir playerdir $pl, 0770;
993	$pl->{last_save} = $cf::RUNTIME;	1533	$pl->{last_save} = $cf::RUNTIME;
994		1534
		1535	cf::get_slot 0.01;
		1536
995	$pl->save_pl ($path);	1537	$pl->save_pl ($path);
996	Coro::cede;	1538	cf::cede_to_tick;
997	}	1539	}
998		1540
999	sub new($) {	1541	sub new($) {
1000	my ($login) = @_;	1542	my ($login) = @_;
1001		1543
…		…
1007	$cf::PLAYER{$login} = $self;	1549	$cf::PLAYER{$login} = $self;
1008		1550
1009	$self	1551	$self
1010	}	1552	}
1011		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
1012	=item $pl->quit_character	1564	=item $pl->quit_character
1013		1565
1014	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
1015	be destroyed. May block for a long time.	1567	be destroyed. May block for a long time.
1016		1568
1017	=cut	1569	=cut
1018		1570
1019	sub quit_character {	1571	sub quit_character {
1020	my ($pl) = @_;	1572	my ($pl) = @_;
1021		1573
		1574	my $name = $pl->ob->name;
		1575
1022	$pl->{deny_save} = 1;	1576	$pl->{deny_save} = 1;
1023	$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
1024		1578
1025	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1579	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1026	$pl->deactivate;	1580	$pl->deactivate;
		1581	my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
		1582	$pl->ob->check_score;
1027	$pl->invoke (cf::EVENT_PLAYER_QUIT);	1583	$pl->invoke (cf::EVENT_PLAYER_QUIT);
1028	$pl->ns->destroy if $pl->ns;	1584	$pl->ns->destroy if $pl->ns;
1029		1585
1030	my $path = playerdir $pl;	1586	my $path = playerdir $pl;
1031	my $temp = "$path~$cf::RUNTIME~deleting~";	1587	my $temp = "$path~$cf::RUNTIME~deleting~";
1032	aio_rename $path, $temp;	1588	aio_rename $path, $temp;
1033	delete $cf::PLAYER{$pl->ob->name};	1589	delete $cf::PLAYER{$pl->ob->name};
1034	$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
1035	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;
1036	}	1612	}
1037		1613
1038	=item cf::player::list_logins	1614	=item cf::player::list_logins
1039		1615
1040	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
1041	while and may block, so not sync_job-capable, ever.	1617	while and may block, so not sync_job-capable, ever.
1042		1618
1043	=cut	1619	=cut
1044		1620
1045	sub list_logins {	1621	sub list_logins {
1046	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1622	my $dirs = aio_readdir $PLAYERDIR
1047	or return [];	1623	or return [];
1048		1624
1049	my @logins;	1625	my @logins;
1050		1626
1051	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") {
1052	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1633	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1053	aio_read $fh, 0, 512, my $buf, 0 or next;	1634	aio_read $fh, 0, 512, my $buf, 0 or next;
1054	$buf !~ /^password -------------$/m or next; # official not-valid tag	1635	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1636	}
1055		1637
1056	utf8::decode $login;	1638	utf8::decode $login;
1057	push @logins, $login;	1639	push @logins, $login;
1058	}	1640	}
1059		1641
…		…
1067		1649
1068	=cut	1650	=cut
1069		1651
1070	sub maps($) {	1652	sub maps($) {
1071	my ($pl) = @_;	1653	my ($pl) = @_;
		1654
		1655	$pl = ref $pl ? $pl->ob->name : $pl;
1072		1656
1073	my $files = aio_readdir playerdir $pl	1657	my $files = aio_readdir playerdir $pl
1074	or return;	1658	or return;
1075		1659
1076	my @paths;	1660	my @paths;
…		…
1078	for (@$files) {	1662	for (@$files) {
1079	utf8::decode $_;	1663	utf8::decode $_;
1080	next if /\.(?:pl|pst)$/;	1664	next if /\.(?:pl|pst)$/;
1081	next unless /^$PATH_SEP/o;	1665	next unless /^$PATH_SEP/o;
1082		1666
1083	s/\.map$//;	1667	push @paths, cf::map::normalise "~$pl/$_";
1084	push @paths, "~" . $pl->ob->name . "/" . $_;
1085	}	1668	}
1086		1669
1087	\@paths	1670	\@paths
1088	}	1671	}
1089		1672
		1673	=item $protocol_xml = $player->expand_cfpod ($cfpod)
		1674
		1675	Expand deliantra pod fragments into protocol xml.
		1676
1090	=item $player->ext_reply ($msgid, $msgtype, %msg)	1677	=item $player->ext_reply ($msgid, @msg)
1091		1678
1092	Sends an ext reply to the player.	1679	Sends an ext reply to the player.
1093		1680
1094	=cut	1681	=cut
1095		1682
1096	sub ext_reply($$$%) {	1683	sub ext_reply($$@) {
1097	my ($self, $id, %msg) = @_;	1684	my ($self, $id, @msg) = @_;
1098		1685
1099	$msg{msgid} = $id;	1686	$self->ns->ext_reply ($id, @msg)
1100
1101	$self->send ("ext " . cf::to_json \%msg);
1102	}	1687	}
1103		1688
1104	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	}
1105		1729
1106	=back	1730	=back
1107
1108		1731
1109	=head3 cf::map	1732	=head3 cf::map
1110		1733
1111	=over 4	1734	=over 4
1112		1735
…		…
1124	our $MAX_RESET = 3600;	1747	our $MAX_RESET = 3600;
1125	our $DEFAULT_RESET = 3000;	1748	our $DEFAULT_RESET = 3000;
1126		1749
1127	sub generate_random_map {	1750	sub generate_random_map {
1128	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
1129	# mit "rum" bekleckern, nicht	1755	# mit "rum" bekleckern, nicht
1130	$self->_create_random_map (	1756	$self->_create_random_map (
1131	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1757	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1132	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1758	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1133	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1759	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
…		…
1167	my ($self, $merge) = @_;	1793	my ($self, $merge) = @_;
1168		1794
1169	# we have to keep some variables in memory intact	1795	# we have to keep some variables in memory intact
1170	local $self->{path};	1796	local $self->{path};
1171	local $self->{load_path};	1797	local $self->{load_path};
1172	local $self->{deny_save};
1173	local $self->{deny_reset};
1174		1798
1175	$self->SUPER::thawer_merge ($merge);	1799	$self->SUPER::thawer_merge ($merge);
1176	}	1800	}
1177		1801
1178	sub normalise {	1802	sub normalise {
1179	my ($path, $base) = @_;	1803	my ($path, $base) = @_;
1180		1804
1181	$path = "$path"; # make sure its a string	1805	$path = "$path"; # make sure its a string
		1806
		1807	$path =~ s/\.map$//;
1182		1808
1183	# map plan:	1809	# map plan:
1184	#	1810	#
1185	# /! non-realised random map exit (special hack!)	1811	# /! non-realised random map exit (special hack!)
1186	# {... are special paths that are not being touched	1812	# {... are special paths that are not being touched
…		…
1223	$self->init; # pass $1 etc.	1849	$self->init; # pass $1 etc.
1224	return $self;	1850	return $self;
1225	}	1851	}
1226	}	1852	}
1227		1853
1228	Carp::carp "unable to resolve path '$path' (base '$base').";	1854	Carp::cluck "unable to resolve path '$path' (base '$base').";
1229	()	1855	()
1230	}	1856	}
1231		1857
1232	sub init {	1858	sub init {
1233	my ($self) = @_;	1859	my ($self) = @_;
…		…
1248		1874
1249	# the original (read-only) location	1875	# the original (read-only) location
1250	sub load_path {	1876	sub load_path {
1251	my ($self) = @_;	1877	my ($self) = @_;
1252		1878
1253	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1879	"$MAPDIR/$self->{path}.map"
1254	}	1880	}
1255		1881
1256	# the temporary/swap location	1882	# the temporary/swap location
1257	sub save_path {	1883	sub save_path {
1258	my ($self) = @_;	1884	my ($self) = @_;
1259		1885
1260	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1886	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1261	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	1887	"$TMPDIR/$path.map"
1262	}	1888	}
1263		1889
1264	# the unique path, undef == no special unique path	1890	# the unique path, undef == no special unique path
1265	sub uniq_path {	1891	sub uniq_path {
1266	my ($self) = @_;	1892	my ($self) = @_;
1267		1893
1268	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1894	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1269	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1895	"$UNIQUEDIR/$path"
1270	}	1896	}
1271		1897
1272	# and all this just because we cannot iterate over	1898	sub decay_objects {
1273	# all maps in C++...
1274	sub change_all_map_light {
1275	my ($change) = @_;	1899	my ($self) = @_;
1276		1900
1277	$_->change_map_light ($change)	1901	return if $self->{deny_reset};
1278	for grep $_->outdoor, values %cf::MAP;	1902
		1903	$self->do_decay_objects;
1279	}	1904	}
1280		1905
1281	sub unlink_save {	1906	sub unlink_save {
1282	my ($self) = @_;	1907	my ($self) = @_;
1283		1908
…		…
1288		1913
1289	sub load_header_from($) {	1914	sub load_header_from($) {
1290	my ($self, $path) = @_;	1915	my ($self, $path) = @_;
1291		1916
1292	utf8::encode $path;	1917	utf8::encode $path;
1293	aio_open $path, O_RDONLY, 0	1918	my $f = new_from_file cf::object::thawer $path
1294	or return;	1919	or return;
1295		1920
1296	$self->_load_header ($path)	1921	$self->_load_header ($f)
1297	or return;	1922	or return;
		1923
		1924	local $MAP_LOADING{$self->{path}} = $self;
		1925	$f->resolve_delayed_derefs;
1298		1926
1299	$self->{load_path} = $path;	1927	$self->{load_path} = $path;
1300		1928
1301	1	1929	1
1302	}	1930	}
…		…
1341	$self->load_header_orig	1969	$self->load_header_orig
1342	or return;	1970	or return;
1343	$self->prepare_orig;	1971	$self->prepare_orig;
1344	}	1972	}
1345		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;
		1979
1346	1	1980	1
1347	}	1981	}
1348		1982
1349	sub find;	1983	sub find;
1350	sub find {	1984	sub find {
1351	my ($path, $origin) = @_;	1985	my ($path, $origin) = @_;
1352		1986
1353	$path = normalise $path, $origin && $origin->path;	1987	$path = normalise $path, $origin && $origin->path;
1354		1988
		1989	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1355	cf::lock_wait "map_find:$path";	1990	my $guard2 = cf::lock_acquire "map_find:$path";
1356		1991
1357	$cf::MAP{$path} || do {	1992	$cf::MAP{$path} || do {
1358	my $guard = cf::lock_acquire "map_find:$path";
1359	my $map = new_from_path cf::map $path	1993	my $map = new_from_path cf::map $path
1360	or return;	1994	or return;
1361		1995
1362	$map->{last_save} = $cf::RUNTIME;	1996	$map->{last_save} = $cf::RUNTIME;
1363		1997
1364	$map->load_header	1998	$map->load_header
1365	or return;	1999	or return;
1366		2000
1367	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	2001	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1368	# doing this can freeze the server in a sync job, obviously	2002	# doing this can freeze the server in a sync job, obviously
1369	#$cf::WAIT_FOR_TICK->wait;	2003	#$cf::WAIT_FOR_TICK->wait;
		2004	undef $guard2;
		2005	undef $guard1;
1370	$map->reset;	2006	$map->reset;
1371	undef $guard;
1372	return find $path;	2007	return find $path;
1373	}	2008	}
1374		2009
1375	$cf::MAP{$path} = $map	2010	$cf::MAP{$path} = $map
1376	}	2011	}
1377	}	2012	}
1378		2013
1379	sub pre_load { }	2014	sub pre_load { }
1380	sub post_load { }	2015	#sub post_load { } # XS
1381		2016
1382	sub load {	2017	sub load {
1383	my ($self) = @_;	2018	my ($self) = @_;
1384		2019
1385	local $self->{deny_reset} = 1; # loading can take a long time	2020	local $self->{deny_reset} = 1; # loading can take a long time
1386		2021
1387	my $path = $self->{path};	2022	my $path = $self->{path};
		2023
		2024	{
1388	my $guard = cf::lock_acquire "map_load:$path";	2025	my $guard = cf::lock_acquire "map_data:$path";
1389		2026
		2027	return unless $self->valid;
1390	return if $self->in_memory != cf::MAP_SWAPPED;	2028	return unless $self->in_memory == cf::MAP_SWAPPED;
1391		2029
1392	$self->in_memory (cf::MAP_LOADING);	2030	$self->in_memory (cf::MAP_LOADING);
1393		2031
1394	$self->alloc;	2032	$self->alloc;
1395		2033
1396	$self->pre_load;	2034	$self->pre_load;
		2035	cf::cede_to_tick;
1397		2036
1398	$self->_load_objects ($self->{load_path}, 1)	2037	my $f = new_from_file cf::object::thawer $self->{load_path};
		2038	$f->skip_block;
		2039	$self->_load_objects ($f)
1399	or return;	2040	or return;
1400		2041
1401	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2042	$self->post_load_original
1402	if delete $self->{load_original};	2043	if delete $self->{load_original};
1403		2044
1404	if (my $uniq = $self->uniq_path) {	2045	if (my $uniq = $self->uniq_path) {
1405	utf8::encode $uniq;	2046	utf8::encode $uniq;
1406	if (aio_open $uniq, O_RDONLY, 0) {	2047	unless (aio_stat $uniq) {
		2048	if (my $f = new_from_file cf::object::thawer $uniq) {
1407	$self->clear_unique_items;	2049	$self->clear_unique_items;
1408	$self->_load_objects ($uniq, 0);	2050	$self->_load_objects ($f);
		2051	$f->resolve_delayed_derefs;
		2052	}
1409	}	2053	}
1410	}	2054	}
1411		2055
1412	Coro::cede;	2056	$f->resolve_delayed_derefs;
1413		2057
		2058	cf::cede_to_tick;
1414	# now do the right thing for maps	2059	# now do the right thing for maps
1415	$self->link_multipart_objects;	2060	$self->link_multipart_objects;
1416
1417	unless ($self->{deny_activate}) {
1418	$self->decay_objects;
1419	$self->fix_auto_apply;
1420	$self->update_buttons;
1421	Coro::cede;
1422	$self->set_darkness_map;
1423	$self->difficulty ($self->estimate_difficulty)	2061	$self->difficulty ($self->estimate_difficulty)
1424	unless $self->difficulty;	2062	unless $self->difficulty;
1425	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;
1426	$self->activate;	2070	$self->activate;
		2071	}
		2072
		2073	$self->{last_save} = $cf::RUNTIME;
		2074	$self->last_access ($cf::RUNTIME);
		2075
		2076	$self->in_memory (cf::MAP_ACTIVE);
1427	}	2077	}
1428		2078
1429	$self->post_load;	2079	$self->post_load;
1430
1431	$self->in_memory (cf::MAP_IN_MEMORY);
1432	}	2080	}
1433		2081
1434	sub customise_for {	2082	sub customise_for {
1435	my ($self, $ob) = @_;	2083	my ($self, $ob) = @_;
1436		2084
1437	return find "~" . $ob->name . "/" . $self->{path}	2085	return find "~" . $ob->name . "/" . $self->{path}
1438	if $self->per_player;	2086	if $self->per_player;
1439		2087
		2088	# return find "?party/" . $ob->name . "/" . $self->{path}
		2089	# if $self->per_party;
		2090
1440	$self	2091	$self
1441	}	2092	}
1442		2093
1443	# 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
1444	sub load_diag {	2095	sub load_neighbours {
1445	my ($map) = @_;	2096	my ($map) = @_;
1446		2097
1447	my @diag; # diagonal neighbours	2098	my @neigh; # diagonal neighbours
1448		2099
1449	for (0 .. 3) {	2100	for (0 .. 3) {
1450	my $neigh = $map->tile_path ($_)	2101	my $neigh = $map->tile_path ($_)
1451	or next;	2102	or next;
1452	$neigh = find $neigh, $map	2103	$neigh = find $neigh, $map
1453	or next;	2104	or next;
1454	$neigh->load;	2105	$neigh->load;
1455		2106
		2107	push @neigh,
1456	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2108	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1457	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2109	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1458	}	2110	}
1459		2111
1460	for (@diag) {	2112	for (grep defined $_->[0], @neigh) {
		2113	my ($path, $origin) = @$_;
1461	my $neigh = find @$_	2114	my $neigh = find $path, $origin
1462	or next;	2115	or next;
1463	$neigh->load;	2116	$neigh->load;
1464	}	2117	}
1465	}	2118	}
1466		2119
…		…
1471	}	2124	}
1472		2125
1473	sub do_load_sync {	2126	sub do_load_sync {
1474	my ($map) = @_;	2127	my ($map) = @_;
1475		2128
		2129	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2130	if $Coro::current == $Coro::main;
		2131
1476	cf::sync_job { $map->load };	2132	cf::sync_job { $map->load };
1477	}	2133	}
1478		2134
1479	our %MAP_PREFETCH;	2135	our %MAP_PREFETCH;
1480	our $MAP_PREFETCHER = undef;	2136	our $MAP_PREFETCHER = undef;
1481		2137
1482	sub find_async {	2138	sub find_async {
1483	my ($path, $origin) = @_;	2139	my ($path, $origin, $load) = @_;
1484		2140
1485	$path = normalise $path, $origin && $origin->{path};	2141	$path = normalise $path, $origin && $origin->{path};
1486		2142
1487	if (my $map = $cf::MAP{$path}) {	2143	if (my $map = $cf::MAP{$path}) {
1488	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2144	return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
1489	}	2145	}
1490		2146
1491	undef $MAP_PREFETCH{$path};	2147	$MAP_PREFETCH{$path} |= $load;
		2148
1492	$MAP_PREFETCHER ||= cf::async {	2149	$MAP_PREFETCHER ||= cf::async {
		2150	$Coro::current->{desc} = "map prefetcher";
		2151
1493	while (%MAP_PREFETCH) {	2152	while (%MAP_PREFETCH) {
1494	for my $path (keys %MAP_PREFETCH) {	2153	while (my ($k, $v) = each %MAP_PREFETCH) {
1495	my $map = find $path	2154	if (my $map = find $k) {
1496	or next;
1497	$map->load;	2155	$map->load if $v;
		2156	}
1498		2157
1499	delete $MAP_PREFETCH{$path};	2158	delete $MAP_PREFETCH{$k};
1500	}	2159	}
1501	}	2160	}
1502	undef $MAP_PREFETCHER;	2161	undef $MAP_PREFETCHER;
1503	};	2162	};
1504	$MAP_PREFETCHER->prio (6);	2163	$MAP_PREFETCHER->prio (6);
…		…
1507	}	2166	}
1508		2167
1509	sub save {	2168	sub save {
1510	my ($self) = @_;	2169	my ($self) = @_;
1511		2170
1512	my $lock = cf::lock_acquire "map_data:" . $self->path;	2171	my $lock = cf::lock_acquire "map_data:$self->{path}";
1513		2172
1514	$self->{last_save} = $cf::RUNTIME;	2173	$self->{last_save} = $cf::RUNTIME;
1515		2174
1516	return unless $self->dirty;	2175	return unless $self->dirty;
1517		2176
…		…
1523	return if $self->{deny_save};	2182	return if $self->{deny_save};
1524		2183
1525	local $self->{last_access} = $self->last_access;#d#	2184	local $self->{last_access} = $self->last_access;#d#
1526		2185
1527	cf::async {	2186	cf::async {
		2187	$Coro::current->{desc} = "map player save";
1528	$_->contr->save for $self->players;	2188	$_->contr->save for $self->players;
1529	};	2189	};
		2190
		2191	cf::get_slot 0.02;
1530		2192
1531	if ($uniq) {	2193	if ($uniq) {
1532	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2194	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1533	$self->_save_objects ($uniq, cf::IO_UNIQUES);	2195	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1534	} else {	2196	} else {
…		…
1540	my ($self) = @_;	2202	my ($self) = @_;
1541		2203
1542	# save first because save cedes	2204	# save first because save cedes
1543	$self->save;	2205	$self->save;
1544		2206
1545	my $lock = cf::lock_acquire "map_data:" . $self->path;	2207	my $lock = cf::lock_acquire "map_data:$self->{path}";
1546		2208
1547	return if $self->players;	2209	return if $self->players;
1548	return if $self->in_memory != cf::MAP_IN_MEMORY;	2210	return if $self->in_memory != cf::MAP_ACTIVE;
1549	return if $self->{deny_save};	2211	return if $self->{deny_save};
1550		2212
		2213	$self->in_memory (cf::MAP_SWAPPED);
		2214
		2215	$self->deactivate;
		2216	$_->clear_links_to ($self) for values %cf::MAP;
1551	$self->clear;	2217	$self->clear;
1552	$self->in_memory (cf::MAP_SWAPPED);
1553	}	2218	}
1554		2219
1555	sub reset_at {	2220	sub reset_at {
1556	my ($self) = @_;	2221	my ($self) = @_;
1557		2222
1558	# TODO: safety, remove and allow resettable per-player maps	2223	# TODO: safety, remove and allow resettable per-player maps
1559	return 1e99 if $self->isa ("ext::map_per_player");#d#
1560	return 1e99 if $self->{deny_reset};	2224	return 1e99 if $self->{deny_reset};
1561		2225
1562	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2226	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1563	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;
1564		2228
…		…
1575	my ($self) = @_;	2239	my ($self) = @_;
1576		2240
1577	my $lock = cf::lock_acquire "map_data:$self->{path}";	2241	my $lock = cf::lock_acquire "map_data:$self->{path}";
1578		2242
1579	return if $self->players;	2243	return if $self->players;
1580	return if $self->isa ("ext::map_per_player");#d#
1581		2244
1582	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	}
1583		2256
1584	delete $cf::MAP{$self->path};	2257	delete $cf::MAP{$self->path};
1585		2258
1586	$self->in_memory (cf::MAP_SWAPPED);	2259	$self->deactivate;
		2260	$_->clear_links_to ($self) for values %cf::MAP;
1587	$self->clear;	2261	$self->clear;
1588
1589	$_->clear_links_to ($self) for values %cf::MAP;
1590		2262
1591	$self->unlink_save;	2263	$self->unlink_save;
1592	$self->destroy;	2264	$self->destroy;
1593	}	2265	}
1594		2266
1595	my $nuke_counter = "aaaa";	2267	my $nuke_counter = "aaaa";
1596		2268
1597	sub nuke {	2269	sub nuke {
1598	my ($self) = @_;	2270	my ($self) = @_;
1599		2271
		2272	{
		2273	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2274
1600	delete $cf::MAP{$self->path};	2275	delete $cf::MAP{$self->path};
1601		2276
1602	$self->unlink_save;	2277	$self->unlink_save;
1603		2278
1604	bless $self, "cf::map";	2279	bless $self, "cf::map";
1605	delete $self->{deny_reset};	2280	delete $self->{deny_reset};
1606	$self->{deny_save} = 1;	2281	$self->{deny_save} = 1;
1607	$self->reset_timeout (1);	2282	$self->reset_timeout (1);
1608	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2283	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1609		2284
1610	$cf::MAP{$self->path} = $self;	2285	$cf::MAP{$self->path} = $self;
		2286	}
1611		2287
1612	$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	]
1613	}	2325	}
1614		2326
1615	=item cf::map::unique_maps	2327	=item cf::map::unique_maps
1616		2328
1617	Returns an arrayref of paths of all shared maps that have	2329	Returns an arrayref of paths of all shared maps that have
1618	instantiated unique items. May block.	2330	instantiated unique items. May block.
1619		2331
1620	=cut	2332	=cut
1621		2333
1622	sub unique_maps() {	2334	sub unique_maps() {
1623	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2335	[
1624	or return;	2336	map {
1625
1626	my @paths;
1627
1628	for (@$files) {
1629	utf8::decode $_;	2337	utf8::decode $_;
1630	next if /\.pst$/;	2338	s/\.map$//; # TODO future compatibility hack
1631	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	}
1632		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) {
1633	s/\.map$//;	2367	s/\.map$// or next;
1634	push @paths, $_;	2368	utf8::decode $_;
1635	}	2369	push @maps, "$dir/$_";
		2370	}
1636		2371
1637	\@paths	2372	push @dirs, map "$dir/$_", @$dirs;
1638	}	2373	}
1639		2374
1640	package cf;	2375	\@maps
		2376	}
1641		2377
1642	=back	2378	=back
1643		2379
1644	=head3 cf::object	2380	=head3 cf::object
1645		2381
…		…
1649		2385
1650	=over 4	2386	=over 4
1651		2387
1652	=item $ob->inv_recursive	2388	=item $ob->inv_recursive
1653		2389
1654	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.
1655		2392
1656	=cut	2393	=cut
1657		2394
1658	sub inv_recursive_;	2395	sub inv_recursive_;
1659	sub inv_recursive_ {	2396	sub inv_recursive_ {
…		…
1662		2399
1663	sub inv_recursive {	2400	sub inv_recursive {
1664	inv_recursive_ inv $_[0]	2401	inv_recursive_ inv $_[0]
1665	}	2402	}
1666		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
1667	package cf;	2432	package cf;
1668		2433
1669	=back	2434	=back
1670		2435
1671	=head3 cf::object::player	2436	=head3 cf::object::player
…		…
1677	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>
1678	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
1679	dialogue with the given NPC character.	2444	dialogue with the given NPC character.
1680		2445
1681	=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	};
1682		2461
1683	# rough implementation of a future "reply" method that works	2462	# rough implementation of a future "reply" method that works
1684	# with dialog boxes.	2463	# with dialog boxes.
1685	#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
1686	sub cf::object::player::reply($$$;$) {	2465	sub cf::object::player::reply($$$;$) {
…		…
1688		2467
1689	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2468	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1690		2469
1691	if ($self->{record_replies}) {	2470	if ($self->{record_replies}) {
1692	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2471	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2472
1693	} 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 {
1694	$msg = $npc->name . " says: $msg" if $npc;	2481	$msg = $npc->name . " says: $msg" if $npc;
1695	$self->message ($msg, $flags);	2482	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2483	}
1696	}	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 (@_);
1697	}	2495	}
1698		2496
1699	=item $player_object->may ("access")	2497	=item $player_object->may ("access")
1700		2498
1701	Returns wether the given player is authorized to access resource "access"	2499	Returns wether the given player is authorized to access resource "access"
…		…
1714		2512
1715	=item $player_object->enter_link	2513	=item $player_object->enter_link
1716		2514
1717	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}>).
1718		2516
1719	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.
1720	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.
1721		2521
1722	Will never block.	2522	Will never block.
1723		2523
1724	=item $player_object->leave_link ($map, $x, $y)	2524	=item $player_object->leave_link ($map, $x, $y)
1725		2525
…		…
1748	$self->deactivate_recursive;	2548	$self->deactivate_recursive;
1749		2549
1750	return if UNIVERSAL::isa $self->map, "ext::map_link";	2550	return if UNIVERSAL::isa $self->map, "ext::map_link";
1751		2551
1752	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2552	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1753	if $self->map;	2553	if $self->map && $self->map->{path} ne "{link}";
1754		2554
1755	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2555	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1756	}	2556	}
1757		2557
1758	sub cf::object::player::leave_link {	2558	sub cf::object::player::leave_link {
1759	my ($self, $map, $x, $y) = @_;	2559	my ($self, $map, $x, $y) = @_;
		2560
		2561	return unless $self->contr->active;
1760		2562
1761	my $link_pos = delete $self->{_link_pos};	2563	my $link_pos = delete $self->{_link_pos};
1762		2564
1763	unless ($map) {	2565	unless ($map) {
1764	# restore original map position	2566	# restore original map position
…		…
1775	($x, $y) = (-1, -1)	2577	($x, $y) = (-1, -1)
1776	unless (defined $x) && (defined $y);	2578	unless (defined $x) && (defined $y);
1777		2579
1778	# use -1 or undef as default coordinates, not 0, 0	2580	# use -1 or undef as default coordinates, not 0, 0
1779	($x, $y) = ($map->enter_x, $map->enter_y)	2581	($x, $y) = ($map->enter_x, $map->enter_y)
1780	if $x <=0 && $y <= 0;	2582	if $x <= 0 && $y <= 0;
1781		2583
1782	$map->load;	2584	$map->load;
1783	$map->load_diag;	2585	$map->load_neighbours;
1784		2586
1785	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
1786	$self->activate_recursive;	2593	$self->activate_recursive;
1787	$self->enter_map ($map, $x, $y);
1788	}	2594	}
1789		2595
1790	cf::player->attach (	2596	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1791	on_logout => sub {
1792	my ($pl) = @_;
1793		2597
1794	# abort map switching before logout	2598	Moves the player to the given map-path and coordinates by first freezing
1795	if ($pl->ob->{_link_pos}) {	2599	her, loading and preparing them map, calling the provided $check callback
1796	cf::sync_job {	2600	that has to return the map if sucecssful, and then unfreezes the player on
1797	$pl->ob->leave_link	2601	the new (success) or old (failed) map position. In either case, $done will
1798	};	2602	be called at the end of this process.
1799	}
1800	},
1801	on_login => sub {
1802	my ($pl) = @_;
1803		2603
1804	# try to abort aborted map switching on player login :)	2604	Note that $check will be called with a potentially non-loaded map, so if
1805	# should happen only on crashes	2605	it needs a loaded map it has to call C<< ->load >>.
1806	if ($pl->ob->{_link_pos}) {
1807	$pl->ob->enter_link;
1808	(async {
1809	# we need this sleep as the login has a concurrent enter_exit running
1810	# and this sleep increases chances of the player not ending up in scorn
1811	$pl->ob->reply (undef,
1812	"There was an internal problem at your last logout, "
1813	. "the server will try to bring you to your intended destination in a second.",
1814	cf::NDI_RED);
1815	Coro::Timer::sleep 1;
1816	$pl->ob->leave_link;
1817	})->prio (2);
1818	}
1819	},
1820	);
1821		2606
1822	=item $player_object->goto ($path, $x, $y)
1823
1824	=cut	2607	=cut
		2608
		2609	our $GOTOGEN;
1825		2610
1826	sub cf::object::player::goto {	2611	sub cf::object::player::goto {
1827	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;
1828		2616
1829	$self->enter_link;	2617	$self->enter_link;
1830		2618
1831	(async {	2619	(async {
1832	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) {
1833	$map = $map->customise_for ($self) if $map;	2645	$map = $map->customise_for ($self);
1834		2646	$map = $check->($map) if $check && $map;
1835	# warn "entering ", $map->path, " at ($x, $y)\n"	2647	} else {
1836	# if $map;
1837
1838	$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	}
1839		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};
1840	$self->leave_link ($map, $x, $y);	2661	$self->leave_link ($map, $x, $y);
		2662	}
		2663
		2664	$done->() if $done;
1841	})->prio (1);	2665	})->prio (1);
1842	}	2666	}
1843		2667
1844	=item $player_object->enter_exit ($exit_object)	2668	=item $player_object->enter_exit ($exit_object)
1845		2669
…		…
1865	}	2689	}
1866		2690
1867	sub prepare_random_map {	2691	sub prepare_random_map {
1868	my ($exit) = @_;	2692	my ($exit) = @_;
1869		2693
1870	my $guard = cf::lock_acquire "exit_prepare:$exit";
1871
1872	# all this does is basically replace the /! path by	2694	# all this does is basically replace the /! path by
1873	# a new random map path (?random/...) with a seed	2695	# a new random map path (?random/...) with a seed
1874	# that depends on the exit object	2696	# that depends on the exit object
1875		2697
1876	my $rmp = parse_random_map_params $exit->msg;	2698	my $rmp = parse_random_map_params $exit->msg;
1877		2699
1878	if ($exit->map) {	2700	if ($exit->map) {
1879	$rmp->{region} = $exit->map->region_name;	2701	$rmp->{region} = $exit->region->name;
1880	$rmp->{origin_map} = $exit->map->path;	2702	$rmp->{origin_map} = $exit->map->path;
1881	$rmp->{origin_x} = $exit->x;	2703	$rmp->{origin_x} = $exit->x;
1882	$rmp->{origin_y} = $exit->y;	2704	$rmp->{origin_y} = $exit->y;
		2705
		2706	$exit->map->touch;
1883	}	2707	}
1884		2708
1885	$rmp->{random_seed} ||= $exit->random_seed;	2709	$rmp->{random_seed} ||= $exit->random_seed;
1886		2710
1887	my $data = cf::to_json $rmp;	2711	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1888	my $md5 = Digest::MD5::md5_hex $data;	2712	my $md5 = Digest::MD5::md5_hex $data;
1889	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2713	my $meta = "$RANDOMDIR/$md5.meta";
1890		2714
1891	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2715	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1892	aio_write $fh, 0, (length $data), $data, 0;	2716	aio_write $fh, 0, (length $data), $data, 0;
1893	undef $fh;	2717	undef $fh;
1894	aio_rename "$meta~", $meta;	2718	aio_rename "$meta~", $meta;
1895		2719
		2720	my $slaying = "?random/$md5";
		2721
		2722	if ($exit->valid) {
1896	$exit->slaying ("?random/$md5");	2723	$exit->slaying ("?random/$md5");
1897	$exit->msg (undef);	2724	$exit->msg (undef);
		2725	}
1898	}	2726	}
1899	}	2727	}
1900		2728
1901	sub cf::object::player::enter_exit {	2729	sub cf::object::player::enter_exit {
1902	my ($self, $exit) = @_;	2730	my ($self, $exit) = @_;
1903		2731
1904	return unless $self->type == cf::PLAYER;	2732	return unless $self->type == cf::PLAYER;
1905		2733
1906	if ($exit->slaying eq "/!") {
1907	#TODO: this should de-fi-ni-te-ly not be a sync-job
1908	cf::sync_job { prepare_random_map $exit };
1909	}
1910
1911	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1912	my $hp = $exit->stats->hp;
1913	my $sp = $exit->stats->sp;
1914
1915	$self->enter_link;	2734	$self->enter_link;
1916		2735
1917	(async {	2736	(async {
1918	$self->deactivate_recursive; # just to be sure	2737	$Coro::current->{desc} = "enter_exit";
		2738
1919	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
		2746	prepare_random_map $exit
		2747	if $exit->slaying eq "/!";
		2748	}
		2749
		2750	my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2751	my $x = $exit->stats->hp;
		2752	my $y = $exit->stats->sp;
		2753
1920	$self->goto ($slaying, $hp, $sp);	2754	$self->goto ($map, $x, $y);
1921		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
1922	1;	2760	1
1923	}) {	2761	}) {
1924	$self->message ("Something went wrong deep within the crossfire server. "	2762	$self->message ("Something went wrong deep within the deliantra server. "
1925	. "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. "
1926	. "Please report this to the dungeon master!",	2764	. "Please report this to the dungeon master!",
1927	cf::NDI_UNIQUE | cf::NDI_RED);	2765	cf::NDI_UNIQUE | cf::NDI_RED);
1928		2766
1929	warn "ERROR in enter_exit: $@";	2767	warn "ERROR in enter_exit: $@";
1930	$self->leave_link;	2768	$self->leave_link;
1931	}	2769	}
1932	})->prio (1);	2770	})->prio (1);
…		…
1945		2783
1946	sub cf::client::send_drawinfo {	2784	sub cf::client::send_drawinfo {
1947	my ($self, $text, $flags) = @_;	2785	my ($self, $text, $flags) = @_;
1948		2786
1949	utf8::encode $text;	2787	utf8::encode $text;
1950	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2788	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1951	}	2789	}
1952		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	}
1953		3012
1954	=item $success = $client->query ($flags, "text", \&cb)	3013	=item $success = $client->query ($flags, "text", \&cb)
1955		3014
1956	Queues a query to the client, calling the given callback with	3015	Queues a query to the client, calling the given callback with
1957	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>,
1958	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>.
1959		3018
1960	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
1961	reliable at some point in the future.	3020	become reliable at some point in the future.
1962		3021
1963	=cut	3022	=cut
1964		3023
1965	sub cf::client::query {	3024	sub cf::client::query {
1966	my ($self, $flags, $text, $cb) = @_;	3025	my ($self, $flags, $text, $cb) = @_;
…		…
1974	utf8::encode $text;	3033	utf8::encode $text;
1975	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	3034	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1976		3035
1977	$self->send_packet ($self->{query_queue}[0][0])	3036	$self->send_packet ($self->{query_queue}[0][0])
1978	if @{ $self->{query_queue} } == 1;	3037	if @{ $self->{query_queue} } == 1;
		3038
		3039	1
1979	}	3040	}
1980		3041
1981	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	},
1982	on_reply => sub {	3048	on_reply => sub {
1983	my ($ns, $msg) = @_;	3049	my ($ns, $msg) = @_;
1984		3050
1985	# this weird shuffling is so that direct followup queries	3051	# this weird shuffling is so that direct followup queries
1986	# get handled first	3052	# get handled first
1987	my $queue = delete $ns->{query_queue}	3053	my $queue = delete $ns->{query_queue}
1988	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
1989		3055
1990	(shift @$queue)->[1]->($msg);	3056	(shift @$queue)->[1]->($msg);
		3057	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1991		3058
1992	push @{ $ns->{query_queue} }, @$queue;	3059	push @{ $ns->{query_queue} }, @$queue;
1993		3060
1994	if (@{ $ns->{query_queue} } == @$queue) {	3061	if (@{ $ns->{query_queue} } == @$queue) {
1995	if (@$queue) {	3062	if (@$queue) {
…		…
1997	} else {	3064	} else {
1998	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3065	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1999	}	3066	}
2000	}	3067	}
2001	},	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	},
2002	);	3095	);
2003		3096
2004	=item $client->async (\&cb)	3097	=item $client->async (\&cb)
2005		3098
2006	Create a new coroutine, running the specified callback. The coroutine will	3099	Create a new coroutine, running the specified callback. The coroutine will
…		…
2047	our $safe = new Safe "safe";	3140	our $safe = new Safe "safe";
2048	our $safe_hole = new Safe::Hole;	3141	our $safe_hole = new Safe::Hole;
2049		3142
2050	$SIG{FPE} = 'IGNORE';	3143	$SIG{FPE} = 'IGNORE';
2051		3144
2052	$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	));
2053		3150
2054	# here we export the classes and methods available to script code	3151	# here we export the classes and methods available to script code
2055		3152
2056	=pod	3153	=pod
2057		3154
2058	The following fucntions and emthods are available within a safe environment:	3155	The following functions and methods are available within a safe environment:
2059		3156
2060	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
2061	cf::object::player player	3162	cf::object::player
2062	cf::player peaceful	3163	player
2063	cf::map trigger	3164
		3165	cf::player
		3166	peaceful
		3167
		3168	cf::map
		3169	trigger
2064		3170
2065	=cut	3171	=cut
2066		3172
2067	for (	3173	for (
2068	["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)],
2069	["cf::object::player" => qw(player)],	3177	["cf::object::player" => qw(player)],
2070	["cf::player" => qw(peaceful)],	3178	["cf::player" => qw(peaceful send_msg)],
2071	["cf::map" => qw(trigger)],	3179	["cf::map" => qw(trigger)],
2072	) {	3180	) {
2073	no strict 'refs';	3181	no strict 'refs';
2074	my ($pkg, @funs) = @$_;	3182	my ($pkg, @funs) = @$_;
2075	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3183	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
…		…
2093		3201
2094	my $qcode = $code;	3202	my $qcode = $code;
2095	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3203	$qcode =~ s/"/‟/g; # not allowed in #line filenames
2096	$qcode =~ s/\n/\\n/g;	3204	$qcode =~ s/\n/\\n/g;
2097		3205
		3206	%vars = (_dummy => 0) unless %vars;
		3207
		3208	my @res;
2098	local $_;	3209	local $_;
2099	local @safe::cf::_safe_eval_args = values %vars;
2100		3210
2101	my $eval =	3211	my $eval =
2102	"do {\n"	3212	"do {\n"
2103	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	3213	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
2104	. "#line 0 \"{$qcode}\"\n"	3214	. "#line 0 \"{$qcode}\"\n"
2105	. $code	3215	. $code
2106	. "\n}"	3216	. "\n}"
2107	;	3217	;
2108		3218
		3219	if ($CFG{safe_eval}) {
2109	sub_generation_inc;	3220	sub_generation_inc;
		3221	local @safe::cf::_safe_eval_args = values %vars;
2110	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);	3222	@res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
2111	sub_generation_inc;	3223	sub_generation_inc;
		3224	} else {
		3225	local @cf::_safe_eval_args = values %vars;
		3226	@res = wantarray ? eval eval : scalar eval $eval;
		3227	}
2112		3228
2113	if ($@) {	3229	if ($@) {
2114	warn "$@";	3230	warn "$@";
2115	warn "while executing safe code '$code'\n";	3231	warn "while executing safe code '$code'\n";
2116	warn "with arguments " . (join " ", %vars) . "\n";	3232	warn "with arguments " . (join " ", %vars) . "\n";
…		…
2135	=cut	3251	=cut
2136		3252
2137	sub register_script_function {	3253	sub register_script_function {
2138	my ($fun, $cb) = @_;	3254	my ($fun, $cb) = @_;
2139		3255
2140	no strict 'refs';	3256	$fun = "safe::$fun" if $CFG{safe_eval};
2141	*{"safe::$fun"} = $safe_hole->wrap ($cb);	3257	*$fun = $safe_hole->wrap ($cb);
2142	}	3258	}
2143		3259
2144	=back	3260	=back
2145		3261
2146	=cut	3262	=cut
2147		3263
2148	#############################################################################	3264	#############################################################################
		3265	# the server's init and main functions
2149		3266
2150	=head2 EXTENSION DATABASE SUPPORT	3267	sub load_facedata($) {
		3268	my ($path) = @_;
2151		3269
2152	Crossfire maintains a very simple database for extension use. It can	3270	# HACK to clear player env face cache, we need some signal framework
2153	currently store anything that can be serialised using Storable, which	3271	# for this (global event?)
2154	excludes objects.	3272	%ext::player_env::MUSIC_FACE_CACHE = ();
2155		3273
2156	The parameter C<$family> should best start with the name of the extension	3274	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2157	using it, it should be unique.
2158		3275
2159	=over 4	3276	warn "loading facedata from $path\n";
2160		3277
2161	=item $hashref = cf::db_get $family	3278	my $facedata;
		3279	0 < aio_load $path, $facedata
		3280	or die "$path: $!";
2162		3281
2163	Return a hashref for use by the extension C<$family>, which can be	3282	$facedata = Coro::Storable::thaw $facedata;
2164	modified. After modifications, you have to call C<cf::db_dirty> or
2165	C<cf::db_sync>.
2166		3283
2167	=item $value = cf::db_get $family => $key	3284	$facedata->{version} == 2
		3285	or cf::cleanup "$path: version mismatch, cannot proceed.";
2168		3286
2169	Returns a single value from the database	3287	# patch in the exptable
2170		3288	my $exp_table = $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]);
2171	=item cf::db_put $family => $hashref	3289	$facedata->{resource}{"res/exp_table"} = {
2172		3290	type => FT_RSRC,
2173	Stores the given family hashref into the database. Updates are delayed, if	3291	data => $exp_table,
2174	you want the data to be synced to disk immediately, use C<cf::db_sync>.	3292	hash => (Digest::MD5::md5 $exp_table),
2175
2176	=item cf::db_put $family => $key => $value
2177
2178	Stores the given C<$value> in the family hash. Updates are delayed, if you
2179	want the data to be synced to disk immediately, use C<cf::db_sync>.
2180
2181	=item cf::db_dirty
2182
2183	Marks the database as dirty, to be updated at a later time.
2184
2185	=item cf::db_sync
2186
2187	Immediately write the database to disk I<if it is dirty>.
2188
2189	=cut
2190
2191	our $DB;
2192
2193	{
2194	my $path = cf::localdir . "/database.pst";
2195
2196	sub db_load() {
2197	$DB = stat $path ? Storable::retrieve $path : { };
2198	}	3293	};
		3294	cf::cede_to_tick;
2199		3295
2200	my $pid;
2201
2202	sub db_save() {
2203	waitpid $pid, 0 if $pid;
2204	if (0 == ($pid = fork)) {
2205	$DB->{_meta}{version} = 1;
2206	Storable::nstore $DB, "$path~";
2207	rename "$path~", $path;
2208	cf::_exit 0 if defined $pid;
2209	}
2210	}	3296	{
		3297	my $faces = $facedata->{faceinfo};
2211		3298
2212	my $dirty;	3299	while (my ($face, $info) = each %$faces) {
		3300	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2213		3301
2214	sub db_sync() {	3302	cf::face::set_visibility $idx, $info->{visibility};
2215	db_save if $dirty;	3303	cf::face::set_magicmap $idx, $info->{magicmap};
2216	undef $dirty;	3304	cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
2217	}	3305	cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
2218		3306
2219	my $idle = Event->idle (	3307	cf::cede_to_tick;
2220	reentrant => 0,
2221	min => 10,
2222	max => 20,
2223	repeat => 0,
2224	data => WF_AUTOCANCEL,
2225	cb => \&db_sync,
2226	);
2227
2228	sub db_dirty() {
2229	$dirty = 1;
2230	$idle->start;
2231	}
2232
2233	sub db_get($;$) {
2234	@_ >= 2
2235	? $DB->{$_[0]}{$_[1]}
2236	: ($DB->{$_[0]} ||= { })
2237	}
2238
2239	sub db_put($$;$) {
2240	if (@_ >= 3) {
2241	$DB->{$_[0]}{$_[1]} = $_[2];
2242	} else {
2243	$DB->{$_[0]} = $_[1];
2244	}
2245	db_dirty;
2246	}
2247
2248	cf::global->attach (
2249	prio => 10000,
2250	on_cleanup => sub {
2251	db_sync;
2252	},	3308	}
2253	);
2254	}
2255		3309
2256	#############################################################################	3310	while (my ($face, $info) = each %$faces) {
2257	# the server's main()	3311	next unless $info->{smooth};
2258		3312
2259	sub cfg_load {	3313	my $idx = cf::face::find $face
		3314	or next;
		3315
		3316	if (my $smooth = cf::face::find $info->{smooth}) {
		3317	cf::face::set_smooth $idx, $smooth;
		3318	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3319	} else {
		3320	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3321	}
		3322
		3323	cf::cede_to_tick;
		3324	}
		3325	}
		3326
		3327	{
		3328	my $anims = $facedata->{animinfo};
		3329
		3330	while (my ($anim, $info) = each %$anims) {
		3331	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3332	cf::cede_to_tick;
		3333	}
		3334
		3335	cf::anim::invalidate_all; # d'oh
		3336	}
		3337
		3338	{
		3339	my $res = $facedata->{resource};
		3340
		3341	while (my ($name, $info) = each %$res) {
		3342	if (defined $info->{type}) {
		3343	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3344
		3345	cf::face::set_data $idx, 0, $info->{data}, $info->{hash};
		3346	cf::face::set_type $idx, $info->{type};
		3347	} else {
		3348	$RESOURCE{$name} = $info;
		3349	}
		3350
		3351	cf::cede_to_tick;
		3352	}
		3353	}
		3354
		3355	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3356
		3357	1
		3358	}
		3359
		3360	cf::global->attach (on_resource_update => sub {
		3361	if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
		3362	$soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
		3363
		3364	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3365	my $sound = $soundconf->{compat}[$_]
		3366	or next;
		3367
		3368	my $face = cf::face::find "sound/$sound->[1]";
		3369	cf::sound::set $sound->[0] => $face;
		3370	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3371	}
		3372
		3373	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3374	my $face = cf::face::find "sound/$v";
		3375	cf::sound::set $k => $face;
		3376	}
		3377	}
		3378	});
		3379
		3380	register_exticmd fx_want => sub {
		3381	my ($ns, $want) = @_;
		3382
		3383	while (my ($k, $v) = each %$want) {
		3384	$ns->fx_want ($k, $v);
		3385	}
		3386	};
		3387
		3388	sub load_resource_file($) {
		3389	my $guard = lock_acquire "load_resource_file";
		3390
		3391	my $status = load_resource_file_ $_[0];
		3392	get_slot 0.1, 100;
		3393	cf::arch::commit_load;
		3394
		3395	$status
		3396	}
		3397
		3398	sub reload_regions {
		3399	# HACK to clear player env face cache, we need some signal framework
		3400	# for this (global event?)
		3401	%ext::player_env::MUSIC_FACE_CACHE = ();
		3402
		3403	load_resource_file "$MAPDIR/regions"
		3404	or die "unable to load regions file\n";
		3405
		3406	for (cf::region::list) {
		3407	$_->{match} = qr/$_->{match}/
		3408	if exists $_->{match};
		3409	}
		3410	}
		3411
		3412	sub reload_facedata {
		3413	load_facedata "$DATADIR/facedata"
		3414	or die "unable to load facedata\n";
		3415	}
		3416
		3417	sub reload_archetypes {
		3418	load_resource_file "$DATADIR/archetypes"
		3419	or die "unable to load archetypes\n";
		3420	}
		3421
		3422	sub reload_treasures {
		3423	load_resource_file "$DATADIR/treasures"
		3424	or die "unable to load treasurelists\n";
		3425	}
		3426
		3427	sub reload_resources {
		3428	warn "reloading resource files...\n";
		3429
		3430	reload_facedata;
		3431	reload_archetypes;
		3432	reload_regions;
		3433	reload_treasures;
		3434
		3435	warn "finished reloading resource files\n";
		3436	}
		3437
		3438	sub reload_config {
		3439	warn "reloading config file...\n";
		3440
2260	open my $fh, "<:utf8", cf::confdir . "/config"	3441	open my $fh, "<:utf8", "$CONFDIR/config"
2261	or return;	3442	or return;
2262		3443
2263	local $/;	3444	local $/;
2264	*CFG = YAML::Syck::Load <$fh>;	3445	*CFG = YAML::XS::Load scalar <$fh>;
2265		3446
2266	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3447	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2267		3448
2268	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	3449	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2269	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};	3450	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
…		…
2273	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"	3454	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2274	and die "WARNING: m(un)lockall failed: $!\n";	3455	and die "WARNING: m(un)lockall failed: $!\n";
2275	};	3456	};
2276	warn $@ if $@;	3457	warn $@ if $@;
2277	}	3458	}
		3459
		3460	warn "finished reloading resource files\n";
		3461	}
		3462
		3463	sub pidfile() {
		3464	sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
		3465	or die "$PIDFILE: $!";
		3466	flock $fh, &Fcntl::LOCK_EX
		3467	or die "$PIDFILE: flock: $!";
		3468	$fh
		3469	}
		3470
		3471	# make sure only one server instance is running at any one time
		3472	sub atomic {
		3473	my $fh = pidfile;
		3474
		3475	my $pid = <$fh>;
		3476	kill 9, $pid if $pid > 0;
		3477
		3478	seek $fh, 0, 0;
		3479	print $fh $$;
		3480	}
		3481
		3482	sub main_loop {
		3483	warn "EV::loop starting\n";
		3484	if (1) {
		3485	EV::loop;
		3486	}
		3487	warn "EV::loop returned\n";
		3488	goto &main_loop unless $REALLY_UNLOOP;
2278	}	3489	}
2279		3490
2280	sub main {	3491	sub main {
		3492	cf::init_globals; # initialise logging
		3493
		3494	LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
		3495	LOG llevInfo, "Copyright (C) 2005-2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
		3496	LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
		3497	LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
		3498
		3499	cf::init_experience;
		3500	cf::init_anim;
		3501	cf::init_attackmess;
		3502	cf::init_dynamic;
		3503
		3504	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3505
2281	# we must not ever block the main coroutine	3506	# we must not ever block the main coroutine
2282	local $Coro::idle = sub {	3507	local $Coro::idle = sub {
2283	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3508	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2284	(async {	3509	(async {
2285	Event::one_event;	3510	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3511	EV::loop EV::LOOP_ONESHOT;
2286	})->prio (Coro::PRIO_MAX);	3512	})->prio (Coro::PRIO_MAX);
2287	};	3513	};
2288		3514
2289	cfg_load;	3515	evthread_start IO::AIO::poll_fileno;
2290	db_load;	3516
		3517	cf::sync_job {
		3518	cf::load_settings;
		3519	cf::load_materials;
		3520
		3521	reload_resources;
		3522	reload_config;
		3523	db_init;
		3524
		3525	cf::init_uuid;
		3526	cf::init_signals;
		3527	cf::init_commands;
		3528	cf::init_skills;
		3529
		3530	cf::init_beforeplay;
		3531
		3532	atomic;
		3533
2291	load_extensions;	3534	load_extensions;
2292		3535
2293	$TICK_WATCHER->start;	3536	utime time, time, $RUNTIMEFILE;
2294	Event::loop;	3537
		3538	# no (long-running) fork's whatsoever before this point(!)
		3539	use POSIX ();
		3540	POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
		3541
		3542	(pop @POST_INIT)->(0) while @POST_INIT;
		3543	};
		3544
		3545	main_loop;
2295	}	3546	}
2296		3547
2297	#############################################################################	3548	#############################################################################
2298	# initialisation and cleanup	3549	# initialisation and cleanup
2299		3550
2300	# install some emergency cleanup handlers	3551	# install some emergency cleanup handlers
2301	BEGIN {	3552	BEGIN {
		3553	our %SIGWATCHER = ();
2302	for my $signal (qw(INT HUP TERM)) {	3554	for my $signal (qw(INT HUP TERM)) {
2303	Event->signal (	3555	$SIGWATCHER{$signal} = EV::signal $signal, sub {
2304	reentrant => 0,
2305	data => WF_AUTOCANCEL,
2306	signal => $signal,
2307	prio => 0,
2308	cb => sub {
2309	cf::cleanup "SIG$signal";	3556	cf::cleanup "SIG$signal";
2310	},
2311	);	3557	};
		3558	}
		3559	}
		3560
		3561	sub write_runtime_sync {
		3562	# first touch the runtime file to show we are still running:
		3563	# the fsync below can take a very very long time.
		3564
		3565	IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
		3566
		3567	my $guard = cf::lock_acquire "write_runtime";
		3568
		3569	my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT, 0644
		3570	or return;
		3571
		3572	my $value = $cf::RUNTIME + 90 + 10;
		3573	# 10 is the runtime save interval, for a monotonic clock
		3574	# 60 allows for the watchdog to kill the server.
		3575
		3576	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3577	and return;
		3578
		3579	# always fsync - this file is important
		3580	aio_fsync $fh
		3581	and return;
		3582
		3583	# touch it again to show we are up-to-date
		3584	aio_utime $fh, undef, undef;
		3585
		3586	close $fh
		3587	or return;
		3588
		3589	aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
		3590	and return;
		3591
		3592	warn "runtime file written.\n";
		3593
2312	}	3594	1
		3595	}
		3596
		3597	our $uuid_lock;
		3598	our $uuid_skip;
		3599
		3600	sub write_uuid_sync($) {
		3601	$uuid_skip ||= $_[0];
		3602
		3603	return if $uuid_lock;
		3604	local $uuid_lock = 1;
		3605
		3606	my $uuid = "$LOCALDIR/uuid";
		3607
		3608	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3609	or return;
		3610
		3611	my $value = uuid_seq uuid_cur;
		3612
		3613	unless ($value) {
		3614	warn "cowardly refusing to write zero uuid value!\n";
		3615	return;
		3616	}
		3617
		3618	my $value = uuid_str $value + $uuid_skip;
		3619	$uuid_skip = 0;
		3620
		3621	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3622	and return;
		3623
		3624	# always fsync - this file is important
		3625	aio_fsync $fh
		3626	and return;
		3627
		3628	close $fh
		3629	or return;
		3630
		3631	aio_rename "$uuid~", $uuid
		3632	and return;
		3633
		3634	warn "uuid file written ($value).\n";
		3635
		3636	1
		3637
		3638	}
		3639
		3640	sub write_uuid($$) {
		3641	my ($skip, $sync) = @_;
		3642
		3643	$sync ? write_uuid_sync $skip
		3644	: async { write_uuid_sync $skip };
2313	}	3645	}
2314		3646
2315	sub emergency_save() {	3647	sub emergency_save() {
2316	my $freeze_guard = cf::freeze_mainloop;	3648	my $freeze_guard = cf::freeze_mainloop;
2317		3649
2318	warn "enter emergency perl save\n";	3650	warn "emergency_perl_save: enter\n";
2319		3651
2320	cf::sync_job {	3652	cf::sync_job {
		3653	# this is a trade-off: we want to be very quick here, so
		3654	# save all maps without fsync, and later call a global sync
		3655	# (which in turn might be very very slow)
		3656	local $USE_FSYNC = 0;
		3657
2321	# use a peculiar iteration method to avoid tripping on perl	3658	# use a peculiar iteration method to avoid tripping on perl
2322	# refcount bugs in for. also avoids problems with players	3659	# refcount bugs in for. also avoids problems with players
2323	# and maps saved/destroyed asynchronously.	3660	# and maps saved/destroyed asynchronously.
2324	warn "begin emergency player save\n";	3661	warn "emergency_perl_save: begin player save\n";
2325	for my $login (keys %cf::PLAYER) {	3662	for my $login (keys %cf::PLAYER) {
2326	my $pl = $cf::PLAYER{$login} or next;	3663	my $pl = $cf::PLAYER{$login} or next;
2327	$pl->valid or next;	3664	$pl->valid or next;
		3665	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2328	$pl->save;	3666	$pl->save;
2329	}	3667	}
2330	warn "end emergency player save\n";	3668	warn "emergency_perl_save: end player save\n";
2331		3669
2332	warn "begin emergency map save\n";	3670	warn "emergency_perl_save: begin map save\n";
2333	for my $path (keys %cf::MAP) {	3671	for my $path (keys %cf::MAP) {
2334	my $map = $cf::MAP{$path} or next;	3672	my $map = $cf::MAP{$path} or next;
2335	$map->valid or next;	3673	$map->valid or next;
2336	$map->save;	3674	$map->save;
2337	}	3675	}
2338	warn "end emergency map save\n";	3676	warn "emergency_perl_save: end map save\n";
		3677
		3678	warn "emergency_perl_save: begin database checkpoint\n";
		3679	BDB::db_env_txn_checkpoint $DB_ENV;
		3680	warn "emergency_perl_save: end database checkpoint\n";
		3681
		3682	warn "emergency_perl_save: begin write uuid\n";
		3683	write_uuid_sync 1;
		3684	warn "emergency_perl_save: end write uuid\n";
2339	};	3685	};
2340		3686
		3687	warn "emergency_perl_save: starting sync()\n";
		3688	IO::AIO::aio_sync sub {
		3689	warn "emergency_perl_save: finished sync()\n";
		3690	};
		3691
2341	warn "leave emergency perl save\n";	3692	warn "emergency_perl_save: leave\n";
2342	}	3693	}
2343		3694
		3695	sub post_cleanup {
		3696	my ($make_core) = @_;
		3697
		3698	warn Carp::longmess "post_cleanup backtrace"
		3699	if $make_core;
		3700
		3701	my $fh = pidfile;
		3702	unlink $PIDFILE if <$fh> == $$;
		3703	}
		3704
		3705	# a safer delete_package, copied from Symbol
		3706	sub clear_package($) {
		3707	my $pkg = shift;
		3708
		3709	# expand to full symbol table name if needed
		3710	unless ($pkg =~ /^main::.*::$/) {
		3711	$pkg = "main$pkg" if $pkg =~ /^::/;
		3712	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		3713	$pkg .= '::' unless $pkg =~ /::$/;
		3714	}
		3715
		3716	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		3717	my $stem_symtab = *{$stem}{HASH};
		3718
		3719	defined $stem_symtab and exists $stem_symtab->{$leaf}
		3720	or return;
		3721
		3722	# clear all symbols
		3723	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		3724	for my $name (keys %$leaf_symtab) {
		3725	_gv_clear *{"$pkg$name"};
		3726	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		3727	}
		3728	warn "cleared package $pkg\n";#d#
		3729	}
		3730
2344	sub reload() {	3731	sub do_reload_perl() {
2345	# can/must only be called in main	3732	# can/must only be called in main
2346	if ($Coro::current != $Coro::main) {	3733	if ($Coro::current != $Coro::main) {
2347	warn "can only reload from main coroutine";	3734	warn "can only reload from main coroutine";
2348	return;	3735	return;
2349	}	3736	}
2350		3737
		3738	return if $RELOAD++;
		3739
		3740	my $t1 = EV::time;
		3741
		3742	while ($RELOAD) {
2351	warn "reloading...";	3743	warn "reloading...";
2352		3744
2353	warn "cancelling server ticker";	3745	warn "entering sync_job";
2354	$TICK_WATCHER->cancel;
2355		3746
		3747	cf::sync_job {
		3748	cf::write_runtime_sync; # external watchdog should not bark
2356	cf::emergency_save;	3749	cf::emergency_save;
		3750	cf::write_runtime_sync; # external watchdog should not bark
2357		3751
2358	eval {	3752	warn "syncing database to disk";
		3753	BDB::db_env_txn_checkpoint $DB_ENV;
		3754
2359	# if anything goes wrong in here, we should simply crash as we already saved	3755	# if anything goes wrong in here, we should simply crash as we already saved
2360		3756
2361	warn "syncing database to disk";
2362	cf::db_sync;
2363
2364	warn "cancelling all WF_AUTOCANCEL watchers";
2365	for (Event::all_watchers) {
2366	$_->cancel if $_->data & WF_AUTOCANCEL;
2367	}
2368
2369	warn "flushing outstanding aio requests";	3757	warn "flushing outstanding aio requests";
2370	for (;;) {	3758	while (IO::AIO::nreqs || BDB::nreqs) {
2371	IO::AIO::flush;	3759	Coro::EV::timer_once 0.01; # let the sync_job do it's thing
2372	Coro::cede;
2373	last unless IO::AIO::nreqs;
2374	warn "iterate...";
2375	}
2376
2377	warn "cancelling all extension coros";
2378	$_->cancel for values %EXT_CORO;
2379	%EXT_CORO = ();
2380
2381	warn "removing commands";
2382	%COMMAND = ();
2383
2384	warn "removing ext commands";
2385	%EXTCMD = ();
2386
2387	warn "unloading/nuking all extensions";
2388	for my $pkg (@EXTS) {
2389	warn "... unloading $pkg";
2390
2391	if (my $cb = $pkg->can ("unload")) {
2392	eval {
2393	$cb->($pkg);
2394	1
2395	} or warn "$pkg unloaded, but with errors: $@";
2396	}	3760	}
2397		3761
2398	warn "... nuking $pkg";	3762	warn "cancelling all extension coros";
2399	Symbol::delete_package $pkg;	3763	$_->cancel for values %EXT_CORO;
2400	}	3764	%EXT_CORO = ();
2401		3765
2402	warn "unloading all perl modules loaded from $LIBDIR";	3766	warn "removing commands";
2403	while (my ($k, $v) = each %INC) {	3767	%COMMAND = ();
2404	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2405		3768
		3769	warn "removing ext/exti commands";
		3770	%EXTCMD = ();
		3771	%EXTICMD = ();
		3772
		3773	warn "unloading/nuking all extensions";
		3774	for my $pkg (@EXTS) {
2406	warn "... unloading $k";	3775	warn "... unloading $pkg";
2407	delete $INC{$k};
2408		3776
2409	$k =~ s/\.pm$//;
2410	$k =~ s/\//::/g;
2411
2412	if (my $cb = $k->can ("unload_module")) {	3777	if (my $cb = $pkg->can ("unload")) {
		3778	eval {
2413	$cb->();	3779	$cb->($pkg);
		3780	1
		3781	} or warn "$pkg unloaded, but with errors: $@";
		3782	}
		3783
		3784	warn "... clearing $pkg";
		3785	clear_package $pkg;
2414	}	3786	}
2415		3787
2416	Symbol::delete_package $k;	3788	warn "unloading all perl modules loaded from $LIBDIR";
		3789	while (my ($k, $v) = each %INC) {
		3790	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		3791
		3792	warn "... unloading $k";
		3793	delete $INC{$k};
		3794
		3795	$k =~ s/\.pm$//;
		3796	$k =~ s/\//::/g;
		3797
		3798	if (my $cb = $k->can ("unload_module")) {
		3799	$cb->();
		3800	}
		3801
		3802	clear_package $k;
2417	}	3803	}
2418		3804
2419	warn "getting rid of safe::, as good as possible";	3805	warn "getting rid of safe::, as good as possible";
2420	Symbol::delete_package "safe::$_"	3806	clear_package "safe::$_"
2421	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3807	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2422		3808
2423	warn "unloading cf.pm \"a bit\"";	3809	warn "unloading cf.pm \"a bit\"";
2424	delete $INC{"cf.pm"};	3810	delete $INC{"cf.pm"};
		3811	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2425		3812
2426	# don't, removes xs symbols, too,	3813	# don't, removes xs symbols, too,
2427	# and global variables created in xs	3814	# and global variables created in xs
2428	#Symbol::delete_package __PACKAGE__;	3815	#clear_package __PACKAGE__;
2429		3816
2430	warn "unload completed, starting to reload now";	3817	warn "unload completed, starting to reload now";
2431		3818
2432	warn "reloading cf.pm";	3819	warn "reloading cf.pm";
2433	require cf;	3820	require cf;
2434	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3821	cf::_connect_to_perl_1;
2435		3822
2436	warn "loading config and database again";	3823	warn "loading config and database again";
2437	cf::cfg_load;	3824	cf::reload_config;
2438	cf::db_load;
2439		3825
2440	warn "loading extensions";	3826	warn "loading extensions";
2441	cf::load_extensions;	3827	cf::load_extensions;
2442		3828
		3829	if ($REATTACH_ON_RELOAD) {
2443	warn "reattaching attachments to objects/players";	3830	warn "reattaching attachments to objects/players";
2444	_global_reattach;	3831	_global_reattach; # objects, sockets
2445	warn "reattaching attachments to maps";	3832	warn "reattaching attachments to maps";
2446	reattach $_ for values %MAP;	3833	reattach $_ for values %MAP;
		3834	warn "reattaching attachments to players";
		3835	reattach $_ for values %PLAYER;
		3836	}
2447		3837
2448	warn "restarting server ticker";	3838	warn "running post_init jobs";
		3839	(pop @POST_INIT)->(1) while @POST_INIT;
2449		3840
2450	$TICK_WATCHER->start;	3841	warn "leaving sync_job";
		3842
		3843	1
		3844	} or do {
		3845	warn $@;
		3846	cf::cleanup "error while reloading, exiting.";
		3847	};
		3848
		3849	warn "reloaded";
		3850	--$RELOAD;
		3851	}
		3852
		3853	$t1 = EV::time - $t1;
		3854	warn "reload completed in ${t1}s\n";
		3855	};
		3856
		3857	our $RELOAD_WATCHER; # used only during reload
		3858
		3859	sub reload_perl() {
		3860	# doing reload synchronously and two reloads happen back-to-back,
		3861	# coro crashes during coro_state_free->destroy here.
		3862
		3863	$RELOAD_WATCHER ||= cf::async {
		3864	Coro::AIO::aio_wait cache_extensions;
		3865
		3866	$RELOAD_WATCHER = EV::timer $TICK * 1.5, 0, sub {
		3867	do_reload_perl;
		3868	undef $RELOAD_WATCHER;
		3869	};
2451	};	3870	};
2452		3871	}
2453	if ($@) {
2454	warn $@;
2455	warn "error while reloading, exiting.";
2456	exit 1;
2457	}
2458
2459	warn "reloaded";
2460	};
2461
2462	our $RELOAD_WATCHER; # used only during reload
2463		3872
2464	register_command "reload" => sub {	3873	register_command "reload" => sub {
2465	my ($who, $arg) = @_;	3874	my ($who, $arg) = @_;
2466		3875
2467	if ($who->flag (FLAG_WIZ)) {	3876	if ($who->flag (FLAG_WIZ)) {
2468	$who->message ("reloading server.");	3877	$who->message ("reloading server.");
2469		3878	async {
2470	# doing reload synchronously and two reloads happen back-to-back,	3879	$Coro::current->{desc} = "perl_reload";
2471	# coro crashes during coro_state_free->destroy here.
2472
2473	$RELOAD_WATCHER ||= Event->timer (
2474	reentrant => 0,
2475	after => 0,
2476	data => WF_AUTOCANCEL,
2477	cb => sub {
2478	reload;	3880	reload_perl;
2479	undef $RELOAD_WATCHER;
2480	},
2481	);	3881	};
2482	}	3882	}
2483	};	3883	};
2484		3884
2485	unshift @INC, $LIBDIR;	3885	unshift @INC, $LIBDIR;
2486		3886
2487	my $bug_warning = 0;	3887	my $bug_warning = 0;
2488		3888
2489	$TICK_WATCHER = Event->timer (	3889	our @WAIT_FOR_TICK;
2490	reentrant => 0,	3890	our @WAIT_FOR_TICK_BEGIN;
2491	parked => 1,	3891
2492	prio => 0,	3892	sub wait_for_tick {
2493	at => $NEXT_TICK || $TICK,	3893	return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
2494	data => WF_AUTOCANCEL,	3894
2495	cb => sub {	3895	my $signal = new Coro::Signal;
		3896	push @WAIT_FOR_TICK, $signal;
		3897	$signal->wait;
		3898	}
		3899
		3900	sub wait_for_tick_begin {
		3901	return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
		3902
		3903	my $signal = new Coro::Signal;
		3904	push @WAIT_FOR_TICK_BEGIN, $signal;
		3905	$signal->wait;
		3906	}
		3907
		3908	sub tick {
2496	if ($Coro::current != $Coro::main) {	3909	if ($Coro::current != $Coro::main) {
2497	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3910	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2498	unless ++$bug_warning > 10;	3911	unless ++$bug_warning > 10;
2499	return;	3912	return;
2500	}	3913	}
2501		3914
2502	$NOW = Event::time;
2503
2504	cf::server_tick; # one server iteration	3915	cf::server_tick; # one server iteration
2505	$RUNTIME += $TICK;
2506	$NEXT_TICK += $TICK;
2507		3916
2508	$WAIT_FOR_TICK->broadcast;	3917	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2509	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3918	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2510		3919	Coro::async_pool {
2511	Event::sweep;	3920	$Coro::current->{desc} = "runtime saver";
2512	Coro::cede_notself;
2513
2514	# my $AFTER = Event::time;
2515	# warn $AFTER - $NOW;#d#
2516
2517	# if we are delayed by four ticks or more, skip them all
2518	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2519
2520	$TICK_WATCHER->at ($NEXT_TICK);
2521	$TICK_WATCHER->start;
2522	},
2523	);
2524
2525	IO::AIO::max_poll_time $TICK * 0.1;
2526
2527	undef $Coro::AIO::WATCHER;
2528	$AIO_POLL_WATCHER = Event->io (
2529	reentrant => 0,
2530	fd => IO::AIO::poll_fileno,
2531	poll => 'r',
2532	prio => 6,
2533	data => WF_AUTOCANCEL,
2534	cb => \&IO::AIO::poll_cb,
2535	);
2536
2537	$WRITE_RUNTIME_WATCHER = Event->timer (
2538	reentrant => 0,
2539	data => WF_AUTOCANCEL,
2540	after => 1,
2541	interval => 10,
2542	prio => 6, # keep it lowest so it acts like a watchdog
2543	cb => Coro::unblock_sub {
2544	write_runtime	3921	write_runtime_sync
2545	or warn "ERROR: unable to write runtime file: $!";	3922	or warn "ERROR: unable to write runtime file: $!";
		3923	};
2546	},	3924	}
2547	);	3925
		3926	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3927	$sig->send;
		3928	}
		3929	while (my $sig = shift @WAIT_FOR_TICK) {
		3930	$sig->send;
		3931	}
		3932
		3933	$LOAD = ($NOW - $TICK_START) / $TICK;
		3934	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3935
		3936	if (0) {
		3937	if ($NEXT_TICK) {
		3938	my $jitter = $TICK_START - $NEXT_TICK;
		3939	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		3940	warn "jitter $JITTER\n";#d#
		3941	}
		3942	}
		3943	}
		3944
		3945	{
		3946	# configure BDB
		3947
		3948	BDB::min_parallel 8;
		3949	BDB::max_poll_reqs $TICK * 0.1;
		3950	$AnyEvent::BDB::WATCHER->priority (1);
		3951
		3952	unless ($DB_ENV) {
		3953	$DB_ENV = BDB::db_env_create;
		3954	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		3955	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		3956	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		3957	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3958	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3959
		3960	cf::sync_job {
		3961	eval {
		3962	BDB::db_env_open
		3963	$DB_ENV,
		3964	$BDBDIR,
		3965	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3966	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3967	0666;
		3968
		3969	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3970	};
		3971
		3972	cf::cleanup "db_env_open(db): $@" if $@;
		3973	};
		3974	}
		3975
		3976	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3977	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3978	};
		3979	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		3980	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3981	};
		3982	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3983	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3984	};
		3985	}
		3986
		3987	{
		3988	# configure IO::AIO
		3989
		3990	IO::AIO::min_parallel 8;
		3991	IO::AIO::max_poll_time $TICK * 0.1;
		3992	undef $AnyEvent::AIO::WATCHER;
		3993	}
		3994
		3995	my $_log_backtrace;
		3996
		3997	sub _log_backtrace {
		3998	my ($msg, @addr) = @_;
		3999
		4000	$msg =~ s/\n//;
		4001
		4002	# limit the # of concurrent backtraces
		4003	if ($_log_backtrace < 2) {
		4004	++$_log_backtrace;
		4005	my $perl_bt = Carp::longmess $msg;
		4006	async {
		4007	$Coro::current->{desc} = "abt $msg";
		4008
		4009	my @bt = fork_call {
		4010	@addr = map { sprintf "%x", $_ } @addr;
		4011	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		4012	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		4013	or die "addr2line: $!";
		4014
		4015	my @funcs;
		4016	my @res = <$fh>;
		4017	chomp for @res;
		4018	while (@res) {
		4019	my ($func, $line) = splice @res, 0, 2, ();
		4020	push @funcs, "[$func] $line";
		4021	}
		4022
		4023	@funcs
		4024	};
		4025
		4026	LOG llevInfo, "[ABT] $perl_bt\n";
		4027	LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
		4028	LOG llevInfo, "[ABT] $_\n" for @bt;
		4029	--$_log_backtrace;
		4030	};
		4031	} else {
		4032	LOG llevInfo, "[ABT] $msg\n";
		4033	LOG llevInfo, "[ABT] [suppressed]\n";
		4034	}
		4035	}
		4036
		4037	# load additional modules
		4038	require "cf/$_.pm" for @EXTRA_MODULES;
		4039	cf::_connect_to_perl_2;
2548		4040
2549	END { cf::emergency_save }	4041	END { cf::emergency_save }
2550		4042
2551	1	4043	1
2552		4044

Diff Legend

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