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.133 by root, Thu Jan 4 16:19:32 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
20	use Digest::MD5;	53	use JSON::XS 2.01 ();
		54	use BDB ();
		55	use Data::Dumper;
21	use Fcntl;	56	use Fcntl;
22	use IO::AIO 2.31 ();
23	use YAML::Syck ();	57	use YAML::XS ();
		58	use IO::AIO ();
24	use Time::HiRes;	59	use Time::HiRes;
		60	use Compress::LZF;
		61	use Digest::MD5 ();
25		62
26	use Event; $Event::Eval = 1; # no idea why this is required, but it is	63	AnyEvent::detect;
27		64
28	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	65	# configure various modules to our taste
29	$YAML::Syck::ImplicitUnicode = 1;	66	#
		67	$Storable::canonical = 1; # reduce rsync transfers
		68	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
30		69
31	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority	70	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
		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" };
32		78
33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	79	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		80
		81	our @ORIG_INC;
34		82
35	our %COMMAND = ();	83	our %COMMAND = ();
36	our %COMMAND_TIME = ();	84	our %COMMAND_TIME = ();
		85
		86	our @EXTS = (); # list of extension package names
37	our %EXTCMD = ();	87	our %EXTCMD = ();
		88	our %EXTICMD = ();
		89	our %EXT_CORO = (); # coroutines bound to extensions
		90	our %EXT_MAP = (); # pluggable maps
38		91
		92	our $RELOAD; # number of reloads so far, non-zero while in reload
39	our @EVENT;	93	our @EVENT;
40	our $LIBDIR = datadir . "/ext";	94	our @REFLECT; # set by XS
		95	our %REFLECT; # set by us
41		96
42	our $TICK = MAX_TIME * 1e-6;	97	our $CONFDIR = confdir;
43	our $TICK_WATCHER;	98
		99	our $DATADIR = datadir;
		100	our $LIBDIR = "$DATADIR/ext";
		101	our $PODDIR = "$DATADIR/pod";
		102	our $MAPDIR = "$DATADIR/" . mapdir;
		103
		104	our $LOCALDIR = localdir;
		105	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		106	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		107	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		108	our $RANDOMDIR = "$LOCALDIR/random";
		109	our $BDBDIR = "$LOCALDIR/db";
		110	our $PIDFILE = "$LOCALDIR/pid";
		111	our $RUNTIMEFILE = "$LOCALDIR/runtime";
		112
		113	our %RESOURCE; # unused
		114
		115	our $OUTPUT_RATE_MIN = 3000;
		116	our $OUTPUT_RATE_MAX = 1000000;
		117
		118	our $MAX_LINKS = 32; # how many chained exits to follow
		119	our $VERBOSE_IO = 1;
		120
		121	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
		122	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44	our $NEXT_TICK;	123	our $NEXT_TICK;
45	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);
46		132
47	our %CFG;	133	our %CFG;
48		134
49	our $UPTIME; $UPTIME ||= time;	135	our $UPTIME; $UPTIME ||= time;
50	our $RUNTIME;	136	our $RUNTIME;
		137	our $NOW;
51		138
52	our %MAP; # all maps	139	our (%PLAYER, %PLAYER_LOADING); # all users
53	our $LINK_MAP; # the special {link} map	140	our (%MAP, %MAP_LOADING ); # all maps
54	our $RANDOM_MAPS = cf::localdir . "/random";	141	our $LINK_MAP; # the special {link} map, which is always available
55	our %EXT_CORO;	142
		143	# used to convert map paths into valid unix filenames by replacing / by ∕
		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 :)
56		155
57	binmode STDOUT;	156	binmode STDOUT;
58	binmode STDERR;	157	binmode STDERR;
59		158
60	# read virtual server time, if available	159	# read virtual server time, if available
61	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	160	unless ($RUNTIME || !-e $RUNTIMEFILE) {
62	open my $fh, "<", cf::localdir . "/runtime"	161	open my $fh, "<", $RUNTIMEFILE
63	or die "unable to read runtime file: $!";	162	or die "unable to read $RUNTIMEFILE file: $!";
64	$RUNTIME = <$fh> + 0.;	163	$RUNTIME = <$fh> + 0.;
65	}	164	}
66		165
67	mkdir cf::localdir;	166	eval "sub TICK() { $TICK } 1" or die;
68	mkdir cf::localdir . "/" . cf::playerdir;
69	mkdir cf::localdir . "/" . cf::tmpdir;
70	mkdir cf::localdir . "/" . cf::uniquedir;
71	mkdir $RANDOM_MAPS;
72		167
73	# a special map that is always available	168	mkdir $_
74	our $LINK_MAP;	169	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
		170
75	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::"} };
76		189
77	#############################################################################	190	#############################################################################
78		191
79	=head2 GLOBAL VARIABLES	192	=head2 GLOBAL VARIABLES
80		193
…		…
87	=item $cf::RUNTIME	200	=item $cf::RUNTIME
88		201
89	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
90	every server tick.	203	every server tick.
91		204
92	=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
93		208
94	The perl library directory, where extensions and cf-specific modules can	209	Various directories - "/etc", read-only install directory, perl-library
95	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.
96		213
97	=item $cf::NOW	214	=item $cf::NOW
98		215
99	The time of the last (current) server tick.	216	The time of the last (current) server tick.
100		217
101	=item $cf::TICK	218	=item $cf::TICK
102		219
103	The interval between server ticks, in seconds.	220	The interval between server ticks, in seconds.
104		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
105	=item %cf::CFG	232	=item %cf::CFG
106		233
107	Configuration for the server, loaded from C</etc/crossfire/config>, or	234	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
108	from wherever your confdir points to.	235	from wherever your confdir points to.
109		236
		237	=item cf::wait_for_tick, cf::wait_for_tick_begin
		238
		239	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
		240	returns directly I<after> the tick processing (and consequently, can only wake one thread
		241	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
		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.
		259
110	=back	260	=back
111		261
112	=cut	262	=cut
113		263
114	BEGIN {	264	sub error(@) { LOG llevError, join "", @_ }
115	*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 {
116	my $msg = join "", @_;	271	my $msg = join "", @_;
117	utf8::encode $msg;
118		272
119	$msg .= "\n"	273	$msg .= "\n"
120	unless $msg =~ /\n$/;	274	unless $msg =~ /\n$/;
121		275
122	LOG llevError, "cfperl: $msg";	276	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
123	};	277
124	}	278	LOG llevWarn, $msg;
		279	};
		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	};
125		294
126	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	295	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
127	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	296	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
128	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	297	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
129	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	298	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
130	@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';
131	@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)
132		302
133	# 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
134	# within the Safe compartment.	304	# within the Safe compartment.
135	for my $pkg (qw(	305	for my $pkg (qw(
136	cf::global cf::attachable	306	cf::global cf::attachable
137	cf::object cf::object::player	307	cf::object cf::object::player
138	cf::client cf::player	308	cf::client cf::player
139	cf::arch cf::living	309	cf::arch cf::living
		310	cf::map cf::mapspace
140	cf::map cf::party cf::region	311	cf::party cf::region
141	)) {	312	)) {
142	no strict 'refs';
143	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	313	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
144	}	314	}
145		315
146	$Event::DIED = sub {	316	$EV::DIED = sub {
147	warn "error in event callback: @_";	317	Carp::cluck "error in event callback: @_";
148	};	318	};
149		319
150	my %ext_pkg;	320	#############################################################################
151	my @exts;	321
152	my @hook;	322	sub fork_call(&@);
		323	sub get_slot($;$$);
		324
		325	#############################################################################
153		326
154	=head2 UTILITY FUNCTIONS	327	=head2 UTILITY FUNCTIONS
155		328
156	=over 4	329	=over 4
157		330
158	=cut	331	=item dumpval $ref
159		332
160	use JSON::Syck (); # TODO# replace by JSON::PC once working	333	=cut
161		334
		335	sub dumpval {
		336	eval {
		337	local $SIG{__DIE__};
		338	my $d;
		339	if (1) {
		340	$d = new Data::Dumper([$_[0]], ["*var"]);
		341	$d->Terse(1);
		342	$d->Indent(2);
		343	$d->Quotekeys(0);
		344	$d->Useqq(1);
		345	#$d->Bless(...);
		346	$d->Seen($_[1]) if @_ > 1;
		347	$d = $d->Dump();
		348	}
		349	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		350	$d
		351	} || "[unable to dump $_[0]: '$@']";
		352	}
		353
		354	=item $scalar = load_file $path
		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
162	=item $ref = cf::from_json $json	368	=item $ref = cf::decode_json $json
163		369
164	Converts a JSON string into the corresponding perl data structure.	370	Converts a JSON string into the corresponding perl data structure.
165		371
166	=cut
167
168	sub from_json($) {
169	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
170	JSON::Syck::Load $_[0]
171	}
172
173	=item $json = cf::to_json $ref	372	=item $json = cf::encode_json $ref
174		373
175	Converts a perl data structure into its JSON representation.	374	Converts a perl data structure into its JSON representation.
176		375
177	=cut	376	=cut
178		377
179	sub to_json($) {	378	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
180	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
181	JSON::Syck::Dump $_[0]
182	}
183		379
184	=item my $guard = cf::guard { BLOCK }	380	sub encode_json($) { $json_coder->encode ($_[0]) }
		381	sub decode_json($) { $json_coder->decode ($_[0]) }
185		382
186	Run the given callback when the guard object gets destroyed (useful for	383	=item $ref = cf::decode_storable $scalar
187	coroutine cancellations).
188		384
189	You can call C<< ->cancel >> on the guard object to stop the block from	385	Same as Coro::Storable::thaw, so blocks.
190	being executed.
191		386
192	=cut	387	=cut
193		388
194	sub guard(&) {	389	BEGIN { *decode_storable = \&Coro::Storable::thaw }
195	bless \(my $cb = $_[0]), cf::guard::;
196	}
197		390
198	sub cf::guard::cancel {	391	=item $ref = cf::decode_yaml $scalar
199	${$_[0]} = sub { };
200	}
201		392
202	sub cf::guard::DESTROY {	393	Same as YAML::XS::Load, but doesn't leak, because it forks (and thus blocks).
203	${$_[0]}->();	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	}
204	}	443	}
205		444
206	=item cf::lock_wait $string	445	=item cf::lock_wait $string
207		446
208	Wait until the given lock is available. See cf::lock_acquire.	447	Wait until the given lock is available. See cf::lock_acquire.
209		448
210	=item my $lock = cf::lock_acquire $string	449	=item my $lock = cf::lock_acquire $string
211		450
212	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
213	a 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,
214	for example when the coroutine gets canceled), the lock is automatically	453	for example when the coroutine gets canceled), the lock is automatically
215	returned.	454	returned.
216		455
		456	Locks are *not* recursive, locking from the same coro twice results in a
		457	deadlocked coro.
		458
217	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
218	uses map_find and cf::map::load uses map_load).	460	uses map_find and cf::map::load uses map_load).
219		461
220	=cut	462	=item $locked = cf::lock_active $string
221		463
222	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;
223		469
224	sub lock_wait($) {	470	sub lock_wait($) {
225	my ($key) = @_;	471	$LOCKS->wait ($_[0]);
226
227	# wait for lock, if any
228	while ($LOCK{$key}) {
229	push @{ $LOCK{$key} }, $Coro::current;
230	Coro::schedule;
231	}
232	}	472	}
233		473
234	sub lock_acquire($) {	474	sub lock_acquire($) {
235	my ($key) = @_;	475	$LOCKS->guard ($_[0])
		476	}
236		477
237	# wait, to be sure we are not locked	478	sub lock_active($) {
238	lock_wait $key;	479	$LOCKS->count ($_[0]) < 1
		480	}
