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.250 by root, Wed Apr 18 14:24:10 2007 UTC vs.
Revision 1.600 by root, Sun Nov 11 04:31:57 2012 UTC

		1	#
		2	# This file is part of Deliantra, the Roguelike Realtime MMORPG.
		3	#
		4	# Copyright (©) 2006,2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
		5	#
		6	# Deliantra is free software: you can redistribute it and/or modify it under
		7	# the terms of the Affero GNU General Public License as published by the
		8	# Free Software Foundation, either version 3 of the License, or (at your
		9	# option) any later version.
		10	#
		11	# This program is distributed in the hope that it will be useful,
		12	# but WITHOUT ANY WARRANTY; without even the implied warranty of
		13	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
		14	# GNU General Public License for more details.
		15	#
		16	# You should have received a copy of the Affero GNU General Public License
		17	# and the GNU General Public License along with this program. If not, see
		18	# <http://www.gnu.org/licenses/>.
		19	#
		20	# The authors can be reached via e-mail to <support@deliantra.net>
		21	#
		22
1	package cf;	23	package cf;
2		24
3	use utf8;	25	use common::sense;
4	use strict;
5		26
6	use Symbol;	27	use Symbol;
7	use List::Util;	28	use List::Util;
8	use Socket;	29	use Socket;
9	use Storable;	30	use EV;
10	use Event;
11	use Opcode;	31	use Opcode;
12	use Safe;	32	use Safe;
13	use Safe::Hole;	33	use Safe::Hole;
		34	use Storable ();
		35	use Carp ();
14		36
		37	use AnyEvent ();
		38	use AnyEvent::IO ();
		39	use AnyEvent::DNS ();
		40
15	use Coro 3.61 ();	41	use Coro ();
16	use Coro::State;	42	use Coro::State;
17	use Coro::Handle;	43	use Coro::Handle;
		44	use Coro::EV;
18	use Coro::Event;	45	use Coro::AnyEvent;
19	use Coro::Timer;	46	use Coro::Timer;
20	use Coro::Signal;	47	use Coro::Signal;
21	use Coro::Semaphore;	48	use Coro::Semaphore;
		49	use Coro::SemaphoreSet;
		50	use Coro::AnyEvent;
22	use Coro::AIO;	51	use Coro::AIO;
		52	use Coro::BDB 1.6;
23	use Coro::Storable;	53	use Coro::Storable;
		54	use Coro::Util ();
24		55
		56	use Guard ();
		57	use JSON::XS 2.01 ();
25	use BDB ();	58	use BDB ();
26	use Data::Dumper;	59	use Data::Dumper;
27	use Digest::MD5;
28	use Fcntl;	60	use Fcntl;
29	use YAML::Syck ();	61	use YAML::XS ();
30	use IO::AIO 2.32 ();	62	use IO::AIO ();
31	use Time::HiRes;
32	use Compress::LZF;	63	use Compress::LZF;
		64	use Digest::MD5 ();
		65
		66	AnyEvent::detect;
33		67
34	# configure various modules to our taste	68	# configure various modules to our taste
35	#	69	#
36	$Storable::canonical = 1; # reduce rsync transfers	70	$Storable::canonical = 1; # reduce rsync transfers
37	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator	71	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		72
		73	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
		74
		75	# make sure c-lzf reinitialises itself
		76	Compress::LZF::set_serializer "Storable", "Storable::net_mstore", "Storable::mretrieve";
38	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later	77	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
39		78
40	$Event::Eval = 1; # no idea why this is required, but it is	79	# strictly for debugging
41		80	$SIG{QUIT} = sub { Carp::cluck "SIGQUIT" };
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
46		81
47	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	82	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		83
		84	our @ORIG_INC;
48		85
49	our %COMMAND = ();	86	our %COMMAND = ();
50	our %COMMAND_TIME = ();	87	our %COMMAND_TIME = ();
51		88
52	our @EXTS = (); # list of extension package names	89	our @EXTS = (); # list of extension package names
53	our %EXTCMD = ();	90	our %EXTCMD = ();
		91	our %EXTACMD = ();
		92	our %EXTICMD = ();
		93	our %EXTIACMD = ();
54	our %EXT_CORO = (); # coroutines bound to extensions	94	our %EXT_CORO = (); # coroutines bound to extensions
55	our %EXT_MAP = (); # pluggable maps	95	our %EXT_MAP = (); # pluggable maps
56		96
57	our $RELOAD; # number of reloads so far	97	our $RELOAD; # number of reloads so far, non-zero while in reload
58	our @EVENT;	98	our @EVENT;
59	our $LIBDIR = datadir . "/ext";	99	our @REFLECT; # set by XS
		100	our %REFLECT; # set by us
		101
		102	our $CONFDIR = confdir;
		103
		104	our $DATADIR = datadir;
		105	our $LIBDIR = "$DATADIR/ext";
		106	our $PODDIR = "$DATADIR/pod";
		107	our $MAPDIR = "$DATADIR/" . mapdir;
		108
		109	our $LOCALDIR = localdir;
		110	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		111	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		112	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		113	our $RANDOMDIR = "$LOCALDIR/random";
		114	our $BDBDIR = "$LOCALDIR/db";
		115	our $PIDFILE = "$LOCALDIR/pid";
		116	our $RUNTIMEFILE = "$LOCALDIR/runtime";
		117
		118	#our %RESOURCE; # unused
		119
		120	our $OUTPUT_RATE_MIN = 3000;
		121	our $OUTPUT_RATE_MAX = 1000000;
		122
		123	our $MAX_LINKS = 32; # how many chained exits to follow
		124	our $VERBOSE_IO = 1;
60		125
61	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)	126	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
62	our $TICK_WATCHER;
63	our $AIO_POLL_WATCHER;
64	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written	127	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
65	our $NEXT_TICK;	128	our $NEXT_TICK;
		129	our $USE_FSYNC = 1; # use fsync to write maps - default on
		130
		131	our $BDB_DEADLOCK_WATCHER;
		132	our $BDB_CHECKPOINT_WATCHER;
		133	our $BDB_TRICKLE_WATCHER;
		134	our $DB_ENV;
		135
		136	our @EXTRA_MODULES = qw(pod match mapscript incloader);
		137
		138	our %CFG;
		139	our %EXT_CFG; # cfgkeyname => [var-ref, defaultvalue]
		140
		141	our $UPTIME; $UPTIME ||= time;
		142	our $RUNTIME = 0;
		143	our $SERVER_TICK = 0;
66	our $NOW;	144	our $NOW;
67	our $USE_FSYNC = 1; # use fsync to write maps - default off
68		145
69	our $BDB_POLL_WATCHER;	146	our (%PLAYER, %PLAYER_LOADING); # all users
70	our $DB_ENV;	147	our (%MAP, %MAP_LOADING ); # all maps
71
72	our %CFG;
73
74	our $UPTIME; $UPTIME ||= time;
75	our $RUNTIME;
76
77	our %PLAYER; # all users
78	our %MAP; # all maps
79	our $LINK_MAP; # the special {link} map, which is always available	148	our $LINK_MAP; # the special {link} map, which is always available
80	our $RANDOM_MAPS = cf::localdir . "/random";
81	our $BDB_ENV_DIR = cf::localdir . "/db";
82		149
83	# used to convert map paths into valid unix filenames by replacing / by ∕	150	# used to convert map paths into valid unix filenames by replacing / by ∕
84	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	151	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
85		152
		153	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		154	our $LOADAVG; # same thing, but with alpha-smoothing
		155	our $JITTER; # average jitter
		156	our $TICK_START; # for load detecting purposes
		157
		158	our @POST_INIT;
		159
		160	our $REATTACH_ON_RELOAD; # set to true to force object reattach on reload (slow)
		161	our $REALLY_UNLOOP; # never set to true, please :)
		162
		163	our $WAIT_FOR_TICK = new Coro::Signal;
		164	our @WAIT_FOR_TICK_BEGIN;
		165
86	binmode STDOUT;	166	binmode STDOUT;
87	binmode STDERR;	167	binmode STDERR;
88		168
89	# read virtual server time, if available	169	# read virtual server time, if available
90	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	170	unless ($RUNTIME || !-e $RUNTIMEFILE) {
91	open my $fh, "<", cf::localdir . "/runtime"	171	open my $fh, "<", $RUNTIMEFILE
92	or die "unable to read runtime file: $!";	172	or die "unable to read $RUNTIMEFILE file: $!";
93	$RUNTIME = <$fh> + 0.;	173	$RUNTIME = <$fh> + 0.;
94	}	174	}
95		175
96	mkdir cf::localdir;	176	eval "sub TICK() { $TICK } 1" or die;
97	mkdir cf::localdir . "/" . cf::playerdir;	177
98	mkdir cf::localdir . "/" . cf::tmpdir;	178	mkdir $_
99	mkdir cf::localdir . "/" . cf::uniquedir;	179	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
100	mkdir $RANDOM_MAPS;
101	mkdir $BDB_ENV_DIR;
102		180
103	our $EMERGENCY_POSITION;	181	our $EMERGENCY_POSITION;
104		182
105	sub cf::map::normalise;	183	sub cf::map::normalise;
106		184
		185	sub in_main() {
		186	$Coro::current == $Coro::main
		187	}
		188
107	#############################################################################	189	#############################################################################
108		190
		191	%REFLECT = ();
		192	for (@REFLECT) {
		193	my $reflect = JSON::XS::decode_json $_;
		194	$REFLECT{$reflect->{class}} = $reflect;
		195	}
		196
		197	# this is decidedly evil
		198	$REFLECT{object}{flags} = { map +($_ => undef), grep $_, map /^FLAG_([A-Z0-9_]+)$/ && lc $1, keys %{"cf::"} };
		199
		200	#############################################################################
		201
109	=head2 GLOBAL VARIABLES	202	=head2 GLOBAL VARIABLES
110		203
111	=over 4	204	=over 4
112		205
113	=item $cf::UPTIME	206	=item $cf::UPTIME
114		207
115	The timestamp of the server start (so not actually an uptime).	208	The timestamp of the server start (so not actually an "uptime").
		209
		210	=item $cf::SERVER_TICK
		211
		212	An unsigned integer that starts at zero when the server is started and is
		213	incremented on every tick.
		214
		215	=item $cf::NOW
		216
		217	The (real) time of the last (current) server tick - updated before and
		218	after tick processing, so this is useful only as a rough "what time is it
		219	now" estimate.
		220
		221	=item $cf::TICK
		222
		223	The interval between each server tick, in seconds.
116		224
117	=item $cf::RUNTIME	225	=item $cf::RUNTIME
118		226
119	The time this server has run, starts at 0 and is increased by $cf::TICK on	227	The time this server has run, starts at 0 and is increased by $cf::TICK on
120	every server tick.	228	every server tick.
121		229
122	=item $cf::LIBDIR	230	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		231	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		232	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
123		233
124	The perl library directory, where extensions and cf-specific modules can	234	Various directories - "/etc", read-only install directory, perl-library
125	be found. It will be added to C<@INC> automatically.	235	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		236	unique-items directory, player file directory, random maps directory and
		237	database environment.
126		238
		239	=item $cf::LOADAVG
		240
		241	The current CPU load on the server (alpha-smoothed), as a value between 0
		242	(none) and 1 (overloaded), indicating how much time is spent on processing
		243	objects per tick. Healthy values are < 0.5.
		244
127	=item $cf::NOW	245	=item $cf::LOAD
128		246
129	The time of the last (current) server tick.	247	The raw value load value from the last tick.
130
131	=item $cf::TICK
132
133	The interval between server ticks, in seconds.
134		248
135	=item %cf::CFG	249	=item %cf::CFG
136		250
137	Configuration for the server, loaded from C</etc/crossfire/config>, or	251	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
138	from wherever your confdir points to.	252	from wherever your confdir points to.
139		253
140	=item cf::wait_for_tick, cf::wait_for_tick_begin	254	=item cf::wait_for_tick, cf::wait_for_tick_begin
141		255
142	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only	256	These are functions that inhibit the current coroutine one tick.
143	returns directly I<after> the tick processing (and consequently, can only wake one process	257	cf::wait_for_tick_begin only returns directly I<after> the tick
		258	processing (and consequently, can only wake one thread per tick), while
144	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.	259	cf::wait_for_tick wakes up all waiters after tick processing.
		260
		261	Note that cf::wait_for_tick will immediately return when the server is not
		262	ticking, making it suitable for small pauses in threads that need to run
		263	when the server is paused. If that is not applicable (i.e. you I<really>
		264	want to wait, use C<$cf::WAIT_FOR_TICK>).
		265
		266	=item $cf::WAIT_FOR_TICK
		267
		268	Note that C<cf::wait_for_tick> is probably the correct thing to use. This
		269	variable contains a L<Coro::Signal> that is broadcats after every server
		270	tick. Calling C<< ->wait >> on it will suspend the caller until after the
		271	next server tick.
		272
		273	=cut
		274
		275	sub wait_for_tick();
		276	sub wait_for_tick_begin();
		277
		278	=item @cf::INVOKE_RESULTS
		279
		280	This array contains the results of the last C<invoke ()> call. When
		281	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		282	that call.
		283
		284	=item %cf::REFLECT
		285
		286	Contains, for each (C++) class name, a hash reference with information
		287	about object members (methods, scalars, arrays and flags) and other
		288	metadata, which is useful for introspection.
145		289
146	=back	290	=back
147		291
148	=cut	292	=cut
149		293
150	BEGIN {	294	sub error(@) { LOG llevError, join "", @_ }
151	*CORE::GLOBAL::warn = sub {	295	sub warn (@) { LOG llevWarn , join "", @_ }
		296	sub info (@) { LOG llevInfo , join "", @_ }
		297	sub debug(@) { LOG llevDebug, join "", @_ }
		298	sub trace(@) { LOG llevTrace, join "", @_ }
		299
		300	$Coro::State::WARNHOOK = sub {
152	my $msg = join "", @_;	301	my $msg = join "", @_;
153		302
154	$msg .= "\n"	303	$msg .= "\n"
155	unless $msg =~ /\n$/;	304	unless $msg =~ /\n$/;
156		305
157	$msg =~ s/([\x00-\x09\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;	306	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
158		307
159	utf8::encode $msg;
160	LOG llevError, $msg;	308	LOG llevWarn, $msg;
161	};	309	};
162	}	310
		311	$Coro::State::DIEHOOK = sub {
		312	return unless $^S eq 0; # "eq", not "=="
		313
		314	error Carp::longmess $_[0];
		315
		316	if (in_main) {#d#
		317	error "DIEHOOK called in main context, Coro bug?\n";#d#
		318	return;#d#
		319	}#d#
		320
		321	# kill coroutine otherwise
		322	Coro::terminate
		323	};
163		324
164	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	325	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
165	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	326	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
166	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	327	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
167	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	328	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
168	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	329	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		330	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
169	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	331	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
170		332
171	# we bless all objects into (empty) derived classes to force a method lookup	333	# we bless all objects into (empty) derived classes to force a method lookup
172	# within the Safe compartment.	334	# within the Safe compartment.
173	for my $pkg (qw(	335	for my $pkg (qw(
174	cf::global cf::attachable	336	cf::global cf::attachable
175	cf::object cf::object::player	337	cf::object cf::object::player
176	cf::client cf::player	338	cf::client cf::player
177	cf::arch cf::living	339	cf::arch cf::living
		340	cf::map cf::mapspace
178	cf::map cf::party cf::region	341	cf::party cf::region
179	)) {	342	)) {
180	no strict 'refs';
181	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	343	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
182	}	344	}
183		345
184	$Event::DIED = sub {	346	$EV::DIED = sub {
185	warn "error in event callback: @_";	347	warn "error in event callback: $@";
186	};	348	};
		349
		350	#############################################################################
		351
		352	sub fork_call(&@);
		353	sub get_slot($;$$);
		354
		355	#############################################################################
187		356
188	=head2 UTILITY FUNCTIONS	357	=head2 UTILITY FUNCTIONS
189		358
190	=over 4	359	=over 4
191		360
…		…
210	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	379	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
211	$d	380	$d
212	} || "[unable to dump $_[0]: '$@']";	381	} || "[unable to dump $_[0]: '$@']";
213	}	382	}
214		383
215	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working	384	=item $scalar = cf::load_file $path
216		385
		386	Loads the given file from path and returns its contents. Croaks on error
		387	and can block.
		388
		389	=cut
		390
		391	sub load_file($) {
		392	0 <= aio_load $_[0], my $data
		393	or Carp::croak "$_[0]: $!";
		394
		395	$data
		396	}
		397
		398	=item $success = cf::replace_file $path, $data, $sync
		399
		400	Atomically replaces the file at the given $path with new $data, and
		401	optionally $sync the data to disk before replacing the file.
		402
		403	=cut
		404
		405	sub replace_file($$;$) {
		406	my ($path, $data, $sync) = @_;
		407
		408	my $lock = cf::lock_acquire ("replace_file:$path");
		409
		410	my $fh = aio_open "$path~", Fcntl::O_WRONLY | Fcntl::O_CREAT | Fcntl::O_TRUNC, 0644
		411	or return;
		412
		413	$data = $data->() if ref $data;
		414
		415	length $data == aio_write $fh, 0, (length $data), $data, 0
		416	or return;
		417
		418	!$sync
		419	or !aio_fsync $fh
		420	or return;
		421
		422	aio_close $fh
		423	and return;
		424
		425	aio_rename "$path~", $path
		426	and return;
		427
		428	if ($sync) {
		429	$path =~ s%/[^/]*$%%;
		430	aio_pathsync $path;
		431	}
		432
		433	1
		434	}
		435
217	=item $ref = cf::from_json $json	436	=item $ref = cf::decode_json $json
218		437
219	Converts a JSON string into the corresponding perl data structure.	438	Converts a JSON string into the corresponding perl data structure.
220		439
221	=item $json = cf::to_json $ref	440	=item $json = cf::encode_json $ref
222		441
223	Converts a perl data structure into its JSON representation.	442	Converts a perl data structure into its JSON representation.
224		443
		444	=cut
		445
		446	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
		447
		448	sub encode_json($) { $json_coder->encode ($_[0]) }
		449	sub decode_json($) { $json_coder->decode ($_[0]) }
		450
		451	=item $ref = cf::decode_storable $scalar
		452
		453	Same as Coro::Storable::thaw, so blocks.
		454
		455	=cut
		456
		457	BEGIN { *decode_storable = \&Coro::Storable::thaw }
		458
		459	=item $ref = cf::decode_yaml $scalar
		460
		461	Same as YAML::XS::Load, but doesn't leak, because it forks (and thus blocks).
		462
		463	=cut
		464
		465	sub decode_yaml($) {
		466	fork_call { YAML::XS::Load $_[0] } @_
		467	}
		468
		469	=item $scalar = cf::unlzf $scalar
		470
		471	Same as Compress::LZF::compress, but takes server ticks into account, so
		472	blocks.
		473
		474	=cut
		475
		476	sub unlzf($) {
		477	# we assume 100mb/s minimum decompression speed (noncompressible data on a ~2ghz machine)
		478	cf::get_slot +(length $_[0]) / 100_000_000, 0, "unlzf";
		479	Compress::LZF::decompress $_[0]
		480	}
		481
		482	=item cf::post_init { BLOCK }
		483
		484	Execute the given codeblock, I<after> all extensions have been (re-)loaded,
		485	but I<before> the server starts ticking again.
		486
		487	The codeblock will have a single boolean argument to indicate whether this
		488	is a reload or not.
		489
		490	=cut
		491
		492	sub post_init(&) {
		493	push @POST_INIT, shift;
		494	}
		495
		496	sub _post_init {
		497	trace "running post_init jobs";
		498
		499	# run them in parallel...
		500
		501	my @join;
		502
		503	while () {
		504	push @join, map &Coro::async ($_, 0), @POST_INIT;
		505	@POST_INIT = ();
		506
		507	@join or last;
		508
		509	(pop @join)->join;
		510	}
		511	}
		512
225	=item cf::lock_wait $string	513	=item cf::lock_wait $string
226		514
227	Wait until the given lock is available. See cf::lock_acquire.	515	Wait until the given lock is available. See cf::lock_acquire.
228		516
229	=item my $lock = cf::lock_acquire $string	517	=item my $lock = cf::lock_acquire $string
230		518
231	Wait until the given lock is available and then acquires it and returns	519	Wait until the given lock is available and then acquires it and returns
232	a Coro::guard object. If the guard object gets destroyed (goes out of scope,	520	a L<Guard> object. If the guard object gets destroyed (goes out of scope,
233	for example when the coroutine gets canceled), the lock is automatically	521	for example when the coroutine gets canceled), the lock is automatically
234	returned.	522	returned.
235		523
		524	Locks are *not* recursive, locking from the same coro twice results in a
		525	deadlocked coro.
		526
236	Lock names should begin with a unique identifier (for example, cf::map::find	527	Lock names should begin with a unique identifier (for example, cf::map::find
237	uses map_find and cf::map::load uses map_load).	528	uses map_find and cf::map::load uses map_load).
238		529
239	=cut	530	=item $locked = cf::lock_active $string
240		531
241	our %LOCK;	532	Return true if the lock is currently active, i.e. somebody has locked it.
		533
		534	=cut
		535
		536	our $LOCKS = new Coro::SemaphoreSet;
