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.154 by root, Tue Jan 9 15:36:19 2007 UTC vs.
Revision 1.583 by root, Mon Oct 29 23:12:37 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;
28		64
29	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	65	# configure various modules to our taste
30	$YAML::Syck::ImplicitUnicode = 1;	66	#
		67	$Storable::canonical = 1; # reduce rsync transfers
		68	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
31		69
32	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority	70	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
33		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" };
		78
34	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	79	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		80
		81	our @ORIG_INC;
35		82
36	our %COMMAND = ();	83	our %COMMAND = ();
37	our %COMMAND_TIME = ();	84	our %COMMAND_TIME = ();
		85
		86	our @EXTS = (); # list of extension package names
38	our %EXTCMD = ();	87	our %EXTCMD = ();
		88	our %EXTICMD = ();
		89	our %EXT_CORO = (); # coroutines bound to extensions
		90	our %EXT_MAP = (); # pluggable maps
39		91
		92	our $RELOAD; # number of reloads so far, non-zero while in reload
40	our @EVENT;	93	our @EVENT;
41	our $LIBDIR = datadir . "/ext";	94	our @REFLECT; # set by XS
		95	our %REFLECT; # set by us
42		96
43	our $TICK = MAX_TIME * 1e-6;	97	our $CONFDIR = confdir;
44	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
45	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;
46	our $NOW;	139	our $NOW;
47		140
48	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
49		144
50	our $UPTIME; $UPTIME ||= time;	145	# used to convert map paths into valid unix filenames by replacing / by ∕
51	our $RUNTIME;	146	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
52		147
53	our %PLAYER; # all users	148	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
54	our %MAP; # all maps	149	our $LOADAVG; # same thing, but with alpha-smoothing
55	our $LINK_MAP; # the special {link} map	150	our $JITTER; # average jitter
56	our $RANDOM_MAPS = cf::localdir . "/random";	151	our $TICK_START; # for load detecting purposes
57	our %EXT_CORO; # coroutines bound to extensions	152
		153	our @POST_INIT;
		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;
58		160
59	binmode STDOUT;	161	binmode STDOUT;
60	binmode STDERR;	162	binmode STDERR;
61		163
62	# read virtual server time, if available	164	# read virtual server time, if available
63	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	165	unless ($RUNTIME || !-e $RUNTIMEFILE) {
64	open my $fh, "<", cf::localdir . "/runtime"	166	open my $fh, "<", $RUNTIMEFILE
65	or die "unable to read runtime file: $!";	167	or die "unable to read $RUNTIMEFILE file: $!";
66	$RUNTIME = <$fh> + 0.;	168	$RUNTIME = <$fh> + 0.;
67	}	169	}
68		170
69	mkdir cf::localdir;	171	eval "sub TICK() { $TICK } 1" or die;
70	mkdir cf::localdir . "/" . cf::playerdir;
71	mkdir cf::localdir . "/" . cf::tmpdir;
72	mkdir cf::localdir . "/" . cf::uniquedir;
73	mkdir $RANDOM_MAPS;
74		172
75	# a special map that is always available	173	mkdir $_
76	our $LINK_MAP;	174	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
		175
77	our $EMERGENCY_POSITION;	176	our $EMERGENCY_POSITION;
78		177
		178	sub cf::map::normalise;
		179
		180	sub in_main() {
		181	$Coro::current == $Coro::main
		182	}
		183
79	#############################################################################	184	#############################################################################
80		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
81	=head2 GLOBAL VARIABLES	197	=head2 GLOBAL VARIABLES
82		198
83	=over 4	199	=over 4
84		200
85	=item $cf::UPTIME	201	=item $cf::UPTIME
86		202
87	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.
88		219
89	=item $cf::RUNTIME	220	=item $cf::RUNTIME
90		221
91	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
92	every server tick.	223	every server tick.
93		224
94	=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
95		228
96	The perl library directory, where extensions and cf-specific modules can	229	Various directories - "/etc", read-only install directory, perl-library
97	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.
98		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
99	=item $cf::NOW	240	=item $cf::LOAD
100		241
101	The time of the last (current) server tick.	242	The raw value load value from the last tick.
102
103	=item $cf::TICK
104
105	The interval between server ticks, in seconds.
106		243
107	=item %cf::CFG	244	=item %cf::CFG
108		245
109	Configuration for the server, loaded from C</etc/crossfire/config>, or	246	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
110	from wherever your confdir points to.	247	from wherever your confdir points to.
111		248
		249	=item cf::wait_for_tick, cf::wait_for_tick_begin
		250
		251	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
		252	returns directly I<after> the tick processing (and consequently, can only wake one thread
		253	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
		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.
		283
112	=back	284	=back
113		285
114	=cut	286	=cut
115		287
116	BEGIN {	288	sub error(@) { LOG llevError, join "", @_ }
117	*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 {
118	my $msg = join "", @_;	295	my $msg = join "", @_;
119	utf8::encode $msg;
120		296
121	$msg .= "\n"	297	$msg .= "\n"
122	unless $msg =~ /\n$/;	298	unless $msg =~ /\n$/;
123		299
		300	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		301
124	LOG llevError, $msg;	302	LOG llevWarn, $msg;
125	};	303	};
126	}	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	};
127		318
128	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	319	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
129	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	320	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
130	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	321	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
131	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	322	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
132	@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';
133	@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)
134		326
135	# 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
136	# within the Safe compartment.	328	# within the Safe compartment.
137	for my $pkg (qw(	329	for my $pkg (qw(
138	cf::global cf::attachable	330	cf::global cf::attachable
139	cf::object cf::object::player	331	cf::object cf::object::player
140	cf::client cf::player	332	cf::client cf::player
141	cf::arch cf::living	333	cf::arch cf::living
		334	cf::map cf::mapspace
142	cf::map cf::party cf::region	335	cf::party cf::region
143	)) {	336	)) {
144	no strict 'refs';
145	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	337	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
146	}	338	}
147		339
148	$Event::DIED = sub {	340	$EV::DIED = sub {
149	warn "error in event callback: @_";	341	Carp::cluck "error in event callback: @_";
150	};	342	};
151		343
152	my %ext_pkg;	344	#############################################################################
153	my @exts;	345
154	my @hook;	346	sub fork_call(&@);
		347	sub get_slot($;$$);
		348
		349	#############################################################################
155		350
156	=head2 UTILITY FUNCTIONS	351	=head2 UTILITY FUNCTIONS
157		352
158	=over 4	353	=over 4
159		354
…		…
178	$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;
179	$d	374	$d
180	} || "[unable to dump $_[0]: '$@']";	375	} || "[unable to dump $_[0]: '$@']";
181	}	376	}
182		377
183	use JSON::Syck (); # TODO# replace by JSON::PC once working	378	=item $scalar = cf::load_file $path
184		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
185	=item $ref = cf::from_json $json	430	=item $ref = cf::decode_json $json
186		431
187	Converts a JSON string into the corresponding perl data structure.	432	Converts a JSON string into the corresponding perl data structure.
188		433
189	=cut
190
191	sub from_json($) {
192	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
193	JSON::Syck::Load $_[0]
194	}
195
196	=item $json = cf::to_json $ref	434	=item $json = cf::encode_json $ref
197		435
198	Converts a perl data structure into its JSON representation.	436	Converts a perl data structure into its JSON representation.
199		437
200	=cut	438	=cut
201		439
202	sub to_json($) {	440	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
203	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	441
204	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	}
205	}	505	}
206		506
207	=item cf::lock_wait $string	507	=item cf::lock_wait $string
208		508
209	Wait until the given lock is available. See cf::lock_acquire.	509	Wait until the given lock is available. See cf::lock_acquire.
210		510
211	=item my $lock = cf::lock_acquire $string	511	=item my $lock = cf::lock_acquire $string
212		512
213	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
214	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,
215	for example when the coroutine gets canceled), the lock is automatically	515	for example when the coroutine gets canceled), the lock is automatically
216	returned.	516	returned.
217		517
		518	Locks are *not* recursive, locking from the same coro twice results in a
		519	deadlocked coro.
		520
218	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
219	uses map_find and cf::map::load uses map_load).	522	uses map_find and cf::map::load uses map_load).
220		523
221	=cut	524	=item $locked = cf::lock_active $string
222		525
223	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;
224		531
225	sub lock_wait($) {	532	sub lock_wait($) {
226	my ($key) = @_;	533	$LOCKS->wait ($_[0]);
227
228	# wait for lock, if any
229	while ($LOCK{$key}) {
230	push @{ $LOCK{$key} }, $Coro::current;
231	Coro::schedule;
232	}
233	}	534	}
234		535
235	sub lock_acquire($) {	536	sub lock_acquire($) {
236	my ($key) = @_;	537	$LOCKS->guard ($_[0])
		538	}
237		539
238	# wait, to be sure we are not locked	540	sub lock_active($) {
239	lock_wait $key;	541	$LOCKS->count ($_[0]) < 1
240
241	$LOCK{$key} = [];
242
243	Coro::guard {
244	# wake up all waiters, to be on the safe side
245	$_->ready for @{ delete $LOCK{$key} };
246	}
247	}	542	}
248		543
249	sub freeze_mainloop {	544	sub freeze_mainloop {
250	return unless $TICK_WATCHER->is_active;	545	tick_inhibit_inc;
251		546
252	my $guard = Coro::guard { $TICK_WATCHER->start };	547	&Guard::guard (\&tick_inhibit_dec);
253	$TICK_WATCHER->stop;	548	}
254	$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;
255	}	633	}
256		634
257	=item cf::async { BLOCK }	635	=item cf::async { BLOCK }
258		636
259	Currently the same as Coro::async_pool, meaning you cannot use	637	Currently the same as Coro::async_pool, meaning you cannot use
…		…
264		642
265	BEGIN { *async = \&Coro::async_pool }	643	BEGIN { *async = \&Coro::async_pool }
266		644
267	=item cf::sync_job { BLOCK }	645	=item cf::sync_job { BLOCK }
268		646
269	The design of crossfire+ requires that the main coro ($Coro::main) is	647	The design of Deliantra requires that the main coroutine ($Coro::main)
270	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
271	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.
272		651
273	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
274	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
275	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
276	fast or be very important.	655	fast or be very important.
…		…
278	=cut	657	=cut
279		658
280	sub sync_job(&) {	659	sub sync_job(&) {
281	my ($job) = @_;	660	my ($job) = @_;
282		661
283	if ($Coro::current == $Coro::main) {	662	if (in_main) {
		663	my $time = AE::time;
		664
284	# this is the main coro, too bad, we have to block	665	# this is the main coro, too bad, we have to block
285	# till the operation succeeds, freezing the server :/	666	# till the operation succeeds, freezing the server :/
286		667
287	# TODO: use suspend/resume instead	668	#LOG llevError, Carp::longmess "sync job";#d#
288	# (but this is cancel-safe)	669
289	my $freeze_guard = freeze_mainloop;	670	my $freeze_guard = freeze_mainloop;
290		671
291	my $busy = 1;	672	my $busy = 1;
292	my @res;	673	my @res;
293		674
294	(async {	675	(async {
		676	$Coro::current->desc ("sync job coro");
295	@res = eval { $job->() };	677	@res = eval { $job->() };
296	warn $@ if $@;	678	error $@ if $@;
297	undef $busy;	679	undef $busy;
298	})->prio (Coro::PRIO_MAX);	680	})->prio (Coro::PRIO_MAX);
299		681
300	while ($busy) {	682	while ($busy) {
301	Coro::cede or Event::one_event;	683	if (Coro::nready) {
		684	Coro::cede_notself;
		685	} else {
		686	EV::loop EV::LOOP_ONESHOT;
302	}	687	}
		688	}
		689
		690	my $time = AE::time - $time;
		691
		692	$TICK_START += $time; # do not account sync jobs to server load
303		693
304	wantarray ? @res : $res[0]	694	wantarray ? @res : $res[0]
305	} else {	695	} else {
306	# we are in another coroutine, how wonderful, everything just works	696	# we are in another coroutine, how wonderful, everything just works
307		697
…		…
309	}	699	}
310	}	700	}
311		701
312	=item $coro = cf::async_ext { BLOCK }	702	=item $coro = cf::async_ext { BLOCK }
313		703
314	Like async, but this coro is automcatially being canceled when the	704	Like async, but this coro is automatically being canceled when the
315	extension calling this is being unloaded.	705	extension calling this is being unloaded.
316		706
317	=cut	707	=cut
318		708
319	sub async_ext(&) {	709	sub async_ext(&) {
…		…
327	$EXT_CORO{$coro+0} = $coro;	717	$EXT_CORO{$coro+0} = $coro;
328		718
329	$coro	719	$coro
330	}	720	}
331		721
332	sub write_runtime {	722	=item fork_call { }, @args
333	my $runtime = cf::localdir . "/runtime";
334		723
335	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	724	Executes the given code block with the given arguments in a seperate
336	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.
337		728
338	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	729	=cut
339	(aio_write $fh, 0, (length $value), $value, 0) <= 0
340	and return;
341		730
342	aio_fsync $fh	731	sub post_fork {
343	and return;	732	reset_signals;
		733	}
344		734
345	close $fh	735	sub fork_call(&@) {
346	or return;	736	my ($cb, @args) = @_;
347		737
348	aio_rename "$runtime~", $runtime	738	# we seemingly have to make a local copy of the whole thing,
349	and return;	739	# otherwise perl prematurely frees the stuff :/
		740	# TODO: investigate and fix (likely this will be rather laborious)
350		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 {
351	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 });
352	}	925	}
353		926
354	=back	927	=back
355		928
356	=cut	929	=cut
357		930
358	#############################################################################	931	#############################################################################
359		932
360	package cf::path;
361
362	# used to convert map paths into valid unix filenames by repalcing / by ∕
363	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
364
365	sub new {
366	my ($class, $path, $base) = @_;
367
368	$path = $path->as_string if ref $path;
369
370	my $self = bless { }, $class;
371
372	# {... are special paths that are not touched
373	# ?xxx/... are special absolute paths
374	# ?random/... random maps
375	# /! non-realised random map exit
376	# /... normal maps
377	# ~/... per-player maps without a specific player (DO NOT USE)
378	# ~user/... per-player map of a specific user
379
380	if ($path =~ /^{/) {
381	# fine as it is
382	} elsif ($path =~ s{^\?random/}{}) {
383	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
384	$self->{random} = cf::from_json $data;
385	} else {
386	if ($path =~ s{^~([^/]+)?}{}) {
387	$self->{user_rel} = 1;
388
389	if (defined $1) {
390	$self->{user} = $1;
391	} elsif ($base =~ m{^~([^/]+)/}) {
392	$self->{user} = $1;
393	} else {
394	warn "cannot resolve user-relative path without user <$path,$base>\n";
395	}
396	} elsif ($path =~ /^\//) {
397	# already absolute
398	} else {
399	$base =~ s{[^/]+/?$}{};
400	return $class->new ("$base/$path");
401	}
402
403	for ($path) {
404	redo if s{/\.?/}{/};
405	redo if s{/[^/]+/\.\./}{/};
406	}
407	}
408
409	$self->{path} = $path;
410
411	$self
412	}
413
414	# the name / primary key / in-game path
415	sub as_string {
416	my ($self) = @_;
417
418	$self->{user_rel} ? "~$self->{user}$self->{path}"
419	: $self->{random} ? "?random/$self->{path}"
420	: $self->{path}
421	}
422
423	# the displayed name, this is a one way mapping
424	sub visible_name {
425	my ($self) = @_;
426
427	# if (my $rmp = $self->{random}) {
428	# # todo: be more intelligent about this
429	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
430	# } else {
431	$self->as_string
432	# }
433	}
434
435	# escape the /'s in the path
436	sub _escaped_path {
437	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
438	$path
439	}
440
441	# the original (read-only) location
442	sub load_path {
443	my ($self) = @_;
444
445	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
446	}
447
448	# the temporary/swap location
449	sub save_path {
450	my ($self) = @_;
451
452	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
453	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
454	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
455	}
456
457	# the unique path, might be eq to save_path
458	sub uniq_path {
459	my ($self) = @_;
460
461	$self->{user_rel} || $self->{random}
462	? undef
463	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
464	}
465
466	# return random map parameters, or undef
467	sub random_map_params {
468	my ($self) = @_;
469
470	$self->{random}
471	}
472
473	# this is somewhat ugly, but style maps do need special treatment
474	sub is_style_map {
475	$_[0]{path} =~ m{^/styles/}
476	}
477
478	package cf;
479
480	#############################################################################
481
482	=head2 ATTACHABLE OBJECTS	933	=head2 ATTACHABLE OBJECTS
483		934
484	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
485	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")
486	to it. All such attachable objects support the following methods.	937	to it. All such attachable objects support the following methods.
487		938
488	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>
489	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
490	crossfire+).	941	Deliantra).
491		942
492	=over 4	943	=over 4
493		944
494	=item $attachable->attach ($attachment, key => $value...)	945	=item $attachable->attach ($attachment, key => $value...)
495		946
…		…
539	=item cf::CLASS::attachment $name, ...	990	=item cf::CLASS::attachment $name, ...
540		991
541	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
542	given CLASS can refer to this attachment.	993	given CLASS can refer to this attachment.
543		994
544	Some classes such as crossfire maps and objects can specify attachments	995	Some classes such as deliantra maps and objects can specify attachments
545	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.
546		997
547	These calls expect any number of the following handler/hook descriptions:	998	These calls expect any number of the following handler/hook descriptions:
548		999
549	=over 4	1000	=over 4
…		…
609	our @CB_TYPE = (); # registry for type (cf-object class) based events	1060	our @CB_TYPE = (); # registry for type (cf-object class) based events
610	our @CB_MAP = ();	1061	our @CB_MAP = ();
611		1062
612	my %attachment;	1063	my %attachment;
613		1064
		1065	sub cf::attachable::thawer_merge {
		1066	# simply override everything except _meta
		1067	local $_[0]{_meta};
		1068	%{$_[0]} = %{$_[1]};
		1069	}
		1070
