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

Diff Legend

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