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.224 by root, Mon Mar 12 21:42:12 2007 UTC vs.
Revision 1.501 by root, Sat Jan 16 23:27:21 2010 UTC

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

Diff Legend

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