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.217 by root, Thu Feb 15 21:07:49 2007 UTC vs.
Revision 1.508 by root, Sun Mar 28 22:29:50 2010 UTC

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

Diff Legend

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