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.158 by root, Wed Jan 10 19:52:43 2007 UTC vs.
Revision 1.572 by root, Sun May 8 11:44:43 2011 UTC

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

Diff Legend

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