614	sub _attach_cb($$$$) {	1071	sub _attach_cb($$$$) {
615	my ($registry, $event, $prio, $cb) = @_;	1072	my ($registry, $event, $prio, $cb) = @_;
616		1073
617	use sort 'stable';	1074	use sort 'stable';
618		1075
…		…
652	$registry = $CB_TYPE[$object_type] ||= [];	1109	$registry = $CB_TYPE[$object_type] ||= [];
653		1110
654	} elsif ($type eq "subtype") {	1111	} elsif ($type eq "subtype") {
655	defined $object_type or Carp::croak "subtype specified without type";	1112	defined $object_type or Carp::croak "subtype specified without type";
656	my $object_subtype = shift @arg;	1113	my $object_subtype = shift @arg;
657	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	1114	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
658		1115
659	} elsif ($type eq "package") {	1116	} elsif ($type eq "package") {
660	my $pkg = shift @arg;	1117	my $pkg = shift @arg;
661		1118
662	while (my ($name, $id) = each %cb_id) {	1119	while (my ($name, $id) = each %cb_id) {
…		…
667		1124
668	} elsif (exists $cb_id{$type}) {	1125	} elsif (exists $cb_id{$type}) {
669	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;	1126	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
670		1127
671	} elsif (ref $type) {	1128	} elsif (ref $type) {
672	warn "attaching objects not supported, ignoring.\n";	1129	error "attaching objects not supported, ignoring.\n";
673		1130
674	} else {	1131	} else {
675	shift @arg;	1132	shift @arg;
676	warn "attach argument '$type' not supported, ignoring.\n";	1133	error "attach argument '$type' not supported, ignoring.\n";
677	}	1134	}
678	}	1135	}
679	}	1136	}
680		1137
681	sub _object_attach {	1138	sub _object_attach {
…		…
691	_attach $registry, $klass, @attach;	1148	_attach $registry, $klass, @attach;
692	}	1149	}
693		1150
694	$obj->{$name} = \%arg;	1151	$obj->{$name} = \%arg;
695	} else {	1152	} else {
696	warn "object uses attachment '$name' that is not available, postponing.\n";	1153	info "object uses attachment '$name' which is not available, postponing.\n";
697	}	1154	}
698		1155
699	$obj->{_attachment}{$name} = undef;	1156	$obj->{_attachment}{$name} = undef;
700	}	1157	}
701		1158
…		…
703	if (ref $_[0]) {	1160	if (ref $_[0]) {
704	_object_attach @_;	1161	_object_attach @_;
705	} else {	1162	} else {
706	_attach shift->_attach_registry, @_;	1163	_attach shift->_attach_registry, @_;
707	}	1164	}
		1165	_recalc_want;
708	};	1166	};
709		1167
710	# all those should be optimised	1168	# all those should be optimised
711	sub cf::attachable::detach {	1169	sub cf::attachable::detach {
712	my ($obj, $name) = @_;	1170	my ($obj, $name) = @_;
…		…
715	delete $obj->{_attachment}{$name};	1173	delete $obj->{_attachment}{$name};
716	reattach ($obj);	1174	reattach ($obj);
717	} else {	1175	} else {
718	Carp::croak "cannot, currently, detach class attachments";	1176	Carp::croak "cannot, currently, detach class attachments";
719	}	1177	}
		1178	_recalc_want;
720	};	1179	};
721		1180
722	sub cf::attachable::attached {	1181	sub cf::attachable::attached {
723	my ($obj, $name) = @_;	1182	my ($obj, $name) = @_;
724		1183
…		…
739	";	1198	";
740	die if $@;	1199	die if $@;
741	}	1200	}
742		1201
743	our $override;	1202	our $override;
744	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?
745		1204
746	sub override {	1205	sub override {
747	$override = 1;	1206	$override = 1;
748	@invoke_results = ();	1207	@INVOKE_RESULTS = (@_);
749	}	1208	}
750		1209
751	sub do_invoke {	1210	sub do_invoke {
752	my $event = shift;	1211	my $event = shift;
753	my $callbacks = shift;	1212	my $callbacks = shift;
754		1213
755	@invoke_results = ();	1214	@INVOKE_RESULTS = ();
756		1215
757	local $override;	1216	local $override;
758		1217
759	for (@$callbacks) {	1218	for (@$callbacks) {
760	eval { &{$_->[1]} };	1219	eval { &{$_->[1]} };
761		1220
762	if ($@) {	1221	if ($@) {
763	warn "$@";
764	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";	1222	error "$@", "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
765	override;	1223	override;
766	}	1224	}
767		1225
768	return 1 if $override;	1226	return 1 if $override;
769	}	1227	}
770		1228
771	0	1229	0
772	}	1230	}
773		1231
774	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1232	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
775		1233
776	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1234	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
777		1235
778	Generate an object-specific event with the given arguments.	1236	Generate an object-specific event with the given arguments.
779		1237
780	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
781	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
782	results (if you must, access C<@cf::invoke_results> directly).	1240	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
783		1241
784	=back	1242	=back
785		1243
786	=cut	1244	=cut
787		1245
788	#############################################################################	1246	#############################################################################
789	# 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	}
790		1290
791	sub reattach {	1291	sub reattach {
792	# basically do the same as instantiate, without calling instantiate	1292	# basically do the same as instantiate, without calling instantiate
793	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
794		1297
795	my $registry = $obj->registry;	1298	my $registry = $obj->registry;
796		1299
797	@$registry = ();	1300	@$registry = ();
798		1301
…		…
803	for (@$attach) {	1306	for (@$attach) {
804	my ($klass, @attach) = @$_;	1307	my ($klass, @attach) = @$_;
805	_attach $registry, $klass, @attach;	1308	_attach $registry, $klass, @attach;
806	}	1309	}
807	} else {	1310	} else {
808	warn "object uses attachment '$name' that is not available, postponing.\n";	1311	info "object uses attachment '$name' that is not available, postponing.\n";
809	}	1312	}
810	}	1313	}
811	}	1314	}
812		1315
813	cf::attachable->attach (	1316	cf::attachable->attach (
814	prio => -1000000,	1317	prio => -1000000,
815	on_instantiate => sub {	1318	on_instantiate => sub {
816	my ($obj, $data) = @_;	1319	my ($obj, $data) = @_;
817		1320
818	$data = from_json $data;	1321	$data = decode_json $data;
819		1322
820	for (@$data) {	1323	for (@$data) {
821	my ($name, $args) = @$_;	1324	my ($name, $args) = @$_;
822		1325
823	$obj->attach ($name, %{$args || {} });	1326	$obj->attach ($name, %{$args || {} });
…		…
839	sub object_freezer_save {	1342	sub object_freezer_save {
840	my ($filename, $rdata, $objs) = @_;	1343	my ($filename, $rdata, $objs) = @_;
841		1344
842	sync_job {	1345	sync_job {
843	if (length $$rdata) {	1346	if (length $$rdata) {
		1347	utf8::decode (my $decname = $filename);
844	warn sprintf "saving %s (%d,%d)\n",	1348	trace sprintf "saving %s (%d,%d)\n",
845	$filename, length $$rdata, scalar @$objs;	1349	$decname, length $$rdata, scalar @$objs
		1350	if $VERBOSE_IO;
846		1351
847	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1352	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
848	chmod SAVE_MODE, $fh;	1353	aio_chmod $fh, SAVE_MODE;
849	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;
850	aio_fsync $fh;	1357	aio_fsync $fh;
		1358	}
851	close $fh;	1359	aio_close $fh;
852		1360
853	if (@$objs) {	1361	if (@$objs) {
854	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) {
855	chmod SAVE_MODE, $fh;	1363	aio_chmod $fh, SAVE_MODE;
856	my $data = Storable::nfreeze { version => 1, objs => $objs };	1364	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
857	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;
858	aio_fsync $fh;	1368	aio_fsync $fh;
		1369	}
859	close $fh;	1370	aio_close $fh;
860	aio_rename "$filename.pst~", "$filename.pst";	1371	aio_rename "$filename.pst~", "$filename.pst";
861	}	1372	}
862	} else {	1373	} else {
863	aio_unlink "$filename.pst";	1374	aio_unlink "$filename.pst";
864	}	1375	}
865		1376
866	aio_rename "$filename~", $filename;	1377	aio_rename "$filename~", $filename;
		1378
		1379	$filename =~ s%/[^/]+$%%;
		1380	aio_pathsync $filename if $cf::USE_FSYNC;
867	} else {	1381	} else {
868	warn "FATAL: $filename~: $!\n";	1382	error "unable to save objects: $filename~: $!\n";
869	}	1383	}
870	} else {	1384	} else {
871	aio_unlink $filename;	1385	aio_unlink $filename;
872	aio_unlink "$filename.pst";	1386	aio_unlink "$filename.pst";
873	}	1387	}
874	}	1388	};
875	}	1389	}
876		1390
877	sub object_freezer_as_string {	1391	sub object_freezer_as_string {
878	my ($rdata, $objs) = @_;	1392	my ($rdata, $objs) = @_;
879		1393
…		…
891	or return;	1405	or return;
892		1406
893	unless (aio_stat "$filename.pst") {	1407	unless (aio_stat "$filename.pst") {
894	(aio_load "$filename.pst", $av) >= 0	1408	(aio_load "$filename.pst", $av) >= 0
895	or return;	1409	or return;
		1410
896	$av = eval { (Storable::thaw $av)->{objs} };	1411	my $st = eval { Coro::Storable::thaw $av };
		1412	$av = $st->{objs};
897	}	1413	}
898		1414
		1415	utf8::decode (my $decname = $filename);
899	warn sprintf "loading %s (%d)\n",	1416	trace sprintf "loading %s (%d,%d)\n",
900	$filename, length $data, scalar @{$av || []};#d#	1417	$decname, length $data, scalar @{$av || []}
		1418	if $VERBOSE_IO;
		1419
901	return ($data, $av);	1420	($data, $av)
902	}	1421	}
		1422
		1423	=head2 COMMAND CALLBACKS
		1424
		1425	=over 4
		1426
		1427	=cut
