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.221 by pippijn, Fri Mar 2 13:32:52 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;
		32	use EV;
9	use Opcode;	33	use Opcode;
10	use Safe;	34	use Safe;
11	use Safe::Hole;	35	use Safe::Hole;
		36	use Storable ();
		37	use Carp ();
12		38
		39	use Guard ();
13	use Coro 3.5 ();	40	use Coro ();
		41	use Coro::State;
		42	use Coro::Handle;
		43	use Coro::EV;
14	use Coro::Event;	44	use Coro::AnyEvent;
15	use Coro::Timer;	45	use Coro::Timer;
16	use Coro::Signal;	46	use Coro::Signal;
17	use Coro::Semaphore;	47	use Coro::Semaphore;
		48	use Coro::SemaphoreSet;
		49	use Coro::AnyEvent;
18	use Coro::AIO;	50	use Coro::AIO;
		51	use Coro::BDB 1.6;
		52	use Coro::Storable;
		53	use Coro::Util ();
19		54
		55	use JSON::XS 2.01 ();
20	use BDB ();	56	use BDB ();
21	use Data::Dumper;	57	use Data::Dumper;
22	use Digest::MD5;
23	use Fcntl;	58	use Fcntl;
24	use IO::AIO 2.32 ();
25	use YAML::Syck ();	59	use YAML::XS ();
		60	use IO::AIO ();
26	use Time::HiRes;	61	use Time::HiRes;
27	use Compress::LZF;	62	use Compress::LZF;
		63	use Digest::MD5 ();
28		64
		65	AnyEvent::detect;
		66
		67	# configure various modules to our taste
		68	#
		69	$Storable::canonical = 1; # reduce rsync transfers
		70	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		71
		72	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
		73
		74	# make sure c-lzf reinitialises itself
		75	Compress::LZF::set_serializer "Storable", "Storable::net_mstore", "Storable::mretrieve";
29	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
30		77
31	use Event; $Event::Eval = 1; # no idea why this is required, but it is	78	# strictly for debugging
		79	$SIG{QUIT} = sub { Carp::cluck "SIGQUIT" };
32		80
33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	81	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34
35	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
36	$YAML::Syck::ImplicitUnicode = 1;
37
38	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
39		82
40	our %COMMAND = ();	83	our %COMMAND = ();
41	our %COMMAND_TIME = ();	84	our %COMMAND_TIME = ();
42		85
43	our @EXTS = (); # list of extension package names	86	our @EXTS = (); # list of extension package names
44	our %EXTCMD = ();	87	our %EXTCMD = ();
		88	our %EXTICMD = ();
45	our %EXT_CORO = (); # coroutines bound to extensions	89	our %EXT_CORO = (); # coroutines bound to extensions
46	our %EXT_MAP = (); # pluggable maps	90	our %EXT_MAP = (); # pluggable maps
47		91
		92	our $RELOAD; # number of reloads so far, non-zero while in reload
48	our @EVENT;	93	our @EVENT;
49	our $LIBDIR = datadir . "/ext";	94	our @REFLECT; # set by XS
		95	our %REFLECT; # set by us
50		96
51	our $TICK = MAX_TIME * 1e-6;	97	our $CONFDIR = confdir;
52	our $TICK_WATCHER;	98	our $DATADIR = datadir;
53	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(!)
54	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written	117	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
55	our $NEXT_TICK;	118	our $NEXT_TICK;
56	our $NOW;
57	our $USE_FSYNC = 1; # use fsync to write maps - default off	119	our $USE_FSYNC = 1; # use fsync to write maps - default on
58		120
		121	our $BDB_DEADLOCK_WATCHER;
		122	our $BDB_CHECKPOINT_WATCHER;
59	our $BDB_POLL_WATCHER;	123	our $BDB_TRICKLE_WATCHER;
60	our $DB_ENV;	124	our $DB_ENV;
		125
		126	our @EXTRA_MODULES = qw(pod match mapscript);
61		127
62	our %CFG;	128	our %CFG;
63		129
64	our $UPTIME; $UPTIME ||= time;	130	our $UPTIME; $UPTIME ||= time;
65	our $RUNTIME;	131	our $RUNTIME;
		132	our $NOW;
66		133
67	our %PLAYER; # all users	134	our (%PLAYER, %PLAYER_LOADING); # all users
68	our %MAP; # all maps	135	our (%MAP, %MAP_LOADING ); # all maps
69	our $LINK_MAP; # the special {link} map, which is always available	136	our $LINK_MAP; # the special {link} map, which is always available
70	our $RANDOM_MAPS = cf::localdir . "/random";
71	our $BDB_ENV_DIR = cf::localdir . "/db";
72
73	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
74	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
75		137
76	# 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 ∕
77	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	139	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
78		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
79	binmode STDOUT;	151	binmode STDOUT;
80	binmode STDERR;	152	binmode STDERR;
81		153
82	# read virtual server time, if available	154	# read virtual server time, if available
83	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	155	unless ($RUNTIME || !-e $RUNTIMEFILE) {
84	open my $fh, "<", cf::localdir . "/runtime"	156	open my $fh, "<", $RUNTIMEFILE
85	or die "unable to read runtime file: $!";	157	or die "unable to read $RUNTIMEFILE file: $!";
86	$RUNTIME = <$fh> + 0.;	158	$RUNTIME = <$fh> + 0.;
87	}	159	}
88		160
89	mkdir cf::localdir;	161	eval "sub TICK() { $TICK } 1" or die;
90	mkdir cf::localdir . "/" . cf::playerdir;	162
91	mkdir cf::localdir . "/" . cf::tmpdir;	163	mkdir $_
92	mkdir cf::localdir . "/" . cf::uniquedir;	164	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
93	mkdir $RANDOM_MAPS;
94	mkdir $BDB_ENV_DIR;
95		165
96	our $EMERGENCY_POSITION;	166	our $EMERGENCY_POSITION;
97		167
98	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::"} };
99		180
100	#############################################################################	181	#############################################################################
101		182
102	=head2 GLOBAL VARIABLES	183	=head2 GLOBAL VARIABLES
103		184
…		…
110	=item $cf::RUNTIME	191	=item $cf::RUNTIME
111		192
112	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
113	every server tick.	194	every server tick.
114		195
115	=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
116		199
117	The perl library directory, where extensions and cf-specific modules can	200	Various directories - "/etc", read-only install directory, perl-library
118	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.
119		204
120	=item $cf::NOW	205	=item $cf::NOW
121		206
122	The time of the last (current) server tick.	207	The time of the last (current) server tick.
123		208
124	=item $cf::TICK	209	=item $cf::TICK
125		210
126	The interval between server ticks, in seconds.	211	The interval between server ticks, in seconds.
127		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
128	=item %cf::CFG	223	=item %cf::CFG
129		224
130	Configuration for the server, loaded from C</etc/crossfire/config>, or	225	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
131	from wherever your confdir points to.	226	from wherever your confdir points to.
132		227
133	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	228	=item cf::wait_for_tick, cf::wait_for_tick_begin
134		229
135	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
136	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
137	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.
138	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.
139		245
140	=back	246	=back
141		247
142	=cut	248	=cut
143		249
144	BEGIN {	250	$Coro::State::WARNHOOK = sub {
145	*CORE::GLOBAL::warn = sub {
146	my $msg = join "", @_;	251	my $msg = join "", @_;
147	utf8::encode $msg;
148		252
149	$msg .= "\n"	253	$msg .= "\n"
150	unless $msg =~ /\n$/;	254	unless $msg =~ /\n$/;
151		255
		256	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		257
152	LOG llevError, $msg;	258	LOG llevError, $msg;
153	};	259	};
154	}	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	};
155		274
156	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	275	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
157	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	276	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
158	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	277	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
159	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	278	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
160	@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';
161	@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)
162		282
163	# 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
164	# within the Safe compartment.	284	# within the Safe compartment.
165	for my $pkg (qw(	285	for my $pkg (qw(
166	cf::global cf::attachable	286	cf::global cf::attachable
167	cf::object cf::object::player	287	cf::object cf::object::player
168	cf::client cf::player	288	cf::client cf::player
169	cf::arch cf::living	289	cf::arch cf::living
		290	cf::map cf::mapspace
170	cf::map cf::party cf::region	291	cf::party cf::region
171	)) {	292	)) {
172	no strict 'refs';
173	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	293	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
174	}	294	}
175		295
176	$Event::DIED = sub {	296	$EV::DIED = sub {
177	warn "error in event callback: @_";	297	Carp::cluck "error in event callback: @_";
178	};	298	};
		299
		300	#############################################################################
179		301
180	=head2 UTILITY FUNCTIONS	302	=head2 UTILITY FUNCTIONS
181		303
182	=over 4	304	=over 4
183		305
…		…
202	$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;
203	$d	325	$d
204	} || "[unable to dump $_[0]: '$@']";	326	} || "[unable to dump $_[0]: '$@']";
205	}	327	}
206		328
207	use JSON::Syck (); # TODO# replace by JSON::PC once working
208
209	=item $ref = cf::from_json $json	329	=item $ref = cf::decode_json $json
210		330
211	Converts a JSON string into the corresponding perl data structure.	331	Converts a JSON string into the corresponding perl data structure.
212		332
213	=cut
214
215	sub from_json($) {
216	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
217	JSON::Syck::Load $_[0]
218	}
219
220	=item $json = cf::to_json $ref	333	=item $json = cf::encode_json $ref
221		334
222	Converts a perl data structure into its JSON representation.	335	Converts a perl data structure into its JSON representation.
223		336
224	=cut	337	=cut
225		338
226	sub to_json($) {	339	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
227	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	340
228	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;
229	}	356	}
230		357
231	=item cf::lock_wait $string	358	=item cf::lock_wait $string
232		359
233	Wait until the given lock is available. See cf::lock_acquire.	360	Wait until the given lock is available. See cf::lock_acquire.
234		361
235	=item my $lock = cf::lock_acquire $string	362	=item my $lock = cf::lock_acquire $string
236		363
237	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
238	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,
239	for example when the coroutine gets canceled), the lock is automatically	366	for example when the coroutine gets canceled), the lock is automatically
240	returned.	367	returned.
241		368
		369	Locks are *not* recursive, locking from the same coro twice results in a
		370	deadlocked coro.
		371
