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

Diff Legend

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