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

Diff Legend

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