239		481
240	$LOCK{$key} = [];	482	sub freeze_mainloop {
		483	tick_inhibit_inc;
241		484
242	cf::guard {	485	&Guard::guard (\&tick_inhibit_dec);
243	# wake up all waiters, to be on the safe side	486	}
244	$_->ready for @{ delete $LOCK{$key} };	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	}
245	}	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;
246	}	572	}
247		573
248	=item cf::async { BLOCK }	574	=item cf::async { BLOCK }
249		575
250	Like C<Coro::async>, but runs the given BLOCK in an eval and only logs the	576	Currently the same as Coro::async_pool, meaning you cannot use
251	error instead of exiting the server in case of a problem.	577	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		578	thing you are allowed to do is call C<prio> on it.
252		579
253	=cut	580	=cut
254		581
255	sub async(&) {	582	BEGIN { *async = \&Coro::async_pool }
256	my ($cb) = @_;
257
258	Coro::async {
259	eval { $cb->() };
260	warn $@ if $@;
261	}
262	}
263
264	sub freeze_mainloop {
265	return unless $TICK_WATCHER->is_active;
266
267	my $guard = guard { $TICK_WATCHER->start };
268	$TICK_WATCHER->stop;
269	$guard
270	}
271		583
272	=item cf::sync_job { BLOCK }	584	=item cf::sync_job { BLOCK }
273		585
274	The design of crossfire+ requires that the main coro ($Coro::main) is	586	The design of Deliantra requires that the main coroutine ($Coro::main)
275	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
276	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.
277		590
278	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
279	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
280	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
281	fast or be very important.	594	fast or be very important.
…		…
283	=cut	596	=cut
284		597
285	sub sync_job(&) {	598	sub sync_job(&) {
286	my ($job) = @_;	599	my ($job) = @_;
287		600
288	if ($Coro::current == $Coro::main) {	601	if (in_main) {
		602	my $time = AE::time;
		603
289	# this is the main coro, too bad, we have to block	604	# this is the main coro, too bad, we have to block
290	# till the operation succeeds, freezing the server :/	605	# till the operation succeeds, freezing the server :/
291		606
292	# TODO: use suspend/resume instead	607	#LOG llevError, Carp::longmess "sync job";#d#
293	# (but this is cancel-safe)	608
294	my $freeze_guard = freeze_mainloop;	609	my $freeze_guard = freeze_mainloop;
295		610
296	my $busy = 1;	611	my $busy = 1;
297	my @res;	612	my @res;
298		613
299	(Coro::async {	614	(async {
		615	$Coro::current->desc ("sync job coro");
300	@res = eval { $job->() };	616	@res = eval { $job->() };
301	warn $@ if $@;	617	error $@ if $@;
302	undef $busy;	618	undef $busy;
303	})->prio (Coro::PRIO_MAX);	619	})->prio (Coro::PRIO_MAX);
304		620
305	while ($busy) {	621	while ($busy) {
		622	if (Coro::nready) {
306	Coro::cede_notself;	623	Coro::cede_notself;
307	Event::one_event unless Coro::nready;	624	} else {
		625	EV::loop EV::LOOP_ONESHOT;
308	}	626	}
		627	}
		628
		629	my $time = AE::time - $time;
		630
		631	$TICK_START += $time; # do not account sync jobs to server load
309		632
310	wantarray ? @res : $res[0]	633	wantarray ? @res : $res[0]
311	} else {	634	} else {
312	# we are in another coroutine, how wonderful, everything just works	635	# we are in another coroutine, how wonderful, everything just works
313		636
314	$job->()	637	$job->()
315	}	638	}
316	}	639	}
317		640
318	=item $coro = cf::coro { BLOCK }	641	=item $coro = cf::async_ext { BLOCK }
319		642
320	Creates and returns a new coro. This coro is automcatially being canceled	643	Like async, but this coro is automatically being canceled when the
321	when the extension calling this is being unloaded.	644	extension calling this is being unloaded.
322		645
323	=cut	646	=cut
324		647
325	sub coro(&) {	648	sub async_ext(&) {
326	my $cb = shift;	649	my $cb = shift;
327		650
328	my $coro = &cf::async ($cb);	651	my $coro = &Coro::async ($cb);
329		652
330	$coro->on_destroy (sub {	653	$coro->on_destroy (sub {
331	delete $EXT_CORO{$coro+0};	654	delete $EXT_CORO{$coro+0};
332	});	655	});
333	$EXT_CORO{$coro+0} = $coro;	656	$EXT_CORO{$coro+0} = $coro;
334		657
335	$coro	658	$coro
336	}	659	}
337		660
338	sub write_runtime {	661	=item fork_call { }, @args
339	my $runtime = cf::localdir . "/runtime";
340		662
341	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	663	Executes the given code block with the given arguments in a seperate
342	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.
343		667
344	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	668	=cut
345	(aio_write $fh, 0, (length $value), $value, 0) <= 0
346	and return;
347		669
348	aio_fsync $fh	670	sub post_fork {
349	and return;	671	reset_signals;
		672	}
350		673
351	close $fh	674	sub fork_call(&@) {
352	or return;	675	my ($cb, @args) = @_;
353		676
354	aio_rename "$runtime~", $runtime	677	# we seemingly have to make a local copy of the whole thing,
355	and return;	678	# otherwise perl prematurely frees the stuff :/
		679	# TODO: investigate and fix (likely this will be rather laborious)
356		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 {
357	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 });
358	}	864	}
359		865
360	=back	866	=back
361		867
362	=cut	868	=cut
363		869
364	#############################################################################	870	#############################################################################
365		871
366	package cf::path;
367
368	sub new {
369	my ($class, $path, $base) = @_;
370
371	$path = $path->as_string if ref $path;
372
373	my $self = bless { }, $class;
374
375	# {... are special paths that are not touched
376	# ?xxx/... are special absolute paths
377	# ?random/... random maps
378	# /! non-realised random map exit
379	# /... normal maps
380	# ~/... per-player maps without a specific player (DO NOT USE)
381	# ~user/... per-player map of a specific user
382
383	if ($path =~ /^{/) {
384	# fine as it is
385	} elsif ($path =~ s{^\?random/}{}) {
386	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
387	$self->{random} = cf::from_json $data;
388	} else {
389	if ($path =~ s{^~([^/]+)?}{}) {
390	$self->{user_rel} = 1;
391
392	if (defined $1) {
393	$self->{user} = $1;
394	} elsif ($base =~ m{^~([^/]+)/}) {
395	$self->{user} = $1;
396	} else {
397	warn "cannot resolve user-relative path without user <$path,$base>\n";
398	}
399	} elsif ($path =~ /^\//) {
400	# already absolute
401	} else {
402	$base =~ s{[^/]+/?$}{};
403	return $class->new ("$base/$path");
404	}
405
406	for ($path) {
407	redo if s{/\.?/}{/};
408	redo if s{/[^/]+/\.\./}{/};
409	}
410	}
411
412	$self->{path} = $path;
413
414	$self
415	}
416
417	# the name / primary key / in-game path
418	sub as_string {
419	my ($self) = @_;
420
421	$self->{user_rel} ? "~$self->{user}$self->{path}"
422	: $self->{random} ? "?random/$self->{path}"
423	: $self->{path}
424	}
425
426	# the displayed name, this is a one way mapping
427	sub visible_name {
428	my ($self) = @_;
429
430	# if (my $rmp = $self->{random}) {
431	# # todo: be more intelligent about this
432	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
433	# } else {
434	$self->as_string
435	# }
436	}
437
438	# escape the /'s in the path
439	sub _escaped_path {
440	# ∕ is U+2215
441	(my $path = $_[0]{path}) =~ s/\//∕/g;
442	$path
443	}
444
445	# the original (read-only) location
446	sub load_path {
447	my ($self) = @_;
448
449	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
450	}
451
452	# the temporary/swap location
453	sub save_path {
454	my ($self) = @_;
455
456	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
457	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
458	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
459	}
460
461	# the unique path, might be eq to save_path
462	sub uniq_path {
463	my ($self) = @_;
464
465	$self->{user_rel} || $self->{random}
466	? undef
467	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
468	}
469
470	# return random map parameters, or undef
471	sub random_map_params {
472	my ($self) = @_;
473
474	$self->{random}
475	}
476
477	# this is somewhat ugly, but style maps do need special treatment
478	sub is_style_map {
479	$_[0]{path} =~ m{^/styles/}
480	}
481
482	package cf;
483
484	#############################################################################
485
486	=head2 ATTACHABLE OBJECTS	872	=head2 ATTACHABLE OBJECTS
487		873
488	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
489	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")
490	to it. All such attachable objects support the following methods.	876	to it. All such attachable objects support the following methods.
491		877
492	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>
493	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
494	crossfire+).	880	Deliantra).
495		881
496	=over 4	882	=over 4
497		883
498	=item $attachable->attach ($attachment, key => $value...)	884	=item $attachable->attach ($attachment, key => $value...)
499		885
…		…
543	=item cf::CLASS::attachment $name, ...	929	=item cf::CLASS::attachment $name, ...
544		930
545	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
546	given CLASS can refer to this attachment.	932	given CLASS can refer to this attachment.
547		933
548	Some classes such as crossfire maps and objects can specify attachments	934	Some classes such as deliantra maps and objects can specify attachments
549	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.
550		936
551	These calls expect any number of the following handler/hook descriptions:	937	These calls expect any number of the following handler/hook descriptions:
552		938
553	=over 4	939	=over 4
…		…
613	our @CB_TYPE = (); # registry for type (cf-object class) based events	999	our @CB_TYPE = (); # registry for type (cf-object class) based events
614	our @CB_MAP = ();	1000	our @CB_MAP = ();
615		1001
616	my %attachment;	1002	my %attachment;
617		1003
		1004	sub cf::attachable::thawer_merge {
		1005	# simply override everything except _meta
		1006	local $_[0]{_meta};
		1007	%{$_[0]} = %{$_[1]};
		1008	}
		1009
618	sub _attach_cb($$$$) {	1010	sub _attach_cb($$$$) {
619	my ($registry, $event, $prio, $cb) = @_;	1011	my ($registry, $event, $prio, $cb) = @_;
620		1012
621	use sort 'stable';	1013	use sort 'stable';
622		1014
…		…
656	$registry = $CB_TYPE[$object_type] ||= [];	1048	$registry = $CB_TYPE[$object_type] ||= [];
657		1049
658	} elsif ($type eq "subtype") {	1050	} elsif ($type eq "subtype") {
659	defined $object_type or Carp::croak "subtype specified without type";	1051	defined $object_type or Carp::croak "subtype specified without type";
660	my $object_subtype = shift @arg;	1052	my $object_subtype = shift @arg;
661	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	1053	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
662		1054
663	} elsif ($type eq "package") {	1055	} elsif ($type eq "package") {
664	my $pkg = shift @arg;	1056	my $pkg = shift @arg;
665		1057
666	while (my ($name, $id) = each %cb_id) {	1058	while (my ($name, $id) = each %cb_id) {
…		…
671		1063
672	} elsif (exists $cb_id{$type}) {	1064	} elsif (exists $cb_id{$type}) {
673	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;	1065	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
674		1066
675	} elsif (ref $type) {	1067	} elsif (ref $type) {
676	warn "attaching objects not supported, ignoring.\n";	1068	error "attaching objects not supported, ignoring.\n";
677		1069
678	} else {	1070	} else {
679	shift @arg;	1071	shift @arg;
680	warn "attach argument '$type' not supported, ignoring.\n";	1072	error "attach argument '$type' not supported, ignoring.\n";
681	}	1073	}
682	}	1074	}
683	}	1075	}
684		1076
685	sub _object_attach {	1077	sub _object_attach {
…		…
695	_attach $registry, $klass, @attach;	1087	_attach $registry, $klass, @attach;
696	}	1088	}
697		1089
698	$obj->{$name} = \%arg;	1090	$obj->{$name} = \%arg;
699	} else {	1091	} else {
700	warn "object uses attachment '$name' that is not available, postponing.\n";	1092	info "object uses attachment '$name' which is not available, postponing.\n";
701	}	1093	}
702		1094
703	$obj->{_attachment}{$name} = undef;	1095	$obj->{_attachment}{$name} = undef;
704	}	1096	}
705		1097
…		…
707	if (ref $_[0]) {	1099	if (ref $_[0]) {
708	_object_attach @_;	1100	_object_attach @_;
709	} else {	1101	} else {
710	_attach shift->_attach_registry, @_;	1102	_attach shift->_attach_registry, @_;
711	}	1103	}
		1104	_recalc_want;
