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.201 by root, Mon Jan 29 18:15:23 2007 UTC vs.
Revision 1.510 by root, Tue Apr 6 22:59:28 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	}
992		1537
…		…
1001	return if $pl->{deny_save};	1546	return if $pl->{deny_save};
1002		1547
1003	aio_mkdir playerdir $pl, 0770;	1548	aio_mkdir playerdir $pl, 0770;
1004	$pl->{last_save} = $cf::RUNTIME;	1549	$pl->{last_save} = $cf::RUNTIME;
1005		1550
		1551	cf::get_slot 0.01;
		1552
1006	$pl->save_pl ($path);	1553	$pl->save_pl ($path);
1007	Coro::cede;	1554	cf::cede_to_tick;
1008	}	1555	}
1009		1556
1010	sub new($) {	1557	sub new($) {
1011	my ($login) = @_;	1558	my ($login) = @_;
1012		1559
…		…
1018	$cf::PLAYER{$login} = $self;	1565	$cf::PLAYER{$login} = $self;
1019		1566
1020	$self	1567	$self
1021	}	1568	}
1022		1569
		1570	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1571
		1572	=cut
		1573
		1574	sub send_msg {
		1575	my $ns = shift->ns
		1576	or return;
		1577	$ns->send_msg (@_);
		1578	}
		1579
1023	=item $pl->quit_character	1580	=item $pl->quit_character
1024		1581
1025	Nukes the player without looking back. If logged in, the connection will	1582	Nukes the player without looking back. If logged in, the connection will
1026	be destroyed. May block for a long time.	1583	be destroyed. May block for a long time.
1027		1584
1028	=cut	1585	=cut
1029		1586
1030	sub quit_character {	1587	sub quit_character {
1031	my ($pl) = @_;	1588	my ($pl) = @_;
1032		1589
		1590	my $name = $pl->ob->name;
		1591
1033	$pl->{deny_save} = 1;	1592	$pl->{deny_save} = 1;
1034	$pl->password ("*"); # this should lock out the player until we nuked the dir	1593	$pl->password ("*"); # this should lock out the player until we have nuked the dir
1035		1594
1036	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1595	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1037	$pl->deactivate;	1596	$pl->deactivate;
		1597	my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
		1598	$pl->ob->check_score;
1038	$pl->invoke (cf::EVENT_PLAYER_QUIT);	1599	$pl->invoke (cf::EVENT_PLAYER_QUIT);
1039	$pl->ns->destroy if $pl->ns;	1600	$pl->ns->destroy if $pl->ns;
1040		1601
1041	my $path = playerdir $pl;	1602	my $path = playerdir $pl;
1042	my $temp = "$path~$cf::RUNTIME~deleting~";	1603	my $temp = "$path~$cf::RUNTIME~deleting~";
1043	aio_rename $path, $temp;	1604	aio_rename $path, $temp;
1044	delete $cf::PLAYER{$pl->ob->name};	1605	delete $cf::PLAYER{$pl->ob->name};
1045	$pl->destroy;	1606	$pl->destroy;
		1607
		1608	my $prefix = qr<^~\Q$name\E/>;
		1609
		1610	# nuke player maps
		1611	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1612
1046	IO::AIO::aio_rmtree $temp;	1613	IO::AIO::aio_rmtree $temp;
		1614	}
		1615
		1616	=item $pl->kick
		1617
		1618	Kicks a player out of the game. This destroys the connection.
		1619
		1620	=cut
		1621
		1622	sub kick {
		1623	my ($pl, $kicker) = @_;
		1624
		1625	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1626	$pl->killer ("kicked");
		1627	$pl->ns->destroy;
1047	}	1628	}
1048		1629
1049	=item cf::player::list_logins	1630	=item cf::player::list_logins
1050		1631
1051	Returns am arrayref of all valid playernames in the system, can take a	1632	Returns am arrayref of all valid playernames in the system, can take a
1052	while and may block, so not sync_job-capable, ever.	1633	while and may block, so not sync_job-capable, ever.
1053		1634
1054	=cut	1635	=cut
1055		1636
1056	sub list_logins {	1637	sub list_logins {
1057	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1638	my $dirs = aio_readdir $PLAYERDIR
1058	or return [];	1639	or return [];
1059		1640
1060	my @logins;	1641	my @logins;
1061		1642
1062	for my $login (@$dirs) {	1643	for my $login (@$dirs) {
		1644	my $path = path $login;
		1645
		1646	# a .pst is a dead give-away for a valid player
		1647	# if no pst file found, open and chekc for blocked users
		1648	if (aio_stat "$path.pst") {
1063	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1649	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1064	aio_read $fh, 0, 512, my $buf, 0 or next;	1650	aio_read $fh, 0, 512, my $buf, 0 or next;
1065	$buf !~ /^password -------------$/m or next; # official not-valid tag	1651	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1652	}
1066		1653
1067	utf8::decode $login;	1654	utf8::decode $login;
1068	push @logins, $login;	1655	push @logins, $login;
1069	}	1656	}
1070		1657
…		…
1097	}	1684	}
1098		1685
1099	\@paths	1686	\@paths
1100	}	1687	}
1101		1688
		1689	=item $protocol_xml = $player->expand_cfpod ($cfpod)
		1690
		1691	Expand deliantra pod fragments into protocol xml.
		1692
1102	=item $player->ext_reply ($msgid, $msgtype, %msg)	1693	=item $player->ext_reply ($msgid, @msg)
1103		1694
1104	Sends an ext reply to the player.	1695	Sends an ext reply to the player.
1105		1696
1106	=cut	1697	=cut
1107		1698
1108	sub ext_reply($$$%) {	1699	sub ext_reply($$@) {
1109	my ($self, $id, %msg) = @_;	1700	my ($self, $id, @msg) = @_;
1110		1701
1111	$msg{msgid} = $id;	1702	$self->ns->ext_reply ($id, @msg)
1112
1113	$self->send ("ext " . cf::to_json \%msg);
1114	}	1703	}
1115		1704
1116	package cf;	1705	=item $player->ext_msg ($type, @msg)
		1706
		1707	Sends an ext event to the client.
		1708
		1709	=cut
		1710
		1711	sub ext_msg($$@) {
		1712	my ($self, $type, @msg) = @_;
		1713
		1714	$self->ns->ext_msg ($type, @msg);
		1715	}
		1716
		1717	=head3 cf::region
		1718
		1719	=over 4
		1720
		1721	=cut
		1722
		1723	package cf::region;
		1724
		1725	=item cf::region::find_by_path $path
		1726
		1727	Tries to decuce the likely region for a map knowing only its path.
		1728
		1729	=cut
		1730
		1731	sub find_by_path($) {
		1732	my ($path) = @_;
		1733
		1734	my ($match, $specificity);
		1735
		1736	for my $region (list) {
		1737	if ($region->{match} && $path =~ $region->{match}) {
		1738	($match, $specificity) = ($region, $region->specificity)
		1739	if $region->specificity > $specificity;
		1740	}
		1741	}
		1742
		1743	$match
		1744	}
