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.204 by root, Fri Feb 2 19:59:22 2007 UTC vs.
Revision 1.521 by root, Fri Apr 16 23:28:42 2010 UTC

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

Diff Legend

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