903		1428
904	#############################################################################	1429	#############################################################################
905	# command handling &c	1430	# command handling &c
906		1431
907	=item cf::register_command $name => \&callback($ob,$args);	1432	=item cf::register_command $name => \&callback($ob,$args);
…		…
920	push @{ $COMMAND{$name} }, [$caller, $cb];	1445	push @{ $COMMAND{$name} }, [$caller, $cb];
921	}	1446	}
922		1447
923	=item cf::register_extcmd $name => \&callback($pl,$packet);	1448	=item cf::register_extcmd $name => \&callback($pl,$packet);
924		1449
925	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.
926		1455
927	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
928	called.	1457	called.
929		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
930	=cut	1470	=cut
931		1471
932	sub register_extcmd {	1472	sub register_extcmd {
933	my ($name, $cb) = @_;	1473	my ($name, $cb) = @_;
934		1474
935	my $caller = caller;
936	#warn "registering extcmd '$name' to '$caller'";
937
938	$EXTCMD{$name} = [$cb, $caller];	1475	$EXTCMD{$name} = $cb;
939	}	1476	}
		1477
		1478	sub register_exticmd {
		1479	my ($name, $cb) = @_;
		1480
		1481	$EXTICMD{$name} = $cb;
		1482	}
		1483
		1484	use File::Glob ();
