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.113 by root, Mon Jan 1 15:32:40 2007 UTC vs.
Revision 1.461 by root, Fri Dec 19 22:47:29 2008 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	if ($path =~ s{^\?random/}{}) {
295	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
296	$self->{random} = cf::from_json $data;
297	} else {
298	if ($path =~ s{^~([^/]+)?}{}) {
299	$self->{user_rel} = 1;
300
301	if (defined $1) {
302	$self->{user} = $1;
303	} elsif ($base =~ m{^~([^/]+)/}) {
304	$self->{user} = $1;
305	} else {
306	warn "cannot resolve user-relative path without user <$path,$base>\n";
307	}
308	} elsif ($path =~ /^\//) {
309	# already absolute
310	} else {
311	$base =~ s{[^/]+/?$}{};
312	return $class->new ("$base/$path");
313	}
314
315	for ($path) {
316	redo if s{/\.?/}{/};
317	redo if s{/[^/]+/\.\./}{/};
318	}
319	}
320
321	$self->{path} = $path;
322
323	$self
324	}
325
326	# the name / primary key / in-game path
327	sub as_string {
328	my ($self) = @_;
329
330	$self->{user_rel} ? "~$self->{user}$self->{path}"
331	: $self->{random} ? "?random/$self->{path}"
332	: $self->{path}
333	}
334
335	# the displayed name, this is a one way mapping
336	sub visible_name {
337	my ($self) = @_;
338
339	# if (my $rmp = $self->{random}) {
340	# # todo: be more intelligent about this
341	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
342	# } else {
343	$self->as_string
344	# }
345	}
346
347	# escape the /'s in the path
348	sub _escaped_path {
349	# ∕ is U+2215
350	(my $path = $_[0]{path}) =~ s/\//∕/g;
351	$path
352	}
353
354	# the original (read-only) location
355	sub load_path {
356	my ($self) = @_;
357
358	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
359	}
360
361	# the temporary/swap location
362	sub save_path {
363	my ($self) = @_;
364
365	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
366	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
367	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
368	}
369
370	# the unique path, might be eq to save_path
371	sub uniq_path {
372	my ($self) = @_;
373
374	$self->{user_rel} || $self->{random}
375	? undef
376	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
377	}
378
379	# return random map parameters, or undef
380	sub random_map_params {
381	my ($self) = @_;
382
383	$self->{random}
384	}
385
386	# this is somewhat ugly, but style maps do need special treatment
387	sub is_style_map {
388	$_[0]{path} =~ m{^/styles/}
389	}
390
391	package cf;
392
393	#############################################################################
394
395	=head2 ATTACHABLE OBJECTS	730	=head2 ATTACHABLE OBJECTS
396		731
397	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
398	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")
399	to it. All such attachable objects support the following methods.	734	to it. All such attachable objects support the following methods.
400		735
401	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>
402	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
403	crossfire+).	738	Deliantra).
404		739
405	=over 4	740	=over 4
406		741
407	=item $attachable->attach ($attachment, key => $value...)	742	=item $attachable->attach ($attachment, key => $value...)
408		743
…		…
452	=item cf::CLASS::attachment $name, ...	787	=item cf::CLASS::attachment $name, ...
453		788
454	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
455	given CLASS can refer to this attachment.	790	given CLASS can refer to this attachment.
456		791
457	Some classes such as crossfire maps and objects can specify attachments	792	Some classes such as deliantra maps and objects can specify attachments
458	that are attached at load/instantiate time, thus the need for a name.	793	that are attached at load/instantiate time, thus the need for a name.
459		794
460	These calls expect any number of the following handler/hook descriptions:	795	These calls expect any number of the following handler/hook descriptions:
461		796
462	=over 4	797	=over 4
…		…
522	our @CB_TYPE = (); # registry for type (cf-object class) based events	857	our @CB_TYPE = (); # registry for type (cf-object class) based events
523	our @CB_MAP = ();	858	our @CB_MAP = ();
524		859
525	my %attachment;	860	my %attachment;
526		861
		862	sub cf::attachable::thawer_merge {
		863	# simply override everything except _meta
		864	local $_[0]{_meta};
		865	%{$_[0]} = %{$_[1]};
		866	}
		867
527	sub _attach_cb($$$$) {	868	sub _attach_cb($$$$) {
528	my ($registry, $event, $prio, $cb) = @_;	869	my ($registry, $event, $prio, $cb) = @_;
529		870
530	use sort 'stable';	871	use sort 'stable';
531		872
…		…
565	$registry = $CB_TYPE[$object_type] ||= [];	906	$registry = $CB_TYPE[$object_type] ||= [];
566		907
567	} elsif ($type eq "subtype") {	908	} elsif ($type eq "subtype") {
568	defined $object_type or Carp::croak "subtype specified without type";	909	defined $object_type or Carp::croak "subtype specified without type";
569	my $object_subtype = shift @arg;	910	my $object_subtype = shift @arg;
570	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	911	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
571		912
572	} elsif ($type eq "package") {	913	} elsif ($type eq "package") {
573	my $pkg = shift @arg;	914	my $pkg = shift @arg;
574		915
575	while (my ($name, $id) = each %cb_id) {	916	while (my ($name, $id) = each %cb_id) {
…		…
604	_attach $registry, $klass, @attach;	945	_attach $registry, $klass, @attach;
605	}	946	}
606		947
607	$obj->{$name} = \%arg;	948	$obj->{$name} = \%arg;
608	} else {	949	} else {
609	warn "object uses attachment '$name' that is not available, postponing.\n";	950	warn "object uses attachment '$name' which is not available, postponing.\n";
610	}	951	}
611		952
612	$obj->{_attachment}{$name} = undef;	953	$obj->{_attachment}{$name} = undef;
613	}	954	}
614		955
…		…
616	if (ref $_[0]) {	957	if (ref $_[0]) {
617	_object_attach @_;	958	_object_attach @_;
618	} else {	959	} else {
619	_attach shift->_attach_registry, @_;	960	_attach shift->_attach_registry, @_;
620	}	961	}
		962	_recalc_want;
621	};	963	};
622		964
623	# all those should be optimised	965	# all those should be optimised
624	sub cf::attachable::detach {	966	sub cf::attachable::detach {
625	my ($obj, $name) = @_;	967	my ($obj, $name) = @_;
…		…
628	delete $obj->{_attachment}{$name};	970	delete $obj->{_attachment}{$name};
629	reattach ($obj);	971	reattach ($obj);
630	} else {	972	} else {
631	Carp::croak "cannot, currently, detach class attachments";	973	Carp::croak "cannot, currently, detach class attachments";
632	}	974	}
		975	_recalc_want;
633	};	976	};
634		977
635	sub cf::attachable::attached {	978	sub cf::attachable::attached {
636	my ($obj, $name) = @_;	979	my ($obj, $name) = @_;
637		980
…		…
652	";	995	";
653	die if $@;	996	die if $@;
654	}	997	}
655		998
656	our $override;	999	our $override;
657	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?
658		1001
659	sub override {	1002	sub override {
660	$override = 1;	1003	$override = 1;
661	@invoke_results = ();	1004	@INVOKE_RESULTS = (@_);
662	}	1005	}
663		1006
664	sub do_invoke {	1007	sub do_invoke {
665	my $event = shift;	1008	my $event = shift;
666	my $callbacks = shift;	1009	my $callbacks = shift;
667		1010
668	@invoke_results = ();	1011	@INVOKE_RESULTS = ();
669		1012
670	local $override;	1013	local $override;
671		1014
672	for (@$callbacks) {	1015	for (@$callbacks) {
673	eval { &{$_->[1]} };	1016	eval { &{$_->[1]} };
…		…
682	}	1025	}
683		1026
684	0	1027	0
685	}	1028	}
686		1029
687	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1030	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
688		1031
689	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1032	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
690		1033
691	Generate an object-specific event with the given arguments.	1034	Generate an object-specific event with the given arguments.
692		1035
693	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
694	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
695	results (if you must, access C<@cf::invoke_results> directly).	1038	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
696		1039
697	=back	1040	=back
698		1041
699	=cut	1042	=cut
700		1043
701	#############################################################################	1044	#############################################################################
702	# 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	}
703		1088
704	sub reattach {	1089	sub reattach {
705	# basically do the same as instantiate, without calling instantiate	1090	# basically do the same as instantiate, without calling instantiate
706	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
707		1095
708	my $registry = $obj->registry;	1096	my $registry = $obj->registry;
709		1097
710	@$registry = ();	1098	@$registry = ();
711		1099
…		…
726	cf::attachable->attach (	1114	cf::attachable->attach (
727	prio => -1000000,	1115	prio => -1000000,
728	on_instantiate => sub {	1116	on_instantiate => sub {
729	my ($obj, $data) = @_;	1117	my ($obj, $data) = @_;
730		1118
731	$data = from_json $data;	1119	$data = decode_json $data;
732		1120
733	for (@$data) {	1121	for (@$data) {
734	my ($name, $args) = @$_;	1122	my ($name, $args) = @$_;
735		1123
736	$obj->attach ($name, %{$args || {} });	1124	$obj->attach ($name, %{$args || {} });
…		…
752	sub object_freezer_save {	1140	sub object_freezer_save {
753	my ($filename, $rdata, $objs) = @_;	1141	my ($filename, $rdata, $objs) = @_;
754		1142
755	sync_job {	1143	sync_job {
756	if (length $$rdata) {	1144	if (length $$rdata) {
		1145	utf8::decode (my $decname = $filename);
757	warn sprintf "saving %s (%d,%d)\n",	1146	warn sprintf "saving %s (%d,%d)\n",
758	$filename, length $$rdata, scalar @$objs;	1147	$decname, length $$rdata, scalar @$objs;
759		1148
760	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1149	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
761	chmod SAVE_MODE, $fh;	1150	aio_chmod $fh, SAVE_MODE;
762	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1151	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
763	aio_fsync $fh;	1152	aio_fsync $fh if $cf::USE_FSYNC;
764	close $fh;	1153	aio_close $fh;
765		1154
766	if (@$objs) {	1155	if (@$objs) {
767	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) {
768	chmod SAVE_MODE, $fh;	1157	aio_chmod $fh, SAVE_MODE;
769	my $data = Storable::nfreeze { version => 1, objs => $objs };	1158	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
770	aio_write $fh, 0, (length $data), $data, 0;	1159	aio_write $fh, 0, (length $data), $data, 0;
771	aio_fsync $fh;	1160	aio_fsync $fh if $cf::USE_FSYNC;
772	close $fh;	1161	aio_close $fh;
773	aio_rename "$filename.pst~", "$filename.pst";	1162	aio_rename "$filename.pst~", "$filename.pst";
774	}	1163	}
775	} else {	1164	} else {
776	aio_unlink "$filename.pst";	1165	aio_unlink "$filename.pst";
777	}	1166	}
778		1167
779	aio_rename "$filename~", $filename;	1168	aio_rename "$filename~", $filename;
		1169
		1170	$filename =~ s%/[^/]+$%%;
		1171	aio_pathsync $filename if $cf::USE_FSYNC;
780	} else {	1172	} else {
781	warn "FATAL: $filename~: $!\n";	1173	warn "unable to save objects: $filename~: $!\n";
782	}	1174	}
783	} else {	1175	} else {
784	aio_unlink $filename;	1176	aio_unlink $filename;
785	aio_unlink "$filename.pst";	1177	aio_unlink "$filename.pst";
786	}	1178	}
787	}	1179	};
788	}	1180	}
789		1181
790	sub object_freezer_as_string {	1182	sub object_freezer_as_string {
791	my ($rdata, $objs) = @_;	1183	my ($rdata, $objs) = @_;
792		1184
…		…
804	or return;	1196	or return;
805		1197
806	unless (aio_stat "$filename.pst") {	1198	unless (aio_stat "$filename.pst") {
807	(aio_load "$filename.pst", $av) >= 0	1199	(aio_load "$filename.pst", $av) >= 0
808	or return;	1200	or return;
		1201
809	$av = eval { (Storable::thaw $av)->{objs} };	1202	my $st = eval { Coro::Storable::thaw $av };
		1203	$av = $st->{objs};
810	}	1204	}
811		1205
		1206	utf8::decode (my $decname = $filename);
		1207	warn sprintf "loading %s (%d,%d)\n",
		1208	$decname, length $data, scalar @{$av || []};
		1209
812	return ($data, $av);	1210	($data, $av)
813	}	1211	}
		1212
		1213	=head2 COMMAND CALLBACKS
		1214
		1215	=over 4
		1216
		1217	=cut
814		1218
815	#############################################################################	1219	#############################################################################
816	# command handling &c	1220	# command handling &c
817		1221
818	=item cf::register_command $name => \&callback($ob,$args);	1222	=item cf::register_command $name => \&callback($ob,$args);
…		…
831	push @{ $COMMAND{$name} }, [$caller, $cb];	1235	push @{ $COMMAND{$name} }, [$caller, $cb];
832	}	1236	}
833		1237
834	=item cf::register_extcmd $name => \&callback($pl,$packet);	1238	=item cf::register_extcmd $name => \&callback($pl,$packet);
835		1239
836	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.
837		1245
838	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
839	called.	1247	called.
840		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
841	=cut	1260	=cut
842		1261
843	sub register_extcmd {	1262	sub register_extcmd {
844	my ($name, $cb) = @_;	1263	my ($name, $cb) = @_;
845		1264
846	my $caller = caller;
847	#warn "registering extcmd '$name' to '$caller'";
848
849	$EXTCMD{$name} = [$cb, $caller];	1265	$EXTCMD{$name} = $cb;
850	}	1266	}
		1267
		1268	sub register_exticmd {
		1269	my ($name, $cb) = @_;
		1270
		1271	$EXTICMD{$name} = $cb;
		1272	}
		1273
		1274	use File::Glob ();
851		1275
852	cf::player->attach (	1276	cf::player->attach (
853	on_command => sub {	1277	on_command => sub {
854	my ($pl, $name, $params) = @_;	1278	my ($pl, $name, $params) = @_;
855		1279
…		…
863	cf::override;	1287	cf::override;
864	},	1288	},
865	on_extcmd => sub {	1289	on_extcmd => sub {
866	my ($pl, $buf) = @_;	1290	my ($pl, $buf) = @_;
867		1291
868	my $msg = eval { from_json $buf };	1292	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
869		1293
870	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
871	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1302	if (my $cb = $EXTCMD{$type}) {
872	if (my %reply = $cb->[0]->($pl, $msg)) {	1303	@reply = $cb->($pl, @payload);
873	$pl->ext_reply ($msg->{msgid}, %reply);
874	}
875	}	1304	}
		1305
		1306	$pl->ext_reply ($reply, @reply)
		1307	if $reply;
		1308
876	} else {	1309	} else {
877	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1310	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
878	}	1311	}
879		1312
880	cf::override;	1313	cf::override;
881	},	1314	},
882	);	1315	);
883		1316
884	sub register {	1317	# "readahead" all extensions
885	my ($base, $pkg) = @_;	1318	sub cache_extensions {
		1319	my $grp = IO::AIO::aio_group;
886		1320
887	#TODO	1321	add $grp IO::AIO::aio_readdir $LIBDIR, sub {
888	}	1322	for (grep /\.ext$/, @{$_[0]}) {
		1323	add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
		1324	}
		1325	};