242		537
243	sub lock_wait($) {	538	sub lock_wait($) {
244	my ($key) = @_;	539	$LOCKS->wait ($_[0]);
245
246	# wait for lock, if any
247	while ($LOCK{$key}) {
248	push @{ $LOCK{$key} }, $Coro::current;
249	Coro::schedule;
250	}
251	}	540	}
252		541
253	sub lock_acquire($) {	542	sub lock_acquire($) {
254	my ($key) = @_;	543	$LOCKS->guard ($_[0])
		544	}
255		545
256	# wait, to be sure we are not locked	546	sub lock_active($) {
257	lock_wait $key;	547	$LOCKS->count ($_[0]) < 1
258
259	$LOCK{$key} = [];
260
261	Coro::guard {
262	# wake up all waiters, to be on the safe side
263	$_->ready for @{ delete $LOCK{$key} };
264	}
265	}	548	}
266		549
267	sub freeze_mainloop {	550	sub freeze_mainloop {
268	return unless $TICK_WATCHER->is_active;	551	tick_inhibit_inc;
269		552
270	my $guard = Coro::guard {	553	&Guard::guard (\&tick_inhibit_dec);
271	$TICK_WATCHER->start;	554	}
		555
		556	=item cf::periodic $interval, $cb
		557
		558	Like EV::periodic, but randomly selects a starting point so that the actions
		559	get spread over time.
		560
		561	=cut
		562
		563	sub periodic($$) {
		564	my ($interval, $cb) = @_;
		565
		566	my $start = rand List::Util::min 180, $interval;
		567
		568	EV::periodic $start, $interval, 0, $cb
		569	}
		570
		571	=item cf::get_slot $time[, $priority[, $name]]
		572
		573	Allocate $time seconds of blocking CPU time at priority C<$priority>
		574	(default: 0): This call blocks and returns only when you have at least
		575	C<$time> seconds of cpu time till the next tick. The slot is only valid
		576	till the next cede.
		577
		578	Background jobs should use a priority les than zero, interactive jobs
		579	should use 100 or more.
		580
		581	The optional C<$name> can be used to identify the job to run. It might be
		582	used for statistical purposes and should identify the same time-class.
		583
		584	Useful for short background jobs.
		585
		586	=cut
		587
		588	our @SLOT_QUEUE;
		589	our $SLOT_QUEUE;
		590	our $SLOT_DECAY = 0.9;
		591
		592	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		593	$SLOT_QUEUE = Coro::async {
		594	$Coro::current->desc ("timeslot manager");
		595
		596	my $signal = new Coro::Signal;
		597	my $busy;
		598
		599	while () {
		600	next_job:
		601
		602	my $avail = cf::till_tick;
		603
		604	for (0 .. $#SLOT_QUEUE) {
		605	if ($SLOT_QUEUE[$_][0] <= $avail) {
		606	$busy = 0;
		607	my $job = splice @SLOT_QUEUE, $_, 1, ();
		608	$job->[2]->send;
		609	Coro::cede;
		610	goto next_job;
		611	} else {
		612	$SLOT_QUEUE[$_][0] *= $SLOT_DECAY;
		613	}
		614	}
		615
		616	if (@SLOT_QUEUE) {
		617	# we do not use wait_for_tick() as it returns immediately when tick is inactive
		618	$WAIT_FOR_TICK->wait;
		619	} else {
		620	$busy = 0;
		621	Coro::schedule;
		622	}
272	};	623	}
273	$TICK_WATCHER->stop;	624	};
274	$guard	625
		626	sub get_slot($;$$) {
		627	return if tick_inhibit || $Coro::current == $Coro::main;
		628
		629	my ($time, $pri, $name) = @_;
		630
		631	$time = clamp $time, 0.01, $TICK * .6;
		632
		633	my $sig = new Coro::Signal;
		634
		635	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		636	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		637	$SLOT_QUEUE->ready;
		638	$sig->wait;
275	}	639	}
276		640
277	=item cf::async { BLOCK }	641	=item cf::async { BLOCK }
278		642
279	Currently the same as Coro::async_pool, meaning you cannot use	643	Currently the same as Coro::async_pool, meaning you cannot use
…		…
284		648
285	BEGIN { *async = \&Coro::async_pool }	649	BEGIN { *async = \&Coro::async_pool }
286		650
287	=item cf::sync_job { BLOCK }	651	=item cf::sync_job { BLOCK }
288		652
289	The design of crossfire+ requires that the main coro ($Coro::main) is	653	The design of Deliantra requires that the main coroutine ($Coro::main)
290	always able to handle events or runnable, as crossfire+ is only partly	654	is always able to handle events or runnable, as Deliantra is only
291	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	655	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		656	acceptable.
292		657
293	If it must be done, put the blocking parts into C<sync_job>. This will run	658	If it must be done, put the blocking parts into C<sync_job>. This will run
294	the given BLOCK in another coroutine while waiting for the result. The	659	the given BLOCK in another coroutine while waiting for the result. The
295	server will be frozen during this time, so the block should either finish	660	server will be frozen during this time, so the block should either finish
296	fast or be very important.	661	fast or be very important.
…		…
298	=cut	663	=cut
299		664
300	sub sync_job(&) {	665	sub sync_job(&) {
301	my ($job) = @_;	666	my ($job) = @_;
302		667
303	if ($Coro::current == $Coro::main) {	668	if (in_main) {
		669	my $time = AE::time;
		670
304	# this is the main coro, too bad, we have to block	671	# this is the main coro, too bad, we have to block
305	# till the operation succeeds, freezing the server :/	672	# till the operation succeeds, freezing the server :/
306		673
307	# TODO: use suspend/resume instead	674	#LOG llevError, Carp::longmess "sync job";#d#
308	# (but this is cancel-safe)	675
309	my $freeze_guard = freeze_mainloop;	676	my $freeze_guard = freeze_mainloop;
310		677
311	my $busy = 1;	678	my $busy = 1;
312	my @res;	679	my @res;
313		680
314	(async {	681	(async {
		682	$Coro::current->desc ("sync job coro");
315	@res = eval { $job->() };	683	@res = eval { $job->() };
316	warn $@ if $@;	684	error $@ if $@;
317	undef $busy;	685	undef $busy;
318	})->prio (Coro::PRIO_MAX);	686	})->prio (Coro::PRIO_MAX);
319		687
320	while ($busy) {	688	while ($busy) {
321	Coro::cede or Event::one_event;	689	if (Coro::nready) {
		690	Coro::cede_notself;
		691	} else {
		692	EV::loop EV::LOOP_ONESHOT;
322	}	693	}
		694	}
		695
		696	my $time = AE::time - $time;
		697
		698	$TICK_START += $time; # do not account sync jobs to server load
323		699
324	wantarray ? @res : $res[0]	700	wantarray ? @res : $res[0]
325	} else {	701	} else {
326	# we are in another coroutine, how wonderful, everything just works	702	# we are in another coroutine, how wonderful, everything just works
327		703
…		…
347	$EXT_CORO{$coro+0} = $coro;	723	$EXT_CORO{$coro+0} = $coro;
348		724
349	$coro	725	$coro
350	}	726	}
351		727
352	sub write_runtime {	728	=item fork_call { }, @args
353	my $guard = cf::lock_acquire "write_runtime";
354		729
355	my $runtime = cf::localdir . "/runtime";	730	Executes the given code block with the given arguments in a seperate
		731	process, returning the results. Everything must be serialisable with
		732	Coro::Storable. May, of course, block. Note that the executed sub may
		733	never block itself or use any form of event handling.
356		734
357	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	735	=cut
358	or return;
359		736
360	my $value = $cf::RUNTIME + 90 + 10;	737	sub post_fork {
361	# 10 is the runtime save interval, for a monotonic clock	738	reset_signals;
362	# 60 allows for the watchdog to kill the server.	739	}
363		740
364	(aio_write $fh, 0, (length $value), $value, 0) <= 0	741	sub fork_call(&@) {
365	and return;	742	my ($cb, @args) = @_;
366		743
367	# always fsync - this file is important	744	# we seemingly have to make a local copy of the whole thing,
368	aio_fsync $fh	745	# otherwise perl prematurely frees the stuff :/
369	and return;	746	# TODO: investigate and fix (likely this will be rather laborious)
370		747
371	close $fh	748	my @res = Coro::Util::fork_eval {
372	or return;	749	cf::post_fork;
		750	&$cb
		751	} @args;
373		752
374	aio_rename "$runtime~", $runtime	753	wantarray ? @res : $res[-1]
375	and return;	754	}
376		755
		756	sub objinfo {
377	1	757	(
		758	"counter value" => cf::object::object_count,
		759	"objects created" => cf::object::create_count,
		760	"objects destroyed" => cf::object::destroy_count,
		761	"freelist size" => cf::object::free_count,
		762	"allocated objects" => cf::object::objects_size,
		763	"active objects" => cf::object::actives_size,
		764	)
		765	}
		766
		767	=item $coin = coin_from_name $name
		768
		769	=cut
		770
		771	our %coin_alias = (
		772	"silver" => "silvercoin",
		773	"silvercoin" => "silvercoin",
		774	"silvercoins" => "silvercoin",
		775	"gold" => "goldcoin",
		776	"goldcoin" => "goldcoin",
		777	"goldcoins" => "goldcoin",
		778	"platinum" => "platinacoin",
		779	"platinumcoin" => "platinacoin",
		780	"platinumcoins" => "platinacoin",
		781	"platina" => "platinacoin",
		782	"platinacoin" => "platinacoin",
		783	"platinacoins" => "platinacoin",
		784	"royalty" => "royalty",
		785	"royalties" => "royalty",
		786	);
		787
		788	sub coin_from_name($) {
		789	$coin_alias{$_[0]}
		790	? cf::arch::find $coin_alias{$_[0]}
		791	: undef
		792	}
		793
		794	=item $value = cf::db_get $family => $key
		795
		796	Returns a single value from the environment database.
		797
		798	=item cf::db_put $family => $key => $value
		799
		800	Stores the given C<$value> in the family. It can currently store binary
		801	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		802
		803	=item $db = cf::db_table "name"
		804
		805	Create and/or open a new database table. The string must not be "db" and must be unique
		806	within each server.
		807
		808	=cut
		809
		810	sub db_table($) {
		811	cf::error "db_get called from main context"
		812	if $Coro::current == $Coro::main;
		813
		814	my ($name) = @_;
		815	my $db = BDB::db_create $DB_ENV;
		816
		817	eval {
		818	$db->set_flags (BDB::CHKSUM);
		819
		820	utf8::encode $name;
		821	BDB::db_open $db, undef, $name, undef, BDB::BTREE,
		822	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		823	cf::cleanup "db_open(db): $!" if $!;
		824	};
		825	cf::cleanup "db_open(db): $@" if $@;
		826
		827	$db
		828	}
		829
		830	our $DB;
		831
		832	sub db_init {
		833	$DB ||= db_table "db";
		834	}
		835
		836	sub db_get($$) {
		837	my $key = "$_[0]/$_[1]";
		838
		839	cf::error "db_get called from main context"
		840	if $Coro::current == $Coro::main;
		841
		842	BDB::db_get $DB, undef, $key, my $data;
		843
		844	$! ? ()
		845	: $data
		846	}
		847
		848	sub db_put($$$) {
		849	BDB::dbreq_pri 4;
		850	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		851	}
		852
		853	=item cf::cache $id => [$paths...], $processversion => $process
		854
		855	Generic caching function that returns the value of the resource $id,
		856	caching and regenerating as required.
		857
		858	This function can block.
		859
		860	=cut
		861
		862	sub cache {
		863	my ($id, $src, $processversion, $process) = @_;
		864
		865	my $meta =
		866	join "\x00",
		867	$processversion,
		868	map {
		869	aio_stat $_
		870	and Carp::croak "$_: $!";
		871
		872	($_, (stat _)[7,9])
		873	} @$src;
		874
		875	my $dbmeta = db_get cache => "$id/meta";
		876	if ($dbmeta ne $meta) {
		877	# changed, we may need to process
		878
		879	my @data;
		880	my $md5;
		881
		882	for (0 .. $#$src) {
		883	$data[$_] = load_file $src->[$_];
		884	}
		885
		886	# if processing is expensive, check
		887	# checksum first
		888	if (1) {
		889	$md5 =
		890	join "\x00",
		891	$processversion,
		892	map {
		893	cf::cede_to_tick;
		894	($src->[$_], Digest::MD5::md5_hex $data[$_])
		895	} 0.. $#$src;
		896
		897
		898	my $dbmd5 = db_get cache => "$id/md5";
		899	if ($dbmd5 eq $md5) {
		900	db_put cache => "$id/meta", $meta;
		901
		902	return db_get cache => "$id/data";
		903	}
		904	}
		905
		906	my $t1 = EV::time;
		907	my $data = $process->(\@data);
		908	my $t2 = EV::time;
		909
		910	info "cache: '$id' processed in ", $t2 - $t1, "s\n";
		911
		912	db_put cache => "$id/data", $data;
		913	db_put cache => "$id/md5" , $md5;
		914	db_put cache => "$id/meta", $meta;
		915
		916	return $data;
		917	}
		918
		919	db_get cache => "$id/data"
378	}	920	}
379		921
380	=item cf::datalog type => key => value, ...	922	=item cf::datalog type => key => value, ...
381		923
382	Log a datalog packet of the given type with the given key-value pairs.	924	Log a datalog packet of the given type with the given key-value pairs.
383		925
384	=cut	926	=cut
385		927
386	sub datalog($@) {	928	sub datalog($@) {
387	my ($type, %kv) = @_;	929	my ($type, %kv) = @_;
388	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });	930	info "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
389	}	931	}
390		932
391	=back	933	=back
392		934
393	=cut	935	=cut
394		936
395	#############################################################################	937	#############################################################################
396		938
397	=head2 ATTACHABLE OBJECTS	939	=head2 ATTACHABLE OBJECTS
398		940
399	Many objects in crossfire are so-called attachable objects. That means you can	941	Many objects in deliantra are so-called attachable objects. That means you can
400	attach callbacks/event handlers (a collection of which is called an "attachment")	942	attach callbacks/event handlers (a collection of which is called an "attachment")
401	to it. All such attachable objects support the following methods.	943	to it. All such attachable objects support the following methods.
402		944
403	In the following description, CLASS can be any of C<global>, C<object>	945	In the following description, CLASS can be any of C<global>, C<object>
404	C<player>, C<client> or C<map> (i.e. the attachable objects in	946	C<player>, C<client> or C<map> (i.e. the attachable objects in
405	crossfire+).	947	Deliantra).
406		948
407	=over 4	949	=over 4
408		950
409	=item $attachable->attach ($attachment, key => $value...)	951	=item $attachable->attach ($attachment, key => $value...)
410		952
…		…
454	=item cf::CLASS::attachment $name, ...	996	=item cf::CLASS::attachment $name, ...
455		997
456	Register an attachment by C<$name> through which attachable objects of the	998	Register an attachment by C<$name> through which attachable objects of the
457	given CLASS can refer to this attachment.	999	given CLASS can refer to this attachment.
458		1000
459	Some classes such as crossfire maps and objects can specify attachments	1001	Some classes such as deliantra maps and objects can specify attachments
460	that are attached at load/instantiate time, thus the need for a name.	1002	that are attached at load/instantiate time, thus the need for a name.
461		1003
462	These calls expect any number of the following handler/hook descriptions:	1004	These calls expect any number of the following handler/hook descriptions:
463		1005
464	=over 4	1006	=over 4
…		…
573	$registry = $CB_TYPE[$object_type] ||= [];	1115	$registry = $CB_TYPE[$object_type] ||= [];
574		1116
575	} elsif ($type eq "subtype") {	1117	} elsif ($type eq "subtype") {
576	defined $object_type or Carp::croak "subtype specified without type";	1118	defined $object_type or Carp::croak "subtype specified without type";
577	my $object_subtype = shift @arg;	1119	my $object_subtype = shift @arg;
578	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	1120	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
579		1121
580	} elsif ($type eq "package") {	1122	} elsif ($type eq "package") {
581	my $pkg = shift @arg;	1123	my $pkg = shift @arg;
582		1124
583	while (my ($name, $id) = each %cb_id) {	1125	while (my ($name, $id) = each %cb_id) {
…		…
588		1130
589	} elsif (exists $cb_id{$type}) {	1131	} elsif (exists $cb_id{$type}) {
590	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;	1132	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
591		1133
592	} elsif (ref $type) {	1134	} elsif (ref $type) {
593	warn "attaching objects not supported, ignoring.\n";	1135	error "attaching objects not supported, ignoring.\n";
594		1136
595	} else {	1137	} else {
596	shift @arg;	1138	shift @arg;
597	warn "attach argument '$type' not supported, ignoring.\n";	1139	error "attach argument '$type' not supported, ignoring.\n";
598	}	1140	}
599	}	1141	}
600	}	1142	}
601		1143
602	sub _object_attach {	1144	sub _object_attach {
…		…
612	_attach $registry, $klass, @attach;	1154	_attach $registry, $klass, @attach;
613	}	1155	}
614		1156
615	$obj->{$name} = \%arg;	1157	$obj->{$name} = \%arg;
616	} else {	1158	} else {
617	warn "object uses attachment '$name' that is not available, postponing.\n";	1159	info "object uses attachment '$name' which is not available, postponing.\n";
618	}	1160	}
619		1161
620	$obj->{_attachment}{$name} = undef;	1162	$obj->{_attachment}{$name} = undef;
621	}	1163	}
622		1164
…		…
624	if (ref $_[0]) {	1166	if (ref $_[0]) {
625	_object_attach @_;	1167	_object_attach @_;
626	} else {	1168	} else {
627	_attach shift->_attach_registry, @_;	1169	_attach shift->_attach_registry, @_;
628	}	1170	}
		1171	_recalc_want;
629	};	1172	};
630		1173
631	# all those should be optimised	1174	# all those should be optimised
632	sub cf::attachable::detach {	1175	sub cf::attachable::detach {
633	my ($obj, $name) = @_;	1176	my ($obj, $name) = @_;
…		…
636	delete $obj->{_attachment}{$name};	1179	delete $obj->{_attachment}{$name};
637	reattach ($obj);	1180	reattach ($obj);
638	} else {	1181	} else {
639	Carp::croak "cannot, currently, detach class attachments";	1182	Carp::croak "cannot, currently, detach class attachments";
640	}	1183	}
		1184	_recalc_want;
641	};	1185	};
642		1186
643	sub cf::attachable::attached {	1187	sub cf::attachable::attached {
644	my ($obj, $name) = @_;	1188	my ($obj, $name) = @_;
645		1189
…		…
660	";	1204	";
661	die if $@;	1205	die if $@;
662	}	1206	}
663		1207
664	our $override;	1208	our $override;
665	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	1209	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
666		1210
667	sub override {	1211	sub override {
668	$override = 1;	1212	$override = 1;
669	@invoke_results = ();	1213	@INVOKE_RESULTS = (@_);
670	}	1214	}
671		1215
672	sub do_invoke {	1216	sub do_invoke {
673	my $event = shift;	1217	my $event = shift;
674	my $callbacks = shift;	1218	my $callbacks = shift;
675		1219
676	@invoke_results = ();	1220	@INVOKE_RESULTS = ();
677		1221
678	local $override;	1222	local $override;
679		1223
680	for (@$callbacks) {	1224	for (@$callbacks) {
681	eval { &{$_->[1]} };	1225	eval { &{$_->[1]} };
682		1226
683	if ($@) {	1227	if ($@) {
684	warn "$@";
685	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";	1228	error "$@", "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
686	override;	1229	override;
687	}	1230	}
688		1231
689	return 1 if $override;	1232	return 1 if $override;
690	}	1233	}
691		1234
692	0	1235	0
693	}	1236	}
694		1237
695	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1238	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
696		1239
697	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1240	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
698		1241
699	Generate an object-specific event with the given arguments.	1242	Generate an object-specific event with the given arguments.
700		1243
701	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	1244	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
702	removed in future versions), and there is no public API to access override	1245	removed in future versions), and there is no public API to access override
703	results (if you must, access C<@cf::invoke_results> directly).	1246	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
704		1247
705	=back	1248	=back
706		1249
707	=cut	1250	=cut
708		1251
709	#############################################################################	1252	#############################################################################
710	# object support	1253	# object support
		1254
		1255	sub _object_equal($$);
		1256	sub _object_equal($$) {
		1257	my ($a, $b) = @_;
		1258
		1259	return 0 unless (ref $a) eq (ref $b);
		1260
		1261	if ("HASH" eq ref $a) {
		1262	my @ka = keys %$a;
		1263	my @kb = keys %$b;
		1264
		1265	return 0 if @ka != @kb;
		1266
		1267	for (0 .. $#ka) {
		1268	return 0 unless $ka[$_] eq $kb[$_];
		1269	return 0 unless _object_equal $a->{$ka[$_]}, $b->{$kb[$_]};
		1270	}
		1271
		1272	} elsif ("ARRAY" eq ref $a) {
		1273
		1274	return 0 if @$a != @$b;
		1275
		1276	for (0 .. $#$a) {
		1277	return 0 unless _object_equal $a->[$_], $b->[$_];
		1278	}
		1279
		1280	} elsif ($a ne $b) {
		1281	return 0;
		1282	}
		1283
		1284	1
		1285	}
		1286
		1287	our $SLOW_MERGES;#d#
		1288	sub _can_merge {
		1289	my ($ob1, $ob2) = @_;
		1290
		1291	++$SLOW_MERGES;#d#
		1292
		1293	# we do the slow way here
		1294	return _object_equal $ob1, $ob2
		1295	}
