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

Diff Legend

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