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

Diff Legend

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