711		1296
712	sub reattach {	1297	sub reattach {
713	# basically do the same as instantiate, without calling instantiate	1298	# basically do the same as instantiate, without calling instantiate
714	my ($obj) = @_;	1299	my ($obj) = @_;
715		1300
		1301	# no longer needed after getting rid of delete_package?
716	bless $obj, ref $obj; # re-bless in case extensions have been reloaded	1302	#bless $obj, ref $obj; # re-bless in case extensions have been reloaded
717		1303
718	my $registry = $obj->registry;	1304	my $registry = $obj->registry;
719		1305
720	@$registry = ();	1306	@$registry = ();
721		1307
…		…
726	for (@$attach) {	1312	for (@$attach) {
727	my ($klass, @attach) = @$_;	1313	my ($klass, @attach) = @$_;
728	_attach $registry, $klass, @attach;	1314	_attach $registry, $klass, @attach;
729	}	1315	}
730	} else {	1316	} else {
731	warn "object uses attachment '$name' that is not available, postponing.\n";	1317	info "object uses attachment '$name' that is not available, postponing.\n";
732	}	1318	}
733	}	1319	}
734	}	1320	}
735		1321
736	cf::attachable->attach (	1322	cf::attachable->attach (
737	prio => -1000000,	1323	prio => -1000000,
738	on_instantiate => sub {	1324	on_instantiate => sub {
739	my ($obj, $data) = @_;	1325	my ($obj, $data) = @_;
740		1326
741	$data = from_json $data;	1327	$data = decode_json $data;
742		1328
743	for (@$data) {	1329	for (@$data) {
744	my ($name, $args) = @$_;	1330	my ($name, $args) = @$_;
745		1331
746	$obj->attach ($name, %{$args || {} });	1332	$obj->attach ($name, %{$args || {} });
…		…
762	sub object_freezer_save {	1348	sub object_freezer_save {
763	my ($filename, $rdata, $objs) = @_;	1349	my ($filename, $rdata, $objs) = @_;
764		1350
765	sync_job {	1351	sync_job {
766	if (length $$rdata) {	1352	if (length $$rdata) {
		1353	utf8::decode (my $decname = $filename);
767	warn sprintf "saving %s (%d,%d)\n",	1354	trace sprintf "saving %s (%d,%d)\n",
768	$filename, length $$rdata, scalar @$objs;	1355	$decname, length $$rdata, scalar @$objs
		1356	if $VERBOSE_IO;
769		1357
770	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1358	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
771	chmod SAVE_MODE, $fh;	1359	aio_chmod $fh, SAVE_MODE;
772	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1360	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
773	aio_fsync $fh if $cf::USE_FSYNC;	1361	if ($cf::USE_FSYNC) {
		1362	aio_sync_file_range $fh, 0, 0, IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE | IO::AIO::SYNC_FILE_RANGE_WRITE | IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER;
		1363	aio_fsync $fh;
		1364	}
774	close $fh;	1365	aio_close $fh;
775		1366
776	if (@$objs) {	1367	if (@$objs) {
777	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	1368	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
778	chmod SAVE_MODE, $fh;	1369	aio_chmod $fh, SAVE_MODE;
779	my $data = Storable::nfreeze { version => 1, objs => $objs };	1370	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
780	aio_write $fh, 0, (length $data), $data, 0;	1371	aio_write $fh, 0, (length $data), $data, 0;
781	aio_fsync $fh if $cf::USE_FSYNC;	1372	if ($cf::USE_FSYNC) {
		1373	aio_sync_file_range $fh, 0, 0, IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE | IO::AIO::SYNC_FILE_RANGE_WRITE | IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER;
		1374	aio_fsync $fh;
		1375	}
782	close $fh;	1376	aio_close $fh;
783	aio_rename "$filename.pst~", "$filename.pst";	1377	aio_rename "$filename.pst~", "$filename.pst";
784	}	1378	}
785	} else {	1379	} else {
786	aio_unlink "$filename.pst";	1380	aio_unlink "$filename.pst";
787	}	1381	}
788		1382
789	aio_rename "$filename~", $filename;	1383	aio_rename "$filename~", $filename;
		1384
		1385	$filename =~ s%/[^/]+$%%;
		1386	aio_pathsync $filename if $cf::USE_FSYNC;
790	} else {	1387	} else {
791	warn "FATAL: $filename~: $!\n";	1388	error "unable to save objects: $filename~: $!\n";
792	}	1389	}
793	} else {	1390	} else {
794	aio_unlink $filename;	1391	aio_unlink $filename;
795	aio_unlink "$filename.pst";	1392	aio_unlink "$filename.pst";
796	}	1393	}
797	}	1394	};
798	}	1395	}
799		1396
800	sub object_freezer_as_string {	1397	sub object_freezer_as_string {
801	my ($rdata, $objs) = @_;	1398	my ($rdata, $objs) = @_;
802		1399
…		…
814	or return;	1411	or return;
815		1412
816	unless (aio_stat "$filename.pst") {	1413	unless (aio_stat "$filename.pst") {
817	(aio_load "$filename.pst", $av) >= 0	1414	(aio_load "$filename.pst", $av) >= 0
818	or return;	1415	or return;
		1416
819	$av = eval { (Storable::thaw $av)->{objs} };	1417	my $st = eval { Coro::Storable::thaw $av };
		1418	$av = $st->{objs};
820	}	1419	}
821		1420
		1421	utf8::decode (my $decname = $filename);
822	warn sprintf "loading %s (%d)\n",	1422	trace sprintf "loading %s (%d,%d)\n",
823	$filename, length $data, scalar @{$av || []};#d#	1423	$decname, length $data, scalar @{$av || []}
		1424	if $VERBOSE_IO;
		1425
824	return ($data, $av);	1426	($data, $av)
825	}	1427	}
		1428
		1429	=head2 COMMAND CALLBACKS
		1430
		1431	=over 4
		1432
		1433	=cut
826		1434
827	#############################################################################	1435	#############################################################################
828	# command handling &c	1436	# command handling &c
829		1437
830	=item cf::register_command $name => \&callback($ob,$args);	1438	=item cf::register_command $name => \&callback($ob,$args)
831		1439
832	Register a callback for execution when the client sends the user command	1440	Register a callback for execution when the client sends the user command
833	$name.	1441	$name.
834		1442
835	=cut	1443	=cut
…		…
841	#warn "registering command '$name/$time' to '$caller'";	1449	#warn "registering command '$name/$time' to '$caller'";
842		1450
843	push @{ $COMMAND{$name} }, [$caller, $cb];	1451	push @{ $COMMAND{$name} }, [$caller, $cb];
844	}	1452	}
845		1453
846	=item cf::register_extcmd $name => \&callback($pl,$packet);	1454	=item cf::register_extcmd $name => \&callback($pl,@args)
847		1455
848	Register a callbackf ro execution when the client sends an extcmd packet.	1456	Register a callback for execution when the client sends an (synchronous)
		1457	extcmd packet. Ext commands will be processed in the order they are
		1458	received by the server, like other user commands. The first argument is
		1459	the logged-in player. Ext commands can only be processed after a player
		1460	has logged in successfully.
849		1461
850	If the callback returns something, it is sent back as if reply was being	1462	The values will be sent back to the client.
851	called.
852		1463
853	=cut	1464	=item cf::register_async_extcmd $name => \&callback($pl,$reply->(...),@args)
854		1465
		1466	Same as C<cf::register_extcmd>, but instead of returning values, the
		1467	callback needs to clal the C<$reply> function.
		1468
		1469	=item cf::register_exticmd $name => \&callback($ns,@args)
		1470
		1471	Register a callback for execution when the client sends an (asynchronous)
		1472	exticmd packet. Exti commands are processed by the server as soon as they
		1473	are received, i.e. out of order w.r.t. other commands. The first argument
		1474	is a client socket. Exti commands can be received anytime, even before
		1475	log-in.
		1476
		1477	The values will be sent back to the client.
		1478
		1479	=item cf::register_async_exticmd $name => \&callback($ns,$reply->(...),@args)
		1480
		1481	Same as C<cf::register_extcmd>, but instead of returning values, the
		1482	callback needs to clal the C<$reply> function.
		1483
		1484	=cut
		1485
855	sub register_extcmd {	1486	sub register_extcmd($$) {
856	my ($name, $cb) = @_;	1487	my ($name, $cb) = @_;
857		1488
858	$EXTCMD{$name} = $cb;	1489	$EXTCMD{$name} = $cb;
859	}	1490	}
860		1491
		1492	sub register_async_extcmd($$) {
		1493	my ($name, $cb) = @_;
		1494
		1495	$EXTACMD{$name} = $cb;
		1496	}
		1497
		1498	sub register_exticmd($$) {
		1499	my ($name, $cb) = @_;
		1500
		1501	$EXTICMD{$name} = $cb;
		1502	}
		1503
		1504	sub register_async_exticmd($$) {
		1505	my ($name, $cb) = @_;
		1506
		1507	$EXTIACMD{$name} = $cb;
		1508	}
		1509
		1510	use File::Glob ();
		1511
861	cf::player->attach (	1512	cf::player->attach (
862	on_command => sub {	1513	on_unknown_command => sub {
863	my ($pl, $name, $params) = @_;	1514	my ($pl, $name, $params) = @_;
864		1515
865	my $cb = $COMMAND{$name}	1516	my $cb = $COMMAND{$name}
866	or return;	1517	or return;
867		1518
…		…
872	cf::override;	1523	cf::override;
873	},	1524	},
874	on_extcmd => sub {	1525	on_extcmd => sub {
875	my ($pl, $buf) = @_;	1526	my ($pl, $buf) = @_;
876		1527
877	my $msg = eval { from_json $buf };	1528	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
878		1529
879	if (ref $msg) {	1530	if (ref $msg) {
		1531	my ($type, $reply, @payload) = @$msg; # version 1 used %type, $id, %$hash
		1532
880	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1533	if (my $cb = $EXTACMD{$type}) {
881	if (my %reply = $cb->($pl, $msg)) {	1534	$cb->(
882	$pl->ext_reply ($msg->{msgid}, %reply);	1535	$pl,
		1536	sub {
		1537	$pl->ext_msg ("reply-$reply", @_)
		1538	if $reply;
		1539	},
		1540	@payload
		1541	);
		1542	} else {
		1543	my @reply;
		1544
		1545	if (my $cb = $EXTCMD{$type}) {
		1546	@reply = $cb->($pl, @payload);
883	}	1547	}
		1548
		1549	$pl->ext_msg ("reply-$reply", @reply)
		1550	if $reply;
884	}	1551	}
		1552
885	} else {	1553	} else {
886	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1554	error "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
887	}	1555	}
888		1556
889	cf::override;	1557	cf::override;
890	},	1558	},
891	);	1559	);
892		1560
		1561	# "readahead" all extensions
893	sub load_extension {	1562	sub cache_extensions {
894	my ($path) = @_;	1563	my $grp = IO::AIO::aio_group;
895		1564
896	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1565	add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
897	my $base = $1;	1566	for (grep /\.ext$/, @{$_[0]}) {
898	my $pkg = $1;	1567	add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
899	$pkg =~ s/[^[:word:]]/_/g;
900	$pkg = "ext::$pkg";
901
902	warn "... loading '$path' into '$pkg'\n";
903
904	open my $fh, "<:utf8", $path
905	or die "$path: $!";
906
907	my $source =
908	"package $pkg; use strict; use utf8;\n"
909	. "#line 1 \"$path\"\n{\n"
910	. (do { local $/; <$fh> })
911	. "\n};\n1";
912
913	unless (eval $source) {
914	my $msg = $@ ? "$path: $@\n"
915	: "extension disabled.\n";
916	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
917	warn $@;
918	warn "mandatory extension failed to load, exiting.\n";
919	exit 1;
920	}	1568	}
921	die $@;
922	}	1569	};
923		1570
924	push @EXTS, $pkg;	1571	$grp
		1572	}
		1573
		1574	sub _ext_cfg_reg($$$$) {
		1575	my ($rvar, $varname, $cfgname, $default) = @_;
		1576
		1577	$cfgname = lc $varname
		1578	unless length $cfgname;
		1579
		1580	$EXT_CFG{$cfgname} = [$rvar, $default];
		1581
		1582	$$rvar = exists $CFG{$cfgname} ? $CFG{$cfgname} : $default;
925	}	1583	}
926		1584
927	sub load_extensions {	1585	sub load_extensions {
		1586	info "loading extensions...";
		1587
		1588	%EXT_CFG = ();
		1589
		1590	cf::sync_job {
		1591	my %todo;
		1592
928	for my $ext (<$LIBDIR/*.ext>) {	1593	for my $path (<$LIBDIR/*.ext>) {
929	next unless -r $ext;	1594	next unless -r $path;
930	eval {	1595
931	load_extension $ext;	1596	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1597	my $base = $1;
		1598	my $pkg = $1;
		1599	$pkg =~ s/[^[:word:]]/_/g;
		1600	$pkg = "ext::$pkg";
		1601
		1602	open my $fh, "<:utf8", $path
		1603	or die "$path: $!";
		1604
		1605	my $source = do { local $/; <$fh> };
		1606
		1607	my %ext = (
		1608	path => $path,
		1609	base => $base,
		1610	pkg => $pkg,
		1611	);
		1612
		1613	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1614	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1615
		1616	$ext{source} =
		1617	"package $pkg; use common::sense;\n"
		1618	. "#line 1 \"$path\"\n{\n"
		1619	. $source
		1620	. "\n};\n1";
		1621
		1622	$todo{$base} = \%ext;
		1623	}
		1624
		1625	my $pass = 0;
		1626	my %done;
		1627	while (%todo) {
		1628	my $progress;
		1629
		1630	++$pass;
		1631
		1632	ext:
		1633	while (my ($k, $v) = each %todo) {
		1634	for (split /,\s*/, $v->{meta}{depends}) {
		1635	next ext
		1636	unless exists $done{$_};
		1637	}
		1638
		1639	trace "... pass $pass, loading '$k' into '$v->{pkg}'\n";
		1640
		1641	my $source = $v->{source};
		1642
		1643	# support "CONF varname :confname = default" pseudo-statements
		1644	$source =~ s{
		1645	^ CONF \s+ ([^\s:=]+) \s* (?:: \s* ([^\s:=]+) \s* )? = ([^\n#]+)
		1646	}{
		1647	"our \$$1; BEGIN { cf::_ext_cfg_reg \\\$$1, q\x00$1\x00, q\x00$2\x00, $3 }";
		1648	}gmxe;
		1649
		1650	my $active = eval $source;
		1651
		1652	if (length $@) {
		1653	error "$v->{path}: $@\n";
		1654
		1655	cf::cleanup "mandatory extension '$k' failed to load, exiting."
		1656	if exists $v->{meta}{mandatory};
		1657
		1658	warn "$v->{base}: optional extension cannot be loaded, skipping.\n";
		1659	delete $todo{$k};
		1660	} else {
		1661	$done{$k} = delete $todo{$k};
		1662	push @EXTS, $v->{pkg};
		1663	$progress = 1;
		1664
		1665	info "$v->{base}: extension inactive.\n"
		1666	unless $active;
		1667	}
932	1	1668	}
933	} or warn "$ext not loaded: $@";	1669
		1670	unless ($progress) {
		1671	warn "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n";
		1672
		1673	while (my ($k, $v) = each %todo) {
		1674	cf::cleanup "mandatory extension '$k' has unresolved dependencies, exiting."
		1675	if exists $v->{meta}{mandatory};
		1676	}
		1677
		1678	last;
		1679	}
		1680	}
934	}	1681	};
935	}	1682	}
936		1683
937	#############################################################################	1684	#############################################################################
938		1685
		1686	=back
		1687
939	=head2 CORE EXTENSIONS	1688	=head2 CORE EXTENSIONS
940		1689
941	Functions and methods that extend core crossfire objects.	1690	Functions and methods that extend core deliantra objects.
942		1691
943	=cut	1692	=cut
944		1693
945	package cf::player;	1694	package cf::player;
946		1695
…		…
948		1697
949	=head3 cf::player	1698	=head3 cf::player
950		1699
951	=over 4	1700	=over 4
952		1701
		1702	=item cf::player::num_playing
		1703
		1704	Returns the official number of playing players, as per the Crossfire metaserver rules.
		1705
		1706	=cut
		1707
		1708	sub num_playing {
		1709	scalar grep
		1710	$_->ob->map
		1711	&& !$_->hidden
		1712	&& !$_->ob->flag (cf::FLAG_WIZ),
		1713	cf::player::list
		1714	}
		1715
953	=item cf::player::find $login	1716	=item cf::player::find $login
954		1717
955	Returns the given player object, loading it if necessary (might block).	1718	Returns the given player object, loading it if necessary (might block).
956		1719
957	=cut	1720	=cut
958		1721
959	sub playerdir($) {	1722	sub playerdir($) {
960	cf::localdir	1723	"$PLAYERDIR/"
961	. "/"
962	. cf::playerdir
963	. "/"
964	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1724	. (ref $_[0] ? $_[0]->ob->name : $_[0])
965	}	1725	}
966		1726
967	sub path($) {	1727	sub path($) {
968	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1728	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
…		…
978		1738
979	sub exists($) {	1739	sub exists($) {
980	my ($login) = @_;	1740	my ($login) = @_;
981		1741
982	$cf::PLAYER{$login}	1742	$cf::PLAYER{$login}
983	or cf::sync_job { !aio_stat path $login }	1743	or !aio_stat path $login
984	}	1744	}
985		1745
986	sub find($) {	1746	sub find($) {
987	return $cf::PLAYER{$_[0]} || do {	1747	return $cf::PLAYER{$_[0]} || do {
988	my $login = $_[0];	1748	my $login = $_[0];
…		…
995	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";	1755	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
996	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";	1756	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
997	aio_unlink +(playerdir $login) . "/$login.pl.pst";	1757	aio_unlink +(playerdir $login) . "/$login.pl.pst";
998	aio_unlink +(playerdir $login) . "/$login.pl";	1758	aio_unlink +(playerdir $login) . "/$login.pl";
999		1759
1000	my $pl = load_pl path $login	1760	my $f = new_from_file cf::object::thawer path $login
1001	or return;	1761	or return;
		1762
		1763	my $pl = cf::player::load_pl $f
		1764	or return;
		1765
		1766	local $cf::PLAYER_LOADING{$login} = $pl;
		1767	$f->resolve_delayed_derefs;
1002	$cf::PLAYER{$login} = $pl	1768	$cf::PLAYER{$login} = $pl
1003	}	1769	}
1004	}	1770	}
1005	}	1771	}
		1772
		1773	cf::player->attach (
		1774	on_load => sub {
		1775	my ($pl, $path) = @_;
		1776
		1777	# restore slots saved in save, below
		1778	my $slots = delete $pl->{_slots};
		1779
		1780	$pl->ob->current_weapon ($slots->[0]);
		1781	$pl->combat_ob ($slots->[1]);
		1782	$pl->ranged_ob ($slots->[2]);
		1783	},
		1784	);
1006		1785
1007	sub save($) {	1786	sub save($) {
1008	my ($pl) = @_;	1787	my ($pl) = @_;
1009		1788
1010	return if $pl->{deny_save};	1789	return if $pl->{deny_save};
…		…
1015	return if $pl->{deny_save};	1794	return if $pl->{deny_save};
1016		1795
1017	aio_mkdir playerdir $pl, 0770;	1796	aio_mkdir playerdir $pl, 0770;
1018	$pl->{last_save} = $cf::RUNTIME;	1797	$pl->{last_save} = $cf::RUNTIME;
1019		1798
		1799	cf::get_slot 0.01;
		1800
		1801	# save slots, to be restored later
		1802	local $pl->{_slots} = [$pl->ob->current_weapon, $pl->combat_ob, $pl->ranged_ob];
		1803
1020	$pl->save_pl ($path);	1804	$pl->save_pl ($path);
1021	Coro::cede;	1805	cf::cede_to_tick;
1022	}	1806	}
1023		1807
1024	sub new($) {	1808	sub new($) {
1025	my ($login) = @_;	1809	my ($login) = @_;
1026		1810
…		…
1032	$cf::PLAYER{$login} = $self;	1816	$cf::PLAYER{$login} = $self;
1033		1817
1034	$self	1818	$self
1035	}	1819	}
1036		1820
		1821	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1822
		1823	=cut
		1824
		1825	sub send_msg {
		1826	my $ns = shift->ns
		1827	or return;
		1828	$ns->send_msg (@_);
		1829	}
		1830
1037	=item $pl->quit_character	1831	=item $pl->quit_character
1038		1832
1039	Nukes the player without looking back. If logged in, the connection will	1833	Nukes the player without looking back. If logged in, the connection will
1040	be destroyed. May block for a long time.	1834	be destroyed. May block for a long time.
1041		1835
…		…
1045	my ($pl) = @_;	1839	my ($pl) = @_;
1046		1840
1047	my $name = $pl->ob->name;	1841	my $name = $pl->ob->name;
1048		1842
1049	$pl->{deny_save} = 1;	1843	$pl->{deny_save} = 1;
1050	$pl->password ("*"); # this should lock out the player until we nuked the dir	1844	$pl->password ("*"); # this should lock out the player until we have nuked the dir
1051		1845
1052	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1846	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->ns;
1053	$pl->deactivate;	1847	$pl->deactivate;
		1848
		1849	my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
1054	$pl->invoke (cf::EVENT_PLAYER_QUIT);	1850	$pl->invoke (cf::EVENT_PLAYER_QUIT) if $pl->ns;
		1851	ext::highscore::check ($pl->ob);
		1852
