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

Diff Legend

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