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

Diff Legend

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