1055	$pl->ns->destroy if $pl->ns;	1853	$pl->ns->destroy if $pl->ns;
1056		1854
1057	my $path = playerdir $pl;	1855	my $path = playerdir $pl;
1058	my $temp = "$path~$cf::RUNTIME~deleting~";	1856	my $temp = "$path~$cf::RUNTIME~deleting~";
1059	aio_rename $path, $temp;	1857	aio_rename $path, $temp;
…		…
1088	while and may block, so not sync_job-capable, ever.	1886	while and may block, so not sync_job-capable, ever.
1089		1887
1090	=cut	1888	=cut
1091		1889
1092	sub list_logins {	1890	sub list_logins {
1093	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1891	my $dirs = aio_readdir $PLAYERDIR
1094	or return [];	1892	or return [];
1095		1893
1096	my @logins;	1894	my @logins;
1097		1895
1098	for my $login (@$dirs) {	1896	for my $login (@$dirs) {
		1897	my $path = path $login;
		1898
		1899	# a .pst is a dead give-away for a valid player
		1900	# if no pst file found, open and chekc for blocked users
		1901	if (aio_stat "$path.pst") {
1099	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1902	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1100	aio_read $fh, 0, 512, my $buf, 0 or next;	1903	aio_read $fh, 0, 512, my $buf, 0 or next;
1101	$buf !~ /^password -------------$/m or next; # official not-valid tag	1904	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1905	}
1102		1906
1103	utf8::decode $login;	1907	utf8::decode $login;
1104	push @logins, $login;	1908	push @logins, $login;
1105	}	1909	}
1106		1910
1107	\@logins	1911	\@logins
1108	}	1912	}
1109		1913
1110	=item $player->maps	1914	=item $player->maps
		1915
		1916	=item cf::player::maps $login
1111		1917
1112	Returns an arrayref of map paths that are private for this	1918	Returns an arrayref of map paths that are private for this
1113	player. May block.	1919	player. May block.
1114		1920
1115	=cut	1921	=cut
…		…
1133	}	1939	}
1134		1940
1135	\@paths	1941	\@paths
1136	}	1942	}
1137		1943
1138	=item $player->ext_reply ($msgid, %msg)	1944	=item $protocol_xml = $player->expand_cfpod ($cfpod)
1139		1945
1140	Sends an ext reply to the player.	1946	Expand deliantra pod fragments into protocol xml.
1141		1947
1142	=cut
1143
1144	sub ext_reply($$%) {
1145	my ($self, $id, %msg) = @_;
1146
1147	$msg{msgid} = $id;
1148
1149	$self->send ("ext " . cf::to_json \%msg);
1150	}
1151
1152	=item $player->ext_event ($type, %msg)	1948	=item $player->ext_msg ($type, @msg)
1153		1949
1154	Sends an ext event to the client.	1950	Sends an ext event to the client.
1155		1951
1156	=cut	1952	=cut
1157		1953
1158	sub ext_event($$%) {	1954	sub ext_msg($$@) {
1159	my ($self, $type, %msg) = @_;	1955	my ($self, $type, @msg) = @_;
1160		1956
1161	$self->ns->ext_event ($type, %msg);	1957	$self->ns->ext_msg ($type, @msg);
1162	}	1958	}
1163		1959
1164	=head3 cf::region	1960	=head3 cf::region
1165		1961
1166	=over 4	1962	=over 4
…		…
1169		1965
1170	package cf::region;	1966	package cf::region;
1171		1967
1172	=item cf::region::find_by_path $path	1968	=item cf::region::find_by_path $path
1173		1969
1174	Tries to decuce the probable region for a map knowing only its path.	1970	Tries to decuce the likely region for a map knowing only its path.
1175		1971
1176	=cut	1972	=cut
1177		1973
1178	sub find_by_path($) {	1974	sub find_by_path($) {
1179	my ($path) = @_;	1975	my ($path) = @_;
1180		1976
		1977	$path =~ s/^~[^\/]*//; # skip ~login
		1978
1181	my ($match, $specificity);	1979	my ($match, $specificity);
1182		1980
1183	for my $region (list) {	1981	for my $region (list) {
1184	if ($region->match && $path =~ $region->match) {	1982	if ($region->{match} && $path =~ $region->{match}) {
1185	($match, $specificity) = ($region, $region->specificity)	1983	($match, $specificity) = ($region, $region->specificity)
1186	if $region->specificity > $specificity;	1984	if $region->specificity > $specificity;
1187	}	1985	}
1188	}	1986	}
1189		1987
…		…
1210	our $MAX_RESET = 3600;	2008	our $MAX_RESET = 3600;
1211	our $DEFAULT_RESET = 3000;	2009	our $DEFAULT_RESET = 3000;
1212		2010
1213	sub generate_random_map {	2011	sub generate_random_map {
1214	my ($self, $rmp) = @_;	2012	my ($self, $rmp) = @_;
1215	# mit "rum" bekleckern, nicht	2013
		2014	my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
		2015
1216	$self->_create_random_map (	2016	$self->_create_random_map ($rmp);
1217	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1218	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1219	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1220	$rmp->{exit_on_final_map},
1221	$rmp->{xsize}, $rmp->{ysize},
1222	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1223	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1224	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1225	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1226	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1227	(cf::region::find $rmp->{region}), $rmp->{custom}
1228	)
1229	}	2017	}
1230		2018
1231	=item cf::map->register ($regex, $prio)	2019	=item cf::map->register ($regex, $prio)
1232		2020
1233	Register a handler for the map path matching the given regex at the	2021	Register a handler for the map path matching the given regex at the
…		…
1238		2026
1239	sub register {	2027	sub register {
1240	my (undef, $regex, $prio) = @_;	2028	my (undef, $regex, $prio) = @_;
1241	my $pkg = caller;	2029	my $pkg = caller;
1242		2030
1243	no strict;
1244	push @{"$pkg\::ISA"}, __PACKAGE__;	2031	push @{"$pkg\::ISA"}, __PACKAGE__;
1245		2032
1246	$EXT_MAP{$pkg} = [$prio, qr<$regex>];	2033	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
1247	}	2034	}
1248		2035
1249	# also paths starting with '/'	2036	# also paths starting with '/'
1250	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];	2037	$EXT_MAP{"cf::map::wrap"} = [0, qr{^(?=/)}];
1251		2038
1252	sub thawer_merge {	2039	sub thawer_merge {
1253	my ($self, $merge) = @_;	2040	my ($self, $merge) = @_;
1254		2041
1255	# we have to keep some variables in memory intact	2042	# we have to keep some variables in memory intact
1256	local $self->{path};	2043	local $self->{path};
1257	local $self->{load_path};	2044	local $self->{load_path};
1258	local $self->{deny_save};
1259	local $self->{deny_reset};
1260		2045
1261	$self->SUPER::thawer_merge ($merge);	2046	$self->SUPER::thawer_merge ($merge);
1262	}	2047	}
1263		2048
1264	sub normalise {	2049	sub normalise {
1265	my ($path, $base) = @_;	2050	my ($path, $base) = @_;
1266		2051
1267	$path = "$path"; # make sure its a string	2052	$path = "$path"; # make sure it's a string
1268		2053
1269	$path =~ s/\.map$//;	2054	$path =~ s/\.map$//;
1270		2055
1271	# map plan:	2056	# map plan:
1272	#	2057	#
…		…
1287	$base =~ s{[^/]+/?$}{};	2072	$base =~ s{[^/]+/?$}{};
1288	$path = "$base/$path";	2073	$path = "$base/$path";
1289	}	2074	}
1290		2075
1291	for ($path) {	2076	for ($path) {
1292	redo if s{//}{/};
1293	redo if s{/\.?/}{/};	2077	redo if s{/\.?/}{/};
1294	redo if s{/[^/]+/\.\./}{/};	2078	redo if s{/[^/]+/\.\./}{/};
1295	}	2079	}
1296		2080
1297	$path	2081	$path
…		…
1311	$self->init; # pass $1 etc.	2095	$self->init; # pass $1 etc.
1312	return $self;	2096	return $self;
1313	}	2097	}
1314	}	2098	}
1315		2099
1316	Carp::carp "unable to resolve path '$path' (base '$base').";	2100	Carp::cluck "unable to resolve path '$path' (base '$base')";
1317	()	2101	()
1318	}	2102	}
1319		2103
		2104	# may re-bless or do other evil things
1320	sub init {	2105	sub init {
1321	my ($self) = @_;	2106	my ($self) = @_;
1322		2107
1323	$self	2108	$self
1324	}	2109	}
…		…
1336		2121
1337	# the original (read-only) location	2122	# the original (read-only) location
1338	sub load_path {	2123	sub load_path {
1339	my ($self) = @_;	2124	my ($self) = @_;
1340		2125
1341	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	2126	"$MAPDIR/$self->{path}.map"
1342	}	2127	}
1343		2128
1344	# the temporary/swap location	2129	# the temporary/swap location
1345	sub save_path {	2130	sub save_path {
1346	my ($self) = @_;	2131	my ($self) = @_;
1347		2132
1348	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	2133	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1349	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	2134	"$TMPDIR/$path.map"
1350	}	2135	}
1351		2136
1352	# the unique path, undef == no special unique path	2137	# the unique path, undef == no special unique path
1353	sub uniq_path {	2138	sub uniq_path {
1354	my ($self) = @_;	2139	my ($self) = @_;
1355		2140
1356	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	2141	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1357	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	2142	"$UNIQUEDIR/$path"
1358	}	2143	}
1359		2144
1360	# and all this just because we cannot iterate over	2145	sub decay_objects {
1361	# all maps in C++...
1362	sub change_all_map_light {
1363	my ($change) = @_;	2146	my ($self) = @_;
1364		2147
1365	$_->change_map_light ($change)	2148	return if $self->{deny_reset};
1366	for grep $_->outdoor, values %cf::MAP;	2149
		2150	$self->do_decay_objects;
1367	}	2151	}
1368		2152
1369	sub unlink_save {	2153	sub unlink_save {
1370	my ($self) = @_;	2154	my ($self) = @_;
1371		2155
…		…
1376		2160
1377	sub load_header_from($) {	2161	sub load_header_from($) {
1378	my ($self, $path) = @_;	2162	my ($self, $path) = @_;
1379		2163
1380	utf8::encode $path;	2164	utf8::encode $path;
1381	#aio_open $path, O_RDONLY, 0	2165	my $f = new_from_file cf::object::thawer $path
1382	# or return;
1383
1384	$self->_load_header ($path)
1385	or return;	2166	or return;
1386		2167
		2168	$self->_load_header ($f)
		2169	or return;
		2170
		2171	local $MAP_LOADING{$self->{path}} = $self;
		2172	$f->resolve_delayed_derefs;
		2173
1387	$self->{load_path} = $path;	2174	$self->{load_path} = $path;
1388		2175
1389	1	2176	1
1390	}	2177	}
1391		2178
		2179	# used to laod the header of an original map
1392	sub load_header_orig {	2180	sub load_header_orig {
1393	my ($self) = @_;	2181	my ($self) = @_;
1394		2182
1395	$self->load_header_from ($self->load_path)	2183	$self->load_header_from ($self->load_path)
1396	}	2184	}
1397		2185
		2186	# used to laod the header of an instantiated map
1398	sub load_header_temp {	2187	sub load_header_temp {
1399	my ($self) = @_;	2188	my ($self) = @_;
1400		2189
1401	$self->load_header_from ($self->save_path)	2190	$self->load_header_from ($self->save_path)
1402	}	2191	}
1403		2192
		2193	# called after loading the header from an instantiated map
1404	sub prepare_temp {	2194	sub prepare_temp {
1405	my ($self) = @_;	2195	my ($self) = @_;
1406		2196
1407	$self->last_access ((delete $self->{last_access})	2197	$self->last_access ((delete $self->{last_access})
1408	|| $cf::RUNTIME); #d#	2198	|| $cf::RUNTIME); #d#
1409	# safety	2199	# safety
1410	$self->{instantiate_time} = $cf::RUNTIME	2200	$self->{instantiate_time} = $cf::RUNTIME
1411	if $self->{instantiate_time} > $cf::RUNTIME;	2201	if $self->{instantiate_time} > $cf::RUNTIME;
1412	}	2202	}
1413		2203
		2204	# called after loading the header from an original map
1414	sub prepare_orig {	2205	sub prepare_orig {
1415	my ($self) = @_;	2206	my ($self) = @_;
1416		2207
1417	$self->{load_original} = 1;	2208	$self->{load_original} = 1;
1418	$self->{instantiate_time} = $cf::RUNTIME;	2209	$self->{instantiate_time} = $cf::RUNTIME;
…		…
1429	$self->load_header_orig	2220	$self->load_header_orig
1430	or return;	2221	or return;
1431	$self->prepare_orig;	2222	$self->prepare_orig;
1432	}	2223	}
1433		2224
		2225	$self->{deny_reset} = 1
		2226	if $self->no_reset;
		2227
1434	$self->default_region (cf::region::find_by_path $self->{path})	2228	$self->default_region (cf::region::find_by_path $self->{path})
1435	unless $self->default_region;	2229	unless $self->default_region;
1436		2230
1437	1	2231	1
1438	}	2232	}
1439		2233
1440	sub find;	2234	sub find;
1441	sub find {	2235	sub find {
1442	my ($path, $origin) = @_;	2236	my ($path, $origin) = @_;
1443		2237
		2238	cf::cede_to_tick;
		2239
1444	$path = normalise $path, $origin && $origin->path;	2240	$path = normalise $path, $origin;
1445		2241
		2242	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1446	cf::lock_wait "map_find:$path";	2243	my $guard2 = cf::lock_acquire "map_find:$path";
1447		2244
1448	$cf::MAP{$path} || do {	2245	$cf::MAP{$path} || do {
1449	my $guard = cf::lock_acquire "map_find:$path";
1450	my $map = new_from_path cf::map $path	2246	my $map = new_from_path cf::map $path
1451	or return;	2247	or return;
1452		2248
1453	$map->{last_save} = $cf::RUNTIME;	2249	$map->{last_save} = $cf::RUNTIME;
1454		2250
1455	$map->load_header	2251	$map->load_header
1456	or return;	2252	or return;
1457		2253
1458	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	2254	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1459	# doing this can freeze the server in a sync job, obviously	2255	# doing this can freeze the server in a sync job, obviously
1460	#$cf::WAIT_FOR_TICK->wait;	2256	#$cf::WAIT_FOR_TICK->wait;
		2257	undef $guard2;
		2258	undef $guard1;
1461	$map->reset;	2259	$map->reset;
1462	undef $guard;
1463	return find $path;	2260	return find $path;
1464	}	2261	}
1465		2262
1466	$cf::MAP{$path} = $map	2263	$cf::MAP{$path} = $map
1467	}	2264	}
1468	}	2265	}
1469		2266
1470	sub pre_load { }	2267	sub pre_load { }
1471	sub post_load { }	2268	#sub post_load { } # XS
1472		2269
1473	sub load {	2270	sub load {
1474	my ($self) = @_;	2271	my ($self) = @_;
1475		2272
1476	local $self->{deny_reset} = 1; # loading can take a long time	2273	local $self->{deny_reset} = 1; # loading can take a long time
1477		2274
1478	my $path = $self->{path};	2275	my $path = $self->{path};
		2276
		2277	{
1479	my $guard = cf::lock_acquire "map_load:$path";	2278	my $guard = cf::lock_acquire "map_data:$path";
1480		2279
1481	return if $self->in_memory != cf::MAP_SWAPPED;	2280	return unless $self->valid;
		2281	return unless $self->state == cf::MAP_SWAPPED;
1482		2282
1483	$self->in_memory (cf::MAP_LOADING);
1484
1485	$self->alloc;	2283	$self->alloc;
1486		2284
1487	$self->pre_load;	2285	$self->pre_load;
1488	Coro::cede;	2286	cf::cede_to_tick;
1489		2287
1490	$self->_load_objects ($self->{load_path}, 1)	2288	if (exists $self->{load_path}) {
		2289	my $f = new_from_file cf::object::thawer $self->{load_path};
		2290	$f->skip_block;
		2291	$self->_load_objects ($f)
1491	or return;	2292	or return;
1492		2293
1493	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2294	$self->post_load_original
1494	if delete $self->{load_original};	2295	if delete $self->{load_original};
1495		2296
1496	if (my $uniq = $self->uniq_path) {	2297	if (my $uniq = $self->uniq_path) {
1497	utf8::encode $uniq;	2298	utf8::encode $uniq;
1498	if (aio_open $uniq, O_RDONLY, 0) {	2299	unless (aio_stat $uniq) {
		2300	if (my $f = new_from_file cf::object::thawer $uniq) {
1499	$self->clear_unique_items;	2301	$self->clear_unique_items;
1500	$self->_load_objects ($uniq, 0);	2302	$self->_load_objects ($f);
		2303	$f->resolve_delayed_derefs;
		2304	}
		2305	}
1501	}	2306	}
1502	}
1503		2307
1504	Coro::cede;	2308	$f->resolve_delayed_derefs;
		2309	} else {
		2310	$self->post_load_original
		2311	if delete $self->{load_original};
		2312	}
		2313
		2314	$self->state (cf::MAP_INACTIVE);
		2315
		2316	cf::cede_to_tick;
1505	# now do the right thing for maps	2317	# now do the right thing for maps
1506	$self->link_multipart_objects;	2318	$self->link_multipart_objects;
1507	Coro::cede;
1508
1509	unless ($self->{deny_activate}) {
1510	$self->decay_objects;
1511	$self->fix_auto_apply;
1512	$self->update_buttons;
1513	Coro::cede;
1514	$self->set_darkness_map;
1515	$self->difficulty ($self->estimate_difficulty)	2319	$self->difficulty ($self->estimate_difficulty)
1516	unless $self->difficulty;	2320	unless $self->difficulty;
1517	Coro::cede;	2321	cf::cede_to_tick;
1518	$self->activate;	2322
1519	Coro::cede;	2323	unless ($self->{deny_activate}) {
		2324	$self->decay_objects;
		2325	$self->fix_auto_apply;
		2326	$self->update_buttons;
		2327	cf::cede_to_tick;
		2328	#$self->activate; # no longer activate maps automatically
		2329	}
		2330
		2331	$self->{last_save} = $cf::RUNTIME;
		2332	$self->last_access ($cf::RUNTIME);
1520	}	2333	}
1521		2334
1522	$self->post_load;	2335	$self->post_load;
1523	Coro::cede;
1524		2336
1525	$self->in_memory (cf::MAP_IN_MEMORY);	2337	1
1526	}	2338	}
1527		2339
		2340	# customize the map for a given player, i.e.
		2341	# return the _real_ map. used by e.g. per-player
		2342	# maps to change the path to ~playername/mappath
1528	sub customise_for {	2343	sub customise_for {
1529	my ($self, $ob) = @_;	2344	my ($self, $ob) = @_;
1530		2345
1531	return find "~" . $ob->name . "/" . $self->{path}	2346	return find "~" . $ob->name . "/" . $self->{path}
1532	if $self->per_player;	2347	if $self->per_player;
1533		2348
		2349	# return find "?party/" . $ob->name . "/" . $self->{path}
		2350	# if $self->per_party;
		2351
1534	$self	2352	$self
1535	}
1536
1537	# find and load all maps in the 3x3 area around a map
1538	sub load_diag {
1539	my ($map) = @_;
1540
1541	my @diag; # diagonal neighbours
1542
1543	for (0 .. 3) {
1544	my $neigh = $map->tile_path ($_)
1545	or next;
1546	$neigh = find $neigh, $map
1547	or next;
1548	$neigh->load;
1549
1550	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1551	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1552	}
1553
1554	for (@diag) {
1555	my $neigh = find @$_
1556	or next;
1557	$neigh->load;
1558	}
1559	}	2353	}
1560		2354
1561	sub find_sync {	2355	sub find_sync {
1562	my ($path, $origin) = @_;	2356	my ($path, $origin) = @_;
1563		2357
1564	cf::sync_job { find $path, $origin }	2358	# it's a bug to call this from the main context
		2359	return cf::LOG cf::llevError | cf::logBacktrace, "do_find_sync"
		2360	if $Coro::current == $Coro::main;
		2361
		2362	find $path, $origin
1565	}	2363	}
1566		2364
1567	sub do_load_sync {	2365	sub do_load_sync {
1568	my ($map) = @_;	2366	my ($map) = @_;
1569		2367
1570	cf::sync_job { $map->load };	2368	# it's a bug to call this from the main context
		2369	return cf::LOG cf::llevError | cf::logBacktrace, "do_load_sync"
		2370	if $Coro::current == $Coro::main;
		2371
		2372	$map->load;
1571	}	2373	}
1572		2374
1573	our %MAP_PREFETCH;	2375	our %MAP_PREFETCH;
1574	our $MAP_PREFETCHER = undef;	2376	our $MAP_PREFETCHER = undef;
1575		2377
1576	sub find_async {	2378	sub find_async {
1577	my ($path, $origin) = @_;	2379	my ($path, $origin, $load) = @_;
1578		2380
1579	$path = normalise $path, $origin && $origin->{path};	2381	$path = normalise $path, $origin;
1580		2382
1581	if (my $map = $cf::MAP{$path}) {	2383	if (my $map = $cf::MAP{$path}) {
1582	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2384	return $map if !$load || $map->linkable;
1583	}	2385	}
1584		2386
1585	undef $MAP_PREFETCH{$path};	2387	$MAP_PREFETCH{$path} |= $load;
		2388
1586	$MAP_PREFETCHER ||= cf::async {	2389	$MAP_PREFETCHER ||= cf::async {
		2390	$Coro::current->{desc} = "map prefetcher";
		2391
1587	while (%MAP_PREFETCH) {	2392	while (%MAP_PREFETCH) {
1588	for my $path (keys %MAP_PREFETCH) {	2393	while (my ($k, $v) = each %MAP_PREFETCH) {
1589	my $map = find $path	2394	if (my $map = find $k) {
1590	or next;
1591	$map->load;	2395	$map->load if $v;
		2396	}
1592		2397
1593	delete $MAP_PREFETCH{$path};	2398	delete $MAP_PREFETCH{$k};
1594	}	2399	}
1595	}	2400	}
1596	undef $MAP_PREFETCHER;	2401	undef $MAP_PREFETCHER;
1597	};	2402	};
1598	$MAP_PREFETCHER->prio (6);	2403	$MAP_PREFETCHER->prio (6);
1599		2404
1600	()	2405	()
1601	}	2406	}
1602		2407
		2408	# common code, used by both ->save and ->swapout
