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

Diff Legend

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