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

Diff Legend

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