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

Diff Legend

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