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

Diff Legend

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