712	};	1105	};
713		1106
714	# all those should be optimised	1107	# all those should be optimised
715	sub cf::attachable::detach {	1108	sub cf::attachable::detach {
716	my ($obj, $name) = @_;	1109	my ($obj, $name) = @_;
…		…
719	delete $obj->{_attachment}{$name};	1112	delete $obj->{_attachment}{$name};
720	reattach ($obj);	1113	reattach ($obj);
721	} else {	1114	} else {
722	Carp::croak "cannot, currently, detach class attachments";	1115	Carp::croak "cannot, currently, detach class attachments";
723	}	1116	}
		1117	_recalc_want;
724	};	1118	};
725		1119
726	sub cf::attachable::attached {	1120	sub cf::attachable::attached {
727	my ($obj, $name) = @_;	1121	my ($obj, $name) = @_;
728		1122
…		…
743	";	1137	";
744	die if $@;	1138	die if $@;
745	}	1139	}
746		1140
747	our $override;	1141	our $override;
748	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?
749		1143
750	sub override {	1144	sub override {
751	$override = 1;	1145	$override = 1;
752	@invoke_results = ();	1146	@INVOKE_RESULTS = (@_);
753	}	1147	}
754		1148
755	sub do_invoke {	1149	sub do_invoke {
756	my $event = shift;	1150	my $event = shift;
757	my $callbacks = shift;	1151	my $callbacks = shift;
758		1152
759	@invoke_results = ();	1153	@INVOKE_RESULTS = ();
760		1154
761	local $override;	1155	local $override;
762		1156
763	for (@$callbacks) {	1157	for (@$callbacks) {
764	eval { &{$_->[1]} };	1158	eval { &{$_->[1]} };
765		1159
766	if ($@) {	1160	if ($@) {
767	warn "$@";
768	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";	1161	error "$@", "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
769	override;	1162	override;
770	}	1163	}
771		1164
772	return 1 if $override;	1165	return 1 if $override;
773	}	1166	}
774		1167
775	0	1168	0
776	}	1169	}
777		1170
778	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1171	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
779		1172
780	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1173	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
781		1174
782	Generate an object-specific event with the given arguments.	1175	Generate an object-specific event with the given arguments.
783		1176
784	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
785	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
786	results (if you must, access C<@cf::invoke_results> directly).	1179	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
787		1180
788	=back	1181	=back
789		1182
790	=cut	1183	=cut
791		1184
792	#############################################################################	1185	#############################################################################
793	# 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	}
794		1229
795	sub reattach {	1230	sub reattach {
796	# basically do the same as instantiate, without calling instantiate	1231	# basically do the same as instantiate, without calling instantiate
797	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
798		1236
799	my $registry = $obj->registry;	1237	my $registry = $obj->registry;
800		1238
801	@$registry = ();	1239	@$registry = ();
802		1240
…		…
807	for (@$attach) {	1245	for (@$attach) {
808	my ($klass, @attach) = @$_;	1246	my ($klass, @attach) = @$_;
809	_attach $registry, $klass, @attach;	1247	_attach $registry, $klass, @attach;
810	}	1248	}
811	} else {	1249	} else {
812	warn "object uses attachment '$name' that is not available, postponing.\n";	1250	info "object uses attachment '$name' that is not available, postponing.\n";
813	}	1251	}
814	}	1252	}
815	}	1253	}
816		1254
817	cf::attachable->attach (	1255	cf::attachable->attach (
818	prio => -1000000,	1256	prio => -1000000,
819	on_instantiate => sub {	1257	on_instantiate => sub {
820	my ($obj, $data) = @_;	1258	my ($obj, $data) = @_;
821		1259
822	$data = from_json $data;	1260	$data = decode_json $data;
823		1261
824	for (@$data) {	1262	for (@$data) {
825	my ($name, $args) = @$_;	1263	my ($name, $args) = @$_;
826		1264
827	$obj->attach ($name, %{$args || {} });	1265	$obj->attach ($name, %{$args || {} });
…		…
843	sub object_freezer_save {	1281	sub object_freezer_save {
844	my ($filename, $rdata, $objs) = @_;	1282	my ($filename, $rdata, $objs) = @_;
845		1283
846	sync_job {	1284	sync_job {
847	if (length $$rdata) {	1285	if (length $$rdata) {
		1286	utf8::decode (my $decname = $filename);
848	warn sprintf "saving %s (%d,%d)\n",	1287	trace sprintf "saving %s (%d,%d)\n",
849	$filename, length $$rdata, scalar @$objs;	1288	$decname, length $$rdata, scalar @$objs
		1289	if $VERBOSE_IO;
850		1290
851	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1291	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
852	chmod SAVE_MODE, $fh;	1292	aio_chmod $fh, SAVE_MODE;
853	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;
854	aio_fsync $fh;	1296	aio_fsync $fh;
		1297	}
855	close $fh;	1298	aio_close $fh;
856		1299
857	if (@$objs) {	1300	if (@$objs) {
858	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) {
859	chmod SAVE_MODE, $fh;	1302	aio_chmod $fh, SAVE_MODE;
860	my $data = Storable::nfreeze { version => 1, objs => $objs };	1303	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
861	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;
862	aio_fsync $fh;	1307	aio_fsync $fh;
		1308	}
863	close $fh;	1309	aio_close $fh;
864	aio_rename "$filename.pst~", "$filename.pst";	1310	aio_rename "$filename.pst~", "$filename.pst";
865	}	1311	}
866	} else {	1312	} else {
867	aio_unlink "$filename.pst";	1313	aio_unlink "$filename.pst";
868	}	1314	}
869		1315
870	aio_rename "$filename~", $filename;	1316	aio_rename "$filename~", $filename;
		1317
		1318	$filename =~ s%/[^/]+$%%;
		1319	aio_pathsync $filename if $cf::USE_FSYNC;
871	} else {	1320	} else {
872	warn "FATAL: $filename~: $!\n";	1321	error "unable to save objects: $filename~: $!\n";
873	}	1322	}
874	} else {	1323	} else {
875	aio_unlink $filename;	1324	aio_unlink $filename;
876	aio_unlink "$filename.pst";	1325	aio_unlink "$filename.pst";
877	}	1326	}
878	}	1327	};
879	}	1328	}
880		1329
881	sub object_freezer_as_string {	1330	sub object_freezer_as_string {
882	my ($rdata, $objs) = @_;	1331	my ($rdata, $objs) = @_;
883		1332
…		…
895	or return;	1344	or return;
896		1345
897	unless (aio_stat "$filename.pst") {	1346	unless (aio_stat "$filename.pst") {
898	(aio_load "$filename.pst", $av) >= 0	1347	(aio_load "$filename.pst", $av) >= 0
899	or return;	1348	or return;
		1349
900	$av = eval { (Storable::thaw $av)->{objs} };	1350	my $st = eval { Coro::Storable::thaw $av };
		1351	$av = $st->{objs};
901	}	1352	}
902		1353
		1354	utf8::decode (my $decname = $filename);
903	warn sprintf "loading %s (%d)\n",	1355	trace sprintf "loading %s (%d,%d)\n",
904	$filename, length $data, scalar @{$av || []};#d#	1356	$decname, length $data, scalar @{$av || []}
		1357	if $VERBOSE_IO;
		1358
905	return ($data, $av);	1359	($data, $av)
906	}	1360	}
		1361
		1362	=head2 COMMAND CALLBACKS
		1363
		1364	=over 4
		1365
		1366	=cut
907		1367
908	#############################################################################	1368	#############################################################################
909	# command handling &c	1369	# command handling &c
910		1370
911	=item cf::register_command $name => \&callback($ob,$args);	1371	=item cf::register_command $name => \&callback($ob,$args);
…		…
924	push @{ $COMMAND{$name} }, [$caller, $cb];	1384	push @{ $COMMAND{$name} }, [$caller, $cb];
925	}	1385	}
926		1386
927	=item cf::register_extcmd $name => \&callback($pl,$packet);	1387	=item cf::register_extcmd $name => \&callback($pl,$packet);
928		1388
929	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.
930		1394
931	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
932	called.	1396	called.
933		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
934	=cut	1409	=cut
935		1410
936	sub register_extcmd {	1411	sub register_extcmd {
937	my ($name, $cb) = @_;	1412	my ($name, $cb) = @_;
938		1413
939	my $caller = caller;
940	#warn "registering extcmd '$name' to '$caller'";
941
942	$EXTCMD{$name} = [$cb, $caller];	1414	$EXTCMD{$name} = $cb;
943	}	1415	}
		1416
		1417	sub register_exticmd {
		1418	my ($name, $cb) = @_;
		1419
		1420	$EXTICMD{$name} = $cb;
		1421	}
		1422
		1423	use File::Glob ();
