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.211 by root, Tue Feb 13 16:23:32 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.5 ();	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 ();
20	use BDB ();	54	use BDB ();
21	use Data::Dumper;	55	use Data::Dumper;
22	use Digest::MD5;	56	use Digest::MD5;
23	use Fcntl;	57	use Fcntl;
		58	use YAML ();
24	use IO::AIO 2.32 ();	59	use IO::AIO ();
25	use YAML::Syck ();
26	use Time::HiRes;	60	use Time::HiRes;
27	use Compress::LZF;	61	use Compress::LZF;
		62	use Digest::MD5 ();
28		63
		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";
29	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later	75	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
30		76
31	use Event; $Event::Eval = 1; # no idea why this is required, but it is	77	# strictly for debugging
		78	$SIG{QUIT} = sub { Carp::cluck "SIGQUIT" };
32		79
33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	80	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34
35	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
36	$YAML::Syck::ImplicitUnicode = 1;
37
38	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
39		81
40	our %COMMAND = ();	82	our %COMMAND = ();
41	our %COMMAND_TIME = ();	83	our %COMMAND_TIME = ();
42		84
43	our @EXTS = (); # list of extension package names	85	our @EXTS = (); # list of extension package names
44	our %EXTCMD = ();	86	our %EXTCMD = ();
		87	our %EXTICMD = ();
45	our %EXT_CORO = (); # coroutines bound to extensions	88	our %EXT_CORO = (); # coroutines bound to extensions
46	our %EXT_MAP = (); # pluggable maps	89	our %EXT_MAP = (); # pluggable maps
47		90
		91	our $RELOAD; # number of reloads so far, non-zero while in reload
48	our @EVENT;	92	our @EVENT;
49	our $LIBDIR = datadir . "/ext";
50		93
51	our $TICK = MAX_TIME * 1e-6;	94	our $CONFDIR = confdir;
52	our $TICK_WATCHER;	95	our $DATADIR = datadir;
53	our $AIO_POLL_WATCHER;	96	our $LIBDIR = "$DATADIR/ext";
54	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
55	our $NEXT_TICK;	112	our $NEXT_TICK;
56	our $NOW;
57	our $USE_FSYNC = 1; # use fsync to write maps - default off	113	our $USE_FSYNC = 1; # use fsync to write maps - default on
58		114
		115	our $BDB_DEADLOCK_WATCHER;
		116	our $BDB_CHECKPOINT_WATCHER;
59	our $BDB_POLL_WATCHER;	117	our $BDB_TRICKLE_WATCHER;
60	our $DB_ENV;	118	our $DB_ENV;
		119
		120	our @EXTRA_MODULES = qw(pod mapscript);
61		121
62	our %CFG;	122	our %CFG;
63		123
64	our $UPTIME; $UPTIME ||= time;	124	our $UPTIME; $UPTIME ||= time;
65	our $RUNTIME;	125	our $RUNTIME;
		126	our $NOW;
66		127
67	our %PLAYER; # all users	128	our (%PLAYER, %PLAYER_LOADING); # all users
68	our %MAP; # all maps	129	our (%MAP, %MAP_LOADING ); # all maps
69	our $LINK_MAP; # the special {link} map, which is always available	130	our $LINK_MAP; # the special {link} map, which is always available
70	our $RANDOM_MAPS = cf::localdir . "/random";
71	our $BDB_ENV_DIR = cf::localdir . "/db";
72
73	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
74	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
75		131
76	# 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 ∕
77	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	133	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
78		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
79	binmode STDOUT;	145	binmode STDOUT;
80	binmode STDERR;	146	binmode STDERR;
81		147
82	# read virtual server time, if available	148	# read virtual server time, if available
83	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	149	unless ($RUNTIME || !-e $RUNTIMEFILE) {
84	open my $fh, "<", cf::localdir . "/runtime"	150	open my $fh, "<", $RUNTIMEFILE
85	or die "unable to read runtime file: $!";	151	or die "unable to read $RUNTIMEFILE file: $!";
86	$RUNTIME = <$fh> + 0.;	152	$RUNTIME = <$fh> + 0.;
87	}	153	}
88		154
89	mkdir cf::localdir;	155	eval "sub TICK() { $TICK } 1" or die;
90	mkdir cf::localdir . "/" . cf::playerdir;	156
91	mkdir cf::localdir . "/" . cf::tmpdir;	157	mkdir $_
92	mkdir cf::localdir . "/" . cf::uniquedir;	158	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
93	mkdir $RANDOM_MAPS;
94	mkdir $BDB_ENV_DIR;
95		159
96	our $EMERGENCY_POSITION;	160	our $EMERGENCY_POSITION;
97		161
98	sub cf::map::normalise;	162	sub cf::map::normalise;
99		163
…		…
110	=item $cf::RUNTIME	174	=item $cf::RUNTIME
111		175
112	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
113	every server tick.	177	every server tick.
114		178
115	=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
116		182
117	The perl library directory, where extensions and cf-specific modules can	183	Various directories - "/etc", read-only install directory, perl-library
118	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.
119		187
120	=item $cf::NOW	188	=item $cf::NOW
121		189
122	The time of the last (current) server tick.	190	The time of the last (current) server tick.
123		191
124	=item $cf::TICK	192	=item $cf::TICK
125		193
126	The interval between server ticks, in seconds.	194	The interval between server ticks, in seconds.
127		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
128	=item %cf::CFG	206	=item %cf::CFG
129		207
130	Configuration for the server, loaded from C</etc/crossfire/config>, or	208	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
131	from wherever your confdir points to.	209	from wherever your confdir points to.
132		210
133	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	211	=item cf::wait_for_tick, cf::wait_for_tick_begin
134		212
135	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
136	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
137	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.
138	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.
139		222
140	=back	223	=back
141		224
142	=cut	225	=cut
143		226
144	BEGIN {	227	BEGIN {
145	*CORE::GLOBAL::warn = sub {	228	*CORE::GLOBAL::warn = sub {
146	my $msg = join "", @_;	229	my $msg = join "", @_;
147	utf8::encode $msg;
148		230
149	$msg .= "\n"	231	$msg .= "\n"
150	unless $msg =~ /\n$/;	232	unless $msg =~ /\n$/;
151		233
		234	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		235
152	LOG llevError, $msg;	236	LOG llevError, $msg;
153	};	237	};
154	}	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#?
155		254
156	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	255	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
157	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	256	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
158	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	257	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
159	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	258	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
160	@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';
161	@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)
162		262
163	# 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
164	# within the Safe compartment.	264	# within the Safe compartment.
165	for my $pkg (qw(	265	for my $pkg (qw(
166	cf::global cf::attachable	266	cf::global cf::attachable
167	cf::object cf::object::player	267	cf::object cf::object::player
168	cf::client cf::player	268	cf::client cf::player
169	cf::arch cf::living	269	cf::arch cf::living
		270	cf::map cf::mapspace
170	cf::map cf::party cf::region	271	cf::party cf::region
171	)) {	272	)) {
172	no strict 'refs';
173	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	273	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
174	}	274	}
175		275
176	$Event::DIED = sub {	276	$EV::DIED = sub {
177	warn "error in event callback: @_";	277	warn "error in event callback: @_";
178	};	278	};
		279
		280	#############################################################################
179		281
180	=head2 UTILITY FUNCTIONS	282	=head2 UTILITY FUNCTIONS
181		283
182	=over 4	284	=over 4
183		285
…		…
202	$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;
203	$d	305	$d
204	} || "[unable to dump $_[0]: '$@']";	306	} || "[unable to dump $_[0]: '$@']";
205	}	307	}
206		308
207	use JSON::Syck (); # TODO# replace by JSON::PC once working
208
209	=item $ref = cf::from_json $json	309	=item $ref = cf::decode_json $json
210		310
211	Converts a JSON string into the corresponding perl data structure.	311	Converts a JSON string into the corresponding perl data structure.
212		312
213	=cut
214
215	sub from_json($) {
216	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
217	JSON::Syck::Load $_[0]
218	}
219
220	=item $json = cf::to_json $ref	313	=item $json = cf::encode_json $ref
221		314
222	Converts a perl data structure into its JSON representation.	315	Converts a perl data structure into its JSON representation.
223		316
224	=cut	317	=cut
225		318
226	sub to_json($) {	319	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
227	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	320
228	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;
229	}	336	}
230		337
231	=item cf::lock_wait $string	338	=item cf::lock_wait $string
232		339
233	Wait until the given lock is available. See cf::lock_acquire.	340	Wait until the given lock is available. See cf::lock_acquire.
234		341
235	=item my $lock = cf::lock_acquire $string	342	=item my $lock = cf::lock_acquire $string
236		343
237	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
238	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,
239	for example when the coroutine gets canceled), the lock is automatically	346	for example when the coroutine gets canceled), the lock is automatically
240	returned.	347	returned.
241		348
		349	Locks are *not* recursive, locking from the same coro twice results in a
		350	deadlocked coro.
		351