889		1326
		1327	$grp
		1328	}
		1329
890	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($) {
891	my ($path) = @_;	1685	my ($path) = @_;
892		1686
893	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1687	my ($match, $specificity);
894	my $base = $1;
895	my $pkg = $1;
896	$pkg =~ s/[^[:word:]]/_/g;
897	$pkg = "ext::$pkg";
898		1688
899	warn "loading '$path' into '$pkg'\n";	1689	for my $region (list) {
900		1690	if ($region->{match} && $path =~ $region->{match}) {
901	open my $fh, "<:utf8", $path	1691	($match, $specificity) = ($region, $region->specificity)
902	or die "$path: $!";	1692	if $region->specificity > $specificity;
903		1693	}
904	my $source =
905	"package $pkg; use strict; use utf8;\n"
906	. "#line 1 \"$path\"\n{\n"
907	. (do { local $/; <$fh> })
908	. "\n};\n1";
909
910	eval $source
911	or die $@ ? "$path: $@\n"
912	: "extension disabled.\n";
913
914	push @exts, $pkg;
915	$ext_pkg{$base} = $pkg;
916
917	# no strict 'refs';
918	# @{"$pkg\::ISA"} = ext::;
919
920	register $base, $pkg;
921	}
922
923	sub unload_extension {
924	my ($pkg) = @_;
925
926	warn "removing extension $pkg\n";
927
928	# remove hooks
929	#TODO
930	# for my $idx (0 .. $#PLUGIN_EVENT) {
931	# delete $hook[$idx]{$pkg};
932	# }	1694	}
933		1695
934	# remove commands	1696	$match
935	for my $name (keys %COMMAND) {
936	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
937
938	if (@cb) {
939	$COMMAND{$name} = \@cb;
940	} else {
941	delete $COMMAND{$name};
942	}
943	}
944
945	# remove extcmds
946	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
947	delete $EXTCMD{$name};
948	}
949
950	if (my $cb = $pkg->can ("unload")) {
951	eval {
952	$cb->($pkg);
953	1
954	} or warn "$pkg unloaded, but with errors: $@";
955	}
956
957	Symbol::delete_package $pkg;
958	}
959
960	sub load_extensions {
961	for my $ext (<$LIBDIR/*.ext>) {
962	next unless -r $ext;
963	eval {
964	load_extension $ext;
965	1
966	} or warn "$ext not loaded: $@";
967	}
968	}
969
970	#############################################################################
971	# load/save/clean perl data associated with a map
972
973	*cf::mapsupport::on_clean = sub {
974	my ($map) = @_;
975
976	my $path = $map->tmpname;
977	defined $path or return;
978
979	unlink "$path.pst";
980	};
981
982	cf::map->attach (prio => -10000, package => cf::mapsupport::);
983
984	#############################################################################
985	# load/save perl data associated with player->ob objects
986
987	sub all_objects(@) {
988	@_, map all_objects ($_->inv), @_
989	}
990
991	# TODO: compatibility cruft, remove when no longer needed
992	cf::player->attach (
993	on_load => sub {
994	my ($pl, $path) = @_;
995
996	for my $o (all_objects $pl->ob) {
997	if (my $value = $o->get_ob_key_value ("_perl_data")) {
998	$o->set_ob_key_value ("_perl_data");
999
1000	%$o = %{ Storable::thaw pack "H*", $value };
1001	}
1002	}
1003	},
1004	);
1005
1006	#############################################################################
1007
1008	=head2 CORE EXTENSIONS
1009
1010	Functions and methods that extend core crossfire objects.
1011
1012	=head3 cf::player
1013
1014	=over 4
1015
1016	=item cf::player::exists $login
1017
1018	Returns true when the given account exists.
1019
1020	=cut
1021
1022	sub cf::player::exists($) {
1023	cf::player::find $_[0]
1024	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1025	}
1026
1027	=item $player->ext_reply ($msgid, $msgtype, %msg)
1028
1029	Sends an ext reply to the player.
1030
1031	=cut
1032
1033	sub cf::player::ext_reply($$$%) {
1034	my ($self, $id, %msg) = @_;
1035
1036	$msg{msgid} = $id;
1037
1038	$self->send ("ext " . to_json \%msg);
1039	}	1697	}
1040		1698
1041	=back	1699	=back
1042
1043		1700
1044	=head3 cf::map	1701	=head3 cf::map
1045		1702
1046	=over 4	1703	=over 4
1047		1704
…		…
1050	package cf::map;	1707	package cf::map;
1051		1708
1052	use Fcntl;	1709	use Fcntl;
1053	use Coro::AIO;	1710	use Coro::AIO;
1054		1711
		1712	use overload
		1713	'""' => \&as_string,
		1714	fallback => 1;
		1715
1055	our $MAX_RESET = 7200;	1716	our $MAX_RESET = 3600;
1056	our $DEFAULT_RESET = 3600;	1717	our $DEFAULT_RESET = 3000;
1057		1718
1058	sub generate_random_map {	1719	sub generate_random_map {
1059	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
1060		1723
1061	# mit "rum" bekleckern, nicht	1724	# mit "rum" bekleckern, nicht
1062	cf::map::_create_random_map	1725	$self->_create_random_map (
1063	$path,
1064	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1726	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1065	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1727	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1066	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1728	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1067	$rmp->{exit_on_final_map},	1729	$rmp->{exit_on_final_map},
1068	$rmp->{xsize}, $rmp->{ysize},	1730	$rmp->{xsize}, $rmp->{ysize},
1069	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1731	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1070	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1732	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1071	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1733	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1072	$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},
1073	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1735	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1074	(cf::region::find $rmp->{region})	1736	(cf::region::find $rmp->{region}), $rmp->{custom}
		1737	)
		1738	}
		1739
		1740	=item cf::map->register ($regex, $prio)
		1741
		1742	Register a handler for the map path matching the given regex at the
		1743	givne priority (higher is better, built-in handlers have priority 0, the
		1744	default).
		1745
		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 {
		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"
1075	}	1865	}
1076		1866
1077	# and all this just because we cannot iterate over	1867	# and all this just because we cannot iterate over
1078	# all maps in C++...	1868	# all maps in C++...
1079	sub change_all_map_light {	1869	sub change_all_map_light {
1080	my ($change) = @_;	1870	my ($change) = @_;
1081		1871
1082	$_->change_map_light ($change) for values %cf::MAP;	1872	$_->change_map_light ($change)
		1873	for grep $_->outdoor, values %cf::MAP;
1083	}	1874	}
1084		1875
		1876	sub decay_objects {
		1877	my ($self) = @_;
		1878
		1879	return if $self->{deny_reset};
		1880
		1881	$self->do_decay_objects;
		1882	}
		1883
		1884	sub unlink_save {
		1885	my ($self) = @_;
		1886
		1887	utf8::encode (my $save = $self->save_path);
		1888	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1889	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1890	}
		1891
1085	sub try_load_header($) {	1892	sub load_header_from($) {
1086	my ($path) = @_;	1893	my ($self, $path) = @_;
1087		1894
1088	utf8::encode $path;	1895	utf8::encode $path;
1089	aio_open $path, O_RDONLY, 0	1896	my $f = new_from_file cf::object::thawer $path
1090	or return;	1897	or return;
1091		1898
1092	my $map = cf::map::new	1899	$self->_load_header ($f)
1093	or return;	1900	or return;
1094		1901
1095	$map->load_header ($path)	1902	local $MAP_LOADING{$self->{path}} = $self;
		1903	$f->resolve_delayed_derefs;
		1904
		1905	$self->{load_path} = $path;
		1906
		1907	1
		1908	}
		1909
		1910	sub load_header_orig {
		1911	my ($self) = @_;
		1912
		1913	$self->load_header_from ($self->load_path)
		1914	}
		1915
		1916	sub load_header_temp {
		1917	my ($self) = @_;
		1918
		1919	$self->load_header_from ($self->save_path)
		1920	}
		1921
		1922	sub prepare_temp {
		1923	my ($self) = @_;
		1924
		1925	$self->last_access ((delete $self->{last_access})
		1926	|| $cf::RUNTIME); #d#
		1927	# safety
		1928	$self->{instantiate_time} = $cf::RUNTIME
		1929	if $self->{instantiate_time} > $cf::RUNTIME;
		1930	}
		1931
		1932	sub prepare_orig {
		1933	my ($self) = @_;
		1934
		1935	$self->{load_original} = 1;
		1936	$self->{instantiate_time} = $cf::RUNTIME;
		1937	$self->last_access ($cf::RUNTIME);
		1938	$self->instantiate;
		1939	}
		1940
		1941	sub load_header {
		1942	my ($self) = @_;
		1943
		1944	if ($self->load_header_temp) {
		1945	$self->prepare_temp;
		1946	} else {
		1947	$self->load_header_orig
1096	or return;	1948	or return;
		1949	$self->prepare_orig;
		1950	}
1097		1951
1098	$map->{load_path} = $path;	1952	$self->{deny_reset} = 1
		1953	if $self->no_reset;
1099		1954
1100	$map	1955	$self->default_region (cf::region::find_by_path $self->{path})
1101	}	1956	unless $self->default_region;
1102		1957
		1958	1
		1959	}
		1960
		1961	sub find;
1103	sub find_map {	1962	sub find {
1104	my ($path, $origin) = @_;	1963	my ($path, $origin) = @_;
1105		1964
1106	#warn "find_map<$path,$origin>\n";#d#
1107
1108	$path = new cf::path $path, $origin && $origin->path;	1965	$path = normalise $path, $origin && $origin->path;
1109	my $key = $path->as_string;
1110		1966
		1967	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
		1968	my $guard2 = cf::lock_acquire "map_find:$path";
		1969
1111	$cf::MAP{$key} || do {	1970	$cf::MAP{$path} || do {
1112	# do it the slow way	1971	my $map = new_from_path cf::map $path
1113	my $map = try_load_header $path->save_path;
1114
1115	if ($map) {
1116	# safety
1117	$map->{instantiate_time} = $cf::RUNTIME
1118	if $map->{instantiate_time} > $cf::RUNTIME;
1119	} else {
1120	if (my $rmp = $path->random_map_params) {
1121	$map = generate_random_map $key, $rmp;
1122	} else {
1123	$map = try_load_header $path->load_path;
1124	}
1125
1126	$map or return;	1972	or return;
1127		1973
1128	$map->{load_original} = 1;
1129	$map->{instantiate_time} = $cf::RUNTIME;
1130	$map->instantiate;
1131
1132	# per-player maps become, after loading, normal maps
1133	$map->per_player (0) if $path->{user_rel};
1134	}
1135
1136	$map->path ($key);
1137	$map->{path} = $path;
1138	$map->last_access ($cf::RUNTIME);	1974	$map->{last_save} = $cf::RUNTIME;
1139		1975
1140	if ($map->should_reset) {	1976	$map->load_header
		1977	or return;
		1978
		1979	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1980	# doing this can freeze the server in a sync job, obviously
		1981	#$cf::WAIT_FOR_TICK->wait;
		1982	undef $guard2;
		1983	undef $guard1;
1141	$map->reset;	1984	$map->reset;
1142	$map = find_map $path;	1985	return find $path;
1143	}	1986	}
1144		1987
1145	$cf::MAP{$key} = $map	1988	$cf::MAP{$path} = $map
1146	}	1989	}
1147	}	1990	}
		1991
		1992	sub pre_load { }
		1993	sub post_load { }
1148		1994
1149	sub load {	1995	sub load {
1150	my ($self) = @_;	1996	my ($self) = @_;
1151		1997
1152	return if $self->in_memory != cf::MAP_SWAPPED;	1998	local $self->{deny_reset} = 1; # loading can take a long time
1153
1154	$self->in_memory (cf::MAP_LOADING);
1155		1999
1156	my $path = $self->{path};	2000	my $path = $self->{path};
1157		2001
		2002	{
		2003	my $guard = cf::lock_acquire "map_data:$path";
		2004
		2005	return unless $self->valid;
		2006	return unless $self->in_memory == cf::MAP_SWAPPED;
		2007
		2008	$self->in_memory (cf::MAP_LOADING);
		2009
1158	$self->alloc;	2010	$self->alloc;
1159	$self->load_objects ($self->{load_path}, 1)	2011
		2012	$self->pre_load;
		2013	cf::cede_to_tick;
		2014
		2015	my $f = new_from_file cf::object::thawer $self->{load_path};
		2016	$f->skip_block;
		2017	$self->_load_objects ($f)
1160	or return;	2018	or return;
1161		2019
1162	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2020	$self->post_load_original
1163	if delete $self->{load_original};	2021	if delete $self->{load_original};
1164		2022
1165	if (my $uniq = $path->uniq_path) {	2023	if (my $uniq = $self->uniq_path) {
1166	utf8::encode $uniq;	2024	utf8::encode $uniq;
1167	if (aio_open $uniq, O_RDONLY, 0) {	2025	unless (aio_stat $uniq) {
		2026	if (my $f = new_from_file cf::object::thawer $uniq) {
1168	$self->clear_unique_items;	2027	$self->clear_unique_items;
1169	$self->load_objects ($uniq, 0);	2028	$self->_load_objects ($f);
		2029	$f->resolve_delayed_derefs;
		2030	}
1170	}	2031	}
1171	}	2032	}
1172		2033
		2034	$f->resolve_delayed_derefs;
		2035
		2036	cf::cede_to_tick;
1173	# now do the right thing for maps	2037	# now do the right thing for maps
1174	$self->link_multipart_objects;	2038	$self->link_multipart_objects;
1175
1176	if ($self->{path}->is_style_map) {
1177	$self->{deny_save} = 1;
1178	$self->{deny_reset} = 1;
1179	} else {
1180	$self->fix_auto_apply;
1181	$self->decay_objects;
1182	$self->update_buttons;
1183	$self->set_darkness_map;
1184	$self->difficulty ($self->estimate_difficulty)	2039	$self->difficulty ($self->estimate_difficulty)
1185	unless $self->difficulty;	2040	unless $self->difficulty;
		2041	cf::cede_to_tick;
		2042
		2043	unless ($self->{deny_activate}) {
		2044	$self->decay_objects;
		2045	$self->fix_auto_apply;
		2046	$self->update_buttons;
		2047	cf::cede_to_tick;
		2048	$self->set_darkness_map;
		2049	cf::cede_to_tick;
1186	$self->activate;	2050	$self->activate;
1187	}	2051	}
1188		2052
		2053	$self->{last_save} = $cf::RUNTIME;
		2054	$self->last_access ($cf::RUNTIME);
		2055
1189	$self->in_memory (cf::MAP_IN_MEMORY);	2056	$self->in_memory (cf::MAP_ACTIVE);
1190	}	2057	}
1191		2058
1192	sub load_map_sync {	2059	$self->post_load;
		2060	}
		2061
		2062	sub customise_for {
		2063	my ($self, $ob) = @_;
		2064
		2065	return find "~" . $ob->name . "/" . $self->{path}
		2066	if $self->per_player;
		2067
		2068	# return find "?party/" . $ob->name . "/" . $self->{path}
		2069	# if $self->per_party;
		2070
		2071	$self
		2072	}
		2073
		2074	# find and load all maps in the 3x3 area around a map
		2075	sub load_neighbours {
		2076	my ($map) = @_;
		2077
		2078	my @neigh; # diagonal neighbours
		2079
		2080	for (0 .. 3) {
		2081	my $neigh = $map->tile_path ($_)
		2082	or next;
		2083	$neigh = find $neigh, $map
		2084	or next;
		2085	$neigh->load;
		2086
		2087	push @neigh,
		2088	[$neigh->tile_path (($_ + 3) % 4), $neigh],
		2089	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		2090	}
		2091
		2092	for (grep defined $_->[0], @neigh) {
		2093	my ($path, $origin) = @$_;
		2094	my $neigh = find $path, $origin
		2095	or next;
		2096	$neigh->load;
		2097	}
		2098	}
		2099
		2100	sub find_sync {
1193	my ($path, $origin) = @_;	2101	my ($path, $origin) = @_;
1194		2102
1195	#warn "load_map_sync<$path, $origin>\n";#d#	2103	cf::sync_job { find $path, $origin }
		2104	}
1196		2105
1197	cf::sync_job {	2106	sub do_load_sync {
1198	my $map = cf::map::find_map $path, $origin	2107	my ($map) = @_;
1199	or return;	2108
1200	$map->load;	2109	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1201	$map	2110	if $Coro::current == $Coro::main;
		2111
		2112	cf::sync_job { $map->load };
		2113	}
		2114
		2115	our %MAP_PREFETCH;
		2116	our $MAP_PREFETCHER = undef;
		2117
		2118	sub find_async {
		2119	my ($path, $origin, $load) = @_;
		2120
		2121	$path = normalise $path, $origin && $origin->{path};
		2122
		2123	if (my $map = $cf::MAP{$path}) {
		2124	return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
		2125	}
		2126
		2127	$MAP_PREFETCH{$path} |= $load;
		2128
		2129	$MAP_PREFETCHER ||= cf::async {
		2130	$Coro::current->{desc} = "map prefetcher";
		2131
		2132	while (%MAP_PREFETCH) {
		2133	while (my ($k, $v) = each %MAP_PREFETCH) {
		2134	if (my $map = find $k) {
		2135	$map->load if $v;
		2136	}
		2137
		2138	delete $MAP_PREFETCH{$k};
		2139	}
		2140	}
		2141	undef $MAP_PREFETCHER;
1202	}	2142	};
		2143	$MAP_PREFETCHER->prio (6);
		2144
		2145	()
1203	}	2146	}
1204		2147
1205	sub save {	2148	sub save {
1206	my ($self) = @_;	2149	my ($self) = @_;
1207		2150
1208	my $save = $self->{path}->save_path; utf8::encode $save;	2151	my $lock = cf::lock_acquire "map_data:$self->{path}";
1209	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
1210		2152
1211	$self->{last_save} = $cf::RUNTIME;	2153	$self->{last_save} = $cf::RUNTIME;
1212		2154
1213	return unless $self->dirty;	2155	return unless $self->dirty;
1214		2156
		2157	my $save = $self->save_path; utf8::encode $save;
		2158	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2159
1215	$self->{load_path} = $save;	2160	$self->{load_path} = $save;
1216		2161
1217	return if $self->{deny_save};	2162	return if $self->{deny_save};
1218		2163
		2164	local $self->{last_access} = $self->last_access;#d#
		2165
		2166	cf::async {
		2167	$Coro::current->{desc} = "map player save";
		2168	$_->contr->save for $self->players;
		2169	};
		2170
		2171	cf::get_slot 0.02;
		2172
1219	if ($uniq) {	2173	if ($uniq) {
1220	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2174	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1221	$self->save_objects ($uniq, cf::IO_UNIQUES);	2175	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1222	} else {	2176	} else {
1223	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);	2177	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1224	}	2178	}
1225	}	2179	}
1226		2180
1227	sub swap_out {	2181	sub swap_out {
1228	my ($self) = @_;	2182	my ($self) = @_;
1229		2183
		2184	# save first because save cedes
		2185	$self->save;
		2186
		2187	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2188
1230	return if $self->players;	2189	return if $self->players;
1231	return if $self->in_memory != cf::MAP_IN_MEMORY;	2190	return if $self->in_memory != cf::MAP_ACTIVE;
1232	return if $self->{deny_save};	2191	return if $self->{deny_save};
1233		2192
		2193	$self->in_memory (cf::MAP_SWAPPED);
		2194
1234	$self->save;	2195	$self->deactivate;
		2196	$_->clear_links_to ($self) for values %cf::MAP;
1235	$self->clear;	2197	$self->clear;
1236	$self->in_memory (cf::MAP_SWAPPED);
1237	}	2198	}
1238		2199
1239	sub reset_at {	2200	sub reset_at {
1240	my ($self) = @_;	2201	my ($self) = @_;
1241		2202
1242	# TODO: safety, remove and allow resettable per-player maps	2203	# TODO: safety, remove and allow resettable per-player maps
1243	return 1e100 if $self->{path}{user_rel};
1244	return 1e100 if $self->{deny_reset};	2204	return 1e99 if $self->{deny_reset};
1245		2205
1246	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2206	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1247	my $to = $self->reset_timeout || $DEFAULT_RESET;	2207	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1248	$to = $MAX_RESET if $to > $MAX_RESET;
1249		2208
1250	$time + $to	2209	$time + $to
1251	}	2210	}
1252		2211
1253	sub should_reset {	2212	sub should_reset {
1254	my ($self) = @_;	2213	my ($self) = @_;
1255		2214
1256	$self->reset_at <= $cf::RUNTIME	2215	$self->reset_at <= $cf::RUNTIME
1257	}	2216	}
1258		2217
1259	sub unlink_save {
1260	my ($self) = @_;
1261
1262	utf8::encode (my $save = $self->{path}->save_path);
1263	aioreq_pri 3; IO::AIO::aio_unlink $save;
1264	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1265	}
1266
1267	sub rename {
1268	my ($self, $new_path) = @_;
1269
1270	$self->unlink_save;
1271
1272	delete $cf::MAP{$self->path};
1273	$self->{path} = new cf::path $new_path;
1274	$self->path ($self->{path}->path);
1275	$cf::MAP{$self->path} = $self;
1276
1277	$self->save;
1278	}
1279
1280	sub reset {	2218	sub reset {
1281	my ($self) = @_;	2219	my ($self) = @_;
1282		2220
		2221	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2222
1283	return if $self->players;	2223	return if $self->players;
1284	return if $self->{path}{user_rel};#d#
1285		2224
1286	warn "resetting map ", $self->path;#d#	2225	warn "resetting map ", $self->path;
		2226
		2227	$self->in_memory (cf::MAP_SWAPPED);
		2228
		2229	# need to save uniques path
		2230	unless ($self->{deny_save}) {
		2231	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2232
		2233	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2234	if $uniq;
		2235	}
1287		2236
1288	delete $cf::MAP{$self->path};	2237	delete $cf::MAP{$self->path};
1289		2238
		2239	$self->deactivate;
1290	$_->clear_links_to ($self) for values %cf::MAP;	2240	$_->clear_links_to ($self) for values %cf::MAP;
		2241	$self->clear;
1291		2242
1292	$self->unlink_save;	2243	$self->unlink_save;
1293	$self->destroy;	2244	$self->destroy;
1294	}	2245	}
1295		2246
1296	sub customise_for {	2247	my $nuke_counter = "aaaa";
1297	my ($map, $ob) = @_;
1298		2248
1299	if ($map->per_player) {	2249	sub nuke {
1300	return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path};	2250	my ($self) = @_;
		2251
1301	}	2252	{
		2253	my $lock = cf::lock_acquire "map_data:$self->{path}";
1302		2254
1303	$map	2255	delete $cf::MAP{$self->path};
1304	}
1305		2256
1306	sub emergency_save {	2257	$self->unlink_save;
1307	local $cf::FREEZE = 1;
1308		2258
1309	warn "enter emergency map save\n";	2259	bless $self, "cf::map";
		2260	delete $self->{deny_reset};
		2261	$self->{deny_save} = 1;
		2262	$self->reset_timeout (1);
		2263	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1310		2264
1311	cf::sync_job {	2265	$cf::MAP{$self->path} = $self;
1312	warn "begin emergency map save\n";
1313	$_->save for values %cf::MAP;
1314	};	2266	}
1315		2267
1316	warn "end emergency map save\n";	2268	$self->reset; # polite request, might not happen
		2269	}
		2270
		2271	=item $maps = cf::map::tmp_maps
		2272
		2273	Returns an arrayref with all map paths of currently instantiated and saved
		2274	maps. May block.
		2275
		2276	=cut
		2277
		2278	sub tmp_maps() {
		2279	[
		2280	map {
		2281	utf8::decode $_;
		2282	/\.map$/
		2283	? normalise $_
		2284	: ()
		2285	} @{ aio_readdir $TMPDIR or [] }
		2286	]
		2287	}
		2288
		2289	=item $maps = cf::map::random_maps
		2290
		2291	Returns an arrayref with all map paths of currently instantiated and saved
		2292	random maps. May block.
		2293
		2294	=cut
		2295
		2296	sub random_maps() {
		2297	[
		2298	map {
		2299	utf8::decode $_;
		2300	/\.map$/
		2301	? normalise "?random/$_"
		2302	: ()
		2303	} @{ aio_readdir $RANDOMDIR or [] }
		2304	]
		2305	}
		2306
		2307	=item cf::map::unique_maps
		2308
		2309	Returns an arrayref of paths of all shared maps that have
		2310	instantiated unique items. May block.
		2311
		2312	=cut
		2313
		2314	sub unique_maps() {
		2315	[
		2316	map {
		2317	utf8::decode $_;
		2318	s/\.map$//; # TODO future compatibility hack
		2319	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
		2320	? ()
		2321	: normalise $_
		2322	} @{ aio_readdir $UNIQUEDIR or [] }
		2323	]
		2324	}
		2325
		2326	=back
		2327
		2328	=head3 cf::object
		2329
		2330	=cut
		2331
		2332	package cf::object;
		2333
		2334	=over 4
		2335
		2336	=item $ob->inv_recursive
		2337
		2338	Returns the inventory of the object I<and> their inventories, recursively,
		2339	but I<not> the object itself.
		2340
		2341	=cut
		2342
		2343	sub inv_recursive_;
		2344	sub inv_recursive_ {
		2345	map { $_, inv_recursive_ $_->inv } @_
		2346	}
		2347
		2348	sub inv_recursive {
		2349	inv_recursive_ inv $_[0]
		2350	}
		2351
		2352	=item $ref = $ob->ref
		2353
		2354	Creates and returns a persistent reference to an object that can be stored as a string.
		2355
		2356	=item $ob = cf::object::deref ($refstring)
		2357
		2358	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2359	even if the object actually exists. May block.
		2360
		2361	=cut
		2362
		2363	sub deref {
		2364	my ($ref) = @_;
		2365
		2366	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2367	my ($uuid, $name) = ($1, $2);
		2368	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2369	or return;
		2370	$pl->ob->uuid eq $uuid
		2371	or return;
		2372
		2373	$pl->ob
		2374	} else {
		2375	warn "$ref: cannot resolve object reference\n";
		2376	undef
		2377	}
1317	}	2378	}
1318		2379
1319	package cf;	2380	package cf;
1320		2381
1321	=back	2382	=back
1322
1323		2383
1324	=head3 cf::object::player	2384	=head3 cf::object::player
1325		2385
1326	=over 4	2386	=over 4
1327		2387
…		…
1330	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	2390	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
1331	can be C<undef>. Does the right thing when the player is currently in a	2391	can be C<undef>. Does the right thing when the player is currently in a
1332	dialogue with the given NPC character.	2392	dialogue with the given NPC character.
1333		2393
1334	=cut	2394	=cut
		2395
		2396	our $SAY_CHANNEL = {
		2397	id => "say",
		2398	title => "Map",
		2399	reply => "say ",
		2400	tooltip => "Things said to and replied from npcs near you and other players on the same map only.",
		2401	};
		2402
		2403	our $CHAT_CHANNEL = {
		2404	id => "chat",
		2405	title => "Chat",
		2406	reply => "chat ",
		2407	tooltip => "Player chat and shouts, global to the server.",
		2408	};
1335		2409
1336	# rough implementation of a future "reply" method that works	2410	# rough implementation of a future "reply" method that works
1337	# with dialog boxes.	2411	# with dialog boxes.
1338	#TODO: the first argument must go, split into a $npc->reply_to ( method	2412	#TODO: the first argument must go, split into a $npc->reply_to ( method
1339	sub cf::object::player::reply($$$;$) {	2413	sub cf::object::player::reply($$$;$) {
…		…
1341		2415
1342	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2416	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1343		2417
1344	if ($self->{record_replies}) {	2418	if ($self->{record_replies}) {
1345	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2419	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2420
1346	} else {	2421	} else {
		2422	my $pl = $self->contr;
		2423
		2424	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2425	my $dialog = $pl->{npc_dialog};
		2426	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2427
		2428	} else {
1347	$msg = $npc->name . " says: $msg" if $npc;	2429	$msg = $npc->name . " says: $msg" if $npc;
1348	$self->message ($msg, $flags);	2430	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2431	}
1349	}	2432	}
		2433	}
		2434
		2435	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2436
		2437	=cut
		2438
		2439	sub cf::object::send_msg {
		2440	my $pl = shift->contr
		2441	or return;
		2442	$pl->send_msg (@_);
1350	}	2443	}
1351		2444
1352	=item $player_object->may ("access")	2445	=item $player_object->may ("access")
1353		2446
1354	Returns wether the given player is authorized to access resource "access"	2447	Returns wether the given player is authorized to access resource "access"
…		…
1363	(ref $cf::CFG{"may_$access"}	2456	(ref $cf::CFG{"may_$access"}
1364	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	2457	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
1365	: $cf::CFG{"may_$access"})	2458	: $cf::CFG{"may_$access"})
1366	}	2459	}
1367		2460
		2461	=item $player_object->enter_link
		2462
		2463	Freezes the player and moves him/her to a special map (C<{link}>).
		2464
		2465	The player should be reasonably safe there for short amounts of time (e.g.
		2466	for loading a map). You I<MUST> call C<leave_link> as soon as possible,
		2467	though, as the palyer cannot control the character while it is on the link
		2468	map.
		2469
		2470	Will never block.
		2471
		2472	=item $player_object->leave_link ($map, $x, $y)
		2473
		2474	Moves the player out of the special C<{link}> map onto the specified
		2475	map. If the map is not valid (or omitted), the player will be moved back
		2476	to the location he/she was before the call to C<enter_link>, or, if that
		2477	fails, to the emergency map position.
		2478
		2479	Might block.
		2480
		2481	=cut
		2482
		2483	sub link_map {
		2484	unless ($LINK_MAP) {
		2485	$LINK_MAP = cf::map::find "{link}"
		2486	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2487	$LINK_MAP->load;
		2488	}
		2489
		2490	$LINK_MAP
		2491	}
		2492
1368	sub cf::object::player::enter_link {	2493	sub cf::object::player::enter_link {
1369	my ($self) = @_;	2494	my ($self) = @_;
1370		2495
1371	return if $self->map == $LINK_MAP;
1372
1373	$self->{_link_pos} = [$self->map->{path}, $self->x, $self->y]
1374	if $self->map;
1375
1376	$self->enter_map ($LINK_MAP, 20, 20);
1377	$self->deactivate_recursive;	2496	$self->deactivate_recursive;
		2497
		2498	return if UNIVERSAL::isa $self->map, "ext::map_link";
		2499
		2500	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		2501	if $self->map && $self->map->{path} ne "{link}";
		2502
		2503	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1378	}	2504	}
1379		2505
1380	sub cf::object::player::leave_link {	2506	sub cf::object::player::leave_link {
1381	my ($self, $map, $x, $y) = @_;	2507	my ($self, $map, $x, $y) = @_;
1382		2508
		2509	return unless $self->contr->active;
		2510
1383	my $link_pos = delete $self->{_link_pos};	2511	my $link_pos = delete $self->{_link_pos};
1384		2512
1385	unless ($map) {	2513	unless ($map) {
1386	$self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1387
1388	# restore original map position	2514	# restore original map position
1389	($map, $x, $y) = @{ $link_pos || [] };	2515	($map, $x, $y) = @{ $link_pos || [] };
1390	$map = cf::map::find_map $map;	2516	$map = cf::map::find $map;
1391		2517
1392	unless ($map) {	2518	unless ($map) {
1393	($map, $x, $y) = @$EMERGENCY_POSITION;	2519	($map, $x, $y) = @$EMERGENCY_POSITION;
1394	$map = cf::map::find_map $map	2520	$map = cf::map::find $map
1395	or die "FATAL: cannot load emergency map\n";	2521	or die "FATAL: cannot load emergency map\n";
1396	}	2522	}
1397	}	2523	}
1398		2524
1399	($x, $y) = (-1, -1)	2525	($x, $y) = (-1, -1)
…		…
1402	# use -1 or undef as default coordinates, not 0, 0	2528	# use -1 or undef as default coordinates, not 0, 0
1403	($x, $y) = ($map->enter_x, $map->enter_y)	2529	($x, $y) = ($map->enter_x, $map->enter_y)
1404	if $x <=0 && $y <= 0;	2530	if $x <=0 && $y <= 0;
1405		2531
1406	$map->load;	2532	$map->load;
		2533	$map->load_neighbours;
1407		2534
		2535	return unless $self->contr->active;
		2536	$self->flag (cf::FLAG_DEBUG, 0);#d# temp
1408	$self->activate_recursive;	2537	$self->activate_recursive;
		2538
		2539	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1409	$self->enter_map ($map, $x, $y);	2540	$self->enter_map ($map, $x, $y);
1410	}	2541	}
1411		2542
1412	=item $player_object->goto_map ($map, $x, $y)	2543	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1413		2544
1414	=cut	2545	Moves the player to the given map-path and coordinates by first freezing
		2546	her, loading and preparing them map, calling the provided $check callback
		2547	that has to return the map if sucecssful, and then unfreezes the player on
		2548	the new (success) or old (failed) map position. In either case, $done will
		2549	be called at the end of this process.
1415		2550
		2551	Note that $check will be called with a potentially non-loaded map, so if
		2552	it needs a loaded map it has to call C<< ->load >>.
		2553
		2554	=cut
		2555
		2556	our $GOTOGEN;
		2557
1416	sub cf::object::player::goto_map {	2558	sub cf::object::player::goto {
1417	my ($self, $path, $x, $y) = @_;	2559	my ($self, $path, $x, $y, $check, $done) = @_;
		2560
		2561	# do generation counting so two concurrent goto's will be executed in-order
		2562	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1418		2563
1419	$self->enter_link;	2564	$self->enter_link;
1420		2565
1421	(Coro::async {	2566	(async {
1422	$path = new cf::path $path;	2567	$Coro::current->{desc} = "player::goto $path $x $y";
1423		2568
1424	my $map = cf::map::find_map $path->as_string;	2569	# *tag paths override both path and x|y
		2570	if ($path =~ /^\*(.*)$/) {
		2571	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2572	my $ob = $obs[rand @obs];
		2573
		2574	# see if we actually can go there
		2575	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2576	$ob = $obs[rand @obs];
		2577	} else {
		2578	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2579	}
		2580	# else put us there anyways for now #d#
		2581
		2582	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2583	} else {
		2584	($path, $x, $y) = (undef, undef, undef);
		2585	}
		2586	}
		2587
		2588	my $map = eval {
		2589	my $map = defined $path ? cf::map::find $path : undef;
		2590
		2591	if ($map) {
1425	$map = $map->customise_for ($self) if $map;	2592	$map = $map->customise_for ($self);
		2593	$map = $check->($map) if $check && $map;
		2594	} else {
		2595	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2596	}
1426		2597
1427	warn "entering ", $map->path, " at ($x, $y)\n"
1428	if $map;	2598	$map
		2599	};
1429		2600
		2601	if ($@) {
		2602	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2603	LOG llevError | logBacktrace, Carp::longmess $@;
		2604	}
		2605
		2606	if ($gen == $self->{_goto_generation}) {
		2607	delete $self->{_goto_generation};
1430	$self->leave_link ($map, $x, $y);	2608	$self->leave_link ($map, $x, $y);
		2609	}
		2610
		2611	$done->() if $done;
1431	})->prio (1);	2612	})->prio (1);
1432	}	2613	}
1433		2614
1434	=item $player_object->enter_exit ($exit_object)	2615	=item $player_object->enter_exit ($exit_object)
1435		2616
…		…
1437		2618
1438	sub parse_random_map_params {	2619	sub parse_random_map_params {
1439	my ($spec) = @_;	2620	my ($spec) = @_;
1440		2621
1441	my $rmp = { # defaults	2622	my $rmp = { # defaults
1442	xsize => 10,	2623	xsize => (cf::rndm 15, 40),
1443	ysize => 10,	2624	ysize => (cf::rndm 15, 40),
		2625	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2626	#layout => string,
1444	};	2627	};
1445		2628
1446	for (split /\n/, $spec) {	2629	for (split /\n/, $spec) {
1447	my ($k, $v) = split /\s+/, $_, 2;	2630	my ($k, $v) = split /\s+/, $_, 2;
1448		2631
…		…
1460	# that depends on the exit object	2643	# that depends on the exit object
1461		2644
1462	my $rmp = parse_random_map_params $exit->msg;	2645	my $rmp = parse_random_map_params $exit->msg;
1463		2646
1464	if ($exit->map) {	2647	if ($exit->map) {
1465	$rmp->{region} = $exit->map->region_name;	2648	$rmp->{region} = $exit->region->name;
1466	$rmp->{origin_map} = $exit->map->path;	2649	$rmp->{origin_map} = $exit->map->path;
1467	$rmp->{origin_x} = $exit->x;	2650	$rmp->{origin_x} = $exit->x;
1468	$rmp->{origin_y} = $exit->y;	2651	$rmp->{origin_y} = $exit->y;
		2652
		2653	$exit->map->touch;
1469	}	2654	}
1470		2655
1471	$rmp->{random_seed} ||= $exit->random_seed;	2656	$rmp->{random_seed} ||= $exit->random_seed;
1472		2657
1473	my $data = cf::to_json $rmp;	2658	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1474	my $md5 = Digest::MD5::md5_hex $data;	2659	my $md5 = Digest::MD5::md5_hex $data;
		2660	my $meta = "$RANDOMDIR/$md5.meta";
1475		2661
1476	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2662	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1477	aio_write $fh, 0, (length $data), $data, 0;	2663	aio_write $fh, 0, (length $data), $data, 0;
		2664	undef $fh;
		2665	aio_rename "$meta~", $meta;
1478		2666
		2667	my $slaying = "?random/$md5";
		2668
		2669	if ($exit->valid) {
1479	$exit->slaying ("?random/$md5");	2670	$exit->slaying ("?random/$md5");
1480	$exit->msg (undef);	2671	$exit->msg (undef);
		2672	}
1481	}	2673	}
1482	}	2674	}
1483		2675
1484	sub cf::object::player::enter_exit {	2676	sub cf::object::player::enter_exit {
1485	my ($self, $exit) = @_;	2677	my ($self, $exit) = @_;
1486		2678
1487	return unless $self->type == cf::PLAYER;	2679	return unless $self->type == cf::PLAYER;
1488		2680
1489	$self->enter_link;	2681	$self->enter_link;
1490		2682
1491	(Coro::async {	2683	(async {
		2684	$Coro::current->{desc} = "enter_exit";
		2685
1492	unless (eval {	2686	unless (eval {
		2687	$self->deactivate_recursive; # just to be sure
1493		2688
		2689	# random map handling
		2690	{
		2691	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2692
1494	prepare_random_map $exit	2693	prepare_random_map $exit
1495	if $exit->slaying eq "/!";	2694	if $exit->slaying eq "/!";
		2695	}
1496		2696
1497	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;	2697	my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1498	$self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);	2698	my $x = $exit->stats->hp;
		2699	my $y = $exit->stats->sp;
1499		2700
		2701	$self->goto ($map, $x, $y);
		2702
		2703	# if exit is damned, update players death & WoR home-position
		2704	$self->contr->savebed ($map, $x, $y)
		2705	if $exit->flag (cf::FLAG_DAMNED);
		2706
1500	1;	2707	1
1501	}) {	2708	}) {
1502	$self->message ("Something went wrong deep within the crossfire server. "	2709	$self->message ("Something went wrong deep within the deliantra server. "
1503	. "I'll try to bring you back to the map you were before. "	2710	. "I'll try to bring you back to the map you were before. "
1504	. "Please report this to the dungeon master",	2711	. "Please report this to the dungeon master!",
1505	cf::NDI_UNIQUE | cf::NDI_RED);	2712	cf::NDI_UNIQUE | cf::NDI_RED);
1506		2713
1507	warn "ERROR in enter_exit: $@";	2714	warn "ERROR in enter_exit: $@";
1508	$self->leave_link;	2715	$self->leave_link;
1509	}	2716	}
1510	})->prio (1);	2717	})->prio (1);
…		…
1523		2730
1524	sub cf::client::send_drawinfo {	2731	sub cf::client::send_drawinfo {
1525	my ($self, $text, $flags) = @_;	2732	my ($self, $text, $flags) = @_;
1526		2733
1527	utf8::encode $text;	2734	utf8::encode $text;
1528	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2735	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1529	}	2736	}
1530		2737
		2738	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2739
		2740	Send a drawinfo or msg packet to the client, formatting the msg for the
		2741	client if neccessary. C<$type> should be a string identifying the type of
		2742	the message, with C<log> being the default. If C<$color> is negative, suppress
		2743	the message unless the client supports the msg packet.
		2744
		2745	=cut
		2746
		2747	# non-persistent channels (usually the info channel)
		2748	our %CHANNEL = (
		2749	"c/identify" => {
		2750	id => "infobox",
		2751	title => "Identify",
		2752	reply => undef,
		2753	tooltip => "Items recently identified",
		2754	},
		2755	"c/examine" => {
		2756	id => "infobox",
		2757	title => "Examine",
		2758	reply => undef,
		2759	tooltip => "Signs and other items you examined",
		2760	},
		2761	"c/book" => {
		2762	id => "infobox",
		2763	title => "Book",
		2764	reply => undef,
		2765	tooltip => "The contents of a note or book",
		2766	},
		2767	"c/lookat" => {
		2768	id => "infobox",
		2769	title => "Look",
		2770	reply => undef,
		2771	tooltip => "What you saw there",
		2772	},
		2773	"c/who" => {
		2774	id => "infobox",
		2775	title => "Players",
		2776	reply => undef,
		2777	tooltip => "Shows players who are currently online",
		2778	},
		2779	"c/body" => {
		2780	id => "infobox",
		2781	title => "Body Parts",
		2782	reply => undef,
		2783	tooltip => "Shows which body parts you posess and are available",
		2784	},
		2785	"c/skills" => {
		2786	id => "infobox",
		2787	title => "Skills",
		2788	reply => undef,
		2789	tooltip => "Shows your experience per skill and item power",
		2790	},
		2791	"c/uptime" => {
		2792	id => "infobox",
		2793	title => "Uptime",
		2794	reply => undef,
		2795	tooltip => "How long the server has been running since last restart",
		2796	},
		2797	"c/mapinfo" => {
		2798	id => "infobox",
		2799	title => "Map Info",
		2800	reply => undef,
		2801	tooltip => "Information related to the maps",
		2802	},
		2803	"c/party" => {
		2804	id => "party",
		2805	title => "Party",
		2806	reply => "gsay ",
		2807	tooltip => "Messages and chat related to your party",
		2808	},
		2809	);
		2810
		2811	sub cf::client::send_msg {
		2812	my ($self, $channel, $msg, $color, @extra) = @_;
		2813
		2814	$msg = $self->pl->expand_cfpod ($msg)
		2815	unless $color & cf::NDI_VERBATIM;
		2816
		2817	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2818
		2819	# check predefined channels, for the benefit of C
		2820	if ($CHANNEL{$channel}) {
		2821	$channel = $CHANNEL{$channel};
		2822
		2823	$self->ext_msg (channel_info => $channel)
		2824	if $self->can_msg;
		2825
		2826	$channel = $channel->{id};
		2827
		2828	} elsif (ref $channel) {
		2829	# send meta info to client, if not yet sent
		2830	unless (exists $self->{channel}{$channel->{id}}) {
		2831	$self->{channel}{$channel->{id}} = $channel;
		2832	$self->ext_msg (channel_info => $channel)
		2833	if $self->can_msg;
		2834	}
		2835
		2836	$channel = $channel->{id};
		2837	}
		2838
		2839	return unless @extra || length $msg;
		2840
		2841	if ($self->can_msg) {
		2842	# default colour, mask it out
		2843	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2844	if $color & cf::NDI_DEF;
		2845
		2846	my $pkt = "msg "
		2847	. $self->{json_coder}->encode (
		2848	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
		2849	);
		2850
		2851	# try lzf for large packets
		2852	$pkt = "lzf " . Compress::LZF::compress $pkt
		2853	if 1024 <= length $pkt and $self->{can_lzf};
		2854
		2855	# split very large packets
		2856	if (8192 < length $pkt and $self->{can_lzf}) {
		2857	$self->send_packet ("frag $_") for unpack "(a8192)*", $pkt;
		2858	$pkt = "frag";
		2859	}
		2860
		2861	$self->send_packet ($pkt);
		2862	} else {
		2863	if ($color >= 0) {
		2864	# replace some tags by gcfclient-compatible ones
		2865	for ($msg) {
		2866	1 while
		2867	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2868	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2869	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2870	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2871	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2872	}
		2873
		2874	$color &= cf::NDI_COLOR_MASK;
		2875
		2876	utf8::encode $msg;
		2877
		2878	if (0 && $msg =~ /\[/) {
		2879	# COMMAND/INFO
		2880	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2881	} else {
		2882	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2883	$self->send_packet ("drawinfo $color $msg")
		2884	}
		2885	}
		2886	}
		2887	}
		2888
		2889	=item $client->ext_msg ($type, @msg)
		2890
		2891	Sends an ext event to the client.
		2892
		2893	=cut
		2894
		2895	sub cf::client::ext_msg($$@) {
		2896	my ($self, $type, @msg) = @_;
		2897
		2898	if ($self->extcmd == 2) {
		2899	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2900	} elsif ($self->extcmd == 1) { # TODO: remove
		2901	push @msg, msgtype => "event_$type";
		2902	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2903	}
		2904	}
		2905
		2906	=item $client->ext_reply ($msgid, @msg)
		2907
		2908	Sends an ext reply to the client.
		2909
		2910	=cut
		2911
		2912	sub cf::client::ext_reply($$@) {
		2913	my ($self, $id, @msg) = @_;
		2914
		2915	if ($self->extcmd == 2) {
		2916	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2917	} elsif ($self->extcmd == 1) {
		2918	#TODO: version 1, remove
		2919	unshift @msg, msgtype => "reply", msgid => $id;
		2920	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2921	}
		2922	}
1531		2923
1532	=item $success = $client->query ($flags, "text", \&cb)	2924	=item $success = $client->query ($flags, "text", \&cb)
1533		2925
1534	Queues a query to the client, calling the given callback with	2926	Queues a query to the client, calling the given callback with
1535	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2927	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1536	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2928	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1537		2929
1538	Queries can fail, so check the return code. Or don't, as queries will become	2930	Queries can fail, so check the return code. Or don't, as queries will
1539	reliable at some point in the future.	2931	become reliable at some point in the future.
1540		2932
1541	=cut	2933	=cut
1542		2934
1543	sub cf::client::query {	2935	sub cf::client::query {
1544	my ($self, $flags, $text, $cb) = @_;	2936	my ($self, $flags, $text, $cb) = @_;
…		…
1552	utf8::encode $text;	2944	utf8::encode $text;
1553	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2945	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1554		2946
1555	$self->send_packet ($self->{query_queue}[0][0])	2947	$self->send_packet ($self->{query_queue}[0][0])
1556	if @{ $self->{query_queue} } == 1;	2948	if @{ $self->{query_queue} } == 1;
		2949
		2950	1
1557	}	2951	}
1558		2952
1559	cf::client->attach (	2953	cf::client->attach (
		2954	on_connect => sub {
		2955	my ($ns) = @_;
		2956
		2957	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2958	},
1560	on_reply => sub {	2959	on_reply => sub {
1561	my ($ns, $msg) = @_;	2960	my ($ns, $msg) = @_;
1562		2961
1563	# this weird shuffling is so that direct followup queries	2962	# this weird shuffling is so that direct followup queries
1564	# get handled first	2963	# get handled first
1565	my $queue = delete $ns->{query_queue};	2964	my $queue = delete $ns->{query_queue}
		2965	or return; # be conservative, not sure how that can happen, but we saw a crash here
1566		2966
1567	(shift @$queue)->[1]->($msg);	2967	(shift @$queue)->[1]->($msg);
		2968	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1568		2969
1569	push @{ $ns->{query_queue} }, @$queue;	2970	push @{ $ns->{query_queue} }, @$queue;
1570		2971
1571	if (@{ $ns->{query_queue} } == @$queue) {	2972	if (@{ $ns->{query_queue} } == @$queue) {
1572	if (@$queue) {	2973	if (@$queue) {
…		…
1574	} else {	2975	} else {
1575	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2976	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1576	}	2977	}
1577	}	2978	}
1578	},	2979	},
		2980	on_exticmd => sub {
		2981	my ($ns, $buf) = @_;
		2982
		2983	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2984
		2985	if (ref $msg) {
		2986	my ($type, $reply, @payload) =
		2987	"ARRAY" eq ref $msg
		2988	? @$msg
		2989	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2990
		2991	my @reply;
		2992
		2993	if (my $cb = $EXTICMD{$type}) {
		2994	@reply = $cb->($ns, @payload);
		2995	}
		2996
		2997	$ns->ext_reply ($reply, @reply)
		2998	if $reply;
		2999
		3000	} else {
		3001	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		3002	}
		3003
		3004	cf::override;
		3005	},
1579	);	3006	);
1580		3007
1581	=item $client->coro (\&cb)	3008	=item $client->async (\&cb)
1582		3009
1583	Create a new coroutine, running the specified callback. The coroutine will	3010	Create a new coroutine, running the specified callback. The coroutine will
1584	be automatically cancelled when the client gets destroyed (e.g. on logout,	3011	be automatically cancelled when the client gets destroyed (e.g. on logout,
1585	or loss of connection).	3012	or loss of connection).
1586		3013
1587	=cut	3014	=cut
1588		3015
1589	sub cf::client::coro {	3016	sub cf::client::async {
1590	my ($self, $cb) = @_;	3017	my ($self, $cb) = @_;
1591		3018
1592	my $coro; $coro = async {	3019	my $coro = &Coro::async ($cb);
1593	eval {
1594	$cb->();
1595	};
1596	warn $@ if $@;
1597	};
1598		3020
1599	$coro->on_destroy (sub {	3021	$coro->on_destroy (sub {
1600	delete $self->{_coro}{$coro+0};	3022	delete $self->{_coro}{$coro+0};
1601	});	3023	});
1602		3024
…		…
1629	our $safe = new Safe "safe";	3051	our $safe = new Safe "safe";
1630	our $safe_hole = new Safe::Hole;	3052	our $safe_hole = new Safe::Hole;
1631		3053
1632	$SIG{FPE} = 'IGNORE';	3054	$SIG{FPE} = 'IGNORE';
1633		3055
1634	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3056	$safe->permit_only (Opcode::opset qw(
		3057	:base_core :base_mem :base_orig :base_math
		3058	grepstart grepwhile mapstart mapwhile
		3059	sort time
		3060	));
1635		3061
1636	# here we export the classes and methods available to script code	3062	# here we export the classes and methods available to script code
1637		3063
1638	=pod	3064	=pod
1639		3065
1640	The following fucntions and emthods are available within a safe environment:	3066	The following functions and methods are available within a safe environment:
1641		3067
1642	cf::object contr pay_amount pay_player map	3068	cf::object
		3069	contr pay_amount pay_player map x y force_find force_add destroy
		3070	insert remove name archname title slaying race decrease split
		3071
1643	cf::object::player player	3072	cf::object::player
1644	cf::player peaceful	3073	player
1645	cf::map trigger	3074
		3075	cf::player
		3076	peaceful
		3077
		3078	cf::map
		3079	trigger
1646		3080
1647	=cut	3081	=cut
1648		3082
1649	for (	3083	for (
1650	["cf::object" => qw(contr pay_amount pay_player map)],	3084	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3085	insert remove inv nrof name archname title slaying race
		3086	decrease split destroy change_exp)],
1651	["cf::object::player" => qw(player)],	3087	["cf::object::player" => qw(player)],
1652	["cf::player" => qw(peaceful)],	3088	["cf::player" => qw(peaceful)],
1653	["cf::map" => qw(trigger)],	3089	["cf::map" => qw(trigger)],
1654	) {	3090	) {
1655	no strict 'refs';	3091	no strict 'refs';
…		…
1726	=back	3162	=back
1727		3163
1728	=cut	3164	=cut
1729		3165
1730	#############################################################################	3166	#############################################################################
		3167	# the server's init and main functions
1731		3168
1732	=head2 EXTENSION DATABASE SUPPORT	3169	sub load_facedata($) {
		3170	my ($path) = @_;
1733		3171
1734	Crossfire maintains a very simple database for extension use. It can	3172	# HACK to clear player env face cache, we need some signal framework
1735	currently store anything that can be serialised using Storable, which	3173	# for this (global event?)
1736	excludes objects.	3174	%ext::player_env::MUSIC_FACE_CACHE = ();
1737		3175
1738	The parameter C<$family> should best start with the name of the extension	3176	my $enc = JSON::XS->new->utf8->canonical->relaxed;
1739	using it, it should be unique.
1740		3177
1741	=over 4	3178	warn "loading facedata from $path\n";
1742		3179
1743	=item $hashref = cf::db_get $family	3180	my $facedata;
		3181	0 < aio_load $path, $facedata
		3182	or die "$path: $!";
1744		3183
1745	Return a hashref for use by the extension C<$family>, which can be	3184	$facedata = Coro::Storable::thaw $facedata;
1746	modified. After modifications, you have to call C<cf::db_dirty> or
1747	C<cf::db_sync>.
1748		3185
1749	=item $value = cf::db_get $family => $key	3186	$facedata->{version} == 2
		3187	or cf::cleanup "$path: version mismatch, cannot proceed.";
1750		3188
1751	Returns a single value from the database	3189	# patch in the exptable
1752		3190	$facedata->{resource}{"res/exp_table"} = {
1753	=item cf::db_put $family => $hashref	3191	type => FT_RSRC,
1754		3192	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1755	Stores the given family hashref into the database. Updates are delayed, if
1756	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1757
1758	=item cf::db_put $family => $key => $value
1759
1760	Stores the given C<$value> in the family hash. Updates are delayed, if you
1761	want the data to be synced to disk immediately, use C<cf::db_sync>.
1762
1763	=item cf::db_dirty
1764
1765	Marks the database as dirty, to be updated at a later time.
1766
1767	=item cf::db_sync
1768
1769	Immediately write the database to disk I<if it is dirty>.
1770
1771	=cut
1772
1773	our $DB;
1774
1775	{
1776	my $path = cf::localdir . "/database.pst";
1777
1778	sub db_load() {
1779	warn "loading database $path\n";#d# remove later
1780	$DB = stat $path ? Storable::retrieve $path : { };
1781	}
1782
1783	my $pid;
1784
1785	sub db_save() {
1786	warn "saving database $path\n";#d# remove later
1787	waitpid $pid, 0 if $pid;
1788	if (0 == ($pid = fork)) {
1789	$DB->{_meta}{version} = 1;
1790	Storable::nstore $DB, "$path~";
1791	rename "$path~", $path;
1792	cf::_exit 0 if defined $pid;
1793	}
1794	}
1795
1796	my $dirty;
1797
1798	sub db_sync() {
1799	db_save if $dirty;
1800	undef $dirty;
1801	}
1802
1803	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1804	db_sync;
1805	});	3193	};
		3194	cf::cede_to_tick;
1806		3195
1807	sub db_dirty() {
1808	$dirty = 1;
1809	$idle->start;
1810	}	3196	{
		3197	my $faces = $facedata->{faceinfo};
1811		3198
1812	sub db_get($;$) {	3199	while (my ($face, $info) = each %$faces) {
1813	@_ >= 2	3200	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1814	? $DB->{$_[0]}{$_[1]}
1815	: ($DB->{$_[0]} ||= { })
1816	}
1817		3201
1818	sub db_put($$;$) {	3202	cf::face::set_visibility $idx, $info->{visibility};
1819	if (@_ >= 3) {	3203	cf::face::set_magicmap $idx, $info->{magicmap};
1820	$DB->{$_[0]}{$_[1]} = $_[2];	3204	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
1821	} else {	3205	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1822	$DB->{$_[0]} = $_[1];
1823	}
1824	db_dirty;
1825	}
1826		3206
1827	cf::global->attach (	3207	cf::cede_to_tick;
1828	prio => 10000,
1829	on_cleanup => sub {
1830	db_sync;
1831	},	3208	}
1832	);
1833	}
1834		3209
1835	#############################################################################	3210	while (my ($face, $info) = each %$faces) {
1836	# the server's main()	3211	next unless $info->{smooth};
1837		3212
1838	sub cfg_load {	3213	my $idx = cf::face::find $face
		3214	or next;
		3215
		3216	if (my $smooth = cf::face::find $info->{smooth}) {
		3217	cf::face::set_smooth $idx, $smooth;
		3218	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3219	} else {
		3220	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3221	}
		3222
		3223	cf::cede_to_tick;
		3224	}
		3225	}
		3226
		3227	{
		3228	my $anims = $facedata->{animinfo};
		3229
		3230	while (my ($anim, $info) = each %$anims) {
		3231	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3232	cf::cede_to_tick;
		3233	}
		3234
		3235	cf::anim::invalidate_all; # d'oh
		3236	}
		3237
		3238	{
		3239	# TODO: for gcfclient pleasure, we should give resources
		3240	# that gcfclient doesn't grok a >10000 face index.
		3241	my $res = $facedata->{resource};
		3242
		3243	while (my ($name, $info) = each %$res) {
		3244	if (defined $info->{type}) {
		3245	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3246	my $data;
		3247
		3248	if ($info->{type} & 1) {
		3249	# prepend meta info
		3250
		3251	my $meta = $enc->encode ({
		3252	name => $name,
		3253	%{ $info->{meta} || {} },
		3254	});
		3255
		3256	$data = pack "(w/a*)*", $meta, $info->{data};
		3257	} else {
		3258	$data = $info->{data};
		3259	}
		3260
		3261	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3262	cf::face::set_type $idx, $info->{type};
		3263	} else {
		3264	$RESOURCE{$name} = $info;
		3265	}
		3266
		3267	cf::cede_to_tick;
		3268	}
		3269	}
		3270
		3271	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3272
		3273	1
		3274	}
		3275
		3276	cf::global->attach (on_resource_update => sub {
		3277	if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
		3278	$soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
		3279
		3280	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3281	my $sound = $soundconf->{compat}[$_]
		3282	or next;
		3283
		3284	my $face = cf::face::find "sound/$sound->[1]";
		3285	cf::sound::set $sound->[0] => $face;
		3286	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3287	}
		3288
		3289	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3290	my $face = cf::face::find "sound/$v";
		3291	cf::sound::set $k => $face;
		3292	}
		3293	}
		3294	});
		3295
		3296	register_exticmd fx_want => sub {
		3297	my ($ns, $want) = @_;
		3298
		3299	while (my ($k, $v) = each %$want) {
		3300	$ns->fx_want ($k, $v);
		3301	}
		3302	};
		3303
		3304	sub load_resource_file($) {
		3305	my $guard = lock_acquire "load_resource_file";
		3306
		3307	my $status = load_resource_file_ $_[0];
		3308	get_slot 0.1, 100;
		3309	cf::arch::commit_load;
		3310
		3311	$status
		3312	}
		3313
		3314	sub reload_regions {
		3315	# HACK to clear player env face cache, we need some signal framework
		3316	# for this (global event?)
		3317	%ext::player_env::MUSIC_FACE_CACHE = ();
		3318
		3319	load_resource_file "$MAPDIR/regions"
		3320	or die "unable to load regions file\n";
		3321
		3322	for (cf::region::list) {
		3323	$_->{match} = qr/$_->{match}/
		3324	if exists $_->{match};
		3325	}
		3326	}
		3327
		3328	sub reload_facedata {
		3329	load_facedata "$DATADIR/facedata"
		3330	or die "unable to load facedata\n";
		3331	}
		3332
		3333	sub reload_archetypes {
		3334	load_resource_file "$DATADIR/archetypes"
		3335	or die "unable to load archetypes\n";
		3336	}
		3337
		3338	sub reload_treasures {
		3339	load_resource_file "$DATADIR/treasures"
		3340	or die "unable to load treasurelists\n";
		3341	}
		3342
		3343	sub reload_resources {
		3344	warn "reloading resource files...\n";
		3345
		3346	reload_facedata;
		3347	reload_archetypes;
		3348	reload_regions;
		3349	reload_treasures;
		3350
		3351	warn "finished reloading resource files\n";
		3352	}
		3353
		3354	sub reload_config {
1839	open my $fh, "<:utf8", cf::confdir . "/config"	3355	open my $fh, "<:utf8", "$CONFDIR/config"
1840	or return;	3356	or return;
1841		3357
1842	local $/;	3358	local $/;
1843	*CFG = YAML::Syck::Load <$fh>;	3359	*CFG = YAML::Load <$fh>;
		3360
		3361	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		3362
		3363	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		3364	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		3365
		3366	if (exists $CFG{mlockall}) {
		3367	eval {
		3368	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		3369	and die "WARNING: m(un)lockall failed: $!\n";
		3370	};
		3371	warn $@ if $@;
		3372	}
		3373	}
		3374
		3375	sub pidfile() {
		3376	sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
		3377	or die "$PIDFILE: $!";
		3378	flock $fh, &Fcntl::LOCK_EX
		3379	or die "$PIDFILE: flock: $!";
		3380	$fh
		3381	}
		3382
		3383	# make sure only one server instance is running at any one time
		3384	sub atomic {
		3385	my $fh = pidfile;
		3386
		3387	my $pid = <$fh>;
		3388	kill 9, $pid if $pid > 0;
		3389
		3390	seek $fh, 0, 0;
		3391	print $fh $$;
1844	}	3392	}
1845		3393
1846	sub main {	3394	sub main {
		3395	cf::init_globals; # initialise logging
		3396
		3397	LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
		3398	LOG llevInfo, "Copyright (C) 2005-2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
		3399	LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
		3400	LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
		3401
		3402	cf::init_experience;
		3403	cf::init_anim;
		3404	cf::init_attackmess;
		3405	cf::init_dynamic;
		3406
		3407	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3408
1847	# we must not ever block the main coroutine	3409	# we must not ever block the main coroutine
1848	local $Coro::idle = sub {	3410	local $Coro::idle = sub {
1849	Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#	3411	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1850	(Coro::unblock_sub {	3412	(async {
1851	Event::one_event;	3413	$Coro::current->{desc} = "IDLE BUG HANDLER";
1852	})->();	3414	EV::loop EV::LOOP_ONESHOT;
		3415	})->prio (Coro::PRIO_MAX);
1853	};	3416	};
1854		3417
1855	cfg_load;	3418	evthread_start IO::AIO::poll_fileno;
1856	db_load;	3419
		3420	cf::sync_job {
		3421	reload_resources;
		3422	reload_config;
		3423	db_init;
		3424
		3425	cf::load_settings;
		3426	cf::load_materials;
		3427	cf::init_uuid;
		3428	cf::init_signals;
		3429	cf::init_commands;
		3430	cf::init_skills;
		3431
		3432	cf::init_beforeplay;
		3433
		3434	atomic;
		3435
1857	load_extensions;	3436	load_extensions;
		3437
		3438	utime time, time, $RUNTIMEFILE;
		3439
		3440	# no (long-running) fork's whatsoever before this point(!)
		3441	POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
		3442
		3443	(pop @POST_INIT)->(0) while @POST_INIT;
		3444	};
		3445
1858	Event::loop;	3446	EV::loop;
1859	}	3447	}
1860		3448
1861	#############################################################################	3449	#############################################################################
1862	# initialisation	3450	# initialisation and cleanup
1863		3451
		3452	# install some emergency cleanup handlers
		3453	BEGIN {
		3454	our %SIGWATCHER = ();
		3455	for my $signal (qw(INT HUP TERM)) {
		3456	$SIGWATCHER{$signal} = EV::signal $signal, sub {
		3457	cf::cleanup "SIG$signal";
		3458	};
		3459	}
		3460	}
		3461
		3462	sub write_runtime_sync {
		3463	# first touch the runtime file to show we are still running:
		3464	# the fsync below can take a very very long time.
		3465
		3466	IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
		3467
		3468	my $guard = cf::lock_acquire "write_runtime";
		3469
		3470	my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT, 0644
		3471	or return;
		3472
		3473	my $value = $cf::RUNTIME + 90 + 10;
		3474	# 10 is the runtime save interval, for a monotonic clock
		3475	# 60 allows for the watchdog to kill the server.
		3476
		3477	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3478	and return;
		3479
		3480	# always fsync - this file is important
		3481	aio_fsync $fh
		3482	and return;
		3483
		3484	# touch it again to show we are up-to-date
		3485	aio_utime $fh, undef, undef;
		3486
		3487	close $fh
		3488	or return;
		3489
		3490	aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
		3491	and return;
		3492
		3493	warn "runtime file written.\n";
		3494
		3495	1
		3496	}
		3497
		3498	our $uuid_lock;
		3499	our $uuid_skip;
		3500
		3501	sub write_uuid_sync($) {
		3502	$uuid_skip ||= $_[0];
		3503
		3504	return if $uuid_lock;
		3505	local $uuid_lock = 1;
		3506
		3507	my $uuid = "$LOCALDIR/uuid";
		3508
		3509	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3510	or return;
		3511
		3512	my $value = uuid_seq uuid_cur;
		3513
		3514	unless ($value) {
		3515	warn "cowardly refusing to write zero uuid value!\n";
		3516	return;
		3517	}
		3518
		3519	my $value = uuid_str $value + $uuid_skip;
		3520	$uuid_skip = 0;
		3521
		3522	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3523	and return;
		3524
		3525	# always fsync - this file is important
		3526	aio_fsync $fh
		3527	and return;
		3528
		3529	close $fh
		3530	or return;
		3531
		3532	aio_rename "$uuid~", $uuid
		3533	and return;
		3534
		3535	warn "uuid file written ($value).\n";
		3536
		3537	1
		3538
		3539	}
		3540
		3541	sub write_uuid($$) {
		3542	my ($skip, $sync) = @_;
		3543
		3544	$sync ? write_uuid_sync $skip
		3545	: async { write_uuid_sync $skip };
		3546	}
		3547
		3548	sub emergency_save() {
		3549	my $freeze_guard = cf::freeze_mainloop;
		3550
		3551	warn "emergency_perl_save: enter\n";
		3552
		3553	cf::sync_job {
		3554	# this is a trade-off: we want to be very quick here, so
		3555	# save all maps without fsync, and later call a global sync
		3556	# (which in turn might be very very slow)
		3557	local $USE_FSYNC = 0;
		3558
		3559	# use a peculiar iteration method to avoid tripping on perl
		3560	# refcount bugs in for. also avoids problems with players
		3561	# and maps saved/destroyed asynchronously.
		3562	warn "emergency_perl_save: begin player save\n";
		3563	for my $login (keys %cf::PLAYER) {
		3564	my $pl = $cf::PLAYER{$login} or next;
		3565	$pl->valid or next;
		3566	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
		3567	$pl->save;
		3568	}
		3569	warn "emergency_perl_save: end player save\n";
		3570
		3571	warn "emergency_perl_save: begin map save\n";
		3572	for my $path (keys %cf::MAP) {
		3573	my $map = $cf::MAP{$path} or next;
		3574	$map->valid or next;
		3575	$map->save;
		3576	}
		3577	warn "emergency_perl_save: end map save\n";
		3578
		3579	warn "emergency_perl_save: begin database checkpoint\n";
		3580	BDB::db_env_txn_checkpoint $DB_ENV;
		3581	warn "emergency_perl_save: end database checkpoint\n";
		3582
		3583	warn "emergency_perl_save: begin write uuid\n";
		3584	write_uuid_sync 1;
		3585	warn "emergency_perl_save: end write uuid\n";
		3586	};
		3587
		3588	warn "emergency_perl_save: starting sync()\n";
		3589	IO::AIO::aio_sync sub {
		3590	warn "emergency_perl_save: finished sync()\n";
		3591	};
		3592
		3593	warn "emergency_perl_save: leave\n";
		3594	}
		3595
		3596	sub post_cleanup {
		3597	my ($make_core) = @_;
		3598
		3599	warn Carp::longmess "post_cleanup backtrace"
		3600	if $make_core;
		3601
		3602	my $fh = pidfile;
		3603	unlink $PIDFILE if <$fh> == $$;
		3604	}
		3605
		3606	# a safer delete_package, copied from Symbol
		3607	sub clear_package($) {
		3608	my $pkg = shift;
		3609
		3610	# expand to full symbol table name if needed
		3611	unless ($pkg =~ /^main::.*::$/) {
		3612	$pkg = "main$pkg" if $pkg =~ /^::/;
		3613	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		3614	$pkg .= '::' unless $pkg =~ /::$/;
		3615	}
		3616
		3617	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		3618	my $stem_symtab = *{$stem}{HASH};
		3619
		3620	defined $stem_symtab and exists $stem_symtab->{$leaf}
		3621	or return;
		3622
		3623	# clear all symbols
		3624	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		3625	for my $name (keys %$leaf_symtab) {
		3626	_gv_clear *{"$pkg$name"};
		3627	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		3628	}
		3629	warn "cleared package $pkg\n";#d#
		3630	}
		3631
1864	sub reload() {	3632	sub do_reload_perl() {
1865	# can/must only be called in main	3633	# can/must only be called in main
1866	if ($Coro::current != $Coro::main) {	3634	if ($Coro::current != $Coro::main) {
1867	warn "can only reload from main coroutine\n";	3635	warn "can only reload from main coroutine";
1868	return;	3636	return;
1869	}	3637	}
1870		3638
		3639	return if $RELOAD++;
		3640
		3641	my $t1 = EV::time;
		3642
		3643	while ($RELOAD) {
1871	warn "reloading...";	3644	warn "reloading...";
1872		3645
1873	local $FREEZE = 1;	3646	warn "entering sync_job";
		3647
		3648	cf::sync_job {
		3649	cf::write_runtime_sync; # external watchdog should not bark
1874	cf::emergency_save;	3650	cf::emergency_save;
		3651	cf::write_runtime_sync; # external watchdog should not bark
1875		3652
1876	eval {	3653	warn "syncing database to disk";
		3654	BDB::db_env_txn_checkpoint $DB_ENV;
		3655
1877	# if anything goes wrong in here, we should simply crash as we already saved	3656	# if anything goes wrong in here, we should simply crash as we already saved
1878		3657
1879	# cancel all watchers	3658	warn "flushing outstanding aio requests";
1880	for (Event::all_watchers) {	3659	while (IO::AIO::nreqs || BDB::nreqs) {
1881	$_->cancel if $_->data & WF_AUTOCANCEL;	3660	Coro::EV::timer_once 0.01; # let the sync_job do it's thing
1882	}
1883
1884	# cancel all extension coros
1885	$_->cancel for values %EXT_CORO;
1886	%EXT_CORO = ();
1887
1888	# unload all extensions
1889	for (@exts) {
1890	warn "unloading <$_>";
1891	unload_extension $_;
1892	}
1893
1894	# unload all modules loaded from $LIBDIR
1895	while (my ($k, $v) = each %INC) {
1896	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1897
1898	warn "removing <$k>";
1899	delete $INC{$k};
1900
1901	$k =~ s/\.pm$//;
1902	$k =~ s/\//::/g;
1903
1904	if (my $cb = $k->can ("unload_module")) {
1905	$cb->();
1906	}	3661	}
1907		3662
1908	Symbol::delete_package $k;	3663	warn "cancelling all extension coros";
		3664	$_->cancel for values %EXT_CORO;
		3665	%EXT_CORO = ();
		3666
		3667	warn "removing commands";
		3668	%COMMAND = ();
		3669
		3670	warn "removing ext/exti commands";
		3671	%EXTCMD = ();
		3672	%EXTICMD = ();
		3673
		3674	warn "unloading/nuking all extensions";
		3675	for my $pkg (@EXTS) {
		3676	warn "... unloading $pkg";
		3677
		3678	if (my $cb = $pkg->can ("unload")) {
		3679	eval {
		3680	$cb->($pkg);
		3681	1
		3682	} or warn "$pkg unloaded, but with errors: $@";
		3683	}
		3684
		3685	warn "... clearing $pkg";
		3686	clear_package $pkg;
1909	}	3687	}
1910		3688
1911	# sync database to disk	3689	warn "unloading all perl modules loaded from $LIBDIR";
1912	cf::db_sync;	3690	while (my ($k, $v) = each %INC) {
1913	IO::AIO::flush;	3691	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1914		3692
		3693	warn "... unloading $k";
		3694	delete $INC{$k};
		3695
		3696	$k =~ s/\.pm$//;
		3697	$k =~ s/\//::/g;
		3698
		3699	if (my $cb = $k->can ("unload_module")) {
		3700	$cb->();
		3701	}
		3702
		3703	clear_package $k;
		3704	}
		3705
1915	# get rid of safe::, as good as possible	3706	warn "getting rid of safe::, as good as possible";
1916	Symbol::delete_package "safe::$_"	3707	clear_package "safe::$_"
1917	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3708	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1918		3709
1919	# remove register_script_function callbacks	3710	warn "unloading cf.pm \"a bit\"";
1920	# TODO
1921
1922	# unload cf.pm "a bit"
1923	delete $INC{"cf.pm"};	3711	delete $INC{"cf.pm"};
		3712	delete $INC{"cf/pod.pm"};
1924		3713
1925	# don't, removes xs symbols, too,	3714	# don't, removes xs symbols, too,
1926	# and global variables created in xs	3715	# and global variables created in xs
1927	#Symbol::delete_package __PACKAGE__;	3716	#clear_package __PACKAGE__;
1928		3717
1929	# reload cf.pm	3718	warn "unload completed, starting to reload now";
		3719
1930	warn "reloading cf.pm";	3720	warn "reloading cf.pm";
1931	require cf;	3721	require cf;
1932	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3722	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1933		3723
1934	# load config and database again	3724	warn "loading config and database again";
1935	cf::cfg_load;	3725	cf::reload_config;
1936	cf::db_load;
1937		3726
1938	# load extensions
1939	warn "load extensions";	3727	warn "loading extensions";
1940	cf::load_extensions;	3728	cf::load_extensions;
1941		3729
1942	# reattach attachments to objects	3730	if ($REATTACH_ON_RELOAD) {
		3731	warn "reattaching attachments to objects/players";
		3732	_global_reattach; # objects, sockets
		3733	warn "reattaching attachments to maps";
		3734	reattach $_ for values %MAP;
		3735	warn "reattaching attachments to players";
		3736	reattach $_ for values %PLAYER;
		3737	}
		3738
		3739	warn "running post_init jobs";
		3740	(pop @POST_INIT)->(1) while @POST_INIT;
		3741
		3742	warn "leaving sync_job";
		3743
		3744	1
		3745	} or do {
		3746	warn $@;
		3747	cf::cleanup "error while reloading, exiting.";
		3748	};
		3749
1943	warn "reattach";	3750	warn "reloaded";
1944	_global_reattach;	3751	--$RELOAD;
		3752	}
		3753
		3754	$t1 = EV::time - $t1;
		3755	warn "reload completed in ${t1}s\n";
		3756	};
		3757
		3758	our $RELOAD_WATCHER; # used only during reload
		3759
		3760	sub reload_perl() {
		3761	# doing reload synchronously and two reloads happen back-to-back,
		3762	# coro crashes during coro_state_free->destroy here.
		3763
		3764	$RELOAD_WATCHER ||= cf::async {
		3765	Coro::AIO::aio_wait cache_extensions;
		3766
		3767	$RELOAD_WATCHER = EV::timer $TICK * 1.5, 0, sub {
		3768	do_reload_perl;
		3769	undef $RELOAD_WATCHER;
		3770	};
1945	};	3771	};
1946
1947	if ($@) {
1948	warn $@;
1949	warn "error while reloading, exiting.";
1950	exit 1;
1951	}
1952
1953	warn "reloaded successfully";
1954	};
1955
1956	#############################################################################
1957
1958	unless ($LINK_MAP) {
1959	$LINK_MAP = cf::map::new;
1960
1961	$LINK_MAP->width (41);
1962	$LINK_MAP->height (41);
1963	$LINK_MAP->alloc;
1964	$LINK_MAP->path ("{link}");
1965	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
1966	$LINK_MAP->in_memory (MAP_IN_MEMORY);
1967
1968	# dirty hack because... archetypes are not yet loaded
1969	Event->timer (
1970	after => 2,
1971	cb => sub {
1972	$_[0]->w->cancel;
1973
1974	# provide some exits "home"
1975	my $exit = cf::object::new "exit";
1976
1977	$exit->slaying ($EMERGENCY_POSITION->[0]);
1978	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
1979	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
1980
1981	$LINK_MAP->insert ($exit->clone, 19, 19);
1982	$LINK_MAP->insert ($exit->clone, 19, 20);
1983	$LINK_MAP->insert ($exit->clone, 19, 21);
1984	$LINK_MAP->insert ($exit->clone, 20, 19);
1985	$LINK_MAP->insert ($exit->clone, 20, 21);
1986	$LINK_MAP->insert ($exit->clone, 21, 19);
1987	$LINK_MAP->insert ($exit->clone, 21, 20);
1988	$LINK_MAP->insert ($exit->clone, 21, 21);
1989
1990	$exit->destroy;
1991	});
1992
1993	$LINK_MAP->{deny_save} = 1;
1994	$LINK_MAP->{deny_reset} = 1;
1995
1996	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
1997	}	3772	}
1998
1999	register "<global>", __PACKAGE__;
2000		3773
2001	register_command "reload" => sub {	3774	register_command "reload" => sub {
2002	my ($who, $arg) = @_;	3775	my ($who, $arg) = @_;
2003		3776
2004	if ($who->flag (FLAG_WIZ)) {	3777	if ($who->flag (FLAG_WIZ)) {
2005	$who->message ("start of reload.");
2006	reload;
2007	$who->message ("end of reload.");	3778	$who->message ("reloading server.");
		3779	async {
		3780	$Coro::current->{desc} = "perl_reload";
		3781	reload_perl;
		3782	};
2008	}	3783	}
2009	};	3784	};
2010		3785
2011	unshift @INC, $LIBDIR;	3786	unshift @INC, $LIBDIR;
2012		3787
2013	$TICK_WATCHER = Event->timer (	3788	my $bug_warning = 0;
2014	reentrant => 0,	3789
2015	prio => 0,	3790	our @WAIT_FOR_TICK;
2016	at => $NEXT_TICK || $TICK,	3791	our @WAIT_FOR_TICK_BEGIN;
2017	data => WF_AUTOCANCEL,	3792
2018	cb => sub {	3793	sub wait_for_tick {
2019	unless ($FREEZE) {	3794	return if tick_inhibit || $Coro::current == $Coro::main;
		3795
		3796	my $signal = new Coro::Signal;
		3797	push @WAIT_FOR_TICK, $signal;
		3798	$signal->wait;
		3799	}
		3800
		3801	sub wait_for_tick_begin {
		3802	return if tick_inhibit || $Coro::current == $Coro::main;
		3803
		3804	my $signal = new Coro::Signal;
		3805	push @WAIT_FOR_TICK_BEGIN, $signal;
		3806	$signal->wait;
		3807	}
		3808
		3809	sub tick {
		3810	if ($Coro::current != $Coro::main) {
		3811	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3812	unless ++$bug_warning > 10;
		3813	return;
		3814	}
		3815
2020	cf::server_tick; # one server iteration	3816	cf::server_tick; # one server iteration
2021	$RUNTIME += $TICK;
2022	}
2023		3817
2024	$NEXT_TICK += $TICK;	3818	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2025		3819	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2026	# if we are delayed by four ticks or more, skip them all	3820	Coro::async_pool {
2027	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3821	$Coro::current->{desc} = "runtime saver";
2028
2029	$TICK_WATCHER->at ($NEXT_TICK);
2030	$TICK_WATCHER->start;
2031	},
2032	);
2033
2034	IO::AIO::max_poll_time $TICK * 0.2;
2035
2036	Event->io (
2037	fd => IO::AIO::poll_fileno,
2038	poll => 'r',
2039	prio => 5,
2040	data => WF_AUTOCANCEL,
2041	cb => \&IO::AIO::poll_cb,
2042	);
2043
2044	Event->timer (
2045	data => WF_AUTOCANCEL,
2046	after => 0,
2047	interval => 10,
2048	cb => sub {
2049	(Coro::unblock_sub {
2050	write_runtime	3822	write_runtime_sync
2051	or warn "ERROR: unable to write runtime file: $!";	3823	or warn "ERROR: unable to write runtime file: $!";
2052	})->();	3824	};
2053	},	3825	}
2054	);	3826
		3827	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3828	$sig->send;
		3829	}
		3830	while (my $sig = shift @WAIT_FOR_TICK) {
		3831	$sig->send;
		3832	}
		3833
		3834	$LOAD = ($NOW - $TICK_START) / $TICK;
		3835	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3836
		3837	if (0) {
		3838	if ($NEXT_TICK) {
		3839	my $jitter = $TICK_START - $NEXT_TICK;
		3840	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		3841	warn "jitter $JITTER\n";#d#
		3842	}
		3843	}
		3844	}
		3845
		3846	{
		3847	# configure BDB
		3848
		3849	BDB::min_parallel 8;
		3850	BDB::max_poll_reqs $TICK * 0.1;
		3851	$AnyEvent::BDB::WATCHER->priority (1);
		3852
		3853	unless ($DB_ENV) {
		3854	$DB_ENV = BDB::db_env_create;
		3855	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		3856	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		3857	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		3858	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3859	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3860
		3861	cf::sync_job {
		3862	eval {
		3863	BDB::db_env_open
		3864	$DB_ENV,
		3865	$BDBDIR,
		3866	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3867	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3868	0666;
		3869
		3870	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3871	};
		3872
		3873	cf::cleanup "db_env_open(db): $@" if $@;
		3874	};
		3875	}
		3876
		3877	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3878	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3879	};
		3880	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		3881	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3882	};
		3883	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3884	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3885	};
		3886	}
		3887
		3888	{
		3889	# configure IO::AIO
		3890
		3891	IO::AIO::min_parallel 8;
		3892	IO::AIO::max_poll_time $TICK * 0.1;
		3893	undef $AnyEvent::AIO::WATCHER;
		3894	}
		3895
		3896	my $_log_backtrace;
		3897
		3898	sub _log_backtrace {
		3899	my ($msg, @addr) = @_;
		3900
		3901	$msg =~ s/\n//;
		3902
		3903	# limit the # of concurrent backtraces
		3904	if ($_log_backtrace < 2) {
		3905	++$_log_backtrace;
		3906	my $perl_bt = Carp::longmess $msg;
		3907	async {
		3908	$Coro::current->{desc} = "abt $msg";
		3909
		3910	my @bt = fork_call {
		3911	@addr = map { sprintf "%x", $_ } @addr;
		3912	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3913	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3914	or die "addr2line: $!";
		3915
		3916	my @funcs;
		3917	my @res = <$fh>;
		3918	chomp for @res;
		3919	while (@res) {
		3920	my ($func, $line) = splice @res, 0, 2, ();
		3921	push @funcs, "[$func] $line";
		3922	}
		3923
		3924	@funcs
		3925	};
		3926
		3927	LOG llevInfo, "[ABT] $perl_bt\n";
		3928	LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
		3929	LOG llevInfo, "[ABT] $_\n" for @bt;
		3930	--$_log_backtrace;
		3931	};
		3932	} else {
		3933	LOG llevInfo, "[ABT] $msg\n";
		3934	LOG llevInfo, "[ABT] [suppressed]\n";
		3935	}
		3936	}
		3937
		3938	# load additional modules
		3939	use cf::pod;
		3940
		3941	END { cf::emergency_save }
2055		3942
2056	1	3943	1
2057		3944

Diff Legend

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