242	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
243	uses map_find and cf::map::load uses map_load).	373	uses map_find and cf::map::load uses map_load).
244		374
245	=cut	375	=item $locked = cf::lock_active $string
246		376
247	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;
248		382
249	sub lock_wait($) {	383	sub lock_wait($) {
250	my ($key) = @_;	384	$LOCKS->wait ($_[0]);
251
252	# wait for lock, if any
253	while ($LOCK{$key}) {
254	push @{ $LOCK{$key} }, $Coro::current;
255	Coro::schedule;
256	}
257	}	385	}
258		386
259	sub lock_acquire($) {	387	sub lock_acquire($) {
260	my ($key) = @_;	388	$LOCKS->guard ($_[0])
		389	}
261		390
262	# wait, to be sure we are not locked	391	sub lock_active($) {
263	lock_wait $key;	392	$LOCKS->count ($_[0]) < 1
264
265	$LOCK{$key} = [];
266
267	Coro::guard {
268	# wake up all waiters, to be on the safe side
269	$_->ready for @{ delete $LOCK{$key} };
270	}
271	}	393	}
272		394
273	sub freeze_mainloop {	395	sub freeze_mainloop {
274	return unless $TICK_WATCHER->is_active;	396	tick_inhibit_inc;
275		397
276	my $guard = Coro::guard {	398	&Guard::guard (\&tick_inhibit_dec);
277	$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	}
278	};	465	}
279	$TICK_WATCHER->stop;	466	};
280	$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;
281	}	481	}
282		482
283	=item cf::async { BLOCK }	483	=item cf::async { BLOCK }
284		484
285	Currently the same as Coro::async_pool, meaning you cannot use	485	Currently the same as Coro::async_pool, meaning you cannot use
…		…
290		490
291	BEGIN { *async = \&Coro::async_pool }	491	BEGIN { *async = \&Coro::async_pool }
292		492
293	=item cf::sync_job { BLOCK }	493	=item cf::sync_job { BLOCK }
294		494
295	The design of crossfire+ requires that the main coro ($Coro::main) is	495	The design of Deliantra requires that the main coroutine ($Coro::main)
296	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
297	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.
298		499
299	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
300	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
301	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
302	fast or be very important.	503	fast or be very important.
…		…
305		506
306	sub sync_job(&) {	507	sub sync_job(&) {
307	my ($job) = @_;	508	my ($job) = @_;
308		509
309	if ($Coro::current == $Coro::main) {	510	if ($Coro::current == $Coro::main) {
		511	my $time = AE::time;
		512
310	# this is the main coro, too bad, we have to block	513	# this is the main coro, too bad, we have to block
311	# till the operation succeeds, freezing the server :/	514	# till the operation succeeds, freezing the server :/
312		515
313	# TODO: use suspend/resume instead	516	LOG llevError, Carp::longmess "sync job";#d#
314	# (but this is cancel-safe)	517
315	my $freeze_guard = freeze_mainloop;	518	my $freeze_guard = freeze_mainloop;
316		519
317	my $busy = 1;	520	my $busy = 1;
318	my @res;	521	my @res;
319		522
320	(async {	523	(async {
		524	$Coro::current->desc ("sync job coro");
321	@res = eval { $job->() };	525	@res = eval { $job->() };
322	warn $@ if $@;	526	warn $@ if $@;
323	undef $busy;	527	undef $busy;
324	})->prio (Coro::PRIO_MAX);	528	})->prio (Coro::PRIO_MAX);
325		529
326	while ($busy) {	530	while ($busy) {
327	Coro::cede or Event::one_event;	531	if (Coro::nready) {
		532	Coro::cede_notself;
		533	} else {
		534	EV::loop EV::LOOP_ONESHOT;
328	}	535	}
		536	}
		537
		538	my $time = AE::time - $time;
		539
		540	$TICK_START += $time; # do not account sync jobs to server load
329		541
330	wantarray ? @res : $res[0]	542	wantarray ? @res : $res[0]
331	} else {	543	} else {
332	# we are in another coroutine, how wonderful, everything just works	544	# we are in another coroutine, how wonderful, everything just works
333		545
…		…
353	$EXT_CORO{$coro+0} = $coro;	565	$EXT_CORO{$coro+0} = $coro;
354		566
355	$coro	567	$coro
356	}	568	}
357		569
358	sub write_runtime {	570	=item fork_call { }, $args
359	my $guard = cf::lock_acquire "write_runtime";
360		571
361	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.
362		576
363	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	577	=cut
364	or return;
365		578
366	my $value = $cf::RUNTIME + 90 + 10;	579	sub fork_call(&@) {
367	# 10 is the runtime save interval, for a monotonic clock	580	my ($cb, @args) = @_;
368	# 60 allows for the watchdog to kill the server.
369		581
370	(aio_write $fh, 0, (length $value), $value, 0) <= 0	582	# we seemingly have to make a local copy of the whole thing,
371	and return;	583	# otherwise perl prematurely frees the stuff :/
		584	# TODO: investigate and fix (likely this will be rather laborious)
372		585
373	# always fsync - this file is important	586	my @res = Coro::Util::fork_eval {
374	aio_fsync $fh	587	reset_signals;
375	and return;	588	&$cb
		589	}, @args;
376		590
377	close $fh	591	wantarray ? @res : $res[-1]
378	or return;	592	}
379		593
380	aio_rename "$runtime~", $runtime	594	sub objinfo {
381	and return;
382
383	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 });
384	}	768	}
385		769
386	=back	770	=back
387		771
388	=cut	772	=cut
389		773
390	#############################################################################	774	#############################################################################
391		775
392	=head2 ATTACHABLE OBJECTS	776	=head2 ATTACHABLE OBJECTS
393		777
394	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
395	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")
396	to it. All such attachable objects support the following methods.	780	to it. All such attachable objects support the following methods.
397		781
398	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>
399	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
400	crossfire+).	784	Deliantra).
401		785
402	=over 4	786	=over 4
403		787
404	=item $attachable->attach ($attachment, key => $value...)	788	=item $attachable->attach ($attachment, key => $value...)
405		789
…		…
449	=item cf::CLASS::attachment $name, ...	833	=item cf::CLASS::attachment $name, ...
450		834
451	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
452	given CLASS can refer to this attachment.	836	given CLASS can refer to this attachment.
453		837
454	Some classes such as crossfire maps and objects can specify attachments	838	Some classes such as deliantra maps and objects can specify attachments
455	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.
456		840
457	These calls expect any number of the following handler/hook descriptions:	841	These calls expect any number of the following handler/hook descriptions:
458		842
459	=over 4	843	=over 4
…		…
568	$registry = $CB_TYPE[$object_type] ||= [];	952	$registry = $CB_TYPE[$object_type] ||= [];
569		953
570	} elsif ($type eq "subtype") {	954	} elsif ($type eq "subtype") {
571	defined $object_type or Carp::croak "subtype specified without type";	955	defined $object_type or Carp::croak "subtype specified without type";
572	my $object_subtype = shift @arg;	956	my $object_subtype = shift @arg;
573	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	957	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
574		958
575	} elsif ($type eq "package") {	959	} elsif ($type eq "package") {
576	my $pkg = shift @arg;	960	my $pkg = shift @arg;
577		961
578	while (my ($name, $id) = each %cb_id) {	962	while (my ($name, $id) = each %cb_id) {
…		…
607	_attach $registry, $klass, @attach;	991	_attach $registry, $klass, @attach;
608	}	992	}
609		993
610	$obj->{$name} = \%arg;	994	$obj->{$name} = \%arg;
611	} else {	995	} else {
612	warn "object uses attachment '$name' that is not available, postponing.\n";	996	warn "object uses attachment '$name' which is not available, postponing.\n";
613	}	997	}
614		998
615	$obj->{_attachment}{$name} = undef;	999	$obj->{_attachment}{$name} = undef;
616	}	1000	}
617		1001
…		…
619	if (ref $_[0]) {	1003	if (ref $_[0]) {
620	_object_attach @_;	1004	_object_attach @_;
621	} else {	1005	} else {
622	_attach shift->_attach_registry, @_;	1006	_attach shift->_attach_registry, @_;
623	}	1007	}
		1008	_recalc_want;
624	};	1009	};
625		1010
626	# all those should be optimised	1011	# all those should be optimised
627	sub cf::attachable::detach {	1012	sub cf::attachable::detach {
628	my ($obj, $name) = @_;	1013	my ($obj, $name) = @_;
…		…
631	delete $obj->{_attachment}{$name};	1016	delete $obj->{_attachment}{$name};
632	reattach ($obj);	1017	reattach ($obj);
633	} else {	1018	} else {
634	Carp::croak "cannot, currently, detach class attachments";	1019	Carp::croak "cannot, currently, detach class attachments";
635	}	1020	}
		1021	_recalc_want;
636	};	1022	};
637		1023
638	sub cf::attachable::attached {	1024	sub cf::attachable::attached {
639	my ($obj, $name) = @_;	1025	my ($obj, $name) = @_;
640		1026
…		…
655	";	1041	";
656	die if $@;	1042	die if $@;
657	}	1043	}
658		1044
659	our $override;	1045	our $override;
660	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?
661		1047
662	sub override {	1048	sub override {
663	$override = 1;	1049	$override = 1;
664	@invoke_results = ();	1050	@INVOKE_RESULTS = (@_);
665	}	1051	}
666		1052
667	sub do_invoke {	1053	sub do_invoke {
668	my $event = shift;	1054	my $event = shift;
669	my $callbacks = shift;	1055	my $callbacks = shift;
670		1056
671	@invoke_results = ();	1057	@INVOKE_RESULTS = ();
672		1058
673	local $override;	1059	local $override;
674		1060
675	for (@$callbacks) {	1061	for (@$callbacks) {
676	eval { &{$_->[1]} };	1062	eval { &{$_->[1]} };
…		…
685	}	1071	}
686		1072
687	0	1073	0
688	}	1074	}
689		1075
690	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1076	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
691		1077
692	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1078	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
693		1079
694	Generate an object-specific event with the given arguments.	1080	Generate an object-specific event with the given arguments.
695		1081
696	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
697	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
698	results (if you must, access C<@cf::invoke_results> directly).	1084	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
699		1085
700	=back	1086	=back
701		1087
702	=cut	1088	=cut
703		1089
704	#############################################################################	1090	#############################################################################
705	# 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	}
706		1134
707	sub reattach {	1135	sub reattach {
708	# basically do the same as instantiate, without calling instantiate	1136	# basically do the same as instantiate, without calling instantiate
709	my ($obj) = @_;	1137	my ($obj) = @_;
710		1138
		1139	# no longer needed after getting rid of delete_package?
711	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
712		1141
713	my $registry = $obj->registry;	1142	my $registry = $obj->registry;
714		1143
715	@$registry = ();	1144	@$registry = ();
716		1145
…		…
731	cf::attachable->attach (	1160	cf::attachable->attach (
732	prio => -1000000,	1161	prio => -1000000,
733	on_instantiate => sub {	1162	on_instantiate => sub {
734	my ($obj, $data) = @_;	1163	my ($obj, $data) = @_;
735		1164
736	$data = from_json $data;	1165	$data = decode_json $data;
737		1166
738	for (@$data) {	1167	for (@$data) {
739	my ($name, $args) = @$_;	1168	my ($name, $args) = @$_;
740		1169
741	$obj->attach ($name, %{$args || {} });	1170	$obj->attach ($name, %{$args || {} });
…		…
757	sub object_freezer_save {	1186	sub object_freezer_save {
758	my ($filename, $rdata, $objs) = @_;	1187	my ($filename, $rdata, $objs) = @_;
759		1188
760	sync_job {	1189	sync_job {
761	if (length $$rdata) {	1190	if (length $$rdata) {
		1191	utf8::decode (my $decname = $filename);
762	warn sprintf "saving %s (%d,%d)\n",	1192	warn sprintf "saving %s (%d,%d)\n",
763	$filename, length $$rdata, scalar @$objs;	1193	$decname, length $$rdata, scalar @$objs;
764		1194
765	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1195	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
766	chmod SAVE_MODE, $fh;	1196	aio_chmod $fh, SAVE_MODE;
767	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1197	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
768	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	}
769	close $fh;	1202	aio_close $fh;
770		1203
771	if (@$objs) {	1204	if (@$objs) {
772	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) {
773	chmod SAVE_MODE, $fh;	1206	aio_chmod $fh, SAVE_MODE;
774	my $data = Storable::nfreeze { version => 1, objs => $objs };	1207	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
775	aio_write $fh, 0, (length $data), $data, 0;	1208	aio_write $fh, 0, (length $data), $data, 0;
776	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	}
777	close $fh;	1213	aio_close $fh;
778	aio_rename "$filename.pst~", "$filename.pst";	1214	aio_rename "$filename.pst~", "$filename.pst";
779	}	1215	}
780	} else {	1216	} else {
781	aio_unlink "$filename.pst";	1217	aio_unlink "$filename.pst";
782	}	1218	}
783		1219
784	aio_rename "$filename~", $filename;	1220	aio_rename "$filename~", $filename;
		1221
		1222	$filename =~ s%/[^/]+$%%;
		1223	aio_pathsync $filename if $cf::USE_FSYNC;
785	} else {	1224	} else {
786	warn "FATAL: $filename~: $!\n";	1225	warn "unable to save objects: $filename~: $!\n";
787	}	1226	}
788	} else {	1227	} else {
789	aio_unlink $filename;	1228	aio_unlink $filename;
790	aio_unlink "$filename.pst";	1229	aio_unlink "$filename.pst";
791	}	1230	}
792	}	1231	};
793	}	1232	}
794		1233
795	sub object_freezer_as_string {	1234	sub object_freezer_as_string {
796	my ($rdata, $objs) = @_;	1235	my ($rdata, $objs) = @_;
797		1236
…		…
809	or return;	1248	or return;
810		1249
811	unless (aio_stat "$filename.pst") {	1250	unless (aio_stat "$filename.pst") {
812	(aio_load "$filename.pst", $av) >= 0	1251	(aio_load "$filename.pst", $av) >= 0
813	or return;	1252	or return;
		1253
814	$av = eval { (Storable::thaw $av)->{objs} };	1254	my $st = eval { Coro::Storable::thaw $av };
		1255	$av = $st->{objs};
815	}	1256	}
816		1257
		1258	utf8::decode (my $decname = $filename);
817	warn sprintf "loading %s (%d)\n",	1259	warn sprintf "loading %s (%d,%d)\n",
818	$filename, length $data, scalar @{$av || []};#d#	1260	$decname, length $data, scalar @{$av || []};
		1261
819	return ($data, $av);	1262	($data, $av)
820	}	1263	}
		1264
		1265	=head2 COMMAND CALLBACKS
		1266
		1267	=over 4
		1268
		1269	=cut
821		1270
822	#############################################################################	1271	#############################################################################
823	# command handling &c	1272	# command handling &c
824		1273
825	=item cf::register_command $name => \&callback($ob,$args);	1274	=item cf::register_command $name => \&callback($ob,$args);
…		…
838	push @{ $COMMAND{$name} }, [$caller, $cb];	1287	push @{ $COMMAND{$name} }, [$caller, $cb];
839	}	1288	}
840		1289
841	=item cf::register_extcmd $name => \&callback($pl,$packet);	1290	=item cf::register_extcmd $name => \&callback($pl,$packet);
842		1291
843	Register a callbackf ro execution when the client sends an extcmd packet.	1292	Register a callback for execution when the client sends an (synchronous)
		1293	extcmd packet. Ext commands will be processed in the order they are
		1294	received by the server, like other user commands. The first argument is
		1295	the logged-in player. Ext commands can only be processed after a player
		1296	has logged in successfully.