944		1424
945	cf::player->attach (	1425	cf::player->attach (
946	on_command => sub {	1426	on_unknown_command => sub {
947	my ($pl, $name, $params) = @_;	1427	my ($pl, $name, $params) = @_;
948		1428
949	my $cb = $COMMAND{$name}	1429	my $cb = $COMMAND{$name}
950	or return;	1430	or return;
951		1431
…		…
956	cf::override;	1436	cf::override;
957	},	1437	},
958	on_extcmd => sub {	1438	on_extcmd => sub {
959	my ($pl, $buf) = @_;	1439	my ($pl, $buf) = @_;
960		1440
961	my $msg = eval { from_json $buf };	1441	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
962		1442
963	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
964	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1451	if (my $cb = $EXTCMD{$type}) {
965	if (my %reply = $cb->[0]->($pl, $msg)) {	1452	@reply = $cb->($pl, @payload);
966	$pl->ext_reply ($msg->{msgid}, %reply);
967	}
968	}	1453	}
		1454
		1455	$pl->ext_reply ($reply, @reply)
		1456	if $reply;
		1457
969	} else {	1458	} else {
970	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1459	error "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
971	}	1460	}
972		1461
973	cf::override;	1462	cf::override;
974	},	1463	},
975	);	1464	);
976		1465
977	sub register {	1466	# "readahead" all extensions
978	my ($base, $pkg) = @_;
979
980	#TODO
981	}
982
983	sub load_extension {	1467	sub cache_extensions {
984	my ($path) = @_;	1468	my $grp = IO::AIO::aio_group;
985		1469
986	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1470	add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
987	my $base = $1;	1471	for (grep /\.ext$/, @{$_[0]}) {
988	my $pkg = $1;	1472	add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
989	$pkg =~ s/[^[:word:]]/_/g;
990	$pkg = "ext::$pkg";
991
992	warn "loading '$path' into '$pkg'\n";
993
994	open my $fh, "<:utf8", $path
995	or die "$path: $!";
996
997	my $source =
998	"package $pkg; use strict; use utf8;\n"
999	. "#line 1 \"$path\"\n{\n"
1000	. (do { local $/; <$fh> })
1001	. "\n};\n1";
1002
1003	eval $source
1004	or die $@ ? "$path: $@\n"
1005	: "extension disabled.\n";
1006
1007	push @exts, $pkg;
1008	$ext_pkg{$base} = $pkg;
1009
1010	# no strict 'refs';
1011	# @{"$pkg\::ISA"} = ext::;
1012
1013	register $base, $pkg;
1014	}
1015
1016	sub unload_extension {
1017	my ($pkg) = @_;
1018
1019	warn "removing extension $pkg\n";
1020
1021	# remove hooks
1022	#TODO
1023	# for my $idx (0 .. $#PLUGIN_EVENT) {
1024	# delete $hook[$idx]{$pkg};
1025	# }
1026
1027	# remove commands
1028	for my $name (keys %COMMAND) {
1029	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1030
1031	if (@cb) {
1032	$COMMAND{$name} = \@cb;
1033	} else {
1034	delete $COMMAND{$name};
1035	}	1473	}
1036	}	1474	};
1037		1475
1038	# remove extcmds	1476	$grp
1039	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1040	delete $EXTCMD{$name};
1041	}
1042
1043	if (my $cb = $pkg->can ("unload")) {
1044	eval {
1045	$cb->($pkg);
1046	1
1047	} or warn "$pkg unloaded, but with errors: $@";
1048	}
1049
1050	Symbol::delete_package $pkg;
1051	}	1477	}
1052		1478
1053	sub load_extensions {	1479	sub load_extensions {
		1480	info "loading extensions...";
		1481
		1482	cf::sync_job {
		1483	my %todo;
		1484
1054	for my $ext (<$LIBDIR/*.ext>) {	1485	for my $path (<$LIBDIR/*.ext>) {
1055	next unless -r $ext;	1486	next unless -r $path;
1056	eval {	1487
1057	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	}
1058	1	1551	}
1059	} 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	}
1060	}	1564	};
1061	}	1565	}
1062		1566
1063	#############################################################################	1567	#############################################################################
1064	# load/save/clean perl data associated with a map
1065		1568
1066	*cf::mapsupport::on_clean = sub {	1569	=back
		1570
		1571	=head2 CORE EXTENSIONS
		1572
		1573	Functions and methods that extend core deliantra objects.
		1574
		1575	=cut
		1576
		1577	package cf::player;
		1578
		1579	use Coro::AIO;
		1580
		1581	=head3 cf::player
		1582
		1583	=over 4
		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
		1599	=item cf::player::find $login
		1600
		1601	Returns the given player object, loading it if necessary (might block).
		1602
		1603	=cut
		1604
		1605	sub playerdir($) {
		1606	"$PLAYERDIR/"
		1607	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		1608	}
		1609
		1610	sub path($) {
		1611	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		1612
		1613	(playerdir $login) . "/playerdata"
		1614	}
		1615
		1616	sub find_active($) {
		1617	$cf::PLAYER{$_[0]}
		1618	and $cf::PLAYER{$_[0]}->active
		1619	and $cf::PLAYER{$_[0]}
		1620	}
		1621
		1622	sub exists($) {
1067	my ($map) = @_;	1623	my ($login) = @_;
1068		1624
1069	my $path = $map->tmpname;	1625	$cf::PLAYER{$login}
1070	defined $path or return;	1626	or !aio_stat path $login
1071
1072	unlink "$path.pst";
1073	};
1074
1075	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1076
1077	#############################################################################
1078	# load/save perl data associated with player->ob objects
1079
1080	sub all_objects(@) {
1081	@_, map all_objects ($_->inv), @_
1082	}	1627	}
1083		1628
1084	# TODO: compatibility cruft, remove when no longer needed	1629	sub find($) {
		1630	return $cf::PLAYER{$_[0]} || do {
		1631	my $login = $_[0];
		1632
		1633	my $guard = cf::lock_acquire "user_find:$login";
		1634
		1635	$cf::PLAYER{$_[0]} || do {
		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
		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;
		1651	$cf::PLAYER{$login} = $pl
		1652	}
		1653	}
		1654	}
		1655
1085	cf::player->attach (	1656	cf::player->attach (
1086	on_load => sub {	1657	on_load => sub {
1087	my ($pl, $path) = @_;	1658	my ($pl, $path) = @_;
1088		1659
1089	for my $o (all_objects $pl->ob) {	1660	# restore slots saved in save, below
1090	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1661	my $slots = delete $pl->{_slots};
1091	$o->set_ob_key_value ("_perl_data");
1092		1662
1093	%$o = %{ Storable::thaw pack "H*", $value };	1663	$pl->ob->current_weapon ($slots->[0]);
1094	}	1664	$pl->combat_ob ($slots->[1]);
1095	}	1665	$pl->ranged_ob ($slots->[2]);
1096	},	1666	},
1097	);	1667	);
1098		1668
1099	#############################################################################	1669	sub save($) {
		1670	my ($pl) = @_;
1100		1671
1101	=head2 CORE EXTENSIONS	1672	return if $pl->{deny_save};
1102		1673
1103	Functions and methods that extend core crossfire objects.	1674	my $path = path $pl;
		1675	my $guard = cf::lock_acquire "user_save:$path";
1104		1676
1105	=head3 cf::player	1677	return if $pl->{deny_save};
		1678
		1679	aio_mkdir playerdir $pl, 0770;
		1680	$pl->{last_save} = $cf::RUNTIME;
		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
		1687	$pl->save_pl ($path);
		1688	cf::cede_to_tick;
		1689	}
		1690
		1691	sub new($) {
		1692	my ($login) = @_;
		1693
		1694	my $self = create;
		1695
		1696	$self->ob->name ($login);
		1697	$self->{deny_save} = 1;
		1698
		1699	$cf::PLAYER{$login} = $self;
		1700
		1701	$self
		1702	}
		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
		1714	=item $pl->quit_character
		1715
		1716	Nukes the player without looking back. If logged in, the connection will
		1717	be destroyed. May block for a long time.
		1718
		1719	=cut
		1720
		1721	sub quit_character {
		1722	my ($pl) = @_;
		1723
		1724	my $name = $pl->ob->name;
		1725
		1726	$pl->{deny_save} = 1;
		1727	$pl->password ("*"); # this should lock out the player until we have nuked the dir
		1728
		1729	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->ns;
		1730	$pl->deactivate;
		1731
		1732	my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
		1733	$pl->invoke (cf::EVENT_PLAYER_QUIT) if $pl->ns;
		1734	ext::highscore::check ($pl->ob);
		1735
		1736	$pl->ns->destroy if $pl->ns;
		1737
		1738	my $path = playerdir $pl;
		1739	my $temp = "$path~$cf::RUNTIME~deleting~";
		1740	aio_rename $path, $temp;
		1741	delete $cf::PLAYER{$pl->ob->name};
		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
		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;
		1764	}
		1765
		1766	=item cf::player::list_logins
		1767
		1768	Returns am arrayref of all valid playernames in the system, can take a
		1769	while and may block, so not sync_job-capable, ever.
		1770
		1771	=cut
		1772
		1773	sub list_logins {
		1774	my $dirs = aio_readdir $PLAYERDIR
		1775	or return [];
		1776
		1777	my @logins;
		1778
		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") {
		1785	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
		1786	aio_read $fh, 0, 512, my $buf, 0 or next;
		1787	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1788	}
		1789
		1790	utf8::decode $login;
		1791	push @logins, $login;
		1792	}
		1793
		1794	\@logins
		1795	}
		1796
		1797	=item $player->maps
		1798
		1799	=item cf::player::maps $login
		1800
		1801	Returns an arrayref of map paths that are private for this
		1802	player. May block.
		1803
		1804	=cut
		1805
		1806	sub maps($) {
		1807	my ($pl) = @_;
		1808
		1809	$pl = ref $pl ? $pl->ob->name : $pl;
		1810
		1811	my $files = aio_readdir playerdir $pl
		1812	or return;
		1813
		1814	my @paths;
		1815
		1816	for (@$files) {
		1817	utf8::decode $_;
		1818	next if /\.(?:pl|pst)$/;
		1819	next unless /^$PATH_SEP/o;
		1820
		1821	push @paths, cf::map::normalise "~$pl/$_";
		1822	}
		1823
		1824	\@paths
		1825	}
		1826
		1827	=item $protocol_xml = $player->expand_cfpod ($cfpod)
		1828
		1829	Expand deliantra pod fragments into protocol xml.
		1830
		1831	=item $player->ext_reply ($msgid, @msg)
		1832
		1833	Sends an ext reply to the player.
		1834
		1835	=cut
		1836
		1837	sub ext_reply($$@) {
		1838	my ($self, $id, @msg) = @_;
		1839
		1840	$self->ns->ext_reply ($id, @msg)
		1841	}
		1842
		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
1106		1856
1107	=over 4	1857	=over 4
1108		1858
1109	=item cf::player::exists $login
1110
1111	Returns true when the given account exists.
1112
1113	=cut	1859	=cut
1114		1860
1115	sub cf::player::exists($) {	1861	package cf::region;
1116	cf::player::find $_[0]
1117	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1118	}
1119		1862
1120	=item $player->ext_reply ($msgid, $msgtype, %msg)	1863	=item cf::region::find_by_path $path
1121		1864
1122	Sends an ext reply to the player.	1865	Tries to decuce the likely region for a map knowing only its path.
1123		1866
1124	=cut	1867	=cut
1125		1868
1126	sub cf::player::ext_reply($$$%) {	1869	sub find_by_path($) {
1127	my ($self, $id, %msg) = @_;	1870	my ($path) = @_;
1128		1871
1129	$msg{msgid} = $id;	1872	$path =~ s/^~[^\/]*//; # skip ~login
1130		1873
1131	$self->send ("ext " . to_json \%msg);	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
1132	}	1884	}
1133		1885
1134	=back	1886	=back
1135
1136		1887
1137	=head3 cf::map	1888	=head3 cf::map
1138		1889
1139	=over 4	1890	=over 4
1140		1891
…		…
1143	package cf::map;	1894	package cf::map;
1144		1895
1145	use Fcntl;	1896	use Fcntl;
1146	use Coro::AIO;	1897	use Coro::AIO;
1147		1898
		1899	use overload
		1900	'""' => \&as_string,
		1901	fallback => 1;
		1902
1148	our $MAX_RESET = 3600;	1903	our $MAX_RESET = 3600;
1149	our $DEFAULT_RESET = 3000;	1904	our $DEFAULT_RESET = 3000;
1150		1905
1151	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 {
1152	my ($path, $rmp) = @_;	1945	my ($path, $base) = @_;
1153		1946
1154	# mit "rum" bekleckern, nicht	1947	$path = "$path"; # make sure it's a string
1155	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
1156	$path,	1991	$path
1157	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1158	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1159	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1160	$rmp->{exit_on_final_map},
1161	$rmp->{xsize}, $rmp->{ysize},
1162	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1163	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1164	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1165	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1166	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1167	(cf::region::find $rmp->{region})
1168	}	1992	}
1169		1993
1170	# and all this just because we cannot iterate over	1994	sub new_from_path {
1171	# all maps in C++...	1995	my (undef, $path, $base) = @_;
1172	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 {
1173	my ($change) = @_;	2016	my ($self) = @_;
1174		2017
1175	$_->change_map_light ($change)	2018	$self
1176	for grep $_->outdoor, values %cf::MAP;
1177	}	2019	}
1178		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
1179	sub try_load_header($) {	2071	sub load_header_from($) {
1180	my ($path) = @_;	2072	my ($self, $path) = @_;
1181		2073
1182	utf8::encode $path;	2074	utf8::encode $path;
1183	aio_open $path, O_RDONLY, 0	2075	my $f = new_from_file cf::object::thawer $path
1184	or return;	2076	or return;
1185		2077
1186	my $map = cf::map::new	2078	$self->_load_header ($f)
1187	or return;	2079	or return;
1188		2080
1189	$map->load_header ($path)	2081	local $MAP_LOADING{$self->{path}} = $self;
		2082	$f->resolve_delayed_derefs;
		2083
		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
1190	or return;	2131	or return;
		2132	$self->prepare_orig;
		2133	}
1191		2134
1192	$map->{load_path} = $path;	2135	$self->{deny_reset} = 1
		2136	if $self->no_reset;
1193		2137
1194	$map	2138	$self->default_region (cf::region::find_by_path $self->{path})
		2139	unless $self->default_region;
		2140
		2141	1
1195	}	2142	}
1196		2143
1197	sub find;	2144	sub find;
1198	sub find {	2145	sub find {
1199	my ($path, $origin) = @_;	2146	my ($path, $origin) = @_;
1200		2147
1201	#warn "find<$path,$origin>\n";#d#	2148	cf::cede_to_tick;
1202		2149
1203	$path = new cf::path $path, $origin && $origin->path;	2150	$path = normalise $path, $origin;
1204	my $key = $path->as_string;
1205		2151
1206	cf::lock_wait "map_find:$key";	2152	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1207
1208	$cf::MAP{$key} || do {
1209	my $guard = cf::lock_acquire "map_find:$key";	2153	my $guard2 = cf::lock_acquire "map_find:$path";
1210		2154
1211	# do it the slow way	2155	$cf::MAP{$path} || do {
1212	my $map = try_load_header $path->save_path;	2156	my $map = new_from_path cf::map $path
1213
1214	if ($map) {
1215	$map->last_access ((delete $map->{last_access})
1216	|| $cf::RUNTIME); #d#
1217	# safety
1218	$map->{instantiate_time} = $cf::RUNTIME
1219	if $map->{instantiate_time} > $cf::RUNTIME;
1220	} else {
1221	if (my $rmp = $path->random_map_params) {
1222	$map = generate_random_map $key, $rmp;
1223	} else {
1224	$map = try_load_header $path->load_path;
1225	}
1226
1227	$map or return;	2157	or return;
1228		2158
1229	$map->{load_original} = 1;
1230	$map->{instantiate_time} = $cf::RUNTIME;
1231	$map->last_access ($cf::RUNTIME);
1232	$map->instantiate;
1233
1234	# per-player maps become, after loading, normal maps
1235	$map->per_player (0) if $path->{user_rel};
1236	}
1237
1238	$map->path ($key);
1239	$map->{path} = $path;
1240	$map->{last_save} = $cf::RUNTIME;	2159	$map->{last_save} = $cf::RUNTIME;
1241		2160
1242	if ($map->should_reset) {	2161	$map->load_header
		2162	or return;
		2163
		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;
1243	$map->reset;	2169	$map->reset;
1244	undef $guard;
1245	$map = find $path	2170	return find $path;
1246	or return;
1247	}	2171	}
1248		2172
1249	$cf::MAP{$key} = $map	2173	$cf::MAP{$path} = $map
1250	}	2174	}
1251	}	2175	}
		2176
		2177	sub pre_load { }
		2178	#sub post_load { } # XS
