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.187 by root, Sat Jan 20 21:06:52 2007 UTC vs.
Revision 1.474 by root, Thu Jul 16 21:42:56 2009 UTC

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

Diff Legend

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