1117		1745
1118	=back	1746	=back
1119
1120		1747
1121	=head3 cf::map	1748	=head3 cf::map
1122		1749
1123	=over 4	1750	=over 4
1124		1751
…		…
1136	our $MAX_RESET = 3600;	1763	our $MAX_RESET = 3600;
1137	our $DEFAULT_RESET = 3000;	1764	our $DEFAULT_RESET = 3000;
1138		1765
1139	sub generate_random_map {	1766	sub generate_random_map {
1140	my ($self, $rmp) = @_;	1767	my ($self, $rmp) = @_;
		1768
		1769	my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
		1770
1141	# mit "rum" bekleckern, nicht	1771	# mit "rum" bekleckern, nicht
1142	$self->_create_random_map (	1772	$self->_create_random_map (
1143	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1773	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1144	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1774	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, $rmp->{miningstyle},
1145	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1775	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1146	$rmp->{exit_on_final_map},	1776	$rmp->{exit_on_final_map},
1147	$rmp->{xsize}, $rmp->{ysize},	1777	$rmp->{xsize}, $rmp->{ysize},
1148	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1778	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1149	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1779	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
…		…
1179	my ($self, $merge) = @_;	1809	my ($self, $merge) = @_;
1180		1810
1181	# we have to keep some variables in memory intact	1811	# we have to keep some variables in memory intact
1182	local $self->{path};	1812	local $self->{path};
1183	local $self->{load_path};	1813	local $self->{load_path};
1184	local $self->{deny_save};
1185	local $self->{deny_reset};
1186		1814
1187	$self->SUPER::thawer_merge ($merge);	1815	$self->SUPER::thawer_merge ($merge);
1188	}	1816	}
1189		1817
1190	sub normalise {	1818	sub normalise {
…		…
1237	$self->init; # pass $1 etc.	1865	$self->init; # pass $1 etc.
1238	return $self;	1866	return $self;
1239	}	1867	}
1240	}	1868	}
1241		1869
1242	Carp::carp "unable to resolve path '$path' (base '$base').";	1870	Carp::cluck "unable to resolve path '$path' (base '$base').";
1243	()	1871	()
1244	}	1872	}
1245		1873
1246	sub init {	1874	sub init {
1247	my ($self) = @_;	1875	my ($self) = @_;
…		…
1262		1890
1263	# the original (read-only) location	1891	# the original (read-only) location
1264	sub load_path {	1892	sub load_path {
1265	my ($self) = @_;	1893	my ($self) = @_;
1266		1894
1267	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1895	"$MAPDIR/$self->{path}.map"
1268	}	1896	}
1269		1897
1270	# the temporary/swap location	1898	# the temporary/swap location
1271	sub save_path {	1899	sub save_path {
1272	my ($self) = @_;	1900	my ($self) = @_;
1273		1901
1274	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1902	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1275	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1903	"$TMPDIR/$path.map"
1276	}	1904	}
1277		1905
1278	# the unique path, undef == no special unique path	1906	# the unique path, undef == no special unique path
1279	sub uniq_path {	1907	sub uniq_path {
1280	my ($self) = @_;	1908	my ($self) = @_;
1281		1909
1282	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1910	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1283	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1911	"$UNIQUEDIR/$path"
1284	}	1912	}
1285		1913
1286	# and all this just because we cannot iterate over	1914	sub decay_objects {
1287	# all maps in C++...
1288	sub change_all_map_light {
1289	my ($change) = @_;	1915	my ($self) = @_;
1290		1916
1291	$_->change_map_light ($change)	1917	return if $self->{deny_reset};
1292	for grep $_->outdoor, values %cf::MAP;	1918
		1919	$self->do_decay_objects;
1293	}	1920	}
1294		1921
1295	sub unlink_save {	1922	sub unlink_save {
1296	my ($self) = @_;	1923	my ($self) = @_;
1297		1924
1298	utf8::encode (my $save = $self->save_path);	1925	utf8::encode (my $save = $self->save_path);
1299	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1926	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1300	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";	1927	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	}	1928	}
1307		1929
1308	sub load_header_from($) {	1930	sub load_header_from($) {
1309	my ($self, $path) = @_;	1931	my ($self, $path) = @_;
1310		1932
1311	utf8::encode $path;	1933	utf8::encode $path;
1312	#aio_open $path, O_RDONLY, 0	1934	my $f = new_from_file cf::object::thawer $path
1313	# or return;
1314
1315	$self->_load_header ($path)
1316	or return;	1935	or return;
		1936
		1937	$self->_load_header ($f)
		1938	or return;
		1939
		1940	local $MAP_LOADING{$self->{path}} = $self;
		1941	$f->resolve_delayed_derefs;
1317		1942
1318	$self->{load_path} = $path;	1943	$self->{load_path} = $path;
1319		1944
1320	1	1945	1
1321	}	1946	}
…		…
1360	$self->load_header_orig	1985	$self->load_header_orig
1361	or return;	1986	or return;
1362	$self->prepare_orig;	1987	$self->prepare_orig;
1363	}	1988	}
1364		1989
		1990	$self->{deny_reset} = 1
		1991	if $self->no_reset;
		1992
		1993	$self->default_region (cf::region::find_by_path $self->{path})
		1994	unless $self->default_region;
		1995
1365	1	1996	1
1366	}	1997	}
1367		1998
1368	sub find;	1999	sub find;
1369	sub find {	2000	sub find {
1370	my ($path, $origin) = @_;	2001	my ($path, $origin) = @_;
1371		2002
1372	$path = normalise $path, $origin && $origin->path;	2003	$path = normalise $path, $origin && $origin->path;
1373		2004
		2005	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1374	cf::lock_wait "map_find:$path";	2006	my $guard2 = cf::lock_acquire "map_find:$path";
1375		2007
1376	$cf::MAP{$path} || do {	2008	$cf::MAP{$path} || do {
1377	my $guard = cf::lock_acquire "map_find:$path";
1378	my $map = new_from_path cf::map $path	2009	my $map = new_from_path cf::map $path
1379	or return;	2010	or return;
1380		2011
1381	$map->{last_save} = $cf::RUNTIME;	2012	$map->{last_save} = $cf::RUNTIME;
1382		2013
1383	$map->load_header	2014	$map->load_header
1384	or return;	2015	or return;
1385		2016
1386	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	2017	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1387	# doing this can freeze the server in a sync job, obviously	2018	# doing this can freeze the server in a sync job, obviously
1388	#$cf::WAIT_FOR_TICK->wait;	2019	#$cf::WAIT_FOR_TICK->wait;
		2020	undef $guard2;
		2021	undef $guard1;
1389	$map->reset;	2022	$map->reset;
1390	undef $guard;
1391	return find $path;	2023	return find $path;
1392	}	2024	}
1393		2025
1394	$cf::MAP{$path} = $map	2026	$cf::MAP{$path} = $map
1395	}	2027	}
1396	}	2028	}
1397		2029
1398	sub pre_load { }	2030	sub pre_load { }
1399	sub post_load { }	2031	#sub post_load { } # XS
1400		2032
1401	sub load {	2033	sub load {
1402	my ($self) = @_;	2034	my ($self) = @_;
1403		2035
1404	local $self->{deny_reset} = 1; # loading can take a long time	2036	local $self->{deny_reset} = 1; # loading can take a long time
1405		2037
1406	my $path = $self->{path};	2038	my $path = $self->{path};
		2039
		2040	{
1407	my $guard = cf::lock_acquire "map_load:$path";	2041	my $guard = cf::lock_acquire "map_data:$path";
1408		2042
		2043	return unless $self->valid;
1409	return if $self->in_memory != cf::MAP_SWAPPED;	2044	return unless $self->in_memory == cf::MAP_SWAPPED;
1410		2045
1411	$self->in_memory (cf::MAP_LOADING);	2046	$self->in_memory (cf::MAP_LOADING);
1412		2047
1413	$self->alloc;	2048	$self->alloc;
1414		2049
1415	$self->pre_load;	2050	$self->pre_load;
		2051	cf::cede_to_tick;
1416		2052
1417	$self->_load_objects ($self->{load_path}, 1)	2053	my $f = new_from_file cf::object::thawer $self->{load_path};
		2054	$f->skip_block;
		2055	$self->_load_objects ($f)
1418	or return;	2056	or return;
1419		2057
1420	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2058	$self->post_load_original
1421	if delete $self->{load_original};	2059	if delete $self->{load_original};
1422		2060
1423	if (my $uniq = $self->uniq_path) {	2061	if (my $uniq = $self->uniq_path) {
1424	utf8::encode $uniq;	2062	utf8::encode $uniq;
1425	if (aio_open $uniq, O_RDONLY, 0) {	2063	unless (aio_stat $uniq) {
		2064	if (my $f = new_from_file cf::object::thawer $uniq) {
1426	$self->clear_unique_items;	2065	$self->clear_unique_items;
1427	$self->_load_objects ($uniq, 0);	2066	$self->_load_objects ($f);
		2067	$f->resolve_delayed_derefs;
		2068	}
1428	}	2069	}
1429	}	2070	}
1430		2071
1431	Coro::cede;	2072	$f->resolve_delayed_derefs;
1432		2073
		2074	cf::cede_to_tick;
1433	# now do the right thing for maps	2075	# now do the right thing for maps
1434	$self->link_multipart_objects;	2076	$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)	2077	$self->difficulty ($self->estimate_difficulty)
1443	unless $self->difficulty;	2078	unless $self->difficulty;
1444	Coro::cede;	2079	cf::cede_to_tick;
		2080
		2081	unless ($self->{deny_activate}) {
		2082	$self->decay_objects;
		2083	$self->fix_auto_apply;
		2084	$self->update_buttons;
		2085	cf::cede_to_tick;
1445	$self->activate;	2086	$self->activate;
		2087	}
		2088
		2089	$self->{last_save} = $cf::RUNTIME;
		2090	$self->last_access ($cf::RUNTIME);
		2091
		2092	$self->in_memory (cf::MAP_ACTIVE);
1446	}	2093	}
1447		2094
1448	$self->post_load;	2095	$self->post_load;
1449
1450	$self->in_memory (cf::MAP_IN_MEMORY);
1451	}	2096	}
1452		2097
		2098	# customize the map for a given player, i.e.
		2099	# return the _real_ map. used by e.g. per-player
		2100	# maps to change the path to ~playername/mappath
