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.200 by root, Mon Jan 29 17:57:22 2007 UTC vs.
Revision 1.492 by root, Mon Oct 26 01:22:34 2009 UTC

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

Diff Legend

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