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

Diff Legend

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