1453	sub customise_for {	2101	sub customise_for {
1454	my ($self, $ob) = @_;	2102	my ($self, $ob) = @_;
1455		2103
1456	return find "~" . $ob->name . "/" . $self->{path}	2104	return find "~" . $ob->name . "/" . $self->{path}
1457	if $self->per_player;	2105	if $self->per_player;
1458		2106
		2107	# return find "?party/" . $ob->name . "/" . $self->{path}
		2108	# if $self->per_party;
		2109
1459	$self	2110	$self
1460	}	2111	}
1461		2112
1462	# find and load all maps in the 3x3 area around a map	2113	# find and load all maps in the 3x3 area around a map
1463	sub load_diag {	2114	sub load_neighbours {
1464	my ($map) = @_;	2115	my ($map) = @_;
1465		2116
1466	my @diag; # diagonal neighbours	2117	my @neigh; # diagonal neighbours
1467		2118
1468	for (0 .. 3) {	2119	for (0 .. 3) {
1469	my $neigh = $map->tile_path ($_)	2120	my $neigh = $map->tile_path ($_)
1470	or next;	2121	or next;
1471	$neigh = find $neigh, $map	2122	$neigh = find $neigh, $map
1472	or next;	2123	or next;
1473	$neigh->load;	2124	$neigh->load;
1474		2125
		2126	push @neigh,
1475	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2127	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1476	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2128	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1477	}	2129	}
1478		2130
1479	for (@diag) {	2131	for (grep defined $_->[0], @neigh) {
		2132	my ($path, $origin) = @$_;
1480	my $neigh = find @$_	2133	my $neigh = find $path, $origin
1481	or next;	2134	or next;
1482	$neigh->load;	2135	$neigh->load;
1483	}	2136	}
1484	}	2137	}
1485		2138
…		…
1490	}	2143	}
1491		2144
1492	sub do_load_sync {	2145	sub do_load_sync {
1493	my ($map) = @_;	2146	my ($map) = @_;
1494		2147
		2148	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2149	if $Coro::current == $Coro::main;
		2150
1495	cf::sync_job { $map->load };	2151	cf::sync_job { $map->load };
1496	}	2152	}
1497		2153
1498	our %MAP_PREFETCH;	2154	our %MAP_PREFETCH;
1499	our $MAP_PREFETCHER = undef;	2155	our $MAP_PREFETCHER = undef;
1500		2156
1501	sub find_async {	2157	sub find_async {
1502	my ($path, $origin) = @_;	2158	my ($path, $origin, $load) = @_;
1503		2159
1504	$path = normalise $path, $origin && $origin->{path};	2160	$path = normalise $path, $origin && $origin->{path};
1505		2161
1506	if (my $map = $cf::MAP{$path}) {	2162	if (my $map = $cf::MAP{$path}) {
1507	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2163	return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
1508	}	2164	}
1509		2165
1510	undef $MAP_PREFETCH{$path};	2166	$MAP_PREFETCH{$path} |= $load;
		2167
1511	$MAP_PREFETCHER ||= cf::async {	2168	$MAP_PREFETCHER ||= cf::async {
		2169	$Coro::current->{desc} = "map prefetcher";
		2170
1512	while (%MAP_PREFETCH) {	2171	while (%MAP_PREFETCH) {
1513	for my $path (keys %MAP_PREFETCH) {	2172	while (my ($k, $v) = each %MAP_PREFETCH) {
1514	my $map = find $path	2173	if (my $map = find $k) {
1515	or next;
1516	$map->load;	2174	$map->load if $v;
		2175	}
1517		2176
1518	delete $MAP_PREFETCH{$path};	2177	delete $MAP_PREFETCH{$k};
1519	}	2178	}
1520	}	2179	}
1521	undef $MAP_PREFETCHER;	2180	undef $MAP_PREFETCHER;
1522	};	2181	};
1523	$MAP_PREFETCHER->prio (6);	2182	$MAP_PREFETCHER->prio (6);
…		…
1526	}	2185	}
1527		2186
1528	sub save {	2187	sub save {
1529	my ($self) = @_;	2188	my ($self) = @_;
1530		2189
1531	my $lock = cf::lock_acquire "map_data:" . $self->path;	2190	my $lock = cf::lock_acquire "map_data:$self->{path}";
1532		2191
1533	$self->{last_save} = $cf::RUNTIME;	2192	$self->{last_save} = $cf::RUNTIME;
1534		2193
1535	return unless $self->dirty;	2194	return unless $self->dirty;
1536		2195
…		…
1542	return if $self->{deny_save};	2201	return if $self->{deny_save};
1543		2202
1544	local $self->{last_access} = $self->last_access;#d#	2203	local $self->{last_access} = $self->last_access;#d#
1545		2204
1546	cf::async {	2205	cf::async {
		2206	$Coro::current->{desc} = "map player save";
1547	$_->contr->save for $self->players;	2207	$_->contr->save for $self->players;
1548	};	2208	};
		2209
		2210	cf::get_slot 0.02;
1549		2211
1550	if ($uniq) {	2212	if ($uniq) {
1551	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2213	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1552	$self->_save_objects ($uniq, cf::IO_UNIQUES);	2214	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1553	} else {	2215	} else {
…		…
1559	my ($self) = @_;	2221	my ($self) = @_;
1560		2222
1561	# save first because save cedes	2223	# save first because save cedes
1562	$self->save;	2224	$self->save;
1563		2225
1564	my $lock = cf::lock_acquire "map_data:" . $self->path;	2226	my $lock = cf::lock_acquire "map_data:$self->{path}";
1565		2227
1566	return if $self->players;	2228	return if $self->players;
1567	return if $self->in_memory != cf::MAP_IN_MEMORY;	2229	return if $self->in_memory != cf::MAP_ACTIVE;
1568	return if $self->{deny_save};	2230	return if $self->{deny_save};
1569		2231
		2232	$self->in_memory (cf::MAP_SWAPPED);
		2233
		2234	$self->deactivate;
		2235	$_->clear_links_to ($self) for values %cf::MAP;
1570	$self->clear;	2236	$self->clear;
1571	$self->in_memory (cf::MAP_SWAPPED);
1572	}	2237	}
1573		2238
1574	sub reset_at {	2239	sub reset_at {
1575	my ($self) = @_;	2240	my ($self) = @_;
1576		2241
1577	# TODO: safety, remove and allow resettable per-player maps	2242	# 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};	2243	return 1e99 if $self->{deny_reset};
1580		2244
1581	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2245	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1582	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2246	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1583		2247
…		…
1594	my ($self) = @_;	2258	my ($self) = @_;
1595		2259
1596	my $lock = cf::lock_acquire "map_data:$self->{path}";	2260	my $lock = cf::lock_acquire "map_data:$self->{path}";
1597		2261
1598	return if $self->players;	2262	return if $self->players;
1599	return if $self->isa ("ext::map_per_player");#d#
1600		2263
1601	warn "resetting map ", $self->path;#d#	2264	warn "resetting map ", $self->path, "\n";
		2265
		2266	$self->in_memory (cf::MAP_SWAPPED);
		2267
		2268	# need to save uniques path
		2269	unless ($self->{deny_save}) {
		2270	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2271
		2272	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2273	if $uniq;
		2274	}
1602		2275
1603	delete $cf::MAP{$self->path};	2276	delete $cf::MAP{$self->path};
1604		2277
1605	$self->in_memory (cf::MAP_SWAPPED);	2278	$self->deactivate;
		2279	$_->clear_links_to ($self) for values %cf::MAP;
1606	$self->clear;	2280	$self->clear;
1607
1608	$_->clear_links_to ($self) for values %cf::MAP;
1609		2281
1610	$self->unlink_save;	2282	$self->unlink_save;
1611	$self->destroy;	2283	$self->destroy;
1612	}	2284	}
1613		2285
1614	my $nuke_counter = "aaaa";	2286	my $nuke_counter = "aaaa";
1615		2287
1616	sub nuke {	2288	sub nuke {
1617	my ($self) = @_;	2289	my ($self) = @_;
1618		2290
		2291	{
		2292	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2293
1619	delete $cf::MAP{$self->path};	2294	delete $cf::MAP{$self->path};
1620		2295
1621	$self->unlink_save;	2296	$self->unlink_save;
1622		2297
1623	bless $self, "cf::map";	2298	bless $self, "cf::map";
1624	delete $self->{deny_reset};	2299	delete $self->{deny_reset};
1625	$self->{deny_save} = 1;	2300	$self->{deny_save} = 1;
1626	$self->reset_timeout (1);	2301	$self->reset_timeout (1);
1627	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2302	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1628		2303
1629	$cf::MAP{$self->path} = $self;	2304	$cf::MAP{$self->path} = $self;
		2305	}
1630		2306
1631	$self->reset; # polite request, might not happen	2307	$self->reset; # polite request, might not happen
		2308	}
		2309
		2310	=item $maps = cf::map::tmp_maps
		2311
		2312	Returns an arrayref with all map paths of currently instantiated and saved
		2313	maps. May block.
		2314
		2315	=cut
		2316
		2317	sub tmp_maps() {
		2318	[
		2319	map {
		2320	utf8::decode $_;
		2321	/\.map$/
		2322	? normalise $_
		2323	: ()
		2324	} @{ aio_readdir $TMPDIR or [] }
		2325	]
		2326	}
		2327
		2328	=item $maps = cf::map::random_maps
		2329
		2330	Returns an arrayref with all map paths of currently instantiated and saved
		2331	random maps. May block.
		2332
		2333	=cut
		2334
		2335	sub random_maps() {
		2336	[
		2337	map {
		2338	utf8::decode $_;
		2339	/\.map$/
		2340	? normalise "?random/$_"
		2341	: ()
		2342	} @{ aio_readdir $RANDOMDIR or [] }
		2343	]
1632	}	2344	}
1633		2345
1634	=item cf::map::unique_maps	2346	=item cf::map::unique_maps
1635		2347
1636	Returns an arrayref of paths of all shared maps that have	2348	Returns an arrayref of paths of all shared maps that have
1637	instantiated unique items. May block.	2349	instantiated unique items. May block.
1638		2350
1639	=cut	2351	=cut
1640		2352
1641	sub unique_maps() {	2353	sub unique_maps() {
1642	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2354	[
1643	or return;	2355	map {
1644
1645	my @paths;
1646
1647	for (@$files) {
1648	utf8::decode $_;	2356	utf8::decode $_;
1649	next if /\.pst$/;	2357	s/\.map$//; # TODO future compatibility hack
1650	next unless /^$PATH_SEP/o;	2358	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
1651		2359	? ()
1652	push @paths, cf::map::normalise $_;	2360	: normalise $_
		2361	} @{ aio_readdir $UNIQUEDIR or [] }
1653	}	2362	]
1654
1655	\@paths
1656	}	2363	}
1657		2364
1658	package cf;	2365	=item cf::map::static_maps
		2366
		2367	Returns an arrayref if paths of all static maps (all preinstalled F<.map>
		2368	file in the shared directory excluding F</styles> and F</editor>). May
		2369	block.
		2370
		2371	=cut
		2372
		2373	sub static_maps() {
		2374	my @dirs = "";
		2375	my @maps;
		2376
		2377	while (@dirs) {
		2378	my $dir = shift @dirs;
		2379
		2380	next if $dir eq "/styles" || $dir eq "/editor";
		2381
		2382	my ($dirs, $files) = Coro::AIO::aio_scandir "$MAPDIR$dir", 2
		2383	or return;
		2384
		2385	for (@$files) {
		2386	s/\.map$// or next;
		2387	utf8::decode $_;
		2388	push @maps, "$dir/$_";
		2389	}
		2390
		2391	push @dirs, map "$dir/$_", @$dirs;
		2392	}
		2393
		2394	\@maps
		2395	}
1659		2396
1660	=back	2397	=back
1661		2398
1662	=head3 cf::object	2399	=head3 cf::object
1663		2400
…		…
1667		2404
1668	=over 4	2405	=over 4
1669		2406
1670	=item $ob->inv_recursive	2407	=item $ob->inv_recursive
1671		2408
1672	Returns the inventory of the object _and_ their inventories, recursively.	2409	Returns the inventory of the object I<and> their inventories, recursively,
		2410	but I<not> the object itself.
1673		2411
1674	=cut	2412	=cut
1675		2413
1676	sub inv_recursive_;	2414	sub inv_recursive_;
1677	sub inv_recursive_ {	2415	sub inv_recursive_ {
…		…
1680		2418
1681	sub inv_recursive {	2419	sub inv_recursive {
1682	inv_recursive_ inv $_[0]	2420	inv_recursive_ inv $_[0]
1683	}	2421	}
1684		2422
		2423	=item $ref = $ob->ref
		2424
		2425	Creates and returns a persistent reference to an object that can be stored as a string.
		2426
		2427	=item $ob = cf::object::deref ($refstring)
		2428
		2429	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2430	even if the object actually exists. May block.
		2431
		2432	=cut
		2433
		2434	sub deref {
		2435	my ($ref) = @_;
		2436
		2437	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2438	my ($uuid, $name) = ($1, $2);
		2439	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2440	or return;
		2441	$pl->ob->uuid eq $uuid
		2442	or return;
		2443
		2444	$pl->ob
		2445	} else {
		2446	warn "$ref: cannot resolve object reference\n";
		2447	undef
		2448	}
		2449	}
		2450
1685	package cf;	2451	package cf;
1686		2452
1687	=back	2453	=back
1688		2454
1689	=head3 cf::object::player	2455	=head3 cf::object::player
…		…
1695	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	2461	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	2462	can be C<undef>. Does the right thing when the player is currently in a
1697	dialogue with the given NPC character.	2463	dialogue with the given NPC character.
1698		2464
1699	=cut	2465	=cut
		2466
		2467	our $SAY_CHANNEL = {
		2468	id => "say",
		2469	title => "Map",
		2470	reply => "say ",
		2471	tooltip => "Things said to and replied from NPCs near you and other players on the same map only.",
		2472	};
		2473
		2474	our $CHAT_CHANNEL = {
		2475	id => "chat",
		2476	title => "Chat",
		2477	reply => "chat ",
		2478	tooltip => "Player chat and shouts, global to the server.",
		2479	};
1700		2480
1701	# rough implementation of a future "reply" method that works	2481	# rough implementation of a future "reply" method that works
1702	# with dialog boxes.	2482	# with dialog boxes.
1703	#TODO: the first argument must go, split into a $npc->reply_to ( method	2483	#TODO: the first argument must go, split into a $npc->reply_to ( method
1704	sub cf::object::player::reply($$$;$) {	2484	sub cf::object::player::reply($$$;$) {
…		…
1706		2486
1707	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2487	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1708		2488
1709	if ($self->{record_replies}) {	2489	if ($self->{record_replies}) {
1710	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2490	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2491
1711	} else {	2492	} else {
		2493	my $pl = $self->contr;
		2494
		2495	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2496	my $dialog = $pl->{npc_dialog};
		2497	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2498
		2499	} else {
1712	$msg = $npc->name . " says: $msg" if $npc;	2500	$msg = $npc->name . " says: $msg" if $npc;
1713	$self->message ($msg, $flags);	2501	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2502	}
1714	}	2503	}
		2504	}
		2505
		2506	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2507
		2508	=cut
		2509
		2510	sub cf::object::send_msg {
		2511	my $pl = shift->contr
		2512	or return;
		2513	$pl->send_msg (@_);
1715	}	2514	}
1716		2515
1717	=item $player_object->may ("access")	2516	=item $player_object->may ("access")
1718		2517
1719	Returns wether the given player is authorized to access resource "access"	2518	Returns wether the given player is authorized to access resource "access"
…		…
1732		2531
1733	=item $player_object->enter_link	2532	=item $player_object->enter_link
1734		2533
1735	Freezes the player and moves him/her to a special map (C<{link}>).	2534	Freezes the player and moves him/her to a special map (C<{link}>).
1736		2535
1737	The player should be reasonably safe there for short amounts of time. You	2536	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.	2537	for loading a map). You I<MUST> call C<leave_link> as soon as possible,
		2538	though, as the palyer cannot control the character while it is on the link
		2539	map.
1739		2540
1740	Will never block.	2541	Will never block.
1741		2542
1742	=item $player_object->leave_link ($map, $x, $y)	2543	=item $player_object->leave_link ($map, $x, $y)
1743		2544
…		…
1766	$self->deactivate_recursive;	2567	$self->deactivate_recursive;
1767		2568
1768	return if UNIVERSAL::isa $self->map, "ext::map_link";	2569	return if UNIVERSAL::isa $self->map, "ext::map_link";
1769		2570
1770	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2571	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1771	if $self->map;	2572	if $self->map && $self->map->{path} ne "{link}";
1772		2573
1773	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2574	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1774	}	2575	}
1775		2576
1776	sub cf::object::player::leave_link {	2577	sub cf::object::player::leave_link {
1777	my ($self, $map, $x, $y) = @_;	2578	my ($self, $map, $x, $y) = @_;
		2579
		2580	return unless $self->contr->active;
1778		2581
1779	my $link_pos = delete $self->{_link_pos};	2582	my $link_pos = delete $self->{_link_pos};
1780		2583
1781	unless ($map) {	2584	unless ($map) {
1782	# restore original map position	2585	# restore original map position
…		…
1793	($x, $y) = (-1, -1)	2596	($x, $y) = (-1, -1)
1794	unless (defined $x) && (defined $y);	2597	unless (defined $x) && (defined $y);
1795		2598
1796	# use -1 or undef as default coordinates, not 0, 0	2599	# use -1 or undef as default coordinates, not 0, 0
1797	($x, $y) = ($map->enter_x, $map->enter_y)	2600	($x, $y) = ($map->enter_x, $map->enter_y)
1798	if $x <=0 && $y <= 0;	2601	if $x <= 0 && $y <= 0;
1799		2602
1800	$map->load;	2603	$map->load;
1801	$map->load_diag;	2604	$map->load_neighbours;
1802		2605
1803	return unless $self->contr->active;	2606	return unless $self->contr->active;
		2607
		2608	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
		2609	$self->enter_map ($map, $x, $y);
		2610
		2611	# only activate afterwards, to support waiting in hooks
1804	$self->activate_recursive;	2612	$self->activate_recursive;
1805	$self->enter_map ($map, $x, $y);
1806	}	2613	}
1807		2614
1808	cf::player->attach (	2615	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1809	on_logout => sub {
1810	my ($pl) = @_;
1811		2616
1812	# abort map switching before logout	2617	Moves the player to the given map-path and coordinates by first freezing
1813	if ($pl->ob->{_link_pos}) {	2618	her, loading and preparing them map, calling the provided $check callback
1814	cf::sync_job {	2619	that has to return the map if sucecssful, and then unfreezes the player on
1815	$pl->ob->leave_link	2620	the new (success) or old (failed) map position. In either case, $done will
1816	};	2621	be called at the end of this process.
1817	}
1818	},
1819	on_login => sub {
1820	my ($pl) = @_;
1821		2622
1822	# try to abort aborted map switching on player login :)	2623	Note that $check will be called with a potentially non-loaded map, so if
1823	# should happen only on crashes	2624	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		2625
1840	=item $player_object->goto ($path, $x, $y)
1841
1842	=cut	2626	=cut
		2627
		2628	our $GOTOGEN;
1843		2629
1844	sub cf::object::player::goto {	2630	sub cf::object::player::goto {
1845	my ($self, $path, $x, $y) = @_;	2631	my ($self, $path, $x, $y, $check, $done) = @_;
		2632
		2633	# do generation counting so two concurrent goto's will be executed in-order
		2634	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1846		2635
1847	$self->enter_link;	2636	$self->enter_link;
1848		2637
1849	(async {	2638	(async {
		2639	$Coro::current->{desc} = "player::goto $path $x $y";
		2640
		2641	# *tag paths override both path and x|y
		2642	if ($path =~ /^\*(.*)$/) {
		2643	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2644	my $ob = $obs[rand @obs];
		2645
		2646	# see if we actually can go there
		2647	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2648	$ob = $obs[rand @obs];
		2649	} else {
		2650	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2651	}
		2652	# else put us there anyways for now #d#
		2653
		2654	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2655	} else {
		2656	($path, $x, $y) = (undef, undef, undef);
		2657	}
		2658	}
		2659
1850	my $map = eval {	2660	my $map = eval {
1851	my $map = cf::map::find $path;	2661	my $map = defined $path ? cf::map::find $path : undef;
		2662
		2663	if ($map) {
1852	$map = $map->customise_for ($self) if $map;	2664	$map = $map->customise_for ($self);
		2665	$map = $check->($map) if $check && $map;
		2666	} else {
		2667	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2668	}
		2669
1853	$map	2670	$map
		2671	};
		2672
		2673	if ($@) {
		2674	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2675	LOG llevError | logBacktrace, Carp::longmess $@;
1854	} or	2676	}
1855	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1856		2677
		2678	if ($gen == $self->{_goto_generation}) {
		2679	delete $self->{_goto_generation};
1857	$self->leave_link ($map, $x, $y);	2680	$self->leave_link ($map, $x, $y);
		2681	}
		2682
		2683	$done->() if $done;
1858	})->prio (1);	2684	})->prio (1);
1859	}	2685	}
1860		2686
1861	=item $player_object->enter_exit ($exit_object)	2687	=item $player_object->enter_exit ($exit_object)
1862		2688
…		…
1882	}	2708	}
1883		2709
1884	sub prepare_random_map {	2710	sub prepare_random_map {
1885	my ($exit) = @_;	2711	my ($exit) = @_;
1886		2712
1887	my $guard = cf::lock_acquire "exit_prepare:$exit";
1888
1889	# all this does is basically replace the /! path by	2713	# all this does is basically replace the /! path by
1890	# a new random map path (?random/...) with a seed	2714	# a new random map path (?random/...) with a seed
1891	# that depends on the exit object	2715	# that depends on the exit object
1892		2716
1893	my $rmp = parse_random_map_params $exit->msg;	2717	my $rmp = parse_random_map_params $exit->msg;
…		…
1895	if ($exit->map) {	2719	if ($exit->map) {
1896	$rmp->{region} = $exit->region->name;	2720	$rmp->{region} = $exit->region->name;
1897	$rmp->{origin_map} = $exit->map->path;	2721	$rmp->{origin_map} = $exit->map->path;
1898	$rmp->{origin_x} = $exit->x;	2722	$rmp->{origin_x} = $exit->x;
1899	$rmp->{origin_y} = $exit->y;	2723	$rmp->{origin_y} = $exit->y;
		2724
		2725	$exit->map->touch;
1900	}	2726	}
1901		2727
1902	$rmp->{random_seed} ||= $exit->random_seed;	2728	$rmp->{random_seed} ||= $exit->random_seed;
1903		2729
1904	my $data = cf::to_json $rmp;	2730	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1905	my $md5 = Digest::MD5::md5_hex $data;	2731	my $md5 = Digest::MD5::md5_hex $data;
1906	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2732	my $meta = "$RANDOMDIR/$md5.meta";
1907		2733
1908	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2734	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1909	aio_write $fh, 0, (length $data), $data, 0;	2735	aio_write $fh, 0, (length $data), $data, 0;
1910	undef $fh;	2736	undef $fh;
1911	aio_rename "$meta~", $meta;	2737	aio_rename "$meta~", $meta;
1912		2738
		2739	my $slaying = "?random/$md5";
		2740
		2741	if ($exit->valid) {
1913	$exit->slaying ("?random/$md5");	2742	$exit->slaying ("?random/$md5");
1914	$exit->msg (undef);	2743	$exit->msg (undef);
		2744	}
1915	}	2745	}
1916	}	2746	}
1917		2747
1918	sub cf::object::player::enter_exit {	2748	sub cf::object::player::enter_exit {
1919	my ($self, $exit) = @_;	2749	my ($self, $exit) = @_;
1920		2750
1921	return unless $self->type == cf::PLAYER;	2751	return unless $self->type == cf::PLAYER;
1922		2752
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;	2753	$self->enter_link;
1933		2754
1934	(async {	2755	(async {
1935	$self->deactivate_recursive; # just to be sure	2756	$Coro::current->{desc} = "enter_exit";
		2757
1936	unless (eval {	2758	unless (eval {
		2759	$self->deactivate_recursive; # just to be sure
		2760
		2761	# random map handling
		2762	{
		2763	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2764
		2765	prepare_random_map $exit
		2766	if $exit->slaying eq "/!";
		2767	}
		2768
		2769	my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2770	my $x = $exit->stats->hp;
		2771	my $y = $exit->stats->sp;
		2772
1937	$self->goto ($slaying, $hp, $sp);	2773	$self->goto ($map, $x, $y);
1938		2774
		2775	# if exit is damned, update players death & WoR home-position
		2776	$self->contr->savebed ($map, $x, $y)
		2777	if $exit->flag (cf::FLAG_DAMNED);
		2778
1939	1;	2779	1
1940	}) {	2780	}) {
1941	$self->message ("Something went wrong deep within the crossfire server. "	2781	$self->message ("Something went wrong deep within the deliantra server. "
1942	. "I'll try to bring you back to the map you were before. "	2782	. "I'll try to bring you back to the map you were before. "
1943	. "Please report this to the dungeon master!",	2783	. "Please report this to the dungeon master!",
1944	cf::NDI_UNIQUE | cf::NDI_RED);	2784	cf::NDI_UNIQUE | cf::NDI_RED);
1945		2785
1946	warn "ERROR in enter_exit: $@";	2786	warn "ERROR in enter_exit: $@";
1947	$self->leave_link;	2787	$self->leave_link;
1948	}	2788	}
1949	})->prio (1);	2789	})->prio (1);
…		…
1962		2802
1963	sub cf::client::send_drawinfo {	2803	sub cf::client::send_drawinfo {
1964	my ($self, $text, $flags) = @_;	2804	my ($self, $text, $flags) = @_;
1965		2805
1966	utf8::encode $text;	2806	utf8::encode $text;
1967	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2807	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1968	}	2808	}
1969		2809
		2810	=item $client->send_big_packet ($pkt)
		2811
		2812	Like C<send_packet>, but tries to compress large packets, and fragments
		2813	them as required.
		2814
		2815	=cut
		2816
		2817	our $MAXFRAGSIZE = cf::MAXSOCKBUF - 64;
		2818
		2819	sub cf::client::send_big_packet {
		2820	my ($self, $pkt) = @_;
		2821
		2822	# try lzf for large packets
		2823	$pkt = "lzf " . Compress::LZF::compress $pkt
		2824	if 1024 <= length $pkt and $self->{can_lzf};
		2825
		2826	# split very large packets
		2827	if ($MAXFRAGSIZE < length $pkt and $self->{can_lzf}) {
		2828	$self->send_packet ("frag $_") for unpack "(a$MAXFRAGSIZE)*", $pkt;
		2829	$pkt = "frag";
		2830	}
		2831
		2832	$self->send_packet ($pkt);
		2833	}
		2834
		2835	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2836
		2837	Send a drawinfo or msg packet to the client, formatting the msg for the
		2838	client if neccessary. C<$type> should be a string identifying the type of
		2839	the message, with C<log> being the default. If C<$color> is negative, suppress
		2840	the message unless the client supports the msg packet.
		2841
		2842	=cut
		2843
		2844	# non-persistent channels (usually the info channel)
		2845	our %CHANNEL = (
		2846	"c/motd" => {
		2847	id => "infobox",
		2848	title => "MOTD",
		2849	reply => undef,
		2850	tooltip => "The message of the day",
		2851	},
		2852	"c/identify" => {
		2853	id => "infobox",
		2854	title => "Identify",
		2855	reply => undef,
		2856	tooltip => "Items recently identified",
		2857	},
		2858	"c/examine" => {
		2859	id => "infobox",
		2860	title => "Examine",
		2861	reply => undef,
		2862	tooltip => "Signs and other items you examined",
		2863	},
		2864	"c/shopinfo" => {
		2865	id => "infobox",
		2866	title => "Shop Info",
		2867	reply => undef,
		2868	tooltip => "What your bargaining skill tells you about the shop",
		2869	},
		2870	"c/book" => {
		2871	id => "infobox",
		2872	title => "Book",
		2873	reply => undef,
		2874	tooltip => "The contents of a note or book",
		2875	},
		2876	"c/lookat" => {
		2877	id => "infobox",
		2878	title => "Look",
		2879	reply => undef,
		2880	tooltip => "What you saw there",
		2881	},
		2882	"c/who" => {
		2883	id => "infobox",
		2884	title => "Players",
		2885	reply => undef,
		2886	tooltip => "Shows players who are currently online",
		2887	},
		2888	"c/body" => {
		2889	id => "infobox",
		2890	title => "Body Parts",
		2891	reply => undef,
		2892	tooltip => "Shows which body parts you posess and are available",
		2893	},
		2894	"c/statistics" => {
		2895	id => "infobox",
		2896	title => "Statistics",
		2897	reply => undef,
		2898	tooltip => "Shows your primary statistics",
		2899	},
		2900	"c/skills" => {
		2901	id => "infobox",
		2902	title => "Skills",
		2903	reply => undef,
		2904	tooltip => "Shows your experience per skill and item power",
		2905	},
		2906	"c/shopitems" => {
		2907	id => "infobox",
		2908	title => "Shop Items",
		2909	reply => undef,
		2910	tooltip => "Shows the items currently for sale in this shop",
		2911	},
		2912	"c/resistances" => {
		2913	id => "infobox",
		2914	title => "Resistances",
		2915	reply => undef,
		2916	tooltip => "Shows your resistances",
		2917	},
		2918	"c/pets" => {
		2919	id => "infobox",
		2920	title => "Pets",
		2921	reply => undef,
		2922	tooltip => "Shows information abotu your pets/a specific pet",
		2923	},
		2924	"c/perceiveself" => {
		2925	id => "infobox",
		2926	title => "Perceive Self",
		2927	reply => undef,
		2928	tooltip => "You gained detailed knowledge about yourself",
		2929	},
		2930	"c/uptime" => {
		2931	id => "infobox",
		2932	title => "Uptime",
		2933	reply => undef,
		2934	tooltip => "How long the server has been running since last restart",
		2935	},
		2936	"c/mapinfo" => {
		2937	id => "infobox",
		2938	title => "Map Info",
		2939	reply => undef,
		2940	tooltip => "Information related to the maps",
		2941	},
		2942	"c/party" => {
		2943	id => "party",
		2944	title => "Party",
		2945	reply => "gsay ",
		2946	tooltip => "Messages and chat related to your party",
		2947	},
		2948	"c/death" => {
		2949	id => "death",
		2950	title => "Death",
		2951	reply => undef,
		2952	tooltip => "Reason for and more info about your most recent death",
		2953	},
		2954	"c/say" => $SAY_CHANNEL,
		2955	"c/chat" => $CHAT_CHANNEL,
		2956	);
		2957
		2958	sub cf::client::send_msg {
		2959	my ($self, $channel, $msg, $color, @extra) = @_;
		2960
		2961	$msg = $self->pl->expand_cfpod ($msg)
		2962	unless $color & cf::NDI_VERBATIM;
		2963
		2964	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2965
		2966	# check predefined channels, for the benefit of C
		2967	if ($CHANNEL{$channel}) {
		2968	$channel = $CHANNEL{$channel};
		2969
		2970	$self->ext_msg (channel_info => $channel);
		2971	$channel = $channel->{id};
		2972
		2973	} elsif (ref $channel) {
		2974	# send meta info to client, if not yet sent
		2975	unless (exists $self->{channel}{$channel->{id}}) {
		2976	$self->{channel}{$channel->{id}} = $channel;
		2977	$self->ext_msg (channel_info => $channel);
		2978	}
		2979
		2980	$channel = $channel->{id};
		2981	}
		2982
		2983	return unless @extra || length $msg;
		2984
		2985	# default colour, mask it out
		2986	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2987	if $color & cf::NDI_DEF;
		2988
		2989	my $pkt = "msg "
		2990	. $self->{json_coder}->encode (
		2991	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
		2992	);
		2993
		2994	$self->send_big_packet ($pkt);
		2995	}
		2996
		2997	=item $client->ext_msg ($type, @msg)
		2998
		2999	Sends an ext event to the client.
		3000
		3001	=cut
		3002
		3003	sub cf::client::ext_msg($$@) {
		3004	my ($self, $type, @msg) = @_;
		3005
		3006	if ($self->extcmd == 2) {
		3007	$self->send_big_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		3008	} elsif ($self->extcmd == 1) { # TODO: remove
		3009	push @msg, msgtype => "event_$type";
		3010	$self->send_big_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		3011	}
		3012	}
		3013
		3014	=item $client->ext_reply ($msgid, @msg)
		3015
		3016	Sends an ext reply to the client.
		3017
		3018	=cut
		3019
		3020	sub cf::client::ext_reply($$@) {
		3021	my ($self, $id, @msg) = @_;
		3022
		3023	if ($self->extcmd == 2) {
		3024	$self->send_big_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		3025	} elsif ($self->extcmd == 1) {
		3026	#TODO: version 1, remove
		3027	unshift @msg, msgtype => "reply", msgid => $id;
		3028	$self->send_big_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		3029	}
		3030	}
1970		3031
1971	=item $success = $client->query ($flags, "text", \&cb)	3032	=item $success = $client->query ($flags, "text", \&cb)
1972		3033
1973	Queues a query to the client, calling the given callback with	3034	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>,	3035	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>.	3036	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1976		3037
1977	Queries can fail, so check the return code. Or don't, as queries will become	3038	Queries can fail, so check the return code. Or don't, as queries will
1978	reliable at some point in the future.	3039	become reliable at some point in the future.
1979		3040
1980	=cut	3041	=cut
1981		3042
1982	sub cf::client::query {	3043	sub cf::client::query {
1983	my ($self, $flags, $text, $cb) = @_;	3044	my ($self, $flags, $text, $cb) = @_;
…		…
1991	utf8::encode $text;	3052	utf8::encode $text;
1992	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	3053	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1993		3054
1994	$self->send_packet ($self->{query_queue}[0][0])	3055	$self->send_packet ($self->{query_queue}[0][0])
1995	if @{ $self->{query_queue} } == 1;	3056	if @{ $self->{query_queue} } == 1;
		3057
		3058	1
1996	}	3059	}
1997		3060
1998	cf::client->attach (	3061	cf::client->attach (
		3062	on_connect => sub {
		3063	my ($ns) = @_;
		3064
		3065	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		3066	},
1999	on_reply => sub {	3067	on_reply => sub {
2000	my ($ns, $msg) = @_;	3068	my ($ns, $msg) = @_;
2001		3069
2002	# this weird shuffling is so that direct followup queries	3070	# this weird shuffling is so that direct followup queries
2003	# get handled first	3071	# get handled first
2004	my $queue = delete $ns->{query_queue}	3072	my $queue = delete $ns->{query_queue}
2005	or return; # be conservative, not sure how that can happen, but we saw a crash here	3073	or return; # be conservative, not sure how that can happen, but we saw a crash here
2006		3074
2007	(shift @$queue)->[1]->($msg);	3075	(shift @$queue)->[1]->($msg);
		3076	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
2008		3077
2009	push @{ $ns->{query_queue} }, @$queue;	3078	push @{ $ns->{query_queue} }, @$queue;
2010		3079
2011	if (@{ $ns->{query_queue} } == @$queue) {	3080	if (@{ $ns->{query_queue} } == @$queue) {
2012	if (@$queue) {	3081	if (@$queue) {
…		…
2014	} else {	3083	} else {
2015	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3084	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2016	}	3085	}
2017	}	3086	}
2018	},	3087	},
		3088	on_exticmd => sub {
		3089	my ($ns, $buf) = @_;
		3090
		3091	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		3092
		3093	if (ref $msg) {
		3094	my ($type, $reply, @payload) =
		3095	"ARRAY" eq ref $msg
		3096	? @$msg
		3097	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		3098
		3099	my @reply;
		3100
		3101	if (my $cb = $EXTICMD{$type}) {
		3102	@reply = $cb->($ns, @payload);
		3103	}
		3104
		3105	$ns->ext_reply ($reply, @reply)
		3106	if $reply;
		3107
		3108	} else {
		3109	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		3110	}
		3111
		3112	cf::override;
		3113	},
2019	);	3114	);
2020		3115
2021	=item $client->async (\&cb)	3116	=item $client->async (\&cb)
2022		3117
2023	Create a new coroutine, running the specified callback. The coroutine will	3118	Create a new coroutine, running the specified callback. The coroutine will
…		…
2039		3134
2040	$coro	3135	$coro
2041	}	3136	}
2042		3137
2043	cf::client->attach (	3138	cf::client->attach (
2044	on_destroy => sub {	3139	on_client_destroy => sub {
2045	my ($ns) = @_;	3140	my ($ns) = @_;
2046		3141
2047	$_->cancel for values %{ (delete $ns->{_coro}) || {} };	3142	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
2048	},	3143	},
2049	);	3144	);
…		…
2064	our $safe = new Safe "safe";	3159	our $safe = new Safe "safe";
2065	our $safe_hole = new Safe::Hole;	3160	our $safe_hole = new Safe::Hole;
2066		3161
2067	$SIG{FPE} = 'IGNORE';	3162	$SIG{FPE} = 'IGNORE';
2068		3163
2069	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3164	$safe->permit_only (Opcode::opset qw(
		3165	:base_core :base_mem :base_orig :base_math :base_loop
		3166	grepstart grepwhile mapstart mapwhile
		3167	sort time
		3168	));
