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.145 by root, Sun Jan 7 21:54:59 2007 UTC vs.
Revision 1.598 by root, Sun Nov 11 02:38:10 2012 UTC

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

Diff Legend

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