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

Diff Legend

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