2070		3169
2071	# here we export the classes and methods available to script code	3170	# here we export the classes and methods available to script code
2072		3171
2073	=pod	3172	=pod
2074		3173
2075	The following fucntions and emthods are available within a safe environment:	3174	The following functions and methods are available within a safe environment:
2076		3175
2077	cf::object contr pay_amount pay_player map	3176	cf::object
		3177	contr pay_amount pay_player map x y force_find force_add destroy
		3178	insert remove name archname title slaying race decrease split
		3179	value
		3180
2078	cf::object::player player	3181	cf::object::player
2079	cf::player peaceful	3182	player
2080	cf::map trigger	3183
		3184	cf::player
		3185	peaceful
		3186
		3187	cf::map
		3188	trigger
2081		3189
2082	=cut	3190	=cut
2083		3191
2084	for (	3192	for (
2085	["cf::object" => qw(contr pay_amount pay_player map)],	3193	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3194	insert remove inv nrof name archname title slaying race
		3195	decrease split destroy change_exp value msg lore send_msg)],
2086	["cf::object::player" => qw(player)],	3196	["cf::object::player" => qw(player)],
2087	["cf::player" => qw(peaceful)],	3197	["cf::player" => qw(peaceful send_msg)],
2088	["cf::map" => qw(trigger)],	3198	["cf::map" => qw(trigger)],
2089	) {	3199	) {
2090	no strict 'refs';	3200	no strict 'refs';
2091	my ($pkg, @funs) = @$_;	3201	my ($pkg, @funs) = @$_;
2092	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3202	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
…		…
2110		3220
2111	my $qcode = $code;	3221	my $qcode = $code;
2112	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3222	$qcode =~ s/"/‟/g; # not allowed in #line filenames
2113	$qcode =~ s/\n/\\n/g;	3223	$qcode =~ s/\n/\\n/g;
2114		3224
		3225	%vars = (_dummy => 0) unless %vars;
		3226
		3227	my @res;
2115	local $_;	3228	local $_;
2116	local @safe::cf::_safe_eval_args = values %vars;
2117		3229
2118	my $eval =	3230	my $eval =
2119	"do {\n"	3231	"do {\n"
2120	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	3232	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
2121	. "#line 0 \"{$qcode}\"\n"	3233	. "#line 0 \"{$qcode}\"\n"
2122	. $code	3234	. $code
2123	. "\n}"	3235	. "\n}"
2124	;	3236	;
2125		3237
		3238	if ($CFG{safe_eval}) {
2126	sub_generation_inc;	3239	sub_generation_inc;
		3240	local @safe::cf::_safe_eval_args = values %vars;
2127	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);	3241	@res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
2128	sub_generation_inc;	3242	sub_generation_inc;
		3243	} else {
		3244	local @cf::_safe_eval_args = values %vars;
		3245	@res = wantarray ? eval eval : scalar eval $eval;
		3246	}
