ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

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

Diff Legend

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