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.475 by root, Tue Jul 21 06:17:00 2009 UTC

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

Diff Legend

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