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.174 by root, Sun Jan 14 19:55:37 2007 UTC vs.
Revision 1.477 by root, Wed Sep 2 22:52:36 2009 UTC

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

Diff Legend

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