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

Diff Legend

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