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.231 by root, Wed Apr 4 00:02:06 2007 UTC vs.
Revision 1.513 by root, Mon Apr 12 05:22:38 2010 UTC

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

Diff Legend

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