844		1297
845	If the callback returns something, it is sent back as if reply was being	1298	If the callback returns something, it is sent back as if reply was being
846	called.	1299	called.
847		1300
		1301	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1302
		1303	Register a callback for execution when the client sends an (asynchronous)
		1304	exticmd packet. Exti commands are processed by the server as soon as they
		1305	are received, i.e. out of order w.r.t. other commands. The first argument
		1306	is a client socket. Exti commands can be received anytime, even before
		1307	log-in.
		1308
		1309	If the callback returns something, it is sent back as if reply was being
		1310	called.
		1311
848	=cut	1312	=cut
849		1313
850	sub register_extcmd {	1314	sub register_extcmd {
851	my ($name, $cb) = @_;	1315	my ($name, $cb) = @_;
852		1316
853	$EXTCMD{$name} = $cb;	1317	$EXTCMD{$name} = $cb;
854	}	1318	}
855		1319
		1320	sub register_exticmd {
		1321	my ($name, $cb) = @_;
		1322
		1323	$EXTICMD{$name} = $cb;
		1324	}
		1325
		1326	use File::Glob ();
		1327
856	cf::player->attach (	1328	cf::player->attach (
857	on_command => sub {	1329	on_unknown_command => sub {
858	my ($pl, $name, $params) = @_;	1330	my ($pl, $name, $params) = @_;
859		1331
860	my $cb = $COMMAND{$name}	1332	my $cb = $COMMAND{$name}
861	or return;	1333	or return;
862		1334
…		…
867	cf::override;	1339	cf::override;
868	},	1340	},
869	on_extcmd => sub {	1341	on_extcmd => sub {
870	my ($pl, $buf) = @_;	1342	my ($pl, $buf) = @_;
871		1343
872	my $msg = eval { from_json $buf };	1344	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
873		1345
874	if (ref $msg) {	1346	if (ref $msg) {
		1347	my ($type, $reply, @payload) =
		1348	"ARRAY" eq ref $msg
		1349	? @$msg
		1350	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1351
		1352	my @reply;
		1353
875	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1354	if (my $cb = $EXTCMD{$type}) {
876	if (my %reply = $cb->($pl, $msg)) {	1355	@reply = $cb->($pl, @payload);
877	$pl->ext_reply ($msg->{msgid}, %reply);
878	}
879	}	1356	}
		1357
		1358	$pl->ext_reply ($reply, @reply)
		1359	if $reply;
		1360
880	} else {	1361	} else {
881	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1362	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
882	}	1363	}
883		1364
884	cf::override;	1365	cf::override;
885	},	1366	},
886	);	1367	);
887		1368
		1369	# "readahead" all extensions
888	sub load_extension {	1370	sub cache_extensions {
889	my ($path) = @_;	1371	my $grp = IO::AIO::aio_group;
890		1372
891	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1373	add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
892	my $base = $1;	1374	for (grep /\.ext$/, @{$_[0]}) {
893	my $pkg = $1;	1375	add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
894	$pkg =~ s/[^[:word:]]/_/g;
895	$pkg = "ext::$pkg";
896
897	warn "... loading '$path' into '$pkg'\n";
898
899	open my $fh, "<:utf8", $path
900	or die "$path: $!";
901
902	my $source =
903	"package $pkg; use strict; use utf8;\n"
904	. "#line 1 \"$path\"\n{\n"
905	. (do { local $/; <$fh> })
906	. "\n};\n1";
907
908	unless (eval $source) {
909	my $msg = $@ ? "$path: $@\n"
910	: "extension disabled.\n";
911	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
912	warn $@;
913	warn "mandatory extension failed to load, exiting.\n";
914	exit 1;
915	}	1376	}
916	die $@;
917	}	1377	};
918		1378
919	push @EXTS, $pkg;	1379	$grp
920	}	1380	}
921		1381
922	sub load_extensions {	1382	sub load_extensions {
		1383	cf::sync_job {
		1384	my %todo;
		1385
923	for my $ext (<$LIBDIR/*.ext>) {	1386	for my $path (<$LIBDIR/*.ext>) {
924	next unless -r $ext;	1387	next unless -r $path;
925	eval {	1388
926	load_extension $ext;	1389	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1390	my $base = $1;
		1391	my $pkg = $1;
		1392	$pkg =~ s/[^[:word:]]/_/g;
		1393	$pkg = "ext::$pkg";
		1394
		1395	open my $fh, "<:utf8", $path
		1396	or die "$path: $!";
		1397
		1398	my $source = do { local $/; <$fh> };
		1399
		1400	my %ext = (
		1401	path => $path,
		1402	base => $base,
		1403	pkg => $pkg,
		1404	);
		1405
		1406	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1407	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1408
		1409	$ext{source} =
		1410	"package $pkg; use 5.10.0; use strict 'vars', 'subs'; use utf8;\n"
		1411	. "#line 1 \"$path\"\n{\n"
		1412	. $source
		1413	. "\n};\n1";
		1414
		1415	$todo{$base} = \%ext;
		1416	}
		1417
		1418	my $pass = 0;
		1419	my %done;
		1420	while (%todo) {
		1421	my $progress;
		1422
		1423	++$pass;
		1424
		1425	ext:
		1426	while (my ($k, $v) = each %todo) {
		1427	for (split /,\s*/, $v->{meta}{depends}) {
		1428	next ext
		1429	unless exists $done{$_};
		1430	}
		1431
		1432	warn "... pass $pass, loading '$k' into '$v->{pkg}'\n";
		1433
		1434	my $active = eval $v->{source};
		1435
		1436	if (length $@) {
		1437	warn "$v->{path}: $@\n";
		1438
		1439	cf::cleanup "mandatory extension '$k' failed to load, exiting."
		1440	if exists $v->{meta}{mandatory};
		1441	} 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	}
927	1	1449	}
928	} 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	}
929	}	1460	};
930	}	1461	}
931		1462
932	#############################################################################	1463	#############################################################################
933		1464
		1465	=back
		1466
934	=head2 CORE EXTENSIONS	1467	=head2 CORE EXTENSIONS
935		1468
936	Functions and methods that extend core crossfire objects.	1469	Functions and methods that extend core deliantra objects.
937		1470
938	=cut	1471	=cut
939		1472
940	package cf::player;	1473	package cf::player;
941		1474
…		…
943		1476
944	=head3 cf::player	1477	=head3 cf::player
945		1478
946	=over 4	1479	=over 4
947		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
948	=item cf::player::find $login	1495	=item cf::player::find $login
949		1496
950	Returns the given player object, loading it if necessary (might block).	1497	Returns the given player object, loading it if necessary (might block).
951		1498
952	=cut	1499	=cut
953		1500
954	sub playerdir($) {	1501	sub playerdir($) {
955	cf::localdir	1502	"$PLAYERDIR/"
956	. "/"
957	. cf::playerdir
958	. "/"
959	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1503	. (ref $_[0] ? $_[0]->ob->name : $_[0])
960	}	1504	}
961		1505
962	sub path($) {	1506	sub path($) {
963	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1507	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
964		1508
965	(playerdir $login) . "/$login.pl"	1509	(playerdir $login) . "/playerdata"
966	}	1510	}
967		1511
968	sub find_active($) {	1512	sub find_active($) {
969	$cf::PLAYER{$_[0]}	1513	$cf::PLAYER{$_[0]}
970	and $cf::PLAYER{$_[0]}->active	1514	and $cf::PLAYER{$_[0]}->active
…		…
973		1517
974	sub exists($) {	1518	sub exists($) {
975	my ($login) = @_;	1519	my ($login) = @_;
976		1520
977	$cf::PLAYER{$login}	1521	$cf::PLAYER{$login}
978	or cf::sync_job { !aio_stat path $login }	1522	or !aio_stat path $login
979	}	1523	}
980		1524
981	sub find($) {	1525	sub find($) {
982	return $cf::PLAYER{$_[0]} || do {	1526	return $cf::PLAYER{$_[0]} || do {
983	my $login = $_[0];	1527	my $login = $_[0];
984		1528
985	my $guard = cf::lock_acquire "user_find:$login";	1529	my $guard = cf::lock_acquire "user_find:$login";
986		1530
987	$cf::PLAYER{$_[0]} || do {	1531	$cf::PLAYER{$_[0]} || do {
988	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
989	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;
990	$cf::PLAYER{$login} = $pl	1547	$cf::PLAYER{$login} = $pl
991	}	1548	}
992	}	1549	}
993	}	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	);
994		1564
995	sub save($) {	1565	sub save($) {
996	my ($pl) = @_;	1566	my ($pl) = @_;
997		1567
998	return if $pl->{deny_save};	1568	return if $pl->{deny_save};
…		…
1003	return if $pl->{deny_save};	1573	return if $pl->{deny_save};
1004		1574
1005	aio_mkdir playerdir $pl, 0770;	1575	aio_mkdir playerdir $pl, 0770;
1006	$pl->{last_save} = $cf::RUNTIME;	1576	$pl->{last_save} = $cf::RUNTIME;
1007		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
1008	$pl->save_pl ($path);	1583	$pl->save_pl ($path);
1009	Coro::cede;	1584	cf::cede_to_tick;
1010	}	1585	}
1011		1586
1012	sub new($) {	1587	sub new($) {
1013	my ($login) = @_;	1588	my ($login) = @_;
1014		1589
…		…
1020	$cf::PLAYER{$login} = $self;	1595	$cf::PLAYER{$login} = $self;
1021		1596
1022	$self	1597	$self
1023	}	1598	}
1024		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
1025	=item $pl->quit_character	1610	=item $pl->quit_character
1026		1611
1027	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
1028	be destroyed. May block for a long time.	1613	be destroyed. May block for a long time.
1029		1614
…		…
1033	my ($pl) = @_;	1618	my ($pl) = @_;
1034		1619
1035	my $name = $pl->ob->name;	1620	my $name = $pl->ob->name;
1036		1621
1037	$pl->{deny_save} = 1;	1622	$pl->{deny_save} = 1;
1038	$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
1039		1624
1040	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1625	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1041	$pl->deactivate;	1626	$pl->deactivate;
		1627	my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
		1628	$pl->ob->check_score;
1042	$pl->invoke (cf::EVENT_PLAYER_QUIT);	1629	$pl->invoke (cf::EVENT_PLAYER_QUIT);
1043	$pl->ns->destroy if $pl->ns;	1630	$pl->ns->destroy if $pl->ns;
1044		1631
1045	my $path = playerdir $pl;	1632	my $path = playerdir $pl;
1046	my $temp = "$path~$cf::RUNTIME~deleting~";	1633	my $temp = "$path~$cf::RUNTIME~deleting~";
…		…
1076	while and may block, so not sync_job-capable, ever.	1663	while and may block, so not sync_job-capable, ever.
1077		1664
1078	=cut	1665	=cut
1079		1666
1080	sub list_logins {	1667	sub list_logins {
1081	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1668	my $dirs = aio_readdir $PLAYERDIR
1082	or return [];	1669	or return [];
1083		1670
1084	my @logins;	1671	my @logins;
1085		1672
1086	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") {
1087	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1679	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1088	aio_read $fh, 0, 512, my $buf, 0 or next;	1680	aio_read $fh, 0, 512, my $buf, 0 or next;
1089	$buf !~ /^password -------------$/m or next; # official not-valid tag	1681	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1682	}
1090		1683
1091	utf8::decode $login;	1684	utf8::decode $login;
1092	push @logins, $login;	1685	push @logins, $login;
1093	}	1686	}
1094		1687
…		…
1121	}	1714	}
1122		1715
1123	\@paths	1716	\@paths
1124	}	1717	}
1125		1718
		1719	=item $protocol_xml = $player->expand_cfpod ($cfpod)
		1720
		1721	Expand deliantra pod fragments into protocol xml.
		1722
