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.113 by root, Mon Jan 1 15:32:40 2007 UTC vs.
Revision 1.486 by root, Thu Oct 15 21:56:50 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.
…		…
198		496
199	sub sync_job(&) {	497	sub sync_job(&) {
200	my ($job) = @_;	498	my ($job) = @_;
201		499
202	if ($Coro::current == $Coro::main) {	500	if ($Coro::current == $Coro::main) {
		501	my $time = EV::time;
		502
203	# this is the main coro, too bad, we have to block	503	# this is the main coro, too bad, we have to block
204	# till the operation succeeds, freezing the server :/	504	# till the operation succeeds, freezing the server :/
205		505
206	# TODO: use suspend/resume instead	506	LOG llevError, Carp::longmess "sync job";#d#
207	# (but this is cancel-safe)	507
208	local $FREEZE = 1;	508	my $freeze_guard = freeze_mainloop;
209		509
210	my $busy = 1;	510	my $busy = 1;
211	my @res;	511	my @res;
212		512
213	(Coro::async {	513	(async {
		514	$Coro::current->desc ("sync job coro");
214	@res = eval { $job->() };	515	@res = eval { $job->() };
215	warn $@ if $@;	516	warn $@ if $@;
216	undef $busy;	517	undef $busy;
217	})->prio (Coro::PRIO_MAX);	518	})->prio (Coro::PRIO_MAX);
218		519
219	while ($busy) {	520	while ($busy) {
		521	if (Coro::nready) {
220	Coro::cede_notself;	522	Coro::cede_notself;
221	Event::one_event unless Coro::nready;	523	} else {
		524	EV::loop EV::LOOP_ONESHOT;
222	}	525	}
		526	}
		527
		528	my $time = EV::time - $time;
		529
		530	$TICK_START += $time; # do not account sync jobs to server load
223		531
224	wantarray ? @res : $res[0]	532	wantarray ? @res : $res[0]
225	} else {	533	} else {
226	# we are in another coroutine, how wonderful, everything just works	534	# we are in another coroutine, how wonderful, everything just works
227		535
228	$job->()	536	$job->()
229	}	537	}
230	}	538	}
231		539
232	=item $coro = cf::coro { BLOCK }	540	=item $coro = cf::async_ext { BLOCK }
233		541
234	Creates and returns a new coro. This coro is automcatially being canceled	542	Like async, but this coro is automatically being canceled when the
235	when the extension calling this is being unloaded.	543	extension calling this is being unloaded.
236		544
237	=cut	545	=cut
238		546
239	sub coro(&) {	547	sub async_ext(&) {
240	my $cb = shift;	548	my $cb = shift;
241		549
242	my $coro; $coro = async {	550	my $coro = &Coro::async ($cb);
243	eval {
244	$cb->();
245	};
246	warn $@ if $@;
247	};
248		551
249	$coro->on_destroy (sub {	552	$coro->on_destroy (sub {
250	delete $EXT_CORO{$coro+0};	553	delete $EXT_CORO{$coro+0};
251	});	554	});
252	$EXT_CORO{$coro+0} = $coro;	555	$EXT_CORO{$coro+0} = $coro;
253		556
254	$coro	557	$coro
255	}	558	}
256		559
257	sub write_runtime {	560	=item fork_call { }, $args
258	my $runtime = cf::localdir . "/runtime";
259		561
260	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	562	Executes the given code block with the given arguments in a seperate
261	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.
262		566
263	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	567	=cut
264	(aio_write $fh, 0, (length $value), $value, 0) <= 0
265	and return;
266		568
267	aio_fsync $fh	569	sub fork_call(&@) {
268	and return;	570	my ($cb, @args) = @_;
269		571
270	close $fh	572	# we seemingly have to make a local copy of the whole thing,
271	or return;	573	# otherwise perl prematurely frees the stuff :/
		574	# TODO: investigate and fix (likely this will be rather laborious)
272		575
273	aio_rename "$runtime~", $runtime	576	my @res = Coro::Util::fork_eval {
274	and return;	577	reset_signals;
		578	&$cb
		579	}, @args;
275		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
276	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 });
277	}	747	}
278		748
279	=back	749	=back
280		750
281	=cut	751	=cut
282		752
283	#############################################################################	753	#############################################################################
284		754
285	package cf::path;
286
287	sub new {
288	my ($class, $path, $base) = @_;
289
290	$path = $path->as_string if ref $path;
291
292	my $self = bless { }, $class;
293
294	if ($path =~ s{^\?random/}{}) {
295	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
296	$self->{random} = cf::from_json $data;
297	} else {
298	if ($path =~ s{^~([^/]+)?}{}) {
299	$self->{user_rel} = 1;
300
301	if (defined $1) {
302	$self->{user} = $1;
303	} elsif ($base =~ m{^~([^/]+)/}) {
304	$self->{user} = $1;
305	} else {
306	warn "cannot resolve user-relative path without user <$path,$base>\n";
307	}
308	} elsif ($path =~ /^\//) {
309	# already absolute
310	} else {
311	$base =~ s{[^/]+/?$}{};
312	return $class->new ("$base/$path");
313	}
314
315	for ($path) {
316	redo if s{/\.?/}{/};
317	redo if s{/[^/]+/\.\./}{/};
318	}
319	}
320
321	$self->{path} = $path;
322
323	$self
324	}
325
326	# the name / primary key / in-game path
327	sub as_string {
328	my ($self) = @_;
329
330	$self->{user_rel} ? "~$self->{user}$self->{path}"
331	: $self->{random} ? "?random/$self->{path}"
332	: $self->{path}
333	}
334
335	# the displayed name, this is a one way mapping
336	sub visible_name {
337	my ($self) = @_;
338
339	# if (my $rmp = $self->{random}) {
340	# # todo: be more intelligent about this
341	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
342	# } else {
343	$self->as_string
344	# }
345	}
346
347	# escape the /'s in the path
348	sub _escaped_path {
349	# ∕ is U+2215
350	(my $path = $_[0]{path}) =~ s/\//∕/g;
351	$path
352	}
353
354	# the original (read-only) location
355	sub load_path {
356	my ($self) = @_;
357
358	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
359	}
360
361	# the temporary/swap location
362	sub save_path {
363	my ($self) = @_;
364
365	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
366	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
367	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
368	}
369
370	# the unique path, might be eq to save_path
371	sub uniq_path {
372	my ($self) = @_;
373
374	$self->{user_rel} || $self->{random}
375	? undef
376	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
377	}
378
379	# return random map parameters, or undef
380	sub random_map_params {
381	my ($self) = @_;
382
383	$self->{random}
384	}
385
386	# this is somewhat ugly, but style maps do need special treatment
387	sub is_style_map {
388	$_[0]{path} =~ m{^/styles/}
389	}
390
391	package cf;
392
393	#############################################################################
394
395	=head2 ATTACHABLE OBJECTS	755	=head2 ATTACHABLE OBJECTS
396		756
397	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
398	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")
399	to it. All such attachable objects support the following methods.	759	to it. All such attachable objects support the following methods.
400		760
401	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>
402	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
403	crossfire+).	763	Deliantra).
404		764
405	=over 4	765	=over 4
406		766
407	=item $attachable->attach ($attachment, key => $value...)	767	=item $attachable->attach ($attachment, key => $value...)
408		768
…		…
452	=item cf::CLASS::attachment $name, ...	812	=item cf::CLASS::attachment $name, ...
453		813
454	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
455	given CLASS can refer to this attachment.	815	given CLASS can refer to this attachment.
456		816
457	Some classes such as crossfire maps and objects can specify attachments	817	Some classes such as deliantra maps and objects can specify attachments
458	that are attached at load/instantiate time, thus the need for a name.	818	that are attached at load/instantiate time, thus the need for a name.
459		819
460	These calls expect any number of the following handler/hook descriptions:	820	These calls expect any number of the following handler/hook descriptions:
461		821
462	=over 4	822	=over 4
…		…
522	our @CB_TYPE = (); # registry for type (cf-object class) based events	882	our @CB_TYPE = (); # registry for type (cf-object class) based events
523	our @CB_MAP = ();	883	our @CB_MAP = ();
524		884
525	my %attachment;	885	my %attachment;
526		886
		887	sub cf::attachable::thawer_merge {
		888	# simply override everything except _meta
		889	local $_[0]{_meta};
		890	%{$_[0]} = %{$_[1]};
		891	}
		892
527	sub _attach_cb($$$$) {	893	sub _attach_cb($$$$) {
528	my ($registry, $event, $prio, $cb) = @_;	894	my ($registry, $event, $prio, $cb) = @_;
529		895
530	use sort 'stable';	896	use sort 'stable';
531		897
…		…
565	$registry = $CB_TYPE[$object_type] ||= [];	931	$registry = $CB_TYPE[$object_type] ||= [];
566		932
567	} elsif ($type eq "subtype") {	933	} elsif ($type eq "subtype") {
568	defined $object_type or Carp::croak "subtype specified without type";	934	defined $object_type or Carp::croak "subtype specified without type";
569	my $object_subtype = shift @arg;	935	my $object_subtype = shift @arg;
570	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	936	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
571		937
572	} elsif ($type eq "package") {	938	} elsif ($type eq "package") {
573	my $pkg = shift @arg;	939	my $pkg = shift @arg;
574		940
575	while (my ($name, $id) = each %cb_id) {	941	while (my ($name, $id) = each %cb_id) {
…		…
604	_attach $registry, $klass, @attach;	970	_attach $registry, $klass, @attach;
605	}	971	}
606		972
607	$obj->{$name} = \%arg;	973	$obj->{$name} = \%arg;
608	} else {	974	} else {
609	warn "object uses attachment '$name' that is not available, postponing.\n";	975	warn "object uses attachment '$name' which is not available, postponing.\n";
610	}	976	}
611		977
612	$obj->{_attachment}{$name} = undef;	978	$obj->{_attachment}{$name} = undef;
613	}	979	}
614		980
…		…
616	if (ref $_[0]) {	982	if (ref $_[0]) {
617	_object_attach @_;	983	_object_attach @_;
618	} else {	984	} else {
619	_attach shift->_attach_registry, @_;	985	_attach shift->_attach_registry, @_;
620	}	986	}
		987	_recalc_want;
621	};	988	};
622		989
623	# all those should be optimised	990	# all those should be optimised
624	sub cf::attachable::detach {	991	sub cf::attachable::detach {
625	my ($obj, $name) = @_;	992	my ($obj, $name) = @_;
…		…
628	delete $obj->{_attachment}{$name};	995	delete $obj->{_attachment}{$name};
629	reattach ($obj);	996	reattach ($obj);
630	} else {	997	} else {
631	Carp::croak "cannot, currently, detach class attachments";	998	Carp::croak "cannot, currently, detach class attachments";
632	}	999	}
		1000	_recalc_want;
