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

Diff Legend

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