242	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
243	uses map_find and cf::map::load uses map_load).	353	uses map_find and cf::map::load uses map_load).
244		354
245	=cut	355	=item $locked = cf::lock_active $string
246		356
247	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;
248		362
249	sub lock_wait($) {	363	sub lock_wait($) {
250	my ($key) = @_;	364	$LOCKS->wait ($_[0]);
251
252	# wait for lock, if any
253	while ($LOCK{$key}) {
254	push @{ $LOCK{$key} }, $Coro::current;
255	Coro::schedule;
256	}
257	}	365	}
258		366
259	sub lock_acquire($) {	367	sub lock_acquire($) {
260	my ($key) = @_;	368	$LOCKS->guard ($_[0])
		369	}
261		370
262	# wait, to be sure we are not locked	371	sub lock_active($) {
263	lock_wait $key;	372	$LOCKS->count ($_[0]) < 1
264
265	$LOCK{$key} = [];
266
267	Coro::guard {
268	# wake up all waiters, to be on the safe side
269	$_->ready for @{ delete $LOCK{$key} };
270	}
271	}	373	}
272		374
273	sub freeze_mainloop {	375	sub freeze_mainloop {
274	return unless $TICK_WATCHER->is_active;	376	tick_inhibit_inc;
275		377
276	my $guard = Coro::guard {	378	&Guard::guard (\&tick_inhibit_dec);
277	$TICK_WATCHER->start;	379	}
278	$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	}
279	};	439	}
280	$WRITE_RUNTIME_WATCHER->stop;	440	};
281	$TICK_WATCHER->stop;	441
282	$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;
283	}	454	}
284		455
285	=item cf::async { BLOCK }	456	=item cf::async { BLOCK }
286		457
287	Currently the same as Coro::async_pool, meaning you cannot use	458	Currently the same as Coro::async_pool, meaning you cannot use
…		…
292		463
293	BEGIN { *async = \&Coro::async_pool }	464	BEGIN { *async = \&Coro::async_pool }
294		465
295	=item cf::sync_job { BLOCK }	466	=item cf::sync_job { BLOCK }
296		467
297	The design of crossfire+ requires that the main coro ($Coro::main) is	468	The design of Deliantra requires that the main coroutine ($Coro::main)
298	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
299	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.
300		472
301	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
302	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
303	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
304	fast or be very important.	476	fast or be very important.
…		…
307		479
308	sub sync_job(&) {	480	sub sync_job(&) {
309	my ($job) = @_;	481	my ($job) = @_;
310		482
311	if ($Coro::current == $Coro::main) {	483	if ($Coro::current == $Coro::main) {
		484	my $time = EV::time;
		485
312	# this is the main coro, too bad, we have to block	486	# this is the main coro, too bad, we have to block
313	# till the operation succeeds, freezing the server :/	487	# till the operation succeeds, freezing the server :/
314		488
315	# TODO: use suspend/resume instead	489	LOG llevError, Carp::longmess "sync job";#d#
316	# (but this is cancel-safe)	490
317	my $freeze_guard = freeze_mainloop;	491	my $freeze_guard = freeze_mainloop;
318		492
319	my $busy = 1;	493	my $busy = 1;
320	my @res;	494	my @res;
321		495
322	(async {	496	(async {
		497	$Coro::current->desc ("sync job coro");
323	@res = eval { $job->() };	498	@res = eval { $job->() };
324	warn $@ if $@;	499	warn $@ if $@;
325	undef $busy;	500	undef $busy;
326	})->prio (Coro::PRIO_MAX);	501	})->prio (Coro::PRIO_MAX);
327		502
328	while ($busy) {	503	while ($busy) {
329	Coro::cede or Event::one_event;	504	if (Coro::nready) {
		505	Coro::cede_notself;
		506	} else {
		507	EV::loop EV::LOOP_ONESHOT;
330	}	508	}
		509	}
		510
		511	my $time = EV::time - $time;
		512
		513	$TICK_START += $time; # do not account sync jobs to server load
331		514
332	wantarray ? @res : $res[0]	515	wantarray ? @res : $res[0]
333	} else {	516	} else {
334	# we are in another coroutine, how wonderful, everything just works	517	# we are in another coroutine, how wonderful, everything just works
335		518
…		…
355	$EXT_CORO{$coro+0} = $coro;	538	$EXT_CORO{$coro+0} = $coro;
356		539
357	$coro	540	$coro
358	}	541	}
359		542
360	sub write_runtime {	543	=item fork_call { }, $args
361	$TICK_WATCHER->is_active or cf::cleanup "mainloop frozen but runtime active", 1;
362		544
363	my $runtime = cf::localdir . "/runtime";	545	Executes the given code block with the given arguments in a seperate
		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.
364		549
365	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	550	=cut
366	or return;
367		551
368	my $value = $cf::RUNTIME + 90 + 10;	552	sub fork_call(&@) {
369	# 10 is the runtime save interval, for a monotonic clock	553	my ($cb, @args) = @_;
370	# 60 allows for the watchdog to kill the server.
371		554
372	(aio_write $fh, 0, (length $value), $value, 0) <= 0	555	# we seemingly have to make a local copy of the whole thing,
373	and return;	556	# otherwise perl prematurely frees the stuff :/
		557	# TODO: investigate and fix (likely this will be rather laborious)
374		558
375	# always fsync - this file is important	559	my @res = Coro::Util::fork_eval {
376	aio_fsync $fh	560	reset_signals;
377	and return;	561	&$cb
		562	}, @args;
378		563
379	close $fh	564	wantarray ? @res : $res[-1]
380	or return;	565	}
381		566
382	aio_rename "$runtime~", $runtime	567	=item $coin = coin_from_name $name
383	and return;
384		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
385	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 });
386	}	730	}
387		731
388	=back	732	=back
389		733
390	=cut	734	=cut
391		735
392	#############################################################################	736	#############################################################################
393		737
394	=head2 ATTACHABLE OBJECTS	738	=head2 ATTACHABLE OBJECTS
395		739
396	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
397	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")
398	to it. All such attachable objects support the following methods.	742	to it. All such attachable objects support the following methods.
399		743
400	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>
401	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
402	crossfire+).	746	Deliantra).
403		747
404	=over 4	748	=over 4
405		749
406	=item $attachable->attach ($attachment, key => $value...)	750	=item $attachable->attach ($attachment, key => $value...)
407		751
…		…
451	=item cf::CLASS::attachment $name, ...	795	=item cf::CLASS::attachment $name, ...
452		796
453	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
454	given CLASS can refer to this attachment.	798	given CLASS can refer to this attachment.
455		799
456	Some classes such as crossfire maps and objects can specify attachments	800	Some classes such as deliantra maps and objects can specify attachments
457	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.
458		802
459	These calls expect any number of the following handler/hook descriptions:	803	These calls expect any number of the following handler/hook descriptions:
460		804
461	=over 4	805	=over 4
…		…
570	$registry = $CB_TYPE[$object_type] ||= [];	914	$registry = $CB_TYPE[$object_type] ||= [];
571		915
572	} elsif ($type eq "subtype") {	916	} elsif ($type eq "subtype") {
573	defined $object_type or Carp::croak "subtype specified without type";	917	defined $object_type or Carp::croak "subtype specified without type";
574	my $object_subtype = shift @arg;	918	my $object_subtype = shift @arg;
575	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	919	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
576		920
577	} elsif ($type eq "package") {	921	} elsif ($type eq "package") {
578	my $pkg = shift @arg;	922	my $pkg = shift @arg;
579		923
580	while (my ($name, $id) = each %cb_id) {	924	while (my ($name, $id) = each %cb_id) {
…		…
609	_attach $registry, $klass, @attach;	953	_attach $registry, $klass, @attach;
610	}	954	}
611		955
612	$obj->{$name} = \%arg;	956	$obj->{$name} = \%arg;
613	} else {	957	} else {
614	warn "object uses attachment '$name' that is not available, postponing.\n";	958	warn "object uses attachment '$name' which is not available, postponing.\n";
615	}	959	}
616		960
617	$obj->{_attachment}{$name} = undef;	961	$obj->{_attachment}{$name} = undef;
618	}	962	}
619		963
…		…
621	if (ref $_[0]) {	965	if (ref $_[0]) {
622	_object_attach @_;	966	_object_attach @_;
623	} else {	967	} else {
624	_attach shift->_attach_registry, @_;	968	_attach shift->_attach_registry, @_;
625	}	969	}
		970	_recalc_want;
626	};	971	};
627		972
628	# all those should be optimised	973	# all those should be optimised
629	sub cf::attachable::detach {	974	sub cf::attachable::detach {
630	my ($obj, $name) = @_;	975	my ($obj, $name) = @_;
…		…
633	delete $obj->{_attachment}{$name};	978	delete $obj->{_attachment}{$name};
634	reattach ($obj);	979	reattach ($obj);
635	} else {	980	} else {
636	Carp::croak "cannot, currently, detach class attachments";	981	Carp::croak "cannot, currently, detach class attachments";
637	}	982	}
		983	_recalc_want;
638	};	984	};
639		985
640	sub cf::attachable::attached {	986	sub cf::attachable::attached {
641	my ($obj, $name) = @_;	987	my ($obj, $name) = @_;
642		988
…		…
657	";	1003	";
658	die if $@;	1004	die if $@;
659	}	1005	}
660		1006
661	our $override;	1007	our $override;
662	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?
663		1009
664	sub override {	1010	sub override {
665	$override = 1;	1011	$override = 1;
666	@invoke_results = ();	1012	@INVOKE_RESULTS = (@_);
667	}	1013	}
668		1014
669	sub do_invoke {	1015	sub do_invoke {
670	my $event = shift;	1016	my $event = shift;
671	my $callbacks = shift;	1017	my $callbacks = shift;
672		1018
673	@invoke_results = ();	1019	@INVOKE_RESULTS = ();
674		1020
675	local $override;	1021	local $override;
676		1022
677	for (@$callbacks) {	1023	for (@$callbacks) {
678	eval { &{$_->[1]} };	1024	eval { &{$_->[1]} };
…		…
687	}	1033	}
688		1034
689	0	1035	0
690	}	1036	}
691		1037
692	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1038	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
693		1039
694	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1040	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
695		1041
696	Generate an object-specific event with the given arguments.	1042	Generate an object-specific event with the given arguments.
697		1043
698	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
699	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
700	results (if you must, access C<@cf::invoke_results> directly).	1046	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
701		1047
702	=back	1048	=back
703		1049
704	=cut	1050	=cut
705		1051
706	#############################################################################	1052	#############################################################################
707	# 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	}
708		1096
709	sub reattach {	1097	sub reattach {
710	# basically do the same as instantiate, without calling instantiate	1098	# basically do the same as instantiate, without calling instantiate
711	my ($obj) = @_;	1099	my ($obj) = @_;
712		1100
		1101	# no longer needed after getting rid of delete_package?
713	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
714		1103
715	my $registry = $obj->registry;	1104	my $registry = $obj->registry;
716		1105
717	@$registry = ();	1106	@$registry = ();
718		1107
…		…
733	cf::attachable->attach (	1122	cf::attachable->attach (
734	prio => -1000000,	1123	prio => -1000000,
735	on_instantiate => sub {	1124	on_instantiate => sub {
736	my ($obj, $data) = @_;	1125	my ($obj, $data) = @_;
737		1126
738	$data = from_json $data;	1127	$data = decode_json $data;
739		1128
740	for (@$data) {	1129	for (@$data) {
741	my ($name, $args) = @$_;	1130	my ($name, $args) = @$_;
742		1131
743	$obj->attach ($name, %{$args || {} });	1132	$obj->attach ($name, %{$args || {} });
…		…
759	sub object_freezer_save {	1148	sub object_freezer_save {
760	my ($filename, $rdata, $objs) = @_;	1149	my ($filename, $rdata, $objs) = @_;
761		1150
762	sync_job {	1151	sync_job {
763	if (length $$rdata) {	1152	if (length $$rdata) {
		1153	utf8::decode (my $decname = $filename);
764	warn sprintf "saving %s (%d,%d)\n",	1154	warn sprintf "saving %s (%d,%d)\n",
765	$filename, length $$rdata, scalar @$objs;	1155	$decname, length $$rdata, scalar @$objs;
766		1156
767	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1157	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
768	chmod SAVE_MODE, $fh;	1158	aio_chmod $fh, SAVE_MODE;
769	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1159	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
770	aio_fsync $fh if $cf::USE_FSYNC;	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;
		1162	aio_fsync $fh;
		1163	}
771	close $fh;	1164	aio_close $fh;
772		1165
773	if (@$objs) {	1166	if (@$objs) {
774	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) {
775	chmod SAVE_MODE, $fh;	1168	aio_chmod $fh, SAVE_MODE;
776	my $data = Storable::nfreeze { version => 1, objs => $objs };	1169	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
777	aio_write $fh, 0, (length $data), $data, 0;	1170	aio_write $fh, 0, (length $data), $data, 0;
778	aio_fsync $fh if $cf::USE_FSYNC;	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;
		1173	aio_fsync $fh;
		1174	}
779	close $fh;	1175	aio_close $fh;
780	aio_rename "$filename.pst~", "$filename.pst";	1176	aio_rename "$filename.pst~", "$filename.pst";
781	}	1177	}
782	} else {	1178	} else {
783	aio_unlink "$filename.pst";	1179	aio_unlink "$filename.pst";
784	}	1180	}
785		1181
786	aio_rename "$filename~", $filename;	1182	aio_rename "$filename~", $filename;
		1183
		1184	$filename =~ s%/[^/]+$%%;
		1185	aio_pathsync $filename if $cf::USE_FSYNC;
787	} else {	1186	} else {
788	warn "FATAL: $filename~: $!\n";	1187	warn "unable to save objects: $filename~: $!\n";
789	}	1188	}
790	} else {	1189	} else {
791	aio_unlink $filename;	1190	aio_unlink $filename;
792	aio_unlink "$filename.pst";	1191	aio_unlink "$filename.pst";
793	}	1192	}
794
795	#d##TODO# nuke non .map-files if exist
796	if ($filename =~ s/\.map$//) {
797	aio_unlink $filename;
798	aio_unlink "$filename.pst";
799	}
800	}	1193	};
801	}	1194	}
802		1195
803	sub object_freezer_as_string {	1196	sub object_freezer_as_string {
804	my ($rdata, $objs) = @_;	1197	my ($rdata, $objs) = @_;
805		1198
…		…
810		1203
811	sub object_thawer_load {	1204	sub object_thawer_load {
812	my ($filename) = @_;	1205	my ($filename) = @_;
813		1206
814	my ($data, $av);	1207	my ($data, $av);
815
816	#d#TODO remove .map if file does not exist
817	aio_stat $filename and $filename =~ s/\.map$//;
818		1208
819	(aio_load $filename, $data) >= 0	1209	(aio_load $filename, $data) >= 0
820	or return;	1210	or return;
821		1211
822	unless (aio_stat "$filename.pst") {	1212	unless (aio_stat "$filename.pst") {
823	(aio_load "$filename.pst", $av) >= 0	1213	(aio_load "$filename.pst", $av) >= 0
824	or return;	1214	or return;
		1215
825	$av = eval { (Storable::thaw $av)->{objs} };	1216	my $st = eval { Coro::Storable::thaw $av };
		1217	$av = $st->{objs};
826	}	1218	}
827		1219
		1220	utf8::decode (my $decname = $filename);
828	warn sprintf "loading %s (%d)\n",	1221	warn sprintf "loading %s (%d,%d)\n",
829	$filename, length $data, scalar @{$av || []};#d#	1222	$decname, length $data, scalar @{$av || []};
		1223
830	return ($data, $av);	1224	($data, $av)
831	}	1225	}
		1226
		1227	=head2 COMMAND CALLBACKS
		1228
		1229	=over 4
		1230
		1231	=cut
832		1232
833	#############################################################################	1233	#############################################################################
834	# command handling &c	1234	# command handling &c
835		1235
836	=item cf::register_command $name => \&callback($ob,$args);	1236	=item cf::register_command $name => \&callback($ob,$args);
…		…
849	push @{ $COMMAND{$name} }, [$caller, $cb];	1249	push @{ $COMMAND{$name} }, [$caller, $cb];
850	}	1250	}
851		1251
852	=item cf::register_extcmd $name => \&callback($pl,$packet);	1252	=item cf::register_extcmd $name => \&callback($pl,$packet);
853		1253
854	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.
855		1259
856	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
857	called.	1261	called.
858		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
859	=cut	1274	=cut
860		1275
861	sub register_extcmd {	1276	sub register_extcmd {
862	my ($name, $cb) = @_;	1277	my ($name, $cb) = @_;
863		1278
864	$EXTCMD{$name} = $cb;	1279	$EXTCMD{$name} = $cb;
865	}	1280	}
		1281
		1282	sub register_exticmd {
		1283	my ($name, $cb) = @_;
		1284
		1285	$EXTICMD{$name} = $cb;
		1286	}
		1287
		1288	use File::Glob ();
866		1289
867	cf::player->attach (	1290	cf::player->attach (
868	on_command => sub {	1291	on_command => sub {
869	my ($pl, $name, $params) = @_;	1292	my ($pl, $name, $params) = @_;
870		1293
…		…
878	cf::override;	1301	cf::override;
879	},	1302	},
880	on_extcmd => sub {	1303	on_extcmd => sub {
881	my ($pl, $buf) = @_;	1304	my ($pl, $buf) = @_;
882		1305
883	my $msg = eval { from_json $buf };	1306	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
884		1307
885	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
886	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1316	if (my $cb = $EXTCMD{$type}) {
887	if (my %reply = $cb->($pl, $msg)) {	1317	@reply = $cb->($pl, @payload);
888	$pl->ext_reply ($msg->{msgid}, %reply);
889	}
890	}	1318	}
		1319
		1320	$pl->ext_reply ($reply, @reply)
		1321	if $reply;
		1322
891	} else {	1323	} else {
892	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1324	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
893	}	1325	}
894		1326
895	cf::override;	1327	cf::override;
896	},	1328	},
897	);	1329	);
898		1330
		1331	# "readahead" all extensions
