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

Diff Legend

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