633	};	1001	};
634		1002
635	sub cf::attachable::attached {	1003	sub cf::attachable::attached {
636	my ($obj, $name) = @_;	1004	my ($obj, $name) = @_;
637		1005
…		…
652	";	1020	";
653	die if $@;	1021	die if $@;
654	}	1022	}
655		1023
656	our $override;	1024	our $override;
657	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?
658		1026
659	sub override {	1027	sub override {
660	$override = 1;	1028	$override = 1;
661	@invoke_results = ();	1029	@INVOKE_RESULTS = (@_);
662	}	1030	}
663		1031
664	sub do_invoke {	1032	sub do_invoke {
665	my $event = shift;	1033	my $event = shift;
666	my $callbacks = shift;	1034	my $callbacks = shift;
667		1035
668	@invoke_results = ();	1036	@INVOKE_RESULTS = ();
669		1037
670	local $override;	1038	local $override;
671		1039
672	for (@$callbacks) {	1040	for (@$callbacks) {
673	eval { &{$_->[1]} };	1041	eval { &{$_->[1]} };
…		…
682	}	1050	}
683		1051
684	0	1052	0
685	}	1053	}
686		1054
687	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1055	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
688		1056
689	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1057	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
690		1058
691	Generate an object-specific event with the given arguments.	1059	Generate an object-specific event with the given arguments.
692		1060
693	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
694	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
695	results (if you must, access C<@cf::invoke_results> directly).	1063	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
696		1064
697	=back	1065	=back
698		1066
699	=cut	1067	=cut
700		1068
701	#############################################################################	1069	#############################################################################
702	# 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	}
703		1113
704	sub reattach {	1114	sub reattach {
705	# basically do the same as instantiate, without calling instantiate	1115	# basically do the same as instantiate, without calling instantiate
706	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
707		1120
708	my $registry = $obj->registry;	1121	my $registry = $obj->registry;
709		1122
710	@$registry = ();	1123	@$registry = ();
711		1124
…		…
726	cf::attachable->attach (	1139	cf::attachable->attach (
727	prio => -1000000,	1140	prio => -1000000,
728	on_instantiate => sub {	1141	on_instantiate => sub {
729	my ($obj, $data) = @_;	1142	my ($obj, $data) = @_;
730		1143
731	$data = from_json $data;	1144	$data = decode_json $data;
732		1145
733	for (@$data) {	1146	for (@$data) {
734	my ($name, $args) = @$_;	1147	my ($name, $args) = @$_;
735		1148
736	$obj->attach ($name, %{$args || {} });	1149	$obj->attach ($name, %{$args || {} });
…		…
752	sub object_freezer_save {	1165	sub object_freezer_save {
753	my ($filename, $rdata, $objs) = @_;	1166	my ($filename, $rdata, $objs) = @_;
754		1167
755	sync_job {	1168	sync_job {
756	if (length $$rdata) {	1169	if (length $$rdata) {
		1170	utf8::decode (my $decname = $filename);
757	warn sprintf "saving %s (%d,%d)\n",	1171	warn sprintf "saving %s (%d,%d)\n",
758	$filename, length $$rdata, scalar @$objs;	1172	$decname, length $$rdata, scalar @$objs;
759		1173
760	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1174	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
761	chmod SAVE_MODE, $fh;	1175	aio_chmod $fh, SAVE_MODE;
762	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;
763	aio_fsync $fh;	1179	aio_fsync $fh;
		1180	}
764	close $fh;	1181	aio_close $fh;
765		1182
766	if (@$objs) {	1183	if (@$objs) {
767	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) {
768	chmod SAVE_MODE, $fh;	1185	aio_chmod $fh, SAVE_MODE;
769	my $data = Storable::nfreeze { version => 1, objs => $objs };	1186	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
770	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;
771	aio_fsync $fh;	1190	aio_fsync $fh;
		1191	}
772	close $fh;	1192	aio_close $fh;
773	aio_rename "$filename.pst~", "$filename.pst";	1193	aio_rename "$filename.pst~", "$filename.pst";
774	}	1194	}
775	} else {	1195	} else {
776	aio_unlink "$filename.pst";	1196	aio_unlink "$filename.pst";
777	}	1197	}
778		1198
779	aio_rename "$filename~", $filename;	1199	aio_rename "$filename~", $filename;
		1200
		1201	$filename =~ s%/[^/]+$%%;
		1202	aio_pathsync $filename if $cf::USE_FSYNC;
780	} else {	1203	} else {
781	warn "FATAL: $filename~: $!\n";	1204	warn "unable to save objects: $filename~: $!\n";
782	}	1205	}
783	} else {	1206	} else {
784	aio_unlink $filename;	1207	aio_unlink $filename;
785	aio_unlink "$filename.pst";	1208	aio_unlink "$filename.pst";
786	}	1209	}
787	}	1210	};
788	}	1211	}
789		1212
790	sub object_freezer_as_string {	1213	sub object_freezer_as_string {
791	my ($rdata, $objs) = @_;	1214	my ($rdata, $objs) = @_;
792		1215
…		…
804	or return;	1227	or return;
805		1228
806	unless (aio_stat "$filename.pst") {	1229	unless (aio_stat "$filename.pst") {
807	(aio_load "$filename.pst", $av) >= 0	1230	(aio_load "$filename.pst", $av) >= 0
808	or return;	1231	or return;
		1232
809	$av = eval { (Storable::thaw $av)->{objs} };	1233	my $st = eval { Coro::Storable::thaw $av };
		1234	$av = $st->{objs};
810	}	1235	}
811		1236
		1237	utf8::decode (my $decname = $filename);
		1238	warn sprintf "loading %s (%d,%d)\n",
		1239	$decname, length $data, scalar @{$av || []};
		1240
812	return ($data, $av);	1241	($data, $av)
813	}	1242	}
		1243
		1244	=head2 COMMAND CALLBACKS
		1245
		1246	=over 4
		1247
		1248	=cut
814		1249
815	#############################################################################	1250	#############################################################################
816	# command handling &c	1251	# command handling &c
817		1252
818	=item cf::register_command $name => \&callback($ob,$args);	1253	=item cf::register_command $name => \&callback($ob,$args);
…		…
831	push @{ $COMMAND{$name} }, [$caller, $cb];	1266	push @{ $COMMAND{$name} }, [$caller, $cb];
832	}	1267	}
833		1268
834	=item cf::register_extcmd $name => \&callback($pl,$packet);	1269	=item cf::register_extcmd $name => \&callback($pl,$packet);
835		1270
836	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.
837		1276
838	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
839	called.	1278	called.
840		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
841	=cut	1291	=cut
842		1292
843	sub register_extcmd {	1293	sub register_extcmd {
844	my ($name, $cb) = @_;	1294	my ($name, $cb) = @_;
845		1295
846	my $caller = caller;
847	#warn "registering extcmd '$name' to '$caller'";
848
849	$EXTCMD{$name} = [$cb, $caller];	1296	$EXTCMD{$name} = $cb;
850	}	1297	}
		1298
		1299	sub register_exticmd {
		1300	my ($name, $cb) = @_;
		1301
		1302	$EXTICMD{$name} = $cb;
		1303	}
		1304
		1305	use File::Glob ();
851		1306
852	cf::player->attach (	1307	cf::player->attach (
853	on_command => sub {	1308	on_command => sub {
854	my ($pl, $name, $params) = @_;	1309	my ($pl, $name, $params) = @_;
855		1310
…		…
863	cf::override;	1318	cf::override;
864	},	1319	},
865	on_extcmd => sub {	1320	on_extcmd => sub {
866	my ($pl, $buf) = @_;	1321	my ($pl, $buf) = @_;
867		1322
868	my $msg = eval { from_json $buf };	1323	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
869		1324
870	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
871	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1333	if (my $cb = $EXTCMD{$type}) {
872	if (my %reply = $cb->[0]->($pl, $msg)) {	1334	@reply = $cb->($pl, @payload);
873	$pl->ext_reply ($msg->{msgid}, %reply);
874	}
875	}	1335	}
		1336
		1337	$pl->ext_reply ($reply, @reply)
		1338	if $reply;
		1339
876	} else {	1340	} else {
877	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1341	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
878	}	1342	}
879		1343
880	cf::override;	1344	cf::override;
881	},	1345	},
882	);	1346	);
883		1347
884	sub register {	1348	# "readahead" all extensions
885	my ($base, $pkg) = @_;	1349	sub cache_extensions {
		1350	my $grp = IO::AIO::aio_group;
886		1351
887	#TODO	1352	add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
888	}	1353	for (grep /\.ext$/, @{$_[0]}) {
		1354	add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
		1355	}
		1356	};
889		1357
		1358	$grp
		1359	}
		1360