1603	sub save {	2409	sub _save {
1604	my ($self) = @_;	2410	my ($self) = @_;
1605
1606	my $lock = cf::lock_acquire "map_data:" . $self->path;
1607		2411
1608	$self->{last_save} = $cf::RUNTIME;	2412	$self->{last_save} = $cf::RUNTIME;
1609		2413
1610	return unless $self->dirty;	2414	return unless $self->dirty;
1611		2415
…		…
1617	return if $self->{deny_save};	2421	return if $self->{deny_save};
1618		2422
1619	local $self->{last_access} = $self->last_access;#d#	2423	local $self->{last_access} = $self->last_access;#d#
1620		2424
1621	cf::async {	2425	cf::async {
		2426	$Coro::current->{desc} = "map player save";
1622	$_->contr->save for $self->players;	2427	$_->contr->save for $self->players;
1623	};	2428	};
		2429
		2430	cf::get_slot 0.02;
1624		2431
1625	if ($uniq) {	2432	if ($uniq) {
1626	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2433	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1627	$self->_save_objects ($uniq, cf::IO_UNIQUES);	2434	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1628	} else {	2435	} else {
1629	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);	2436	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1630	}	2437	}
1631	}	2438	}
1632		2439
		2440	sub save {
		2441	my ($self) = @_;
		2442
		2443	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2444
		2445	$self->_save;
		2446	}
		2447
1633	sub swap_out {	2448	sub swap_out {
1634	my ($self) = @_;	2449	my ($self) = @_;
1635		2450
1636	# save first because save cedes
1637	$self->save;
1638
1639	my $lock = cf::lock_acquire "map_data:" . $self->path;	2451	my $lock = cf::lock_acquire "map_data:$self->{path}";
1640		2452
		2453	return if !$self->linkable;
		2454	return if $self->{deny_save};
1641	return if $self->players;	2455	return if $self->players;
1642	return if $self->in_memory != cf::MAP_IN_MEMORY;
1643	return if $self->{deny_save};
1644		2456
		2457	# first deactivate the map and "unlink" it from the core
		2458	$self->deactivate;
		2459	$_->clear_links_to ($self) for values %cf::MAP;
		2460	$self->state (cf::MAP_SWAPPED);
		2461
		2462	# then atomically save
		2463	$self->_save;
		2464
		2465	# then free the map
1645	$self->clear;	2466	$self->clear;
1646	$self->in_memory (cf::MAP_SWAPPED);
1647	}	2467	}
1648		2468
1649	sub reset_at {	2469	sub reset_at {
1650	my ($self) = @_;	2470	my ($self) = @_;
1651		2471
1652	# TODO: safety, remove and allow resettable per-player maps	2472	# TODO: safety, remove and allow resettable per-player maps
1653	return 1e99 if $self->isa ("ext::map_per_player");#d#
1654	return 1e99 if $self->{deny_reset};	2473	return 1e99 if $self->{deny_reset};
1655		2474
1656	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2475	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1657	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2476	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1658		2477
…		…
1669	my ($self) = @_;	2488	my ($self) = @_;
1670		2489
1671	my $lock = cf::lock_acquire "map_data:$self->{path}";	2490	my $lock = cf::lock_acquire "map_data:$self->{path}";
1672		2491
1673	return if $self->players;	2492	return if $self->players;
1674	return if $self->isa ("ext::map_per_player");#d#
1675		2493
1676	warn "resetting map ", $self->path;#d#	2494	cf::trace "resetting map ", $self->path, "\n";
1677		2495
1678	$self->in_memory (cf::MAP_SWAPPED);	2496	$self->state (cf::MAP_SWAPPED);
1679		2497
1680	# need to save uniques path	2498	# need to save uniques path
1681	unless ($self->{deny_save}) {	2499	unless ($self->{deny_save}) {
1682	my $uniq = $self->uniq_path; utf8::encode $uniq;	2500	my $uniq = $self->uniq_path; utf8::encode $uniq;
1683		2501
…		…
1685	if $uniq;	2503	if $uniq;
1686	}	2504	}
1687		2505
1688	delete $cf::MAP{$self->path};	2506	delete $cf::MAP{$self->path};
1689		2507
		2508	$self->deactivate;
		2509	$_->clear_links_to ($self) for values %cf::MAP;
1690	$self->clear;	2510	$self->clear;
1691
1692	$_->clear_links_to ($self) for values %cf::MAP;
1693		2511
1694	$self->unlink_save;	2512	$self->unlink_save;
1695	$self->destroy;	2513	$self->destroy;
1696	}	2514	}
1697		2515
1698	my $nuke_counter = "aaaa";	2516	my $nuke_counter = "aaaa";
1699		2517
1700	sub nuke {	2518	sub nuke {
1701	my ($self) = @_;	2519	my ($self) = @_;
1702		2520
		2521	{
		2522	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2523
1703	delete $cf::MAP{$self->path};	2524	delete $cf::MAP{$self->path};
1704		2525
1705	$self->unlink_save;	2526	$self->unlink_save;
1706		2527
1707	bless $self, "cf::map";	2528	bless $self, "cf::map::wrap";
1708	delete $self->{deny_reset};	2529	delete $self->{deny_reset};
1709	$self->{deny_save} = 1;	2530	$self->{deny_save} = 1;
1710	$self->reset_timeout (1);	2531	$self->reset_timeout (1);
1711	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2532	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1712		2533
1713	$cf::MAP{$self->path} = $self;	2534	$cf::MAP{$self->path} = $self;
		2535	}
1714		2536
1715	$self->reset; # polite request, might not happen	2537	$self->reset; # polite request, might not happen
		2538	}
		2539
		2540	=item $maps = cf::map::tmp_maps
		2541
		2542	Returns an arrayref with all map paths of currently instantiated and saved
		2543	maps. May block.
		2544
		2545	=cut
		2546
		2547	sub tmp_maps() {
		2548	[
		2549	map {
		2550	utf8::decode $_;
		2551	/\.map$/
		2552	? normalise $_
		2553	: ()
		2554	} @{ aio_readdir $TMPDIR or [] }
		2555	]
		2556	}
		2557
		2558	=item $maps = cf::map::random_maps
		2559
		2560	Returns an arrayref with all map paths of currently instantiated and saved
		2561	random maps. May block.
		2562
		2563	=cut
		2564
		2565	sub random_maps() {
		2566	[
		2567	map {
		2568	utf8::decode $_;
		2569	/\.map$/
		2570	? normalise "?random/$_"
		2571	: ()
		2572	} @{ aio_readdir $RANDOMDIR or [] }
		2573	]
1716	}	2574	}
1717		2575
1718	=item cf::map::unique_maps	2576	=item cf::map::unique_maps
1719		2577
1720	Returns an arrayref of paths of all shared maps that have	2578	Returns an arrayref of paths of all shared maps that have
1721	instantiated unique items. May block.	2579	instantiated unique items. May block.
1722		2580
1723	=cut	2581	=cut
1724		2582
1725	sub unique_maps() {	2583	sub unique_maps() {
1726	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2584	[
1727	or return;	2585	map {
1728
1729	my @paths;
1730
1731	for (@$files) {
1732	utf8::decode $_;	2586	utf8::decode $_;
1733	next if /\.pst$/;	2587	s/\.map$//; # TODO future compatibility hack
1734	next unless /^$PATH_SEP/o;	2588	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
1735		2589	? ()
1736	push @paths, cf::map::normalise $_;	2590	: normalise $_
		2591	} @{ aio_readdir $UNIQUEDIR or [] }
1737	}	2592	]
1738
1739	\@paths
1740	}	2593	}
1741		2594
1742	package cf;	2595	=item cf::map::static_maps
		2596
		2597	Returns an arrayref if paths of all static maps (all preinstalled F<.map>
		2598	file in the shared directory excluding F</styles> and F</editor>). May
		2599	block.
		2600
		2601	=cut
		2602
		2603	sub static_maps() {
		2604	my @dirs = "";
		2605	my @maps;
		2606
		2607	while (@dirs) {
		2608	my $dir = shift @dirs;
		2609
		2610	next if $dir eq "/styles" || $dir eq "/editor";
		2611
		2612	my ($dirs, $files) = Coro::AIO::aio_scandir "$MAPDIR$dir", 2
		2613	or return;
		2614
		2615	for (@$files) {
		2616	s/\.map$// or next;
		2617	utf8::decode $_;
		2618	push @maps, "$dir/$_";
		2619	}
		2620
		2621	push @dirs, map "$dir/$_", @$dirs;
		2622	}
		2623
		2624	\@maps
		2625	}
1743		2626
1744	=back	2627	=back
1745		2628
1746	=head3 cf::object	2629	=head3 cf::object
1747		2630
…		…
1751		2634
1752	=over 4	2635	=over 4
1753		2636
1754	=item $ob->inv_recursive	2637	=item $ob->inv_recursive
1755		2638
1756	Returns the inventory of the object _and_ their inventories, recursively.	2639	Returns the inventory of the object I<and> their inventories, recursively,
		2640	but I<not> the object itself.
1757		2641
1758	=cut	2642	=cut
1759		2643
1760	sub inv_recursive_;	2644	sub inv_recursive_;
1761	sub inv_recursive_ {	2645	sub inv_recursive_ {
…		…
1764		2648
1765	sub inv_recursive {	2649	sub inv_recursive {
1766	inv_recursive_ inv $_[0]	2650	inv_recursive_ inv $_[0]
1767	}	2651	}
1768		2652
		2653	=item $ref = $ob->ref
		2654
		2655	Creates and returns a persistent reference to an object that can be stored as a string.
		2656
		2657	=item $ob = cf::object::deref ($refstring)
		2658
		2659	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2660	even if the object actually exists. May block.
		2661
		2662	=cut
		2663
		2664	sub deref {
		2665	my ($ref) = @_;
		2666
		2667	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2668	my ($uuid, $name) = ($1, $2);
		2669	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2670	or return;
		2671	$pl->ob->uuid eq $uuid
		2672	or return;
		2673
		2674	$pl->ob
		2675	} else {
		2676	warn "$ref: cannot resolve object reference\n";
		2677	undef
		2678	}
		2679	}
		2680
1769	package cf;	2681	package cf;
1770		2682
1771	=back	2683	=back
1772		2684
1773	=head3 cf::object::player	2685	=head3 cf::object::player
…		…
1779	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	2691	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
1780	can be C<undef>. Does the right thing when the player is currently in a	2692	can be C<undef>. Does the right thing when the player is currently in a
1781	dialogue with the given NPC character.	2693	dialogue with the given NPC character.
1782		2694
1783	=cut	2695	=cut
		2696
		2697	our $SAY_CHANNEL = {
		2698	id => "say",
		2699	title => "Map",
		2700	reply => "say ",
		2701	tooltip => "Things said to and replied from NPCs near you and other players on the same map only.",
		2702	};
		2703
		2704	our $CHAT_CHANNEL = {
		2705	id => "chat",
		2706	title => "Chat",
		2707	reply => "chat ",
		2708	tooltip => "Player chat and shouts, global to the server.",
		2709	};
1784		2710
1785	# rough implementation of a future "reply" method that works	2711	# rough implementation of a future "reply" method that works
1786	# with dialog boxes.	2712	# with dialog boxes.
1787	#TODO: the first argument must go, split into a $npc->reply_to ( method	2713	#TODO: the first argument must go, split into a $npc->reply_to ( method
1788	sub cf::object::player::reply($$$;$) {	2714	sub cf::object::player::reply($$$;$) {
…		…
1790		2716
1791	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2717	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1792		2718
1793	if ($self->{record_replies}) {	2719	if ($self->{record_replies}) {
1794	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2720	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2721
1795	} else {	2722	} else {
		2723	my $pl = $self->contr;
		2724
		2725	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2726	my $dialog = $pl->{npc_dialog};
		2727	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2728
		2729	} else {
1796	$msg = $npc->name . " says: $msg" if $npc;	2730	$msg = $npc->name . " says: $msg" if $npc;
1797	$self->message ($msg, $flags);	2731	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2732	}
1798	}	2733	}
		2734	}
		2735
		2736	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2737
		2738	=cut
		2739
		2740	sub cf::object::send_msg {
		2741	my $pl = shift->contr
		2742	or return;
		2743	$pl->send_msg (@_);
1799	}	2744	}
1800		2745
1801	=item $player_object->may ("access")	2746	=item $player_object->may ("access")
1802		2747
1803	Returns wether the given player is authorized to access resource "access"	2748	Returns wether the given player is authorized to access resource "access"
…		…
1816		2761
1817	=item $player_object->enter_link	2762	=item $player_object->enter_link
1818		2763
1819	Freezes the player and moves him/her to a special map (C<{link}>).	2764	Freezes the player and moves him/her to a special map (C<{link}>).
1820		2765
1821	The player should be reasonably safe there for short amounts of time. You	2766	The player should be reasonably safe there for short amounts of time (e.g.
1822	I<MUST> call C<leave_link> as soon as possible, though.	2767	for loading a map). You I<MUST> call C<leave_link> as soon as possible,
		2768	though, as the player cannot control the character while it is on the link
		2769	map.
