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.156 by root, Tue Jan 9 22:07:08 2007 UTC vs.
Revision 1.540 by root, Tue May 4 23:32:29 2010 UTC

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

Diff Legend

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