2129		3247
2130	if ($@) {	3248	if ($@) {
2131	warn "$@";	3249	warn "$@";
2132	warn "while executing safe code '$code'\n";	3250	warn "while executing safe code '$code'\n";
2133	warn "with arguments " . (join " ", %vars) . "\n";	3251	warn "with arguments " . (join " ", %vars) . "\n";
…		…
2152	=cut	3270	=cut
2153		3271
2154	sub register_script_function {	3272	sub register_script_function {
2155	my ($fun, $cb) = @_;	3273	my ($fun, $cb) = @_;
2156		3274
2157	no strict 'refs';	3275	$fun = "safe::$fun" if $CFG{safe_eval};
2158	*{"safe::$fun"} = $safe_hole->wrap ($cb);	3276	*$fun = $safe_hole->wrap ($cb);
2159	}	3277	}
2160		3278
2161	=back	3279	=back
2162		3280
2163	=cut	3281	=cut
2164		3282
2165	#############################################################################	3283	#############################################################################
		3284	# the server's init and main functions
2166		3285
2167	=head2 EXTENSION DATABASE SUPPORT	3286	sub load_facedata($) {
		3287	my ($path) = @_;
2168		3288
2169	Crossfire maintains a very simple database for extension use. It can	3289	# HACK to clear player env face cache, we need some signal framework
2170	currently store anything that can be serialised using Storable, which	3290	# for this (global event?)
2171	excludes objects.	3291	%ext::player_env::MUSIC_FACE_CACHE = ();
2172		3292
2173	The parameter C<$family> should best start with the name of the extension	3293	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2174	using it, it should be unique.
2175		3294
2176	=over 4	3295	warn "loading facedata from $path\n";
2177		3296
2178	=item $hashref = cf::db_get $family	3297	my $facedata;
		3298	0 < aio_load $path, $facedata
		3299	or die "$path: $!";
2179		3300
2180	Return a hashref for use by the extension C<$family>, which can be	3301	$facedata = Coro::Storable::thaw $facedata;
2181	modified. After modifications, you have to call C<cf::db_dirty> or
2182	C<cf::db_sync>.
2183		3302
2184	=item $value = cf::db_get $family => $key	3303	$facedata->{version} == 2
		3304	or cf::cleanup "$path: version mismatch, cannot proceed.";
2185		3305
2186	Returns a single value from the database	3306	# patch in the exptable
2187		3307	my $exp_table = $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]);
2188	=item cf::db_put $family => $hashref	3308	$facedata->{resource}{"res/exp_table"} = {
2189		3309	type => FT_RSRC,
2190	Stores the given family hashref into the database. Updates are delayed, if	3310	data => $exp_table,
2191	you want the data to be synced to disk immediately, use C<cf::db_sync>.	3311	hash => (Digest::MD5::md5 $exp_table),
2192
2193	=item cf::db_put $family => $key => $value
2194
2195	Stores the given C<$value> in the family hash. Updates are delayed, if you
2196	want the data to be synced to disk immediately, use C<cf::db_sync>.
2197
2198	=item cf::db_dirty
2199
2200	Marks the database as dirty, to be updated at a later time.
2201
2202	=item cf::db_sync
2203
2204	Immediately write the database to disk I<if it is dirty>.
2205
2206	=cut
2207
2208	our $DB;
2209
2210	{
2211	my $path = cf::localdir . "/database.pst";
2212
2213	sub db_load() {
2214	$DB = stat $path ? Storable::retrieve $path : { };
2215	}	3312	};
		3313	cf::cede_to_tick;
2216		3314
2217	my $pid;
2218
2219	sub db_save() {
2220	waitpid $pid, 0 if $pid;
2221	if (0 == ($pid = fork)) {
2222	$DB->{_meta}{version} = 1;
2223	Storable::nstore $DB, "$path~";
2224	rename "$path~", $path;
2225	cf::_exit 0 if defined $pid;
2226	}
2227	}	3315	{
		3316	my $faces = $facedata->{faceinfo};
2228		3317
2229	my $dirty;	3318	while (my ($face, $info) = each %$faces) {
		3319	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2230		3320
2231	sub db_sync() {	3321	cf::face::set_visibility $idx, $info->{visibility};
2232	db_save if $dirty;	3322	cf::face::set_magicmap $idx, $info->{magicmap};
2233	undef $dirty;	3323	cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
2234	}	3324	cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
2235		3325
2236	my $idle = Event->idle (	3326	cf::cede_to_tick;
2237	reentrant => 0,
2238	min => 10,
2239	max => 20,
2240	repeat => 0,
2241	data => WF_AUTOCANCEL,
2242	cb => \&db_sync,
2243	);
2244
2245	sub db_dirty() {
2246	$dirty = 1;
2247	$idle->start;
2248	}
2249
2250	sub db_get($;$) {
2251	@_ >= 2
2252	? $DB->{$_[0]}{$_[1]}
2253	: ($DB->{$_[0]} ||= { })
2254	}
2255
2256	sub db_put($$;$) {
2257	if (@_ >= 3) {
2258	$DB->{$_[0]}{$_[1]} = $_[2];
2259	} else {
2260	$DB->{$_[0]} = $_[1];
2261	}
2262	db_dirty;
2263	}
2264
2265	cf::global->attach (
2266	prio => 10000,
2267	on_cleanup => sub {
2268	db_sync;
2269	},	3327	}
2270	);
2271	}
2272		3328
2273	#############################################################################	3329	while (my ($face, $info) = each %$faces) {
2274	# the server's main()	3330	next unless $info->{smooth};
2275		3331
2276	sub cfg_load {	3332	my $idx = cf::face::find $face
		3333	or next;
		3334
		3335	if (my $smooth = cf::face::find $info->{smooth}) {
		3336	cf::face::set_smooth $idx, $smooth;
		3337	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3338	} else {
		3339	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3340	}
		3341
		3342	cf::cede_to_tick;
		3343	}
		3344	}
		3345
		3346	{
		3347	my $anims = $facedata->{animinfo};
		3348
		3349	while (my ($anim, $info) = each %$anims) {
		3350	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3351	cf::cede_to_tick;
		3352	}
		3353
		3354	cf::anim::invalidate_all; # d'oh
		3355	}
		3356
		3357	{
		3358	my $res = $facedata->{resource};
		3359
		3360	while (my ($name, $info) = each %$res) {
		3361	if (defined $info->{type}) {
		3362	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3363
		3364	cf::face::set_data $idx, 0, $info->{data}, $info->{hash};
		3365	cf::face::set_type $idx, $info->{type};
		3366	} else {
		3367	$RESOURCE{$name} = $info;
		3368	}
		3369
		3370	cf::cede_to_tick;
		3371	}
		3372	}
		3373
		3374	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3375
		3376	1
		3377	}
		3378
		3379	cf::global->attach (on_resource_update => sub {
		3380	if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
		3381	$soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
		3382
		3383	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3384	my $sound = $soundconf->{compat}[$_]
		3385	or next;
		3386
		3387	my $face = cf::face::find "sound/$sound->[1]";
		3388	cf::sound::set $sound->[0] => $face;
		3389	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3390	}
		3391
		3392	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3393	my $face = cf::face::find "sound/$v";
		3394	cf::sound::set $k => $face;
		3395	}
		3396	}
		3397	});
		3398
		3399	register_exticmd fx_want => sub {
		3400	my ($ns, $want) = @_;
		3401
		3402	while (my ($k, $v) = each %$want) {
		3403	$ns->fx_want ($k, $v);
		3404	}
		3405	};
		3406
		3407	sub load_resource_file($) {
		3408	my $guard = lock_acquire "load_resource_file";
		3409
		3410	my $status = load_resource_file_ $_[0];
		3411	get_slot 0.1, 100;
		3412	cf::arch::commit_load;
		3413
		3414	$status
		3415	}
		3416
		3417	sub reload_regions {
		3418	# HACK to clear player env face cache, we need some signal framework
		3419	# for this (global event?)
		3420	%ext::player_env::MUSIC_FACE_CACHE = ();
		3421
		3422	load_resource_file "$MAPDIR/regions"
		3423	or die "unable to load regions file\n";
		3424
		3425	for (cf::region::list) {
		3426	$_->{match} = qr/$_->{match}/
		3427	if exists $_->{match};
		3428	}
		3429	}
		3430
		3431	sub reload_facedata {
		3432	load_facedata "$DATADIR/facedata"
		3433	or die "unable to load facedata\n";
		3434	}
		3435
		3436	sub reload_archetypes {
		3437	load_resource_file "$DATADIR/archetypes"
		3438	or die "unable to load archetypes\n";
		3439	}
		3440
		3441	sub reload_treasures {
		3442	load_resource_file "$DATADIR/treasures"
		3443	or die "unable to load treasurelists\n";
		3444	}
		3445
		3446	sub reload_resources {
		3447	warn "reloading resource files...\n";
		3448
		3449	reload_facedata;
		3450	reload_archetypes;
		3451	reload_regions;
		3452	reload_treasures;
		3453
		3454	warn "finished reloading resource files\n";
		3455	}
		3456
		3457	sub reload_config {
		3458	warn "reloading config file...\n";
		3459
2277	open my $fh, "<:utf8", cf::confdir . "/config"	3460	open my $fh, "<:utf8", "$CONFDIR/config"
2278	or return;	3461	or return;
2279		3462
2280	local $/;	3463	local $/;
2281	*CFG = YAML::Syck::Load <$fh>;	3464	*CFG = YAML::XS::Load scalar <$fh>;
2282		3465
2283	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3466	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2284		3467
2285	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	3468	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2286	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};	3469	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
…		…
2290	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"	3473	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2291	and die "WARNING: m(un)lockall failed: $!\n";	3474	and die "WARNING: m(un)lockall failed: $!\n";
2292	};	3475	};
2293	warn $@ if $@;	3476	warn $@ if $@;
2294	}	3477	}
		3478
		3479	warn "finished reloading resource files\n";
		3480	}
		3481
		3482	sub pidfile() {
		3483	sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
		3484	or die "$PIDFILE: $!";
		3485	flock $fh, &Fcntl::LOCK_EX
		3486	or die "$PIDFILE: flock: $!";
		3487	$fh
		3488	}
		3489
		3490	# make sure only one server instance is running at any one time
		3491	sub atomic {
		3492	my $fh = pidfile;
		3493
		3494	my $pid = <$fh>;
		3495	kill 9, $pid if $pid > 0;
		3496
		3497	seek $fh, 0, 0;
		3498	print $fh $$;
		3499	}
		3500
		3501	sub main_loop {
		3502	warn "EV::loop starting\n";
		3503	if (1) {
		3504	EV::loop;
		3505	}
		3506	warn "EV::loop returned\n";
		3507	goto &main_loop unless $REALLY_UNLOOP;
2295	}	3508	}
2296		3509
2297	sub main {	3510	sub main {
		3511	cf::init_globals; # initialise logging
		3512
		3513	LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
		3514	LOG llevInfo, "Copyright (C) 2005-2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
		3515	LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
		3516	LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
		3517
		3518	cf::init_experience;
		3519	cf::init_anim;
		3520	cf::init_attackmess;
		3521	cf::init_dynamic;
		3522
		3523	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3524
2298	# we must not ever block the main coroutine	3525	# we must not ever block the main coroutine
2299	local $Coro::idle = sub {	3526	local $Coro::idle = sub {
2300	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3527	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2301	(async {	3528	(async {
2302	Event::one_event;	3529	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3530	EV::loop EV::LOOP_ONESHOT;
2303	})->prio (Coro::PRIO_MAX);	3531	})->prio (Coro::PRIO_MAX);
2304	};	3532	};
2305		3533
2306	cfg_load;	3534	evthread_start IO::AIO::poll_fileno;
2307	db_load;	3535
		3536	cf::sync_job {
		3537	cf::load_settings;
		3538	cf::load_materials;
		3539
		3540	reload_resources;
		3541	reload_config;
		3542	db_init;
		3543
		3544	cf::init_uuid;
		3545	cf::init_signals;
		3546	cf::init_skills;
		3547
		3548	cf::init_beforeplay;
		3549
		3550	atomic;
		3551
2308	load_extensions;	3552	load_extensions;
2309		3553
2310	$TICK_WATCHER->start;	3554	utime time, time, $RUNTIMEFILE;
2311	Event::loop;	3555
		3556	# no (long-running) fork's whatsoever before this point(!)
		3557	use POSIX ();
		3558	POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
		3559
		3560	(pop @POST_INIT)->(0) while @POST_INIT;
		3561	};
		3562
		3563	main_loop;
2312	}	3564	}
2313		3565
2314	#############################################################################	3566	#############################################################################
2315	# initialisation and cleanup	3567	# initialisation and cleanup
2316		3568
2317	# install some emergency cleanup handlers	3569	# install some emergency cleanup handlers
2318	BEGIN {	3570	BEGIN {
		3571	our %SIGWATCHER = ();
2319	for my $signal (qw(INT HUP TERM)) {	3572	for my $signal (qw(INT HUP TERM)) {
2320	Event->signal (	3573	$SIGWATCHER{$signal} = EV::signal $signal, sub {
2321	reentrant => 0,
2322	data => WF_AUTOCANCEL,
2323	signal => $signal,
2324	prio => 0,
2325	cb => sub {
2326	cf::cleanup "SIG$signal";	3574	cf::cleanup "SIG$signal";
2327	},
2328	);	3575	};
		3576	}
		3577	}
		3578
		3579	sub write_runtime_sync {
		3580	my $t0 = EV::time;
		3581
		3582	# first touch the runtime file to show we are still running:
		3583	# the fsync below can take a very very long time.
		3584
		3585	IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
		3586
		3587	my $guard = cf::lock_acquire "write_runtime";
		3588
		3589	my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644
		3590	or return;
		3591
		3592	my $value = $cf::RUNTIME + 90 + 10;
		3593	# 10 is the runtime save interval, for a monotonic clock
		3594	# 60 allows for the watchdog to kill the server.
		3595
		3596	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3597	and return;
		3598
		3599	# always fsync - this file is important
		3600	aio_fsync $fh
		3601	and return;
		3602
		3603	# touch it again to show we are up-to-date
		3604	aio_utime $fh, undef, undef;
		3605
		3606	close $fh
		3607	or return;
		3608
		3609	aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
		3610	and return;
		3611
		3612	warn sprintf "runtime file written (%gs).\n", EV::time - $t0;
		3613
2329	}	3614	1
		3615	}
		3616
		3617	our $uuid_lock;
		3618	our $uuid_skip;
		3619
		3620	sub write_uuid_sync($) {
		3621	$uuid_skip ||= $_[0];
		3622
		3623	return if $uuid_lock;
		3624	local $uuid_lock = 1;
		3625
		3626	my $uuid = "$LOCALDIR/uuid";
		3627
		3628	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3629	or return;
		3630
		3631	my $value = uuid_seq uuid_cur;
		3632
		3633	unless ($value) {
		3634	warn "cowardly refusing to write zero uuid value!\n";
		3635	return;
		3636	}
		3637
		3638	my $value = uuid_str $value + $uuid_skip;
		3639	$uuid_skip = 0;
		3640
		3641	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3642	and return;
		3643
		3644	# always fsync - this file is important
		3645	aio_fsync $fh
		3646	and return;
		3647
		3648	close $fh
		3649	or return;
		3650
		3651	aio_rename "$uuid~", $uuid
		3652	and return;
		3653
		3654	warn "uuid file written ($value).\n";
		3655
		3656	1
		3657
		3658	}
		3659
		3660	sub write_uuid($$) {
		3661	my ($skip, $sync) = @_;
		3662
		3663	$sync ? write_uuid_sync $skip
		3664	: async { write_uuid_sync $skip };
2330	}	3665	}
2331		3666
2332	sub emergency_save() {	3667	sub emergency_save() {
2333	my $freeze_guard = cf::freeze_mainloop;	3668	my $freeze_guard = cf::freeze_mainloop;
2334		3669
2335	warn "enter emergency perl save\n";	3670	warn "emergency_perl_save: enter\n";
2336		3671
2337	cf::sync_job {	3672	cf::sync_job {
		3673	# this is a trade-off: we want to be very quick here, so
		3674	# save all maps without fsync, and later call a global sync
		3675	# (which in turn might be very very slow)
		3676	local $USE_FSYNC = 0;
		3677
2338	# use a peculiar iteration method to avoid tripping on perl	3678	# use a peculiar iteration method to avoid tripping on perl
2339	# refcount bugs in for. also avoids problems with players	3679	# refcount bugs in for. also avoids problems with players
2340	# and maps saved/destroyed asynchronously.	3680	# and maps saved/destroyed asynchronously.
2341	warn "begin emergency player save\n";	3681	warn "emergency_perl_save: begin player save\n";
2342	for my $login (keys %cf::PLAYER) {	3682	for my $login (keys %cf::PLAYER) {
2343	my $pl = $cf::PLAYER{$login} or next;	3683	my $pl = $cf::PLAYER{$login} or next;
2344	$pl->valid or next;	3684	$pl->valid or next;
		3685	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2345	$pl->save;	3686	$pl->save;
2346	}	3687	}
2347	warn "end emergency player save\n";	3688	warn "emergency_perl_save: end player save\n";
2348		3689
2349	warn "begin emergency map save\n";	3690	warn "emergency_perl_save: begin map save\n";
2350	for my $path (keys %cf::MAP) {	3691	for my $path (keys %cf::MAP) {
2351	my $map = $cf::MAP{$path} or next;	3692	my $map = $cf::MAP{$path} or next;
2352	$map->valid or next;	3693	$map->valid or next;
2353	$map->save;	3694	$map->save;
2354	}	3695	}
2355	warn "end emergency map save\n";	3696	warn "emergency_perl_save: end map save\n";
		3697
		3698	warn "emergency_perl_save: begin database checkpoint\n";
		3699	BDB::db_env_txn_checkpoint $DB_ENV;
		3700	warn "emergency_perl_save: end database checkpoint\n";
		3701
		3702	warn "emergency_perl_save: begin write uuid\n";
		3703	write_uuid_sync 1;
		3704	warn "emergency_perl_save: end write uuid\n";
2356	};	3705	};
2357		3706
		3707	warn "emergency_perl_save: starting sync()\n";
		3708	IO::AIO::aio_sync sub {
		3709	warn "emergency_perl_save: finished sync()\n";
		3710	};
		3711
2358	warn "leave emergency perl save\n";	3712	warn "emergency_perl_save: leave\n";
2359	}	3713	}
2360		3714
		3715	sub post_cleanup {
		3716	my ($make_core) = @_;
		3717
		3718	warn Carp::longmess "post_cleanup backtrace"
		3719	if $make_core;
		3720
		3721	my $fh = pidfile;
		3722	unlink $PIDFILE if <$fh> == $$;
		3723	}
		3724
		3725	# a safer delete_package, copied from Symbol
		3726	sub clear_package($) {
		3727	my $pkg = shift;
		3728
		3729	# expand to full symbol table name if needed
		3730	unless ($pkg =~ /^main::.*::$/) {
		3731	$pkg = "main$pkg" if $pkg =~ /^::/;
		3732	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		3733	$pkg .= '::' unless $pkg =~ /::$/;
		3734	}
		3735
		3736	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		3737	my $stem_symtab = *{$stem}{HASH};
		3738
		3739	defined $stem_symtab and exists $stem_symtab->{$leaf}
		3740	or return;
		3741
		3742	# clear all symbols
		3743	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		3744	for my $name (keys %$leaf_symtab) {
		3745	_gv_clear *{"$pkg$name"};
		3746	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		3747	}
		3748	warn "cleared package $pkg\n";#d#
		3749	}
		3750
