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

Diff Legend

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