ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.158 by root, Wed Jan 10 19:52:43 2007 UTC vs.
Revision 1.566 by root, Sun May 1 16:58:16 2011 UTC

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

Diff Legend

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