1823		2770
1824	Will never block.	2771	Will never block.
1825		2772
1826	=item $player_object->leave_link ($map, $x, $y)	2773	=item $player_object->leave_link ($map, $x, $y)
1827		2774
…		…
1847	sub cf::object::player::enter_link {	2794	sub cf::object::player::enter_link {
1848	my ($self) = @_;	2795	my ($self) = @_;
1849		2796
1850	$self->deactivate_recursive;	2797	$self->deactivate_recursive;
1851		2798
		2799	++$self->{_link_recursion};
		2800
1852	return if UNIVERSAL::isa $self->map, "ext::map_link";	2801	return if UNIVERSAL::isa $self->map, "ext::map_link";
1853		2802
1854	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2803	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1855	if $self->map;	2804	if $self->map && $self->map->{path} ne "{link}";
1856		2805
1857	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2806	$self->enter_map ($LINK_MAP || link_map, 3, 3);
1858	}	2807	}
1859		2808
1860	sub cf::object::player::leave_link {	2809	sub cf::object::player::leave_link {
1861	my ($self, $map, $x, $y) = @_;	2810	my ($self, $map, $x, $y) = @_;
		2811
		2812	return unless $self->contr->active;
1862		2813
1863	my $link_pos = delete $self->{_link_pos};	2814	my $link_pos = delete $self->{_link_pos};
1864		2815
1865	unless ($map) {	2816	unless ($map) {
1866	# restore original map position	2817	# restore original map position
…		…
1877	($x, $y) = (-1, -1)	2828	($x, $y) = (-1, -1)
1878	unless (defined $x) && (defined $y);	2829	unless (defined $x) && (defined $y);
1879		2830
1880	# use -1 or undef as default coordinates, not 0, 0	2831	# use -1 or undef as default coordinates, not 0, 0
1881	($x, $y) = ($map->enter_x, $map->enter_y)	2832	($x, $y) = ($map->enter_x, $map->enter_y)
1882	if $x <=0 && $y <= 0;	2833	if $x <= 0 && $y <= 0;
1883		2834
1884	$map->load;	2835	$map->load;
1885	$map->load_diag;
1886		2836
1887	return unless $self->contr->active;	2837	return unless $self->contr->active;
1888	$self->activate_recursive;
1889		2838
1890	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2839	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1891	$self->enter_map ($map, $x, $y);	2840	if ($self->enter_map ($map, $x, $y)) {
1892	}	2841	# entering was successful
1893		2842	delete $self->{_link_recursion};
1894	cf::player->attach (	2843	# only activate afterwards, to support waiting in hooks
1895	on_logout => sub {	2844	$self->activate_recursive;
1896	my ($pl) = @_;
1897
1898	# abort map switching before logout
1899	if ($pl->ob->{_link_pos}) {
1900	cf::sync_job {
1901	$pl->ob->leave_link
1902	};
1903	}
1904	},	2845	}
1905	on_login => sub {
1906	my ($pl) = @_;
1907		2846
1908	# try to abort aborted map switching on player login :)	2847	}
1909	# should happen only on crashes
1910	if ($pl->ob->{_link_pos}) {
1911	$pl->ob->enter_link;
1912	(async {
1913	$pl->ob->reply (undef,
1914	"There was an internal problem at your last logout, "
1915	. "the server will try to bring you to your intended destination in a second.",
1916	cf::NDI_RED);
1917	# we need this sleep as the login has a concurrent enter_exit running
1918	# and this sleep increases chances of the player not ending up in scorn
1919	Coro::Timer::sleep 1;
1920	$pl->ob->leave_link;
1921	})->prio (2);
1922	}
1923	},
1924	);
1925		2848
1926	=item $player_object->goto ($path, $x, $y)	2849	=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
1927		2850
		2851	Moves the player to the given map-path and coordinates by first freezing
		2852	her, loading and preparing them map, calling the provided $check callback
		2853	that has to return the map if sucecssful, and then unfreezes the player on
		2854	the new (success) or old (failed) map position. In either case, $done will
		2855	be called at the end of this process.
		2856
		2857	Note that $check will be called with a potentially non-loaded map, so if
		2858	it needs a loaded map it has to call C<< ->load >>.
		2859
1928	=cut	2860	=cut
		2861
		2862	our $GOTOGEN;
1929		2863
1930	sub cf::object::player::goto {	2864	sub cf::object::player::goto {
1931	my ($self, $path, $x, $y) = @_;	2865	my ($self, $path, $x, $y, $check, $done) = @_;
		2866
		2867	if ($self->{_link_recursion} >= $MAX_LINKS) {
		2868	error "FATAL: link recursion exceeded, ", $self->name, " goto $path $x $y, redirecting.";
		2869	$self->failmsg ("Something went wrong inside the server - please contact an administrator!");
		2870	($path, $x, $y) = @$EMERGENCY_POSITION;
		2871	}
		2872
		2873	# do generation counting so two concurrent goto's will be executed in-order
		2874	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1932		2875
1933	$self->enter_link;	2876	$self->enter_link;
1934		2877
1935	(async {	2878	(async {
		2879	$Coro::current->{desc} = "player::goto $path $x $y";
		2880
		2881	# *tag paths override both path and x|y
		2882	if ($path =~ /^\*(.*)$/) {
		2883	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2884	my $ob = $obs[rand @obs];
		2885
		2886	# see if we actually can go there
		2887	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2888	$ob = $obs[rand @obs];
		2889	} else {
		2890	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2891	}
		2892	# else put us there anyways for now #d#
		2893
		2894	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2895	} else {
		2896	($path, $x, $y) = (undef, undef, undef);
		2897	}
		2898	}
		2899
1936	my $map = eval {	2900	my $map = eval {
1937	my $map = cf::map::find $path;	2901	my $map = defined $path ? cf::map::find $path, $self->map : undef;
		2902
		2903	if ($map) {
1938	$map = $map->customise_for ($self) if $map;	2904	$map = $map->customise_for ($self);
		2905	$map = $check->($map, $x, $y, $self) if $check && $map;
		2906	} else {
		2907	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2908	}
		2909
1939	$map	2910	$map
		2911	};
		2912
		2913	if ($@) {
		2914	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2915	LOG llevError | logBacktrace, Carp::longmess $@;
1940	} or	2916	}
1941	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1942		2917
		2918	if ($gen == $self->{_goto_generation}) {
		2919	delete $self->{_goto_generation};
1943	$self->leave_link ($map, $x, $y);	2920	$self->leave_link ($map, $x, $y);
		2921	}
		2922
		2923	$done->($self) if $done;
1944	})->prio (1);	2924	})->prio (1);
1945	}	2925	}
1946		2926
1947	=item $player_object->enter_exit ($exit_object)	2927	=item $player_object->enter_exit ($exit_object)
1948		2928
…		…
1968	}	2948	}
1969		2949
1970	sub prepare_random_map {	2950	sub prepare_random_map {
1971	my ($exit) = @_;	2951	my ($exit) = @_;
1972		2952
1973	my $guard = cf::lock_acquire "exit_prepare:$exit";
1974
1975	# all this does is basically replace the /! path by	2953	# all this does is basically replace the /! path by
1976	# a new random map path (?random/...) with a seed	2954	# a new random map path (?random/...) with a seed
1977	# that depends on the exit object	2955	# that depends on the exit object
1978		2956
1979	my $rmp = parse_random_map_params $exit->msg;	2957	my $rmp = parse_random_map_params $exit->msg;
…		…
1981	if ($exit->map) {	2959	if ($exit->map) {
1982	$rmp->{region} = $exit->region->name;	2960	$rmp->{region} = $exit->region->name;
1983	$rmp->{origin_map} = $exit->map->path;	2961	$rmp->{origin_map} = $exit->map->path;
1984	$rmp->{origin_x} = $exit->x;	2962	$rmp->{origin_x} = $exit->x;
1985	$rmp->{origin_y} = $exit->y;	2963	$rmp->{origin_y} = $exit->y;
		2964
		2965	$exit->map->touch;
1986	}	2966	}
1987		2967
1988	$rmp->{random_seed} ||= $exit->random_seed;	2968	$rmp->{random_seed} ||= $exit->random_seed;
1989		2969
1990	my $data = cf::to_json $rmp;	2970	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1991	my $md5 = Digest::MD5::md5_hex $data;	2971	my $md5 = Digest::MD5::md5_hex $data;
1992	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2972	my $meta = "$RANDOMDIR/$md5.meta";
1993		2973
1994	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2974	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1995	aio_write $fh, 0, (length $data), $data, 0;	2975	aio_write $fh, 0, (length $data), $data, 0;
1996	undef $fh;	2976	undef $fh;
1997	aio_rename "$meta~", $meta;	2977	aio_rename "$meta~", $meta;
1998		2978
		2979	my $slaying = "?random/$md5";
		2980
		2981	if ($exit->valid) {
1999	$exit->slaying ("?random/$md5");	2982	$exit->slaying ("?random/$md5");
2000	$exit->msg (undef);	2983	$exit->msg (undef);
		2984	}
2001	}	2985	}
2002	}	2986	}
2003		2987
2004	sub cf::object::player::enter_exit {	2988	sub cf::object::player::enter_exit {
2005	my ($self, $exit) = @_;	2989	my ($self, $exit) = @_;
2006		2990
2007	return unless $self->type == cf::PLAYER;	2991	return unless $self->type == cf::PLAYER;
2008		2992
2009	if ($exit->slaying eq "/!") {
2010	#TODO: this should de-fi-ni-te-ly not be a sync-job
2011	# the problem is that $exit might not survive long enough
2012	# so it needs to be done right now, right here
2013	cf::sync_job { prepare_random_map $exit };
2014	}
2015
2016	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2017	my $hp = $exit->stats->hp;
2018	my $sp = $exit->stats->sp;
2019
2020	$self->enter_link;	2993	$self->enter_link;
2021		2994
2022	(async {	2995	(async {
2023	$self->deactivate_recursive; # just to be sure	2996	$Coro::current->{desc} = "enter_exit";
		2997
2024	unless (eval {	2998	unless (eval {
		2999	$self->deactivate_recursive; # just to be sure
		3000
		3001	my $map = cf::map::normalise $exit->slaying, $exit->map;
		3002	my $x = $exit->stats->hp;
		3003	my $y = $exit->stats->sp;
		3004
		3005	# special map handling
		3006	my $slaying = $exit->slaying;
		3007
		3008	# special map handling
		3009	if ($slaying eq "/!") {
		3010	my $guard = cf::lock_acquire "exit_prepare:$exit";
		3011
		3012	prepare_random_map $exit
		3013	if $exit->slaying eq "/!"; # need to re-check after getting the lock
		3014
		3015	$map = $exit->slaying;
		3016
		3017	} elsif ($slaying eq '!up') {
		3018	$map = $exit->map->tile_path (cf::TILE_UP);
		3019	$x = $exit->x;
		3020	$y = $exit->y;
		3021
		3022	} elsif ($slaying eq '!down') {
		3023	$map = $exit->map->tile_path (cf::TILE_DOWN);
		3024	$x = $exit->x;
		3025	$y = $exit->y;
		3026	}
		3027
2025	$self->goto ($slaying, $hp, $sp);	3028	$self->goto ($map, $x, $y);
2026		3029
		3030	# if exit is damned, update players death & WoR home-position
		3031	$self->contr->savebed ($map, $x, $y)
		3032	if $exit->flag (cf::FLAG_DAMNED);
		3033
2027	1;	3034	1
2028	}) {	3035	}) {
2029	$self->message ("Something went wrong deep within the crossfire server. "	3036	$self->message ("Something went wrong deep within the deliantra server. "
2030	. "I'll try to bring you back to the map you were before. "	3037	. "I'll try to bring you back to the map you were before. "
2031	. "Please report this to the dungeon master!",	3038	. "Please report this to the dungeon master!",
2032	cf::NDI_UNIQUE | cf::NDI_RED);	3039	cf::NDI_UNIQUE | cf::NDI_RED);
2033		3040
2034	warn "ERROR in enter_exit: $@";	3041	error "ERROR in enter_exit: $@";
2035	$self->leave_link;	3042	$self->leave_link;
2036	}	3043	}
2037	})->prio (1);	3044	})->prio (1);
2038	}	3045	}
2039		3046
…		…
2053		3060
2054	utf8::encode $text;	3061	utf8::encode $text;
2055	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	3062	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2056	}	3063	}
2057		3064
		3065	=item $client->send_big_packet ($pkt)
		3066
		3067	Like C<send_packet>, but tries to compress large packets, and fragments
		3068	them as required.
		3069
		3070	=cut
		3071
		3072	our $MAXFRAGSIZE = cf::MAXSOCKBUF - 64;
		3073
		3074	sub cf::client::send_big_packet {
		3075	my ($self, $pkt) = @_;
		3076
		3077	# try lzf for large packets
		3078	$pkt = "lzf " . Compress::LZF::compress $pkt
		3079	if 1024 <= length $pkt and $self->{can_lzf};
		3080
		3081	# split very large packets
		3082	if ($MAXFRAGSIZE < length $pkt and $self->{can_lzf}) {
		3083	$self->send_packet ("frag $_") for unpack "(a$MAXFRAGSIZE)*", $pkt;
		3084	$pkt = "frag";
		3085	}
		3086
		3087	$self->send_packet ($pkt);
		3088	}
		3089
		3090	=item $client->send_msg ($channel, $msg, $color, [extra...])
		3091
		3092	Send a drawinfo or msg packet to the client, formatting the msg for the
		3093	client if neccessary. C<$type> should be a string identifying the type of
		3094	the message, with C<log> being the default. If C<$color> is negative, suppress
		3095	the message unless the client supports the msg packet.
		3096
		3097	=cut
		3098
		3099	# non-persistent channels (usually the info channel)
		3100	our %CHANNEL = (
		3101	"c/motd" => {
		3102	id => "infobox",
		3103	title => "MOTD",
		3104	reply => undef,
		3105	tooltip => "The message of the day",
		3106	},
		3107	"c/identify" => {
		3108	id => "infobox",
		3109	title => "Identify",
		3110	reply => undef,
		3111	tooltip => "Items recently identified",
		3112	},
		3113	"c/examine" => {
		3114	id => "infobox",
		3115	title => "Examine",
		3116	reply => undef,
		3117	tooltip => "Signs and other items you examined",
		3118	},
		3119	"c/shopinfo" => {
		3120	id => "infobox",
		3121	title => "Shop Info",
		3122	reply => undef,
		3123	tooltip => "What your bargaining skill tells you about the shop",
		3124	},
		3125	"c/book" => {
		3126	id => "infobox",
		3127	title => "Book",
		3128	reply => undef,
		3129	tooltip => "The contents of a note or book",
		3130	},
		3131	"c/lookat" => {
		3132	id => "infobox",
		3133	title => "Look",
		3134	reply => undef,
		3135	tooltip => "What you saw there",
		3136	},
		3137	"c/who" => {
		3138	id => "infobox",
		3139	title => "Players",
		3140	reply => undef,
		3141	tooltip => "Shows players who are currently online",
		3142	},
		3143	"c/body" => {
		3144	id => "infobox",
		3145	title => "Body Parts",
		3146	reply => undef,
		3147	tooltip => "Shows which body parts you posess and are available",
		3148	},
		3149	"c/statistics" => {
		3150	id => "infobox",
		3151	title => "Statistics",
		3152	reply => undef,
		3153	tooltip => "Shows your primary statistics",
		3154	},
		3155	"c/skills" => {
		3156	id => "infobox",
		3157	title => "Skills",
		3158	reply => undef,
		3159	tooltip => "Shows your experience per skill and item power",
		3160	},
		3161	"c/shopitems" => {
		3162	id => "infobox",
		3163	title => "Shop Items",
		3164	reply => undef,
		3165	tooltip => "Shows the items currently for sale in this shop",
		3166	},
		3167	"c/resistances" => {
		3168	id => "infobox",
		3169	title => "Resistances",
		3170	reply => undef,
		3171	tooltip => "Shows your resistances",
		3172	},
		3173	"c/pets" => {
		3174	id => "infobox",
		3175	title => "Pets",
		3176	reply => undef,
		3177	tooltip => "Shows information abotu your pets/a specific pet",
		3178	},
		3179	"c/perceiveself" => {
		3180	id => "infobox",
		3181	title => "Perceive Self",
		3182	reply => undef,
		3183	tooltip => "You gained detailed knowledge about yourself",
		3184	},
		3185	"c/uptime" => {
		3186	id => "infobox",
		3187	title => "Uptime",
		3188	reply => undef,
		3189	tooltip => "How long the server has been running since last restart",
		3190	},
		3191	"c/mapinfo" => {
		3192	id => "infobox",
		3193	title => "Map Info",
		3194	reply => undef,
		3195	tooltip => "Information related to the maps",
		3196	},
		3197	"c/party" => {
		3198	id => "party",
		3199	title => "Party",
		3200	reply => "gsay ",
		3201	tooltip => "Messages and chat related to your party",
		3202	},
		3203	"c/death" => {
		3204	id => "death",
		3205	title => "Death",
		3206	reply => undef,
		3207	tooltip => "Reason for and more info about your most recent death",
		3208	},
		3209	"c/say" => $SAY_CHANNEL,
		3210	"c/chat" => $CHAT_CHANNEL,
		3211	);
		3212
		3213	sub cf::client::send_msg {
		3214	my ($self, $channel, $msg, $color, @extra) = @_;
		3215
		3216	$msg = $self->pl->expand_cfpod ($msg)
		3217	unless $color & cf::NDI_VERBATIM;
		3218
		3219	$color &= cf::NDI_CLIENT_MASK; # just in case...
		3220
		3221	# check predefined channels, for the benefit of C
		3222	if ($CHANNEL{$channel}) {
		3223	$channel = $CHANNEL{$channel};
		3224
		3225	$self->ext_msg (channel_info => $channel);
		3226	$channel = $channel->{id};
		3227
		3228	} elsif (ref $channel) {
		3229	# send meta info to client, if not yet sent
		3230	unless (exists $self->{channel}{$channel->{id}}) {
		3231	$self->{channel}{$channel->{id}} = $channel;
		3232	$self->ext_msg (channel_info => $channel);
		3233	}
		3234
		3235	$channel = $channel->{id};
		3236	}
		3237
		3238	return unless @extra || length $msg;
		3239
		3240	# default colour, mask it out
		3241	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		3242	if $color & cf::NDI_DEF;
		3243
		3244	my $pkt = "msg "
		3245	. $self->{json_coder}->encode (
		3246	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
		3247	);
		3248
		3249	$self->send_big_packet ($pkt);
		3250	}
		3251
2058	=item $client->ext_event ($type, %msg)	3252	=item $client->ext_msg ($type, @msg)
2059		3253
2060	Sends an exti event to the client.	3254	Sends an ext event to the client.
2061		3255
2062	=cut	3256	=cut
2063		3257
2064	sub cf::client::ext_event($$%) {	3258	sub cf::client::ext_msg($$@) {
2065	my ($self, $type, %msg) = @_;	3259	my ($self, $type, @msg) = @_;
2066		3260
2067	$msg{msgtype} = "event_$type";	3261	$self->send_big_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2068	$self->send_packet ("ext " . cf::to_json \%msg);
2069	}	3262	}
2070		3263
2071	=item $success = $client->query ($flags, "text", \&cb)	3264	=item $success = $client->query ($flags, "text", \&cb)
2072		3265
2073	Queues a query to the client, calling the given callback with	3266	Queues a query to the client, calling the given callback with
2074	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	3267	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2075	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	3268	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2076		3269
2077	Queries can fail, so check the return code. Or don't, as queries will become	3270	Queries can fail, so check the return code. Or don't, as queries will
2078	reliable at some point in the future.	3271	become reliable at some point in the future.
2079		3272
2080	=cut	3273	=cut
2081		3274
2082	sub cf::client::query {	3275	sub cf::client::query {
2083	my ($self, $flags, $text, $cb) = @_;	3276	my ($self, $flags, $text, $cb) = @_;
…		…
2091	utf8::encode $text;	3284	utf8::encode $text;
2092	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	3285	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2093		3286
2094	$self->send_packet ($self->{query_queue}[0][0])	3287	$self->send_packet ($self->{query_queue}[0][0])
2095	if @{ $self->{query_queue} } == 1;	3288	if @{ $self->{query_queue} } == 1;
		3289
		3290	1
2096	}	3291	}
2097		3292
2098	cf::client->attach (	3293	cf::client->attach (
		3294	on_connect => sub {
		3295	my ($ns) = @_;
		3296
		3297	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		3298	},
2099	on_reply => sub {	3299	on_reply => sub {
2100	my ($ns, $msg) = @_;	3300	my ($ns, $msg) = @_;
2101		3301
2102	# this weird shuffling is so that direct followup queries	3302	# this weird shuffling is so that direct followup queries
2103	# get handled first	3303	# get handled first
…		…
2115	} else {	3315	} else {
2116	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3316	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2117	}	3317	}
2118	}	3318	}
2119	},	3319	},
		3320	on_exticmd => sub {
		3321	my ($ns, $buf) = @_;
		3322
		3323	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		3324
		3325	if (ref $msg) {
		3326	my ($type, $reply, @payload) = @$msg; # version 1 used %type, $id, %$hash
		3327
		3328	if (my $cb = $EXTIACMD{$type}) {
		3329	$cb->(
		3330	$ns,
		3331	sub {
		3332	$ns->ext_msg ("reply-$reply", @_)
		3333	if $reply;
		3334	},
		3335	@payload
		3336	);
		3337	} else {
		3338	my @reply;
		3339
		3340	if (my $cb = $EXTICMD{$type}) {
		3341	@reply = $cb->($ns, @payload);
		3342	}
		3343
		3344	$ns->ext_msg ("reply-$reply", @reply)
		3345	if $reply;
		3346	}
		3347	} else {
		3348	error "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		3349	}
		3350
		3351	cf::override;
		3352	},
2120	);	3353	);
2121		3354
2122	=item $client->async (\&cb)	3355	=item $client->async (\&cb)
2123		3356
2124	Create a new coroutine, running the specified callback. The coroutine will	3357	Create a new coroutine, running the specified callback. The coroutine will
…		…
2140		3373
2141	$coro	3374	$coro
2142	}	3375	}
2143		3376
2144	cf::client->attach (	3377	cf::client->attach (
2145	on_destroy => sub {	3378	on_client_destroy => sub {
2146	my ($ns) = @_;	3379	my ($ns) = @_;
2147		3380
2148	$_->cancel for values %{ (delete $ns->{_coro}) || {} };	3381	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
2149	},	3382	},
2150	);	3383	);
…		…
2165	our $safe = new Safe "safe";	3398	our $safe = new Safe "safe";
2166	our $safe_hole = new Safe::Hole;	3399	our $safe_hole = new Safe::Hole;
2167		3400
2168	$SIG{FPE} = 'IGNORE';	3401	$SIG{FPE} = 'IGNORE';
2169		3402
2170	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3403	$safe->permit_only (Opcode::opset qw(
		3404	:base_core :base_mem :base_orig :base_math :base_loop
		3405	grepstart grepwhile mapstart mapwhile
		3406	sort time
		3407	));
2171		3408
2172	# here we export the classes and methods available to script code	3409	# here we export the classes and methods available to script code
2173		3410
2174	=pod	3411	=pod
2175		3412
2176	The following functions and methods are available within a safe environment:	3413	The following functions and methods are available within a safe environment:
2177		3414
2178	cf::object contr pay_amount pay_player map	3415	cf::object
		3416	contr pay_amount pay_player map x y force_find force_add destroy
		3417	insert remove name archname title slaying race decrease split
		3418	value
		3419
2179	cf::object::player player	3420	cf::object::player
2180	cf::player peaceful	3421	player
2181	cf::map trigger	3422
		3423	cf::player
		3424	peaceful
		3425
		3426	cf::map
		3427	trigger
2182		3428
2183	=cut	3429	=cut
2184		3430
2185	for (	3431	for (
2186	["cf::object" => qw(contr pay_amount pay_player map)],	3432	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3433	insert remove inv nrof name archname title slaying race
		3434	decrease split destroy change_exp value msg lore send_msg)],
2187	["cf::object::player" => qw(player)],	3435	["cf::object::player" => qw(player)],
2188	["cf::player" => qw(peaceful)],	3436	["cf::player" => qw(peaceful send_msg)],
2189	["cf::map" => qw(trigger)],	3437	["cf::map" => qw(trigger)],
2190	) {	3438	) {
2191	no strict 'refs';
2192	my ($pkg, @funs) = @$_;	3439	my ($pkg, @funs) = @$_;
2193	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3440	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
2194	for @funs;	3441	for @funs;
2195	}	3442	}
2196		3443
…		…
2211		3458
2212	my $qcode = $code;	3459	my $qcode = $code;
2213	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3460	$qcode =~ s/"/‟/g; # not allowed in #line filenames
2214	$qcode =~ s/\n/\\n/g;	3461	$qcode =~ s/\n/\\n/g;
2215		3462
		3463	%vars = (_dummy => 0) unless %vars;
		3464
		3465	my @res;
2216	local $_;	3466	local $_;
2217	local @safe::cf::_safe_eval_args = values %vars;
2218		3467
2219	my $eval =	3468	my $eval =
2220	"do {\n"	3469	"do {\n"
2221	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	3470	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
2222	. "#line 0 \"{$qcode}\"\n"	3471	. "#line 0 \"{$qcode}\"\n"
2223	. $code	3472	. $code
2224	. "\n}"	3473	. "\n}"
2225	;	3474	;
2226		3475
		3476	if ($CFG{safe_eval}) {
2227	sub_generation_inc;	3477	sub_generation_inc;
		3478	local @safe::cf::_safe_eval_args = values %vars;
2228	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);	3479	@res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
2229	sub_generation_inc;	3480	sub_generation_inc;
		3481	} else {
		3482	local @cf::_safe_eval_args = values %vars;
		3483	@res = wantarray ? eval eval : scalar eval $eval;
		3484	}