1252		2179
1253	sub load {	2180	sub load {
1254	my ($self) = @_;	2181	my ($self) = @_;
1255		2182
		2183	local $self->{deny_reset} = 1; # loading can take a long time
		2184
1256	my $path = $self->{path};	2185	my $path = $self->{path};
		2186
		2187	{
1257	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	2188	my $guard = cf::lock_acquire "map_data:$path";
1258		2189
		2190	return unless $self->valid;
1259	return if $self->in_memory != cf::MAP_SWAPPED;	2191	return unless $self->in_memory == cf::MAP_SWAPPED;
1260		2192
1261	$self->in_memory (cf::MAP_LOADING);	2193	$self->in_memory (cf::MAP_LOADING);
1262		2194
1263	$self->alloc;	2195	$self->alloc;
1264	$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)
1265	or return;	2204	or return;
1266		2205
1267	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2206	$self->post_load_original
1268	if delete $self->{load_original};	2207	if delete $self->{load_original};
1269		2208
1270	if (my $uniq = $path->uniq_path) {	2209	if (my $uniq = $self->uniq_path) {
1271	utf8::encode $uniq;	2210	utf8::encode $uniq;
1272	if (aio_open $uniq, O_RDONLY, 0) {	2211	unless (aio_stat $uniq) {
		2212	if (my $f = new_from_file cf::object::thawer $uniq) {
1273	$self->clear_unique_items;	2213	$self->clear_unique_items;
1274	$self->load_objects ($uniq, 0);	2214	$self->_load_objects ($f);
		2215	$f->resolve_delayed_derefs;
		2216	}
		2217	}
1275	}	2218	}
1276	}
1277		2219
		2220	$f->resolve_delayed_derefs;
		2221	} else {
		2222	$self->post_load_original
		2223	if delete $self->{load_original};
		2224	}
		2225
		2226	cf::cede_to_tick;
1278	# now do the right thing for maps	2227	# now do the right thing for maps
1279	$self->link_multipart_objects;	2228	$self->link_multipart_objects;
1280
1281	if ($self->{path}->is_style_map) {
1282	$self->{deny_save} = 1;
1283	$self->{deny_reset} = 1;
1284	} else {
1285	$self->fix_auto_apply;
1286	$self->decay_objects;
1287	$self->update_buttons;
1288	$self->set_darkness_map;
1289	$self->difficulty ($self->estimate_difficulty)	2229	$self->difficulty ($self->estimate_difficulty)
1290	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;
1291	$self->activate;	2238	$self->activate;
1292	}	2239	}
1293		2240
		2241	$self->{last_save} = $cf::RUNTIME;
		2242	$self->last_access ($cf::RUNTIME);
		2243
1294	$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
		2265	}
		2266
		2267	# find and load all maps in the 3x3 area around a map
		2268	sub load_neighbours {
		2269	my ($map) = @_;
		2270
		2271	my @neigh; # diagonal neighbours
		2272
		2273	for (0 .. 3) {
		2274	my $neigh = $map->tile_path ($_)
		2275	or next;
		2276	$neigh = find $neigh, $map
		2277	or next;
		2278	$neigh->load;
		2279
		2280	# now find the diagonal neighbours
		2281	push @neigh,
		2282	[$neigh->tile_path (($_ + 3) % 4), $neigh],
		2283	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		2284	}
		2285
		2286	for (grep defined $_->[0], @neigh) {
		2287	my ($path, $origin) = @$_;
		2288	my $neigh = find $path, $origin
		2289	or next;
		2290	$neigh->load;
		2291	}
1295	}	2292	}
1296		2293
1297	sub find_sync {	2294	sub find_sync {
1298	my ($path, $origin) = @_;	2295	my ($path, $origin) = @_;
1299		2296
1300	cf::sync_job { cf::map::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
1301	}	2301	}
1302		2302
1303	sub do_load_sync {	2303	sub do_load_sync {
1304	my ($map) = @_;	2304	my ($map) = @_;
1305		2305
1306	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;
		2310	}
		2311
		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
		2326	$MAP_PREFETCHER ||= cf::async {
		2327	$Coro::current->{desc} = "map prefetcher";
		2328
		2329	while (%MAP_PREFETCH) {
		2330	while (my ($k, $v) = each %MAP_PREFETCH) {
		2331	if (my $map = find $k) {
		2332	$map->load if $v;
		2333	}
		2334
		2335	delete $MAP_PREFETCH{$k};
		2336	}
		2337	}
		2338	undef $MAP_PREFETCHER;
		2339	};
		2340	$MAP_PREFETCHER->prio (6);
		2341
		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	}
1307	}	2375	}
1308		2376
1309	sub save {	2377	sub save {
1310	my ($self) = @_;	2378	my ($self) = @_;
1311		2379
1312	$self->{last_save} = $cf::RUNTIME;	2380	my $lock = cf::lock_acquire "map_data:$self->{path}";
1313		2381
1314	return unless $self->dirty;	2382	$self->_save;
1315
1316	my $save = $self->{path}->save_path; utf8::encode $save;
1317	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
1318
1319	$self->{load_path} = $save;
1320
1321	return if $self->{deny_save};
1322
1323	local $self->{last_access} = $self->last_access;#d#
1324
1325	if ($uniq) {
1326	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1327	$self->save_objects ($uniq, cf::IO_UNIQUES);
1328	} else {
1329	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1330	}
1331	}	2383	}
1332		2384
1333	sub swap_out {	2385	sub swap_out {
1334	my ($self) = @_;	2386	my ($self) = @_;
1335		2387
1336	# save first because save cedes	2388	my $lock = cf::lock_acquire "map_data:$self->{path}";
1337	$self->save;
1338		2389
		2390	return if $self->in_memory != cf::MAP_ACTIVE;
		2391	return if $self->{deny_save};
1339	return if $self->players;	2392	return if $self->players;
1340	return if $self->in_memory != cf::MAP_IN_MEMORY;
1341	return if $self->{deny_save};
1342		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
1343	$self->clear;	2403	$self->clear;
1344	$self->in_memory (cf::MAP_SWAPPED);
1345	}	2404	}
1346		2405
1347	sub reset_at {	2406	sub reset_at {
1348	my ($self) = @_;	2407	my ($self) = @_;
1349		2408
1350	# TODO: safety, remove and allow resettable per-player maps	2409	# TODO: safety, remove and allow resettable per-player maps
1351	return 1e99 if $self->{path}{user_rel};
1352	return 1e99 if $self->{deny_reset};	2410	return 1e99 if $self->{deny_reset};
1353		2411
1354	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2412	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1355	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;
1356		2414
…		…
1361	my ($self) = @_;	2419	my ($self) = @_;
1362		2420
1363	$self->reset_at <= $cf::RUNTIME	2421	$self->reset_at <= $cf::RUNTIME
1364	}	2422	}
1365		2423
1366	sub unlink_save {
1367	my ($self) = @_;
1368
1369	utf8::encode (my $save = $self->{path}->save_path);
1370	aioreq_pri 3; IO::AIO::aio_unlink $save;
1371	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1372	}
1373
1374	sub rename {
1375	my ($self, $new_path) = @_;
1376
1377	$self->unlink_save;
1378
1379	delete $cf::MAP{$self->path};
1380	$self->{path} = new cf::path $new_path;
1381	$self->path ($self->{path}->as_string);
1382	$cf::MAP{$self->path} = $self;
1383
1384	$self->save;
1385	}
1386
1387	sub reset {	2424	sub reset {
1388	my ($self) = @_;	2425	my ($self) = @_;
1389		2426
		2427	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2428
1390	return if $self->players;	2429	return if $self->players;
1391	return if $self->{path}{user_rel};#d#
1392		2430
1393	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	}
1394		2442
1395	delete $cf::MAP{$self->path};	2443	delete $cf::MAP{$self->path};
1396		2444
		2445	$self->deactivate;
1397	$_->clear_links_to ($self) for values %cf::MAP;	2446	$_->clear_links_to ($self) for values %cf::MAP;
		2447	$self->clear;
1398		2448
1399	$self->unlink_save;	2449	$self->unlink_save;
1400	$self->destroy;	2450	$self->destroy;
1401	}	2451	}
1402		2452
1403	my $nuke_counter = "aaaa";	2453	my $nuke_counter = "aaaa";
1404		2454
1405	sub nuke {	2455	sub nuke {
1406	my ($self) = @_;	2456	my ($self) = @_;
1407		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};
1408	$self->{deny_save} = 1;	2467	$self->{deny_save} = 1;
1409	$self->reset_timeout (1);	2468	$self->reset_timeout (1);
1410	$self->rename ("{nuke}/" . ($nuke_counter++));	2469	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2470
		2471	$cf::MAP{$self->path} = $self;
		2472	}
		2473