1126	=item $player->ext_reply ($msgid, $msgtype, %msg)	1723	=item $player->ext_reply ($msgid, @msg)
1127		1724
1128	Sends an ext reply to the player.	1725	Sends an ext reply to the player.
1129		1726
1130	=cut	1727	=cut
1131		1728
1132	sub ext_reply($$$%) {	1729	sub ext_reply($$@) {
1133	my ($self, $id, %msg) = @_;	1730	my ($self, $id, @msg) = @_;
1134		1731
1135	$msg{msgid} = $id;	1732	$self->ns->ext_reply ($id, @msg)
1136
1137	$self->send ("ext " . cf::to_json \%msg);
1138	}	1733	}
1139		1734
1140	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	}
1141		1775
1142	=back	1776	=back
1143
1144		1777
1145	=head3 cf::map	1778	=head3 cf::map
1146		1779
1147	=over 4	1780	=over 4
1148		1781
…		…
1160	our $MAX_RESET = 3600;	1793	our $MAX_RESET = 3600;
1161	our $DEFAULT_RESET = 3000;	1794	our $DEFAULT_RESET = 3000;
1162		1795
1163	sub generate_random_map {	1796	sub generate_random_map {
1164	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
1165	# mit "rum" bekleckern, nicht	1801	# mit "rum" bekleckern, nicht
1166	$self->_create_random_map (	1802	$self->_create_random_map (
1167	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1803	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1168	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1804	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, $rmp->{miningstyle},
1169	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1805	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1170	$rmp->{exit_on_final_map},	1806	$rmp->{exit_on_final_map},
1171	$rmp->{xsize}, $rmp->{ysize},	1807	$rmp->{xsize}, $rmp->{ysize},
1172	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1808	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1173	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1809	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
…		…
1203	my ($self, $merge) = @_;	1839	my ($self, $merge) = @_;
1204		1840
1205	# we have to keep some variables in memory intact	1841	# we have to keep some variables in memory intact
1206	local $self->{path};	1842	local $self->{path};
1207	local $self->{load_path};	1843	local $self->{load_path};
1208	local $self->{deny_save};
1209	local $self->{deny_reset};
1210		1844
1211	$self->SUPER::thawer_merge ($merge);	1845	$self->SUPER::thawer_merge ($merge);
1212	}	1846	}
1213		1847
1214	sub normalise {	1848	sub normalise {
…		…
1261	$self->init; # pass $1 etc.	1895	$self->init; # pass $1 etc.
1262	return $self;	1896	return $self;
1263	}	1897	}
1264	}	1898	}
1265		1899
1266	Carp::carp "unable to resolve path '$path' (base '$base').";	1900	Carp::cluck "unable to resolve path '$path' (base '$base').";
1267	()	1901	()
1268	}	1902	}
1269		1903
1270	sub init {	1904	sub init {
1271	my ($self) = @_;	1905	my ($self) = @_;
…		…
1286		1920
1287	# the original (read-only) location	1921	# the original (read-only) location
1288	sub load_path {	1922	sub load_path {
1289	my ($self) = @_;	1923	my ($self) = @_;
1290		1924
1291	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1925	"$MAPDIR/$self->{path}.map"
1292	}	1926	}
1293		1927
1294	# the temporary/swap location	1928	# the temporary/swap location
1295	sub save_path {	1929	sub save_path {
1296	my ($self) = @_;	1930	my ($self) = @_;
1297		1931
1298	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1932	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1299	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1933	"$TMPDIR/$path.map"
1300	}	1934	}
1301		1935
1302	# the unique path, undef == no special unique path	1936	# the unique path, undef == no special unique path
1303	sub uniq_path {	1937	sub uniq_path {
1304	my ($self) = @_;	1938	my ($self) = @_;
1305		1939
1306	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1940	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1307	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1941	"$UNIQUEDIR/$path"
1308	}	1942	}
1309		1943
1310	# and all this just because we cannot iterate over	1944	sub decay_objects {
1311	# all maps in C++...
1312	sub change_all_map_light {
1313	my ($change) = @_;	1945	my ($self) = @_;
1314		1946
1315	$_->change_map_light ($change)	1947	return if $self->{deny_reset};
1316	for grep $_->outdoor, values %cf::MAP;	1948
		1949	$self->do_decay_objects;
1317	}	1950	}
1318		1951
1319	sub unlink_save {	1952	sub unlink_save {
1320	my ($self) = @_;	1953	my ($self) = @_;
1321		1954
…		…
1326		1959
1327	sub load_header_from($) {	1960	sub load_header_from($) {
1328	my ($self, $path) = @_;	1961	my ($self, $path) = @_;
1329		1962
1330	utf8::encode $path;	1963	utf8::encode $path;
1331	#aio_open $path, O_RDONLY, 0	1964	my $f = new_from_file cf::object::thawer $path
1332	# or return;
1333
1334	$self->_load_header ($path)
1335	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;
1336		1972
1337	$self->{load_path} = $path;	1973	$self->{load_path} = $path;
1338		1974
1339	1	1975	1
1340	}	1976	}
…		…
1379	$self->load_header_orig	2015	$self->load_header_orig
1380	or return;	2016	or return;
1381	$self->prepare_orig;	2017	$self->prepare_orig;
1382	}	2018	}
1383		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
1384	1	2026	1
1385	}	2027	}
1386		2028
1387	sub find;	2029	sub find;
1388	sub find {	2030	sub find {
1389	my ($path, $origin) = @_;	2031	my ($path, $origin) = @_;
1390		2032
1391	$path = normalise $path, $origin && $origin->path;	2033	$path = normalise $path, $origin && $origin->path;
1392		2034
		2035	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1393	cf::lock_wait "map_find:$path";	2036	my $guard2 = cf::lock_acquire "map_find:$path";
1394		2037
1395	$cf::MAP{$path} || do {	2038	$cf::MAP{$path} || do {
1396	my $guard = cf::lock_acquire "map_find:$path";
1397	my $map = new_from_path cf::map $path	2039	my $map = new_from_path cf::map $path
1398	or return;	2040	or return;
1399		2041
1400	$map->{last_save} = $cf::RUNTIME;	2042	$map->{last_save} = $cf::RUNTIME;
1401		2043
1402	$map->load_header	2044	$map->load_header
1403	or return;	2045	or return;
1404		2046
1405	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	2047	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1406	# doing this can freeze the server in a sync job, obviously	2048	# doing this can freeze the server in a sync job, obviously
1407	#$cf::WAIT_FOR_TICK->wait;	2049	#$cf::WAIT_FOR_TICK->wait;
		2050	undef $guard2;
		2051	undef $guard1;
1408	$map->reset;	2052	$map->reset;
1409	undef $guard;
1410	return find $path;	2053	return find $path;
1411	}	2054	}
1412		2055
1413	$cf::MAP{$path} = $map	2056	$cf::MAP{$path} = $map
1414	}	2057	}
1415	}	2058	}
1416		2059
1417	sub pre_load { }	2060	sub pre_load { }
1418	sub post_load { }	2061	#sub post_load { } # XS
1419		2062
1420	sub load {	2063	sub load {
1421	my ($self) = @_;	2064	my ($self) = @_;
1422		2065
1423	local $self->{deny_reset} = 1; # loading can take a long time	2066	local $self->{deny_reset} = 1; # loading can take a long time
1424		2067
1425	my $path = $self->{path};	2068	my $path = $self->{path};
		2069
		2070	{
1426	my $guard = cf::lock_acquire "map_load:$path";	2071	my $guard = cf::lock_acquire "map_data:$path";
1427		2072
		2073	return unless $self->valid;
1428	return if $self->in_memory != cf::MAP_SWAPPED;	2074	return unless $self->in_memory == cf::MAP_SWAPPED;
1429		2075
1430	$self->in_memory (cf::MAP_LOADING);	2076	$self->in_memory (cf::MAP_LOADING);
1431		2077
1432	$self->alloc;	2078	$self->alloc;
1433		2079
1434	$self->pre_load;	2080	$self->pre_load;
		2081	cf::cede_to_tick;
1435		2082
1436	$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)
1437	or return;	2086	or return;
1438		2087
1439	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2088	$self->post_load_original
1440	if delete $self->{load_original};	2089	if delete $self->{load_original};
1441		2090
1442	if (my $uniq = $self->uniq_path) {	2091	if (my $uniq = $self->uniq_path) {
1443	utf8::encode $uniq;	2092	utf8::encode $uniq;
1444	if (aio_open $uniq, O_RDONLY, 0) {	2093	unless (aio_stat $uniq) {
		2094	if (my $f = new_from_file cf::object::thawer $uniq) {
1445	$self->clear_unique_items;	2095	$self->clear_unique_items;
1446	$self->_load_objects ($uniq, 0);	2096	$self->_load_objects ($f);
		2097	$f->resolve_delayed_derefs;
		2098	}
1447	}	2099	}
1448	}	2100	}
1449		2101
1450	Coro::cede;	2102	$f->resolve_delayed_derefs;
1451		2103
		2104	cf::cede_to_tick;
1452	# now do the right thing for maps	2105	# now do the right thing for maps
1453	$self->link_multipart_objects;	2106	$self->link_multipart_objects;
1454
1455	unless ($self->{deny_activate}) {
1456	$self->decay_objects;
1457	$self->fix_auto_apply;
1458	$self->update_buttons;
1459	Coro::cede;
1460	$self->set_darkness_map;
1461	$self->difficulty ($self->estimate_difficulty)	2107	$self->difficulty ($self->estimate_difficulty)
1462	unless $self->difficulty;	2108	unless $self->difficulty;
1463	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;
1464	$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);
1465	}	2123	}
1466		2124
1467	$self->post_load;	2125	$self->post_load;
1468
1469	$self->in_memory (cf::MAP_IN_MEMORY);
1470	}	2126	}
1471		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
1472	sub customise_for {	2131	sub customise_for {
1473	my ($self, $ob) = @_;	2132	my ($self, $ob) = @_;
1474		2133
1475	return find "~" . $ob->name . "/" . $self->{path}	2134	return find "~" . $ob->name . "/" . $self->{path}
1476	if $self->per_player;	2135	if $self->per_player;
1477		2136
		2137	# return find "?party/" . $ob->name . "/" . $self->{path}
		2138	# if $self->per_party;
		2139
1478	$self	2140	$self
1479	}	2141	}
1480		2142
1481	# 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
1482	sub load_diag {	2144	sub load_neighbours {
1483	my ($map) = @_;	2145	my ($map) = @_;
1484		2146
1485	my @diag; # diagonal neighbours	2147	my @neigh; # diagonal neighbours
1486		2148
1487	for (0 .. 3) {	2149	for (0 .. 3) {
1488	my $neigh = $map->tile_path ($_)	2150	my $neigh = $map->tile_path ($_)
1489	or next;	2151	or next;
1490	$neigh = find $neigh, $map	2152	$neigh = find $neigh, $map
1491	or next;	2153	or next;
1492	$neigh->load;	2154	$neigh->load;
1493		2155
		2156	push @neigh,
1494	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2157	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1495	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2158	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1496	}	2159	}
1497		2160
1498	for (@diag) {	2161	for (grep defined $_->[0], @neigh) {
		2162	my ($path, $origin) = @$_;
1499	my $neigh = find @$_	2163	my $neigh = find $path, $origin
1500	or next;	2164	or next;
1501	$neigh->load;	2165	$neigh->load;
1502	}	2166	}
1503	}	2167	}
1504		2168
…		…
1509	}	2173	}
1510		2174
1511	sub do_load_sync {	2175	sub do_load_sync {
1512	my ($map) = @_;	2176	my ($map) = @_;
1513		2177
		2178	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2179	if $Coro::current == $Coro::main;
		2180
1514	cf::sync_job { $map->load };	2181	cf::sync_job { $map->load };
1515	}	2182	}
1516		2183
1517	our %MAP_PREFETCH;	2184	our %MAP_PREFETCH;
1518	our $MAP_PREFETCHER = undef;	2185	our $MAP_PREFETCHER = undef;
1519		2186
1520	sub find_async {	2187	sub find_async {
1521	my ($path, $origin) = @_;	2188	my ($path, $origin, $load) = @_;
1522		2189
1523	$path = normalise $path, $origin && $origin->{path};	2190	$path = normalise $path, $origin && $origin->{path};
1524		2191
1525	if (my $map = $cf::MAP{$path}) {	2192	if (my $map = $cf::MAP{$path}) {
1526	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2193	return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
1527	}	2194	}
1528		2195
1529	undef $MAP_PREFETCH{$path};	2196	$MAP_PREFETCH{$path} |= $load;
		2197
1530	$MAP_PREFETCHER ||= cf::async {	2198	$MAP_PREFETCHER ||= cf::async {
		2199	$Coro::current->{desc} = "map prefetcher";
		2200
1531	while (%MAP_PREFETCH) {	2201	while (%MAP_PREFETCH) {
1532	for my $path (keys %MAP_PREFETCH) {	2202	while (my ($k, $v) = each %MAP_PREFETCH) {
1533	my $map = find $path	2203	if (my $map = find $k) {
1534	or next;
1535	$map->load;	2204	$map->load if $v;
		2205	}
1536		2206
1537	delete $MAP_PREFETCH{$path};	2207	delete $MAP_PREFETCH{$k};
1538	}	2208	}
1539	}	2209	}
1540	undef $MAP_PREFETCHER;	2210	undef $MAP_PREFETCHER;
1541	};	2211	};
1542	$MAP_PREFETCHER->prio (6);	2212	$MAP_PREFETCHER->prio (6);
…		…
1545	}	2215	}
1546		2216
1547	sub save {	2217	sub save {
1548	my ($self) = @_;	2218	my ($self) = @_;
1549		2219
1550	my $lock = cf::lock_acquire "map_data:" . $self->path;	2220	my $lock = cf::lock_acquire "map_data:$self->{path}";
1551		2221
1552	$self->{last_save} = $cf::RUNTIME;	2222	$self->{last_save} = $cf::RUNTIME;
1553		2223
1554	return unless $self->dirty;	2224	return unless $self->dirty;
1555		2225
…		…
1561	return if $self->{deny_save};	2231	return if $self->{deny_save};
1562		2232
1563	local $self->{last_access} = $self->last_access;#d#	2233	local $self->{last_access} = $self->last_access;#d#
1564		2234
1565	cf::async {	2235	cf::async {
		2236	$Coro::current->{desc} = "map player save";
1566	$_->contr->save for $self->players;	2237	$_->contr->save for $self->players;
1567	};	2238	};
		2239
		2240	cf::get_slot 0.02;
1568		2241
1569	if ($uniq) {	2242	if ($uniq) {
1570	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2243	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1571	$self->_save_objects ($uniq, cf::IO_UNIQUES);	2244	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1572	} else {	2245	} else {
…		…
1578	my ($self) = @_;	2251	my ($self) = @_;
1579		2252
1580	# save first because save cedes	2253	# save first because save cedes
1581	$self->save;	2254	$self->save;
1582		2255
1583	my $lock = cf::lock_acquire "map_data:" . $self->path;	2256	my $lock = cf::lock_acquire "map_data:$self->{path}";
1584		2257
1585	return if $self->players;	2258	return if $self->players;
1586	return if $self->in_memory != cf::MAP_IN_MEMORY;	2259	return if $self->in_memory != cf::MAP_ACTIVE;
1587	return if $self->{deny_save};	2260	return if $self->{deny_save};
1588		2261
		2262	$self->in_memory (cf::MAP_SWAPPED);
		2263
		2264	$self->deactivate;
		2265	$_->clear_links_to ($self) for values %cf::MAP;
1589	$self->clear;	2266	$self->clear;
1590	$self->in_memory (cf::MAP_SWAPPED);
1591	}	2267	}
1592		2268
1593	sub reset_at {	2269	sub reset_at {
1594	my ($self) = @_;	2270	my ($self) = @_;
1595		2271
1596	# TODO: safety, remove and allow resettable per-player maps	2272	# TODO: safety, remove and allow resettable per-player maps
1597	return 1e99 if $self->isa ("ext::map_per_player");#d#
1598	return 1e99 if $self->{deny_reset};	2273	return 1e99 if $self->{deny_reset};
1599		2274
1600	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2275	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1601	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;
1602		2277
…		…
1613	my ($self) = @_;	2288	my ($self) = @_;
1614		2289
1615	my $lock = cf::lock_acquire "map_data:$self->{path}";	2290	my $lock = cf::lock_acquire "map_data:$self->{path}";
1616		2291
1617	return if $self->players;	2292	return if $self->players;
1618	return if $self->isa ("ext::map_per_player");#d#
1619		2293
1620	warn "resetting map ", $self->path;#d#	2294	warn "resetting map ", $self->path, "\n";
1621		2295
1622	$self->in_memory (cf::MAP_SWAPPED);	2296	$self->in_memory (cf::MAP_SWAPPED);
1623		2297
1624	# need to save uniques path	2298	# need to save uniques path
1625	unless ($self->{deny_save}) {	2299	unless ($self->{deny_save}) {
…		…
1629	if $uniq;	2303	if $uniq;
1630	}	2304	}
1631		2305
1632	delete $cf::MAP{$self->path};	2306	delete $cf::MAP{$self->path};
1633		2307
		2308	$self->deactivate;
		2309	$_->clear_links_to ($self) for values %cf::MAP;
1634	$self->clear;	2310	$self->clear;
1635
1636	$_->clear_links_to ($self) for values %cf::MAP;
1637		2311
1638	$self->unlink_save;	2312	$self->unlink_save;
1639	$self->destroy;	2313	$self->destroy;
1640	}	2314	}
1641		2315
1642	my $nuke_counter = "aaaa";	2316	my $nuke_counter = "aaaa";
1643		2317
1644	sub nuke {	2318	sub nuke {
1645	my ($self) = @_;	2319	my ($self) = @_;
1646		2320
		2321	{
		2322	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2323
1647	delete $cf::MAP{$self->path};	2324	delete $cf::MAP{$self->path};
1648		2325
1649	$self->unlink_save;	2326	$self->unlink_save;
1650		2327
1651	bless $self, "cf::map";	2328	bless $self, "cf::map";
1652	delete $self->{deny_reset};	2329	delete $self->{deny_reset};
1653	$self->{deny_save} = 1;	2330	$self->{deny_save} = 1;
1654	$self->reset_timeout (1);	2331	$self->reset_timeout (1);
1655	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2332	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1656		2333
1657	$cf::MAP{$self->path} = $self;	2334	$cf::MAP{$self->path} = $self;
		2335	}
1658		2336
1659	$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	]
1660	}	2374	}
1661		2375
1662	=item cf::map::unique_maps	2376	=item cf::map::unique_maps
1663		2377
1664	Returns an arrayref of paths of all shared maps that have	2378	Returns an arrayref of paths of all shared maps that have
1665	instantiated unique items. May block.	2379	instantiated unique items. May block.
1666		2380
1667	=cut	2381	=cut
1668		2382
1669	sub unique_maps() {	2383	sub unique_maps() {
1670	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2384	[
1671	or return;	2385	map {
1672
1673	my @paths;
1674
1675	for (@$files) {
1676	utf8::decode $_;	2386	utf8::decode $_;
1677	next if /\.pst$/;	2387	s/\.map$//; # TODO future compatibility hack
1678	next unless /^$PATH_SEP/o;	2388	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
1679		2389	? ()
1680	push @paths, cf::map::normalise $_;	2390	: normalise $_
		2391	} @{ aio_readdir $UNIQUEDIR or [] }
1681	}	2392	]
1682
1683	\@paths
1684	}	2393	}
1685		2394
1686	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	}
1687		2426
1688	=back	2427	=back
1689		2428
1690	=head3 cf::object	2429	=head3 cf::object
1691		2430
…		…
1695		2434
1696	=over 4	2435	=over 4
1697		2436
1698	=item $ob->inv_recursive	2437	=item $ob->inv_recursive
1699		2438
1700	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.
1701		2441
1702	=cut	2442	=cut
1703		2443
1704	sub inv_recursive_;	2444	sub inv_recursive_;
1705	sub inv_recursive_ {	2445	sub inv_recursive_ {
…		…
1708		2448
1709	sub inv_recursive {	2449	sub inv_recursive {
1710	inv_recursive_ inv $_[0]	2450	inv_recursive_ inv $_[0]
1711	}	2451	}
1712		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
1713	package cf;	2481	package cf;
1714		2482
1715	=back	2483	=back
1716		2484
1717	=head3 cf::object::player	2485	=head3 cf::object::player
…		…
1723	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>
1724	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
1725	dialogue with the given NPC character.	2493	dialogue with the given NPC character.
1726		2494
1727	=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	};
1728		2510
1729	# rough implementation of a future "reply" method that works	2511	# rough implementation of a future "reply" method that works
1730	# with dialog boxes.	2512	# with dialog boxes.
1731	#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
1732	sub cf::object::player::reply($$$;$) {	2514	sub cf::object::player::reply($$$;$) {
…		…
1734		2516
1735	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2517	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1736		2518
1737	if ($self->{record_replies}) {	2519	if ($self->{record_replies}) {
1738	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2520	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2521
1739	} 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 {
1740	$msg = $npc->name . " says: $msg" if $npc;	2530	$msg = $npc->name . " says: $msg" if $npc;
1741	$self->message ($msg, $flags);	2531	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2532	}
1742	}	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 (@_);
1743	}	2544	}
1744		2545
1745	=item $player_object->may ("access")	2546	=item $player_object->may ("access")
1746		2547
1747	Returns wether the given player is authorized to access resource "access"	2548	Returns wether the given player is authorized to access resource "access"
…		…
1760		2561
1761	=item $player_object->enter_link	2562	=item $player_object->enter_link
1762		2563
1763	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}>).
1764		2565
1765	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.
1766	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.
1767		2570
1768	Will never block.	2571	Will never block.
1769		2572
1770	=item $player_object->leave_link ($map, $x, $y)	2573	=item $player_object->leave_link ($map, $x, $y)
1771		2574
…		…
1794	$self->deactivate_recursive;	2597	$self->deactivate_recursive;
1795		2598
1796	return if UNIVERSAL::isa $self->map, "ext::map_link";	2599	return if UNIVERSAL::isa $self->map, "ext::map_link";
1797		2600
1798	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2601	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1799	if $self->map;	2602	if $self->map && $self->map->{path} ne "{link}";
1800		2603
1801	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2604	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1802	}	2605	}
1803		2606
1804	sub cf::object::player::leave_link {	2607	sub cf::object::player::leave_link {
1805	my ($self, $map, $x, $y) = @_;	2608	my ($self, $map, $x, $y) = @_;
		2609
		2610	return unless $self->contr->active;
1806		2611
1807	my $link_pos = delete $self->{_link_pos};	2612	my $link_pos = delete $self->{_link_pos};
1808		2613
1809	unless ($map) {	2614	unless ($map) {
1810	# restore original map position	2615	# restore original map position
…		…
1821	($x, $y) = (-1, -1)	2626	($x, $y) = (-1, -1)
1822	unless (defined $x) && (defined $y);	2627	unless (defined $x) && (defined $y);
1823		2628
1824	# use -1 or undef as default coordinates, not 0, 0	2629	# use -1 or undef as default coordinates, not 0, 0
1825	($x, $y) = ($map->enter_x, $map->enter_y)	2630	($x, $y) = ($map->enter_x, $map->enter_y)
1826	if $x <=0 && $y <= 0;	2631	if $x <= 0 && $y <= 0;
1827		2632
1828	$map->load;	2633	$map->load;
1829	$map->load_diag;	2634	$map->load_neighbours;
1830		2635
1831	return unless $self->contr->active;	2636	return unless $self->contr->active;
1832	$self->activate_recursive;
1833		2637
1834	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2638	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1835	$self->enter_map ($map, $x, $y);	2639	$self->enter_map ($map, $x, $y);
1836	}
1837		2640
1838	cf::player->attach (	2641	# only activate afterwards, to support waiting in hooks
1839	on_logout => sub {	2642	$self->activate_recursive;
1840	my ($pl) = @_;	2643	}
1841		2644
1842	# abort map switching before logout	2645	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1843	if ($pl->ob->{_link_pos}) {
1844	cf::sync_job {
1845	$pl->ob->leave_link
1846	};
1847	}
1848	},
1849	on_login => sub {
1850	my ($pl) = @_;
1851		2646
1852	# try to abort aborted map switching on player login :)	2647	Moves the player to the given map-path and coordinates by first freezing
1853	# should happen only on crashes	2648	her, loading and preparing them map, calling the provided $check callback
1854	if ($pl->ob->{_link_pos}) {	2649	that has to return the map if sucecssful, and then unfreezes the player on
1855	$pl->ob->enter_link;	2650	the new (success) or old (failed) map position. In either case, $done will
1856	(async {	2651	be called at the end of this process.
1857	$pl->ob->reply (undef,
1858	"There was an internal problem at your last logout, "
1859	. "the server will try to bring you to your intended destination in a second.",
1860	cf::NDI_RED);
1861	# we need this sleep as the login has a concurrent enter_exit running
1862	# and this sleep increases chances of the player not ending up in scorn
1863	Coro::Timer::sleep 1;
1864	$pl->ob->leave_link;
1865	})->prio (2);
1866	}
1867	},
1868	);
1869		2652
1870	=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 >>.
1871		2655
1872	=cut	2656	=cut
		2657
		2658	our $GOTOGEN;
1873		2659
1874	sub cf::object::player::goto {	2660	sub cf::object::player::goto {
1875	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;
1876		2665
1877	$self->enter_link;	2666	$self->enter_link;
1878		2667
1879	(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
1880	my $map = eval {	2690	my $map = eval {
1881	my $map = cf::map::find $path;	2691	my $map = defined $path ? cf::map::find $path : undef;
		2692
		2693	if ($map) {
1882	$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
1883	$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 $@;
1884	} or	2706	}
1885	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1886		2707
		2708	if ($gen == $self->{_goto_generation}) {
		2709	delete $self->{_goto_generation};
1887	$self->leave_link ($map, $x, $y);	2710	$self->leave_link ($map, $x, $y);
		2711	}
		2712
		2713	$done->() if $done;
1888	})->prio (1);	2714	})->prio (1);
1889	}	2715	}
1890		2716
1891	=item $player_object->enter_exit ($exit_object)	2717	=item $player_object->enter_exit ($exit_object)
1892		2718
…		…
1912	}	2738	}
1913		2739
1914	sub prepare_random_map {	2740	sub prepare_random_map {
1915	my ($exit) = @_;	2741	my ($exit) = @_;
1916		2742
1917	my $guard = cf::lock_acquire "exit_prepare:$exit";
1918
1919	# all this does is basically replace the /! path by	2743	# all this does is basically replace the /! path by
1920	# a new random map path (?random/...) with a seed	2744	# a new random map path (?random/...) with a seed
1921	# that depends on the exit object	2745	# that depends on the exit object
1922		2746
1923	my $rmp = parse_random_map_params $exit->msg;	2747	my $rmp = parse_random_map_params $exit->msg;
…		…
1925	if ($exit->map) {	2749	if ($exit->map) {
1926	$rmp->{region} = $exit->region->name;	2750	$rmp->{region} = $exit->region->name;
1927	$rmp->{origin_map} = $exit->map->path;	2751	$rmp->{origin_map} = $exit->map->path;
1928	$rmp->{origin_x} = $exit->x;	2752	$rmp->{origin_x} = $exit->x;
1929	$rmp->{origin_y} = $exit->y;	2753	$rmp->{origin_y} = $exit->y;
		2754
		2755	$exit->map->touch;
1930	}	2756	}
1931		2757
1932	$rmp->{random_seed} ||= $exit->random_seed;	2758	$rmp->{random_seed} ||= $exit->random_seed;
1933		2759
1934	my $data = cf::to_json $rmp;	2760	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1935	my $md5 = Digest::MD5::md5_hex $data;	2761	my $md5 = Digest::MD5::md5_hex $data;
1936	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2762	my $meta = "$RANDOMDIR/$md5.meta";
1937		2763
1938	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2764	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1939	aio_write $fh, 0, (length $data), $data, 0;	2765	aio_write $fh, 0, (length $data), $data, 0;
1940	undef $fh;	2766	undef $fh;
1941	aio_rename "$meta~", $meta;	2767	aio_rename "$meta~", $meta;
1942		2768
		2769	my $slaying = "?random/$md5";
		2770
		2771	if ($exit->valid) {
1943	$exit->slaying ("?random/$md5");	2772	$exit->slaying ("?random/$md5");
1944	$exit->msg (undef);	2773	$exit->msg (undef);
		2774	}
1945	}	2775	}
1946	}	2776	}
1947		2777
1948	sub cf::object::player::enter_exit {	2778	sub cf::object::player::enter_exit {
1949	my ($self, $exit) = @_;	2779	my ($self, $exit) = @_;
1950		2780
1951	return unless $self->type == cf::PLAYER;	2781	return unless $self->type == cf::PLAYER;
1952		2782
1953	if ($exit->slaying eq "/!") {
1954	#TODO: this should de-fi-ni-te-ly not be a sync-job
1955	cf::sync_job { prepare_random_map $exit };
1956	}
1957
1958	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1959	my $hp = $exit->stats->hp;
1960	my $sp = $exit->stats->sp;
1961
1962	$self->enter_link;	2783	$self->enter_link;
1963		2784
1964	(async {	2785	(async {
1965	$self->deactivate_recursive; # just to be sure	2786	$Coro::current->{desc} = "enter_exit";
		2787
1966	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
1967	$self->goto ($slaying, $hp, $sp);	2803	$self->goto ($map, $x, $y);
1968		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
1969	1;	2809	1
1970	}) {	2810	}) {
1971	$self->message ("Something went wrong deep within the crossfire server. "	2811	$self->message ("Something went wrong deep within the deliantra server. "
1972	. "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. "
1973	. "Please report this to the dungeon master!",	2813	. "Please report this to the dungeon master!",
1974	cf::NDI_UNIQUE | cf::NDI_RED);	2814	cf::NDI_UNIQUE | cf::NDI_RED);
1975		2815
1976	warn "ERROR in enter_exit: $@";	2816	warn "ERROR in enter_exit: $@";
1977	$self->leave_link;	2817	$self->leave_link;
1978	}	2818	}
1979	})->prio (1);	2819	})->prio (1);
…		…
1992		2832
1993	sub cf::client::send_drawinfo {	2833	sub cf::client::send_drawinfo {
1994	my ($self, $text, $flags) = @_;	2834	my ($self, $text, $flags) = @_;
1995		2835
1996	utf8::encode $text;	2836	utf8::encode $text;
1997	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2837	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1998	}	2838	}
1999		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	}
2000		3061
2001	=item $success = $client->query ($flags, "text", \&cb)	3062	=item $success = $client->query ($flags, "text", \&cb)
2002		3063
2003	Queues a query to the client, calling the given callback with	3064	Queues a query to the client, calling the given callback with
2004	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>,
2005	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>.
2006		3067
2007	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
2008	reliable at some point in the future.	3069	become reliable at some point in the future.
2009		3070
2010	=cut	3071	=cut
2011		3072
2012	sub cf::client::query {	3073	sub cf::client::query {
2013	my ($self, $flags, $text, $cb) = @_;	3074	my ($self, $flags, $text, $cb) = @_;
…		…
2021	utf8::encode $text;	3082	utf8::encode $text;
2022	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	3083	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2023		3084
2024	$self->send_packet ($self->{query_queue}[0][0])	3085	$self->send_packet ($self->{query_queue}[0][0])
2025	if @{ $self->{query_queue} } == 1;	3086	if @{ $self->{query_queue} } == 1;
		3087
		3088	1
2026	}	3089	}
2027		3090
2028	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	},
2029	on_reply => sub {	3097	on_reply => sub {
2030	my ($ns, $msg) = @_;	3098	my ($ns, $msg) = @_;
2031		3099
2032	# this weird shuffling is so that direct followup queries	3100	# this weird shuffling is so that direct followup queries
2033	# get handled first	3101	# get handled first
…		…
2045	} else {	3113	} else {
2046	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3114	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2047	}	3115	}
2048	}	3116	}
2049	},	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	},
2050	);	3144	);
2051		3145
2052	=item $client->async (\&cb)	3146	=item $client->async (\&cb)
2053		3147
2054	Create a new coroutine, running the specified callback. The coroutine will	3148	Create a new coroutine, running the specified callback. The coroutine will
…		…
2070		3164
2071	$coro	3165	$coro
2072	}	3166	}
2073		3167
2074	cf::client->attach (	3168	cf::client->attach (
2075	on_destroy => sub {	3169	on_client_destroy => sub {
2076	my ($ns) = @_;	3170	my ($ns) = @_;
2077		3171
2078	$_->cancel for values %{ (delete $ns->{_coro}) || {} };	3172	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
2079	},	3173	},
2080	);	3174	);
…		…
2095	our $safe = new Safe "safe";	3189	our $safe = new Safe "safe";
2096	our $safe_hole = new Safe::Hole;	3190	our $safe_hole = new Safe::Hole;
2097		3191
2098	$SIG{FPE} = 'IGNORE';	3192	$SIG{FPE} = 'IGNORE';
2099		3193
2100	$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	));
2101		3199
2102	# here we export the classes and methods available to script code	3200	# here we export the classes and methods available to script code
2103		3201
2104	=pod	3202	=pod
2105		3203
2106	The following fucntions and emthods are available within a safe environment:	3204	The following functions and methods are available within a safe environment:
2107		3205
2108	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
2109	cf::object::player player	3211	cf::object::player
2110	cf::player peaceful	3212	player
2111	cf::map trigger	3213
		3214	cf::player
		3215	peaceful
		3216
		3217	cf::map
		3218	trigger