899	sub load_extension {	1332	sub cache_extensions {
900	my ($path) = @_;	1333	my $grp = IO::AIO::aio_group;
901		1334
902	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1335	add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
903	my $base = $1;	1336	for (grep /\.ext$/, @{$_[0]}) {
904	my $pkg = $1;	1337	add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
905	$pkg =~ s/[^[:word:]]/_/g;
906	$pkg = "ext::$pkg";
907
908	warn "... loading '$path' into '$pkg'\n";
909
910	open my $fh, "<:utf8", $path
911	or die "$path: $!";
912
913	my $source =
914	"package $pkg; use strict; use utf8;\n"
915	. "#line 1 \"$path\"\n{\n"
916	. (do { local $/; <$fh> })
917	. "\n};\n1";
918
919	unless (eval $source) {
920	my $msg = $@ ? "$path: $@\n"
921	: "extension disabled.\n";
922	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
923	warn $@;
924	warn "mandatory extension failed to load, exiting.\n";
925	exit 1;
926	}	1338	}
927	die $@;
928	}	1339	};
929		1340
930	push @EXTS, $pkg;	1341	$grp
931	}	1342	}
932		1343
933	sub load_extensions {	1344	sub load_extensions {
		1345	cf::sync_job {
		1346	my %todo;
		1347
934	for my $ext (<$LIBDIR/*.ext>) {	1348	for my $path (<$LIBDIR/*.ext>) {
935	next unless -r $ext;	1349	next unless -r $path;
936	eval {	1350
937	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;
938	1	1407	}
939	} or warn "$ext not loaded: $@";	1408
		1409	skip:
		1410	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1411	unless $progress;
		1412	}
940	}	1413	};
941	}	1414	}
942		1415
943	#############################################################################	1416	#############################################################################
944		1417
		1418	=back
		1419
945	=head2 CORE EXTENSIONS	1420	=head2 CORE EXTENSIONS
946		1421
947	Functions and methods that extend core crossfire objects.	1422	Functions and methods that extend core deliantra objects.
948		1423
949	=cut	1424	=cut
950		1425
951	package cf::player;	1426	package cf::player;
952		1427
…		…
954		1429
955	=head3 cf::player	1430	=head3 cf::player
956		1431
957	=over 4	1432	=over 4
958		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
959	=item cf::player::find $login	1448	=item cf::player::find $login
960		1449
961	Returns the given player object, loading it if necessary (might block).	1450	Returns the given player object, loading it if necessary (might block).
962		1451
963	=cut	1452	=cut
964		1453
965	sub playerdir($) {	1454	sub playerdir($) {
966	cf::localdir	1455	"$PLAYERDIR/"
967	. "/"
968	. cf::playerdir
969	. "/"
970	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1456	. (ref $_[0] ? $_[0]->ob->name : $_[0])
971	}	1457	}
972		1458
973	sub path($) {	1459	sub path($) {
974	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1460	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
975		1461
976	(playerdir $login) . "/$login.pl"	1462	(playerdir $login) . "/playerdata"
977	}	1463	}
978		1464
979	sub find_active($) {	1465	sub find_active($) {
980	$cf::PLAYER{$_[0]}	1466	$cf::PLAYER{$_[0]}
981	and $cf::PLAYER{$_[0]}->active	1467	and $cf::PLAYER{$_[0]}->active
…		…
984		1470
985	sub exists($) {	1471	sub exists($) {
986	my ($login) = @_;	1472	my ($login) = @_;
987		1473
988	$cf::PLAYER{$login}	1474	$cf::PLAYER{$login}
989	or cf::sync_job { !aio_stat path $login }	1475	or !aio_stat path $login
990	}	1476	}
991		1477
992	sub find($) {	1478	sub find($) {
993	return $cf::PLAYER{$_[0]} || do {	1479	return $cf::PLAYER{$_[0]} || do {
994	my $login = $_[0];	1480	my $login = $_[0];
995		1481
996	my $guard = cf::lock_acquire "user_find:$login";	1482	my $guard = cf::lock_acquire "user_find:$login";
997		1483
998	$cf::PLAYER{$_[0]} || do {	1484	$cf::PLAYER{$_[0]} || do {
999	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
1000	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;
1001	$cf::PLAYER{$login} = $pl	1500	$cf::PLAYER{$login} = $pl
1002	}	1501	}
1003	}	1502	}
1004	}	1503	}
1005		1504
…		…
1014	return if $pl->{deny_save};	1513	return if $pl->{deny_save};
1015		1514
1016	aio_mkdir playerdir $pl, 0770;	1515	aio_mkdir playerdir $pl, 0770;
1017	$pl->{last_save} = $cf::RUNTIME;	1516	$pl->{last_save} = $cf::RUNTIME;
1018		1517
		1518	cf::get_slot 0.01;
		1519
1019	$pl->save_pl ($path);	1520	$pl->save_pl ($path);
1020	Coro::cede;	1521	cf::cede_to_tick;
1021	}	1522	}
1022		1523
1023	sub new($) {	1524	sub new($) {
1024	my ($login) = @_;	1525	my ($login) = @_;
1025		1526
…		…
1031	$cf::PLAYER{$login} = $self;	1532	$cf::PLAYER{$login} = $self;
1032		1533
1033	$self	1534	$self
1034	}	1535	}
1035		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
1036	=item $pl->quit_character	1547	=item $pl->quit_character
1037		1548
1038	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
1039	be destroyed. May block for a long time.	1550	be destroyed. May block for a long time.
1040		1551
1041	=cut	1552	=cut
1042		1553
1043	sub quit_character {	1554	sub quit_character {
1044	my ($pl) = @_;	1555	my ($pl) = @_;
1045		1556
		1557	my $name = $pl->ob->name;
		1558
1046	$pl->{deny_save} = 1;	1559	$pl->{deny_save} = 1;
1047	$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
1048		1561
1049	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1562	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1050	$pl->deactivate;	1563	$pl->deactivate;
		1564	my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
		1565	$pl->ob->check_score;
1051	$pl->invoke (cf::EVENT_PLAYER_QUIT);	1566	$pl->invoke (cf::EVENT_PLAYER_QUIT);
1052	$pl->ns->destroy if $pl->ns;	1567	$pl->ns->destroy if $pl->ns;
1053		1568
1054	my $path = playerdir $pl;	1569	my $path = playerdir $pl;
1055	my $temp = "$path~$cf::RUNTIME~deleting~";	1570	my $temp = "$path~$cf::RUNTIME~deleting~";
1056	aio_rename $path, $temp;	1571	aio_rename $path, $temp;
1057	delete $cf::PLAYER{$pl->ob->name};	1572	delete $cf::PLAYER{$pl->ob->name};
1058	$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
1059	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;
1060	}	1595	}
1061		1596
1062	=item cf::player::list_logins	1597	=item cf::player::list_logins
1063		1598
1064	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
1065	while and may block, so not sync_job-capable, ever.	1600	while and may block, so not sync_job-capable, ever.
1066		1601
1067	=cut	1602	=cut
1068		1603
1069	sub list_logins {	1604	sub list_logins {
1070	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1605	my $dirs = aio_readdir $PLAYERDIR
1071	or return [];	1606	or return [];
1072		1607
1073	my @logins;	1608	my @logins;
1074		1609
1075	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") {
1076	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1616	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1077	aio_read $fh, 0, 512, my $buf, 0 or next;	1617	aio_read $fh, 0, 512, my $buf, 0 or next;
1078	$buf !~ /^password -------------$/m or next; # official not-valid tag	1618	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1619	}
1079		1620
1080	utf8::decode $login;	1621	utf8::decode $login;
1081	push @logins, $login;	1622	push @logins, $login;
1082	}	1623	}
1083		1624
…		…
1110	}	1651	}
1111		1652
1112	\@paths	1653	\@paths
1113	}	1654	}
1114		1655
		1656	=item $protocol_xml = $player->expand_cfpod ($cfpod)
		1657
		1658	Expand deliantra pod fragments into protocol xml.
		1659
1115	=item $player->ext_reply ($msgid, $msgtype, %msg)	1660	=item $player->ext_reply ($msgid, @msg)
1116		1661
1117	Sends an ext reply to the player.	1662	Sends an ext reply to the player.
1118		1663
1119	=cut	1664	=cut
1120		1665
1121	sub ext_reply($$$%) {	1666	sub ext_reply($$@) {
1122	my ($self, $id, %msg) = @_;	1667	my ($self, $id, @msg) = @_;
1123		1668
1124	$msg{msgid} = $id;	1669	$self->ns->ext_reply ($id, @msg)
1125
1126	$self->send ("ext " . cf::to_json \%msg);
1127	}	1670	}
1128		1671
1129	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	}
1130		1712
1131	=back	1713	=back
1132
1133		1714
1134	=head3 cf::map	1715	=head3 cf::map
1135		1716
1136	=over 4	1717	=over 4
1137		1718
…		…
1149	our $MAX_RESET = 3600;	1730	our $MAX_RESET = 3600;
1150	our $DEFAULT_RESET = 3000;	1731	our $DEFAULT_RESET = 3000;
1151		1732
1152	sub generate_random_map {	1733	sub generate_random_map {
1153	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
1154	# mit "rum" bekleckern, nicht	1738	# mit "rum" bekleckern, nicht
1155	$self->_create_random_map (	1739	$self->_create_random_map (
1156	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1740	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1157	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1741	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1158	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1742	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
…		…
1192	my ($self, $merge) = @_;	1776	my ($self, $merge) = @_;
1193		1777
1194	# we have to keep some variables in memory intact	1778	# we have to keep some variables in memory intact
1195	local $self->{path};	1779	local $self->{path};
1196	local $self->{load_path};	1780	local $self->{load_path};
1197	local $self->{deny_save};
1198	local $self->{deny_reset};
1199		1781
1200	$self->SUPER::thawer_merge ($merge);	1782	$self->SUPER::thawer_merge ($merge);
1201	}	1783	}
1202		1784
1203	sub normalise {	1785	sub normalise {
…		…
1250	$self->init; # pass $1 etc.	1832	$self->init; # pass $1 etc.
1251	return $self;	1833	return $self;
1252	}	1834	}
1253	}	1835	}
1254		1836
1255	Carp::carp "unable to resolve path '$path' (base '$base').";	1837	Carp::cluck "unable to resolve path '$path' (base '$base').";
1256	()	1838	()
1257	}	1839	}
1258		1840
1259	sub init {	1841	sub init {
1260	my ($self) = @_;	1842	my ($self) = @_;
…		…
1275		1857
1276	# the original (read-only) location	1858	# the original (read-only) location
1277	sub load_path {	1859	sub load_path {
1278	my ($self) = @_;	1860	my ($self) = @_;
1279		1861
1280	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1862	"$MAPDIR/$self->{path}.map"
1281	}	1863	}
1282		1864
1283	# the temporary/swap location	1865	# the temporary/swap location
1284	sub save_path {	1866	sub save_path {
1285	my ($self) = @_;	1867	my ($self) = @_;
1286		1868
1287	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1869	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1288	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1870	"$TMPDIR/$path.map"
1289	}	1871	}
1290		1872
1291	# the unique path, undef == no special unique path	1873	# the unique path, undef == no special unique path
1292	sub uniq_path {	1874	sub uniq_path {
1293	my ($self) = @_;	1875	my ($self) = @_;
1294		1876
1295	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1877	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1296	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1878	"$UNIQUEDIR/$path"
1297	}	1879	}
1298		1880
1299	# and all this just because we cannot iterate over	1881	sub decay_objects {
1300	# all maps in C++...
1301	sub change_all_map_light {
1302	my ($change) = @_;	1882	my ($self) = @_;
1303		1883
1304	$_->change_map_light ($change)	1884	return if $self->{deny_reset};
1305	for grep $_->outdoor, values %cf::MAP;	1885
		1886	$self->do_decay_objects;
1306	}	1887	}
1307		1888
1308	sub unlink_save {	1889	sub unlink_save {
1309	my ($self) = @_;	1890	my ($self) = @_;
1310		1891
1311	utf8::encode (my $save = $self->save_path);	1892	utf8::encode (my $save = $self->save_path);
1312	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1893	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1313	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";	1894	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1314
1315	#d#TODO remove .map and also nuke
1316	$save =~ s/\.map// or return;#d#
1317	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1318	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1319	}	1895	}
1320		1896
1321	sub load_header_from($) {	1897	sub load_header_from($) {
1322	my ($self, $path) = @_;	1898	my ($self, $path) = @_;
1323		1899
1324	utf8::encode $path;	1900	utf8::encode $path;
1325	#aio_open $path, O_RDONLY, 0	1901	my $f = new_from_file cf::object::thawer $path
1326	# or return;
1327
1328	$self->_load_header ($path)
1329	or return;	1902	or return;
		1903
		1904	$self->_load_header ($f)
		1905	or return;
		1906
		1907	local $MAP_LOADING{$self->{path}} = $self;
		1908	$f->resolve_delayed_derefs;
1330		1909
1331	$self->{load_path} = $path;	1910	$self->{load_path} = $path;
1332		1911
1333	1	1912	1
1334	}	1913	}
…		…
1373	$self->load_header_orig	1952	$self->load_header_orig
1374	or return;	1953	or return;
1375	$self->prepare_orig;	1954	$self->prepare_orig;
1376	}	1955	}
1377		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;
		1962
1378	1	1963	1
1379	}	1964	}
1380		1965
1381	sub find;	1966	sub find;
1382	sub find {	1967	sub find {
1383	my ($path, $origin) = @_;	1968	my ($path, $origin) = @_;
1384		1969
1385	$path = normalise $path, $origin && $origin->path;	1970	$path = normalise $path, $origin && $origin->path;
1386		1971
		1972	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1387	cf::lock_wait "map_find:$path";	1973	my $guard2 = cf::lock_acquire "map_find:$path";
1388		1974
1389	$cf::MAP{$path} || do {	1975	$cf::MAP{$path} || do {
1390	my $guard = cf::lock_acquire "map_find:$path";
1391	my $map = new_from_path cf::map $path	1976	my $map = new_from_path cf::map $path
1392	or return;	1977	or return;
1393		1978
1394	$map->{last_save} = $cf::RUNTIME;	1979	$map->{last_save} = $cf::RUNTIME;
1395		1980
1396	$map->load_header	1981	$map->load_header
1397	or return;	1982	or return;
1398		1983
1399	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1984	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1400	# doing this can freeze the server in a sync job, obviously	1985	# doing this can freeze the server in a sync job, obviously
1401	#$cf::WAIT_FOR_TICK->wait;	1986	#$cf::WAIT_FOR_TICK->wait;
		1987	undef $guard2;
		1988	undef $guard1;
1402	$map->reset;	1989	$map->reset;
1403	undef $guard;
1404	return find $path;	1990	return find $path;
1405	}	1991	}
1406		1992
1407	$cf::MAP{$path} = $map	1993	$cf::MAP{$path} = $map
1408	}	1994	}
…		…
1415	my ($self) = @_;	2001	my ($self) = @_;
1416		2002
1417	local $self->{deny_reset} = 1; # loading can take a long time	2003	local $self->{deny_reset} = 1; # loading can take a long time
1418		2004
1419	my $path = $self->{path};	2005	my $path = $self->{path};
		2006
		2007	{
1420	my $guard = cf::lock_acquire "map_load:$path";	2008	my $guard = cf::lock_acquire "map_data:$path";
1421		2009
		2010	return unless $self->valid;
1422	return if $self->in_memory != cf::MAP_SWAPPED;	2011	return unless $self->in_memory == cf::MAP_SWAPPED;
1423		2012
1424	$self->in_memory (cf::MAP_LOADING);	2013	$self->in_memory (cf::MAP_LOADING);
1425		2014
1426	$self->alloc;	2015	$self->alloc;
1427		2016
1428	$self->pre_load;	2017	$self->pre_load;
		2018	cf::cede_to_tick;
1429		2019
1430	$self->_load_objects ($self->{load_path}, 1)	2020	my $f = new_from_file cf::object::thawer $self->{load_path};
		2021	$f->skip_block;
		2022	$self->_load_objects ($f)
1431	or return;	2023	or return;
1432		2024
1433	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2025	$self->post_load_original
1434	if delete $self->{load_original};	2026	if delete $self->{load_original};
1435		2027
1436	if (my $uniq = $self->uniq_path) {	2028	if (my $uniq = $self->uniq_path) {
1437	utf8::encode $uniq;	2029	utf8::encode $uniq;
1438	if (aio_open $uniq, O_RDONLY, 0) {	2030	unless (aio_stat $uniq) {
		2031	if (my $f = new_from_file cf::object::thawer $uniq) {
1439	$self->clear_unique_items;	2032	$self->clear_unique_items;
1440	$self->_load_objects ($uniq, 0);	2033	$self->_load_objects ($f);
		2034	$f->resolve_delayed_derefs;
		2035	}
1441	}	2036	}
1442	}	2037	}
1443		2038
1444	Coro::cede;	2039	$f->resolve_delayed_derefs;
1445		2040
		2041	cf::cede_to_tick;
1446	# now do the right thing for maps	2042	# now do the right thing for maps
1447	$self->link_multipart_objects;	2043	$self->link_multipart_objects;
1448
1449	unless ($self->{deny_activate}) {
1450	$self->decay_objects;
1451	$self->fix_auto_apply;
1452	$self->update_buttons;
1453	Coro::cede;
1454	$self->set_darkness_map;
1455	$self->difficulty ($self->estimate_difficulty)	2044	$self->difficulty ($self->estimate_difficulty)
1456	unless $self->difficulty;	2045	unless $self->difficulty;
1457	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;
1458	$self->activate;	2053	$self->activate;
		2054	}
		2055
		2056	$self->{last_save} = $cf::RUNTIME;
		2057	$self->last_access ($cf::RUNTIME);
		2058
		2059	$self->in_memory (cf::MAP_ACTIVE);
1459	}	2060	}
1460		2061
1461	$self->post_load;	2062	$self->post_load;
1462
1463	$self->in_memory (cf::MAP_IN_MEMORY);
1464	}	2063	}
1465		2064
1466	sub customise_for {	2065	sub customise_for {
1467	my ($self, $ob) = @_;	2066	my ($self, $ob) = @_;
1468		2067
1469	return find "~" . $ob->name . "/" . $self->{path}	2068	return find "~" . $ob->name . "/" . $self->{path}
1470	if $self->per_player;	2069	if $self->per_player;
1471		2070
		2071	# return find "?party/" . $ob->name . "/" . $self->{path}
		2072	# if $self->per_party;
		2073
1472	$self	2074	$self
1473	}	2075	}
1474		2076
1475	# 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
1476	sub load_diag {	2078	sub load_neighbours {
1477	my ($map) = @_;	2079	my ($map) = @_;
1478		2080
1479	my @diag; # diagonal neighbours	2081	my @neigh; # diagonal neighbours
1480		2082
1481	for (0 .. 3) {	2083	for (0 .. 3) {
1482	my $neigh = $map->tile_path ($_)	2084	my $neigh = $map->tile_path ($_)
1483	or next;	2085	or next;
1484	$neigh = find $neigh, $map	2086	$neigh = find $neigh, $map
1485	or next;	2087	or next;
1486	$neigh->load;	2088	$neigh->load;
1487		2089
		2090	push @neigh,
1488	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2091	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1489	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2092	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1490	}	2093	}
1491		2094
1492	for (@diag) {	2095	for (grep defined $_->[0], @neigh) {
		2096	my ($path, $origin) = @$_;
1493	my $neigh = find @$_	2097	my $neigh = find $path, $origin
1494	or next;	2098	or next;
1495	$neigh->load;	2099	$neigh->load;
1496	}	2100	}
1497	}	2101	}
1498		2102
…		…
1503	}	2107	}
1504		2108
1505	sub do_load_sync {	2109	sub do_load_sync {
1506	my ($map) = @_;	2110	my ($map) = @_;
1507		2111
		2112	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2113	if $Coro::current == $Coro::main;
		2114
1508	cf::sync_job { $map->load };	2115	cf::sync_job { $map->load };
1509	}	2116	}
1510		2117
1511	our %MAP_PREFETCH;	2118	our %MAP_PREFETCH;
1512	our $MAP_PREFETCHER = undef;	2119	our $MAP_PREFETCHER = undef;
1513		2120
1514	sub find_async {	2121	sub find_async {
1515	my ($path, $origin) = @_;	2122	my ($path, $origin, $load) = @_;
1516		2123
1517	$path = normalise $path, $origin && $origin->{path};	2124	$path = normalise $path, $origin && $origin->{path};
1518		2125
1519	if (my $map = $cf::MAP{$path}) {	2126	if (my $map = $cf::MAP{$path}) {
1520	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2127	return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
1521	}	2128	}
1522		2129
1523	undef $MAP_PREFETCH{$path};	2130	$MAP_PREFETCH{$path} |= $load;
		2131
1524	$MAP_PREFETCHER ||= cf::async {	2132	$MAP_PREFETCHER ||= cf::async {
		2133	$Coro::current->{desc} = "map prefetcher";
		2134
1525	while (%MAP_PREFETCH) {	2135	while (%MAP_PREFETCH) {
1526	for my $path (keys %MAP_PREFETCH) {	2136	while (my ($k, $v) = each %MAP_PREFETCH) {
1527	my $map = find $path	2137	if (my $map = find $k) {
1528	or next;
1529	$map->load;	2138	$map->load if $v;
		2139	}
1530		2140
1531	delete $MAP_PREFETCH{$path};	2141	delete $MAP_PREFETCH{$k};
1532	}	2142	}
1533	}	2143	}
1534	undef $MAP_PREFETCHER;	2144	undef $MAP_PREFETCHER;
1535	};	2145	};
1536	$MAP_PREFETCHER->prio (6);	2146	$MAP_PREFETCHER->prio (6);
…		…
1539	}	2149	}
1540		2150
1541	sub save {	2151	sub save {
1542	my ($self) = @_;	2152	my ($self) = @_;
1543		2153
1544	my $lock = cf::lock_acquire "map_data:" . $self->path;	2154	my $lock = cf::lock_acquire "map_data:$self->{path}";
1545		2155
1546	$self->{last_save} = $cf::RUNTIME;	2156	$self->{last_save} = $cf::RUNTIME;
1547		2157
1548	return unless $self->dirty;	2158	return unless $self->dirty;
1549		2159
…		…
1555	return if $self->{deny_save};	2165	return if $self->{deny_save};
1556		2166
1557	local $self->{last_access} = $self->last_access;#d#	2167	local $self->{last_access} = $self->last_access;#d#
1558		2168
1559	cf::async {	2169	cf::async {
		2170	$Coro::current->{desc} = "map player save";
1560	$_->contr->save for $self->players;	2171	$_->contr->save for $self->players;
1561	};	2172	};
		2173
		2174	cf::get_slot 0.02;
1562		2175
1563	if ($uniq) {	2176	if ($uniq) {
1564	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2177	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1565	$self->_save_objects ($uniq, cf::IO_UNIQUES);	2178	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1566	} else {	2179	} else {
…		…
1572	my ($self) = @_;	2185	my ($self) = @_;
1573		2186
1574	# save first because save cedes	2187	# save first because save cedes
1575	$self->save;	2188	$self->save;
1576		2189
1577	my $lock = cf::lock_acquire "map_data:" . $self->path;	2190	my $lock = cf::lock_acquire "map_data:$self->{path}";
1578		2191
1579	return if $self->players;	2192	return if $self->players;
1580	return if $self->in_memory != cf::MAP_IN_MEMORY;	2193	return if $self->in_memory != cf::MAP_ACTIVE;
1581	return if $self->{deny_save};	2194	return if $self->{deny_save};
1582		2195
		2196	$self->in_memory (cf::MAP_SWAPPED);
		2197
		2198	$self->deactivate;
		2199	$_->clear_links_to ($self) for values %cf::MAP;
1583	$self->clear;	2200	$self->clear;
1584	$self->in_memory (cf::MAP_SWAPPED);
1585	}	2201	}
1586		2202
1587	sub reset_at {	2203	sub reset_at {
1588	my ($self) = @_;	2204	my ($self) = @_;
1589		2205
1590	# TODO: safety, remove and allow resettable per-player maps	2206	# TODO: safety, remove and allow resettable per-player maps
1591	return 1e99 if $self->isa ("ext::map_per_player");#d#
1592	return 1e99 if $self->{deny_reset};	2207	return 1e99 if $self->{deny_reset};
1593		2208
1594	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2209	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1595	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;
1596		2211
…		…
1607	my ($self) = @_;	2222	my ($self) = @_;
1608		2223
1609	my $lock = cf::lock_acquire "map_data:$self->{path}";	2224	my $lock = cf::lock_acquire "map_data:$self->{path}";
1610		2225
1611	return if $self->players;	2226	return if $self->players;
1612	return if $self->isa ("ext::map_per_player");#d#
1613		2227
1614	warn "resetting map ", $self->path;#d#	2228	warn "resetting map ", $self->path;
1615		2229
1616	$self->in_memory (cf::MAP_SWAPPED);	2230	$self->in_memory (cf::MAP_SWAPPED);
1617		2231
1618	# need to save uniques path	2232	# need to save uniques path
1619	unless ($self->{deny_save}) {	2233	unless ($self->{deny_save}) {
…		…
1623	if $uniq;	2237	if $uniq;
1624	}	2238	}
1625		2239
1626	delete $cf::MAP{$self->path};	2240	delete $cf::MAP{$self->path};
1627		2241
		2242	$self->deactivate;
		2243	$_->clear_links_to ($self) for values %cf::MAP;
1628	$self->clear;	2244	$self->clear;
1629
1630	$_->clear_links_to ($self) for values %cf::MAP;
1631		2245
1632	$self->unlink_save;	2246	$self->unlink_save;
1633	$self->destroy;	2247	$self->destroy;
1634	}	2248	}
1635		2249
1636	my $nuke_counter = "aaaa";	2250	my $nuke_counter = "aaaa";
1637		2251
1638	sub nuke {	2252	sub nuke {
1639	my ($self) = @_;	2253	my ($self) = @_;
1640		2254
		2255	{
		2256	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2257
1641	delete $cf::MAP{$self->path};	2258	delete $cf::MAP{$self->path};
1642		2259
1643	$self->unlink_save;	2260	$self->unlink_save;
1644		2261
1645	bless $self, "cf::map";	2262	bless $self, "cf::map";
1646	delete $self->{deny_reset};	2263	delete $self->{deny_reset};
1647	$self->{deny_save} = 1;	2264	$self->{deny_save} = 1;
1648	$self->reset_timeout (1);	2265	$self->reset_timeout (1);
1649	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2266	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1650		2267
1651	$cf::MAP{$self->path} = $self;	2268	$cf::MAP{$self->path} = $self;
		2269	}
1652		2270
1653	$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	]
1654	}	2308	}
1655		2309
1656	=item cf::map::unique_maps	2310	=item cf::map::unique_maps
1657		2311
1658	Returns an arrayref of paths of all shared maps that have	2312	Returns an arrayref of paths of all shared maps that have
1659	instantiated unique items. May block.	2313	instantiated unique items. May block.
1660		2314
1661	=cut	2315	=cut
1662		2316
1663	sub unique_maps() {	2317	sub unique_maps() {
1664	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2318	[
1665	or return;	2319	map {
1666
1667	my @paths;
1668
1669	for (@$files) {
1670	utf8::decode $_;	2320	utf8::decode $_;
1671	next if /\.pst$/;	2321	s/\.map$//; # TODO future compatibility hack
1672	next unless /^$PATH_SEP/o;	2322	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
1673		2323	? ()
1674	push @paths, cf::map::normalise $_;	2324	: normalise $_
		2325	} @{ aio_readdir $UNIQUEDIR or [] }
1675	}	2326	]
1676
1677	\@paths
1678	}	2327	}
1679
1680	package cf;
1681		2328
1682	=back	2329	=back
1683		2330
1684	=head3 cf::object	2331	=head3 cf::object
1685		2332
…		…
1689		2336
1690	=over 4	2337	=over 4
1691		2338
1692	=item $ob->inv_recursive	2339	=item $ob->inv_recursive
1693		2340
1694	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.
1695		2343
1696	=cut	2344	=cut
1697		2345
1698	sub inv_recursive_;	2346	sub inv_recursive_;
1699	sub inv_recursive_ {	2347	sub inv_recursive_ {
…		…
1702		2350
1703	sub inv_recursive {	2351	sub inv_recursive {
1704	inv_recursive_ inv $_[0]	2352	inv_recursive_ inv $_[0]
1705	}	2353	}
1706		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
1707	package cf;	2383	package cf;
1708		2384
1709	=back	2385	=back
1710		2386
1711	=head3 cf::object::player	2387	=head3 cf::object::player
…		…
1717	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>
1718	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
1719	dialogue with the given NPC character.	2395	dialogue with the given NPC character.
1720		2396
1721	=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	};
1722		2412
1723	# rough implementation of a future "reply" method that works	2413	# rough implementation of a future "reply" method that works
1724	# with dialog boxes.	2414	# with dialog boxes.
1725	#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
1726	sub cf::object::player::reply($$$;$) {	2416	sub cf::object::player::reply($$$;$) {
…		…
1728		2418
1729	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2419	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1730		2420
1731	if ($self->{record_replies}) {	2421	if ($self->{record_replies}) {
1732	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2422	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2423
1733	} 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 {
1734	$msg = $npc->name . " says: $msg" if $npc;	2432	$msg = $npc->name . " says: $msg" if $npc;
1735	$self->message ($msg, $flags);	2433	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2434	}
1736	}	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 (@_);
1737	}	2446	}
1738		2447
1739	=item $player_object->may ("access")	2448	=item $player_object->may ("access")
1740		2449
1741	Returns wether the given player is authorized to access resource "access"	2450	Returns wether the given player is authorized to access resource "access"
…		…
1754		2463
1755	=item $player_object->enter_link	2464	=item $player_object->enter_link
1756		2465
1757	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}>).
1758		2467
1759	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.
1760	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.
1761		2472
1762	Will never block.	2473	Will never block.
1763		2474
1764	=item $player_object->leave_link ($map, $x, $y)	2475	=item $player_object->leave_link ($map, $x, $y)
1765		2476
…		…
1788	$self->deactivate_recursive;	2499	$self->deactivate_recursive;
1789		2500
1790	return if UNIVERSAL::isa $self->map, "ext::map_link";	2501	return if UNIVERSAL::isa $self->map, "ext::map_link";
1791		2502
1792	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2503	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1793	if $self->map;	2504	if $self->map && $self->map->{path} ne "{link}";
1794		2505
1795	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2506	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1796	}	2507	}
1797		2508
1798	sub cf::object::player::leave_link {	2509	sub cf::object::player::leave_link {
1799	my ($self, $map, $x, $y) = @_;	2510	my ($self, $map, $x, $y) = @_;
		2511
		2512	return unless $self->contr->active;
1800		2513
1801	my $link_pos = delete $self->{_link_pos};	2514	my $link_pos = delete $self->{_link_pos};
1802		2515
1803	unless ($map) {	2516	unless ($map) {
1804	# restore original map position	2517	# restore original map position
…		…
1818	# use -1 or undef as default coordinates, not 0, 0	2531	# use -1 or undef as default coordinates, not 0, 0
1819	($x, $y) = ($map->enter_x, $map->enter_y)	2532	($x, $y) = ($map->enter_x, $map->enter_y)
1820	if $x <=0 && $y <= 0;	2533	if $x <=0 && $y <= 0;
1821		2534
1822	$map->load;	2535	$map->load;
1823	$map->load_diag;	2536	$map->load_neighbours;
1824		2537
1825	return unless $self->contr->active;	2538	return unless $self->contr->active;
		2539	$self->flag (cf::FLAG_DEBUG, 0);#d# temp
1826	$self->activate_recursive;	2540	$self->activate_recursive;
		2541
		2542	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1827	$self->enter_map ($map, $x, $y);	2543	$self->enter_map ($map, $x, $y);
1828	}	2544	}
1829		2545
1830	cf::player->attach (	2546	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1831	on_logout => sub {
1832	my ($pl) = @_;
1833		2547
1834	# abort map switching before logout	2548	Moves the player to the given map-path and coordinates by first freezing
1835	if ($pl->ob->{_link_pos}) {	2549	her, loading and preparing them map, calling the provided $check callback
1836	cf::sync_job {	2550	that has to return the map if sucecssful, and then unfreezes the player on
1837	$pl->ob->leave_link	2551	the new (success) or old (failed) map position. In either case, $done will
1838	};	2552	be called at the end of this process.
1839	}
1840	},
1841	on_login => sub {
1842	my ($pl) = @_;
1843		2553
1844	# try to abort aborted map switching on player login :)	2554	Note that $check will be called with a potentially non-loaded map, so if
1845	# should happen only on crashes	2555	it needs a loaded map it has to call C<< ->load >>.
1846	if ($pl->ob->{_link_pos}) {
1847	$pl->ob->enter_link;
1848	(async {
1849	# we need this sleep as the login has a concurrent enter_exit running
1850	# and this sleep increases chances of the player not ending up in scorn
1851	$pl->ob->reply (undef,
1852	"There was an internal problem at your last logout, "
1853	. "the server will try to bring you to your intended destination in a second.",
1854	cf::NDI_RED);
1855	Coro::Timer::sleep 1;
1856	$pl->ob->leave_link;
1857	})->prio (2);
1858	}
1859	},
1860	);
1861		2556
1862	=item $player_object->goto ($path, $x, $y)
1863
1864	=cut	2557	=cut
		2558
		2559	our $GOTOGEN;
1865		2560
1866	sub cf::object::player::goto {	2561	sub cf::object::player::goto {
1867	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;
1868		2566
1869	$self->enter_link;	2567	$self->enter_link;
1870		2568
1871	(async {	2569	(async {
		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
1872	my $map = eval {	2591	my $map = eval {
1873	my $map = cf::map::find $path;	2592	my $map = defined $path ? cf::map::find $path : undef;
		2593
		2594	if ($map) {
1874	$map = $map->customise_for ($self) if $map;	2595	$map = $map->customise_for ($self);
		2596	$map = $check->($map) if $check && $map;
		2597	} else {
		2598	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2599	}
		2600
1875	$map	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 $@;
1876	} or	2607	}
1877	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1878		2608
		2609	if ($gen == $self->{_goto_generation}) {
		2610	delete $self->{_goto_generation};
1879	$self->leave_link ($map, $x, $y);	2611	$self->leave_link ($map, $x, $y);
		2612	}
		2613
		2614	$done->() if $done;
1880	})->prio (1);	2615	})->prio (1);
1881	}	2616	}
1882		2617
1883	=item $player_object->enter_exit ($exit_object)	2618	=item $player_object->enter_exit ($exit_object)
1884		2619
…		…
1904	}	2639	}
1905		2640
1906	sub prepare_random_map {	2641	sub prepare_random_map {
1907	my ($exit) = @_;	2642	my ($exit) = @_;
1908		2643
1909	my $guard = cf::lock_acquire "exit_prepare:$exit";
1910
1911	# all this does is basically replace the /! path by	2644	# all this does is basically replace the /! path by
1912	# a new random map path (?random/...) with a seed	2645	# a new random map path (?random/...) with a seed
1913	# that depends on the exit object	2646	# that depends on the exit object
1914		2647
1915	my $rmp = parse_random_map_params $exit->msg;	2648	my $rmp = parse_random_map_params $exit->msg;
…		…
1917	if ($exit->map) {	2650	if ($exit->map) {
1918	$rmp->{region} = $exit->region->name;	2651	$rmp->{region} = $exit->region->name;
1919	$rmp->{origin_map} = $exit->map->path;	2652	$rmp->{origin_map} = $exit->map->path;
1920	$rmp->{origin_x} = $exit->x;	2653	$rmp->{origin_x} = $exit->x;
1921	$rmp->{origin_y} = $exit->y;	2654	$rmp->{origin_y} = $exit->y;
		2655
		2656	$exit->map->touch;
1922	}	2657	}
1923		2658
1924	$rmp->{random_seed} ||= $exit->random_seed;	2659	$rmp->{random_seed} ||= $exit->random_seed;
1925		2660
1926	my $data = cf::to_json $rmp;	2661	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1927	my $md5 = Digest::MD5::md5_hex $data;	2662	my $md5 = Digest::MD5::md5_hex $data;
1928	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2663	my $meta = "$RANDOMDIR/$md5.meta";
1929		2664
1930	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2665	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1931	aio_write $fh, 0, (length $data), $data, 0;	2666	aio_write $fh, 0, (length $data), $data, 0;
1932	undef $fh;	2667	undef $fh;
1933	aio_rename "$meta~", $meta;	2668	aio_rename "$meta~", $meta;
1934		2669
		2670	my $slaying = "?random/$md5";
		2671
		2672	if ($exit->valid) {
1935	$exit->slaying ("?random/$md5");	2673	$exit->slaying ("?random/$md5");
1936	$exit->msg (undef);	2674	$exit->msg (undef);
		2675	}
1937	}	2676	}
1938	}	2677	}
1939		2678
1940	sub cf::object::player::enter_exit {	2679	sub cf::object::player::enter_exit {
1941	my ($self, $exit) = @_;	2680	my ($self, $exit) = @_;
1942		2681
1943	return unless $self->type == cf::PLAYER;	2682	return unless $self->type == cf::PLAYER;
1944		2683
1945	if ($exit->slaying eq "/!") {
1946	#TODO: this should de-fi-ni-te-ly not be a sync-job
1947	cf::sync_job { prepare_random_map $exit };
1948	}
1949
1950	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1951	my $hp = $exit->stats->hp;
1952	my $sp = $exit->stats->sp;
1953
1954	$self->enter_link;	2684	$self->enter_link;
1955		2685
1956	(async {	2686	(async {
1957	$self->deactivate_recursive; # just to be sure	2687	$Coro::current->{desc} = "enter_exit";
		2688
1958	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
		2696	prepare_random_map $exit
		2697	if $exit->slaying eq "/!";
		2698	}
		2699
		2700	my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2701	my $x = $exit->stats->hp;
		2702	my $y = $exit->stats->sp;
		2703
1959	$self->goto ($slaying, $hp, $sp);	2704	$self->goto ($map, $x, $y);
1960		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
1961	1;	2710	1
1962	}) {	2711	}) {
1963	$self->message ("Something went wrong deep within the crossfire server. "	2712	$self->message ("Something went wrong deep within the deliantra server. "
1964	. "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. "
1965	. "Please report this to the dungeon master!",	2714	. "Please report this to the dungeon master!",
1966	cf::NDI_UNIQUE | cf::NDI_RED);	2715	cf::NDI_UNIQUE | cf::NDI_RED);
1967		2716
1968	warn "ERROR in enter_exit: $@";	2717	warn "ERROR in enter_exit: $@";
1969	$self->leave_link;	2718	$self->leave_link;
1970	}	2719	}
1971	})->prio (1);	2720	})->prio (1);
…		…
1984		2733
1985	sub cf::client::send_drawinfo {	2734	sub cf::client::send_drawinfo {
1986	my ($self, $text, $flags) = @_;	2735	my ($self, $text, $flags) = @_;
1987		2736
1988	utf8::encode $text;	2737	utf8::encode $text;
1989	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2738	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1990	}	2739	}
1991		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	}
1992		2935
1993	=item $success = $client->query ($flags, "text", \&cb)	2936	=item $success = $client->query ($flags, "text", \&cb)
1994		2937
1995	Queues a query to the client, calling the given callback with	2938	Queues a query to the client, calling the given callback with
1996	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>,
1997	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>.
1998		2941
1999	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
2000	reliable at some point in the future.	2943	become reliable at some point in the future.
2001		2944
2002	=cut	2945	=cut
2003		2946
2004	sub cf::client::query {	2947	sub cf::client::query {
2005	my ($self, $flags, $text, $cb) = @_;	2948	my ($self, $flags, $text, $cb) = @_;
…		…
2013	utf8::encode $text;	2956	utf8::encode $text;
2014	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2957	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2015		2958
2016	$self->send_packet ($self->{query_queue}[0][0])	2959	$self->send_packet ($self->{query_queue}[0][0])
2017	if @{ $self->{query_queue} } == 1;	2960	if @{ $self->{query_queue} } == 1;
		2961
		2962	1
2018	}	2963	}
2019		2964
2020	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	},
2021	on_reply => sub {	2971	on_reply => sub {
2022	my ($ns, $msg) = @_;	2972	my ($ns, $msg) = @_;
2023		2973
2024	# this weird shuffling is so that direct followup queries	2974	# this weird shuffling is so that direct followup queries
2025	# get handled first	2975	# get handled first
…		…
2037	} else {	2987	} else {
2038	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2988	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2039	}	2989	}
2040	}	2990	}
2041	},	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	},
2042	);	3018	);
2043		3019
2044	=item $client->async (\&cb)	3020	=item $client->async (\&cb)
2045		3021
2046	Create a new coroutine, running the specified callback. The coroutine will	3022	Create a new coroutine, running the specified callback. The coroutine will
…		…
2087	our $safe = new Safe "safe";	3063	our $safe = new Safe "safe";
2088	our $safe_hole = new Safe::Hole;	3064	our $safe_hole = new Safe::Hole;
2089		3065
2090	$SIG{FPE} = 'IGNORE';	3066	$SIG{FPE} = 'IGNORE';
2091		3067
2092	$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	));
2093		3073
2094	# here we export the classes and methods available to script code	3074	# here we export the classes and methods available to script code
2095		3075
2096	=pod	3076	=pod
2097		3077
2098	The following fucntions and emthods are available within a safe environment:	3078	The following functions and methods are available within a safe environment:
2099		3079
2100	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
2101	cf::object::player player	3085	cf::object::player
2102	cf::player peaceful	3086	player
2103	cf::map trigger	3087
		3088	cf::player
		3089	peaceful
		3090
		3091	cf::map
		3092	trigger
2104		3093
2105	=cut	3094	=cut
2106		3095
2107	for (	3096	for (
2108	["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)],
2109	["cf::object::player" => qw(player)],	3100	["cf::object::player" => qw(player)],
2110	["cf::player" => qw(peaceful)],	3101	["cf::player" => qw(peaceful send_msg)],
2111	["cf::map" => qw(trigger)],	3102	["cf::map" => qw(trigger)],
2112	) {	3103	) {
2113	no strict 'refs';	3104	no strict 'refs';
2114	my ($pkg, @funs) = @$_;	3105	my ($pkg, @funs) = @$_;
2115	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3106	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
…		…
2132	my ($code, %vars) = @_;	3123	my ($code, %vars) = @_;
2133		3124
2134	my $qcode = $code;	3125	my $qcode = $code;
2135	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3126	$qcode =~ s/"/‟/g; # not allowed in #line filenames
2136	$qcode =~ s/\n/\\n/g;	3127	$qcode =~ s/\n/\\n/g;
		3128
		3129	%vars = (_dummy => 0) unless %vars;
2137		3130
2138	local $_;	3131	local $_;
2139	local @safe::cf::_safe_eval_args = values %vars;	3132	local @safe::cf::_safe_eval_args = values %vars;
2140		3133
2141	my $eval =	3134	my $eval =
…		…
2184	=back	3177	=back
2185		3178
2186	=cut	3179	=cut
2187		3180
2188	#############################################################################	3181	#############################################################################
2189
2190	=head2 EXTENSION DATABASE SUPPORT
2191
2192	Crossfire maintains a very simple database for extension use. It can
2193	currently store anything that can be serialised using Storable, which
2194	excludes objects.
2195
2196	The parameter C<$family> should best start with the name of the extension
2197	using it, it should be unique.
2198
2199	=over 4
2200
2201	=item $value = cf::db_get $family => $key
2202
2203	Returns a single value from the database.
2204
2205	=item cf::db_put $family => $key => $value
2206
2207	Stores the given C<$value> in the family.
2208
2209	=cut
2210
2211	our $DB;
2212
2213	sub db_init {
2214	unless ($DB) {
2215	$DB = BDB::db_create $DB_ENV;
2216
2217	cf::sync_job {
2218	eval {
2219	$DB->set_flags (BDB::CHKSUM);
2220
2221	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2222	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2223	cf::cleanup "db_open(db): $!" if $!;
2224	};
2225	cf::cleanup "db_open(db): $@" if $@;
2226	};
2227
2228	my $path = cf::localdir . "/database.pst";
2229	if (stat $path) {
2230	cf::sync_job {
2231	my $pst = Storable::retrieve $path;
2232
2233	cf::db_put (board => data => $pst->{board});
2234	cf::db_put (guildrules => data => $pst->{guildrules});
2235	cf::db_put (rent => balance => $pst->{rent}{balance});
2236	BDB::db_env_txn_checkpoint $DB_ENV;
2237
2238	unlink $path;
2239	};
2240	}
2241	}
2242	}
2243
2244	sub db_get($$) {
2245	my $key = "$_[0]/$_[1]";
2246
2247	cf::sync_job {
2248	BDB::db_get $DB, undef, $key, my $data;
2249
2250	$! ? ()
2251	: Compress::LZF::sthaw $data
2252	}
2253	}
2254
2255	sub db_put($$$) {
2256	BDB::dbreq_pri 4;
2257	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2258	}
2259
2260	#############################################################################
2261	# the server's init and main functions	3182	# the server's init and main functions
2262		3183
		3184	sub load_facedata($) {
		3185	my ($path) = @_;
		3186
		3187	# HACK to clear player env face cache, we need some signal framework
		3188	# for this (global event?)
		3189	%ext::player_env::MUSIC_FACE_CACHE = ();
		3190
		3191	my $enc = JSON::XS->new->utf8->canonical->relaxed;
		3192
		3193	warn "loading facedata from $path\n";
		3194
		3195	my $facedata;
		3196	0 < aio_load $path, $facedata
		3197	or die "$path: $!";
		3198
		3199	$facedata = Coro::Storable::thaw $facedata;
		3200
		3201	$facedata->{version} == 2
		3202	or cf::cleanup "$path: version mismatch, cannot proceed.";
		3203
		3204	# patch in the exptable
		3205	$facedata->{resource}{"res/exp_table"} = {
		3206	type => FT_RSRC,
		3207	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
		3208	};
		3209	cf::cede_to_tick;
		3210
		3211	{
		3212	my $faces = $facedata->{faceinfo};
		3213
		3214	while (my ($face, $info) = each %$faces) {
		3215	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		3216
		3217	cf::face::set_visibility $idx, $info->{visibility};
		3218	cf::face::set_magicmap $idx, $info->{magicmap};
		3219	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
		3220	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
		3221
		3222	cf::cede_to_tick;
		3223	}
		3224
		3225	while (my ($face, $info) = each %$faces) {
		3226	next unless $info->{smooth};
		3227
		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
2263	sub load_resources {	3319	sub load_resource_file($) {
2264	load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir	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"
2265	or die "unable to load regions file\n";#d#	3335	or die "unable to load regions file\n";
2266	}
2267		3336
2268	sub cfg_load {	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 {
2269	open my $fh, "<:utf8", cf::confdir . "/config"	3370	open my $fh, "<:utf8", "$CONFDIR/config"
2270	or return;	3371	or return;
2271		3372
2272	local $/;	3373	local $/;
2273	*CFG = YAML::Syck::Load <$fh>;	3374	*CFG = YAML::Load <$fh>;
2274		3375
2275	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3376	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2276		3377
2277	$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};
2278	$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};
…		…
2284	};	3385	};
2285	warn $@ if $@;	3386	warn $@ if $@;
2286	}	3387	}
2287	}	3388	}
2288		3389
2289	sub init {	3390	sub pidfile() {
2290	load_resources;	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;
2291	}	3416	}
2292		3417
2293	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
2294	# we must not ever block the main coroutine	3433	# we must not ever block the main coroutine
2295	local $Coro::idle = sub {	3434	local $Coro::idle = sub {
2296	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#
2297	(async {	3436	(async {
2298	Event::one_event;	3437	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3438	EV::loop EV::LOOP_ONESHOT;
2299	})->prio (Coro::PRIO_MAX);	3439	})->prio (Coro::PRIO_MAX);
2300	};	3440	};
2301		3441
2302	cfg_load;	3442	evthread_start IO::AIO::poll_fileno;
		3443
		3444	cf::sync_job {
		3445	reload_resources;
		3446	reload_config;
2303	db_init;	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
2304	load_extensions;	3460	load_extensions;
2305		3461
2306	$TICK_WATCHER->start;	3462	utime time, time, $RUNTIMEFILE;
2307	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;
2308	}	3471	}
2309		3472
2310	#############################################################################	3473	#############################################################################
2311	# initialisation and cleanup	3474	# initialisation and cleanup
2312		3475
2313	# install some emergency cleanup handlers	3476	# install some emergency cleanup handlers
2314	BEGIN {	3477	BEGIN {
		3478	our %SIGWATCHER = ();
2315	for my $signal (qw(INT HUP TERM)) {	3479	for my $signal (qw(INT HUP TERM)) {
2316	Event->signal (	3480	$SIGWATCHER{$signal} = EV::signal $signal, sub {
2317	reentrant => 0,
2318	data => WF_AUTOCANCEL,
2319	signal => $signal,
2320	prio => 0,
2321	cb => sub {
2322	cf::cleanup "SIG$signal";	3481	cf::cleanup "SIG$signal";
2323	},
2324	);	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
2325	}	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 };
2326	}	3570	}
2327		3571
2328	sub emergency_save() {	3572	sub emergency_save() {
2329	my $freeze_guard = cf::freeze_mainloop;	3573	my $freeze_guard = cf::freeze_mainloop;
2330		3574
2331	warn "enter emergency perl save\n";	3575	warn "emergency_perl_save: enter\n";
2332		3576
2333	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
2334	# use a peculiar iteration method to avoid tripping on perl	3583	# use a peculiar iteration method to avoid tripping on perl
2335	# refcount bugs in for. also avoids problems with players	3584	# refcount bugs in for. also avoids problems with players
2336	# and maps saved/destroyed asynchronously.	3585	# and maps saved/destroyed asynchronously.
2337	warn "begin emergency player save\n";	3586	warn "emergency_perl_save: begin player save\n";
2338	for my $login (keys %cf::PLAYER) {	3587	for my $login (keys %cf::PLAYER) {
2339	my $pl = $cf::PLAYER{$login} or next;	3588	my $pl = $cf::PLAYER{$login} or next;
2340	$pl->valid or next;	3589	$pl->valid or next;
		3590	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2341	$pl->save;	3591	$pl->save;
2342	}	3592	}
2343	warn "end emergency player save\n";	3593	warn "emergency_perl_save: end player save\n";
2344		3594
2345	warn "begin emergency map save\n";	3595	warn "emergency_perl_save: begin map save\n";
2346	for my $path (keys %cf::MAP) {	3596	for my $path (keys %cf::MAP) {
2347	my $map = $cf::MAP{$path} or next;	3597	my $map = $cf::MAP{$path} or next;
2348	$map->valid or next;	3598	$map->valid or next;
2349	$map->save;	3599	$map->save;
2350	}	3600	}
2351	warn "end emergency map save\n";	3601	warn "emergency_perl_save: end map save\n";
2352		3602
2353	warn "begin emergency database checkpoint\n";	3603	warn "emergency_perl_save: begin database checkpoint\n";
2354	BDB::db_env_txn_checkpoint $DB_ENV;	3604	BDB::db_env_txn_checkpoint $DB_ENV;
2355	warn "end emergency database checkpoint\n";	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";
2356	};	3610	};
2357		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
2358	warn "leave emergency perl save\n";	3617	warn "emergency_perl_save: leave\n";
2359	}	3618	}
2360		3619
2361	sub post_cleanup {	3620	sub post_cleanup {
2362	my ($make_core) = @_;	3621	my ($make_core) = @_;
2363		3622
2364	warn Carp::longmess "post_cleanup backtrace"	3623	warn Carp::longmess "post_cleanup backtrace"
2365	if $make_core;	3624	if $make_core;
2366	}
2367		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
2368	sub reload() {	3656	sub do_reload_perl() {
2369	# can/must only be called in main	3657	# can/must only be called in main
2370	if ($Coro::current != $Coro::main) {	3658	if ($Coro::current != $Coro::main) {
2371	warn "can only reload from main coroutine";	3659	warn "can only reload from main coroutine";
2372	return;	3660	return;
2373	}	3661	}
2374		3662
		3663	return if $RELOAD++;
		3664
		3665	my $t1 = EV::time;
		3666
		3667	while ($RELOAD) {
2375	warn "reloading...";	3668	warn "reloading...";
2376		3669
2377	warn "cancelling server ticker";	3670	warn "entering sync_job";
2378	$TICK_WATCHER->cancel;
2379		3671
		3672	cf::sync_job {
		3673	cf::write_runtime_sync; # external watchdog should not bark
2380	cf::emergency_save;	3674	cf::emergency_save;
		3675	cf::write_runtime_sync; # external watchdog should not bark
2381		3676
2382	eval {	3677	warn "syncing database to disk";
		3678	BDB::db_env_txn_checkpoint $DB_ENV;
		3679
2383	# 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
2384		3681
2385	warn "cancelling all WF_AUTOCANCEL watchers";
2386	for (Event::all_watchers) {
2387	$_->cancel if $_->data & WF_AUTOCANCEL;
2388	}
2389
2390	warn "syncing database to disk";
2391	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
2392
2393	warn "flushing outstanding aio requests";	3682	warn "flushing outstanding aio requests";
2394	for (;;) {
2395	BDB::flush;
2396	IO::AIO::flush;
2397	Coro::cede;
2398	last unless IO::AIO::nreqs || BDB::nreqs;	3683	while (IO::AIO::nreqs || BDB::nreqs) {
2399	warn "iterate...";	3684	Coro::EV::timer_once 0.01; # let the sync_job do it's thing
2400	}
2401
2402	warn "cancelling all extension coros";
2403	$_->cancel for values %EXT_CORO;
2404	%EXT_CORO = ();
2405
2406	warn "removing commands";
2407	%COMMAND = ();
2408
2409	warn "removing ext commands";
2410	%EXTCMD = ();
2411
2412	warn "unloading/nuking all extensions";
2413	for my $pkg (@EXTS) {
2414	warn "... unloading $pkg";
2415
2416	if (my $cb = $pkg->can ("unload")) {
2417	eval {
2418	$cb->($pkg);
2419	1
2420	} or warn "$pkg unloaded, but with errors: $@";
2421	}	3685	}
2422		3686
2423	warn "... nuking $pkg";	3687	warn "cancelling all extension coros";
2424	Symbol::delete_package $pkg;	3688	$_->cancel for values %EXT_CORO;
2425	}	3689	%EXT_CORO = ();
2426		3690
2427	warn "unloading all perl modules loaded from $LIBDIR";	3691	warn "removing commands";
2428	while (my ($k, $v) = each %INC) {	3692	%COMMAND = ();
2429	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2430		3693
		3694	warn "removing ext/exti commands";
		3695	%EXTCMD = ();
		3696	%EXTICMD = ();
		3697
		3698	warn "unloading/nuking all extensions";
		3699	for my $pkg (@EXTS) {
2431	warn "... unloading $k";	3700	warn "... unloading $pkg";
2432	delete $INC{$k};
2433		3701
2434	$k =~ s/\.pm$//;
2435	$k =~ s/\//::/g;
2436
2437	if (my $cb = $k->can ("unload_module")) {	3702	if (my $cb = $pkg->can ("unload")) {
		3703	eval {
2438	$cb->();	3704	$cb->($pkg);
		3705	1
		3706	} or warn "$pkg unloaded, but with errors: $@";
		3707	}
		3708
		3709	warn "... clearing $pkg";
		3710	clear_package $pkg;
2439	}	3711	}
2440		3712
2441	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;
2442	}	3728	}
2443		3729
2444	warn "getting rid of safe::, as good as possible";	3730	warn "getting rid of safe::, as good as possible";
2445	Symbol::delete_package "safe::$_"	3731	clear_package "safe::$_"
2446	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);
2447		3733
2448	warn "unloading cf.pm \"a bit\"";	3734	warn "unloading cf.pm \"a bit\"";
2449	delete $INC{"cf.pm"};	3735	delete $INC{"cf.pm"};
		3736	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2450		3737
2451	# don't, removes xs symbols, too,	3738	# don't, removes xs symbols, too,
2452	# and global variables created in xs	3739	# and global variables created in xs
2453	#Symbol::delete_package __PACKAGE__;	3740	#clear_package __PACKAGE__;
2454		3741
2455	warn "unload completed, starting to reload now";	3742	warn "unload completed, starting to reload now";
2456		3743
2457	warn "reloading cf.pm";	3744	warn "reloading cf.pm";
2458	require cf;	3745	require cf;
2459	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3746	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2460		3747
2461	warn "loading config and database again";	3748	warn "loading config and database again";
2462	cf::cfg_load;	3749	cf::reload_config;
2463		3750
2464	warn "loading extensions";	3751	warn "loading extensions";
2465	cf::load_extensions;	3752	cf::load_extensions;
2466		3753
		3754	if ($REATTACH_ON_RELOAD) {
2467	warn "reattaching attachments to objects/players";	3755	warn "reattaching attachments to objects/players";
2468	_global_reattach;	3756	_global_reattach; # objects, sockets
2469	warn "reattaching attachments to maps";	3757	warn "reattaching attachments to maps";
2470	reattach $_ for values %MAP;	3758	reattach $_ for values %MAP;
		3759	warn "reattaching attachments to players";
		3760	reattach $_ for values %PLAYER;
		3761	}
2471		3762
2472	warn "loading reloadable resources";	3763	warn "running post_init jobs";
2473	load_resources;	3764	(pop @POST_INIT)->(1) while @POST_INIT;
2474		3765
2475	warn "restarting server ticker";	3766	warn "leaving sync_job";
2476		3767
2477	$TICK_WATCHER->start;	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	};
2478	};	3795	};
2479		3796	}
2480	if ($@) {
2481	warn $@;
2482	warn "error while reloading, exiting.";
2483	exit 1;
2484	}
2485
2486	warn "reloaded";
2487	};
2488
2489	our $RELOAD_WATCHER; # used only during reload
2490		3797
2491	register_command "reload" => sub {	3798	register_command "reload" => sub {
2492	my ($who, $arg) = @_;	3799	my ($who, $arg) = @_;
2493		3800
2494	if ($who->flag (FLAG_WIZ)) {	3801	if ($who->flag (FLAG_WIZ)) {
2495	$who->message ("reloading server.");	3802	$who->message ("reloading server.");
2496		3803	async {
2497	# doing reload synchronously and two reloads happen back-to-back,	3804	$Coro::current->{desc} = "perl_reload";
2498	# coro crashes during coro_state_free->destroy here.
2499
2500	$RELOAD_WATCHER ||= Event->timer (
2501	reentrant => 0,
2502	after => 0,
2503	data => WF_AUTOCANCEL,
2504	cb => sub {
2505	reload;	3805	reload_perl;
2506	undef $RELOAD_WATCHER;
2507	},
2508	);	3806	};
2509	}	3807	}
2510	};	3808	};
2511		3809
2512	unshift @INC, $LIBDIR;	3810	unshift @INC, $LIBDIR;
2513		3811
2514	my $bug_warning = 0;	3812	my $bug_warning = 0;
2515		3813
2516	$TICK_WATCHER = Event->timer (	3814	our @WAIT_FOR_TICK;
2517	reentrant => 0,	3815	our @WAIT_FOR_TICK_BEGIN;
2518	parked => 1,	3816
2519	prio => 0,	3817	sub wait_for_tick {
2520	at => $NEXT_TICK || $TICK,	3818	return if tick_inhibit || $Coro::current == $Coro::main;
2521	data => WF_AUTOCANCEL,	3819
2522	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 {
2523	if ($Coro::current != $Coro::main) {	3834	if ($Coro::current != $Coro::main) {
2524	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"
2525	unless ++$bug_warning > 10;	3836	unless ++$bug_warning > 10;
2526	return;	3837	return;
2527	}	3838	}
2528		3839
2529	$NOW = Event::time;
2530
2531	cf::server_tick; # one server iteration	3840	cf::server_tick; # one server iteration
2532	$RUNTIME += $TICK;
2533	$NEXT_TICK += $TICK;
2534		3841
2535	$WAIT_FOR_TICK->broadcast;	3842	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2536	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3843	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
		3844	Coro::async_pool {
		3845	$Coro::current->{desc} = "runtime saver";
		3846	write_runtime_sync
		3847	or warn "ERROR: unable to write runtime file: $!";
		3848	};
		3849	}
2537		3850
2538	Event::sweep;	3851	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2539	Coro::cede_notself;	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#
2540		3866	}
2541	# my $AFTER = Event::time;
2542	# warn $AFTER - $NOW;#d#
2543
2544	# if we are delayed by four ticks or more, skip them all
2545	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2546
2547	$TICK_WATCHER->at ($NEXT_TICK);
2548	$TICK_WATCHER->start;
2549	},	3867	}
2550	);	3868	}
2551		3869
2552	{	3870	{
2553	BDB::max_poll_time $TICK * 0.1;	3871	# configure BDB
2554	$BDB_POLL_WATCHER = Event->io (	3872
2555	reentrant => 0,
2556	fd => BDB::poll_fileno,
2557	poll => 'r',
2558	prio => 0,
2559	data => WF_AUTOCANCEL,
2560	cb => \&BDB::poll_cb,
2561	);
2562	BDB::min_parallel 8;	3873	BDB::min_parallel 8;
2563		3874	BDB::max_poll_reqs $TICK * 0.1;
2564	BDB::set_sync_prepare {	3875	$AnyEvent::BDB::WATCHER->priority (1);
2565	my $status;
2566	my $current = $Coro::current;
2567	(
2568	sub {
2569	$status = $!;
2570	$current->ready; undef $current;
2571	},
2572	sub {
2573	Coro::schedule while defined $current;
2574	$! = $status;
2575	},
2576	)
2577	};
2578		3876
2579	unless ($DB_ENV) {	3877	unless ($DB_ENV) {
2580	$DB_ENV = BDB::db_env_create;	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);
2581		3884
2582	cf::sync_job {	3885	cf::sync_job {
2583	eval {	3886	eval {
2584	BDB::db_env_open	3887	BDB::db_env_open
2585	$DB_ENV,	3888	$DB_ENV,
2586	$BDB_ENV_DIR,	3889	$BDBDIR,
2587	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	3890	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2588	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3891	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2589	0666;	3892	0666;
2590		3893
2591	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;	3894	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2592
2593	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2594	$DB_ENV->set_lk_detect;
2595	};	3895	};
2596		3896
2597	cf::cleanup "db_env_open(db): $@" if $@;	3897	cf::cleanup "db_env_open(db): $@" if $@;
2598	};	3898	};
2599	}	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	};
2600	}	3910	}
2601		3911
2602	{	3912	{
		3913	# configure IO::AIO
		3914
2603	IO::AIO::min_parallel 8;	3915	IO::AIO::min_parallel 8;
2604
2605	undef $Coro::AIO::WATCHER;
2606	IO::AIO::max_poll_time $TICK * 0.1;	3916	IO::AIO::max_poll_time $TICK * 0.1;
2607	$AIO_POLL_WATCHER = Event->io (	3917	undef $AnyEvent::AIO::WATCHER;
2608	reentrant => 0,
2609	fd => IO::AIO::poll_fileno,
2610	poll => 'r',
2611	prio => 6,
2612	data => WF_AUTOCANCEL,
2613	cb => \&IO::AIO::poll_cb,
2614	);
2615	}	3918	}
2616		3919
2617	$WRITE_RUNTIME_WATCHER = Event->timer (	3920	my $_log_backtrace;
2618	reentrant => 0,	3921
2619	data => WF_AUTOCANCEL,	3922	sub _log_backtrace {
2620	after => 1,	3923	my ($msg, @addr) = @_;
2621	interval => 10,	3924
2622	prio => 6, # keep it lowest so it acts like a watchdog	3925	$msg =~ s/\n//;
2623	cb => Coro::unblock_sub {	3926
2624	write_runtime	3927	# limit the # of concurrent backtraces
2625	or warn "ERROR: unable to write runtime file: $!";	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";
2626	},	3959	}
2627	);	3960	}
		3961
		3962	# load additional modules
		3963	require "cf/$_.pm" for @EXTRA_MODULES;
2628		3964
2629	END { cf::emergency_save }	3965	END { cf::emergency_save }
2630		3966
2631	1	3967	1
2632		3968

Diff Legend

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