1411	$self->reset; # polite request, might not happen	2474	$self->reset; # polite request, might not happen
1412	}	2475	}
1413		2476
1414	sub customise_for {	2477	=item $maps = cf::map::tmp_maps
1415	my ($map, $ob) = @_;
1416		2478
1417	if ($map->per_player) {	2479	Returns an arrayref with all map paths of currently instantiated and saved
1418	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	2480	maps. May block.
		2481
		2482	=cut
		2483
		2484	sub tmp_maps() {
1419	}	2485	[
1420		2486	map {
1421	$map	2487	utf8::decode $_;
		2488	/\.map$/
		2489	? normalise $_
		2490	: ()
		2491	} @{ aio_readdir $TMPDIR or [] }
		2492	]
1422	}	2493	}
1423		2494
1424	sub emergency_save {	2495	=item $maps = cf::map::random_maps
1425	my $freeze_guard = cf::freeze_mainloop;
1426		2496
1427	warn "enter emergency map save\n";	2497	Returns an arrayref with all map paths of currently instantiated and saved
		2498	random maps. May block.
1428		2499
1429	cf::sync_job {	2500	=cut
1430	warn "begin emergency map save\n";	2501
1431	$_->save for values %cf::MAP;	2502	sub random_maps() {
		2503	[
		2504	map {
		2505	utf8::decode $_;
		2506	/\.map$/
		2507	? normalise "?random/$_"
		2508	: ()
		2509	} @{ aio_readdir $RANDOMDIR or [] }
		2510	]
		2511	}
		2512
		2513	=item cf::map::unique_maps
		2514
		2515	Returns an arrayref of paths of all shared maps that have
		2516	instantiated unique items. May block.
		2517
		2518	=cut
		2519
		2520	sub unique_maps() {
		2521	[
		2522	map {
		2523	utf8::decode $_;
		2524	s/\.map$//; # TODO future compatibility hack
		2525	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
		2526	? ()
		2527	: normalise $_
		2528	} @{ aio_readdir $UNIQUEDIR or [] }
		2529	]
		2530	}
		2531
		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;
1432	};	2559	}
1433		2560
1434	warn "end emergency map save\n";	2561	\@maps
		2562	}
		2563
		2564	=back
		2565
		2566	=head3 cf::object
		2567
		2568	=cut
		2569
		2570	package cf::object;
		2571
		2572	=over 4
		2573
		2574	=item $ob->inv_recursive
		2575
		2576	Returns the inventory of the object I<and> their inventories, recursively,
		2577	but I<not> the object itself.
		2578
		2579	=cut
		2580
		2581	sub inv_recursive_;
		2582	sub inv_recursive_ {
		2583	map { $_, inv_recursive_ $_->inv } @_
		2584	}
		2585
		2586	sub inv_recursive {
		2587	inv_recursive_ inv $_[0]
		2588	}
		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	}
1435	}	2616	}
1436		2617
1437	package cf;	2618	package cf;
1438		2619
1439	=back	2620	=back
1440
1441		2621
1442	=head3 cf::object::player	2622	=head3 cf::object::player
1443		2623
1444	=over 4	2624	=over 4
1445		2625
…		…
1448	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>
1449	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
1450	dialogue with the given NPC character.	2630	dialogue with the given NPC character.
1451		2631
1452	=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	};
1453		2647
1454	# rough implementation of a future "reply" method that works	2648	# rough implementation of a future "reply" method that works
1455	# with dialog boxes.	2649	# with dialog boxes.
1456	#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
1457	sub cf::object::player::reply($$$;$) {	2651	sub cf::object::player::reply($$$;$) {
…		…
1459		2653
1460	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2654	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1461		2655
1462	if ($self->{record_replies}) {	2656	if ($self->{record_replies}) {
1463	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2657	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2658
1464	} 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 {
1465	$msg = $npc->name . " says: $msg" if $npc;	2667	$msg = $npc->name . " says: $msg" if $npc;
1466	$self->message ($msg, $flags);	2668	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2669	}
1467	}	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 (@_);
1468	}	2681	}
1469		2682
1470	=item $player_object->may ("access")	2683	=item $player_object->may ("access")
1471		2684
1472	Returns wether the given player is authorized to access resource "access"	2685	Returns wether the given player is authorized to access resource "access"
…		…
1485		2698
1486	=item $player_object->enter_link	2699	=item $player_object->enter_link
1487		2700
1488	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}>).
1489		2702
1490	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.
1491	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.
1492		2709
1493	=item $player_object->leave_link ($map, $x, $y)	2710	=item $player_object->leave_link ($map, $x, $y)
1494		2711
1495	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
1496	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
1497	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
1498	to the emergency map position.	2715	fails, to the emergency map position.
1499		2716
1500	Might block.	2717	Might block.
1501		2718
1502	=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	}
1503		2730
1504	sub cf::object::player::enter_link {	2731	sub cf::object::player::enter_link {
1505	my ($self) = @_;	2732	my ($self) = @_;
1506		2733
1507	$self->deactivate_recursive;	2734	$self->deactivate_recursive;
1508		2735
1509	return if $self->map == $LINK_MAP;	2736	++$self->{_link_recursion};
		2737
		2738	return if UNIVERSAL::isa $self->map, "ext::map_link";
1510		2739
1511	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2740	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1512	if $self->map;	2741	if $self->map && $self->map->{path} ne "{link}";
1513		2742
1514	$self->enter_map ($LINK_MAP, 20, 20);	2743	$self->enter_map ($LINK_MAP || link_map, 3, 3);
1515	}	2744	}
1516		2745
1517	sub cf::object::player::leave_link {	2746	sub cf::object::player::leave_link {
1518	my ($self, $map, $x, $y) = @_;	2747	my ($self, $map, $x, $y) = @_;
		2748
		2749	return unless $self->contr->active;
1519		2750
1520	my $link_pos = delete $self->{_link_pos};	2751	my $link_pos = delete $self->{_link_pos};
1521		2752
1522	unless ($map) {	2753	unless ($map) {
1523	# restore original map position	2754	# restore original map position
…		…
1534	($x, $y) = (-1, -1)	2765	($x, $y) = (-1, -1)
1535	unless (defined $x) && (defined $y);	2766	unless (defined $x) && (defined $y);
1536		2767
1537	# use -1 or undef as default coordinates, not 0, 0	2768	# use -1 or undef as default coordinates, not 0, 0
1538	($x, $y) = ($map->enter_x, $map->enter_y)	2769	($x, $y) = ($map->enter_x, $map->enter_y)
1539	if $x <=0 && $y <= 0;	2770	if $x <= 0 && $y <= 0;
1540		2771
1541	$map->load;	2772	$map->load;
		2773	$map->load_neighbours;
1542		2774
		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
1543	$self->activate_recursive;	2782	$self->activate_recursive;
1544	$self->enter_map ($map, $x, $y);
1545	}
1546
1547	cf::player->attach (
1548	on_logout => sub {
1549	my ($pl) = @_;
1550
1551	# abort map switching before logout
1552	if ($pl->ob->{_link_pos}) {
1553	cf::sync_job {
1554	$pl->ob->leave_link
1555	};
1556	}
1557	},	2783	}
1558	on_login => sub {
1559	my ($pl) = @_;
1560		2784
1561	# try to abort aborted map switching on player login :)	2785	}
1562	# should happen only on crashes
1563	if ($pl->ob->{_link_pos}) {
1564	$pl->ob->enter_link;
1565	cf::async {
1566	# we need this sleep as the login has a concurrent enter_exit running
1567	# and this sleep increases chances of the player not ending up in scorn
1568	Coro::Timer::sleep 1;
1569	$pl->ob->leave_link;
1570	};
1571	}
1572	},
1573	);
1574		2786
1575	=item $player_object->goto_map ($path, $x, $y)	2787	=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
1576		2788
1577	=cut	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.
1578		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
		2798	=cut
		2799
		2800	our $GOTOGEN;
		2801
1579	sub cf::object::player::goto_map {	2802	sub cf::object::player::goto {
1580	my ($self, $path, $x, $y) = @_;	2803	my ($self, $path, $x, $y, $check, $done) = @_;
		2804
		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;
1581		2813
1582	$self->enter_link;	2814	$self->enter_link;
1583		2815
1584	(cf::async {	2816	(async {
1585	$path = new cf::path $path;	2817	$Coro::current->{desc} = "player::goto $path $x $y";
1586		2818
1587	my $map = cf::map::find $path->as_string;	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) {
1588	$map = $map->customise_for ($self) if $map;	2842	$map = $map->customise_for ($self);
1589		2843	$map = $check->($map, $x, $y, $self) if $check && $map;
1590	# warn "entering ", $map->path, " at ($x, $y)\n"	2844	} else {
1591	# if $map;
1592
1593	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2845	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2846	}
1594		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};
1595	$self->leave_link ($map, $x, $y);	2858	$self->leave_link ($map, $x, $y);
		2859	}
		2860
		2861	$done->($self) if $done;
1596	})->prio (1);	2862	})->prio (1);
1597	}	2863	}
1598		2864
1599	=item $player_object->enter_exit ($exit_object)	2865	=item $player_object->enter_exit ($exit_object)
1600		2866
…		…
1602		2868
1603	sub parse_random_map_params {	2869	sub parse_random_map_params {
1604	my ($spec) = @_;	2870	my ($spec) = @_;
1605		2871
1606	my $rmp = { # defaults	2872	my $rmp = { # defaults
1607	xsize => 10,	2873	xsize => (cf::rndm 15, 40),
1608	ysize => 10,	2874	ysize => (cf::rndm 15, 40),
		2875	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2876	#layout => string,
1609	};	2877	};
1610		2878
1611	for (split /\n/, $spec) {	2879	for (split /\n/, $spec) {
1612	my ($k, $v) = split /\s+/, $_, 2;	2880	my ($k, $v) = split /\s+/, $_, 2;
1613		2881
…		…
1625	# that depends on the exit object	2893	# that depends on the exit object
1626		2894
1627	my $rmp = parse_random_map_params $exit->msg;	2895	my $rmp = parse_random_map_params $exit->msg;
1628		2896
1629	if ($exit->map) {	2897	if ($exit->map) {
1630	$rmp->{region} = $exit->map->region_name;	2898	$rmp->{region} = $exit->region->name;
1631	$rmp->{origin_map} = $exit->map->path;	2899	$rmp->{origin_map} = $exit->map->path;
1632	$rmp->{origin_x} = $exit->x;	2900	$rmp->{origin_x} = $exit->x;
1633	$rmp->{origin_y} = $exit->y;	2901	$rmp->{origin_y} = $exit->y;
		2902
		2903	$exit->map->touch;
1634	}	2904	}
1635		2905
1636	$rmp->{random_seed} ||= $exit->random_seed;	2906	$rmp->{random_seed} ||= $exit->random_seed;
1637		2907
1638	my $data = cf::to_json $rmp;	2908	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1639	my $md5 = Digest::MD5::md5_hex $data;	2909	my $md5 = Digest::MD5::md5_hex $data;
		2910	my $meta = "$RANDOMDIR/$md5.meta";
1640		2911
1641	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) {
1642	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;
1643		2916
		2917	my $slaying = "?random/$md5";
		2918
		2919	if ($exit->valid) {
1644	$exit->slaying ("?random/$md5");	2920	$exit->slaying ("?random/$md5");
1645	$exit->msg (undef);	2921	$exit->msg (undef);
		2922	}
1646	}	2923	}
1647	}	2924	}
1648		2925
1649	sub cf::object::player::enter_exit {	2926	sub cf::object::player::enter_exit {
1650	my ($self, $exit) = @_;	2927	my ($self, $exit) = @_;
1651		2928
1652	return unless $self->type == cf::PLAYER;	2929	return unless $self->type == cf::PLAYER;
1653		2930
1654	$self->enter_link;	2931	$self->enter_link;
1655		2932
1656	(cf::async {	2933	(async {
1657	$self->deactivate_recursive; # just to be sure	2934	$Coro::current->{desc} = "enter_exit";
		2935
1658	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
1659	prepare_random_map $exit	2943	prepare_random_map $exit
1660	if $exit->slaying eq "/!";	2944	if $exit->slaying eq "/!";
		2945	}
1661		2946
1662	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;	2947	my $map = cf::map::normalise $exit->slaying, $exit->map;
1663	$self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);	2948	my $x = $exit->stats->hp;
		2949	my $y = $exit->stats->sp;
1664		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
1665	1;	2957	1
1666	}) {	2958	}) {
1667	$self->message ("Something went wrong deep within the crossfire server. "	2959	$self->message ("Something went wrong deep within the deliantra server. "
1668	. "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. "
1669	. "Please report this to the dungeon master",	2961	. "Please report this to the dungeon master!",
1670	cf::NDI_UNIQUE | cf::NDI_RED);	2962	cf::NDI_UNIQUE | cf::NDI_RED);
1671		2963
1672	warn "ERROR in enter_exit: $@";	2964	error "ERROR in enter_exit: $@";
1673	$self->leave_link;	2965	$self->leave_link;
1674	}	2966	}
1675	})->prio (1);	2967	})->prio (1);
1676	}	2968	}
1677		2969
…		…
1688		2980
1689	sub cf::client::send_drawinfo {	2981	sub cf::client::send_drawinfo {
1690	my ($self, $text, $flags) = @_;	2982	my ($self, $text, $flags) = @_;
1691		2983
1692	utf8::encode $text;	2984	utf8::encode $text;
1693	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2985	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1694	}	2986	}
1695		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	}
1696		3209
1697	=item $success = $client->query ($flags, "text", \&cb)	3210	=item $success = $client->query ($flags, "text", \&cb)
1698		3211
1699	Queues a query to the client, calling the given callback with	3212	Queues a query to the client, calling the given callback with
1700	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>,
1701	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>.
1702		3215
1703	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
1704	reliable at some point in the future.	3217	become reliable at some point in the future.
1705		3218
1706	=cut	3219	=cut
1707		3220
1708	sub cf::client::query {	3221	sub cf::client::query {
1709	my ($self, $flags, $text, $cb) = @_;	3222	my ($self, $flags, $text, $cb) = @_;
…		…
1717	utf8::encode $text;	3230	utf8::encode $text;
1718	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	3231	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1719		3232
1720	$self->send_packet ($self->{query_queue}[0][0])	3233	$self->send_packet ($self->{query_queue}[0][0])
1721	if @{ $self->{query_queue} } == 1;	3234	if @{ $self->{query_queue} } == 1;
		3235
		3236	1
1722	}	3237	}
1723		3238
1724	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	},
1725	on_reply => sub {	3245	on_reply => sub {
1726	my ($ns, $msg) = @_;	3246	my ($ns, $msg) = @_;
1727		3247
1728	# this weird shuffling is so that direct followup queries	3248	# this weird shuffling is so that direct followup queries
1729	# get handled first	3249	# get handled first
1730	my $queue = delete $ns->{query_queue}	3250	my $queue = delete $ns->{query_queue}
1731	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
1732		3252
1733	(shift @$queue)->[1]->($msg);	3253	(shift @$queue)->[1]->($msg);
		3254	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1734		3255
1735	push @{ $ns->{query_queue} }, @$queue;	3256	push @{ $ns->{query_queue} }, @$queue;
1736		3257
1737	if (@{ $ns->{query_queue} } == @$queue) {	3258	if (@{ $ns->{query_queue} } == @$queue) {
1738	if (@$queue) {	3259	if (@$queue) {
…		…
1740	} else {	3261	} else {
1741	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3262	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1742	}	3263	}
1743	}	3264	}
1744	},	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	},
1745	);	3292	);
1746		3293
1747	=item $client->coro (\&cb)	3294	=item $client->async (\&cb)
1748		3295
1749	Create a new coroutine, running the specified callback. The coroutine will	3296	Create a new coroutine, running the specified callback. The coroutine will
1750	be automatically cancelled when the client gets destroyed (e.g. on logout,	3297	be automatically cancelled when the client gets destroyed (e.g. on logout,
1751	or loss of connection).	3298	or loss of connection).
1752		3299
1753	=cut	3300	=cut
1754		3301
1755	sub cf::client::coro {	3302	sub cf::client::async {
1756	my ($self, $cb) = @_;	3303	my ($self, $cb) = @_;
1757		3304
1758	my $coro = &cf::async ($cb);	3305	my $coro = &Coro::async ($cb);
1759		3306
1760	$coro->on_destroy (sub {	3307	$coro->on_destroy (sub {
1761	delete $self->{_coro}{$coro+0};	3308	delete $self->{_coro}{$coro+0};
1762	});	3309	});
1763		3310
…		…
1765		3312
1766	$coro	3313	$coro
1767	}	3314	}
1768		3315
1769	cf::client->attach (	3316	cf::client->attach (
1770	on_destroy => sub {	3317	on_client_destroy => sub {
1771	my ($ns) = @_;	3318	my ($ns) = @_;
1772		3319
1773	$_->cancel for values %{ (delete $ns->{_coro}) || {} };	3320	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
1774	},	3321	},
1775	);	3322	);
…		…
1790	our $safe = new Safe "safe";	3337	our $safe = new Safe "safe";
1791	our $safe_hole = new Safe::Hole;	3338	our $safe_hole = new Safe::Hole;
1792		3339
1793	$SIG{FPE} = 'IGNORE';	3340	$SIG{FPE} = 'IGNORE';
1794		3341
1795	$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	));
1796		3347
1797	# here we export the classes and methods available to script code	3348	# here we export the classes and methods available to script code
1798		3349
1799	=pod	3350	=pod
1800		3351
1801	The following fucntions and emthods are available within a safe environment:	3352	The following functions and methods are available within a safe environment:
1802		3353
1803	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
1804	cf::object::player player	3359	cf::object::player
1805	cf::player peaceful	3360	player
1806	cf::map trigger	3361
		3362	cf::player
		3363	peaceful
		3364
		3365	cf::map
		3366	trigger