2361	sub reload() {	3751	sub do_reload_perl() {
2362	# can/must only be called in main	3752	# can/must only be called in main
2363	if ($Coro::current != $Coro::main) {	3753	if ($Coro::current != $Coro::main) {
2364	warn "can only reload from main coroutine";	3754	warn "can only reload from main coroutine";
2365	return;	3755	return;
2366	}	3756	}
2367		3757
		3758	return if $RELOAD++;
		3759
		3760	my $t1 = EV::time;
		3761
		3762	while ($RELOAD) {
2368	warn "reloading...";	3763	warn "reloading...";
2369		3764
2370	warn "cancelling server ticker";	3765	warn "entering sync_job";
2371	$TICK_WATCHER->cancel;
2372		3766
		3767	cf::sync_job {
		3768	cf::write_runtime_sync; # external watchdog should not bark
2373	cf::emergency_save;	3769	cf::emergency_save;
		3770	cf::write_runtime_sync; # external watchdog should not bark
2374		3771
2375	eval {	3772	warn "syncing database to disk";
		3773	BDB::db_env_txn_checkpoint $DB_ENV;
		3774
2376	# if anything goes wrong in here, we should simply crash as we already saved	3775	# if anything goes wrong in here, we should simply crash as we already saved
2377		3776
2378	warn "syncing database to disk";
2379	cf::db_sync;
2380
2381	warn "cancelling all WF_AUTOCANCEL watchers";
2382	for (Event::all_watchers) {
2383	$_->cancel if $_->data & WF_AUTOCANCEL;
2384	}
2385
2386	warn "flushing outstanding aio requests";	3777	warn "flushing outstanding aio requests";
2387	for (;;) {	3778	while (IO::AIO::nreqs || BDB::nreqs) {
2388	IO::AIO::flush;	3779	Coro::EV::timer_once 0.01; # let the sync_job do it's thing
2389	Coro::cede;
2390	last unless IO::AIO::nreqs;
2391	warn "iterate...";
2392	}
2393
2394	warn "cancelling all extension coros";
2395	$_->cancel for values %EXT_CORO;
2396	%EXT_CORO = ();
2397
2398	warn "removing commands";
2399	%COMMAND = ();
2400
2401	warn "removing ext commands";
2402	%EXTCMD = ();
2403
2404	warn "unloading/nuking all extensions";
2405	for my $pkg (@EXTS) {
2406	warn "... unloading $pkg";
2407
2408	if (my $cb = $pkg->can ("unload")) {
2409	eval {
2410	$cb->($pkg);
2411	1
2412	} or warn "$pkg unloaded, but with errors: $@";
2413	}	3780	}
2414		3781
2415	warn "... nuking $pkg";	3782	warn "cancelling all extension coros";
2416	Symbol::delete_package $pkg;	3783	$_->cancel for values %EXT_CORO;
2417	}	3784	%EXT_CORO = ();
2418		3785
2419	warn "unloading all perl modules loaded from $LIBDIR";	3786	warn "removing commands";
2420	while (my ($k, $v) = each %INC) {	3787	%COMMAND = ();
2421	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2422		3788
		3789	warn "removing ext/exti commands";
		3790	%EXTCMD = ();
		3791	%EXTICMD = ();
		3792
		3793	warn "unloading/nuking all extensions";
		3794	for my $pkg (@EXTS) {
2423	warn "... unloading $k";	3795	warn "... unloading $pkg";
2424	delete $INC{$k};
2425		3796
2426	$k =~ s/\.pm$//;
2427	$k =~ s/\//::/g;
2428
2429	if (my $cb = $k->can ("unload_module")) {	3797	if (my $cb = $pkg->can ("unload")) {
		3798	eval {
2430	$cb->();	3799	$cb->($pkg);
		3800	1
		3801	} or warn "$pkg unloaded, but with errors: $@";
		3802	}
		3803
		3804	warn "... clearing $pkg";
		3805	clear_package $pkg;
2431	}	3806	}
2432		3807
2433	Symbol::delete_package $k;	3808	warn "unloading all perl modules loaded from $LIBDIR";
		3809	while (my ($k, $v) = each %INC) {
		3810	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		3811
		3812	warn "... unloading $k";
		3813	delete $INC{$k};
		3814
		3815	$k =~ s/\.pm$//;
		3816	$k =~ s/\//::/g;
		3817
		3818	if (my $cb = $k->can ("unload_module")) {
		3819	$cb->();
		3820	}
		3821
		3822	clear_package $k;
2434	}	3823	}
2435		3824
2436	warn "getting rid of safe::, as good as possible";	3825	warn "getting rid of safe::, as good as possible";
2437	Symbol::delete_package "safe::$_"	3826	clear_package "safe::$_"
2438	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3827	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2439		3828
2440	warn "unloading cf.pm \"a bit\"";	3829	warn "unloading cf.pm \"a bit\"";
2441	delete $INC{"cf.pm"};	3830	delete $INC{"cf.pm"};
		3831	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2442		3832
2443	# don't, removes xs symbols, too,	3833	# don't, removes xs symbols, too,
2444	# and global variables created in xs	3834	# and global variables created in xs
2445	#Symbol::delete_package __PACKAGE__;	3835	#clear_package __PACKAGE__;
2446		3836
2447	warn "unload completed, starting to reload now";	3837	warn "unload completed, starting to reload now";
2448		3838
2449	warn "reloading cf.pm";	3839	warn "reloading cf.pm";
2450	require cf;	3840	require cf;
2451	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3841	cf::_connect_to_perl_1;
2452		3842
2453	warn "loading config and database again";	3843	warn "loading config and database again";
2454	cf::cfg_load;	3844	cf::reload_config;
2455	cf::db_load;
2456		3845
2457	warn "loading extensions";	3846	warn "loading extensions";
2458	cf::load_extensions;	3847	cf::load_extensions;
2459		3848
		3849	if ($REATTACH_ON_RELOAD) {
2460	warn "reattaching attachments to objects/players";	3850	warn "reattaching attachments to objects/players";
2461	_global_reattach;	3851	_global_reattach; # objects, sockets
2462	warn "reattaching attachments to maps";	3852	warn "reattaching attachments to maps";
2463	reattach $_ for values %MAP;	3853	reattach $_ for values %MAP;
		3854	warn "reattaching attachments to players";
		3855	reattach $_ for values %PLAYER;
		3856	}
2464		3857
2465	warn "restarting server ticker";	3858	warn "running post_init jobs";
		3859	(pop @POST_INIT)->(1) while @POST_INIT;
2466		3860
2467	$TICK_WATCHER->start;	3861	warn "leaving sync_job";
		3862
		3863	1
		3864	} or do {
		3865	warn $@;
		3866	cf::cleanup "error while reloading, exiting.";
		3867	};
		3868
		3869	warn "reloaded";
		3870	--$RELOAD;
		3871	}
		3872
		3873	$t1 = EV::time - $t1;
		3874	warn "reload completed in ${t1}s\n";
		3875	};
		3876
		3877	our $RELOAD_WATCHER; # used only during reload
		3878
		3879	sub reload_perl() {
		3880	# doing reload synchronously and two reloads happen back-to-back,
		3881	# coro crashes during coro_state_free->destroy here.
		3882
		3883	$RELOAD_WATCHER ||= cf::async {
		3884	Coro::AIO::aio_wait cache_extensions;
		3885
		3886	$RELOAD_WATCHER = EV::timer $TICK * 1.5, 0, sub {
		3887	do_reload_perl;
		3888	undef $RELOAD_WATCHER;
		3889	};
2468	};	3890	};
2469		3891	}
2470	if ($@) {
2471	warn $@;
2472	warn "error while reloading, exiting.";
2473	exit 1;
2474	}
2475
2476	warn "reloaded";
2477	};
2478
2479	our $RELOAD_WATCHER; # used only during reload
2480		3892
2481	register_command "reload" => sub {	3893	register_command "reload" => sub {
2482	my ($who, $arg) = @_;	3894	my ($who, $arg) = @_;
2483		3895
2484	if ($who->flag (FLAG_WIZ)) {	3896	if ($who->flag (FLAG_WIZ)) {
2485	$who->message ("reloading server.");	3897	$who->message ("reloading server.");
2486		3898	async {
2487	# doing reload synchronously and two reloads happen back-to-back,	3899	$Coro::current->{desc} = "perl_reload";
2488	# coro crashes during coro_state_free->destroy here.
2489
2490	$RELOAD_WATCHER ||= Event->timer (
2491	reentrant => 0,
2492	after => 0,
2493	data => WF_AUTOCANCEL,
2494	cb => sub {
2495	reload;	3900	reload_perl;
2496	undef $RELOAD_WATCHER;
2497	},
2498	);	3901	};
2499	}	3902	}
2500	};	3903	};
2501		3904
2502	unshift @INC, $LIBDIR;	3905	unshift @INC, $LIBDIR;
2503		3906
2504	my $bug_warning = 0;	3907	my $bug_warning = 0;
2505		3908
2506	$TICK_WATCHER = Event->timer (	3909	our @WAIT_FOR_TICK;
2507	reentrant => 0,	3910	our @WAIT_FOR_TICK_BEGIN;
2508	parked => 1,	3911
2509	prio => 0,	3912	sub wait_for_tick {
2510	at => $NEXT_TICK || $TICK,	3913	return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
2511	data => WF_AUTOCANCEL,	3914
2512	cb => sub {	3915	my $signal = new Coro::Signal;
		3916	push @WAIT_FOR_TICK, $signal;
		3917	$signal->wait;
		3918	}
		3919
		3920	sub wait_for_tick_begin {
		3921	return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
		3922
		3923	my $signal = new Coro::Signal;
		3924	push @WAIT_FOR_TICK_BEGIN, $signal;
		3925	$signal->wait;
		3926	}
		3927
		3928	sub tick {
2513	if ($Coro::current != $Coro::main) {	3929	if ($Coro::current != $Coro::main) {
2514	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3930	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2515	unless ++$bug_warning > 10;	3931	unless ++$bug_warning > 10;
2516	return;	3932	return;
2517	}	3933	}
2518		3934
2519	$NOW = Event::time;
2520
2521	cf::server_tick; # one server iteration	3935	cf::server_tick; # one server iteration
2522	$RUNTIME += $TICK;
2523	$NEXT_TICK += $TICK;
2524		3936
2525	$WAIT_FOR_TICK->broadcast;	3937	#for(1..3e6){} EV::now_update; $NOW=EV::now; # generate load #d#
2526	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2527		3938
2528	Event::sweep;	3939	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2529	Coro::cede_notself;	3940	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2530		3941	Coro::async_pool {
2531	# my $AFTER = Event::time;	3942	$Coro::current->{desc} = "runtime saver";
2532	# warn $AFTER - $NOW;#d#
2533
2534	# if we are delayed by four ticks or more, skip them all
2535	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2536
2537	$TICK_WATCHER->at ($NEXT_TICK);
2538	$TICK_WATCHER->start;
2539	},
2540	);
2541
2542	IO::AIO::max_poll_time $TICK * 0.1;
2543
2544	undef $Coro::AIO::WATCHER;
2545	$AIO_POLL_WATCHER = Event->io (
2546	reentrant => 0,
2547	fd => IO::AIO::poll_fileno,
2548	poll => 'r',
2549	prio => 6,
2550	data => WF_AUTOCANCEL,
2551	cb => \&IO::AIO::poll_cb,
2552	);
2553
2554	$WRITE_RUNTIME_WATCHER = Event->timer (
2555	reentrant => 0,
2556	data => WF_AUTOCANCEL,
2557	after => 1,
2558	interval => 10,
2559	prio => 6, # keep it lowest so it acts like a watchdog
2560	cb => Coro::unblock_sub {
2561	write_runtime	3943	write_runtime_sync
2562	or warn "ERROR: unable to write runtime file: $!";	3944	or warn "ERROR: unable to write runtime file: $!";
		3945	};
2563	},	3946	}
2564	);	3947
		3948	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3949	$sig->send;
		3950	}
		3951	while (my $sig = shift @WAIT_FOR_TICK) {
		3952	$sig->send;
		3953	}
		3954
		3955	$LOAD = ($NOW - $TICK_START) / $TICK;
		3956	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3957
		3958	if (0) {
		3959	if ($NEXT_TICK) {
		3960	my $jitter = $TICK_START - $NEXT_TICK;
		3961	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		3962	warn "jitter $JITTER\n";#d#
		3963	}
		3964	}
		3965	}
		3966
		3967	{
		3968	# configure BDB
		3969
		3970	BDB::min_parallel 16;
		3971	BDB::max_poll_reqs $TICK * 0.1;
		3972	$AnyEvent::BDB::WATCHER->priority (1);
		3973
		3974	unless ($DB_ENV) {
		3975	$DB_ENV = BDB::db_env_create;
		3976	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		3977	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		3978	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		3979	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3980	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3981
		3982	cf::sync_job {
		3983	eval {
		3984	BDB::db_env_open
		3985	$DB_ENV,
		3986	$BDBDIR,
		3987	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3988	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3989	0666;
		3990
		3991	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3992	};
		3993
		3994	cf::cleanup "db_env_open(db): $@" if $@;
		3995	};
		3996	}
		3997
		3998	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3999	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		4000	};
		4001	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		4002	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		4003	};
		4004	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		4005	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		4006	};
		4007	}
		4008
		4009	{
		4010	# configure IO::AIO
		4011
		4012	IO::AIO::min_parallel 8;
		4013	IO::AIO::max_poll_time $TICK * 0.1;
		4014	undef $AnyEvent::AIO::WATCHER;
		4015	}
		4016
		4017	my $_log_backtrace;
		4018
		4019	sub _log_backtrace {
		4020	my ($msg, @addr) = @_;
		4021
		4022	$msg =~ s/\n//;
		4023
		4024	# limit the # of concurrent backtraces
		4025	if ($_log_backtrace < 2) {
		4026	++$_log_backtrace;
		4027	my $perl_bt = Carp::longmess $msg;
		4028	async {
		4029	$Coro::current->{desc} = "abt $msg";
		4030
		4031	my @bt = fork_call {
		4032	@addr = map { sprintf "%x", $_ } @addr;
		4033	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		4034	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		4035	or die "addr2line: $!";
		4036
		4037	my @funcs;
		4038	my @res = <$fh>;
		4039	chomp for @res;
		4040	while (@res) {
		4041	my ($func, $line) = splice @res, 0, 2, ();
		4042	push @funcs, "[$func] $line";
		4043	}
		4044
		4045	@funcs
		4046	};
		4047
		4048	LOG llevInfo, "[ABT] $perl_bt\n";
		4049	LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
		4050	LOG llevInfo, "[ABT] $_\n" for @bt;
		4051	--$_log_backtrace;
		4052	};
		4053	} else {
		4054	LOG llevInfo, "[ABT] $msg\n";
		4055	LOG llevInfo, "[ABT] [suppressed]\n";
		4056	}
		4057	}
		4058
		4059	# load additional modules
		4060	require "cf/$_.pm" for @EXTRA_MODULES;
		4061	cf::_connect_to_perl_2;
2565		4062
2566	END { cf::emergency_save }	4063	END { cf::emergency_save }
2567		4064
2568	1	4065	1
2569		4066

Diff Legend

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