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.111 by root, Mon Jan 1 12:28:47 2007 UTC vs.
Revision 1.489 by root, Fri Oct 23 03:08:35 2009 UTC

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

Diff Legend

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