1807		3367
1808	=cut	3368	=cut
1809		3369
1810	for (	3370	for (
1811	["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)],
1812	["cf::object::player" => qw(player)],	3374	["cf::object::player" => qw(player)],
1813	["cf::player" => qw(peaceful)],	3375	["cf::player" => qw(peaceful send_msg)],
1814	["cf::map" => qw(trigger)],	3376	["cf::map" => qw(trigger)],
1815	) {	3377	) {
1816	no strict 'refs';
1817	my ($pkg, @funs) = @$_;	3378	my ($pkg, @funs) = @$_;
1818	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3379	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
1819	for @funs;	3380	for @funs;
1820	}	3381	}
1821		3382
…		…
1836		3397
1837	my $qcode = $code;	3398	my $qcode = $code;
1838	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3399	$qcode =~ s/"/‟/g; # not allowed in #line filenames
1839	$qcode =~ s/\n/\\n/g;	3400	$qcode =~ s/\n/\\n/g;
1840		3401
		3402	%vars = (_dummy => 0) unless %vars;
		3403
		3404	my @res;
1841	local $_;	3405	local $_;
1842	local @safe::cf::_safe_eval_args = values %vars;
1843		3406
1844	my $eval =	3407	my $eval =
1845	"do {\n"	3408	"do {\n"
1846	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	3409	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
1847	. "#line 0 \"{$qcode}\"\n"	3410	. "#line 0 \"{$qcode}\"\n"
1848	. $code	3411	. $code
1849	. "\n}"	3412	. "\n}"
1850	;	3413	;
1851		3414
		3415	if ($CFG{safe_eval}) {
1852	sub_generation_inc;	3416	sub_generation_inc;
		3417	local @safe::cf::_safe_eval_args = values %vars;
1853	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);	3418	@res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
1854	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	}
1855		3424
1856	if ($@) {	3425	if ($@) {
1857	warn "$@";	3426	warn "$@",
1858	warn "while executing safe code '$code'\n";	3427	"while executing safe code '$code'\n",
1859	warn "with arguments " . (join " ", %vars) . "\n";	3428	"with arguments " . (join " ", %vars) . "\n";
1860	}	3429	}
1861		3430
1862	wantarray ? @res : $res[0]	3431	wantarray ? @res : $res[0]
1863	}	3432	}
1864		3433
…		…
1878	=cut	3447	=cut
1879		3448
1880	sub register_script_function {	3449	sub register_script_function {
1881	my ($fun, $cb) = @_;	3450	my ($fun, $cb) = @_;
1882		3451
1883	no strict 'refs';	3452	$fun = "safe::$fun" if $CFG{safe_eval};
1884	*{"safe::$fun"} = $safe_hole->wrap ($cb);	3453	*$fun = $safe_hole->wrap ($cb);
1885	}	3454	}
1886		3455
1887	=back	3456	=back
1888		3457
1889	=cut	3458	=cut
1890		3459
1891	#############################################################################	3460	#############################################################################
		3461	# the server's init and main functions
1892		3462
1893	=head2 EXTENSION DATABASE SUPPORT	3463	sub load_facedata($) {
		3464	my ($path) = @_;
1894		3465
1895	Crossfire maintains a very simple database for extension use. It can	3466	# HACK to clear player env face cache, we need some signal framework
1896	currently store anything that can be serialised using Storable, which	3467	# for this (global event?)
1897	excludes objects.	3468	%ext::player_env::MUSIC_FACE_CACHE = ();
1898		3469
1899	The parameter C<$family> should best start with the name of the extension	3470	my $enc = JSON::XS->new->utf8->canonical->relaxed;
1900	using it, it should be unique.
1901		3471
1902	=over 4	3472	trace "loading facedata from $path\n";
1903		3473
1904	=item $hashref = cf::db_get $family	3474	my $facedata = decode_storable load_file $path;
1905		3475
1906	Return a hashref for use by the extension C<$family>, which can be	3476	$facedata->{version} == 2
1907	modified. After modifications, you have to call C<cf::db_dirty> or	3477	or cf::cleanup "$path: version mismatch, cannot proceed.";
1908	C<cf::db_sync>.
1909		3478
1910	=item $value = cf::db_get $family => $key	3479	# patch in the exptable
1911		3480	my $exp_table = $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]);
1912	Returns a single value from the database	3481	$facedata->{resource}{"res/exp_table"} = {
1913		3482	type => FT_RSRC,
1914	=item cf::db_put $family => $hashref	3483	data => $exp_table,
1915		3484	hash => (Digest::MD5::md5 $exp_table),
1916	Stores the given family hashref into the database. Updates are delayed, if
1917	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1918
1919	=item cf::db_put $family => $key => $value
1920
1921	Stores the given C<$value> in the family hash. Updates are delayed, if you
1922	want the data to be synced to disk immediately, use C<cf::db_sync>.
1923
1924	=item cf::db_dirty
1925
1926	Marks the database as dirty, to be updated at a later time.
1927
1928	=item cf::db_sync
1929
1930	Immediately write the database to disk I<if it is dirty>.
1931
1932	=cut
1933
1934	our $DB;
1935
1936	{
1937	my $path = cf::localdir . "/database.pst";
1938
1939	sub db_load() {
1940	$DB = stat $path ? Storable::retrieve $path : { };
1941	}
1942
1943	my $pid;
1944
1945	sub db_save() {
1946	waitpid $pid, 0 if $pid;
1947	if (0 == ($pid = fork)) {
1948	$DB->{_meta}{version} = 1;
1949	Storable::nstore $DB, "$path~";
1950	rename "$path~", $path;
1951	cf::_exit 0 if defined $pid;
1952	}
1953	}
1954
1955	my $dirty;
1956
1957	sub db_sync() {
1958	db_save if $dirty;
1959	undef $dirty;
1960	}
1961
1962	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1963	db_sync;
1964	});	3485	};
		3486	cf::cede_to_tick;
