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.199 by root, Mon Jan 29 14:46:01 2007 UTC vs.
Revision 1.479 by root, Thu Oct 8 05:04:27 2009 UTC

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

Diff Legend

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