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

Diff Legend

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