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

Diff Legend

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