2230		3485
2231	if ($@) {	3486	if ($@) {
2232	warn "$@";	3487	warn "$@",
2233	warn "while executing safe code '$code'\n";	3488	"while executing safe code '$code'\n",
2234	warn "with arguments " . (join " ", %vars) . "\n";	3489	"with arguments " . (join " ", %vars) . "\n";
2235	}	3490	}
2236		3491
2237	wantarray ? @res : $res[0]	3492	wantarray ? @res : $res[0]
2238	}	3493	}
2239		3494
…		…
2253	=cut	3508	=cut
2254		3509
2255	sub register_script_function {	3510	sub register_script_function {
2256	my ($fun, $cb) = @_;	3511	my ($fun, $cb) = @_;
2257		3512
2258	no strict 'refs';	3513	$fun = "safe::$fun" if $CFG{safe_eval};
2259	*{"safe::$fun"} = $safe_hole->wrap ($cb);	3514	*$fun = $safe_hole->wrap ($cb);
2260	}	3515	}
2261		3516
2262	=back	3517	=back
2263		3518
2264	=cut	3519	=cut
2265
2266	#############################################################################
2267
2268	=head2 EXTENSION DATABASE SUPPORT
2269
2270	Crossfire maintains a very simple database for extension use. It can
2271	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2272	convert to/from binary).
2273
2274	The parameter C<$family> should best start with the name of the extension
2275	using it, it should be unique.
2276
2277	=over 4
2278
2279	=item $value = cf::db_get $family => $key
2280
2281	Returns a single value from the database.
2282
2283	=item cf::db_put $family => $key => $value
2284
2285	Stores the given C<$value> in the family.
2286
2287	=cut
2288
2289	our $DB;
2290
2291	sub db_init {
2292	unless ($DB) {
2293	$DB = BDB::db_create $DB_ENV;
2294
2295	cf::sync_job {
2296	eval {
2297	$DB->set_flags (BDB::CHKSUM);
2298
2299	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2300	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2301	cf::cleanup "db_open(db): $!" if $!;
2302	};
2303	cf::cleanup "db_open(db): $@" if $@;
2304	};
2305	}
2306	}
2307
2308	sub db_get($$) {
2309	my $key = "$_[0]/$_[1]";
2310
2311	cf::sync_job {
2312	BDB::db_get $DB, undef, $key, my $data;
2313
2314	$! ? ()
2315	: $data
2316	}
2317	}
2318
2319	sub db_put($$$) {
2320	BDB::dbreq_pri 4;
2321	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2322	}
2323
2324	=item cf::cache $id => [$paths...], $processversion => $process
2325
2326	Generic caching function that returns the value of the resource $id,
2327	caching and regenerating as required.
2328
2329	This function can block.
2330
2331	=cut
2332
2333	sub cache {
2334	my ($id, $src, $processversion, $process) = @_;
2335
2336	my $meta =
2337	join "\x00",
2338	$processversion,
2339	map {
2340	aio_stat $_
2341	and Carp::croak "$_: $!";
2342
2343	($_, (stat _)[7,9])
2344	} @$src;
2345
2346	my $dbmeta = db_get cache => "$id/meta";
2347	if ($dbmeta ne $meta) {
2348	# changed, we may need to process
2349
2350	my @data;
2351	my $md5;
2352
2353	for (0 .. $#$src) {
2354	0 <= aio_load $src->[$_], $data[$_]
2355	or Carp::croak "$src->[$_]: $!";
2356	}
2357
2358	# if processing is expensive, check
2359	# checksum first
2360	if (1) {
2361	$md5 =
2362	join "\x00",
2363	$processversion,
2364	map {
2365	Coro::cede;
2366	($src->[$_], Digest::MD5::md5_hex $data[$_])
2367	} 0.. $#$src;
2368
2369
2370	my $dbmd5 = db_get cache => "$id/md5";
2371	if ($dbmd5 eq $md5) {
2372	db_put cache => "$id/meta", $meta;
2373
2374	return db_get cache => "$id/data";
2375	}
2376	}
2377
2378	my $data = $process->(\@data);
2379
2380	db_put cache => "$id/data", $data;
2381	db_put cache => "$id/md5" , $md5;
2382	db_put cache => "$id/meta", $meta;
2383
2384	return $data;
2385	}
2386
2387	db_get cache => "$id/data"
2388	}
2389
2390	=item fork_call { }, $args
2391
2392	Executes the given code block with the given arguments in a seperate
2393	process, returning the results. Everything must be serialisable with
2394	Coro::Storable. May, of course, block. Note that the executed sub may
2395	never block itself or use any form of Event handling.
2396
2397	=cut
2398
2399	sub fork_call(&@) {
2400	my ($cb, @args) = @_;
2401
2402	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2403	# or die "socketpair: $!";
2404	pipe my $fh1, my $fh2
2405	or die "pipe: $!";
2406
2407	if (my $pid = fork) {
2408	close $fh2;
2409
2410	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2411	$res = Coro::Storable::thaw $res;
2412
2413	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2414
2415	die $$res unless "ARRAY" eq ref $res;
2416
2417	return wantarray ? @$res : $res->[-1];
2418	} else {
2419	eval {
2420	local $SIG{__DIE__};
2421	local $SIG{__WARN__};
2422	close $fh1;
2423
2424	my @res = eval { $cb->(@args) };
2425	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2426	};
2427
2428	_exit 0;
2429	}
2430	}
2431
2432
2433		3520
2434	#############################################################################	3521	#############################################################################
2435	# the server's init and main functions	3522	# the server's init and main functions
2436		3523
		3524	our %FACEHASH; # hash => idx, #d# HACK for http server
		3525	our @FACEDATA; # dynamically-created facedata
		3526
		3527	# internal api, not fianlised
		3528	sub set_face {
		3529	my ($name, $type, $data) = @_;
		3530
		3531	my $idx = cf::face::find $name;
		3532
		3533	if ($idx) {
		3534	delete $FACEHASH{cf::face::get_chksum $idx};
		3535	} else {
		3536	$idx = cf::face::alloc $name;
		3537	}
		3538
		3539	my $hash = cf::face::mangle_chksum Digest::MD5::md5 $data;
		3540
		3541	cf::face::set_type $idx, $type;
		3542	cf::face::set_data $idx, 0, (length $data), 0, $hash;
		3543	cf::face::set_meta $idx, $type & 1 ? undef : undef;
		3544
		3545	# we need to destroy the SV itself, not just overwrite,
		3546	# as a running ix might hold a reference to it.
		3547	# delete achieves that.
		3548	delete $FACEDATA[$idx];
		3549	$FACEDATA[$idx] = $data;
		3550	$FACEHASH{$hash} = $idx;#d#
		3551
		3552	$idx
		3553	}
		3554
		3555	our $FACEDATA; # facedata filehandle
		3556
		3557	sub _face_get_data($$$$) {
		3558	my ($idx, $size, $fofs, $cb) = @_;
		3559
		3560	if (defined $FACEDATA[$idx]) {
		3561	$cb->($FACEDATA[$idx]);
		3562	} elsif ($fofs) {
		3563	my $buf;
		3564	IO::AIO::aio_read $FACEDATA, $fofs, $size, $buf, 0, sub {
		3565	if ($_[0] == $size) {
		3566	#cf::debug "read face $idx, $size from $fofs as ", length $buf;#d#
		3567	$cb->($buf);
		3568	} else {
		3569	cf::error "INTERNAL ERROR: unable to read facedata for face $idx ($size, $fofs), ignoring request.";
		3570	}
		3571	};
		3572	} else {
		3573	cf::error "requested facedata for unknown face $idx ($size, $fofs), ignoring.";
		3574	}
		3575	}
		3576
		3577	# rather ineffient
		3578	sub cf::face::get_data($;$) {
		3579	my ($idx, $faceset) = @_;
		3580
		3581	my $size = cf::face::get_size $idx, $faceset;
		3582	my $fofs = cf::face::get_fofs $idx, $faceset;
		3583
		3584	_face_get_data $idx, $size, $fofs, Coro::rouse_cb;
		3585	Coro::rouse_wait
		3586	}
		3587
		3588	sub cf::face::ix {
		3589	my ($ns, $idx, $pri, $size, $fofs) = @_;
		3590
		3591	_face_get_data $idx, $size, $fofs, sub {
		3592	$ns->ix_send ($idx, $pri, $_[0]);
		3593	};
		3594	}
		3595
2437	sub load_facedata($) {	3596	sub load_facedata($) {
2438	my ($path) = @_;	3597	my ($path) = @_;
2439		3598
		3599	my $enc = JSON::XS->new->utf8->canonical->relaxed;
		3600
2440	warn "loading facedata from $path\n";	3601	trace "loading facedata from $path\n";
2441		3602
2442	my $facedata;	3603	my $facedata = decode_storable load_file "$path/faceinfo";
2443	0 < aio_load $path, $facedata
2444	or die "$path: $!";
2445
2446	$facedata = Coro::Storable::thaw $facedata;
2447		3604
2448	$facedata->{version} == 2	3605	$facedata->{version} == 2
2449	or cf::cleanup "$path: version mismatch, cannot proceed.";	3606	or cf::cleanup "$path/faceinfo: version mismatch, cannot proceed.";
		3607
		3608	my $fh = aio_open "$DATADIR/facedata", IO::AIO::O_RDONLY, 0
		3609	or cf::cleanup "$path/facedata: $!, cnanot proceed.";
		3610
		3611	get_slot 1, -100, "load_facedata"; # make sure we get a very big slot
		3612
		3613	# BEGIN ATOMIC
		3614	# from here on, everything must be atomic - no thread switch allowed
		3615	my $t1 = EV::time;
2450		3616
2451	{	3617	{
2452	my $faces = $facedata->{faceinfo};	3618	my $faces = $facedata->{faceinfo};
2453		3619
2454	while (my ($face, $info) = each %$faces) {	3620	for my $face (sort keys %$faces) {
		3621	my $info = $faces->{$face};
2455	my $idx = (cf::face::find $face) || cf::face::alloc $face;	3622	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		3623
2456	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	3624	cf::face::set_visibility $idx, $info->{visibility};
		3625	cf::face::set_magicmap $idx, $info->{magicmap};
2457	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	3626	cf::face::set_data $idx, 0, $info->{size32}, $info->{fofs32}, $info->{hash32};
2458	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	3627	cf::face::set_data $idx, 1, $info->{size64}, $info->{fofs64}, $info->{hash64};
2459	Coro::cede;	3628	#cf::face::set_data $idx, 2, $info->{glyph} , $info->{glyph}; # glyphs no longer downloadable via ix
		3629	$FACEHASH{$info->{hash64}} = $idx;#d#
2460	}	3630	}
2461		3631
2462	while (my ($face, $info) = each %$faces) {	3632	while (my ($face, $info) = each %$faces) {
2463	next unless $info->{smooth};	3633	next unless $info->{smooth};
		3634
2464	my $idx = cf::face::find $face	3635	my $idx = cf::face::find $face
2465	or next;	3636	or next;
		3637
2466	if (my $smooth = cf::face::find $info->{smooth}) {	3638	if (my $smooth = cf::face::find $info->{smooth}) {
		3639	cf::face::set_smooth $idx, $smooth;
2467	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	3640	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2468	} else {	3641	} else {
2469	warn "smooth face '$info->{smooth}' not found for face '$face'";	3642	error "smooth face '$info->{smooth}' not found for face '$face'";
2470	}	3643	}
2471	Coro::cede;
2472	}	3644	}
2473	}	3645	}
2474		3646
2475	{	3647	{
2476	my $anims = $facedata->{animinfo};	3648	my $anims = $facedata->{animinfo};
2477		3649
2478	while (my ($anim, $info) = each %$anims) {	3650	while (my ($anim, $info) = each %$anims) {
2479	cf::anim::set $anim, $info->{frames}, $info->{facings};	3651	cf::anim::set $anim, $info->{frames}, $info->{facings};
2480	Coro::cede;
2481	}	3652	}
2482		3653
2483	cf::anim::invalidate_all; # d'oh	3654	cf::anim::invalidate_all; # d'oh
2484	}	3655	}
2485		3656
		3657	{
		3658	my $res = $facedata->{resource};
		3659
		3660	while (my ($name, $info) = each %$res) {
		3661	if (defined (my $type = $info->{type})) {
		3662	# TODO: different hash - must free and use new index, or cache ixface data queue
		3663	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3664
		3665	cf::face::set_type $idx, $type;
		3666	cf::face::set_data $idx, 0, $info->{size}, $info->{fofs}, $info->{hash};
		3667	cf::face::set_meta $idx, $type & 1 ? undef : $info->{meta}; # preserve meta unless prepended already
		3668	$FACEHASH{$info->{hash}} = $idx;#d#
		3669	} else {
		3670	# $RESOURCE{$name} = $info; # unused
		3671	}
		3672	}
		3673	}
		3674
		3675	($fh, $FACEDATA) = ($FACEDATA, $fh);
		3676
		3677	# HACK to clear player env face cache, we need some signal framework
		3678	# for this (global event?)
		3679	%ext::player_env::MUSIC_FACE_CACHE = ();
		3680
		3681	# END ATOMIC
		3682
		3683	cf::debug "facedata atomic update time ", EV::time - $t1;
		3684
		3685	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3686
		3687	aio_close $fh if $fh; # close old facedata
		3688
2486	1	3689	1
2487	}	3690	}
2488		3691
		3692	register_exticmd fx_want => sub {
		3693	my ($ns, $want) = @_;
		3694
		3695	while (my ($k, $v) = each %$want) {
		3696	$ns->fx_want ($k, $v);
		3697	}
		3698	};
		3699
		3700	sub load_resource_file($) {
		3701	my $guard = lock_acquire "load_resource_file";
		3702
		3703	my $status = load_resource_file_ $_[0];
		3704	get_slot 0.1, 100;
		3705	cf::arch::commit_load;
		3706
		3707	$status
		3708	}
		3709
		3710	sub reload_exp_table {
		3711	_reload_exp_table;
		3712
		3713	set_face "res/exp_table" => FT_RSRC,
		3714	JSON::XS->new->utf8->canonical->encode (
		3715	[map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]
		3716	);
		3717	}
		3718
		3719	sub reload_materials {
		3720	_reload_materials;
		3721	}
		3722
		3723	sub reload_regions {
		3724	# HACK to clear player env face cache, we need some signal framework
		3725	# for this (global event?)
		3726	%ext::player_env::MUSIC_FACE_CACHE = ();
		3727
		3728	load_resource_file "$MAPDIR/regions"
		3729	or die "unable to load regions file\n";
		3730
		3731	for (cf::region::list) {
		3732	$_->{match} = qr/$_->{match}/
		3733	if exists $_->{match};
		3734	}
		3735	}
		3736
2489	sub reload_facedata {	3737	sub reload_facedata {
2490	load_facedata sprintf "%s/facedata", cf::datadir	3738	load_facedata $DATADIR
2491	or die "unable to load facedata\n";	3739	or die "unable to load facedata\n";
2492	}	3740	}
2493		3741
2494	sub reload_regions {
2495	load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir
2496	or die "unable to load regions file\n";
2497	}
2498
2499	sub reload_archetypes {	3742	sub reload_archetypes {
2500	load_resource_file sprintf "%s/archetypes", cf::datadir	3743	load_resource_file "$DATADIR/archetypes"
2501	or die "unable to load archetypes\n";	3744	or die "unable to load archetypes\n";
		3745
		3746	set_face "res/skill_info" => FT_RSRC,
		3747	JSON::XS->new->utf8->canonical->encode (
		3748	[map [cf::arch::skillvec ($_)->name], 0 .. cf::arch::skillvec_size - 1]
		3749	);
		3750	set_face "res/spell_paths" => FT_RSRC,
		3751	JSON::XS->new->utf8->canonical->encode (
		3752	[map [cf::spellpathnames ($_)], 0 .. NRSPELLPATHS - 1]
		3753	);
2502	}	3754	}
2503		3755
2504	sub reload_treasures {	3756	sub reload_treasures {
2505	load_resource_file sprintf "%s/treasures", cf::datadir	3757	load_resource_file "$DATADIR/treasures"
2506	or die "unable to load treasurelists\n";	3758	or die "unable to load treasurelists\n";
2507	}	3759	}
2508		3760
		3761	sub reload_sound {
		3762	trace "loading sound config from $DATADIR/sound\n";
		3763
		3764	my $soundconf = JSON::XS->new->utf8->relaxed->decode (load_file "$DATADIR/sound");
		3765
		3766	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3767	my $sound = $soundconf->{compat}[$_]
		3768	or next;
		3769
		3770	my $face = cf::face::find "sound/$sound->[1]";
		3771	cf::sound::set $sound->[0] => $face;
		3772	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3773	}
		3774
		3775	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3776	my $face = cf::face::find "sound/$v";
		3777	cf::sound::set $k => $face;
		3778	}
		3779	}
		3780
2509	sub reload_resources {	3781	sub reload_resources {
2510	warn "reloading resource files...\n";	3782	trace "reloading resource files...\n";
2511		3783
		3784	reload_materials;
		3785	reload_facedata;
		3786	reload_exp_table;
		3787	reload_sound;
		3788	reload_archetypes;
2512	reload_regions;	3789	reload_regions;
2513	reload_facedata;
2514	reload_archetypes;
2515	reload_treasures;	3790	reload_treasures;
2516		3791
2517	warn "finished reloading resource files\n";	3792	trace "finished reloading resource files\n";
2518	}	3793	}
2519		3794
2520	sub init {	3795	sub reload_config {
2521	reload_resources;	3796	trace "reloading config file...\n";
2522	}
2523		3797
2524	sub cfg_load {	3798	my $config = load_file "$CONFDIR/config";
2525	open my $fh, "<:utf8", cf::confdir . "/config"	3799	utf8::decode $config;
2526	or return;	3800	*CFG = decode_yaml $config;
2527		3801
2528	local $/;
2529	*CFG = YAML::Syck::Load <$fh>;
2530
2531	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3802	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
2532		3803
2533	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	3804	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2534	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};	3805	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2535		3806
2536	if (exists $CFG{mlockall}) {	3807	if (exists $CFG{mlockall}) {
…		…
2540	};	3811	};
2541	warn $@ if $@;	3812	warn $@ if $@;
2542	}	3813	}
2543	}	3814	}
2544		3815
		3816	sub pidfile() {
		3817	sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
		3818	or die "$PIDFILE: $!";
		3819	flock $fh, &Fcntl::LOCK_EX
		3820	or die "$PIDFILE: flock: $!";
		3821	$fh
		3822	}
		3823
		3824	# make sure only one server instance is running at any one time
		3825	sub atomic {
		3826	my $fh = pidfile;
		3827
		3828	my $pid = <$fh>;
		3829	kill 9, $pid if $pid > 0;
		3830
		3831	seek $fh, 0, 0;
		3832	print $fh $$;
		3833	}
		3834
		3835	sub main_loop {
		3836	trace "EV::loop starting\n";
		3837	if (1) {
		3838	EV::loop;
		3839	}
		3840	trace "EV::loop returned\n";
		3841	goto &main_loop unless $REALLY_UNLOOP;
		3842	}
		3843
