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.143 by root, Sun Jan 7 02:39:14 2007 UTC vs.
Revision 1.572 by root, Sun May 8 11:44:43 2011 UTC

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

Diff Legend

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