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.144 by root, Sun Jan 7 18:01:10 2007 UTC vs.
Revision 1.458 by root, Sat Dec 13 20:34:37 2008 UTC

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

Diff Legend

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