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

Diff Legend

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