890	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($) {
891	my ($path) = @_;	1716	my ($path) = @_;
892		1717
893	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1718	my ($match, $specificity);
894	my $base = $1;
895	my $pkg = $1;
896	$pkg =~ s/[^[:word:]]/_/g;
897	$pkg = "ext::$pkg";
898		1719
899	warn "loading '$path' into '$pkg'\n";	1720	for my $region (list) {
900		1721	if ($region->{match} && $path =~ $region->{match}) {
901	open my $fh, "<:utf8", $path	1722	($match, $specificity) = ($region, $region->specificity)
902	or die "$path: $!";	1723	if $region->specificity > $specificity;
903		1724	}
904	my $source =
905	"package $pkg; use strict; use utf8;\n"
906	. "#line 1 \"$path\"\n{\n"
907	. (do { local $/; <$fh> })
908	. "\n};\n1";
909
910	eval $source
911	or die $@ ? "$path: $@\n"
912	: "extension disabled.\n";
913
914	push @exts, $pkg;
915	$ext_pkg{$base} = $pkg;
916
917	# no strict 'refs';
918	# @{"$pkg\::ISA"} = ext::;
919
920	register $base, $pkg;
921	}
922
923	sub unload_extension {
924	my ($pkg) = @_;
925
926	warn "removing extension $pkg\n";
927
928	# remove hooks
929	#TODO
930	# for my $idx (0 .. $#PLUGIN_EVENT) {
931	# delete $hook[$idx]{$pkg};
932	# }	1725	}
933		1726
934	# remove commands	1727	$match
935	for my $name (keys %COMMAND) {
936	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
937
938	if (@cb) {
939	$COMMAND{$name} = \@cb;
940	} else {
941	delete $COMMAND{$name};
942	}
943	}
944
945	# remove extcmds
946	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
947	delete $EXTCMD{$name};
948	}
949
950	if (my $cb = $pkg->can ("unload")) {
951	eval {
952	$cb->($pkg);
953	1
954	} or warn "$pkg unloaded, but with errors: $@";
955	}
956
957	Symbol::delete_package $pkg;
958	}
959
960	sub load_extensions {
961	for my $ext (<$LIBDIR/*.ext>) {
962	next unless -r $ext;
963	eval {
964	load_extension $ext;
965	1
966	} or warn "$ext not loaded: $@";
967	}
968	}
969
970	#############################################################################
971	# load/save/clean perl data associated with a map
972
973	*cf::mapsupport::on_clean = sub {
974	my ($map) = @_;
975
976	my $path = $map->tmpname;
977	defined $path or return;
978
979	unlink "$path.pst";
980	};
981
982	cf::map->attach (prio => -10000, package => cf::mapsupport::);
983
984	#############################################################################
985	# load/save perl data associated with player->ob objects
986
987	sub all_objects(@) {
988	@_, map all_objects ($_->inv), @_
989	}
990
991	# TODO: compatibility cruft, remove when no longer needed
992	cf::player->attach (
993	on_load => sub {
994	my ($pl, $path) = @_;
995
996	for my $o (all_objects $pl->ob) {
997	if (my $value = $o->get_ob_key_value ("_perl_data")) {
998	$o->set_ob_key_value ("_perl_data");
999
1000	%$o = %{ Storable::thaw pack "H*", $value };
1001	}
1002	}
1003	},
1004	);
1005
1006	#############################################################################
1007
1008	=head2 CORE EXTENSIONS
1009
1010	Functions and methods that extend core crossfire objects.
1011
1012	=head3 cf::player
1013
1014	=over 4
1015
1016	=item cf::player::exists $login
1017
1018	Returns true when the given account exists.
1019
1020	=cut
1021
1022	sub cf::player::exists($) {
1023	cf::player::find $_[0]
1024	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1025	}
1026
1027	=item $player->ext_reply ($msgid, $msgtype, %msg)
1028
1029	Sends an ext reply to the player.
1030
1031	=cut
1032
1033	sub cf::player::ext_reply($$$%) {
1034	my ($self, $id, %msg) = @_;
1035
1036	$msg{msgid} = $id;
1037
1038	$self->send ("ext " . to_json \%msg);
1039	}	1728	}
1040		1729
1041	=back	1730	=back
1042
1043		1731
1044	=head3 cf::map	1732	=head3 cf::map
1045		1733
1046	=over 4	1734	=over 4
1047		1735
…		…
1050	package cf::map;	1738	package cf::map;
1051		1739
1052	use Fcntl;	1740	use Fcntl;
1053	use Coro::AIO;	1741	use Coro::AIO;
1054		1742
		1743	use overload
		1744	'""' => \&as_string,
		1745	fallback => 1;
		1746
1055	our $MAX_RESET = 7200;	1747	our $MAX_RESET = 3600;
1056	our $DEFAULT_RESET = 3600;	1748	our $DEFAULT_RESET = 3000;
1057		1749
1058	sub generate_random_map {	1750	sub generate_random_map {
1059	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
1060		1754
1061	# mit "rum" bekleckern, nicht	1755	# mit "rum" bekleckern, nicht
1062	cf::map::_create_random_map	1756	$self->_create_random_map (
1063	$path,
1064	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1757	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1065	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1758	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1066	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1759	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1067	$rmp->{exit_on_final_map},	1760	$rmp->{exit_on_final_map},
1068	$rmp->{xsize}, $rmp->{ysize},	1761	$rmp->{xsize}, $rmp->{ysize},
1069	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1762	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1070	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1763	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1071	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1764	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1072	$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},
1073	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1766	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1074	(cf::region::find $rmp->{region})	1767	(cf::region::find $rmp->{region}), $rmp->{custom}
		1768	)
1075	}	1769	}
1076		1770
1077	# and all this just because we cannot iterate over	1771	=item cf::map->register ($regex, $prio)
1078	# all maps in C++...
1079	sub change_all_map_light {
1080	my ($change) = @_;
1081		1772
1082	$_->change_map_light ($change) for values %cf::MAP;	1773	Register a handler for the map path matching the given regex at the
1083	}	1774	givne priority (higher is better, built-in handlers have priority 0, the
		1775	default).
1084		1776
1085	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 {
1086	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) = @_;
1087		1916
1088	utf8::encode $path;	1917	utf8::encode $path;
1089	aio_open $path, O_RDONLY, 0	1918	my $f = new_from_file cf::object::thawer $path
1090	or return;	1919	or return;
1091		1920
1092	my $map = cf::map::new	1921	$self->_load_header ($f)
1093	or return;	1922	or return;
1094		1923
1095	$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
1096	or return;	1970	or return;
		1971	$self->prepare_orig;
		1972	}
1097		1973
1098	$map->{load_path} = $path;	1974	$self->{deny_reset} = 1
		1975	if $self->no_reset;
1099		1976
1100	$map	1977	$self->default_region (cf::region::find_by_path $self->{path})
1101	}	1978	unless $self->default_region;
1102		1979
		1980	1
		1981	}
		1982
		1983	sub find;
1103	sub find_map {	1984	sub find {
1104	my ($path, $origin) = @_;	1985	my ($path, $origin) = @_;
1105		1986
1106	#warn "find_map<$path,$origin>\n";#d#
1107
1108	$path = new cf::path $path, $origin && $origin->path;	1987	$path = normalise $path, $origin && $origin->path;
1109	my $key = $path->as_string;
1110		1988
		1989	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
		1990	my $guard2 = cf::lock_acquire "map_find:$path";
		1991
1111	$cf::MAP{$key} || do {	1992	$cf::MAP{$path} || do {
1112	# do it the slow way	1993	my $map = new_from_path cf::map $path
1113	my $map = try_load_header $path->save_path;
1114
1115	if ($map) {
1116	# safety
1117	$map->{instantiate_time} = $cf::RUNTIME
1118	if $map->{instantiate_time} > $cf::RUNTIME;
1119	} else {
1120	if (my $rmp = $path->random_map_params) {
1121	$map = generate_random_map $key, $rmp;
1122	} else {
1123	$map = try_load_header $path->load_path;
1124	}
1125
1126	$map or return;	1994	or return;
1127		1995
1128	$map->{load_original} = 1;
1129	$map->{instantiate_time} = $cf::RUNTIME;
1130	$map->instantiate;
1131
1132	# per-player maps become, after loading, normal maps
1133	$map->per_player (0) if $path->{user_rel};
1134	}
1135
1136	$map->path ($key);
1137	$map->{path} = $path;
1138	$map->last_access ($cf::RUNTIME);	1996	$map->{last_save} = $cf::RUNTIME;
1139		1997
1140	if ($map->should_reset) {	1998	$map->load_header
		1999	or return;
		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;
1141	$map->reset;	2006	$map->reset;
1142	$map = find_map $path;	2007	return find $path;
1143	}	2008	}
1144		2009
1145	$cf::MAP{$key} = $map	2010	$cf::MAP{$path} = $map
1146	}	2011	}
1147	}	2012	}
		2013
		2014	sub pre_load { }
		2015	sub post_load { }
1148		2016
1149	sub load {	2017	sub load {
1150	my ($self) = @_;	2018	my ($self) = @_;
1151		2019
1152	return if $self->in_memory != cf::MAP_SWAPPED;	2020	local $self->{deny_reset} = 1; # loading can take a long time
1153
1154	$self->in_memory (cf::MAP_LOADING);
1155		2021
1156	my $path = $self->{path};	2022	my $path = $self->{path};
1157		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
1158	$self->alloc;	2032	$self->alloc;
1159	$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)
1160	or return;	2040	or return;
1161		2041
1162	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2042	$self->post_load_original
1163	if delete $self->{load_original};	2043	if delete $self->{load_original};
1164		2044
1165	if (my $uniq = $path->uniq_path) {	2045	if (my $uniq = $self->uniq_path) {
1166	utf8::encode $uniq;	2046	utf8::encode $uniq;
1167	if (aio_open $uniq, O_RDONLY, 0) {	2047	unless (aio_stat $uniq) {
		2048	if (my $f = new_from_file cf::object::thawer $uniq) {
1168	$self->clear_unique_items;	2049	$self->clear_unique_items;
1169	$self->load_objects ($uniq, 0);	2050	$self->_load_objects ($f);
		2051	$f->resolve_delayed_derefs;
		2052	}
1170	}	2053	}
1171	}	2054	}
1172		2055
		2056	$f->resolve_delayed_derefs;
		2057
		2058	cf::cede_to_tick;
1173	# now do the right thing for maps	2059	# now do the right thing for maps
1174	$self->link_multipart_objects;	2060	$self->link_multipart_objects;
1175
1176	if ($self->{path}->is_style_map) {
1177	$self->{deny_save} = 1;
1178	$self->{deny_reset} = 1;
1179	} else {
1180	$self->fix_auto_apply;
1181	$self->decay_objects;
1182	$self->update_buttons;
1183	$self->set_darkness_map;
1184	$self->difficulty ($self->estimate_difficulty)	2061	$self->difficulty ($self->estimate_difficulty)
1185	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;
1186	$self->activate;	2070	$self->activate;
1187	}	2071	}
1188		2072
		2073	$self->{last_save} = $cf::RUNTIME;
		2074	$self->last_access ($cf::RUNTIME);
		2075
1189	$self->in_memory (cf::MAP_IN_MEMORY);	2076	$self->in_memory (cf::MAP_ACTIVE);
1190	}	2077	}
1191		2078
1192	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 {
1193	my ($path, $origin) = @_;	2121	my ($path, $origin) = @_;
1194		2122
1195	#warn "load_map_sync<$path, $origin>\n";#d#	2123	cf::sync_job { find $path, $origin }
		2124	}
1196		2125
1197	cf::sync_job {	2126	sub do_load_sync {
1198	my $map = cf::map::find_map $path, $origin	2127	my ($map) = @_;
1199	or return;	2128
1200	$map->load;	2129	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1201	$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;
1202	}	2162	};
		2163	$MAP_PREFETCHER->prio (6);
		2164
		2165	()
1203	}	2166	}
1204		2167
1205	sub save {	2168	sub save {
1206	my ($self) = @_;	2169	my ($self) = @_;
1207		2170
1208	my $save = $self->{path}->save_path; utf8::encode $save;	2171	my $lock = cf::lock_acquire "map_data:$self->{path}";
1209	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
1210		2172
1211	$self->{last_save} = $cf::RUNTIME;	2173	$self->{last_save} = $cf::RUNTIME;
1212		2174
1213	return unless $self->dirty;	2175	return unless $self->dirty;
1214		2176
		2177	my $save = $self->save_path; utf8::encode $save;
		2178	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2179
1215	$self->{load_path} = $save;	2180	$self->{load_path} = $save;
1216		2181
1217	return if $self->{deny_save};	2182	return if $self->{deny_save};
1218		2183
		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;
		2192
1219	if ($uniq) {	2193	if ($uniq) {
1220	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2194	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1221	$self->save_objects ($uniq, cf::IO_UNIQUES);	2195	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1222	} else {	2196	} else {
1223	$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);
1224	}	2198	}
1225	}	2199	}
1226		2200
1227	sub swap_out {	2201	sub swap_out {
1228	my ($self) = @_;	2202	my ($self) = @_;
1229		2203
		2204	# save first because save cedes
		2205	$self->save;
		2206
		2207	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2208
1230	return if $self->players;	2209	return if $self->players;
1231	return if $self->in_memory != cf::MAP_IN_MEMORY;	2210	return if $self->in_memory != cf::MAP_ACTIVE;
1232	return if $self->{deny_save};	2211	return if $self->{deny_save};
1233		2212
		2213	$self->in_memory (cf::MAP_SWAPPED);
		2214
1234	$self->save;	2215	$self->deactivate;
		2216	$_->clear_links_to ($self) for values %cf::MAP;
1235	$self->clear;	2217	$self->clear;
1236	$self->in_memory (cf::MAP_SWAPPED);
1237	}	2218	}
1238		2219
1239	sub reset_at {	2220	sub reset_at {
1240	my ($self) = @_;	2221	my ($self) = @_;
1241		2222
1242	# TODO: safety, remove and allow resettable per-player maps	2223	# TODO: safety, remove and allow resettable per-player maps
1243	return 1e100 if $self->{path}{user_rel};
1244	return 1e100 if $self->{deny_reset};	2224	return 1e99 if $self->{deny_reset};
1245		2225
1246	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2226	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1247	my $to = $self->reset_timeout || $DEFAULT_RESET;	2227	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1248	$to = $MAX_RESET if $to > $MAX_RESET;
1249		2228
1250	$time + $to	2229	$time + $to
1251	}	2230	}
1252		2231
1253	sub should_reset {	2232	sub should_reset {
1254	my ($self) = @_;	2233	my ($self) = @_;
1255		2234
1256	$self->reset_at <= $cf::RUNTIME	2235	$self->reset_at <= $cf::RUNTIME
1257	}	2236	}
1258		2237
1259	sub unlink_save {
1260	my ($self) = @_;
1261
1262	utf8::encode (my $save = $self->{path}->save_path);
1263	aioreq_pri 3; IO::AIO::aio_unlink $save;
1264	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1265	}
1266
1267	sub rename {
1268	my ($self, $new_path) = @_;
1269
1270	$self->unlink_save;
1271
1272	delete $cf::MAP{$self->path};
1273	$self->{path} = new cf::path $new_path;
1274	$self->path ($self->{path}->path);
1275	$cf::MAP{$self->path} = $self;
1276
1277	$self->save;
1278	}
1279
1280	sub reset {	2238	sub reset {
1281	my ($self) = @_;	2239	my ($self) = @_;
1282		2240
		2241	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2242
1283	return if $self->players;	2243	return if $self->players;
1284	return if $self->{path}{user_rel};#d#
1285		2244
1286	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	}
1287		2256
1288	delete $cf::MAP{$self->path};	2257	delete $cf::MAP{$self->path};
1289		2258
		2259	$self->deactivate;
1290	$_->clear_links_to ($self) for values %cf::MAP;	2260	$_->clear_links_to ($self) for values %cf::MAP;
		2261	$self->clear;
1291		2262
1292	$self->unlink_save;	2263	$self->unlink_save;
1293	$self->destroy;	2264	$self->destroy;
1294	}	2265	}
1295		2266
1296	sub customise_for {	2267	my $nuke_counter = "aaaa";
1297	my ($map, $ob) = @_;
1298		2268
1299	if ($map->per_player) {	2269	sub nuke {
1300	return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path};	2270	my ($self) = @_;
		2271
1301	}	2272	{
		2273	my $lock = cf::lock_acquire "map_data:$self->{path}";
1302		2274
1303	$map	2275	delete $cf::MAP{$self->path};
1304	}
1305		2276
1306	sub emergency_save {	2277	$self->unlink_save;
1307	local $cf::FREEZE = 1;
1308		2278
1309	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++));
1310		2284
1311	cf::sync_job {	2285	$cf::MAP{$self->path} = $self;
1312	warn "begin emergency map save\n";
1313	$_->save for values %cf::MAP;
1314	};	2286	}
1315		2287
1316	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	=back
		2347
		2348	=head3 cf::object
		2349
		2350	=cut
		2351
		2352	package cf::object;
		2353
		2354	=over 4
		2355
		2356	=item $ob->inv_recursive
		2357
		2358	Returns the inventory of the object I<and> their inventories, recursively,
		2359	but I<not> the object itself.
		2360
		2361	=cut
		2362
		2363	sub inv_recursive_;
		2364	sub inv_recursive_ {
		2365	map { $_, inv_recursive_ $_->inv } @_
		2366	}
		2367
		2368	sub inv_recursive {
		2369	inv_recursive_ inv $_[0]
		2370	}
		2371
		2372	=item $ref = $ob->ref
		2373
		2374	Creates and returns a persistent reference to an object that can be stored as a string.
		2375
		2376	=item $ob = cf::object::deref ($refstring)
		2377
		2378	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2379	even if the object actually exists. May block.
		2380
		2381	=cut
		2382
		2383	sub deref {
		2384	my ($ref) = @_;
		2385
		2386	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2387	my ($uuid, $name) = ($1, $2);
		2388	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2389	or return;
		2390	$pl->ob->uuid eq $uuid
		2391	or return;
		2392
		2393	$pl->ob
		2394	} else {
		2395	warn "$ref: cannot resolve object reference\n";
		2396	undef
		2397	}
1317	}	2398	}
1318		2399
1319	package cf;	2400	package cf;
1320		2401
1321	=back	2402	=back
1322
1323		2403
1324	=head3 cf::object::player	2404	=head3 cf::object::player
1325		2405
1326	=over 4	2406	=over 4
1327		2407
…		…
1330	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	2410	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
1331	can be C<undef>. Does the right thing when the player is currently in a	2411	can be C<undef>. Does the right thing when the player is currently in a
1332	dialogue with the given NPC character.	2412	dialogue with the given NPC character.
1333		2413
1334	=cut	2414	=cut
		2415
		2416	our $SAY_CHANNEL = {
		2417	id => "say",
		2418	title => "Map",
		2419	reply => "say ",
		2420	tooltip => "Things said to and replied from NPCs near you and other players on the same map only.",
		2421	};
		2422
		2423	our $CHAT_CHANNEL = {
		2424	id => "chat",
		2425	title => "Chat",
		2426	reply => "chat ",
		2427	tooltip => "Player chat and shouts, global to the server.",
		2428	};
1335		2429
1336	# rough implementation of a future "reply" method that works	2430	# rough implementation of a future "reply" method that works
1337	# with dialog boxes.	2431	# with dialog boxes.
1338	#TODO: the first argument must go, split into a $npc->reply_to ( method	2432	#TODO: the first argument must go, split into a $npc->reply_to ( method
1339	sub cf::object::player::reply($$$;$) {	2433	sub cf::object::player::reply($$$;$) {
…		…
1341		2435
1342	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2436	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1343		2437
1344	if ($self->{record_replies}) {	2438	if ($self->{record_replies}) {
1345	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2439	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2440
1346	} else {	2441	} else {
		2442	my $pl = $self->contr;
		2443
		2444	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2445	my $dialog = $pl->{npc_dialog};
		2446	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2447
		2448	} else {
1347	$msg = $npc->name . " says: $msg" if $npc;	2449	$msg = $npc->name . " says: $msg" if $npc;
1348	$self->message ($msg, $flags);	2450	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2451	}
1349	}	2452	}
		2453	}
		2454
		2455	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2456
		2457	=cut
		2458
		2459	sub cf::object::send_msg {
		2460	my $pl = shift->contr
		2461	or return;
		2462	$pl->send_msg (@_);
1350	}	2463	}
1351		2464
1352	=item $player_object->may ("access")	2465	=item $player_object->may ("access")
1353		2466
1354	Returns wether the given player is authorized to access resource "access"	2467	Returns wether the given player is authorized to access resource "access"
…		…
1363	(ref $cf::CFG{"may_$access"}	2476	(ref $cf::CFG{"may_$access"}
1364	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	2477	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
1365	: $cf::CFG{"may_$access"})	2478	: $cf::CFG{"may_$access"})
1366	}	2479	}
1367		2480
		2481	=item $player_object->enter_link
		2482
		2483	Freezes the player and moves him/her to a special map (C<{link}>).
		2484
		2485	The player should be reasonably safe there for short amounts of time (e.g.
		2486	for loading a map). You I<MUST> call C<leave_link> as soon as possible,
		2487	though, as the palyer cannot control the character while it is on the link
		2488	map.
		2489
		2490	Will never block.
		2491
		2492	=item $player_object->leave_link ($map, $x, $y)
		2493
		2494	Moves the player out of the special C<{link}> map onto the specified
		2495	map. If the map is not valid (or omitted), the player will be moved back
		2496	to the location he/she was before the call to C<enter_link>, or, if that
		2497	fails, to the emergency map position.
		2498
		2499	Might block.
		2500
		2501	=cut
		2502
		2503	sub link_map {
		2504	unless ($LINK_MAP) {
		2505	$LINK_MAP = cf::map::find "{link}"
		2506	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2507	$LINK_MAP->load;
		2508	}
		2509
		2510	$LINK_MAP
		2511	}
		2512
1368	sub cf::object::player::enter_link {	2513	sub cf::object::player::enter_link {
1369	my ($self) = @_;	2514	my ($self) = @_;
1370		2515
1371	return if $self->map == $LINK_MAP;
1372
1373	$self->{_link_pos} = [$self->map->{path}, $self->x, $self->y]
1374	if $self->map;
1375
1376	$self->enter_map ($LINK_MAP, 20, 20);
1377	$self->deactivate_recursive;	2516	$self->deactivate_recursive;
		2517
		2518	return if UNIVERSAL::isa $self->map, "ext::map_link";
		2519
		2520	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		2521	if $self->map && $self->map->{path} ne "{link}";
		2522
		2523	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1378	}	2524	}
1379		2525
1380	sub cf::object::player::leave_link {	2526	sub cf::object::player::leave_link {
1381	my ($self, $map, $x, $y) = @_;	2527	my ($self, $map, $x, $y) = @_;
1382		2528
		2529	return unless $self->contr->active;
		2530
1383	my $link_pos = delete $self->{_link_pos};	2531	my $link_pos = delete $self->{_link_pos};
1384		2532
1385	unless ($map) {	2533	unless ($map) {
1386	$self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1387
1388	# restore original map position	2534	# restore original map position
1389	($map, $x, $y) = @{ $link_pos || [] };	2535	($map, $x, $y) = @{ $link_pos || [] };
1390	$map = cf::map::find_map $map;	2536	$map = cf::map::find $map;
1391		2537
1392	unless ($map) {	2538	unless ($map) {
1393	($map, $x, $y) = @$EMERGENCY_POSITION;	2539	($map, $x, $y) = @$EMERGENCY_POSITION;
1394	$map = cf::map::find_map $map	2540	$map = cf::map::find $map
1395	or die "FATAL: cannot load emergency map\n";	2541	or die "FATAL: cannot load emergency map\n";
1396	}	2542	}
1397	}	2543	}
1398		2544
1399	($x, $y) = (-1, -1)	2545	($x, $y) = (-1, -1)
…		…
1402	# use -1 or undef as default coordinates, not 0, 0	2548	# use -1 or undef as default coordinates, not 0, 0
1403	($x, $y) = ($map->enter_x, $map->enter_y)	2549	($x, $y) = ($map->enter_x, $map->enter_y)
1404	if $x <=0 && $y <= 0;	2550	if $x <=0 && $y <= 0;
1405		2551
1406	$map->load;	2552	$map->load;
		2553	$map->load_neighbours;
1407		2554
		2555	return unless $self->contr->active;
		2556
		2557	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
		2558	$self->enter_map ($map, $x, $y);
		2559
		2560	# only activate afterwards, to support waiting in hooks
1408	$self->activate_recursive;	2561	$self->activate_recursive;
1409	$self->enter_map ($map, $x, $y);
1410	}	2562	}
1411		2563
1412	=item $player_object->goto_map ($map, $x, $y)	2564	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1413		2565
1414	=cut	2566	Moves the player to the given map-path and coordinates by first freezing
		2567	her, loading and preparing them map, calling the provided $check callback
		2568	that has to return the map if sucecssful, and then unfreezes the player on
		2569	the new (success) or old (failed) map position. In either case, $done will
		2570	be called at the end of this process.
1415		2571
		2572	Note that $check will be called with a potentially non-loaded map, so if
		2573	it needs a loaded map it has to call C<< ->load >>.
		2574
		2575	=cut
		2576
		2577	our $GOTOGEN;
		2578
1416	sub cf::object::player::goto_map {	2579	sub cf::object::player::goto {
1417	my ($self, $path, $x, $y) = @_;	2580	my ($self, $path, $x, $y, $check, $done) = @_;
		2581
		2582	# do generation counting so two concurrent goto's will be executed in-order
		2583	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1418		2584
1419	$self->enter_link;	2585	$self->enter_link;
1420		2586
1421	(Coro::async {	2587	(async {
1422	$path = new cf::path $path;	2588	$Coro::current->{desc} = "player::goto $path $x $y";
1423		2589
1424	my $map = cf::map::find_map $path->as_string;	2590	# *tag paths override both path and x|y
		2591	if ($path =~ /^\*(.*)$/) {
		2592	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2593	my $ob = $obs[rand @obs];
		2594
		2595	# see if we actually can go there
		2596	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2597	$ob = $obs[rand @obs];
		2598	} else {
		2599	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2600	}
		2601	# else put us there anyways for now #d#
		2602
		2603	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2604	} else {
		2605	($path, $x, $y) = (undef, undef, undef);
		2606	}
		2607	}
		2608
		2609	my $map = eval {
		2610	my $map = defined $path ? cf::map::find $path : undef;
		2611
		2612	if ($map) {
1425	$map = $map->customise_for ($self) if $map;	2613	$map = $map->customise_for ($self);
		2614	$map = $check->($map) if $check && $map;
		2615	} else {
		2616	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2617	}
1426		2618
1427	warn "entering ", $map->path, " at ($x, $y)\n"
1428	if $map;	2619	$map
		2620	};
1429		2621
		2622	if ($@) {
		2623	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2624	LOG llevError | logBacktrace, Carp::longmess $@;
		2625	}
		2626
		2627	if ($gen == $self->{_goto_generation}) {
		2628	delete $self->{_goto_generation};
1430	$self->leave_link ($map, $x, $y);	2629	$self->leave_link ($map, $x, $y);
		2630	}
		2631
		2632	$done->() if $done;
1431	})->prio (1);	2633	})->prio (1);
1432	}	2634	}
1433		2635
1434	=item $player_object->enter_exit ($exit_object)	2636	=item $player_object->enter_exit ($exit_object)
1435		2637
…		…
1437		2639
1438	sub parse_random_map_params {	2640	sub parse_random_map_params {
1439	my ($spec) = @_;	2641	my ($spec) = @_;
1440		2642
1441	my $rmp = { # defaults	2643	my $rmp = { # defaults
1442	xsize => 10,	2644	xsize => (cf::rndm 15, 40),
1443	ysize => 10,	2645	ysize => (cf::rndm 15, 40),
		2646	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2647	#layout => string,
1444	};	2648	};
1445		2649
1446	for (split /\n/, $spec) {	2650	for (split /\n/, $spec) {
1447	my ($k, $v) = split /\s+/, $_, 2;	2651	my ($k, $v) = split /\s+/, $_, 2;
1448		2652
…		…
1460	# that depends on the exit object	2664	# that depends on the exit object
1461		2665
1462	my $rmp = parse_random_map_params $exit->msg;	2666	my $rmp = parse_random_map_params $exit->msg;
1463		2667
1464	if ($exit->map) {	2668	if ($exit->map) {
1465	$rmp->{region} = $exit->map->region_name;	2669	$rmp->{region} = $exit->region->name;
1466	$rmp->{origin_map} = $exit->map->path;	2670	$rmp->{origin_map} = $exit->map->path;
1467	$rmp->{origin_x} = $exit->x;	2671	$rmp->{origin_x} = $exit->x;
1468	$rmp->{origin_y} = $exit->y;	2672	$rmp->{origin_y} = $exit->y;
		2673
		2674	$exit->map->touch;
1469	}	2675	}
1470		2676
1471	$rmp->{random_seed} ||= $exit->random_seed;	2677	$rmp->{random_seed} ||= $exit->random_seed;
1472		2678
1473	my $data = cf::to_json $rmp;	2679	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1474	my $md5 = Digest::MD5::md5_hex $data;	2680	my $md5 = Digest::MD5::md5_hex $data;
		2681	my $meta = "$RANDOMDIR/$md5.meta";
1475		2682
1476	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2683	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1477	aio_write $fh, 0, (length $data), $data, 0;	2684	aio_write $fh, 0, (length $data), $data, 0;
		2685	undef $fh;
		2686	aio_rename "$meta~", $meta;
1478		2687
		2688	my $slaying = "?random/$md5";
		2689
		2690	if ($exit->valid) {
1479	$exit->slaying ("?random/$md5");	2691	$exit->slaying ("?random/$md5");
1480	$exit->msg (undef);	2692	$exit->msg (undef);
		2693	}
1481	}	2694	}
1482	}	2695	}
1483		2696
1484	sub cf::object::player::enter_exit {	2697	sub cf::object::player::enter_exit {
1485	my ($self, $exit) = @_;	2698	my ($self, $exit) = @_;
1486		2699
1487	return unless $self->type == cf::PLAYER;	2700	return unless $self->type == cf::PLAYER;
1488		2701
1489	$self->enter_link;	2702	$self->enter_link;
1490		2703
1491	(Coro::async {	2704	(async {
		2705	$Coro::current->{desc} = "enter_exit";
		2706
1492	unless (eval {	2707	unless (eval {
		2708	$self->deactivate_recursive; # just to be sure
1493		2709
		2710	# random map handling
		2711	{
		2712	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2713
1494	prepare_random_map $exit	2714	prepare_random_map $exit
1495	if $exit->slaying eq "/!";	2715	if $exit->slaying eq "/!";
		2716	}
1496		2717
1497	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;	2718	my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1498	$self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);	2719	my $x = $exit->stats->hp;
		2720	my $y = $exit->stats->sp;
1499		2721
		2722	$self->goto ($map, $x, $y);
		2723
		2724	# if exit is damned, update players death & WoR home-position
		2725	$self->contr->savebed ($map, $x, $y)
		2726	if $exit->flag (cf::FLAG_DAMNED);
		2727
1500	1;	2728	1
1501	}) {	2729	}) {
1502	$self->message ("Something went wrong deep within the crossfire server. "	2730	$self->message ("Something went wrong deep within the deliantra server. "
1503	. "I'll try to bring you back to the map you were before. "	2731	. "I'll try to bring you back to the map you were before. "
1504	. "Please report this to the dungeon master",	2732	. "Please report this to the dungeon master!",
1505	cf::NDI_UNIQUE | cf::NDI_RED);	2733	cf::NDI_UNIQUE | cf::NDI_RED);
1506		2734
1507	warn "ERROR in enter_exit: $@";	2735	warn "ERROR in enter_exit: $@";
1508	$self->leave_link;	2736	$self->leave_link;
1509	}	2737	}
1510	})->prio (1);	2738	})->prio (1);
…		…
1523		2751
1524	sub cf::client::send_drawinfo {	2752	sub cf::client::send_drawinfo {
1525	my ($self, $text, $flags) = @_;	2753	my ($self, $text, $flags) = @_;
1526		2754
1527	utf8::encode $text;	2755	utf8::encode $text;
1528	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2756	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1529	}	2757	}
1530		2758
		2759	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2760
		2761	Send a drawinfo or msg packet to the client, formatting the msg for the
		2762	client if neccessary. C<$type> should be a string identifying the type of
		2763	the message, with C<log> being the default. If C<$color> is negative, suppress
		2764	the message unless the client supports the msg packet.
		2765
		2766	=cut
		2767
		2768	# non-persistent channels (usually the info channel)
		2769	our %CHANNEL = (
		2770	"c/motd" => {
		2771	id => "infobox",
		2772	title => "MOTD",
		2773	reply => undef,
		2774	tooltip => "The message of the day",
		2775	},
		2776	"c/identify" => {
		2777	id => "infobox",
		2778	title => "Identify",
		2779	reply => undef,
		2780	tooltip => "Items recently identified",
		2781	},
		2782	"c/examine" => {
		2783	id => "infobox",
		2784	title => "Examine",
		2785	reply => undef,
		2786	tooltip => "Signs and other items you examined",
		2787	},
		2788	"c/book" => {
		2789	id => "infobox",
		2790	title => "Book",
		2791	reply => undef,
		2792	tooltip => "The contents of a note or book",
		2793	},
		2794	"c/lookat" => {
		2795	id => "infobox",
		2796	title => "Look",
		2797	reply => undef,
		2798	tooltip => "What you saw there",
		2799	},
		2800	"c/who" => {
		2801	id => "infobox",
		2802	title => "Players",
		2803	reply => undef,
		2804	tooltip => "Shows players who are currently online",
		2805	},
		2806	"c/body" => {
		2807	id => "infobox",
		2808	title => "Body Parts",
		2809	reply => undef,
		2810	tooltip => "Shows which body parts you posess and are available",
		2811	},
		2812	"c/statistics" => {
		2813	id => "infobox",
		2814	title => "Statistics",
		2815	reply => undef,
		2816	tooltip => "Shows your primary statistics",
		2817	},
		2818	"c/skills" => {
		2819	id => "infobox",
		2820	title => "Skills",
		2821	reply => undef,
		2822	tooltip => "Shows your experience per skill and item power",
		2823	},
		2824	"c/shopitems" => {
		2825	id => "infobox",
		2826	title => "Shop Items",
		2827	reply => undef,
		2828	tooltip => "Shows the items currently for sale in this shop",
		2829	},
		2830	"c/resistances" => {
		2831	id => "infobox",
		2832	title => "Resistances",
		2833	reply => undef,
		2834	tooltip => "Shows your resistances",
		2835	},
		2836	"c/pets" => {
		2837	id => "infobox",
		2838	title => "Pets",
		2839	reply => undef,
		2840	tooltip => "Shows information abotu your pets/a specific pet",
		2841	},
		2842	"c/perceiveself" => {
		2843	id => "infobox",
		2844	title => "Perceive Self",
		2845	reply => undef,
		2846	tooltip => "You gained detailed knowledge about yourself",
		2847	},
		2848	"c/uptime" => {
		2849	id => "infobox",
		2850	title => "Uptime",
		2851	reply => undef,
		2852	tooltip => "How long the server has been running since last restart",
		2853	},
		2854	"c/mapinfo" => {
		2855	id => "infobox",
		2856	title => "Map Info",
		2857	reply => undef,
		2858	tooltip => "Information related to the maps",
		2859	},
		2860	"c/party" => {
		2861	id => "party",
		2862	title => "Party",
		2863	reply => "gsay ",
		2864	tooltip => "Messages and chat related to your party",
		2865	},
		2866	"c/death" => {
		2867	id => "death",
		2868	title => "Death",
		2869	reply => undef,
		2870	tooltip => "Reason for and more info about your most recent death",
		2871	},
		2872	"c/say" => $SAY_CHANNEL,
		2873	"c/chat" => $CHAT_CHANNEL,
		2874	);
		2875
		2876	sub cf::client::send_msg {
		2877	my ($self, $channel, $msg, $color, @extra) = @_;
		2878
		2879	$msg = $self->pl->expand_cfpod ($msg)
		2880	unless $color & cf::NDI_VERBATIM;
		2881
		2882	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2883
		2884	# check predefined channels, for the benefit of C
		2885	if ($CHANNEL{$channel}) {
		2886	$channel = $CHANNEL{$channel};
		2887
		2888	$self->ext_msg (channel_info => $channel);
		2889	$channel = $channel->{id};
		2890
		2891	} elsif (ref $channel) {
		2892	# send meta info to client, if not yet sent
		2893	unless (exists $self->{channel}{$channel->{id}}) {
		2894	$self->{channel}{$channel->{id}} = $channel;
		2895	$self->ext_msg (channel_info => $channel);
		2896	}
		2897
		2898	$channel = $channel->{id};
		2899	}
		2900
		2901	return unless @extra || length $msg;
		2902
		2903	# default colour, mask it out
		2904	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2905	if $color & cf::NDI_DEF;
		2906
		2907	my $pkt = "msg "
		2908	. $self->{json_coder}->encode (
		2909	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
		2910	);
		2911
		2912	# try lzf for large packets
		2913	$pkt = "lzf " . Compress::LZF::compress $pkt
		2914	if 1024 <= length $pkt and $self->{can_lzf};
		2915
		2916	# split very large packets
		2917	if (8192 < length $pkt and $self->{can_lzf}) {
		2918	$self->send_packet ("frag $_") for unpack "(a8192)*", $pkt;
		2919	$pkt = "frag";
		2920	}
		2921
		2922	$self->send_packet ($pkt);
		2923	}
		2924
		2925	=item $client->ext_msg ($type, @msg)
		2926
		2927	Sends an ext event to the client.
		2928
		2929	=cut
		2930
		2931	sub cf::client::ext_msg($$@) {
		2932	my ($self, $type, @msg) = @_;
		2933
		2934	if ($self->extcmd == 2) {
		2935	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2936	} elsif ($self->extcmd == 1) { # TODO: remove
		2937	push @msg, msgtype => "event_$type";
		2938	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2939	}
		2940	}
		2941
		2942	=item $client->ext_reply ($msgid, @msg)
		2943
		2944	Sends an ext reply to the client.
		2945
		2946	=cut
		2947
		2948	sub cf::client::ext_reply($$@) {
		2949	my ($self, $id, @msg) = @_;
		2950
		2951	if ($self->extcmd == 2) {
		2952	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2953	} elsif ($self->extcmd == 1) {
		2954	#TODO: version 1, remove
		2955	unshift @msg, msgtype => "reply", msgid => $id;
		2956	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2957	}
		2958	}
1531		2959
1532	=item $success = $client->query ($flags, "text", \&cb)	2960	=item $success = $client->query ($flags, "text", \&cb)
1533		2961
1534	Queues a query to the client, calling the given callback with	2962	Queues a query to the client, calling the given callback with
1535	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2963	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1536	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2964	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1537		2965
1538	Queries can fail, so check the return code. Or don't, as queries will become	2966	Queries can fail, so check the return code. Or don't, as queries will
1539	reliable at some point in the future.	2967	become reliable at some point in the future.
1540		2968
1541	=cut	2969	=cut
1542		2970
1543	sub cf::client::query {	2971	sub cf::client::query {
1544	my ($self, $flags, $text, $cb) = @_;	2972	my ($self, $flags, $text, $cb) = @_;
…		…
1552	utf8::encode $text;	2980	utf8::encode $text;
1553	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2981	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1554		2982
1555	$self->send_packet ($self->{query_queue}[0][0])	2983	$self->send_packet ($self->{query_queue}[0][0])
1556	if @{ $self->{query_queue} } == 1;	2984	if @{ $self->{query_queue} } == 1;
		2985
		2986	1
1557	}	2987	}
1558		2988
1559	cf::client->attach (	2989	cf::client->attach (
		2990	on_connect => sub {
		2991	my ($ns) = @_;
		2992
		2993	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2994	},
1560	on_reply => sub {	2995	on_reply => sub {
1561	my ($ns, $msg) = @_;	2996	my ($ns, $msg) = @_;
1562		2997
1563	# this weird shuffling is so that direct followup queries	2998	# this weird shuffling is so that direct followup queries
1564	# get handled first	2999	# get handled first
1565	my $queue = delete $ns->{query_queue};	3000	my $queue = delete $ns->{query_queue}
		3001	or return; # be conservative, not sure how that can happen, but we saw a crash here
1566		3002
1567	(shift @$queue)->[1]->($msg);	3003	(shift @$queue)->[1]->($msg);
		3004	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1568		3005
1569	push @{ $ns->{query_queue} }, @$queue;	3006	push @{ $ns->{query_queue} }, @$queue;
1570		3007
1571	if (@{ $ns->{query_queue} } == @$queue) {	3008	if (@{ $ns->{query_queue} } == @$queue) {
1572	if (@$queue) {	3009	if (@$queue) {
…		…
1574	} else {	3011	} else {
1575	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3012	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1576	}	3013	}
1577	}	3014	}
1578	},	3015	},
		3016	on_exticmd => sub {
		3017	my ($ns, $buf) = @_;
		3018
		3019	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		3020
		3021	if (ref $msg) {
		3022	my ($type, $reply, @payload) =
		3023	"ARRAY" eq ref $msg
		3024	? @$msg
		3025	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		3026
		3027	my @reply;
		3028
		3029	if (my $cb = $EXTICMD{$type}) {
		3030	@reply = $cb->($ns, @payload);
		3031	}
		3032
		3033	$ns->ext_reply ($reply, @reply)
		3034	if $reply;
		3035
		3036	} else {
		3037	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		3038	}
		3039
		3040	cf::override;
		3041	},
1579	);	3042	);
1580		3043
1581	=item $client->coro (\&cb)	3044	=item $client->async (\&cb)
1582		3045
1583	Create a new coroutine, running the specified callback. The coroutine will	3046	Create a new coroutine, running the specified callback. The coroutine will
1584	be automatically cancelled when the client gets destroyed (e.g. on logout,	3047	be automatically cancelled when the client gets destroyed (e.g. on logout,
1585	or loss of connection).	3048	or loss of connection).
1586		3049
1587	=cut	3050	=cut
1588		3051
1589	sub cf::client::coro {	3052	sub cf::client::async {
1590	my ($self, $cb) = @_;	3053	my ($self, $cb) = @_;
1591		3054
1592	my $coro; $coro = async {	3055	my $coro = &Coro::async ($cb);
1593	eval {
1594	$cb->();
1595	};
1596	warn $@ if $@;
1597	};
1598		3056
1599	$coro->on_destroy (sub {	3057	$coro->on_destroy (sub {
1600	delete $self->{_coro}{$coro+0};	3058	delete $self->{_coro}{$coro+0};
1601	});	3059	});
1602		3060
…		…
1629	our $safe = new Safe "safe";	3087	our $safe = new Safe "safe";
1630	our $safe_hole = new Safe::Hole;	3088	our $safe_hole = new Safe::Hole;
1631		3089
1632	$SIG{FPE} = 'IGNORE';	3090	$SIG{FPE} = 'IGNORE';
1633		3091
1634	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3092	$safe->permit_only (Opcode::opset qw(
		3093	:base_core :base_mem :base_orig :base_math
		3094	grepstart grepwhile mapstart mapwhile
		3095	sort time
		3096	));
1635		3097
1636	# here we export the classes and methods available to script code	3098	# here we export the classes and methods available to script code
1637		3099
1638	=pod	3100	=pod
1639		3101
1640	The following fucntions and emthods are available within a safe environment:	3102	The following functions and methods are available within a safe environment:
1641		3103
1642	cf::object contr pay_amount pay_player map	3104	cf::object
		3105	contr pay_amount pay_player map x y force_find force_add destroy
		3106	insert remove name archname title slaying race decrease split
		3107	value
		3108
1643	cf::object::player player	3109	cf::object::player
1644	cf::player peaceful	3110	player
1645	cf::map trigger	3111
		3112	cf::player
		3113	peaceful
		3114
		3115	cf::map
		3116	trigger
1646		3117
1647	=cut	3118	=cut
1648		3119
1649	for (	3120	for (
1650	["cf::object" => qw(contr pay_amount pay_player map)],	3121	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3122	insert remove inv nrof name archname title slaying race
		3123	decrease split destroy change_exp value msg lore send_msg)],
1651	["cf::object::player" => qw(player)],	3124	["cf::object::player" => qw(player)],
1652	["cf::player" => qw(peaceful)],	3125	["cf::player" => qw(peaceful send_msg)],
1653	["cf::map" => qw(trigger)],	3126	["cf::map" => qw(trigger)],
1654	) {	3127	) {
1655	no strict 'refs';	3128	no strict 'refs';
1656	my ($pkg, @funs) = @$_;	3129	my ($pkg, @funs) = @$_;
1657	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3130	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
…		…
1674	my ($code, %vars) = @_;	3147	my ($code, %vars) = @_;
1675		3148
1676	my $qcode = $code;	3149	my $qcode = $code;
1677	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3150	$qcode =~ s/"/‟/g; # not allowed in #line filenames
1678	$qcode =~ s/\n/\\n/g;	3151	$qcode =~ s/\n/\\n/g;
		3152
		3153	%vars = (_dummy => 0) unless %vars;
1679		3154
1680	local $_;	3155	local $_;
1681	local @safe::cf::_safe_eval_args = values %vars;	3156	local @safe::cf::_safe_eval_args = values %vars;
1682		3157
1683	my $eval =	3158	my $eval =
…		…
1726	=back	3201	=back
1727		3202
1728	=cut	3203	=cut
1729		3204
1730	#############################################################################	3205	#############################################################################
		3206	# the server's init and main functions
1731		3207
1732	=head2 EXTENSION DATABASE SUPPORT	3208	sub load_facedata($) {
		3209	my ($path) = @_;
1733		3210
1734	Crossfire maintains a very simple database for extension use. It can	3211	# HACK to clear player env face cache, we need some signal framework
1735	currently store anything that can be serialised using Storable, which	3212	# for this (global event?)
1736	excludes objects.	3213	%ext::player_env::MUSIC_FACE_CACHE = ();
1737		3214
1738	The parameter C<$family> should best start with the name of the extension	3215	my $enc = JSON::XS->new->utf8->canonical->relaxed;
1739	using it, it should be unique.
1740		3216
1741	=over 4	3217	warn "loading facedata from $path\n";
1742		3218
1743	=item $hashref = cf::db_get $family	3219	my $facedata;
		3220	0 < aio_load $path, $facedata
		3221	or die "$path: $!";
1744		3222
1745	Return a hashref for use by the extension C<$family>, which can be	3223	$facedata = Coro::Storable::thaw $facedata;
1746	modified. After modifications, you have to call C<cf::db_dirty> or
1747	C<cf::db_sync>.
1748		3224
1749	=item $value = cf::db_get $family => $key	3225	$facedata->{version} == 2
		3226	or cf::cleanup "$path: version mismatch, cannot proceed.";
1750		3227
1751	Returns a single value from the database	3228	# patch in the exptable
1752		3229	$facedata->{resource}{"res/exp_table"} = {
1753	=item cf::db_put $family => $hashref	3230	type => FT_RSRC,
1754		3231	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1755	Stores the given family hashref into the database. Updates are delayed, if
1756	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1757
1758	=item cf::db_put $family => $key => $value
1759
1760	Stores the given C<$value> in the family hash. Updates are delayed, if you
1761	want the data to be synced to disk immediately, use C<cf::db_sync>.
1762
1763	=item cf::db_dirty
1764
1765	Marks the database as dirty, to be updated at a later time.
1766
1767	=item cf::db_sync
1768
1769	Immediately write the database to disk I<if it is dirty>.
1770
1771	=cut
1772
1773	our $DB;
1774
1775	{
1776	my $path = cf::localdir . "/database.pst";
1777
1778	sub db_load() {
1779	warn "loading database $path\n";#d# remove later
1780	$DB = stat $path ? Storable::retrieve $path : { };
1781	}
1782
1783	my $pid;
1784
1785	sub db_save() {
1786	warn "saving database $path\n";#d# remove later
1787	waitpid $pid, 0 if $pid;
1788	if (0 == ($pid = fork)) {
1789	$DB->{_meta}{version} = 1;
1790	Storable::nstore $DB, "$path~";
1791	rename "$path~", $path;
1792	cf::_exit 0 if defined $pid;
1793	}
1794	}
1795
1796	my $dirty;
1797
1798	sub db_sync() {
1799	db_save if $dirty;
1800	undef $dirty;
1801	}
1802
1803	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1804	db_sync;
1805	});	3232	};
		3233	cf::cede_to_tick;
1806		3234
1807	sub db_dirty() {
1808	$dirty = 1;
1809	$idle->start;
1810	}	3235	{
		3236	my $faces = $facedata->{faceinfo};
1811		3237
1812	sub db_get($;$) {	3238	while (my ($face, $info) = each %$faces) {
1813	@_ >= 2	3239	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1814	? $DB->{$_[0]}{$_[1]}
1815	: ($DB->{$_[0]} ||= { })
1816	}
1817		3240
1818	sub db_put($$;$) {	3241	cf::face::set_visibility $idx, $info->{visibility};
1819	if (@_ >= 3) {	3242	cf::face::set_magicmap $idx, $info->{magicmap};
1820	$DB->{$_[0]}{$_[1]} = $_[2];	3243	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
1821	} else {	3244	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1822	$DB->{$_[0]} = $_[1];
1823	}
1824	db_dirty;
1825	}
1826		3245
1827	cf::global->attach (	3246	cf::cede_to_tick;
1828	prio => 10000,
1829	on_cleanup => sub {
1830	db_sync;
1831	},	3247	}
1832	);
1833	}
1834		3248
1835	#############################################################################	3249	while (my ($face, $info) = each %$faces) {
1836	# the server's main()	3250	next unless $info->{smooth};
1837		3251
1838	sub cfg_load {	3252	my $idx = cf::face::find $face
		3253	or next;
		3254
		3255	if (my $smooth = cf::face::find $info->{smooth}) {
		3256	cf::face::set_smooth $idx, $smooth;
		3257	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3258	} else {
		3259	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3260	}
		3261
		3262	cf::cede_to_tick;
		3263	}
		3264	}
		3265
		3266	{
		3267	my $anims = $facedata->{animinfo};
		3268
		3269	while (my ($anim, $info) = each %$anims) {
		3270	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3271	cf::cede_to_tick;
		3272	}
		3273
		3274	cf::anim::invalidate_all; # d'oh
		3275	}
		3276
		3277	{
		3278	# TODO: for gcfclient pleasure, we should give resources
		3279	# that gcfclient doesn't grok a >10000 face index.
		3280	my $res = $facedata->{resource};
		3281
		3282	while (my ($name, $info) = each %$res) {
		3283	if (defined $info->{type}) {
		3284	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3285	my $data;
		3286
		3287	if ($info->{type} & 1) {
		3288	# prepend meta info
		3289
		3290	my $meta = $enc->encode ({
		3291	name => $name,
		3292	%{ $info->{meta} || {} },
		3293	});
		3294
		3295	$data = pack "(w/a*)*", $meta, $info->{data};
		3296	} else {
		3297	$data = $info->{data};
		3298	}
		3299
		3300	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3301	cf::face::set_type $idx, $info->{type};
		3302	} else {
		3303	$RESOURCE{$name} = $info;
		3304	}
		3305
		3306	cf::cede_to_tick;
		3307	}
		3308	}
		3309
		3310	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3311
		3312	1
		3313	}
		3314
		3315	cf::global->attach (on_resource_update => sub {
		3316	if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
		3317	$soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
		3318
		3319	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3320	my $sound = $soundconf->{compat}[$_]
		3321	or next;
		3322
		3323	my $face = cf::face::find "sound/$sound->[1]";
		3324	cf::sound::set $sound->[0] => $face;
		3325	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3326	}
		3327
		3328	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3329	my $face = cf::face::find "sound/$v";
		3330	cf::sound::set $k => $face;
		3331	}
		3332	}
		3333	});
		3334
		3335	register_exticmd fx_want => sub {
		3336	my ($ns, $want) = @_;
		3337
		3338	while (my ($k, $v) = each %$want) {
		3339	$ns->fx_want ($k, $v);
		3340	}
		3341	};
		3342
		3343	sub load_resource_file($) {
		3344	my $guard = lock_acquire "load_resource_file";
		3345
		3346	my $status = load_resource_file_ $_[0];
		3347	get_slot 0.1, 100;
		3348	cf::arch::commit_load;
		3349
		3350	$status
		3351	}
		3352
		3353	sub reload_regions {
		3354	# HACK to clear player env face cache, we need some signal framework
		3355	# for this (global event?)
		3356	%ext::player_env::MUSIC_FACE_CACHE = ();
		3357
		3358	load_resource_file "$MAPDIR/regions"
		3359	or die "unable to load regions file\n";
		3360
		3361	for (cf::region::list) {
		3362	$_->{match} = qr/$_->{match}/
		3363	if exists $_->{match};
		3364	}
		3365	}
		3366
		3367	sub reload_facedata {
		3368	load_facedata "$DATADIR/facedata"
		3369	or die "unable to load facedata\n";
		3370	}
		3371
		3372	sub reload_archetypes {
		3373	load_resource_file "$DATADIR/archetypes"
		3374	or die "unable to load archetypes\n";
		3375	}
		3376
		3377	sub reload_treasures {
		3378	load_resource_file "$DATADIR/treasures"
		3379	or die "unable to load treasurelists\n";
		3380	}
		3381
		3382	sub reload_resources {
		3383	warn "reloading resource files...\n";
		3384
		3385	reload_facedata;
		3386	reload_archetypes;
		3387	reload_regions;
		3388	reload_treasures;
		3389
		3390	warn "finished reloading resource files\n";
		3391	}
		3392
		3393	sub reload_config {
		3394	warn "reloading config file...\n";
		3395
1839	open my $fh, "<:utf8", cf::confdir . "/config"	3396	open my $fh, "<:utf8", "$CONFDIR/config"
1840	or return;	3397	or return;
1841		3398
1842	local $/;	3399	local $/;
1843	*CFG = YAML::Syck::Load <$fh>;	3400	*CFG = YAML::XS::Load scalar <$fh>;
		3401
		3402	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		3403
		3404	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		3405	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		3406
		3407	if (exists $CFG{mlockall}) {
		3408	eval {
		3409	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		3410	and die "WARNING: m(un)lockall failed: $!\n";
		3411	};
		3412	warn $@ if $@;
		3413	}
		3414
		3415	warn "finished reloading resource files\n";
		3416	}
		3417
		3418	sub pidfile() {
		3419	sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
		3420	or die "$PIDFILE: $!";
		3421	flock $fh, &Fcntl::LOCK_EX
		3422	or die "$PIDFILE: flock: $!";
		3423	$fh
		3424	}
		3425
		3426	# make sure only one server instance is running at any one time
		3427	sub atomic {
		3428	my $fh = pidfile;
		3429
		3430	my $pid = <$fh>;
		3431	kill 9, $pid if $pid > 0;
		3432
		3433	seek $fh, 0, 0;
		3434	print $fh $$;
		3435	}
		3436
		3437	sub main_loop {
		3438	warn "EV::loop starting\n";
		3439	if (1) {
		3440	EV::loop;
		3441	}
		3442	warn "EV::loop returned\n";
		3443	goto &main_loop unless $REALLY_UNLOOP;
1844	}	3444	}
1845		3445
1846	sub main {	3446	sub main {
		3447	cf::init_globals; # initialise logging
		3448
		3449	LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
		3450	LOG llevInfo, "Copyright (C) 2005-2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
		3451	LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
		3452	LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
		3453
		3454	cf::init_experience;
		3455	cf::init_anim;
		3456	cf::init_attackmess;
		3457	cf::init_dynamic;
		3458
		3459	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3460
1847	# we must not ever block the main coroutine	3461	# we must not ever block the main coroutine
1848	local $Coro::idle = sub {	3462	local $Coro::idle = sub {
1849	Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#	3463	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1850	(Coro::unblock_sub {	3464	(async {
1851	Event::one_event;	3465	$Coro::current->{desc} = "IDLE BUG HANDLER";
1852	})->();	3466	EV::loop EV::LOOP_ONESHOT;
		3467	})->prio (Coro::PRIO_MAX);
1853	};	3468	};
1854		3469
1855	cfg_load;	3470	evthread_start IO::AIO::poll_fileno;
1856	db_load;	3471
		3472	cf::sync_job {
		3473	reload_resources;
		3474	reload_config;
		3475	db_init;
		3476
		3477	cf::load_settings;
		3478	cf::load_materials;
		3479	cf::init_uuid;
		3480	cf::init_signals;
		3481	cf::init_commands;
		3482	cf::init_skills;
		3483
		3484	cf::init_beforeplay;
		3485
		3486	atomic;
		3487
1857	load_extensions;	3488	load_extensions;
1858	Event::loop;	3489
		3490	utime time, time, $RUNTIMEFILE;
		3491
		3492	# no (long-running) fork's whatsoever before this point(!)
		3493	use POSIX ();
		3494	POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
		3495
		3496	(pop @POST_INIT)->(0) while @POST_INIT;
		3497	};
		3498
		3499	main_loop;
1859	}	3500	}
1860		3501
1861	#############################################################################	3502	#############################################################################
1862	# initialisation	3503	# initialisation and cleanup
1863		3504
		3505	# install some emergency cleanup handlers
		3506	BEGIN {
		3507	our %SIGWATCHER = ();
		3508	for my $signal (qw(INT HUP TERM)) {
		3509	$SIGWATCHER{$signal} = EV::signal $signal, sub {
		3510	cf::cleanup "SIG$signal";
		3511	};
		3512	}
		3513	}
		3514
		3515	sub write_runtime_sync {
		3516	# first touch the runtime file to show we are still running:
		3517	# the fsync below can take a very very long time.
		3518
		3519	IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
		3520
		3521	my $guard = cf::lock_acquire "write_runtime";
		3522
		3523	my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT, 0644
		3524	or return;
		3525
		3526	my $value = $cf::RUNTIME + 90 + 10;
		3527	# 10 is the runtime save interval, for a monotonic clock
		3528	# 60 allows for the watchdog to kill the server.
		3529
		3530	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3531	and return;
		3532
		3533	# always fsync - this file is important
		3534	aio_fsync $fh
		3535	and return;
		3536
		3537	# touch it again to show we are up-to-date
		3538	aio_utime $fh, undef, undef;
		3539
		3540	close $fh
		3541	or return;
		3542
		3543	aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
		3544	and return;
		3545
		3546	warn "runtime file written.\n";
		3547
		3548	1
		3549	}
		3550
		3551	our $uuid_lock;
		3552	our $uuid_skip;
		3553
		3554	sub write_uuid_sync($) {
		3555	$uuid_skip ||= $_[0];
		3556
		3557	return if $uuid_lock;
		3558	local $uuid_lock = 1;
		3559
		3560	my $uuid = "$LOCALDIR/uuid";
		3561
		3562	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3563	or return;
		3564
		3565	my $value = uuid_seq uuid_cur;
		3566
		3567	unless ($value) {
		3568	warn "cowardly refusing to write zero uuid value!\n";
		3569	return;
		3570	}
		3571
		3572	my $value = uuid_str $value + $uuid_skip;
		3573	$uuid_skip = 0;
		3574
		3575	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3576	and return;
		3577
		3578	# always fsync - this file is important
		3579	aio_fsync $fh
		3580	and return;
		3581
		3582	close $fh
		3583	or return;
		3584
		3585	aio_rename "$uuid~", $uuid
		3586	and return;
		3587
		3588	warn "uuid file written ($value).\n";
		3589
		3590	1
		3591
		3592	}
		3593
		3594	sub write_uuid($$) {
		3595	my ($skip, $sync) = @_;
		3596
		3597	$sync ? write_uuid_sync $skip
		3598	: async { write_uuid_sync $skip };
		3599	}
		3600
		3601	sub emergency_save() {
		3602	my $freeze_guard = cf::freeze_mainloop;
		3603
		3604	warn "emergency_perl_save: enter\n";
		3605
		3606	cf::sync_job {
		3607	# this is a trade-off: we want to be very quick here, so
		3608	# save all maps without fsync, and later call a global sync
		3609	# (which in turn might be very very slow)
		3610	local $USE_FSYNC = 0;
		3611
		3612	# use a peculiar iteration method to avoid tripping on perl
		3613	# refcount bugs in for. also avoids problems with players
		3614	# and maps saved/destroyed asynchronously.
		3615	warn "emergency_perl_save: begin player save\n";
		3616	for my $login (keys %cf::PLAYER) {
		3617	my $pl = $cf::PLAYER{$login} or next;
		3618	$pl->valid or next;
		3619	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
		3620	$pl->save;
		3621	}
		3622	warn "emergency_perl_save: end player save\n";
		3623
		3624	warn "emergency_perl_save: begin map save\n";
		3625	for my $path (keys %cf::MAP) {
		3626	my $map = $cf::MAP{$path} or next;
		3627	$map->valid or next;
		3628	$map->save;
		3629	}
		3630	warn "emergency_perl_save: end map save\n";
		3631
		3632	warn "emergency_perl_save: begin database checkpoint\n";
		3633	BDB::db_env_txn_checkpoint $DB_ENV;
		3634	warn "emergency_perl_save: end database checkpoint\n";
		3635
		3636	warn "emergency_perl_save: begin write uuid\n";
		3637	write_uuid_sync 1;
		3638	warn "emergency_perl_save: end write uuid\n";
		3639	};
		3640
		3641	warn "emergency_perl_save: starting sync()\n";
		3642	IO::AIO::aio_sync sub {
		3643	warn "emergency_perl_save: finished sync()\n";
		3644	};
		3645
		3646	warn "emergency_perl_save: leave\n";
		3647	}
		3648
		3649	sub post_cleanup {
		3650	my ($make_core) = @_;
		3651
		3652	warn Carp::longmess "post_cleanup backtrace"
		3653	if $make_core;
		3654
		3655	my $fh = pidfile;
		3656	unlink $PIDFILE if <$fh> == $$;
		3657	}
		3658
		3659	# a safer delete_package, copied from Symbol
		3660	sub clear_package($) {
		3661	my $pkg = shift;
		3662
		3663	# expand to full symbol table name if needed
		3664	unless ($pkg =~ /^main::.*::$/) {
		3665	$pkg = "main$pkg" if $pkg =~ /^::/;
		3666	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		3667	$pkg .= '::' unless $pkg =~ /::$/;
		3668	}
		3669
		3670	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		3671	my $stem_symtab = *{$stem}{HASH};
		3672
		3673	defined $stem_symtab and exists $stem_symtab->{$leaf}
		3674	or return;
		3675
		3676	# clear all symbols
		3677	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		3678	for my $name (keys %$leaf_symtab) {
		3679	_gv_clear *{"$pkg$name"};
		3680	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		3681	}
		3682	warn "cleared package $pkg\n";#d#
		3683	}
		3684
1864	sub reload() {	3685	sub do_reload_perl() {
1865	# can/must only be called in main	3686	# can/must only be called in main
1866	if ($Coro::current != $Coro::main) {	3687	if ($Coro::current != $Coro::main) {
1867	warn "can only reload from main coroutine\n";	3688	warn "can only reload from main coroutine";
1868	return;	3689	return;
1869	}	3690	}
1870		3691
		3692	return if $RELOAD++;
		3693
		3694	my $t1 = EV::time;
		3695
		3696	while ($RELOAD) {
1871	warn "reloading...";	3697	warn "reloading...";
1872		3698
1873	local $FREEZE = 1;	3699	warn "entering sync_job";
		3700
		3701	cf::sync_job {
		3702	cf::write_runtime_sync; # external watchdog should not bark
1874	cf::emergency_save;	3703	cf::emergency_save;
		3704	cf::write_runtime_sync; # external watchdog should not bark
1875		3705
1876	eval {	3706	warn "syncing database to disk";
		3707	BDB::db_env_txn_checkpoint $DB_ENV;
		3708
1877	# if anything goes wrong in here, we should simply crash as we already saved	3709	# if anything goes wrong in here, we should simply crash as we already saved
1878		3710
1879	# cancel all watchers	3711	warn "flushing outstanding aio requests";
1880	for (Event::all_watchers) {	3712	while (IO::AIO::nreqs || BDB::nreqs) {
1881	$_->cancel if $_->data & WF_AUTOCANCEL;	3713	Coro::EV::timer_once 0.01; # let the sync_job do it's thing
1882	}
1883
1884	# cancel all extension coros
1885	$_->cancel for values %EXT_CORO;
1886	%EXT_CORO = ();
1887
1888	# unload all extensions
1889	for (@exts) {
1890	warn "unloading <$_>";
1891	unload_extension $_;
1892	}
1893
1894	# unload all modules loaded from $LIBDIR
1895	while (my ($k, $v) = each %INC) {
1896	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1897
1898	warn "removing <$k>";
1899	delete $INC{$k};
1900
1901	$k =~ s/\.pm$//;
1902	$k =~ s/\//::/g;
1903
1904	if (my $cb = $k->can ("unload_module")) {
1905	$cb->();
1906	}	3714	}
1907		3715
1908	Symbol::delete_package $k;	3716	warn "cancelling all extension coros";
		3717	$_->cancel for values %EXT_CORO;
		3718	%EXT_CORO = ();
		3719
		3720	warn "removing commands";
		3721	%COMMAND = ();
		3722
		3723	warn "removing ext/exti commands";
		3724	%EXTCMD = ();
		3725	%EXTICMD = ();
		3726
		3727	warn "unloading/nuking all extensions";
		3728	for my $pkg (@EXTS) {
		3729	warn "... unloading $pkg";
		3730
		3731	if (my $cb = $pkg->can ("unload")) {
		3732	eval {
		3733	$cb->($pkg);
		3734	1
		3735	} or warn "$pkg unloaded, but with errors: $@";
		3736	}
		3737
		3738	warn "... clearing $pkg";
		3739	clear_package $pkg;
1909	}	3740	}
1910		3741
1911	# sync database to disk	3742	warn "unloading all perl modules loaded from $LIBDIR";
1912	cf::db_sync;	3743	while (my ($k, $v) = each %INC) {
1913	IO::AIO::flush;	3744	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1914		3745
		3746	warn "... unloading $k";
		3747	delete $INC{$k};
		3748
		3749	$k =~ s/\.pm$//;
		3750	$k =~ s/\//::/g;
		3751
		3752	if (my $cb = $k->can ("unload_module")) {
		3753	$cb->();
		3754	}
		3755
		3756	clear_package $k;
		3757	}
		3758
1915	# get rid of safe::, as good as possible	3759	warn "getting rid of safe::, as good as possible";
1916	Symbol::delete_package "safe::$_"	3760	clear_package "safe::$_"
1917	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3761	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1918		3762
1919	# remove register_script_function callbacks	3763	warn "unloading cf.pm \"a bit\"";
1920	# TODO
1921
1922	# unload cf.pm "a bit"
1923	delete $INC{"cf.pm"};	3764	delete $INC{"cf.pm"};
		3765	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
1924		3766
1925	# don't, removes xs symbols, too,	3767	# don't, removes xs symbols, too,
1926	# and global variables created in xs	3768	# and global variables created in xs
1927	#Symbol::delete_package __PACKAGE__;	3769	#clear_package __PACKAGE__;
1928		3770
1929	# reload cf.pm	3771	warn "unload completed, starting to reload now";
		3772
1930	warn "reloading cf.pm";	3773	warn "reloading cf.pm";
1931	require cf;	3774	require cf;
1932	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3775	cf::_connect_to_perl_1;
1933		3776
1934	# load config and database again	3777	warn "loading config and database again";
1935	cf::cfg_load;	3778	cf::reload_config;
1936	cf::db_load;
1937		3779
1938	# load extensions
1939	warn "load extensions";	3780	warn "loading extensions";
1940	cf::load_extensions;	3781	cf::load_extensions;
1941		3782
1942	# reattach attachments to objects	3783	if ($REATTACH_ON_RELOAD) {
		3784	warn "reattaching attachments to objects/players";
		3785	_global_reattach; # objects, sockets
		3786	warn "reattaching attachments to maps";
		3787	reattach $_ for values %MAP;
		3788	warn "reattaching attachments to players";
		3789	reattach $_ for values %PLAYER;
		3790	}
		3791
		3792	warn "running post_init jobs";
		3793	(pop @POST_INIT)->(1) while @POST_INIT;
		3794
		3795	warn "leaving sync_job";
		3796
		3797	1
		3798	} or do {
		3799	warn $@;
		3800	cf::cleanup "error while reloading, exiting.";
		3801	};
		3802
1943	warn "reattach";	3803	warn "reloaded";
1944	_global_reattach;	3804	--$RELOAD;
		3805	}
		3806
		3807	$t1 = EV::time - $t1;
		3808	warn "reload completed in ${t1}s\n";
		3809	};
		3810
		3811	our $RELOAD_WATCHER; # used only during reload
		3812
		3813	sub reload_perl() {
		3814	# doing reload synchronously and two reloads happen back-to-back,
		3815	# coro crashes during coro_state_free->destroy here.
		3816
		3817	$RELOAD_WATCHER ||= cf::async {
		3818	Coro::AIO::aio_wait cache_extensions;
		3819
		3820	$RELOAD_WATCHER = EV::timer $TICK * 1.5, 0, sub {
		3821	do_reload_perl;
		3822	undef $RELOAD_WATCHER;
		3823	};
1945	};	3824	};
1946
1947	if ($@) {
1948	warn $@;
1949	warn "error while reloading, exiting.";
1950	exit 1;
1951	}
1952
1953	warn "reloaded successfully";
1954	};
1955
1956	#############################################################################
1957
1958	unless ($LINK_MAP) {
1959	$LINK_MAP = cf::map::new;
1960
1961	$LINK_MAP->width (41);
1962	$LINK_MAP->height (41);
1963	$LINK_MAP->alloc;
1964	$LINK_MAP->path ("{link}");
1965	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
1966	$LINK_MAP->in_memory (MAP_IN_MEMORY);
1967
1968	# dirty hack because... archetypes are not yet loaded
1969	Event->timer (
1970	after => 2,
1971	cb => sub {
1972	$_[0]->w->cancel;
1973
1974	# provide some exits "home"
1975	my $exit = cf::object::new "exit";
1976
1977	$exit->slaying ($EMERGENCY_POSITION->[0]);
1978	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
1979	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
1980
1981	$LINK_MAP->insert ($exit->clone, 19, 19);
1982	$LINK_MAP->insert ($exit->clone, 19, 20);
1983	$LINK_MAP->insert ($exit->clone, 19, 21);
1984	$LINK_MAP->insert ($exit->clone, 20, 19);
1985	$LINK_MAP->insert ($exit->clone, 20, 21);
1986	$LINK_MAP->insert ($exit->clone, 21, 19);
1987	$LINK_MAP->insert ($exit->clone, 21, 20);
1988	$LINK_MAP->insert ($exit->clone, 21, 21);
1989
1990	$exit->destroy;
1991	});
1992
1993	$LINK_MAP->{deny_save} = 1;
1994	$LINK_MAP->{deny_reset} = 1;
1995
1996	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
1997	}	3825	}
1998
1999	register "<global>", __PACKAGE__;
2000		3826
2001	register_command "reload" => sub {	3827	register_command "reload" => sub {
2002	my ($who, $arg) = @_;	3828	my ($who, $arg) = @_;
2003		3829
2004	if ($who->flag (FLAG_WIZ)) {	3830	if ($who->flag (FLAG_WIZ)) {
2005	$who->message ("start of reload.");
2006	reload;
2007	$who->message ("end of reload.");	3831	$who->message ("reloading server.");
		3832	async {
		3833	$Coro::current->{desc} = "perl_reload";
		3834	reload_perl;
		3835	};
2008	}	3836	}
2009	};	3837	};
2010		3838
2011	unshift @INC, $LIBDIR;	3839	unshift @INC, $LIBDIR;
2012		3840
2013	$TICK_WATCHER = Event->timer (	3841	my $bug_warning = 0;
2014	reentrant => 0,	3842
2015	prio => 0,	3843	our @WAIT_FOR_TICK;
2016	at => $NEXT_TICK || $TICK,	3844	our @WAIT_FOR_TICK_BEGIN;
2017	data => WF_AUTOCANCEL,	3845
2018	cb => sub {	3846	sub wait_for_tick {
2019	unless ($FREEZE) {	3847	return if tick_inhibit || $Coro::current == $Coro::main;
		3848
		3849	my $signal = new Coro::Signal;
		3850	push @WAIT_FOR_TICK, $signal;
		3851	$signal->wait;
		3852	}
		3853
		3854	sub wait_for_tick_begin {
		3855	return if tick_inhibit || $Coro::current == $Coro::main;
		3856
		3857	my $signal = new Coro::Signal;
		3858	push @WAIT_FOR_TICK_BEGIN, $signal;
		3859	$signal->wait;
		3860	}
		3861
		3862	sub tick {
		3863	if ($Coro::current != $Coro::main) {
		3864	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3865	unless ++$bug_warning > 10;
		3866	return;
		3867	}
		3868
2020	cf::server_tick; # one server iteration	3869	cf::server_tick; # one server iteration
2021	$RUNTIME += $TICK;
2022	}
2023		3870
2024	$NEXT_TICK += $TICK;	3871	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2025		3872	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2026	# if we are delayed by four ticks or more, skip them all	3873	Coro::async_pool {
2027	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3874	$Coro::current->{desc} = "runtime saver";
2028
2029	$TICK_WATCHER->at ($NEXT_TICK);
2030	$TICK_WATCHER->start;
2031	},
2032	);
2033
2034	IO::AIO::max_poll_time $TICK * 0.2;
2035
2036	Event->io (
2037	fd => IO::AIO::poll_fileno,
2038	poll => 'r',
2039	prio => 5,
2040	data => WF_AUTOCANCEL,
2041	cb => \&IO::AIO::poll_cb,
2042	);
2043
2044	Event->timer (
2045	data => WF_AUTOCANCEL,
2046	after => 0,
2047	interval => 10,
2048	cb => sub {
2049	(Coro::unblock_sub {
2050	write_runtime	3875	write_runtime_sync
2051	or warn "ERROR: unable to write runtime file: $!";	3876	or warn "ERROR: unable to write runtime file: $!";
2052	})->();	3877	};
2053	},	3878	}
2054	);	3879
		3880	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3881	$sig->send;
		3882	}
		3883	while (my $sig = shift @WAIT_FOR_TICK) {
		3884	$sig->send;
		3885	}
		3886
		3887	$LOAD = ($NOW - $TICK_START) / $TICK;
		3888	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3889
		3890	if (0) {
		3891	if ($NEXT_TICK) {
		3892	my $jitter = $TICK_START - $NEXT_TICK;
		3893	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		3894	warn "jitter $JITTER\n";#d#
		3895	}
		3896	}
		3897	}
		3898
		3899	{
		3900	# configure BDB
		3901
		3902	BDB::min_parallel 8;
		3903	BDB::max_poll_reqs $TICK * 0.1;
		3904	$AnyEvent::BDB::WATCHER->priority (1);
		3905
		3906	unless ($DB_ENV) {
		3907	$DB_ENV = BDB::db_env_create;
		3908	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		3909	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		3910	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		3911	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3912	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3913
		3914	cf::sync_job {
		3915	eval {
		3916	BDB::db_env_open
		3917	$DB_ENV,
		3918	$BDBDIR,
		3919	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3920	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3921	0666;
		3922
		3923	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3924	};
		3925
		3926	cf::cleanup "db_env_open(db): $@" if $@;
		3927	};
		3928	}
		3929
		3930	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3931	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3932	};
		3933	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		3934	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3935	};
		3936	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3937	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3938	};
		3939	}
		3940
		3941	{
		3942	# configure IO::AIO
		3943
		3944	IO::AIO::min_parallel 8;
		3945	IO::AIO::max_poll_time $TICK * 0.1;
		3946	undef $AnyEvent::AIO::WATCHER;
		3947	}
		3948
		3949	my $_log_backtrace;
		3950
		3951	sub _log_backtrace {
		3952	my ($msg, @addr) = @_;
		3953
		3954	$msg =~ s/\n//;
		3955
		3956	# limit the # of concurrent backtraces
		3957	if ($_log_backtrace < 2) {
		3958	++$_log_backtrace;
		3959	my $perl_bt = Carp::longmess $msg;
		3960	async {
		3961	$Coro::current->{desc} = "abt $msg";
		3962
		3963	my @bt = fork_call {
		3964	@addr = map { sprintf "%x", $_ } @addr;
		3965	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3966	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3967	or die "addr2line: $!";
		3968
		3969	my @funcs;
		3970	my @res = <$fh>;
		3971	chomp for @res;
		3972	while (@res) {
		3973	my ($func, $line) = splice @res, 0, 2, ();
		3974	push @funcs, "[$func] $line";
		3975	}
		3976
		3977	@funcs
		3978	};
		3979
		3980	LOG llevInfo, "[ABT] $perl_bt\n";
		3981	LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
		3982	LOG llevInfo, "[ABT] $_\n" for @bt;
		3983	--$_log_backtrace;
		3984	};
		3985	} else {
		3986	LOG llevInfo, "[ABT] $msg\n";
		3987	LOG llevInfo, "[ABT] [suppressed]\n";
		3988	}
		3989	}
		3990
		3991	# load additional modules
		3992	require "cf/$_.pm" for @EXTRA_MODULES;
		3993	cf::_connect_to_perl_2;
		3994
		3995	END { cf::emergency_save }
2055		3996
2056	1	3997	1
2057		3998

Diff Legend

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