2112		3219
2113	=cut	3220	=cut
2114		3221
2115	for (	3222	for (
2116	["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)],
2117	["cf::object::player" => qw(player)],	3226	["cf::object::player" => qw(player)],
2118	["cf::player" => qw(peaceful)],	3227	["cf::player" => qw(peaceful send_msg)],
2119	["cf::map" => qw(trigger)],	3228	["cf::map" => qw(trigger)],
2120	) {	3229	) {
2121	no strict 'refs';	3230	no strict 'refs';
2122	my ($pkg, @funs) = @$_;	3231	my ($pkg, @funs) = @$_;
2123	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3232	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
…		…
2141		3250
2142	my $qcode = $code;	3251	my $qcode = $code;
2143	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3252	$qcode =~ s/"/‟/g; # not allowed in #line filenames
2144	$qcode =~ s/\n/\\n/g;	3253	$qcode =~ s/\n/\\n/g;
2145		3254
		3255	%vars = (_dummy => 0) unless %vars;
		3256
		3257	my @res;
2146	local $_;	3258	local $_;
2147	local @safe::cf::_safe_eval_args = values %vars;
2148		3259
2149	my $eval =	3260	my $eval =
2150	"do {\n"	3261	"do {\n"
2151	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	3262	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
2152	. "#line 0 \"{$qcode}\"\n"	3263	. "#line 0 \"{$qcode}\"\n"
2153	. $code	3264	. $code
2154	. "\n}"	3265	. "\n}"
2155	;	3266	;
2156		3267
		3268	if ($CFG{safe_eval}) {
2157	sub_generation_inc;	3269	sub_generation_inc;
		3270	local @safe::cf::_safe_eval_args = values %vars;
2158	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);	3271	@res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
2159	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	}
2160		3277
2161	if ($@) {	3278	if ($@) {
2162	warn "$@";	3279	warn "$@";
2163	warn "while executing safe code '$code'\n";	3280	warn "while executing safe code '$code'\n";
2164	warn "with arguments " . (join " ", %vars) . "\n";	3281	warn "with arguments " . (join " ", %vars) . "\n";
…		…
2183	=cut	3300	=cut
2184		3301
2185	sub register_script_function {	3302	sub register_script_function {
2186	my ($fun, $cb) = @_;	3303	my ($fun, $cb) = @_;
2187		3304
2188	no strict 'refs';	3305	$fun = "safe::$fun" if $CFG{safe_eval};
2189	*{"safe::$fun"} = $safe_hole->wrap ($cb);	3306	*$fun = $safe_hole->wrap ($cb);
2190	}	3307	}
2191		3308
2192	=back	3309	=back
2193		3310
2194	=cut	3311	=cut
2195
2196	#############################################################################
2197
2198	=head2 EXTENSION DATABASE SUPPORT
2199
2200	Crossfire maintains a very simple database for extension use. It can
2201	currently store anything that can be serialised using Storable, which
2202	excludes objects.
2203
2204	The parameter C<$family> should best start with the name of the extension
2205	using it, it should be unique.
2206
2207	=over 4
2208
2209	=item $value = cf::db_get $family => $key
2210
2211	Returns a single value from the database.
2212
2213	=item cf::db_put $family => $key => $value
2214
2215	Stores the given C<$value> in the family.
2216
2217	=cut
2218
2219	our $DB;
2220
2221	sub db_init {
2222	unless ($DB) {
2223	$DB = BDB::db_create $DB_ENV;
2224
2225	cf::sync_job {
2226	eval {
2227	$DB->set_flags (BDB::CHKSUM);
2228
2229	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2230	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2231	cf::cleanup "db_open(db): $!" if $!;
2232	};
2233	cf::cleanup "db_open(db): $@" if $@;
2234	};
2235
2236	my $path = cf::localdir . "/database.pst";
2237	if (stat $path) {
2238	cf::sync_job {
2239	my $pst = Storable::retrieve $path;
2240
2241	cf::db_put (board => data => $pst->{board});
2242	cf::db_put (guildrules => data => $pst->{guildrules});
2243	cf::db_put (rent => balance => $pst->{rent}{balance});
2244	BDB::db_env_txn_checkpoint $DB_ENV;
2245
2246	unlink $path;
2247	};
2248	}
2249	}
2250	}
2251
2252	sub db_get($$) {
2253	my $key = "$_[0]/$_[1]";
2254
2255	cf::sync_job {
2256	BDB::db_get $DB, undef, $key, my $data;
2257
2258	$! ? ()
2259	: Compress::LZF::sthaw $data
2260	}
2261	}
2262
2263	sub db_put($$$) {
2264	BDB::dbreq_pri 4;
2265	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2266	}
2267		3312
2268	#############################################################################	3313	#############################################################################
2269	# the server's init and main functions	3314	# the server's init and main functions
2270		3315
2271	sub init_resources {	3316	sub load_facedata($) {
2272	load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir	3317	my ($path) = @_;
		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
		3325	warn "loading facedata from $path\n";
		3326
		3327	my $facedata;
		3328	0 < aio_load $path, $facedata
		3329	or die "$path: $!";
		3330
		3331	$facedata = Coro::Storable::thaw $facedata;
		3332
		3333	$facedata->{version} == 2
		3334	or cf::cleanup "$path: version mismatch, cannot proceed.";
		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
		3348	while (my ($face, $info) = each %$faces) {
		3349	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		3350
		3351	cf::face::set_visibility $idx, $info->{visibility};
		3352	cf::face::set_magicmap $idx, $info->{magicmap};
		3353	cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
		3354	cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
		3355
		3356	cf::cede_to_tick;
		3357	}
		3358
		3359	while (my ($face, $info) = each %$faces) {
		3360	next unless $info->{smooth};
		3361
		3362	my $idx = cf::face::find $face
		3363	or next;
		3364
		3365	if (my $smooth = cf::face::find $info->{smooth}) {
		3366	cf::face::set_smooth $idx, $smooth;
		3367	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3368	} else {
		3369	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3370	}
		3371
		3372	cf::cede_to_tick;
		3373	}
		3374	}
		3375
		3376	{
		3377	my $anims = $facedata->{animinfo};
		3378
		3379	while (my ($anim, $info) = each %$anims) {
		3380	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3381	cf::cede_to_tick;
		3382	}
		3383
		3384	cf::anim::invalidate_all; # d'oh
		3385	}
		3386
		3387	{
		3388	my $res = $facedata->{resource};
		3389
		3390	while (my ($name, $info) = each %$res) {
		3391	if (defined $info->{type}) {
		3392	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3393
		3394	cf::face::set_data $idx, 0, $info->{data}, $info->{hash};
		3395	cf::face::set_type $idx, $info->{type};
		3396	} else {
		3397	$RESOURCE{$name} = $info;
		3398	}
		3399
		3400	cf::cede_to_tick;
		3401	}
		3402	}
		3403
		3404	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3405
		3406	1
		3407	}
		3408
		3409	cf::global->attach (on_resource_update => sub {
		3410	if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
		3411	$soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
		3412
		3413	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3414	my $sound = $soundconf->{compat}[$_]
		3415	or next;
		3416
		3417	my $face = cf::face::find "sound/$sound->[1]";
		3418	cf::sound::set $sound->[0] => $face;
		3419	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3420	}
		3421
		3422	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3423	my $face = cf::face::find "sound/$v";
		3424	cf::sound::set $k => $face;
		3425	}
		3426	}
		3427	});
		3428
		3429	register_exticmd fx_want => sub {
		3430	my ($ns, $want) = @_;
		3431
		3432	while (my ($k, $v) = each %$want) {
		3433	$ns->fx_want ($k, $v);
		3434	}
		3435	};
		3436
		3437	sub load_resource_file($) {
		3438	my $guard = lock_acquire "load_resource_file";
		3439
		3440	my $status = load_resource_file_ $_[0];
		3441	get_slot 0.1, 100;
		3442	cf::arch::commit_load;
		3443
		3444	$status
		3445	}
		3446
		3447	sub reload_regions {
		3448	# HACK to clear player env face cache, we need some signal framework
		3449	# for this (global event?)
		3450	%ext::player_env::MUSIC_FACE_CACHE = ();
		3451
		3452	load_resource_file "$MAPDIR/regions"
2273	or die "unable to load regions file\n";#d#	3453	or die "unable to load regions file\n";
2274	}
2275		3454
2276	sub cfg_load {	3455	for (cf::region::list) {
		3456	$_->{match} = qr/$_->{match}/
		3457	if exists $_->{match};
		3458	}
		3459	}
		3460
		3461	sub reload_facedata {
		3462	load_facedata "$DATADIR/facedata"
		3463	or die "unable to load facedata\n";
		3464	}
		3465
		3466	sub reload_archetypes {
		3467	load_resource_file "$DATADIR/archetypes"
		3468	or die "unable to load archetypes\n";
		3469	}
		3470
		3471	sub reload_treasures {
		3472	load_resource_file "$DATADIR/treasures"
		3473	or die "unable to load treasurelists\n";
		3474	}
		3475
		3476	sub reload_resources {
		3477	warn "reloading resource files...\n";
		3478
		3479	reload_facedata;
		3480	reload_archetypes;
		3481	reload_regions;
		3482	reload_treasures;
		3483
		3484	warn "finished reloading resource files\n";
		3485	}
		3486
		3487	sub reload_config {
		3488	warn "reloading config file...\n";
		3489
2277	open my $fh, "<:utf8", cf::confdir . "/config"	3490	open my $fh, "<:utf8", "$CONFDIR/config"
2278	or return;	3491	or return;
2279		3492
2280	local $/;	3493	local $/;
2281	*CFG = YAML::Syck::Load <$fh>;	3494	*CFG = YAML::XS::Load scalar <$fh>;
2282		3495
2283	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3496	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2284		3497
2285	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	3498	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2286	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};	3499	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
…		…
2290	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"	3503	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2291	and die "WARNING: m(un)lockall failed: $!\n";	3504	and die "WARNING: m(un)lockall failed: $!\n";
2292	};	3505	};
2293	warn $@ if $@;	3506	warn $@ if $@;
2294	}	3507	}
2295	}
2296		3508
2297	sub init {	3509	warn "finished reloading resource files\n";
2298	init_resources;	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;
2299	}	3538	}
2300		3539
2301	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
2302	# we must not ever block the main coroutine	3550	# we must not ever block the main coroutine
2303	local $Coro::idle = sub {	3551	local $Coro::idle = sub {
2304	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#
2305	(async {	3553	(async {
2306	Event::one_event;	3554	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3555	EV::loop EV::LOOP_ONESHOT;
2307	})->prio (Coro::PRIO_MAX);	3556	})->prio (Coro::PRIO_MAX);
2308	};	3557	};
2309		3558
2310	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;
2311	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
2312	load_extensions;	3582	load_extensions;
2313		3583
2314	$TICK_WATCHER->start;	3584	utime time, time, $RUNTIMEFILE;
2315	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;
2316	}	3597	}
2317		3598
2318	#############################################################################	3599	#############################################################################
2319	# initialisation and cleanup	3600	# initialisation and cleanup
2320		3601
2321	# install some emergency cleanup handlers	3602	# install some emergency cleanup handlers
2322	BEGIN {	3603	BEGIN {
		3604	our %SIGWATCHER = ();
2323	for my $signal (qw(INT HUP TERM)) {	3605	for my $signal (qw(INT HUP TERM)) {
2324	Event->signal (	3606	$SIGWATCHER{$signal} = AE::signal $signal, sub {
2325	reentrant => 0,
2326	data => WF_AUTOCANCEL,
2327	signal => $signal,
2328	prio => 0,
2329	cb => sub {
2330	cf::cleanup "SIG$signal";	3607	cf::cleanup "SIG$signal";
2331	},
2332	);	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
2333	}	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 };
2334	}	3698	}
2335		3699
2336	sub emergency_save() {	3700	sub emergency_save() {
2337	my $freeze_guard = cf::freeze_mainloop;	3701	my $freeze_guard = cf::freeze_mainloop;
2338		3702
2339	warn "enter emergency perl save\n";	3703	warn "emergency_perl_save: enter\n";
2340		3704
2341	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
2342	# use a peculiar iteration method to avoid tripping on perl	3711	# use a peculiar iteration method to avoid tripping on perl
2343	# refcount bugs in for. also avoids problems with players	3712	# refcount bugs in for. also avoids problems with players
2344	# and maps saved/destroyed asynchronously.	3713	# and maps saved/destroyed asynchronously.
2345	warn "begin emergency player save\n";	3714	warn "emergency_perl_save: begin player save\n";
2346	for my $login (keys %cf::PLAYER) {	3715	for my $login (keys %cf::PLAYER) {
2347	my $pl = $cf::PLAYER{$login} or next;	3716	my $pl = $cf::PLAYER{$login} or next;
2348	$pl->valid or next;	3717	$pl->valid or next;
		3718	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2349	$pl->save;	3719	$pl->save;
2350	}	3720	}
2351	warn "end emergency player save\n";	3721	warn "emergency_perl_save: end player save\n";
2352		3722
2353	warn "begin emergency map save\n";	3723	warn "emergency_perl_save: begin map save\n";
2354	for my $path (keys %cf::MAP) {	3724	for my $path (keys %cf::MAP) {
2355	my $map = $cf::MAP{$path} or next;	3725	my $map = $cf::MAP{$path} or next;
2356	$map->valid or next;	3726	$map->valid or next;
2357	$map->save;	3727	$map->save;
2358	}	3728	}
2359	warn "end emergency map save\n";	3729	warn "emergency_perl_save: end map save\n";
2360		3730
2361	warn "begin emergency database checkpoint\n";	3731	warn "emergency_perl_save: begin database checkpoint\n";
2362	BDB::db_env_txn_checkpoint $DB_ENV;	3732	BDB::db_env_txn_checkpoint $DB_ENV;
2363	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";
2364	};	3738	};
2365		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
2366	warn "leave emergency perl save\n";	3745	warn "emergency_perl_save: leave\n";
2367	}	3746	}
2368		3747
2369	sub post_cleanup {	3748	sub post_cleanup {
2370	my ($make_core) = @_;	3749	my ($make_core) = @_;
2371		3750
2372	warn Carp::longmess "post_cleanup backtrace"	3751	warn Carp::longmess "post_cleanup backtrace"
2373	if $make_core;	3752	if $make_core;
2374	}
2375		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
2376	sub reload() {	3784	sub do_reload_perl() {
2377	# can/must only be called in main	3785	# can/must only be called in main
2378	if ($Coro::current != $Coro::main) {	3786	if ($Coro::current != $Coro::main) {
2379	warn "can only reload from main coroutine";	3787	warn "can only reload from main coroutine";
2380	return;	3788	return;
2381	}	3789	}
2382		3790
		3791	return if $RELOAD++;
		3792
		3793	my $t1 = AE::time;
		3794
		3795	while ($RELOAD) {
2383	warn "reloading...";	3796	warn "reloading...";
2384		3797
2385	warn "entering sync_job";	3798	warn "entering sync_job";
2386		3799
2387	cf::sync_job {	3800	cf::sync_job {
2388	cf::write_runtime; # external watchdog should not bark	3801	cf::write_runtime_sync; # external watchdog should not bark
2389	cf::emergency_save;	3802	cf::emergency_save;
2390	cf::write_runtime; # external watchdog should not bark	3803	cf::write_runtime_sync; # external watchdog should not bark
2391		3804
2392	warn "syncing database to disk";	3805	warn "syncing database to disk";
2393	BDB::db_env_txn_checkpoint $DB_ENV;	3806	BDB::db_env_txn_checkpoint $DB_ENV;
2394		3807
2395	# 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
2396		3809
2397	warn "cancelling all WF_AUTOCANCEL watchers";
2398	for (Event::all_watchers) {
2399	$_->cancel if $_->data & WF_AUTOCANCEL;
2400	}
2401
2402	warn "flushing outstanding aio requests";	3810	warn "flushing outstanding aio requests";
2403	for (;;) {
2404	BDB::flush;
2405	IO::AIO::flush;
2406	Coro::cede;
2407	last unless IO::AIO::nreqs || BDB::nreqs;	3811	while (IO::AIO::nreqs || BDB::nreqs) {
2408	warn "iterate...";	3812	Coro::EV::timer_once 0.01; # let the sync_job do it's thing
2409	}
2410
2411	warn "cancelling all extension coros";
2412	$_->cancel for values %EXT_CORO;
2413	%EXT_CORO = ();
2414
2415	warn "removing commands";
2416	%COMMAND = ();
2417
2418	warn "removing ext commands";
2419	%EXTCMD = ();
2420
2421	warn "unloading/nuking all extensions";
2422	for my $pkg (@EXTS) {
2423	warn "... unloading $pkg";
2424
2425	if (my $cb = $pkg->can ("unload")) {
2426	eval {
2427	$cb->($pkg);
2428	1
2429	} or warn "$pkg unloaded, but with errors: $@";
2430	}	3813	}
2431		3814
2432	warn "... nuking $pkg";	3815	warn "cancelling all extension coros";
2433	Symbol::delete_package $pkg;	3816	$_->cancel for values %EXT_CORO;
2434	}	3817	%EXT_CORO = ();
2435		3818
2436	warn "unloading all perl modules loaded from $LIBDIR";	3819	warn "removing commands";
2437	while (my ($k, $v) = each %INC) {	3820	%COMMAND = ();
2438	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2439		3821
		3822	warn "removing ext/exti commands";
		3823	%EXTCMD = ();
		3824	%EXTICMD = ();
		3825
		3826	warn "unloading/nuking all extensions";
		3827	for my $pkg (@EXTS) {
2440	warn "... unloading $k";	3828	warn "... unloading $pkg";
2441	delete $INC{$k};
2442		3829
2443	$k =~ s/\.pm$//;
2444	$k =~ s/\//::/g;
2445
2446	if (my $cb = $k->can ("unload_module")) {	3830	if (my $cb = $pkg->can ("unload")) {
		3831	eval {
2447	$cb->();	3832	$cb->($pkg);
		3833	1
		3834	} or warn "$pkg unloaded, but with errors: $@";
		3835	}
		3836
		3837	warn "... clearing $pkg";
		3838	clear_package $pkg;
2448	}	3839	}
2449		3840
2450	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;
2451	}	3856	}
2452		3857
2453	warn "getting rid of safe::, as good as possible";	3858	warn "getting rid of safe::, as good as possible";
2454	Symbol::delete_package "safe::$_"	3859	clear_package "safe::$_"
2455	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);
2456		3861
2457	warn "unloading cf.pm \"a bit\"";	3862	warn "unloading cf.pm \"a bit\"";
2458	delete $INC{"cf.pm"};	3863	delete $INC{"cf.pm"};
		3864	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2459		3865
2460	# don't, removes xs symbols, too,	3866	# don't, removes xs symbols, too,
2461	# and global variables created in xs	3867	# and global variables created in xs
2462	#Symbol::delete_package __PACKAGE__;	3868	#clear_package __PACKAGE__;
2463		3869
2464	warn "unload completed, starting to reload now";	3870	warn "unload completed, starting to reload now";
2465		3871
2466	warn "reloading cf.pm";	3872	warn "reloading cf.pm";
2467	require cf;	3873	require cf;
2468	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3874	cf::_connect_to_perl_1;
2469		3875
2470	warn "loading config and database again";	3876	warn "loading config and database again";
2471	cf::cfg_load;	3877	cf::reload_config;
2472		3878
2473	warn "loading extensions";	3879	warn "loading extensions";
2474	cf::load_extensions;	3880	cf::load_extensions;
2475		3881
		3882	if ($REATTACH_ON_RELOAD) {
2476	warn "reattaching attachments to objects/players";	3883	warn "reattaching attachments to objects/players";
2477	_global_reattach;	3884	_global_reattach; # objects, sockets
2478	warn "reattaching attachments to maps";	3885	warn "reattaching attachments to maps";
2479	reattach $_ for values %MAP;	3886	reattach $_ for values %MAP;
		3887	warn "reattaching attachments to players";
		3888	reattach $_ for values %PLAYER;
		3889	}
2480		3890
2481	warn "loading reloadable resources";	3891	warn "running post_init jobs";
2482	init_resources;	3892	(pop @POST_INIT)->(1) while @POST_INIT;
2483		3893
2484	warn "leaving sync_job";	3894	warn "leaving sync_job";
2485		3895
2486	1	3896	1
2487	} or do {	3897	} or do {
2488	warn $@;	3898	warn $@;
2489	warn "error while reloading, exiting.";	3899	cf::cleanup "error while reloading, exiting.";
2490	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	};
2491	};	3923	};
2492		3924	}
2493	warn "reloaded";
2494	};
2495
2496	our $RELOAD_WATCHER; # used only during reload
2497		3925
2498	register_command "reload" => sub {	3926	register_command "reload" => sub {
2499	my ($who, $arg) = @_;	3927	my ($who, $arg) = @_;
2500		3928
2501	if ($who->flag (FLAG_WIZ)) {	3929	if ($who->flag (FLAG_WIZ)) {
2502	$who->message ("reloading server.");	3930	$who->message ("reloading server.");
2503		3931	async {
2504	# doing reload synchronously and two reloads happen back-to-back,	3932	$Coro::current->{desc} = "perl_reload";
2505	# coro crashes during coro_state_free->destroy here.
2506
2507	$RELOAD_WATCHER ||= Event->timer (
2508	reentrant => 0,
2509	after => 0,
2510	data => WF_AUTOCANCEL,
2511	cb => sub {
2512	reload;	3933	reload_perl;
2513	undef $RELOAD_WATCHER;
2514	},
2515	);	3934	};
2516	}	3935	}
2517	};	3936	};
2518		3937
2519	unshift @INC, $LIBDIR;	3938	unshift @INC, $LIBDIR;
2520		3939
2521	my $bug_warning = 0;	3940	my $bug_warning = 0;
2522		3941
2523	$TICK_WATCHER = Event->timer (	3942	our @WAIT_FOR_TICK;
2524	reentrant => 0,	3943	our @WAIT_FOR_TICK_BEGIN;
2525	parked => 1,	3944
2526	prio => 0,	3945	sub wait_for_tick {
2527	at => $NEXT_TICK || $TICK,	3946	return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
2528	data => WF_AUTOCANCEL,	3947
2529	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 {
2530	if ($Coro::current != $Coro::main) {	3962	if ($Coro::current != $Coro::main) {
2531	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"
2532	unless ++$bug_warning > 10;	3964	unless ++$bug_warning > 10;
2533	return;	3965	return;
2534	}	3966	}
2535		3967
2536	$NOW = Event::time;
2537
2538	cf::server_tick; # one server iteration	3968	cf::server_tick; # one server iteration
2539	$RUNTIME += $TICK;
2540	$NEXT_TICK += $TICK;
2541		3969
		3970	#for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
		3971
2542	if ($NOW >= $NEXT_RUNTIME_WRITE) {	3972	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2543	$NEXT_RUNTIME_WRITE = $NOW + 10;	3973	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2544	Coro::async_pool {	3974	Coro::async_pool {
		3975	$Coro::current->{desc} = "runtime saver";
2545	write_runtime	3976	write_runtime_sync
2546	or warn "ERROR: unable to write runtime file: $!";	3977	or warn "ERROR: unable to write runtime file: $!";
2547	};
2548	}	3978	};
2549
2550	$WAIT_FOR_TICK->broadcast;
2551	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2552
2553	# my $AFTER = Event::time;
2554	# warn $AFTER - $NOW;#d#
2555
2556	# if we are delayed by four ticks or more, skip them all
2557	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2558
2559	$TICK_WATCHER->at ($NEXT_TICK);
2560	$TICK_WATCHER->start;
2561	},	3979	}
2562	);	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	}
2563		3999
2564	{	4000	{
2565	BDB::max_poll_time $TICK * 0.1;	4001	# configure BDB
2566	$BDB_POLL_WATCHER = Event->io (	4002
2567	reentrant => 0,
2568	fd => BDB::poll_fileno,
2569	poll => 'r',
2570	prio => 0,
2571	data => WF_AUTOCANCEL,
2572	cb => \&BDB::poll_cb,
2573	);
2574	BDB::min_parallel 8;	4003	BDB::min_parallel 16;
2575		4004	BDB::max_poll_reqs $TICK * 0.1;
2576	BDB::set_sync_prepare {	4005	$AnyEvent::BDB::WATCHER->priority (1);
2577	my $status;
2578	my $current = $Coro::current;
2579	(
2580	sub {
2581	$status = $!;
2582	$current->ready; undef $current;
2583	},
2584	sub {
2585	Coro::schedule while defined $current;
2586	$! = $status;
2587	},
2588	)
2589	};
2590		4006
2591	unless ($DB_ENV) {	4007	unless ($DB_ENV) {
2592	$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);
2593		4014
2594	cf::sync_job {	4015	cf::sync_job {
2595	eval {	4016	eval {
2596	BDB::db_env_open	4017	BDB::db_env_open
2597	$DB_ENV,	4018	$DB_ENV,
2598	$BDB_ENV_DIR,	4019	$BDBDIR,
2599	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
2600	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	4021	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2601	0666;	4022	0666;
2602		4023
2603	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;	4024	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2604
2605	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2606	$DB_ENV->set_lk_detect;
2607	};	4025	};
2608		4026
2609	cf::cleanup "db_env_open(db): $@" if $@;	4027	cf::cleanup "db_env_open(db): $@" if $@;
2610	};	4028	};
2611	}	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	};
2612	}	4040	}
2613		4041
2614	{	4042	{
		4043	# configure IO::AIO
		4044
2615	IO::AIO::min_parallel 8;	4045	IO::AIO::min_parallel 8;
2616
2617	undef $Coro::AIO::WATCHER;
2618	IO::AIO::max_poll_time $TICK * 0.1;	4046	IO::AIO::max_poll_time $TICK * 0.1;
2619	$AIO_POLL_WATCHER = Event->io (	4047	undef $AnyEvent::AIO::WATCHER;
2620	reentrant => 0,
2621	data => WF_AUTOCANCEL,
2622	fd => IO::AIO::poll_fileno,
2623	poll => 'r',
2624	prio => 6,
2625	cb => \&IO::AIO::poll_cb,
2626	);
2627	}	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;
2628		4095
2629	END { cf::emergency_save }	4096	END { cf::emergency_save }
2630		4097
2631	1	4098	1
2632		4099

Diff Legend

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