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

Diff Legend

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