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.110 by root, Mon Jan 1 11:21:55 2007 UTC vs.
Revision 1.484 by root, Mon Oct 12 14:00:58 2009 UTC

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

Diff Legend

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