1965		3487
1966	sub db_dirty() {
1967	$dirty = 1;
1968	$idle->start;
1969	}	3488	{
		3489	my $faces = $facedata->{faceinfo};
1970		3490
1971	sub db_get($;$) {	3491	while (my ($face, $info) = each %$faces) {
1972	@_ >= 2	3492	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1973	? $DB->{$_[0]}{$_[1]}
1974	: ($DB->{$_[0]} ||= { })
1975	}
1976		3493
1977	sub db_put($$;$) {	3494	cf::face::set_visibility $idx, $info->{visibility};
1978	if (@_ >= 3) {	3495	cf::face::set_magicmap $idx, $info->{magicmap};
1979	$DB->{$_[0]}{$_[1]} = $_[2];	3496	cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
1980	} else {	3497	cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
1981	$DB->{$_[0]} = $_[1];	3498	cf::face::set_data $idx, 2, $info->{glyph} , $info->{glyph} ;
1982	}
1983	db_dirty;
1984	}
1985		3499
1986	cf::global->attach (	3500	cf::cede_to_tick;
1987	prio => 10000,
1988	on_cleanup => sub {
1989	db_sync;
1990	},	3501	}
1991	);
1992	}
1993		3502
1994	#############################################################################	3503	while (my ($face, $info) = each %$faces) {
1995	# the server's main()	3504	next unless $info->{smooth};
1996		3505
1997	sub cfg_load {	3506	my $idx = cf::face::find $face
1998	open my $fh, "<:utf8", cf::confdir . "/config"	3507	or next;
1999	or return;
2000		3508
2001	local $/;	3509	if (my $smooth = cf::face::find $info->{smooth}) {
2002	*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	}
2003		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
2004	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3641	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
		3642
		3643	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		3644	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2005		3645
2006	if (exists $CFG{mlockall}) {	3646	if (exists $CFG{mlockall}) {
2007	eval {	3647	eval {
2008	$CFG{mlockall} ? &mlockall : &munlockall	3648	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2009	and die "WARNING: m(un)lockall failed: $!\n";	3649	and die "WARNING: m(un)lockall failed: $!\n";
2010	};	3650	};
2011	warn $@ if $@;	3651	warn $@ if $@;
2012	}	3652	}
2013	}	3653	}
2014		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
2015	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
2016	# we must not ever block the main coroutine	3693	# we must not ever block the main coroutine
2017	local $Coro::idle = sub {	3694	local $Coro::idle = sub {
2018	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#
2019	(Coro::unblock_sub {	3696	(async {
2020	Event::one_event;	3697	$Coro::current->{desc} = "IDLE BUG HANDLER";
2021	})->();	3698	EV::loop EV::LOOP_ONESHOT;
		3699	})->prio (Coro::PRIO_MAX);
2022	};	3700	};
2023		3701
2024	cfg_load;	3702	evthread_start IO::AIO::poll_fileno;
2025	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
2026	load_extensions;	3725	load_extensions;
2027	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;
2028	}	3745	}
2029		3746
2030	#############################################################################	3747	#############################################################################
2031	# initialisation	3748	# initialisation and cleanup
2032		3749
		3750	# install some emergency cleanup handlers
		3751	BEGIN {
		3752	our %SIGWATCHER = ();
		3753	for my $signal (qw(INT HUP TERM)) {
		3754	$SIGWATCHER{$signal} = AE::signal $signal, sub {
		3755	cf::cleanup "SIG$signal";
		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
		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 };
		3846	}
		3847
		3848	sub emergency_save() {
		3849	my $freeze_guard = cf::freeze_mainloop;
		3850
		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;
		3857
		3858	cf::sync_job {
		3859	cf::write_runtime_sync; # external watchdog should not bark
		3860
		3861	# use a peculiar iteration method to avoid tripping on perl
		3862	# refcount bugs in for. also avoids problems with players
		3863	# and maps saved/destroyed asynchronously.
		3864	info "emergency_perl_save: begin player save\n";
		3865	for my $login (keys %cf::PLAYER) {
		3866	my $pl = $cf::PLAYER{$login} or next;
		3867	$pl->valid or next;
		3868	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
		3869	$pl->save;
		3870	}
		3871	info "emergency_perl_save: end player save\n";
		3872
		3873	cf::write_runtime_sync; # external watchdog should not bark
		3874
		3875	info "emergency_perl_save: begin map save\n";
		3876	for my $path (keys %cf::MAP) {
		3877	my $map = $cf::MAP{$path} or next;
		3878	$map->valid or next;
		3879	$map->save;
		3880	}
		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
		3911	};
		3912
		3913	info "emergency_perl_save: leave\n";
		3914	}
		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
2033	sub reload() {	3953	sub do_reload_perl() {
2034	# can/must only be called in main	3954	# can/must only be called in main
2035	if ($Coro::current != $Coro::main) {	3955	unless (in_main) {
2036	warn "can only reload from main coroutine\n";	3956	error "can only reload from main coroutine";
2037	return;	3957	return;
2038	}	3958	}
2039		3959
2040	warn "reloading...";	3960	return if $RELOAD++;
2041		3961
2042	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 {
2043	cf::emergency_save;	3971	#cf::emergency_save;
2044		3972
2045	eval {	3973	trace "perl_reload: cancelling all extension coros";
2046	# if anything goes wrong in here, we should simply crash as we already saved
2047
2048	# cancel all watchers
2049	for (Event::all_watchers) {
2050	$_->cancel if $_->data & WF_AUTOCANCEL;
2051	}
2052
2053	# cancel all extension coros
2054	$_->cancel for values %EXT_CORO;	3974	$_->cancel for values %EXT_CORO;
2055	%EXT_CORO = ();	3975	%EXT_CORO = ();
2056		3976
2057	# unload all extensions	3977	trace "perl_reload: removing commands";
2058	for (@exts) {	3978	%COMMAND = ();
2059	warn "unloading <$_>";
2060	unload_extension $_;
2061	}
2062		3979
2063	# unload all modules loaded from $LIBDIR	3980	trace "perl_reload: removing ext/exti commands";
2064	while (my ($k, $v) = each %INC) {	3981	%EXTCMD = ();
2065	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3982	%EXTICMD = ();
2066		3983
2067	warn "removing <$k>";	3984	trace "perl_reload: unloading/nuking all extensions";
2068	delete $INC{$k};	3985	for my $pkg (@EXTS) {
		3986	trace "... unloading $pkg";
2069		3987
2070	$k =~ s/\.pm$//;
2071	$k =~ s/\//::/g;
2072
2073	if (my $cb = $k->can ("unload_module")) {	3988	if (my $cb = $pkg->can ("unload")) {
		3989	eval {
2074	$cb->();	3990	$cb->($pkg);
		3991	1
		3992	} or error "$pkg unloaded, but with errors: $@";
		3993	}
		3994
		3995	trace "... clearing $pkg";
		3996	clear_package $pkg;
2075	}	3997	}
2076		3998
2077	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;
2078	}	4014	}
2079		4015
2080	# sync database to disk
2081	cf::db_sync;
2082	IO::AIO::flush;
2083
2084	# get rid of safe::, as good as possible	4016	trace "perl_reload: getting rid of safe::, as good as possible";
2085	Symbol::delete_package "safe::$_"	4017	clear_package "safe::$_"
2086	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);
2087		4019
2088	# remove register_script_function callbacks	4020	trace "perl_reload: unloading cf.pm \"a bit\"";
2089	# TODO
2090
2091	# unload cf.pm "a bit"
2092	delete $INC{"cf.pm"};	4021	delete $INC{"cf.pm"};
		4022	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2093		4023
2094	# don't, removes xs symbols, too,	4024	# don't, removes xs symbols, too,
2095	# and global variables created in xs	4025	# and global variables created in xs
2096	#Symbol::delete_package __PACKAGE__;	4026	#clear_package __PACKAGE__;
2097		4027
2098	# reload cf.pm	4028	info "perl_reload: unload completed, starting to reload now";
2099	warn "reloading cf.pm";	4029
		4030	trace "perl_reload: reloading cf.pm";
2100	require cf;	4031	require cf;
2101	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	4032	cf::_connect_to_perl_1;
2102		4033
2103	# load config and database again	4034	trace "perl_reload: loading config and database again";
2104	cf::cfg_load;	4035	cf::reload_config;
2105	cf::db_load;
2106		4036
2107	# load extensions	4037	trace "perl_reload: loading extensions";
2108	warn "load extensions";
2109	cf::load_extensions;	4038	cf::load_extensions;
2110		4039
2111	# reattach attachments to objects	4040	if ($REATTACH_ON_RELOAD) {
2112	warn "reattach";	4041	trace "perl_reload: reattaching attachments to objects/players";
2113	_global_reattach;	4042	_global_reattach; # objects, sockets
		4043	trace "perl_reload: reattaching attachments to maps";
		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	};
2114	};	4079	};
2115
2116	if ($@) {
2117	warn $@;
2118	warn "error while reloading, exiting.";
2119	exit 1;
2120	}
2121
2122	warn "reloaded successfully";
2123	};
2124
2125	#############################################################################
2126
2127	unless ($LINK_MAP) {
2128	$LINK_MAP = cf::map::new;
2129
2130	$LINK_MAP->width (41);
2131	$LINK_MAP->height (41);
2132	$LINK_MAP->alloc;
2133	$LINK_MAP->path ("{link}");
2134	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2135	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2136
2137	# dirty hack because... archetypes are not yet loaded
2138	Event->timer (
2139	after => 2,
2140	cb => sub {
2141	$_[0]->w->cancel;
2142
2143	# provide some exits "home"
2144	my $exit = cf::object::new "exit";
2145
2146	$exit->slaying ($EMERGENCY_POSITION->[0]);
2147	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2148	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2149
2150	$LINK_MAP->insert ($exit->clone, 19, 19);
2151	$LINK_MAP->insert ($exit->clone, 19, 20);
2152	$LINK_MAP->insert ($exit->clone, 19, 21);
2153	$LINK_MAP->insert ($exit->clone, 20, 19);
2154	$LINK_MAP->insert ($exit->clone, 20, 21);
2155	$LINK_MAP->insert ($exit->clone, 21, 19);
2156	$LINK_MAP->insert ($exit->clone, 21, 20);
2157	$LINK_MAP->insert ($exit->clone, 21, 21);
2158
2159	$exit->destroy;
2160	});
2161
2162	$LINK_MAP->{deny_save} = 1;
2163	$LINK_MAP->{deny_reset} = 1;
2164
2165	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2166	}	4080	}
2167
2168	register "<global>", __PACKAGE__;
2169		4081
2170	register_command "reload" => sub {	4082	register_command "reload" => sub {
2171	my ($who, $arg) = @_;	4083	my ($who, $arg) = @_;
2172		4084
2173	if ($who->flag (FLAG_WIZ)) {	4085	if ($who->flag (FLAG_WIZ)) {
2174	$who->message ("start of reload.");
2175	reload;
2176	$who->message ("end of reload.");	4086	$who->message ("reloading server.");
		4087	async {
		4088	$Coro::current->{desc} = "perl_reload";
		4089	reload_perl;
		4090	};
2177	}	4091	}
2178	};	4092	};
2179		4093
2180	unshift @INC, $LIBDIR;	4094	#############################################################################
2181		4095
2182	$TICK_WATCHER = Event->timer (	4096	my $bug_warning = 0;
2183	reentrant => 0,	4097
2184	prio => 0,	4098	our @WAIT_FOR_TICK;
2185	at => $NEXT_TICK || $TICK,	4099	our @WAIT_FOR_TICK_BEGIN;
2186	data => WF_AUTOCANCEL,	4100
2187	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
2188	cf::server_tick; # one server iteration	4124	cf::server_tick; # one server iteration
2189	$RUNTIME += $TICK;
2190	$NEXT_TICK += $TICK;
2191		4125
2192	# if we are delayed by four ticks or more, skip them all	4126	#for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
2193	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2194		4127
2195	$TICK_WATCHER->at ($NEXT_TICK);	4128	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2196	$TICK_WATCHER->start;	4129	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2197	},	4130	Coro::async_pool {
2198	);	4131	$Coro::current->{desc} = "runtime saver";
2199
2200	IO::AIO::max_poll_time $TICK * 0.2;
2201
2202	Event->io (
2203	fd => IO::AIO::poll_fileno,
2204	poll => 'r',
2205	prio => 5,
2206	data => WF_AUTOCANCEL,
2207	cb => \&IO::AIO::poll_cb,
2208	);
2209
2210	Event->timer (
2211	data => WF_AUTOCANCEL,
2212	after => 0,
2213	interval => 10,
2214	cb => sub {
2215	(Coro::unblock_sub {
2216	write_runtime	4132	write_runtime_sync
2217	or warn "ERROR: unable to write runtime file: $!";	4133	or error "ERROR: unable to write runtime file: $!";
2218	})->();	4134	};
2219	},	4135	}
2220	);	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;
2221		4256
2222	END { cf::emergency_save }	4257	END { cf::emergency_save }
2223		4258
2224	1	4259	1
2225		4260

Diff Legend

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