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.139 by root, Fri Jan 5 19:12:03 2007 UTC vs.
Revision 1.584 by root, Tue Oct 30 17:07:50 2012 UTC

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

Diff Legend

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