940		1485
941	cf::player->attach (	1486	cf::player->attach (
942	on_command => sub {	1487	on_unknown_command => sub {
943	my ($pl, $name, $params) = @_;	1488	my ($pl, $name, $params) = @_;
944		1489
945	my $cb = $COMMAND{$name}	1490	my $cb = $COMMAND{$name}
946	or return;	1491	or return;
947		1492
…		…
952	cf::override;	1497	cf::override;
953	},	1498	},
954	on_extcmd => sub {	1499	on_extcmd => sub {
955	my ($pl, $buf) = @_;	1500	my ($pl, $buf) = @_;
956		1501
957	my $msg = eval { from_json $buf };	1502	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
958		1503
959	if (ref $msg) {	1504	if (ref $msg) {
		1505	my ($type, $reply, @payload) = @$msg; # version 1 used %type, $id, %$hash
		1506
		1507	my @reply;
		1508
960	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1509	if (my $cb = $EXTCMD{$type}) {
961	if (my %reply = $cb->[0]->($pl, $msg)) {	1510	@reply = $cb->($pl, @payload);
962	$pl->ext_reply ($msg->{msgid}, %reply);
963	}
964	}	1511	}
		1512
		1513	$pl->ext_reply ($reply, @reply)
		1514	if $reply;
		1515
965	} else {	1516	} else {
966	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1517	error "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
967	}	1518	}
968		1519
969	cf::override;	1520	cf::override;
970	},	1521	},
971	);	1522	);
972		1523
973	sub register {	1524	# "readahead" all extensions
974	my ($base, $pkg) = @_;
975
976	#TODO
977	}
978
979	sub load_extension {	1525	sub cache_extensions {
980	my ($path) = @_;	1526	my $grp = IO::AIO::aio_group;
981		1527
982	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1528	add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
983	my $base = $1;	1529	for (grep /\.ext$/, @{$_[0]}) {
984	my $pkg = $1;	1530	add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
985	$pkg =~ s/[^[:word:]]/_/g;
986	$pkg = "ext::$pkg";
987
988	warn "loading '$path' into '$pkg'\n";
989
990	open my $fh, "<:utf8", $path
991	or die "$path: $!";
992
993	my $source =
994	"package $pkg; use strict; use utf8;\n"
995	. "#line 1 \"$path\"\n{\n"
996	. (do { local $/; <$fh> })
997	. "\n};\n1";
998
999	eval $source
1000	or die $@ ? "$path: $@\n"
1001	: "extension disabled.\n";
1002
1003	push @exts, $pkg;
1004	$ext_pkg{$base} = $pkg;
1005
1006	# no strict 'refs';
1007	# @{"$pkg\::ISA"} = ext::;
1008
1009	register $base, $pkg;
1010	}
1011
1012	sub unload_extension {
1013	my ($pkg) = @_;
1014
1015	warn "removing extension $pkg\n";
1016
1017	# remove hooks
1018	#TODO
1019	# for my $idx (0 .. $#PLUGIN_EVENT) {
1020	# delete $hook[$idx]{$pkg};
1021	# }
1022
1023	# remove commands
1024	for my $name (keys %COMMAND) {
1025	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1026
1027	if (@cb) {
1028	$COMMAND{$name} = \@cb;
1029	} else {
1030	delete $COMMAND{$name};
1031	}	1531	}
1032	}	1532	};
1033		1533
1034	# remove extcmds	1534	$grp
1035	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {	1535	}
1036	delete $EXTCMD{$name};
1037	}
1038		1536
1039	if (my $cb = $pkg->can ("unload")) {	1537	sub _ext_cfg_reg($$$$) {
1040	eval {	1538	my ($rvar, $varname, $cfgname, $default) = @_;
1041	$cb->($pkg);
1042	1
1043	} or warn "$pkg unloaded, but with errors: $@";
1044	}
1045		1539
1046	Symbol::delete_package $pkg;	1540	$cfgname = lc $varname
		1541	unless length $cfgname;
		1542
		1543	$EXT_CFG{$cfgname} = [$rvar, $default];
		1544
		1545	$$rvar = exists $CFG{$cfgname} ? $CFG{$cfgname} : $default;
1047	}	1546	}
1048		1547
1049	sub load_extensions {	1548	sub load_extensions {
		1549	info "loading extensions...";
		1550
		1551	%EXT_CFG = ();
		1552
		1553	cf::sync_job {
		1554	my %todo;
		1555
1050	for my $ext (<$LIBDIR/*.ext>) {	1556	for my $path (<$LIBDIR/*.ext>) {
1051	next unless -r $ext;	1557	next unless -r $path;
1052	eval {	1558
1053	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	}
1054	1	1631	}
1055	} 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	}
1056	}	1644	};
1057	}	1645	}
1058		1646
1059	#############################################################################	1647	#############################################################################
1060	# load/save/clean perl data associated with a map
1061		1648
1062	*cf::mapsupport::on_clean = sub {	1649	=back
1063	my ($map) = @_;
1064
1065	my $path = $map->tmpname;
1066	defined $path or return;
1067
1068	unlink "$path.pst";
1069	};
1070
1071	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1072
1073	#############################################################################
1074	# load/save perl data associated with player->ob objects
1075
1076	sub all_objects(@) {
1077	@_, map all_objects ($_->inv), @_
1078	}
1079
1080	# TODO: compatibility cruft, remove when no longer needed
1081	cf::player->attach (
1082	on_load => sub {
1083	my ($pl, $path) = @_;
1084
1085	for my $o (all_objects $pl->ob) {
1086	if (my $value = $o->get_ob_key_value ("_perl_data")) {
1087	$o->set_ob_key_value ("_perl_data");
1088
1089	%$o = %{ Storable::thaw pack "H*", $value };
1090	}
1091	}
1092	},
1093	);
1094
1095	#############################################################################
1096		1650
1097	=head2 CORE EXTENSIONS	1651	=head2 CORE EXTENSIONS
1098		1652
1099	Functions and methods that extend core crossfire objects.	1653	Functions and methods that extend core deliantra objects.
1100		1654
1101	=cut	1655	=cut
1102		1656
1103	package cf::player;	1657	package cf::player;
1104		1658
…		…
1106		1660
1107	=head3 cf::player	1661	=head3 cf::player
1108		1662
1109	=over 4	1663	=over 4
1110		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
1111	=item cf::player::find $login	1679	=item cf::player::find $login
1112		1680
1113	Returns the given player object, loading it if necessary (might block).	1681	Returns the given player object, loading it if necessary (might block).
1114		1682
1115	=cut	1683	=cut
1116		1684
1117	sub playerdir($) {	1685	sub playerdir($) {
1118	cf::localdir	1686	"$PLAYERDIR/"
1119	. "/"
1120	. cf::playerdir
1121	. "/"
1122	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1687	. (ref $_[0] ? $_[0]->ob->name : $_[0])
1123	}	1688	}
1124		1689
1125	sub path($) {	1690	sub path($) {
1126	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1691	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1127		1692
1128	(playerdir $login) . "/$login.pl"	1693	(playerdir $login) . "/playerdata"
1129	}	1694	}
1130		1695
1131	sub find_active($) {	1696	sub find_active($) {
1132	$cf::PLAYER{$_[0]}	1697	$cf::PLAYER{$_[0]}
1133	and $cf::PLAYER{$_[0]}->active	1698	and $cf::PLAYER{$_[0]}->active
…		…
1136		1701
1137	sub exists($) {	1702	sub exists($) {
1138	my ($login) = @_;	1703	my ($login) = @_;
1139		1704
1140	$cf::PLAYER{$login}	1705	$cf::PLAYER{$login}
1141	or cf::sync_job { !aio_stat $login }	1706	or !aio_stat path $login
1142	}	1707	}
1143		1708
1144	sub find($) {	1709	sub find($) {
1145	return $cf::PLAYER{$_[0]} || do {	1710	return $cf::PLAYER{$_[0]} || do {
1146	my $login = $_[0];	1711	my $login = $_[0];
1147		1712
1148	my $guard = cf::lock_acquire "user_find:$login";	1713	my $guard = cf::lock_acquire "user_find:$login";
1149		1714
1150	$cf::PLAYER{$_[0]} || do {	1715	$cf::PLAYER{$_[0]} || do {
1151	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
1152	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;
1153	$cf::PLAYER{$login} = $pl	1731	$cf::PLAYER{$login} = $pl
1154	}	1732	}
1155	}	1733	}
1156	}	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	);
1157		1748
1158	sub save($) {	1749	sub save($) {
1159	my ($pl) = @_;	1750	my ($pl) = @_;
1160		1751
1161	return if $pl->{deny_save};	1752	return if $pl->{deny_save};
…		…
1166	return if $pl->{deny_save};	1757	return if $pl->{deny_save};
1167		1758
1168	aio_mkdir playerdir $pl, 0770;	1759	aio_mkdir playerdir $pl, 0770;
1169	$pl->{last_save} = $cf::RUNTIME;	1760	$pl->{last_save} = $cf::RUNTIME;
1170		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
1171	$pl->save_pl ($path);	1767	$pl->save_pl ($path);
1172	Coro::cede;	1768	cf::cede_to_tick;
1173	}	1769	}
1174		1770
1175	sub new($) {	1771	sub new($) {
1176	my ($login) = @_;	1772	my ($login) = @_;
1177		1773
…		…
1183	$cf::PLAYER{$login} = $self;	1779	$cf::PLAYER{$login} = $self;
1184		1780
1185	$self	1781	$self
1186	}	1782	}
1187		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
1188	=item $pl->quit_character	1794	=item $pl->quit_character
1189		1795
1190	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
1191	be destroyed. May block for a long time.	1797	be destroyed. May block for a long time.
1192		1798
1193	=cut	1799	=cut
1194		1800
1195	sub quit_character {	1801	sub quit_character {
1196	my ($pl) = @_;	1802	my ($pl) = @_;
1197		1803
		1804	my $name = $pl->ob->name;
		1805
1198	$pl->{deny_save} = 1;	1806	$pl->{deny_save} = 1;
1199	$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
1200		1808
1201	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1809	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->ns;
1202	$pl->deactivate;	1810	$pl->deactivate;
		1811
		1812	my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
1203	$pl->invoke (cf::EVENT_PLAYER_QUIT);	1813	$pl->invoke (cf::EVENT_PLAYER_QUIT) if $pl->ns;
		1814	ext::highscore::check ($pl->ob);
		1815
1204	$pl->ns->destroy if $pl->ns;	1816	$pl->ns->destroy if $pl->ns;
1205		1817
1206	my $path = playerdir $pl;	1818	my $path = playerdir $pl;
1207	my $temp = "$path~$cf::RUNTIME~deleting~";	1819	my $temp = "$path~$cf::RUNTIME~deleting~";
1208	aio_rename $path, $temp;	1820	aio_rename $path, $temp;
1209	delete $cf::PLAYER{$pl->ob->name};	1821	delete $cf::PLAYER{$pl->ob->name};
1210	$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
1211	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;
1212	}	1844	}
1213		1845
1214	=item cf::player::list_logins	1846	=item cf::player::list_logins
1215		1847
1216	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
1217	while and may block, so not sync_job-capable, ever.	1849	while and may block, so not sync_job-capable, ever.
1218		1850
1219	=cut	1851	=cut
1220		1852
1221	sub list_logins {	1853	sub list_logins {
1222	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1854	my $dirs = aio_readdir $PLAYERDIR
1223	or return [];	1855	or return [];
1224		1856
1225	my @logins;	1857	my @logins;
1226		1858
1227	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") {
1228	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1865	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1229	aio_read $fh, 0, 512, my $buf, 0 or next;	1866	aio_read $fh, 0, 512, my $buf, 0 or next;
1230	$buf !~ /^password -------------$/ or next; # official not-valid tag	1867	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1868	}
1231		1869
1232	utf8::decode $login;	1870	utf8::decode $login;
1233	push @logins, $login;	1871	push @logins, $login;
1234	}	1872	}
1235		1873
1236	\@logins	1874	\@logins
1237	}	1875	}
1238		1876
1239	=item $player->maps	1877	=item $player->maps
1240		1878
		1879	=item cf::player::maps $login
		1880
1241	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
1242	player. May block.	1882	player. May block.
1243		1883
1244	=cut	1884	=cut
1245		1885
1246	sub maps($) {	1886	sub maps($) {
1247	my ($pl) = @_;	1887	my ($pl) = @_;
		1888
		1889	$pl = ref $pl ? $pl->ob->name : $pl;
1248		1890
1249	my $files = aio_readdir playerdir $pl	1891	my $files = aio_readdir playerdir $pl
1250	or return;	1892	or return;
1251		1893
1252	my @paths;	1894	my @paths;
1253		1895
1254	for (@$files) {	1896	for (@$files) {
1255	utf8::decode $_;	1897	utf8::decode $_;
1256	next if /\.(?:pl|pst)$/;	1898	next if /\.(?:pl|pst)$/;
1257	next unless /^$PATH_SEP/;	1899	next unless /^$PATH_SEP/o;
1258		1900
1259	s/$PATH_SEP/\//g;	1901	push @paths, cf::map::normalise "~$pl/$_";
1260	push @paths, new cf::path "~" . $pl->ob->name . "/" . $_;
1261	}	1902	}
1262		1903
1263	\@paths	1904	\@paths
1264	}	1905	}
1265		1906
		1907	=item $protocol_xml = $player->expand_cfpod ($cfpod)
		1908
		1909	Expand deliantra pod fragments into protocol xml.
		1910
1266	=item $player->ext_reply ($msgid, $msgtype, %msg)	1911	=item $player->ext_reply ($msgid, @msg)
1267		1912
1268	Sends an ext reply to the player.	1913	Sends an ext reply to the player.
1269		1914
1270	=cut	1915	=cut
1271		1916
1272	sub ext_reply($$$%) {	1917	sub ext_reply($$@) {
1273	my ($self, $id, %msg) = @_;	1918	my ($self, $id, @msg) = @_;
1274		1919
1275	$msg{msgid} = $id;	1920	$self->ns->ext_reply ($id, @msg)
1276
1277	$self->send ("ext " . cf::to_json \%msg);
1278	}	1921	}
1279		1922
1280	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	}
1281		1965
1282	=back	1966	=back
1283
1284		1967
1285	=head3 cf::map	1968	=head3 cf::map
1286		1969
1287	=over 4	1970	=over 4
1288		1971
…		…
1291	package cf::map;	1974	package cf::map;
1292		1975
1293	use Fcntl;	1976	use Fcntl;
1294	use Coro::AIO;	1977	use Coro::AIO;
1295		1978
		1979	use overload
		1980	'""' => \&as_string,
		1981	fallback => 1;
		1982
1296	our $MAX_RESET = 3600;	1983	our $MAX_RESET = 3600;
1297	our $DEFAULT_RESET = 3000;	1984	our $DEFAULT_RESET = 3000;
1298		1985
1299	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 {
1300	my ($path, $rmp) = @_;	2025	my ($path, $base) = @_;
1301		2026
1302	# mit "rum" bekleckern, nicht	2027	$path = "$path"; # make sure it's a string
1303	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
1304	$path,	2056	$path
1305	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1306	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1307	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1308	$rmp->{exit_on_final_map},
1309	$rmp->{xsize}, $rmp->{ysize},
1310	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1311	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1312	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1313	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1314	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1315	(cf::region::find $rmp->{region})
1316	}	2057	}
1317		2058
1318	# and all this just because we cannot iterate over	2059	sub new_from_path {
1319	# all maps in C++...	2060	my (undef, $path, $base) = @_;
1320	sub change_all_map_light {	2061
		2062	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		2063
		2064	$path = normalise $path, $base;
		2065
		2066	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		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')";
		2076	()
		2077	}
		2078
		2079	# may re-bless or do other evil things
		2080	sub init {
1321	my ($change) = @_;	2081	my ($self) = @_;
1322		2082
1323	$_->change_map_light ($change)	2083	$self
1324	for grep $_->outdoor, values %cf::MAP;
1325	}	2084	}
1326		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
1327	sub try_load_header($) {	2136	sub load_header_from($) {
1328	my ($path) = @_;	2137	my ($self, $path) = @_;
1329		2138
1330	utf8::encode $path;	2139	utf8::encode $path;
1331	aio_open $path, O_RDONLY, 0	2140	my $f = new_from_file cf::object::thawer $path
1332	or return;	2141	or return;
1333		2142
1334	my $map = cf::map::new	2143	$self->_load_header ($f)
1335	or return;	2144	or return;
1336		2145
1337	# for better error messages only, will be overwritten	2146	local $MAP_LOADING{$self->{path}} = $self;
1338	$map->path ($path);	2147	$f->resolve_delayed_derefs;
1339		2148
1340	$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
1341	or return;	2196	or return;
		2197	$self->prepare_orig;
		2198	}
1342		2199
1343	$map->{load_path} = $path;	2200	$self->{deny_reset} = 1
		2201	if $self->no_reset;
1344		2202
1345	$map	2203	$self->default_region (cf::region::find_by_path $self->{path})
		2204	unless $self->default_region;
		2205
		2206	1
1346	}	2207	}
1347		2208
1348	sub find;	2209	sub find;
1349	sub find {	2210	sub find {
1350	my ($path, $origin) = @_;	2211	my ($path, $origin) = @_;
1351		2212
1352	#warn "find<$path,$origin>\n";#d#	2213	cf::cede_to_tick;
1353		2214
1354	$path = new cf::path $path, $origin && $origin->path;	2215	$path = normalise $path, $origin;
1355	my $key = $path->as_string;
1356		2216
1357	cf::lock_wait "map_find:$key";	2217	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1358
1359	$cf::MAP{$key} || do {
1360	my $guard = cf::lock_acquire "map_find:$key";	2218	my $guard2 = cf::lock_acquire "map_find:$path";
1361		2219
1362	# do it the slow way	2220	$cf::MAP{$path} || do {
1363	my $map = try_load_header $path->save_path;	2221	my $map = new_from_path cf::map $path
1364
1365	Coro::cede;
1366
1367	if ($map) {
1368	$map->last_access ((delete $map->{last_access})
1369	|| $cf::RUNTIME); #d#
1370	# safety
1371	$map->{instantiate_time} = $cf::RUNTIME
1372	if $map->{instantiate_time} > $cf::RUNTIME;
1373	} else {
1374	if (my $rmp = $path->random_map_params) {
1375	$map = generate_random_map $key, $rmp;
1376	} else {
1377	$map = try_load_header $path->load_path;
1378	}
1379
1380	$map or return;	2222	or return;
1381		2223
1382	$map->{load_original} = 1;
1383	$map->{instantiate_time} = $cf::RUNTIME;
1384	$map->last_access ($cf::RUNTIME);
1385	$map->instantiate;
1386
1387	# per-player maps become, after loading, normal maps
1388	$map->per_player (0) if $path->{user_rel};
1389	}
1390
1391	$map->path ($key);
1392	$map->{path} = $path;
1393	$map->{last_save} = $cf::RUNTIME;	2224	$map->{last_save} = $cf::RUNTIME;
1394		2225
1395	Coro::cede;	2226	$map->load_header
		2227	or return;
1396		2228
1397	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;
1398	$map->reset;	2234	$map->reset;
1399	undef $guard;
1400	$map = find $path	2235	return find $path;
1401	or return;
1402	}	2236	}
1403		2237
1404	$cf::MAP{$key} = $map	2238	$cf::MAP{$path} = $map
1405	}	2239	}
1406	}	2240	}
		2241
		2242	sub pre_load { }
		2243	#sub post_load { } # XS
1407		2244
1408	sub load {	2245	sub load {
1409	my ($self) = @_;	2246	my ($self) = @_;
1410		2247
		2248	local $self->{deny_reset} = 1; # loading can take a long time
		2249
1411	my $path = $self->{path};	2250	my $path = $self->{path};
		2251
		2252	{
1412	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	2253	my $guard = cf::lock_acquire "map_data:$path";
1413		2254
1414	return if $self->in_memory != cf::MAP_SWAPPED;	2255	return unless $self->valid;
		2256	return unless $self->state == cf::MAP_SWAPPED;
1415		2257
1416	$self->in_memory (cf::MAP_LOADING);
1417
1418	$self->alloc;	2258	$self->alloc;
1419	$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)
1420	or return;	2267	or return;
1421		2268
1422	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2269	$self->post_load_original
1423	if delete $self->{load_original};	2270	if delete $self->{load_original};
1424		2271
1425	if (my $uniq = $path->uniq_path) {	2272	if (my $uniq = $self->uniq_path) {
1426	utf8::encode $uniq;	2273	utf8::encode $uniq;
1427	if (aio_open $uniq, O_RDONLY, 0) {	2274	unless (aio_stat $uniq) {
		2275	if (my $f = new_from_file cf::object::thawer $uniq) {
1428	$self->clear_unique_items;	2276	$self->clear_unique_items;
1429	$self->load_objects ($uniq, 0);	2277	$self->_load_objects ($f);
		2278	$f->resolve_delayed_derefs;
		2279	}
		2280	}
1430	}	2281	}
1431	}
1432		2282
1433	Coro::cede;	2283	$f->resolve_delayed_derefs;
		2284	} else {
		2285	$self->post_load_original
		2286	if delete $self->{load_original};
		2287	}
1434		2288
		2289	$self->state (cf::MAP_INACTIVE);
		2290
		2291	cf::cede_to_tick;
1435	# now do the right thing for maps	2292	# now do the right thing for maps
1436	$self->link_multipart_objects;	2293	$self->link_multipart_objects;
1437
1438	if ($self->{path}->is_style_map) {
1439	$self->{deny_save} = 1;
1440	$self->{deny_reset} = 1;
1441	} else {
1442	$self->fix_auto_apply;
1443	$self->decay_objects;
1444	$self->update_buttons;
1445	$self->set_darkness_map;
1446	$self->difficulty ($self->estimate_difficulty)	2294	$self->difficulty ($self->estimate_difficulty)
1447	unless $self->difficulty;	2295	unless $self->difficulty;
1448	$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
1449	}	2312	1
		2313	}
1450		2314
1451	Coro::cede;	2315	# customize the map for a given player, i.e.
		2316	# return the _real_ map. used by e.g. per-player
		2317	# maps to change the path to ~playername/mappath
		2318	sub customise_for {
		2319	my ($self, $ob) = @_;
1452		2320
1453	$self->in_memory (cf::MAP_IN_MEMORY);	2321	return find "~" . $ob->name . "/" . $self->{path}
		2322	if $self->per_player;
		2323
		2324	# return find "?party/" . $ob->name . "/" . $self->{path}
		2325	# if $self->per_party;
		2326
		2327	$self
1454	}	2328	}
1455		2329
1456	sub find_sync {	2330	sub find_sync {
1457	my ($path, $origin) = @_;	2331	my ($path, $origin) = @_;
1458		2332
1459	cf::sync_job { cf::map::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
1460	}	2338	}
1461		2339
1462	sub do_load_sync {	2340	sub do_load_sync {
1463	my ($map) = @_;	2341	my ($map) = @_;
1464		2342
1465	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;
		2348	}
		2349
		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
		2364	$MAP_PREFETCHER ||= cf::async {
		2365	$Coro::current->{desc} = "map prefetcher";
		2366
		2367	while (%MAP_PREFETCH) {
		2368	while (my ($k, $v) = each %MAP_PREFETCH) {
		2369	if (my $map = find $k) {
		2370	$map->load if $v;
		2371	}
		2372
		2373	delete $MAP_PREFETCH{$k};
		2374	}
		2375	}
		2376	undef $MAP_PREFETCHER;
		2377	};
		2378	$MAP_PREFETCHER->prio (6);
		2379
		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	}
1466	}	2413	}
1467		2414
1468	sub save {	2415	sub save {
1469	my ($self) = @_;	2416	my ($self) = @_;
1470		2417
1471	my $lock = cf::lock_acquire "map_data:" . $self->path;	2418	my $lock = cf::lock_acquire "map_data:$self->{path}";
1472		2419
1473	$self->{last_save} = $cf::RUNTIME;	2420	$self->_save;
1474
1475	return unless $self->dirty;
1476
1477	my $save = $self->{path}->save_path; utf8::encode $save;
1478	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
1479
1480	$self->{load_path} = $save;
1481
1482	return if $self->{deny_save};
1483
1484	local $self->{last_access} = $self->last_access;#d#
1485
1486	cf::async {
1487	$_->contr->save for $self->players;
1488	};
1489
1490	if ($uniq) {
1491	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1492	$self->save_objects ($uniq, cf::IO_UNIQUES);
1493	} else {
1494	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1495	}
1496	}	2421	}
1497		2422
1498	sub swap_out {	2423	sub swap_out {
1499	my ($self) = @_;	2424	my ($self) = @_;
1500		2425
1501	# save first because save cedes
1502	$self->save;
1503
1504	my $lock = cf::lock_acquire "map_data:" . $self->path;	2426	my $lock = cf::lock_acquire "map_data:$self->{path}";
1505		2427
		2428	return if !$self->linkable;
		2429	return if $self->{deny_save};
1506	return if $self->players;	2430	return if $self->players;
1507	return if $self->in_memory != cf::MAP_IN_MEMORY;
1508	return if $self->{deny_save};
1509		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
1510	$self->clear;	2441	$self->clear;
1511	$self->in_memory (cf::MAP_SWAPPED);
1512	}	2442	}
1513		2443
1514	sub reset_at {	2444	sub reset_at {
1515	my ($self) = @_;	2445	my ($self) = @_;
1516		2446
1517	# TODO: safety, remove and allow resettable per-player maps	2447	# TODO: safety, remove and allow resettable per-player maps
1518	return 1e99 if $self->{path}{user_rel};
1519	return 1e99 if $self->{deny_reset};	2448	return 1e99 if $self->{deny_reset};
1520		2449
1521	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2450	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1522	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;
1523		2452
…		…
1528	my ($self) = @_;	2457	my ($self) = @_;
1529		2458
1530	$self->reset_at <= $cf::RUNTIME	2459	$self->reset_at <= $cf::RUNTIME
1531	}	2460	}
1532		2461
1533	sub unlink_save {
1534	my ($self) = @_;
1535
1536	utf8::encode (my $save = $self->{path}->save_path);
1537	aioreq_pri 3; IO::AIO::aio_unlink $save;
1538	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1539	}
1540
1541	sub rename {
1542	my ($self, $new_path) = @_;
1543
1544	$self->unlink_save;
1545
1546	delete $cf::MAP{$self->path};
1547	$self->{path} = new cf::path $new_path;
1548	$self->path ($self->{path}->as_string);
1549	$cf::MAP{$self->path} = $self;
1550
1551	$self->save;
1552	}
1553
1554	sub reset {	2462	sub reset {
1555	my ($self) = @_;	2463	my ($self) = @_;
1556		2464
1557	my $lock = cf::lock_acquire "map_data:" . $self->path;	2465	my $lock = cf::lock_acquire "map_data:$self->{path}";
1558		2466
1559	return if $self->players;	2467	return if $self->players;
1560	return if $self->{path}{user_rel};#d#
1561		2468
1562	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	}
1563		2480
1564	delete $cf::MAP{$self->path};	2481	delete $cf::MAP{$self->path};
1565		2482
		2483	$self->deactivate;
1566	$_->clear_links_to ($self) for values %cf::MAP;	2484	$_->clear_links_to ($self) for values %cf::MAP;
		2485	$self->clear;
1567		2486
1568	$self->unlink_save;	2487	$self->unlink_save;
1569	$self->destroy;	2488	$self->destroy;
1570	}	2489	}
1571		2490
1572	my $nuke_counter = "aaaa";	2491	my $nuke_counter = "aaaa";
1573		2492
1574	sub nuke {	2493	sub nuke {
1575	my ($self) = @_;	2494	my ($self) = @_;
1576		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};
1577	$self->{deny_save} = 1;	2505	$self->{deny_save} = 1;
1578	$self->reset_timeout (1);	2506	$self->reset_timeout (1);
1579	$self->rename ("{nuke}/" . ($nuke_counter++));	2507	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2508
		2509	$cf::MAP{$self->path} = $self;
		2510	}
		2511
1580	$self->reset; # polite request, might not happen	2512	$self->reset; # polite request, might not happen
1581	}	2513	}
1582		2514
1583	sub customise_for {	2515	=item $maps = cf::map::tmp_maps
1584	my ($map, $ob) = @_;
1585		2516
1586	if ($map->per_player) {	2517	Returns an arrayref with all map paths of currently instantiated and saved
1587	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	2518	maps. May block.
		2519
		2520	=cut
		2521
		2522	sub tmp_maps() {
1588	}	2523	[
1589		2524	map {
1590	$map	2525	utf8::decode $_;
		2526	/\.map$/
		2527	? normalise $_
		2528	: ()
		2529	} @{ aio_readdir $TMPDIR or [] }
		2530	]
1591	}	2531	}
1592		2532
1593	sub emergency_save {	2533	=item $maps = cf::map::random_maps
1594	my $freeze_guard = cf::freeze_mainloop;
1595		2534
1596	warn "enter emergency perl save\n";	2535	Returns an arrayref with all map paths of currently instantiated and saved
		2536	random maps. May block.
1597		2537
1598	cf::sync_job {	2538	=cut
1599	warn "begin emergency player save\n";
1600	$_->save for values %cf::PLAYER;
1601	warn "end emergency player save\n";
1602		2539
1603	warn "begin emergency map save\n";	2540	sub random_maps() {
1604	$_->save for values %cf::MAP;	2541	[
1605	warn "end emergency map save\n";	2542	map {
		2543	utf8::decode $_;
		2544	/\.map$/
		2545	? normalise "?random/$_"
		2546	: ()
		2547	} @{ aio_readdir $RANDOMDIR or [] }
		2548	]
		2549	}
		2550
		2551	=item cf::map::unique_maps
		2552
		2553	Returns an arrayref of paths of all shared maps that have
		2554	instantiated unique items. May block.
		2555
		2556	=cut
		2557
		2558	sub unique_maps() {
		2559	[
		2560	map {
		2561	utf8::decode $_;
		2562	s/\.map$//; # TODO future compatibility hack
		2563	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
		2564	? ()
		2565	: normalise $_
		2566	} @{ aio_readdir $UNIQUEDIR or [] }
		2567	]
		2568	}
		2569
		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;
1606	};	2597	}
1607		2598
1608	warn "leave emergency perl save\n";	2599	\@maps
		2600	}
		2601
		2602	=back
		2603
		2604	=head3 cf::object
		2605
		2606	=cut
		2607
		2608	package cf::object;
		2609
		2610	=over 4
		2611
		2612	=item $ob->inv_recursive
		2613
		2614	Returns the inventory of the object I<and> their inventories, recursively,
		2615	but I<not> the object itself.
		2616
		2617	=cut
		2618
		2619	sub inv_recursive_;
		2620	sub inv_recursive_ {
		2621	map { $_, inv_recursive_ $_->inv } @_
		2622	}
		2623
		2624	sub inv_recursive {
		2625	inv_recursive_ inv $_[0]
		2626	}
		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	}
1609	}	2654	}
1610		2655
1611	package cf;	2656	package cf;
1612		2657
1613	=back	2658	=back
1614
1615		2659
1616	=head3 cf::object::player	2660	=head3 cf::object::player
1617		2661
1618	=over 4	2662	=over 4
1619		2663
…		…
1622	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>
1623	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
1624	dialogue with the given NPC character.	2668	dialogue with the given NPC character.
1625		2669
1626	=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	};
1627		2685
1628	# rough implementation of a future "reply" method that works	2686	# rough implementation of a future "reply" method that works
1629	# with dialog boxes.	2687	# with dialog boxes.
1630	#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
1631	sub cf::object::player::reply($$$;$) {	2689	sub cf::object::player::reply($$$;$) {
…		…
1633		2691
1634	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2692	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1635		2693
1636	if ($self->{record_replies}) {	2694	if ($self->{record_replies}) {
1637	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2695	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2696
1638	} 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 {
1639	$msg = $npc->name . " says: $msg" if $npc;	2705	$msg = $npc->name . " says: $msg" if $npc;
1640	$self->message ($msg, $flags);	2706	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2707	}
1641	}	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 (@_);
1642	}	2719	}
1643		2720
1644	=item $player_object->may ("access")	2721	=item $player_object->may ("access")
1645		2722
1646	Returns wether the given player is authorized to access resource "access"	2723	Returns wether the given player is authorized to access resource "access"
…		…
1659		2736
1660	=item $player_object->enter_link	2737	=item $player_object->enter_link
1661		2738
1662	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}>).
1663		2740
1664	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.
1665	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.
1666		2747
1667	=item $player_object->leave_link ($map, $x, $y)	2748	=item $player_object->leave_link ($map, $x, $y)
1668		2749
1669	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
1670	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
1671	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
1672	to the emergency map position.	2753	fails, to the emergency map position.
1673		2754
1674	Might block.	2755	Might block.
1675		2756
1676	=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	}
1677		2768
1678	sub cf::object::player::enter_link {	2769	sub cf::object::player::enter_link {
1679	my ($self) = @_;	2770	my ($self) = @_;
1680		2771
1681	$self->deactivate_recursive;	2772	$self->deactivate_recursive;
1682		2773
1683	return if $self->map == $LINK_MAP;	2774	++$self->{_link_recursion};
		2775
		2776	return if UNIVERSAL::isa $self->map, "ext::map_link";
1684		2777
1685	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2778	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1686	if $self->map;	2779	if $self->map && $self->map->{path} ne "{link}";
1687		2780
1688	$self->enter_map ($LINK_MAP, 20, 20);	2781	$self->enter_map ($LINK_MAP || link_map, 3, 3);
1689	}	2782	}
1690		2783
1691	sub cf::object::player::leave_link {	2784	sub cf::object::player::leave_link {
1692	my ($self, $map, $x, $y) = @_;	2785	my ($self, $map, $x, $y) = @_;
		2786
		2787	return unless $self->contr->active;
1693		2788
1694	my $link_pos = delete $self->{_link_pos};	2789	my $link_pos = delete $self->{_link_pos};
1695		2790
1696	unless ($map) {	2791	unless ($map) {
1697	# restore original map position	2792	# restore original map position
…		…
1708	($x, $y) = (-1, -1)	2803	($x, $y) = (-1, -1)
1709	unless (defined $x) && (defined $y);	2804	unless (defined $x) && (defined $y);
1710		2805
1711	# use -1 or undef as default coordinates, not 0, 0	2806	# use -1 or undef as default coordinates, not 0, 0
1712	($x, $y) = ($map->enter_x, $map->enter_y)	2807	($x, $y) = ($map->enter_x, $map->enter_y)
1713	if $x <=0 && $y <= 0;	2808	if $x <= 0 && $y <= 0;
1714		2809
1715	$map->load;	2810	$map->load;
1716		2811
1717	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
1718	$self->activate_recursive;	2819	$self->activate_recursive;
1719	$self->enter_map ($map, $x, $y);
1720	}
1721
1722	cf::player->attach (
1723	on_logout => sub {
1724	my ($pl) = @_;
1725
1726	# abort map switching before logout
1727	if ($pl->ob->{_link_pos}) {
1728	cf::sync_job {
1729	$pl->ob->leave_link
1730	};
1731	}
1732	},	2820	}
1733	on_login => sub {
1734	my ($pl) = @_;
1735		2821
1736	# try to abort aborted map switching on player login :)	2822	}
1737	# should happen only on crashes
1738	if ($pl->ob->{_link_pos}) {
1739	$pl->ob->enter_link;
1740	(async {
1741	# we need this sleep as the login has a concurrent enter_exit running
1742	# and this sleep increases chances of the player not ending up in scorn
1743	$pl->ob->reply (undef,
1744	"There was an internal problem at your last logout, "
1745	. "the server will try to bring you to your intended destination in a second.",
1746	cf::NDI_RED);
1747	Coro::Timer::sleep 1;
1748	$pl->ob->leave_link;
1749	})->prio (2);
1750	}
1751	},
1752	);
1753		2823
1754	=item $player_object->goto ($path, $x, $y)	2824	=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
1755		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
1756	=cut	2835	=cut
		2836
		2837	our $GOTOGEN;
1757		2838
1758	sub cf::object::player::goto {	2839	sub cf::object::player::goto {
1759	my ($self, $path, $x, $y) = @_;	2840	my ($self, $path, $x, $y, $check, $done) = @_;
1760		2841
1761	$path = new cf::path $path;	2842	if ($self->{_link_recursion} >= $MAX_LINKS) {
1762	$path ne "/" or Carp::cluck ("oy");#d#	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;
1763		2850
1764	$self->enter_link;	2851	$self->enter_link;
1765		2852
1766	(async {	2853	(async {
1767	my $map = cf::map::find $path->as_string;	2854	$Coro::current->{desc} = "player::goto $path $x $y";
		2855
		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
		2878	if ($map) {
1768	$map = $map->customise_for ($self) if $map;	2879	$map = $map->customise_for ($self);
1769		2880	$map = $check->($map, $x, $y, $self) if $check && $map;
1770	# warn "entering ", $map->path, " at ($x, $y)\n"	2881	} else {
1771	# if $map;
1772
1773	$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	}
1774		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};
1775	$self->leave_link ($map, $x, $y);	2895	$self->leave_link ($map, $x, $y);
		2896	}
		2897
		2898	$done->($self) if $done;
1776	})->prio (1);	2899	})->prio (1);
1777	}	2900	}
1778		2901
1779	=item $player_object->enter_exit ($exit_object)	2902	=item $player_object->enter_exit ($exit_object)
1780		2903
…		…
1782		2905
1783	sub parse_random_map_params {	2906	sub parse_random_map_params {
1784	my ($spec) = @_;	2907	my ($spec) = @_;
1785		2908
1786	my $rmp = { # defaults	2909	my $rmp = { # defaults
1787	xsize => 10,	2910	xsize => (cf::rndm 15, 40),
1788	ysize => 10,	2911	ysize => (cf::rndm 15, 40),
		2912	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2913	#layout => string,
1789	};	2914	};
1790		2915
1791	for (split /\n/, $spec) {	2916	for (split /\n/, $spec) {
1792	my ($k, $v) = split /\s+/, $_, 2;	2917	my ($k, $v) = split /\s+/, $_, 2;
1793		2918
…		…
1805	# that depends on the exit object	2930	# that depends on the exit object
1806		2931
1807	my $rmp = parse_random_map_params $exit->msg;	2932	my $rmp = parse_random_map_params $exit->msg;
1808		2933
1809	if ($exit->map) {	2934	if ($exit->map) {
1810	$rmp->{region} = $exit->map->region_name;	2935	$rmp->{region} = $exit->region->name;
1811	$rmp->{origin_map} = $exit->map->path;	2936	$rmp->{origin_map} = $exit->map->path;
1812	$rmp->{origin_x} = $exit->x;	2937	$rmp->{origin_x} = $exit->x;
1813	$rmp->{origin_y} = $exit->y;	2938	$rmp->{origin_y} = $exit->y;
		2939
		2940	$exit->map->touch;
1814	}	2941	}
1815		2942
1816	$rmp->{random_seed} ||= $exit->random_seed;	2943	$rmp->{random_seed} ||= $exit->random_seed;
1817		2944
1818	my $data = cf::to_json $rmp;	2945	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1819	my $md5 = Digest::MD5::md5_hex $data;	2946	my $md5 = Digest::MD5::md5_hex $data;
		2947	my $meta = "$RANDOMDIR/$md5.meta";
1820		2948
1821	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) {
1822	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;
1823		2953
		2954	my $slaying = "?random/$md5";
		2955
		2956	if ($exit->valid) {
1824	$exit->slaying ("?random/$md5");	2957	$exit->slaying ("?random/$md5");
1825	$exit->msg (undef);	2958	$exit->msg (undef);
		2959	}
1826	}	2960	}
1827	}	2961	}
1828		2962
1829	sub cf::object::player::enter_exit {	2963	sub cf::object::player::enter_exit {
1830	my ($self, $exit) = @_;	2964	my ($self, $exit) = @_;
…		…
1832	return unless $self->type == cf::PLAYER;	2966	return unless $self->type == cf::PLAYER;
1833		2967
1834	$self->enter_link;	2968	$self->enter_link;
1835		2969
1836	(async {	2970	(async {
1837	$self->deactivate_recursive; # just to be sure	2971	$Coro::current->{desc} = "enter_exit";
		2972
1838	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
1839	prepare_random_map $exit	2987	prepare_random_map $exit
		2988	if $exit->slaying eq "/!"; # need to re-check after getting the lock
		2989
1840	if $exit->slaying eq "/!";	2990	$map = $exit->slaying;
1841		2991
1842	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;	2992	} elsif ($slaying eq '!up') {
1843	$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;
1844		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
1845	1;	3009	1
1846	}) {	3010	}) {
1847	$self->message ("Something went wrong deep within the crossfire server. "	3011	$self->message ("Something went wrong deep within the deliantra server. "
1848	. "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. "
1849	. "Please report this to the dungeon master",	3013	. "Please report this to the dungeon master!",
1850	cf::NDI_UNIQUE | cf::NDI_RED);	3014	cf::NDI_UNIQUE | cf::NDI_RED);
1851		3015
1852	warn "ERROR in enter_exit: $@";	3016	error "ERROR in enter_exit: $@";
1853	$self->leave_link;	3017	$self->leave_link;
1854	}	3018	}
1855	})->prio (1);	3019	})->prio (1);
1856	}	3020	}
1857		3021
…		…
1868		3032
1869	sub cf::client::send_drawinfo {	3033	sub cf::client::send_drawinfo {
1870	my ($self, $text, $flags) = @_;	3034	my ($self, $text, $flags) = @_;
1871		3035
1872	utf8::encode $text;	3036	utf8::encode $text;
1873	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	3037	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1874	}	3038	}
1875		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	}
1876		3257
1877	=item $success = $client->query ($flags, "text", \&cb)	3258	=item $success = $client->query ($flags, "text", \&cb)
1878		3259
1879	Queues a query to the client, calling the given callback with	3260	Queues a query to the client, calling the given callback with
1880	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>,
1881	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>.
1882		3263
1883	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
1884	reliable at some point in the future.	3265	become reliable at some point in the future.
1885		3266
1886	=cut	3267	=cut
1887		3268
1888	sub cf::client::query {	3269	sub cf::client::query {
1889	my ($self, $flags, $text, $cb) = @_;	3270	my ($self, $flags, $text, $cb) = @_;
…		…
1897	utf8::encode $text;	3278	utf8::encode $text;
1898	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	3279	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1899		3280
1900	$self->send_packet ($self->{query_queue}[0][0])	3281	$self->send_packet ($self->{query_queue}[0][0])
1901	if @{ $self->{query_queue} } == 1;	3282	if @{ $self->{query_queue} } == 1;
		3283
		3284	1
1902	}	3285	}
1903		3286
1904	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	},
1905	on_reply => sub {	3293	on_reply => sub {
1906	my ($ns, $msg) = @_;	3294	my ($ns, $msg) = @_;
1907		3295
1908	# this weird shuffling is so that direct followup queries	3296	# this weird shuffling is so that direct followup queries
1909	# get handled first	3297	# get handled first
1910	my $queue = delete $ns->{query_queue}	3298	my $queue = delete $ns->{query_queue}
1911	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
1912		3300
1913	(shift @$queue)->[1]->($msg);	3301	(shift @$queue)->[1]->($msg);
		3302	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1914		3303
1915	push @{ $ns->{query_queue} }, @$queue;	3304	push @{ $ns->{query_queue} }, @$queue;
1916		3305
1917	if (@{ $ns->{query_queue} } == @$queue) {	3306	if (@{ $ns->{query_queue} } == @$queue) {
1918	if (@$queue) {	3307	if (@$queue) {
…		…
1920	} else {	3309	} else {
1921	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3310	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1922	}	3311	}
1923	}	3312	}
1924	},	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	},
1925	);	3337	);
1926		3338
1927	=item $client->async (\&cb)	3339	=item $client->async (\&cb)
1928		3340
1929	Create a new coroutine, running the specified callback. The coroutine will	3341	Create a new coroutine, running the specified callback. The coroutine will
…		…
1945		3357
1946	$coro	3358	$coro
1947	}	3359	}
1948		3360
1949	cf::client->attach (	3361	cf::client->attach (
1950	on_destroy => sub {	3362	on_client_destroy => sub {
1951	my ($ns) = @_;	3363	my ($ns) = @_;
1952		3364
1953	$_->cancel for values %{ (delete $ns->{_coro}) || {} };	3365	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
1954	},	3366	},
1955	);	3367	);
…		…
1970	our $safe = new Safe "safe";	3382	our $safe = new Safe "safe";
1971	our $safe_hole = new Safe::Hole;	3383	our $safe_hole = new Safe::Hole;
1972		3384
1973	$SIG{FPE} = 'IGNORE';	3385	$SIG{FPE} = 'IGNORE';
1974		3386
1975	$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	));
1976		3392
1977	# here we export the classes and methods available to script code	3393	# here we export the classes and methods available to script code
1978		3394
1979	=pod	3395	=pod
1980		3396
1981	The following fucntions and emthods are available within a safe environment:	3397	The following functions and methods are available within a safe environment:
1982		3398
1983	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
1984	cf::object::player player	3404	cf::object::player
1985	cf::player peaceful	3405	player
1986	cf::map trigger	3406
		3407	cf::player
		3408	peaceful
		3409
		3410	cf::map
		3411	trigger
1987		3412
1988	=cut	3413	=cut
1989		3414
1990	for (	3415	for (
1991	["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)],
1992	["cf::object::player" => qw(player)],	3419	["cf::object::player" => qw(player)],
1993	["cf::player" => qw(peaceful)],	3420	["cf::player" => qw(peaceful send_msg)],
1994	["cf::map" => qw(trigger)],	3421	["cf::map" => qw(trigger)],
1995	) {	3422	) {
1996	no strict 'refs';
1997	my ($pkg, @funs) = @$_;	3423	my ($pkg, @funs) = @$_;
1998	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3424	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
1999	for @funs;	3425	for @funs;
2000	}	3426	}
2001		3427
…		…
2016		3442
2017	my $qcode = $code;	3443	my $qcode = $code;
2018	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3444	$qcode =~ s/"/‟/g; # not allowed in #line filenames
2019	$qcode =~ s/\n/\\n/g;	3445	$qcode =~ s/\n/\\n/g;
2020		3446
		3447	%vars = (_dummy => 0) unless %vars;
		3448
		3449	my @res;
2021	local $_;	3450	local $_;
2022	local @safe::cf::_safe_eval_args = values %vars;
2023		3451
2024	my $eval =	3452	my $eval =
2025	"do {\n"	3453	"do {\n"
2026	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	3454	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
2027	. "#line 0 \"{$qcode}\"\n"	3455	. "#line 0 \"{$qcode}\"\n"
2028	. $code	3456	. $code
2029	. "\n}"	3457	. "\n}"
2030	;	3458	;
2031		3459
		3460	if ($CFG{safe_eval}) {
2032	sub_generation_inc;	3461	sub_generation_inc;
		3462	local @safe::cf::_safe_eval_args = values %vars;
2033	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);	3463	@res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
2034	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	}
2035		3469
2036	if ($@) {	3470	if ($@) {
2037	warn "$@";	3471	warn "$@",
2038	warn "while executing safe code '$code'\n";	3472	"while executing safe code '$code'\n",
2039	warn "with arguments " . (join " ", %vars) . "\n";	3473	"with arguments " . (join " ", %vars) . "\n";
2040	}	3474	}
2041		3475
2042	wantarray ? @res : $res[0]	3476	wantarray ? @res : $res[0]
2043	}	3477	}
2044		3478
…		…
2058	=cut	3492	=cut
2059		3493
2060	sub register_script_function {	3494	sub register_script_function {
2061	my ($fun, $cb) = @_;	3495	my ($fun, $cb) = @_;
2062		3496
2063	no strict 'refs';	3497	$fun = "safe::$fun" if $CFG{safe_eval};
2064	*{"safe::$fun"} = $safe_hole->wrap ($cb);	3498	*$fun = $safe_hole->wrap ($cb);
2065	}	3499	}
2066		3500
2067	=back	3501	=back
2068		3502
2069	=cut	3503	=cut
2070		3504
2071	#############################################################################	3505	#############################################################################
		3506	# the server's init and main functions
2072		3507
2073	=head2 EXTENSION DATABASE SUPPORT	3508	sub load_facedata($) {
		3509	my ($path) = @_;
2074		3510
2075	Crossfire maintains a very simple database for extension use. It can	3511	# HACK to clear player env face cache, we need some signal framework
2076	currently store anything that can be serialised using Storable, which	3512	# for this (global event?)
2077	excludes objects.	3513	%ext::player_env::MUSIC_FACE_CACHE = ();
2078		3514
2079	The parameter C<$family> should best start with the name of the extension	3515	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2080	using it, it should be unique.
2081		3516
2082	=over 4	3517	trace "loading facedata from $path\n";
2083		3518
2084	=item $hashref = cf::db_get $family	3519	my $facedata = decode_storable load_file $path;
2085		3520
2086	Return a hashref for use by the extension C<$family>, which can be	3521	$facedata->{version} == 2
2087	modified. After modifications, you have to call C<cf::db_dirty> or	3522	or cf::cleanup "$path: version mismatch, cannot proceed.";
2088	C<cf::db_sync>.
2089		3523
2090	=item $value = cf::db_get $family => $key	3524	# patch in the exptable
2091		3525	my $exp_table = $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]);
2092	Returns a single value from the database	3526	$facedata->{resource}{"res/exp_table"} = {
2093		3527	type => FT_RSRC,
2094	=item cf::db_put $family => $hashref	3528	data => $exp_table,
2095		3529	hash => (Digest::MD5::md5 $exp_table),
2096	Stores the given family hashref into the database. Updates are delayed, if
2097	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2098
2099	=item cf::db_put $family => $key => $value
2100
2101	Stores the given C<$value> in the family hash. Updates are delayed, if you
2102	want the data to be synced to disk immediately, use C<cf::db_sync>.
2103
2104	=item cf::db_dirty
2105
2106	Marks the database as dirty, to be updated at a later time.
2107
2108	=item cf::db_sync
2109
2110	Immediately write the database to disk I<if it is dirty>.
2111
2112	=cut
2113
2114	our $DB;
2115
2116	{
2117	my $path = cf::localdir . "/database.pst";
2118
2119	sub db_load() {
2120	$DB = stat $path ? Storable::retrieve $path : { };
2121	}
2122
2123	my $pid;
2124
2125	sub db_save() {
2126	waitpid $pid, 0 if $pid;
2127	if (0 == ($pid = fork)) {
2128	$DB->{_meta}{version} = 1;
2129	Storable::nstore $DB, "$path~";
2130	rename "$path~", $path;
2131	cf::_exit 0 if defined $pid;
2132	}
2133	}
2134
2135	my $dirty;
2136
2137	sub db_sync() {
2138	db_save if $dirty;
2139	undef $dirty;
2140	}
2141
2142	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2143	db_sync;
2144	});	3530	};
		3531	cf::cede_to_tick;
2145		3532
2146	sub db_dirty() {
2147	$dirty = 1;
2148	$idle->start;
2149	}	3533	{
		3534	my $faces = $facedata->{faceinfo};
2150		3535
2151	sub db_get($;$) {	3536	while (my ($face, $info) = each %$faces) {
2152	@_ >= 2	3537	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2153	? $DB->{$_[0]}{$_[1]}
2154	: ($DB->{$_[0]} ||= { })
2155	}
2156		3538
2157	sub db_put($$;$) {	3539	cf::face::set_visibility $idx, $info->{visibility};
2158	if (@_ >= 3) {	3540	cf::face::set_magicmap $idx, $info->{magicmap};
2159	$DB->{$_[0]}{$_[1]} = $_[2];	3541	cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
2160	} else {	3542	cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
2161	$DB->{$_[0]} = $_[1];	3543	cf::face::set_data $idx, 2, $info->{glyph} , $info->{glyph} ;
2162	}
2163	db_dirty;
2164	}
2165		3544
2166	cf::global->attach (	3545	cf::cede_to_tick;
2167	prio => 10000,
2168	on_cleanup => sub {
2169	db_sync;
2170	},	3546	}
2171	);
2172	}
2173		3547
2174	#############################################################################	3548	while (my ($face, $info) = each %$faces) {
2175	# the server's main()	3549	next unless $info->{smooth};
2176		3550
2177	sub cfg_load {	3551	my $idx = cf::face::find $face
2178	open my $fh, "<:utf8", cf::confdir . "/config"	3552	or next;
2179	or return;
2180		3553
2181	local $/;	3554	if (my $smooth = cf::face::find $info->{smooth}) {
2182	*CFG = YAML::Syck::Load <$fh>;	3555	cf::face::set_smooth $idx, $smooth;
		3556	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3557	} else {
		3558	error "smooth face '$info->{smooth}' not found for face '$face'";
		3559	}
2183		3560
		3561	cf::cede_to_tick;
		3562	}
		3563	}
		3564
		3565	{
		3566	my $anims = $facedata->{animinfo};
		3567
		3568	while (my ($anim, $info) = each %$anims) {
		3569	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3570	cf::cede_to_tick;
		3571	}
		3572
		3573	cf::anim::invalidate_all; # d'oh
		3574	}
		3575
		3576	{
		3577	my $res = $facedata->{resource};
		3578
		3579	while (my ($name, $info) = each %$res) {
		3580	if (defined (my $type = $info->{type})) {
		3581	# TODO: different hash - must free and use new index, or cache ixface data queue
		3582	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3583
		3584	cf::face::set_data $idx, 0, $info->{data}, $info->{hash};
		3585	cf::face::set_type $idx, $type;
		3586	cf::face::set_meta $idx, $type & 1 ? undef : $info->{meta}; # preserve meta unless prepended already
		3587	} else {
		3588	# $RESOURCE{$name} = $info; # unused
		3589	}
		3590
		3591	cf::cede_to_tick;
		3592	}
		3593	}
		3594
		3595	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3596
		3597	1
		3598	}
		3599
		3600	register_exticmd fx_want => sub {
		3601	my ($ns, $want) = @_;
		3602
		3603	while (my ($k, $v) = each %$want) {
		3604	$ns->fx_want ($k, $v);
		3605	}
		3606	};
		3607
		3608	sub load_resource_file($) {
		3609	my $guard = lock_acquire "load_resource_file";
		3610
		3611	my $status = load_resource_file_ $_[0];
		3612	get_slot 0.1, 100;
		3613	cf::arch::commit_load;
		3614
		3615	$status
		3616	}
		3617
		3618	sub reload_regions {
		3619	# HACK to clear player env face cache, we need some signal framework
		3620	# for this (global event?)
		3621	%ext::player_env::MUSIC_FACE_CACHE = ();
		3622
		3623	load_resource_file "$MAPDIR/regions"
		3624	or die "unable to load regions file\n";
		3625
		3626	for (cf::region::list) {
		3627	$_->{match} = qr/$_->{match}/
		3628	if exists $_->{match};
		3629	}
		3630	}
		3631
		3632	sub reload_facedata {
		3633	load_facedata "$DATADIR/facedata"
		3634	or die "unable to load facedata\n";
		3635	}
		3636
		3637	sub reload_archetypes {
		3638	load_resource_file "$DATADIR/archetypes"
		3639	or die "unable to load archetypes\n";
		3640	}
		3641
		3642	sub reload_treasures {
		3643	load_resource_file "$DATADIR/treasures"
		3644	or die "unable to load treasurelists\n";
		3645	}
		3646
		3647	sub reload_sound {
		3648	trace "loading sound config from $DATADIR/sound\n";
		3649
		3650	my $soundconf = JSON::XS->new->utf8->relaxed->decode (load_file "$DATADIR/sound");
		3651
		3652	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3653	my $sound = $soundconf->{compat}[$_]
		3654	or next;
		3655
		3656	my $face = cf::face::find "sound/$sound->[1]";
		3657	cf::sound::set $sound->[0] => $face;
		3658	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3659	}
		3660
		3661	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3662	my $face = cf::face::find "sound/$v";
		3663	cf::sound::set $k => $face;
		3664	}
		3665	}
		3666
		3667	sub reload_resources {
		3668	trace "reloading resource files...\n";
		3669
		3670	reload_exp_table;
		3671	reload_materials;
		3672	reload_facedata;
		3673	reload_sound;
		3674	reload_archetypes;
		3675	reload_regions;
		3676	reload_treasures;
		3677
		3678	trace "finished reloading resource files\n";
		3679	}
		3680
		3681	sub reload_config {
		3682	trace "reloading config file...\n";
		3683
		3684	my $config = load_file "$CONFDIR/config";
		3685	utf8::decode $config;
		3686	*CFG = decode_yaml $config;
		3687
2184	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3688	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
2185		3689
2186	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	3690	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2187	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};	3691	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2188		3692
2189	if (exists $CFG{mlockall}) {	3693	if (exists $CFG{mlockall}) {
…		…
2193	};	3697	};
2194	warn $@ if $@;	3698	warn $@ if $@;
2195	}	3699	}
2196	}	3700	}
2197		3701
		3702	sub pidfile() {
		3703	sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
		3704	or die "$PIDFILE: $!";
		3705	flock $fh, &Fcntl::LOCK_EX
		3706	or die "$PIDFILE: flock: $!";
		3707	$fh
		3708	}
		3709
		3710	# make sure only one server instance is running at any one time
		3711	sub atomic {
		3712	my $fh = pidfile;
		3713
		3714	my $pid = <$fh>;
		3715	kill 9, $pid if $pid > 0;
		3716
		3717	seek $fh, 0, 0;
		3718	print $fh $$;
		3719	}
		3720
		3721	sub main_loop {
		3722	trace "EV::loop starting\n";
		3723	if (1) {
		3724	EV::loop;
		3725	}
		3726	trace "EV::loop returned\n";
		3727	goto &main_loop unless $REALLY_UNLOOP;
		3728	}
		3729
2198	sub main {	3730	sub main {
		3731	cf::init_globals; # initialise logging
		3732
		3733	LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
		3734	LOG llevInfo, "Copyright (C) 2005-2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
		3735	LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
		3736	LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
		3737
		3738	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3739
2199	# we must not ever block the main coroutine	3740	# we must not ever block the main coroutine
2200	local $Coro::idle = sub {	3741	local $Coro::idle = sub {
2201	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3742	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2202	async { Event::one_event };	3743	(async {
		3744	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3745	EV::loop EV::LOOP_ONESHOT;
		3746	})->prio (Coro::PRIO_MAX);
2203	};	3747	};
2204		3748
2205	cfg_load;	3749	evthread_start IO::AIO::poll_fileno;
2206	db_load;	3750
		3751	cf::sync_job {
		3752	cf::incloader::init ();
		3753
		3754	cf::init_anim;
		3755	cf::init_attackmess;
		3756	cf::init_dynamic;
		3757
		3758	cf::load_settings;
		3759
		3760	reload_resources;
		3761	reload_config;
		3762	db_init;
		3763
		3764	cf::init_uuid;
		3765	cf::init_signals;
		3766	cf::init_skills;
		3767
		3768	cf::init_beforeplay;
		3769
		3770	atomic;
		3771
2207	load_extensions;	3772	load_extensions;
2208	Event::loop;	3773
		3774	utime time, time, $RUNTIMEFILE;
		3775
		3776	# no (long-running) fork's whatsoever before this point(!)
		3777	use POSIX ();
		3778	POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
		3779
		3780	cf::_post_init 0;
		3781	};
		3782
		3783	cf::object::thawer::errors_are_fatal 0;
		3784	info "parse errors in files are no longer fatal from this point on.\n";
		3785
		3786	AE::postpone {
		3787	undef &main; # free gobs of memory :)
		3788	};
		3789
		3790	goto &main_loop;
2209	}	3791	}
2210		3792
2211	#############################################################################	3793	#############################################################################
2212	# initialisation	3794	# initialisation and cleanup
2213		3795
		3796	# install some emergency cleanup handlers
		3797	BEGIN {
		3798	our %SIGWATCHER = ();
		3799	for my $signal (qw(INT HUP TERM)) {
		3800	$SIGWATCHER{$signal} = AE::signal $signal, sub {
		3801	cf::cleanup "SIG$signal";
		3802	};
		3803	}
		3804	}
		3805
		3806	sub write_runtime_sync {
		3807	my $t0 = AE::time;
		3808
		3809	# first touch the runtime file to show we are still running:
		3810	# the fsync below can take a very very long time.
		3811
		3812	IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
		3813
		3814	my $guard = cf::lock_acquire "write_runtime";
		3815
		3816	my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644
		3817	or return;
		3818
		3819	my $value = $cf::RUNTIME + 90 + 10;
		3820	# 10 is the runtime save interval, for a monotonic clock
		3821	# 60 allows for the watchdog to kill the server.
		3822
		3823	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3824	and return;
		3825
		3826	# always fsync - this file is important
		3827	aio_fsync $fh
		3828	and return;
		3829
		3830	# touch it again to show we are up-to-date
		3831	aio_utime $fh, undef, undef;
		3832
		3833	close $fh
		3834	or return;
		3835
		3836	aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
		3837	and return;
		3838
		3839	trace sprintf "runtime file written (%gs).\n", AE::time - $t0;
		3840
		3841	1
		3842	}
		3843
		3844	our $uuid_lock;
		3845	our $uuid_skip;
		3846
		3847	sub write_uuid_sync($) {
		3848	$uuid_skip ||= $_[0];
		3849
		3850	return if $uuid_lock;
		3851	local $uuid_lock = 1;
		3852
		3853	my $uuid = "$LOCALDIR/uuid";
		3854
		3855	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3856	or return;
		3857
		3858	my $value = uuid_seq uuid_cur;
		3859
		3860	unless ($value) {
		3861	info "cowardly refusing to write zero uuid value!\n";
		3862	return;
		3863	}
		3864
		3865	my $value = uuid_str $value + $uuid_skip;
		3866	$uuid_skip = 0;
		3867
		3868	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3869	and return;
		3870
		3871	# always fsync - this file is important
		3872	aio_fsync $fh
		3873	and return;
		3874
		3875	close $fh
		3876	or return;
		3877
		3878	aio_rename "$uuid~", $uuid
		3879	and return;
		3880
		3881	trace "uuid file written ($value).\n";
		3882
		3883	1
		3884
		3885	}
		3886
		3887	sub write_uuid($$) {
		3888	my ($skip, $sync) = @_;
		3889
		3890	$sync ? write_uuid_sync $skip
		3891	: async { write_uuid_sync $skip };
		3892	}
		3893
		3894	sub emergency_save() {
		3895	my $freeze_guard = cf::freeze_mainloop;
		3896
		3897	info "emergency_perl_save: enter\n";
		3898
		3899	# this is a trade-off: we want to be very quick here, so
		3900	# save all maps without fsync, and later call a global sync
		3901	# (which in turn might be very very slow)
		3902	local $USE_FSYNC = 0;
		3903
		3904	cf::sync_job {
		3905	cf::write_runtime_sync; # external watchdog should not bark
		3906
		3907	# use a peculiar iteration method to avoid tripping on perl
		3908	# refcount bugs in for. also avoids problems with players
		3909	# and maps saved/destroyed asynchronously.
		3910	info "emergency_perl_save: begin player save\n";
		3911	for my $login (keys %cf::PLAYER) {
		3912	my $pl = $cf::PLAYER{$login} or next;
		3913	$pl->valid or next;
		3914	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
		3915	$pl->save;
		3916	}
		3917	info "emergency_perl_save: end player save\n";
		3918
		3919	cf::write_runtime_sync; # external watchdog should not bark
		3920
		3921	info "emergency_perl_save: begin map save\n";
		3922	for my $path (keys %cf::MAP) {
		3923	my $map = $cf::MAP{$path} or next;
		3924	$map->valid or next;
		3925	$map->save;
		3926	}
		3927	info "emergency_perl_save: end map save\n";
		3928
		3929	cf::write_runtime_sync; # external watchdog should not bark
		3930
		3931	info "emergency_perl_save: begin database checkpoint\n";
		3932	BDB::db_env_txn_checkpoint $DB_ENV;
		3933	info "emergency_perl_save: end database checkpoint\n";
		3934
		3935	info "emergency_perl_save: begin write uuid\n";
		3936	write_uuid_sync 1;
		3937	info "emergency_perl_save: end write uuid\n";
		3938
		3939	cf::write_runtime_sync; # external watchdog should not bark
		3940
		3941	trace "emergency_perl_save: syncing database to disk";
		3942	BDB::db_env_txn_checkpoint $DB_ENV;
		3943
		3944	info "emergency_perl_save: starting sync\n";
		3945	IO::AIO::aio_sync sub {
		3946	info "emergency_perl_save: finished sync\n";
		3947	};
		3948
		3949	cf::write_runtime_sync; # external watchdog should not bark
		3950
		3951	trace "emergency_perl_save: flushing outstanding aio requests";
		3952	while (IO::AIO::nreqs || BDB::nreqs) {
		3953	Coro::AnyEvent::sleep 0.01; # let the sync_job do it's thing
		3954	}
		3955
		3956	cf::write_runtime_sync; # external watchdog should not bark
		3957	};
		3958
		3959	info "emergency_perl_save: leave\n";
		3960	}
		3961
		3962	sub post_cleanup {
		3963	my ($make_core) = @_;
		3964
		3965	IO::AIO::flush;
		3966
		3967	error Carp::longmess "post_cleanup backtrace"
		3968	if $make_core;
		3969
		3970	my $fh = pidfile;
		3971	unlink $PIDFILE if <$fh> == $$;
		3972	}
		3973
		3974	# a safer delete_package, copied from Symbol
		3975	sub clear_package($) {
		3976	my $pkg = shift;
		3977
		3978	# expand to full symbol table name if needed
		3979	unless ($pkg =~ /^main::.*::$/) {
		3980	$pkg = "main$pkg" if $pkg =~ /^::/;
		3981	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		3982	$pkg .= '::' unless $pkg =~ /::$/;
		3983	}
		3984
		3985	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		3986	my $stem_symtab = *{$stem}{HASH};
		3987
		3988	defined $stem_symtab and exists $stem_symtab->{$leaf}
		3989	or return;
		3990
		3991	# clear all symbols
		3992	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		3993	for my $name (keys %$leaf_symtab) {
		3994	_gv_clear *{"$pkg$name"};
		3995	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		3996	}
		3997	}
		3998
2214	sub reload() {	3999	sub do_reload_perl() {
2215	# can/must only be called in main	4000	# can/must only be called in main
2216	if ($Coro::current != $Coro::main) {	4001	unless (in_main) {
2217	warn "can only reload from main coroutine\n";	4002	error "can only reload from main coroutine";
2218	return;	4003	return;
2219	}	4004	}
2220		4005
2221	warn "reloading...";	4006	return if $RELOAD++;
2222		4007
2223	my $guard = freeze_mainloop;	4008	my $t1 = AE::time;
		4009
		4010	while ($RELOAD) {
		4011	cf::get_slot 0.1, -1, "reload_perl";
		4012	info "perl_reload: reloading...";
		4013
		4014	trace "perl_reload: entering sync_job";
		4015
		4016	cf::sync_job {
2224	cf::emergency_save;	4017	#cf::emergency_save;
2225		4018
2226	eval {	4019	trace "perl_reload: cancelling all extension coros";
2227	# if anything goes wrong in here, we should simply crash as we already saved
2228
2229	# cancel all watchers
2230	for (Event::all_watchers) {
2231	$_->cancel if $_->data & WF_AUTOCANCEL;
2232	}
2233
2234	# cancel all extension coros
2235	$_->cancel for values %EXT_CORO;	4020	$_->cancel for values %EXT_CORO;
2236	%EXT_CORO = ();	4021	%EXT_CORO = ();
2237		4022
2238	# unload all extensions	4023	trace "perl_reload: removing commands";
2239	for (@exts) {	4024	%COMMAND = ();
2240	warn "unloading <$_>";
2241	unload_extension $_;
2242	}
2243		4025
2244	# unload all modules loaded from $LIBDIR	4026	trace "perl_reload: removing ext/exti commands";
2245	while (my ($k, $v) = each %INC) {	4027	%EXTCMD = ();
2246	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	4028	%EXTICMD = ();
2247		4029
2248	warn "removing <$k>";	4030	trace "perl_reload: unloading/nuking all extensions";
2249	delete $INC{$k};	4031	for my $pkg (@EXTS) {
		4032	trace "... unloading $pkg";
2250		4033
2251	$k =~ s/\.pm$//;
2252	$k =~ s/\//::/g;
2253
2254	if (my $cb = $k->can ("unload_module")) {	4034	if (my $cb = $pkg->can ("unload")) {
		4035	eval {
2255	$cb->();	4036	$cb->($pkg);
		4037	1
		4038	} or error "$pkg unloaded, but with errors: $@";
		4039	}
		4040
		4041	trace "... clearing $pkg";
		4042	clear_package $pkg;
2256	}	4043	}
2257		4044
2258	Symbol::delete_package $k;	4045	trace "perl_reload: unloading all perl modules loaded from $LIBDIR";
		4046	while (my ($k, $v) = each %INC) {
		4047	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		4048
		4049	trace "... unloading $k";
		4050	delete $INC{$k};
		4051
		4052	$k =~ s/\.pm$//;
		4053	$k =~ s/\//::/g;
		4054
		4055	if (my $cb = $k->can ("unload_module")) {
		4056	$cb->();
		4057	}
		4058
		4059	clear_package $k;
2259	}	4060	}
2260		4061
2261	# sync database to disk
2262	cf::db_sync;
2263	IO::AIO::flush;
2264
2265	# get rid of safe::, as good as possible	4062	trace "perl_reload: getting rid of safe::, as good as possible";
2266	Symbol::delete_package "safe::$_"	4063	clear_package "safe::$_"
2267	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	4064	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2268		4065
2269	# remove register_script_function callbacks	4066	trace "perl_reload: unloading cf.pm \"a bit\"";
2270	# TODO
2271
2272	# unload cf.pm "a bit"
2273	delete $INC{"cf.pm"};	4067	delete $INC{"cf.pm"};
		4068	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2274		4069
2275	# don't, removes xs symbols, too,	4070	# don't, removes xs symbols, too,
2276	# and global variables created in xs	4071	# and global variables created in xs
2277	#Symbol::delete_package __PACKAGE__;	4072	#clear_package __PACKAGE__;
2278		4073
2279	# reload cf.pm	4074	info "perl_reload: unload completed, starting to reload now";
2280	warn "reloading cf.pm";	4075
		4076	trace "perl_reload: reloading cf.pm";
2281	require cf;	4077	require cf;
2282	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	4078	cf::_connect_to_perl_1;
2283		4079
2284	# load config and database again	4080	trace "perl_reload: loading config and database again";
2285	cf::cfg_load;	4081	cf::reload_config;
2286	cf::db_load;
2287		4082
2288	# load extensions	4083	trace "perl_reload: loading extensions";
2289	warn "load extensions";
2290	cf::load_extensions;	4084	cf::load_extensions;
2291		4085
2292	# reattach attachments to objects	4086	if ($REATTACH_ON_RELOAD) {
2293	warn "reattach";	4087	trace "perl_reload: reattaching attachments to objects/players";
2294	_global_reattach;	4088	_global_reattach; # objects, sockets
		4089	trace "perl_reload: reattaching attachments to maps";
2295	reattach $_ for values %MAP;	4090	reattach $_ for values %MAP;
		4091	trace "perl_reload: reattaching attachments to players";
		4092	reattach $_ for values %PLAYER;
		4093	}
		4094
		4095	cf::_post_init 1;
		4096
		4097	trace "perl_reload: leaving sync_job";
		4098
		4099	1
		4100	} or do {
		4101	error $@;
		4102	cf::cleanup "perl_reload: error, exiting.";
		4103	};
		4104
		4105	--$RELOAD;
		4106	}
		4107
		4108	$t1 = AE::time - $t1;
		4109	info "perl_reload: completed in ${t1}s\n";
		4110	};
		4111
		4112	our $RELOAD_WATCHER; # used only during reload
		4113
		4114	sub reload_perl() {
		4115	# doing reload synchronously and two reloads happen back-to-back,
		4116	# coro crashes during coro_state_free->destroy here.
		4117
		4118	$RELOAD_WATCHER ||= cf::async {
		4119	Coro::AIO::aio_wait cache_extensions;
		4120
		4121	$RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub {
		4122	do_reload_perl;
		4123	undef $RELOAD_WATCHER;
		4124	};
2296	};	4125	};
2297
2298	if ($@) {
2299	warn $@;
2300	warn "error while reloading, exiting.";
2301	exit 1;
2302	}
2303
2304	warn "reloaded successfully";
2305	};
2306
2307	#############################################################################
2308
2309	unless ($LINK_MAP) {
2310	$LINK_MAP = cf::map::new;
2311
2312	$LINK_MAP->width (41);
2313	$LINK_MAP->height (41);
2314	$LINK_MAP->alloc;
2315	$LINK_MAP->path ("{link}");
2316	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2317	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2318
2319	# dirty hack because... archetypes are not yet loaded
2320	Event->timer (
2321	after => 10,
2322	cb => sub {
2323	$_[0]->w->cancel;
2324
2325	# provide some exits "home"
2326	my $exit = cf::object::new "exit";
2327
2328	$exit->slaying ($EMERGENCY_POSITION->[0]);
2329	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2330	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2331
2332	$LINK_MAP->insert ($exit->clone, 19, 19);
2333	$LINK_MAP->insert ($exit->clone, 19, 20);
2334	$LINK_MAP->insert ($exit->clone, 19, 21);
2335	$LINK_MAP->insert ($exit->clone, 20, 19);
2336	$LINK_MAP->insert ($exit->clone, 20, 21);
2337	$LINK_MAP->insert ($exit->clone, 21, 19);
2338	$LINK_MAP->insert ($exit->clone, 21, 20);
2339	$LINK_MAP->insert ($exit->clone, 21, 21);
2340
2341	$exit->destroy;
2342	});
2343
2344	$LINK_MAP->{deny_save} = 1;
2345	$LINK_MAP->{deny_reset} = 1;
2346
2347	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2348	}	4126	}
2349
2350	register "<global>", __PACKAGE__;
2351		4127
2352	register_command "reload" => sub {	4128	register_command "reload" => sub {
2353	my ($who, $arg) = @_;	4129	my ($who, $arg) = @_;
2354		4130
2355	if ($who->flag (FLAG_WIZ)) {	4131	if ($who->flag (FLAG_WIZ)) {
2356	$who->message ("start of reload.");
2357	reload;
2358	$who->message ("end of reload.");	4132	$who->message ("reloading server.");
		4133	async {
		4134	$Coro::current->{desc} = "perl_reload";
		4135	reload_perl;
		4136	};
2359	}	4137	}
2360	};	4138	};
2361		4139
2362	unshift @INC, $LIBDIR;	4140	#############################################################################
2363		4141
2364	$TICK_WATCHER = Event->timer (	4142	my $bug_warning = 0;
2365	reentrant => 0,
2366	prio => 0,
2367	at => $NEXT_TICK || $TICK,
2368	data => WF_AUTOCANCEL,
2369	cb => sub {
2370	cf::server_tick; # one server iteration
2371	$RUNTIME += $TICK;
2372	$NEXT_TICK += $TICK;
2373		4143
2374	# if we are delayed by four ticks or more, skip them all	4144	sub wait_for_tick() {
2375	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	4145	return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
2376		4146
2377	$TICK_WATCHER->at ($NEXT_TICK);	4147	$WAIT_FOR_TICK->wait;
2378	$TICK_WATCHER->start;	4148	}
		4149
		4150	sub wait_for_tick_begin() {
		4151	return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
		4152
		4153	my $signal = new Coro::Signal;
		4154	push @WAIT_FOR_TICK_BEGIN, $signal;
		4155	$signal->wait;
		4156	}
		4157
		4158	sub tick {
		4159	if ($Coro::current != $Coro::main) {
		4160	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		4161	unless ++$bug_warning > 10;
		4162	return;
2379	},	4163	}
2380	);
2381		4164
2382	IO::AIO::max_poll_time $TICK * 0.2;	4165	cf::one_tick; # one server iteration
2383		4166
2384	Event->io (	4167	#for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
2385	fd => IO::AIO::poll_fileno,
2386	poll => 'r',
2387	prio => 5,
2388	data => WF_AUTOCANCEL,
2389	cb => \&IO::AIO::poll_cb,
2390	);
2391		4168
2392	Event->timer (	4169	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2393	data => WF_AUTOCANCEL,	4170	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2394	after => 0,	4171	Coro::async_pool {
2395	interval => 10,	4172	$Coro::current->{desc} = "runtime saver";
2396	cb => sub {
2397	(Coro::unblock_sub {
2398	write_runtime	4173	write_runtime_sync
2399	or warn "ERROR: unable to write runtime file: $!";	4174	or error "ERROR: unable to write runtime file: $!";
2400	})->();	4175	};
2401	},	4176	}
2402	);	4177
		4178	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		4179	$sig->send;
		4180	}
		4181	$WAIT_FOR_TICK->broadcast;
		4182
		4183	$LOAD = ($NOW - $TICK_START) / $TICK;
		4184	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		4185
		4186	if (0) {
		4187	if ($NEXT_TICK) {
		4188	my $jitter = $TICK_START - $NEXT_TICK;
		4189	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		4190	debug "jitter $JITTER\n";#d#
		4191	}
		4192	}
		4193	}
		4194
		4195	{
		4196	# configure BDB
		4197
		4198	BDB::min_parallel 16;
		4199	BDB::max_poll_reqs $TICK * 0.1;
		4200	#$AnyEvent::BDB::WATCHER->priority (1);
		4201
		4202	unless ($DB_ENV) {
		4203	$DB_ENV = BDB::db_env_create;
		4204	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		4205	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		4206	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		4207	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		4208	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		4209
		4210	cf::sync_job {
		4211	eval {
		4212	BDB::db_env_open
		4213	$DB_ENV,
		4214	$BDBDIR,
		4215	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		4216	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		4217	0666;
		4218
		4219	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		4220	};
		4221
		4222	cf::cleanup "db_env_open(db): $@" if $@;
		4223	};
		4224	}
		4225
		4226	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		4227	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		4228	};
		4229	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		4230	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		4231	};
		4232	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		4233	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		4234	};
		4235	}
		4236
		4237	{
		4238	# configure IO::AIO
		4239
		4240	IO::AIO::min_parallel 8;
		4241	IO::AIO::max_poll_time $TICK * 0.1;
		4242	undef $AnyEvent::AIO::WATCHER;
		4243	}
		4244
		4245	our $_log_backtrace;
		4246	our $_log_backtrace_last;
		4247
		4248	sub _log_backtrace {
		4249	my ($msg, @addr) = @_;
		4250
		4251	$msg =~ s/\n$//;
		4252
		4253	if ($_log_backtrace_last eq $msg) {
		4254	LOG llevInfo, "[ABT] $msg\n";
		4255	LOG llevInfo, "[ABT] [duplicate, suppressed]\n";
		4256	# limit the # of concurrent backtraces
		4257	} elsif ($_log_backtrace < 2) {
		4258	$_log_backtrace_last = $msg;
		4259	++$_log_backtrace;
		4260	my $perl_bt = Carp::longmess $msg;
		4261	async {
		4262	$Coro::current->{desc} = "abt $msg";
		4263
		4264	my @bt = fork_call {
		4265	@addr = map { sprintf "%x", $_ } @addr;
		4266	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		4267	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		4268	or die "addr2line: $!";
		4269
		4270	my @funcs;
		4271	my @res = <$fh>;
		4272	chomp for @res;
		4273	while (@res) {
		4274	my ($func, $line) = splice @res, 0, 2, ();
		4275	push @funcs, "[$func] $line";
		4276	}
		4277
		4278	@funcs
		4279	};
		4280
		4281	LOG llevInfo, "[ABT] $perl_bt\n";
		4282	LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
		4283	LOG llevInfo, "[ABT] $_\n" for @bt;
		4284	--$_log_backtrace;
		4285	};
		4286	} else {
		4287	LOG llevInfo, "[ABT] $msg\n";
		4288	LOG llevInfo, "[ABT] [overload, suppressed]\n";
		4289	}
		4290	}
		4291
		4292	# load additional modules
		4293	require "cf/$_.pm" for @EXTRA_MODULES;
		4294	cf::_connect_to_perl_2;
2403		4295
2404	END { cf::emergency_save }	4296	END { cf::emergency_save }
2405		4297
2406	1	4298	1
2407		4299

Diff Legend

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