2545	sub main {	3844	sub main {
		3845	cf::init_globals; # initialise logging
		3846
		3847	LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
		3848	LOG llevInfo, "Copyright (C) 2005-2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
		3849	LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
		3850	LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
		3851
		3852	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3853
2546	# we must not ever block the main coroutine	3854	# we must not ever block the main coroutine
2547	local $Coro::idle = sub {	3855	$Coro::idle = sub {
2548	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3856	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2549	(async {	3857	(async {
2550	Event::one_event;	3858	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3859	EV::loop EV::LOOP_ONESHOT;
2551	})->prio (Coro::PRIO_MAX);	3860	})->prio (Coro::PRIO_MAX);
2552	};	3861	};
2553		3862
2554	cfg_load;	3863	evthread_start IO::AIO::poll_fileno;
		3864
		3865	cf::sync_job {
		3866	cf::incloader::init ();
		3867
2555	db_init;	3868	db_init;
		3869
		3870	cf::init_anim;
		3871	cf::init_attackmess;
		3872	cf::init_dynamic;
		3873
		3874	cf::load_settings;
		3875
		3876	reload_resources;
		3877	reload_config;
		3878
		3879	cf::init_uuid;
		3880	cf::init_signals;
		3881	cf::init_skills;
		3882
		3883	cf::init_beforeplay;
		3884
		3885	atomic;
		3886
2556	load_extensions;	3887	load_extensions;
2557		3888
2558	$TICK_WATCHER->start;	3889	utime time, time, $RUNTIMEFILE;
2559	Event::loop;	3890
		3891	# no (long-running) fork's whatsoever before this point(!)
		3892	use POSIX ();
		3893	POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
		3894
		3895	cf::_post_init 0;
		3896	};
		3897
		3898	cf::object::thawer::errors_are_fatal 0;
		3899	info "parse errors in files are no longer fatal from this point on.\n";
		3900
		3901	AE::postpone {
		3902	undef &main; # free gobs of memory :)
		3903	};
		3904
		3905	goto &main_loop;
2560	}	3906	}
2561		3907
2562	#############################################################################	3908	#############################################################################
2563	# initialisation and cleanup	3909	# initialisation and cleanup
2564		3910
2565	# install some emergency cleanup handlers	3911	# install some emergency cleanup handlers
2566	BEGIN {	3912	BEGIN {
		3913	our %SIGWATCHER = ();
2567	for my $signal (qw(INT HUP TERM)) {	3914	for my $signal (qw(INT HUP TERM)) {
2568	Event->signal (	3915	$SIGWATCHER{$signal} = AE::signal $signal, sub {
2569	reentrant => 0,
2570	data => WF_AUTOCANCEL,
2571	signal => $signal,
2572	prio => 0,
2573	cb => sub {
2574	cf::cleanup "SIG$signal";	3916	cf::cleanup "SIG$signal";
2575	},
2576	);	3917	};
		3918	}
		3919	}
		3920
		3921	sub write_runtime_sync {
		3922	my $t0 = AE::time;
		3923
		3924	# first touch the runtime file to show we are still running:
		3925	# the fsync below can take a very very long time.
		3926
		3927	IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
		3928
		3929	my $guard = cf::lock_acquire "write_runtime";
		3930
		3931	my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644
		3932	or return;
		3933
		3934	my $value = $cf::RUNTIME + 90 + 10;
		3935	# 10 is the runtime save interval, for a monotonic clock
		3936	# 60 allows for the watchdog to kill the server.
		3937
		3938	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3939	and return;
		3940
		3941	# always fsync - this file is important
		3942	aio_fsync $fh
		3943	and return;
		3944
		3945	# touch it again to show we are up-to-date
		3946	aio_utime $fh, undef, undef;
		3947
		3948	close $fh
		3949	or return;
		3950
		3951	aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
		3952	and return;
		3953
		3954	trace sprintf "runtime file written (%gs).\n", AE::time - $t0;
		3955
2577	}	3956	1
		3957	}
		3958
		3959	our $uuid_lock;
		3960	our $uuid_skip;
		3961
		3962	sub write_uuid_sync($) {
		3963	$uuid_skip ||= $_[0];
		3964
		3965	return if $uuid_lock;
		3966	local $uuid_lock = 1;
		3967
		3968	my $uuid = "$LOCALDIR/uuid";
		3969
		3970	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3971	or return;
		3972
		3973	my $value = uuid_seq uuid_cur;
		3974
		3975	unless ($value) {
		3976	info "cowardly refusing to write zero uuid value!\n";
		3977	return;
		3978	}
		3979
		3980	my $value = uuid_str $value + $uuid_skip;
		3981	$uuid_skip = 0;
		3982
		3983	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3984	and return;
		3985
		3986	# always fsync - this file is important
		3987	aio_fsync $fh
		3988	and return;
		3989
		3990	close $fh
		3991	or return;
		3992
		3993	aio_rename "$uuid~", $uuid
		3994	and return;
		3995
		3996	trace "uuid file written ($value).\n";
		3997
		3998	1
		3999
		4000	}
		4001
		4002	sub write_uuid($$) {
		4003	my ($skip, $sync) = @_;
		4004
		4005	$sync ? write_uuid_sync $skip
		4006	: async { write_uuid_sync $skip };
2578	}	4007	}
2579		4008
2580	sub emergency_save() {	4009	sub emergency_save() {
2581	my $freeze_guard = cf::freeze_mainloop;	4010	my $freeze_guard = cf::freeze_mainloop;
2582		4011
2583	warn "enter emergency perl save\n";	4012	info "emergency_perl_save: enter\n";
		4013
		4014	# this is a trade-off: we want to be very quick here, so
		4015	# save all maps without fsync, and later call a global sync
		4016	# (which in turn might be very very slow)
		4017	local $USE_FSYNC = 0;
2584		4018
2585	cf::sync_job {	4019	cf::sync_job {
		4020	cf::write_runtime_sync; # external watchdog should not bark
		4021
2586	# use a peculiar iteration method to avoid tripping on perl	4022	# use a peculiar iteration method to avoid tripping on perl
2587	# refcount bugs in for. also avoids problems with players	4023	# refcount bugs in for. also avoids problems with players
2588	# and maps saved/destroyed asynchronously.	4024	# and maps saved/destroyed asynchronously.
2589	warn "begin emergency player save\n";	4025	info "emergency_perl_save: begin player save\n";
2590	for my $login (keys %cf::PLAYER) {	4026	for my $login (keys %cf::PLAYER) {
2591	my $pl = $cf::PLAYER{$login} or next;	4027	my $pl = $cf::PLAYER{$login} or next;
2592	$pl->valid or next;	4028	$pl->valid or next;
		4029	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2593	$pl->save;	4030	$pl->save;
2594	}	4031	}
2595	warn "end emergency player save\n";	4032	info "emergency_perl_save: end player save\n";
2596		4033
2597	warn "begin emergency map save\n";	4034	cf::write_runtime_sync; # external watchdog should not bark
		4035
		4036	info "emergency_perl_save: begin map save\n";
2598	for my $path (keys %cf::MAP) {	4037	for my $path (keys %cf::MAP) {
2599	my $map = $cf::MAP{$path} or next;	4038	my $map = $cf::MAP{$path} or next;
2600	$map->valid or next;	4039	$map->valid or next;
2601	$map->save;	4040	$map->save;
2602	}	4041	}
2603	warn "end emergency map save\n";	4042	info "emergency_perl_save: end map save\n";
2604		4043
2605	warn "begin emergency database checkpoint\n";	4044	cf::write_runtime_sync; # external watchdog should not bark
		4045
		4046	info "emergency_perl_save: begin database checkpoint\n";
2606	BDB::db_env_txn_checkpoint $DB_ENV;	4047	BDB::db_env_txn_checkpoint $DB_ENV;
2607	warn "end emergency database checkpoint\n";	4048	info "emergency_perl_save: end database checkpoint\n";
		4049
		4050	info "emergency_perl_save: begin write uuid\n";
		4051	write_uuid_sync 1;
		4052	info "emergency_perl_save: end write uuid\n";
		4053
		4054	cf::write_runtime_sync; # external watchdog should not bark
		4055
		4056	trace "emergency_perl_save: syncing database to disk";
		4057	BDB::db_env_txn_checkpoint $DB_ENV;
		4058
		4059	info "emergency_perl_save: starting sync\n";
		4060	IO::AIO::aio_sync sub {
		4061	info "emergency_perl_save: finished sync\n";
		4062	};
		4063
		4064	cf::write_runtime_sync; # external watchdog should not bark
		4065
		4066	trace "emergency_perl_save: flushing outstanding aio requests";
		4067	while (IO::AIO::nreqs || BDB::nreqs) {
		4068	Coro::AnyEvent::sleep 0.01; # let the sync_job do it's thing
		4069	}
		4070
		4071	cf::write_runtime_sync; # external watchdog should not bark
2608	};	4072	};
2609		4073
2610	warn "leave emergency perl save\n";	4074	info "emergency_perl_save: leave\n";
2611	}	4075	}
2612		4076
2613	sub post_cleanup {	4077	sub post_cleanup {
2614	my ($make_core) = @_;	4078	my ($make_core) = @_;
2615		4079
		4080	IO::AIO::flush;
		4081
2616	warn Carp::longmess "post_cleanup backtrace"	4082	error Carp::longmess "post_cleanup backtrace"
2617	if $make_core;	4083	if $make_core;
		4084
		4085	my $fh = pidfile;
		4086	unlink $PIDFILE if <$fh> == $$;
		4087	}
		4088
		4089	# a safer delete_package, copied from Symbol
		4090	sub clear_package($) {
		4091	my $pkg = shift;
		4092
		4093	# expand to full symbol table name if needed
		4094	unless ($pkg =~ /^main::.*::$/) {
		4095	$pkg = "main$pkg" if $pkg =~ /^::/;
		4096	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		4097	$pkg .= '::' unless $pkg =~ /::$/;
		4098	}
		4099
		4100	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		4101	my $stem_symtab = *{$stem}{HASH};
		4102
		4103	defined $stem_symtab and exists $stem_symtab->{$leaf}
		4104	or return;
		4105
		4106	# clear all symbols
		4107	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		4108	for my $name (keys %$leaf_symtab) {
		4109	_gv_clear *{"$pkg$name"};
		4110	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		4111	}
2618	}	4112	}
2619		4113
2620	sub do_reload_perl() {	4114	sub do_reload_perl() {
2621	# can/must only be called in main	4115	# can/must only be called in main
2622	if ($Coro::current != $Coro::main) {	4116	unless (in_main) {
2623	warn "can only reload from main coroutine";	4117	error "can only reload from main coroutine";
2624	return;	4118	return;
2625	}	4119	}
2626		4120
2627	warn "reloading...";	4121	return if $RELOAD++;
2628		4122
2629	warn "entering sync_job";	4123	my $t1 = AE::time;
2630		4124
		4125	while ($RELOAD) {
		4126	cf::get_slot 0.1, -1, "reload_perl";
		4127	info "perl_reload: reloading...";
		4128
		4129	trace "perl_reload: entering sync_job";
		4130
2631	cf::sync_job {	4131	cf::sync_job {
2632	cf::write_runtime; # external watchdog should not bark
2633	cf::emergency_save;	4132	#cf::emergency_save;
2634	cf::write_runtime; # external watchdog should not bark
2635		4133
2636	warn "syncing database to disk";
2637	BDB::db_env_txn_checkpoint $DB_ENV;
2638
2639	# if anything goes wrong in here, we should simply crash as we already saved
2640
2641	warn "cancelling all WF_AUTOCANCEL watchers";
2642	for (Event::all_watchers) {
2643	$_->cancel if $_->data & WF_AUTOCANCEL;
2644	}
2645
2646	warn "flushing outstanding aio requests";
2647	for (;;) {
2648	BDB::flush;
2649	IO::AIO::flush;
2650	Coro::cede;
2651	last unless IO::AIO::nreqs || BDB::nreqs;
2652	warn "iterate...";
2653	}
2654
2655	++$RELOAD;
2656
2657	warn "cancelling all extension coros";	4134	trace "perl_reload: cancelling all extension coros";
2658	$_->cancel for values %EXT_CORO;	4135	$_->cancel for values %EXT_CORO;
2659	%EXT_CORO = ();	4136	%EXT_CORO = ();
2660		4137
2661	warn "removing commands";	4138	trace "perl_reload: removing commands";
2662	%COMMAND = ();	4139	%COMMAND = ();
2663		4140
2664	warn "removing ext commands";	4141	trace "perl_reload: removing ext/exti commands";
2665	%EXTCMD = ();	4142	%EXTCMD = ();
		4143	%EXTICMD = ();
2666		4144
2667	warn "unloading/nuking all extensions";	4145	trace "perl_reload: unloading/nuking all extensions";
2668	for my $pkg (@EXTS) {	4146	for my $pkg (@EXTS) {
2669	warn "... unloading $pkg";	4147	trace "... unloading $pkg";
2670		4148
2671	if (my $cb = $pkg->can ("unload")) {	4149	if (my $cb = $pkg->can ("unload")) {
2672	eval {	4150	eval {
2673	$cb->($pkg);	4151	$cb->($pkg);
2674	1	4152	1
2675	} or warn "$pkg unloaded, but with errors: $@";	4153	} or error "$pkg unloaded, but with errors: $@";
		4154	}
		4155
		4156	trace "... clearing $pkg";
		4157	clear_package $pkg;
2676	}	4158	}
2677		4159
2678	warn "... nuking $pkg";
2679	Symbol::delete_package $pkg;
2680	}
2681
2682	warn "unloading all perl modules loaded from $LIBDIR";	4160	trace "perl_reload: unloading all perl modules loaded from $LIBDIR";
2683	while (my ($k, $v) = each %INC) {	4161	while (my ($k, $v) = each %INC) {
2684	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	4162	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2685		4163
2686	warn "... unloading $k";	4164	trace "... unloading $k";
2687	delete $INC{$k};	4165	delete $INC{$k};
2688		4166
2689	$k =~ s/\.pm$//;	4167	$k =~ s/\.pm$//;
2690	$k =~ s/\//::/g;	4168	$k =~ s/\//::/g;
2691		4169
2692	if (my $cb = $k->can ("unload_module")) {	4170	if (my $cb = $k->can ("unload_module")) {
2693	$cb->();	4171	$cb->();
		4172	}
		4173
		4174	clear_package $k;
2694	}	4175	}
2695		4176
2696	Symbol::delete_package $k;
2697	}
2698
2699	warn "getting rid of safe::, as good as possible";	4177	trace "perl_reload: getting rid of safe::, as good as possible";
2700	Symbol::delete_package "safe::$_"	4178	clear_package "safe::$_"
2701	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	4179	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2702		4180
2703	warn "unloading cf.pm \"a bit\"";	4181	trace "perl_reload: unloading cf.pm \"a bit\"";
2704	delete $INC{"cf.pm"};	4182	delete $INC{"cf.pm"};
		4183	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2705		4184
2706	# don't, removes xs symbols, too,	4185	# don't, removes xs symbols, too,
2707	# and global variables created in xs	4186	# and global variables created in xs
2708	#Symbol::delete_package __PACKAGE__;	4187	#clear_package __PACKAGE__;
2709		4188
2710	warn "unload completed, starting to reload now";	4189	info "perl_reload: unload completed, starting to reload now";
2711		4190
2712	warn "reloading cf.pm";	4191	trace "perl_reload: reloading cf.pm";
2713	require cf;	4192	require cf;
2714	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	4193	cf::_connect_to_perl_1;
2715		4194
2716	warn "loading config and database again";	4195	trace "perl_reload: loading config and database again";
2717	cf::cfg_load;	4196	cf::reload_config;
2718		4197
2719	warn "loading extensions";	4198	trace "perl_reload: loading extensions";
2720	cf::load_extensions;	4199	cf::load_extensions;
2721		4200
		4201	if ($REATTACH_ON_RELOAD) {
2722	warn "reattaching attachments to objects/players";	4202	trace "perl_reload: reattaching attachments to objects/players";
2723	_global_reattach; # objects, sockets	4203	_global_reattach; # objects, sockets
2724	warn "reattaching attachments to maps";	4204	trace "perl_reload: reattaching attachments to maps";
2725	reattach $_ for values %MAP;	4205	reattach $_ for values %MAP;
2726	warn "reattaching attachments to players";	4206	trace "perl_reload: reattaching attachments to players";
2727	reattach $_ for values %PLAYER;	4207	reattach $_ for values %PLAYER;
		4208	}
2728		4209
2729	warn "leaving sync_job";	4210	cf::_post_init 1;
2730		4211
		4212	trace "perl_reload: leaving sync_job";
		4213
2731	1	4214	1
2732	} or do {	4215	} or do {
2733	warn $@;	4216	error $@;
2734	warn "error while reloading, exiting.";	4217	cf::cleanup "perl_reload: error, exiting.";
2735	exit 1;	4218	};
		4219
		4220	--$RELOAD;
2736	};	4221	}
2737		4222
2738	warn "reloaded";	4223	$t1 = AE::time - $t1;
		4224	info "perl_reload: completed in ${t1}s\n";
2739	};	4225	};
2740		4226
2741	our $RELOAD_WATCHER; # used only during reload	4227	our $RELOAD_WATCHER; # used only during reload
2742		4228
2743	sub reload_perl() {	4229	sub reload_perl() {
2744	# doing reload synchronously and two reloads happen back-to-back,	4230	# doing reload synchronously and two reloads happen back-to-back,
2745	# coro crashes during coro_state_free->destroy here.	4231	# coro crashes during coro_state_free->destroy here.
2746		4232
2747	$RELOAD_WATCHER ||= Event->timer (	4233	$RELOAD_WATCHER ||= cf::async {
2748	reentrant => 0,	4234	Coro::AIO::aio_wait cache_extensions;
2749	after => 0,	4235
2750	data => WF_AUTOCANCEL,	4236	$RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub {
2751	cb => sub {
2752	do_reload_perl;	4237	do_reload_perl;
2753	undef $RELOAD_WATCHER;	4238	undef $RELOAD_WATCHER;
2754	},	4239	};
2755	);	4240	};
2756	}	4241	}
2757		4242
2758	register_command "reload" => sub {	4243	register_command "reload" => sub {
2759	my ($who, $arg) = @_;	4244	my ($who, $arg) = @_;
2760		4245
2761	if ($who->flag (FLAG_WIZ)) {	4246	if ($who->flag (FLAG_WIZ)) {
2762	$who->message ("reloading server.");	4247	$who->message ("reloading server.");
		4248	async {
		4249	$Coro::current->{desc} = "perl_reload";
2763	async { reload_perl };	4250	reload_perl;
		4251	};
2764	}	4252	}
2765	};	4253	};
2766		4254
2767	unshift @INC, $LIBDIR;	4255	#############################################################################
2768		4256
2769	my $bug_warning = 0;	4257	my $bug_warning = 0;
2770		4258
2771	our @WAIT_FOR_TICK;
2772	our @WAIT_FOR_TICK_BEGIN;
2773
2774	sub wait_for_tick {	4259	sub wait_for_tick() {
2775	return unless $TICK_WATCHER->is_active;	4260	return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
2776	return if $Coro::current == $Coro::main;
2777		4261
2778	my $signal = new Coro::Signal;	4262	$WAIT_FOR_TICK->wait;
2779	push @WAIT_FOR_TICK, $signal;
2780	$signal->wait;
2781	}	4263	}
2782		4264
2783	sub wait_for_tick_begin {	4265	sub wait_for_tick_begin() {
2784	return unless $TICK_WATCHER->is_active;	4266	return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
2785	return if $Coro::current == $Coro::main;
2786		4267
2787	my $signal = new Coro::Signal;	4268	my $signal = new Coro::Signal;
2788	push @WAIT_FOR_TICK_BEGIN, $signal;	4269	push @WAIT_FOR_TICK_BEGIN, $signal;
2789	$signal->wait;	4270	$signal->wait;
2790	}	4271	}
2791		4272
2792	$TICK_WATCHER = Event->timer (	4273	sub tick {
2793	reentrant => 0,
2794	parked => 1,
2795	prio => 0,
2796	at => $NEXT_TICK || $TICK,
2797	data => WF_AUTOCANCEL,
2798	cb => sub {
2799	if ($Coro::current != $Coro::main) {	4274	if ($Coro::current != $Coro::main) {
2800	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	4275	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2801	unless ++$bug_warning > 10;	4276	unless ++$bug_warning > 10;
2802	return;	4277	return;
2803	}	4278	}
2804		4279
2805	$NOW = Event::time;	4280	cf::one_tick; # one server iteration
2806		4281
2807	cf::server_tick; # one server iteration	4282	#for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
2808		4283
2809	$RUNTIME += $TICK;
2810	$NEXT_TICK += $TICK;
2811
2812	if ($NOW >= $NEXT_RUNTIME_WRITE) {	4284	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2813	$NEXT_RUNTIME_WRITE = $NOW + 10;	4285	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2814	Coro::async_pool {	4286	Coro::async_pool {
		4287	$Coro::current->{desc} = "runtime saver";
2815	write_runtime	4288	write_runtime_sync
2816	or warn "ERROR: unable to write runtime file: $!";	4289	or error "ERROR: unable to write runtime file: $!";
2817	};
2818	}	4290	};
		4291	}
2819		4292
2820	# my $AFTER = Event::time;
2821	# warn $AFTER - $NOW;#d#
2822
2823	# if we are delayed by four ticks or more, skip them all
2824	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2825
2826	$TICK_WATCHER->at ($NEXT_TICK);
2827	$TICK_WATCHER->start;
2828
2829	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {	4293	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2830	$sig->send;	4294	$sig->send;
2831	}
2832	while (my $sig = shift @WAIT_FOR_TICK) {
2833	$sig->send;
2834	}
2835
2836	_post_tick;
2837	},	4295	}
2838	);	4296	$WAIT_FOR_TICK->broadcast;
		4297
		4298	$LOAD = ($NOW - $TICK_START) / $TICK;
		4299	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		4300
		4301	if (0) {
		4302	if ($NEXT_TICK) {
		4303	my $jitter = $TICK_START - $NEXT_TICK;
		4304	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		4305	debug "jitter $JITTER\n";#d#
		4306	}
		4307	}
		4308	}
2839		4309
2840	{	4310	{
2841	BDB::max_poll_time $TICK * 0.1;	4311	# configure BDB
2842	$BDB_POLL_WATCHER = Event->io (	4312	info "initialising database";
2843	reentrant => 0,	4313
2844	fd => BDB::poll_fileno,
2845	poll => 'r',
2846	prio => 0,
2847	data => WF_AUTOCANCEL,
2848	cb => \&BDB::poll_cb,
2849	);
2850	BDB::min_parallel 8;	4314	BDB::min_parallel 16;
2851		4315	BDB::max_poll_reqs $TICK * 0.1;
2852	BDB::set_sync_prepare {	4316	#$AnyEvent::BDB::WATCHER->priority (1);
2853	my $status;
2854	my $current = $Coro::current;
2855	(
2856	sub {
2857	$status = $!;
2858	$current->ready; undef $current;
2859	},
2860	sub {
2861	Coro::schedule while defined $current;
2862	$! = $status;
2863	},
2864	)
2865	};
2866		4317
2867	unless ($DB_ENV) {	4318	unless ($DB_ENV) {
2868	$DB_ENV = BDB::db_env_create;	4319	$DB_ENV = BDB::db_env_create;
		4320	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		4321	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		4322	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		4323	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		4324	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
2869		4325
2870	cf::sync_job {	4326	cf::sync_job {
2871	eval {	4327	eval {
2872	BDB::db_env_open	4328	BDB::db_env_open
2873	$DB_ENV,	4329	$DB_ENV,
2874	$BDB_ENV_DIR,	4330	$BDBDIR,
2875	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	4331	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2876	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	4332	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2877	0666;	4333	0666;
2878		4334
2879	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;	4335	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2880
2881	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2882	$DB_ENV->set_lk_detect;
2883	};	4336	};
2884		4337
2885	cf::cleanup "db_env_open(db): $@" if $@;	4338	cf::cleanup "db_env_open(db): $@" if $@;
2886	};	4339	};
2887	}	4340	}
		4341
		4342	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		4343	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		4344	};
		4345	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		4346	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		4347	};
		4348	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		4349	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		4350	};
		4351
		4352	info "database initialised";
2888	}	4353	}
2889		4354
2890	{	4355	{
		4356	# configure IO::AIO
		4357
		4358	info "initialising aio";
2891	IO::AIO::min_parallel 8;	4359	IO::AIO::min_parallel 8;
2892
2893	undef $Coro::AIO::WATCHER;
2894	IO::AIO::max_poll_time $TICK * 0.1;	4360	IO::AIO::max_poll_time $TICK * 0.1;
2895	$AIO_POLL_WATCHER = Event->io (	4361	undef $AnyEvent::AIO::WATCHER;
2896	reentrant => 0,	4362	info "aio initialised";
2897	data => WF_AUTOCANCEL,	4363	}
2898	fd => IO::AIO::poll_fileno,	4364
2899	poll => 'r',	4365	our $_log_backtrace;
2900	prio => 6,	4366	our $_log_backtrace_last;
2901	cb => \&IO::AIO::poll_cb,	4367
2902	);	4368	sub _log_backtrace {
		4369	my ($msg, @addr) = @_;
		4370
		4371	$msg =~ s/\n$//;
		4372
		4373	if ($_log_backtrace_last eq $msg) {
		4374	LOG llevInfo, "[ABT] $msg\n";
		4375	LOG llevInfo, "[ABT] [duplicate, suppressed]\n";
		4376	# limit the # of concurrent backtraces
		4377	} elsif ($_log_backtrace < 2) {
		4378	$_log_backtrace_last = $msg;
		4379	++$_log_backtrace;
		4380	my $perl_bt = Carp::longmess $msg;
		4381	async {
		4382	$Coro::current->{desc} = "abt $msg";
		4383
		4384	my @bt = fork_call {
		4385	@addr = map { sprintf "%x", $_ } @addr;
		4386	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		4387	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		4388	or die "addr2line: $!";
		4389
		4390	my @funcs;
		4391	my @res = <$fh>;
		4392	chomp for @res;
		4393	while (@res) {
		4394	my ($func, $line) = splice @res, 0, 2, ();
		4395	push @funcs, "[$func] $line";
		4396	}
		4397
		4398	@funcs
		4399	};
		4400
		4401	LOG llevInfo, "[ABT] $perl_bt\n";
		4402	LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
		4403	LOG llevInfo, "[ABT] $_\n" for @bt;
		4404	--$_log_backtrace;
		4405	};
		4406	} else {
		4407	LOG llevInfo, "[ABT] $msg\n";
		4408	LOG llevInfo, "[ABT] [overload, suppressed]\n";
		4409	}
2903	}	4410	}
2904		4411
2905	# load additional modules	4412	# load additional modules
2906	use cf::pod;	4413	require "cf/$_.pm" for @EXTRA_MODULES;
		4414	cf::_connect_to_perl_2;
2907		4415
2908	END { cf::emergency_save }	4416	END { cf::emergency_save }
2909		4417
2910	1	4418	1
2911		4419

Diff Legend

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