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.170 by root, Sun Jan 14 02:00:37 2007 UTC vs.
Revision 1.493 by root, Mon Oct 26 02:34:37 2009 UTC

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

Diff Legend

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