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.139 by root, Fri Jan 5 19:12:03 2007 UTC vs.
Revision 1.433 by root, Sat May 10 22:38:52 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::EV;
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;
		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 (Coro::PRIO_MAX); # 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) {
268	unless (Coro::cede) {	494	if (Coro::nready) {
269	Coro::nready ? Event::one_event 0 : Event::one_event;
270	Coro::cede_notself unless Coro::cede;	495	Coro::cede_notself;
		496	} else {
		497	EV::loop EV::LOOP_ONESHOT;
271	}	498	}
272	}	499	}
		500
		501	my $time = EV::time - $time;
		502
		503	$TICK_START += $time; # do not account sync jobs to server load
273		504
274	wantarray ? @res : $res[0]	505	wantarray ? @res : $res[0]
275	} else {	506	} else {
276	# we are in another coroutine, how wonderful, everything just works	507	# we are in another coroutine, how wonderful, everything just works
277		508
278	$job->()	509	$job->()
279	}	510	}
280	}	511	}
281		512
282	=item $coro = cf::coro { BLOCK }	513	=item $coro = cf::async_ext { BLOCK }
283		514
284	Creates (and readies) and returns a new coro. This coro is automcatially	515	Like async, but this coro is automatically being canceled when the
285	being canceled when the extension calling this is being unloaded.	516	extension calling this is being unloaded.
286		517
287	=cut	518	=cut
288		519
289	sub coro(&) {	520	sub async_ext(&) {
290	my $cb = shift;	521	my $cb = shift;
291		522
292	my $coro = &Coro::async_pool ($cb);	523	my $coro = &Coro::async ($cb);
293		524
294	$coro->on_destroy (sub {	525	$coro->on_destroy (sub {
295	delete $EXT_CORO{$coro+0};	526	delete $EXT_CORO{$coro+0};
296	});	527	});
297	$EXT_CORO{$coro+0} = $coro;	528	$EXT_CORO{$coro+0} = $coro;
298		529
299	$coro	530	$coro
300	}	531	}
301		532
302	sub write_runtime {	533	=item fork_call { }, $args
303	my $runtime = cf::localdir . "/runtime";
304		534
305	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	535	Executes the given code block with the given arguments in a seperate
306	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.
307		539
308	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	540	=cut
309	(aio_write $fh, 0, (length $value), $value, 0) <= 0
310	and return;
311		541
312	aio_fsync $fh	542	sub fork_call(&@) {
313	and return;	543	my ($cb, @args) = @_;
314		544
315	close $fh	545	# we seemingly have to make a local copy of the whole thing,
316	or return;	546	# otherwise perl prematurely frees the stuff :/
		547	# TODO: investigate and fix (likely this will be rather laborious)
317		548
318	aio_rename "$runtime~", $runtime	549	my @res = Coro::Util::fork_eval {
319	and return;	550	reset_signals;
		551	&$cb
		552	}, @args;
320		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
321	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 });
322	}	720	}
323		721
324	=back	722	=back
325		723
326	=cut	724	=cut
327
328	#############################################################################
329
330	package cf::path;
331
332	sub new {
333	my ($class, $path, $base) = @_;
334
335	$path = $path->as_string if ref $path;
336
337	my $self = bless { }, $class;
338
339	# {... are special paths that are not touched
340	# ?xxx/... are special absolute paths
341	# ?random/... random maps
342	# /! non-realised random map exit
343	# /... normal maps
344	# ~/... per-player maps without a specific player (DO NOT USE)
345	# ~user/... per-player map of a specific user
346
347	if ($path =~ /^{/) {
348	# fine as it is
349	} elsif ($path =~ s{^\?random/}{}) {
350	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
351	$self->{random} = cf::from_json $data;
352	} else {
353	if ($path =~ s{^~([^/]+)?}{}) {
354	$self->{user_rel} = 1;
355
356	if (defined $1) {
357	$self->{user} = $1;
358	} elsif ($base =~ m{^~([^/]+)/}) {
359	$self->{user} = $1;
360	} else {
361	warn "cannot resolve user-relative path without user <$path,$base>\n";
362	}
363	} elsif ($path =~ /^\//) {
364	# already absolute
365	} else {
366	$base =~ s{[^/]+/?$}{};
367	return $class->new ("$base/$path");
368	}
369
370	for ($path) {
371	redo if s{/\.?/}{/};
372	redo if s{/[^/]+/\.\./}{/};
373	}
374	}
375
376	$self->{path} = $path;
377
378	$self
379	}
380
381	# the name / primary key / in-game path
382	sub as_string {
383	my ($self) = @_;
384
385	$self->{user_rel} ? "~$self->{user}$self->{path}"
386	: $self->{random} ? "?random/$self->{path}"
387	: $self->{path}
388	}
389
390	# the displayed name, this is a one way mapping
391	sub visible_name {
392	my ($self) = @_;
393
394	# if (my $rmp = $self->{random}) {
395	# # todo: be more intelligent about this
396	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
397	# } else {
398	$self->as_string
399	# }
400	}
401
402	# escape the /'s in the path
403	sub _escaped_path {
404	# ∕ is U+2215
405	(my $path = $_[0]{path}) =~ s/\//∕/g;
406	$path
407	}
408
409	# the original (read-only) location
410	sub load_path {
411	my ($self) = @_;
412
413	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
414	}
415
416	# the temporary/swap location
417	sub save_path {
418	my ($self) = @_;
419
420	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
421	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
422	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
423	}
424
425	# the unique path, might be eq to save_path
426	sub uniq_path {
427	my ($self) = @_;
428
429	$self->{user_rel} || $self->{random}
430	? undef
431	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
432	}
433
434	# return random map parameters, or undef
435	sub random_map_params {
436	my ($self) = @_;
437
438	$self->{random}
439	}
440
441	# this is somewhat ugly, but style maps do need special treatment
442	sub is_style_map {
443	$_[0]{path} =~ m{^/styles/}
444	}
445
446	package cf;
447		725
448	#############################################################################	726	#############################################################################
449		727
450	=head2 ATTACHABLE OBJECTS	728	=head2 ATTACHABLE OBJECTS
451		729
…		…
453	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")
454	to it. All such attachable objects support the following methods.	732	to it. All such attachable objects support the following methods.
455		733
456	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>
457	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
458	crossfire+).	736	Deliantra).
459		737
460	=over 4	738	=over 4
461		739
462	=item $attachable->attach ($attachment, key => $value...)	740	=item $attachable->attach ($attachment, key => $value...)
463		741
…		…
577	our @CB_TYPE = (); # registry for type (cf-object class) based events	855	our @CB_TYPE = (); # registry for type (cf-object class) based events
578	our @CB_MAP = ();	856	our @CB_MAP = ();
579		857
580	my %attachment;	858	my %attachment;
581		859
		860	sub cf::attachable::thawer_merge {
		861	# simply override everything except _meta
		862	local $_[0]{_meta};
		863	%{$_[0]} = %{$_[1]};
		864	}
		865
582	sub _attach_cb($$$$) {	866	sub _attach_cb($$$$) {
583	my ($registry, $event, $prio, $cb) = @_;	867	my ($registry, $event, $prio, $cb) = @_;
584		868
585	use sort 'stable';	869	use sort 'stable';
586		870
…		…
620	$registry = $CB_TYPE[$object_type] ||= [];	904	$registry = $CB_TYPE[$object_type] ||= [];
621		905
622	} elsif ($type eq "subtype") {	906	} elsif ($type eq "subtype") {
623	defined $object_type or Carp::croak "subtype specified without type";	907	defined $object_type or Carp::croak "subtype specified without type";
624	my $object_subtype = shift @arg;	908	my $object_subtype = shift @arg;
625	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	909	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
626		910
627	} elsif ($type eq "package") {	911	} elsif ($type eq "package") {
628	my $pkg = shift @arg;	912	my $pkg = shift @arg;
629		913
630	while (my ($name, $id) = each %cb_id) {	914	while (my ($name, $id) = each %cb_id) {
…		…
659	_attach $registry, $klass, @attach;	943	_attach $registry, $klass, @attach;
660	}	944	}
661		945
662	$obj->{$name} = \%arg;	946	$obj->{$name} = \%arg;
663	} else {	947	} else {
664	warn "object uses attachment '$name' that is not available, postponing.\n";	948	warn "object uses attachment '$name' which is not available, postponing.\n";
665	}	949	}
666		950
667	$obj->{_attachment}{$name} = undef;	951	$obj->{_attachment}{$name} = undef;
668	}	952	}
669		953
…		…
671	if (ref $_[0]) {	955	if (ref $_[0]) {
672	_object_attach @_;	956	_object_attach @_;
673	} else {	957	} else {
674	_attach shift->_attach_registry, @_;	958	_attach shift->_attach_registry, @_;
675	}	959	}
		960	_recalc_want;
676	};	961	};
677		962
678	# all those should be optimised	963	# all those should be optimised
679	sub cf::attachable::detach {	964	sub cf::attachable::detach {
680	my ($obj, $name) = @_;	965	my ($obj, $name) = @_;
…		…
683	delete $obj->{_attachment}{$name};	968	delete $obj->{_attachment}{$name};
684	reattach ($obj);	969	reattach ($obj);
685	} else {	970	} else {
686	Carp::croak "cannot, currently, detach class attachments";	971	Carp::croak "cannot, currently, detach class attachments";
687	}	972	}
		973	_recalc_want;
688	};	974	};
689		975
690	sub cf::attachable::attached {	976	sub cf::attachable::attached {
691	my ($obj, $name) = @_;	977	my ($obj, $name) = @_;
692		978
…		…
707	";	993	";
708	die if $@;	994	die if $@;
709	}	995	}
710		996
711	our $override;	997	our $override;
712	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?
713		999
714	sub override {	1000	sub override {
715	$override = 1;	1001	$override = 1;
716	@invoke_results = ();	1002	@INVOKE_RESULTS = (@_);
717	}	1003	}
718		1004
719	sub do_invoke {	1005	sub do_invoke {
720	my $event = shift;	1006	my $event = shift;
721	my $callbacks = shift;	1007	my $callbacks = shift;
722		1008
723	@invoke_results = ();	1009	@INVOKE_RESULTS = ();
724		1010
725	local $override;	1011	local $override;
726		1012
727	for (@$callbacks) {	1013	for (@$callbacks) {
728	eval { &{$_->[1]} };	1014	eval { &{$_->[1]} };
…		…
737	}	1023	}
738		1024
739	0	1025	0
740	}	1026	}
741		1027
742	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1028	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
743		1029
744	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1030	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
745		1031
746	Generate an object-specific event with the given arguments.	1032	Generate an object-specific event with the given arguments.
747		1033
748	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
749	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
750	results (if you must, access C<@cf::invoke_results> directly).	1036	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
751		1037
752	=back	1038	=back
753		1039
754	=cut	1040	=cut
755		1041
756	#############################################################################	1042	#############################################################################
757	# 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	}
758		1086
759	sub reattach {	1087	sub reattach {
760	# basically do the same as instantiate, without calling instantiate	1088	# basically do the same as instantiate, without calling instantiate
761	my ($obj) = @_;	1089	my ($obj) = @_;
		1090
		1091	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
762		1092
763	my $registry = $obj->registry;	1093	my $registry = $obj->registry;
764		1094
765	@$registry = ();	1095	@$registry = ();
766		1096
…		…
781	cf::attachable->attach (	1111	cf::attachable->attach (
782	prio => -1000000,	1112	prio => -1000000,
783	on_instantiate => sub {	1113	on_instantiate => sub {
784	my ($obj, $data) = @_;	1114	my ($obj, $data) = @_;
785		1115
786	$data = from_json $data;	1116	$data = decode_json $data;
787		1117
788	for (@$data) {	1118	for (@$data) {
789	my ($name, $args) = @$_;	1119	my ($name, $args) = @$_;
790		1120
791	$obj->attach ($name, %{$args || {} });	1121	$obj->attach ($name, %{$args || {} });
…		…
807	sub object_freezer_save {	1137	sub object_freezer_save {
808	my ($filename, $rdata, $objs) = @_;	1138	my ($filename, $rdata, $objs) = @_;
809		1139
810	sync_job {	1140	sync_job {
811	if (length $$rdata) {	1141	if (length $$rdata) {
		1142	utf8::decode (my $decname = $filename);
812	warn sprintf "saving %s (%d,%d)\n",	1143	warn sprintf "saving %s (%d,%d)\n",
813	$filename, length $$rdata, scalar @$objs;	1144	$decname, length $$rdata, scalar @$objs;
814		1145
815	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1146	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
816	chmod SAVE_MODE, $fh;	1147	aio_chmod $fh, SAVE_MODE;
817	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1148	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
818	aio_fsync $fh;	1149	aio_fsync $fh if $cf::USE_FSYNC;
819	close $fh;	1150	aio_close $fh;
820		1151
821	if (@$objs) {	1152	if (@$objs) {
822	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) {
823	chmod SAVE_MODE, $fh;	1154	aio_chmod $fh, SAVE_MODE;
824	my $data = Storable::nfreeze { version => 1, objs => $objs };	1155	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
825	aio_write $fh, 0, (length $data), $data, 0;	1156	aio_write $fh, 0, (length $data), $data, 0;
826	aio_fsync $fh;	1157	aio_fsync $fh if $cf::USE_FSYNC;
827	close $fh;	1158	aio_close $fh;
828	aio_rename "$filename.pst~", "$filename.pst";	1159	aio_rename "$filename.pst~", "$filename.pst";
829	}	1160	}
830	} else {	1161	} else {
831	aio_unlink "$filename.pst";	1162	aio_unlink "$filename.pst";
832	}	1163	}
…		…
837	}	1168	}
838	} else {	1169	} else {
839	aio_unlink $filename;	1170	aio_unlink $filename;
840	aio_unlink "$filename.pst";	1171	aio_unlink "$filename.pst";
841	}	1172	}
842	}	1173	};
843	}	1174	}
844		1175
845	sub object_freezer_as_string {	1176	sub object_freezer_as_string {
846	my ($rdata, $objs) = @_;	1177	my ($rdata, $objs) = @_;
847		1178
…		…
859	or return;	1190	or return;
860		1191
861	unless (aio_stat "$filename.pst") {	1192	unless (aio_stat "$filename.pst") {
862	(aio_load "$filename.pst", $av) >= 0	1193	(aio_load "$filename.pst", $av) >= 0
863	or return;	1194	or return;
		1195
864	$av = eval { (Storable::thaw $av)->{objs} };	1196	my $st = eval { Coro::Storable::thaw $av };
		1197	$av = $st->{objs};
865	}	1198	}
866		1199
		1200	utf8::decode (my $decname = $filename);
867	warn sprintf "loading %s (%d)\n",	1201	warn sprintf "loading %s (%d,%d)\n",
868	$filename, length $data, scalar @{$av || []};#d#	1202	$decname, length $data, scalar @{$av || []};
		1203
869	return ($data, $av);	1204	($data, $av)
870	}	1205	}
		1206
		1207	=head2 COMMAND CALLBACKS
		1208
		1209	=over 4
		1210
		1211	=cut
871		1212
872	#############################################################################	1213	#############################################################################
873	# command handling &c	1214	# command handling &c
874		1215
875	=item cf::register_command $name => \&callback($ob,$args);	1216	=item cf::register_command $name => \&callback($ob,$args);
…		…
888	push @{ $COMMAND{$name} }, [$caller, $cb];	1229	push @{ $COMMAND{$name} }, [$caller, $cb];
889	}	1230	}
890		1231
891	=item cf::register_extcmd $name => \&callback($pl,$packet);	1232	=item cf::register_extcmd $name => \&callback($pl,$packet);
892		1233
893	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.
894		1239
895	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
896	called.	1241	called.
897		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
898	=cut	1254	=cut
899		1255
900	sub register_extcmd {	1256	sub register_extcmd {
901	my ($name, $cb) = @_;	1257	my ($name, $cb) = @_;
902		1258
903	my $caller = caller;
904	#warn "registering extcmd '$name' to '$caller'";
905
906	$EXTCMD{$name} = [$cb, $caller];	1259	$EXTCMD{$name} = $cb;
		1260	}
		1261
		1262	sub register_exticmd {
		1263	my ($name, $cb) = @_;
		1264
		1265	$EXTICMD{$name} = $cb;
907	}	1266	}
908		1267
909	cf::player->attach (	1268	cf::player->attach (
910	on_command => sub {	1269	on_command => sub {
911	my ($pl, $name, $params) = @_;	1270	my ($pl, $name, $params) = @_;
…		…
920	cf::override;	1279	cf::override;
921	},	1280	},
922	on_extcmd => sub {	1281	on_extcmd => sub {
923	my ($pl, $buf) = @_;	1282	my ($pl, $buf) = @_;
924		1283
925	my $msg = eval { from_json $buf };	1284	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
926		1285
927	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
928	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1294	if (my $cb = $EXTCMD{$type}) {
929	if (my %reply = $cb->[0]->($pl, $msg)) {	1295	@reply = $cb->($pl, @payload);
930	$pl->ext_reply ($msg->{msgid}, %reply);
931	}
932	}	1296	}
		1297
		1298	$pl->ext_reply ($reply, @reply)
		1299	if $reply;
		1300
933	} else {	1301	} else {
934	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1302	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
935	}	1303	}
936		1304
937	cf::override;	1305	cf::override;
938	},	1306	},
939	);	1307	);
940		1308
941	sub register {
942	my ($base, $pkg) = @_;
943
944	#TODO
945	}
946
947	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($) {
948	my ($path) = @_;	1753	my ($path) = @_;
949		1754
950	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1755	my ($match, $specificity);
951	my $base = $1;
952	my $pkg = $1;
953	$pkg =~ s/[^[:word:]]/_/g;
954	$pkg = "ext::$pkg";
955		1756
956	warn "loading '$path' into '$pkg'\n";	1757	for my $region (list) {
957		1758	if ($region->{match} && $path =~ $region->{match}) {
958	open my $fh, "<:utf8", $path	1759	($match, $specificity) = ($region, $region->specificity)
959	or die "$path: $!";	1760	if $region->specificity > $specificity;
960		1761	}
961	my $source =
962	"package $pkg; use strict; use utf8;\n"
963	. "#line 1 \"$path\"\n{\n"
964	. (do { local $/; <$fh> })
965	. "\n};\n1";
966
967	eval $source
968	or die $@ ? "$path: $@\n"
969	: "extension disabled.\n";
970
971	push @exts, $pkg;
972	$ext_pkg{$base} = $pkg;
973
974	# no strict 'refs';
975	# @{"$pkg\::ISA"} = ext::;
976
977	register $base, $pkg;
978	}
979
980	sub unload_extension {
981	my ($pkg) = @_;
982
983	warn "removing extension $pkg\n";
984
985	# remove hooks
986	#TODO
987	# for my $idx (0 .. $#PLUGIN_EVENT) {
988	# delete $hook[$idx]{$pkg};
989	# }	1762	}
990		1763
991	# remove commands	1764	$match
992	for my $name (keys %COMMAND) {
993	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
994
995	if (@cb) {
996	$COMMAND{$name} = \@cb;
997	} else {
998	delete $COMMAND{$name};
999	}
1000	}
1001
1002	# remove extcmds
1003	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1004	delete $EXTCMD{$name};
1005	}
1006
1007	if (my $cb = $pkg->can ("unload")) {
1008	eval {
1009	$cb->($pkg);
1010	1
1011	} or warn "$pkg unloaded, but with errors: $@";
1012	}
1013
1014	Symbol::delete_package $pkg;
1015	}
1016
1017	sub load_extensions {
1018	for my $ext (<$LIBDIR/*.ext>) {
1019	next unless -r $ext;
1020	eval {
1021	load_extension $ext;
1022	1
1023	} or warn "$ext not loaded: $@";
1024	}
1025	}
1026
1027	#############################################################################
1028	# load/save/clean perl data associated with a map
1029
1030	*cf::mapsupport::on_clean = sub {
1031	my ($map) = @_;
1032
1033	my $path = $map->tmpname;
1034	defined $path or return;
1035
1036	unlink "$path.pst";
1037	};
1038
1039	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1040
1041	#############################################################################
1042	# load/save perl data associated with player->ob objects
1043
1044	sub all_objects(@) {
1045	@_, map all_objects ($_->inv), @_
1046	}
1047
1048	# TODO: compatibility cruft, remove when no longer needed
1049	cf::player->attach (
1050	on_load => sub {
1051	my ($pl, $path) = @_;
1052
1053	for my $o (all_objects $pl->ob) {
1054	if (my $value = $o->get_ob_key_value ("_perl_data")) {
1055	$o->set_ob_key_value ("_perl_data");
1056
1057	%$o = %{ Storable::thaw pack "H*", $value };
1058	}
1059	}
1060	},
1061	);
1062
1063	#############################################################################
1064
1065	=head2 CORE EXTENSIONS
1066
1067	Functions and methods that extend core crossfire objects.
1068
1069	=head3 cf::player
1070
1071	=over 4
1072
1073	=item cf::player::exists $login
1074
1075	Returns true when the given account exists.
1076
1077	=cut
1078
1079	sub cf::player::exists($) {
1080	cf::player::find $_[0]
1081	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1082	}
1083
1084	=item $player->ext_reply ($msgid, $msgtype, %msg)
1085
1086	Sends an ext reply to the player.
1087
1088	=cut
1089
1090	sub cf::player::ext_reply($$$%) {
1091	my ($self, $id, %msg) = @_;
1092
1093	$msg{msgid} = $id;
1094
1095	$self->send ("ext " . to_json \%msg);
1096	}	1765	}
1097		1766
1098	=back	1767	=back
1099
1100		1768
1101	=head3 cf::map	1769	=head3 cf::map
1102		1770
1103	=over 4	1771	=over 4
1104		1772
…		…
1107	package cf::map;	1775	package cf::map;
1108		1776
1109	use Fcntl;	1777	use Fcntl;
1110	use Coro::AIO;	1778	use Coro::AIO;
1111		1779
		1780	use overload
		1781	'""' => \&as_string,
		1782	fallback => 1;
		1783
1112	our $MAX_RESET = 3600;	1784	our $MAX_RESET = 3600;
1113	our $DEFAULT_RESET = 3000;	1785	our $DEFAULT_RESET = 3000;
1114		1786
1115	sub generate_random_map {	1787	sub generate_random_map {
1116	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
1117		1791
1118	# mit "rum" bekleckern, nicht	1792	# mit "rum" bekleckern, nicht
1119	cf::map::_create_random_map	1793	$self->_create_random_map (
1120	$path,
1121	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1794	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1122	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1795	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1123	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1796	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1124	$rmp->{exit_on_final_map},	1797	$rmp->{exit_on_final_map},
1125	$rmp->{xsize}, $rmp->{ysize},	1798	$rmp->{xsize}, $rmp->{ysize},
1126	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1799	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1127	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1800	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1128	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1801	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1129	$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},
1130	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1803	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1131	(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"
1132	}	1933	}
1133		1934
1134	# and all this just because we cannot iterate over	1935	# and all this just because we cannot iterate over
1135	# all maps in C++...	1936	# all maps in C++...
1136	sub change_all_map_light {	1937	sub change_all_map_light {
…		…
1138		1939
1139	$_->change_map_light ($change)	1940	$_->change_map_light ($change)
1140	for grep $_->outdoor, values %cf::MAP;	1941	for grep $_->outdoor, values %cf::MAP;
1141	}	1942	}
1142		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
1143	sub try_load_header($) {	1960	sub load_header_from($) {
1144	my ($path) = @_;	1961	my ($self, $path) = @_;
1145		1962
1146	utf8::encode $path;	1963	utf8::encode $path;
1147	aio_open $path, O_RDONLY, 0	1964	my $f = new_from_file cf::object::thawer $path
1148	or return;	1965	or return;
1149		1966
1150	my $map = cf::map::new	1967	$self->_load_header ($f)
1151	or return;	1968	or return;
1152		1969
1153	# for better error messages only, will be overwritten	1970	local $MAP_LOADING{$self->{path}} = $self;
1154	$map->path ($path);	1971	$f->resolve_delayed_derefs;
1155		1972
1156	$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
1157	or return;	2016	or return;
		2017	$self->prepare_orig;
		2018	}
1158		2019
1159	$map->{load_path} = $path;	2020	$self->{deny_reset} = 1
		2021	if $self->no_reset;
1160		2022
1161	$map	2023	$self->default_region (cf::region::find_by_path $self->{path})
		2024	unless $self->default_region;
		2025
		2026	1
1162	}	2027	}
1163		2028
1164	sub find;	2029	sub find;
1165	sub find {	2030	sub find {
1166	my ($path, $origin) = @_;	2031	my ($path, $origin) = @_;
1167		2032
1168	#warn "find<$path,$origin>\n";#d#
1169
1170	$path = new cf::path $path, $origin && $origin->path;	2033	$path = normalise $path, $origin && $origin->path;
1171	my $key = $path->as_string;
1172		2034
		2035	cf::lock_wait "map_data:$path";#d#remove
1173	cf::lock_wait "map_find:$key";	2036	cf::lock_wait "map_find:$path";
1174		2037
1175	$cf::MAP{$key} || do {	2038	$cf::MAP{$path} || do {
		2039	my $guard1 = cf::lock_acquire "map_data:$path"; # just for the fun of it
1176	my $guard = cf::lock_acquire "map_find:$key";	2040	my $guard2 = cf::lock_acquire "map_find:$path";
1177		2041
1178	# do it the slow way	2042	my $map = new_from_path cf::map $path
1179	my $map = try_load_header $path->save_path;
1180
1181	Coro::cede;
1182
1183	if ($map) {
1184	$map->last_access ((delete $map->{last_access})
1185	|| $cf::RUNTIME); #d#
1186	# safety
1187	$map->{instantiate_time} = $cf::RUNTIME
1188	if $map->{instantiate_time} > $cf::RUNTIME;
1189	} else {
1190	if (my $rmp = $path->random_map_params) {
1191	$map = generate_random_map $key, $rmp;
1192	} else {
1193	$map = try_load_header $path->load_path;
1194	}
1195
1196	$map or return;	2043	or return;
1197		2044
1198	$map->{load_original} = 1;
1199	$map->{instantiate_time} = $cf::RUNTIME;
1200	$map->last_access ($cf::RUNTIME);
1201	$map->instantiate;
1202
1203	# per-player maps become, after loading, normal maps
1204	$map->per_player (0) if $path->{user_rel};
1205	}
1206
1207	$map->path ($key);
1208	$map->{path} = $path;
1209	$map->{last_save} = $cf::RUNTIME;	2045	$map->{last_save} = $cf::RUNTIME;
1210		2046
1211	Coro::cede;	2047	$map->load_header
		2048	or return;
1212		2049
1213	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;
1214	$map->reset;	2055	$map->reset;
1215	undef $guard;
1216	$map = find $path	2056	return find $path;
1217	or return;
1218	}	2057	}
1219		2058
1220	$cf::MAP{$key} = $map	2059	$cf::MAP{$path} = $map
1221	}	2060	}
1222	}	2061	}
		2062
		2063	sub pre_load { }
		2064	sub post_load { }
1223		2065
1224	sub load {	2066	sub load {
1225	my ($self) = @_;	2067	my ($self) = @_;
1226		2068
		2069	local $self->{deny_reset} = 1; # loading can take a long time
		2070
1227	my $path = $self->{path};	2071	my $path = $self->{path};
		2072
		2073	{
1228	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	2074	my $guard = cf::lock_acquire "map_data:$path";
1229		2075
		2076	return unless $self->valid;
1230	return if $self->in_memory != cf::MAP_SWAPPED;	2077	return unless $self->in_memory == cf::MAP_SWAPPED;
1231		2078
1232	$self->in_memory (cf::MAP_LOADING);	2079	$self->in_memory (cf::MAP_LOADING);
1233		2080
1234	$self->alloc;	2081	$self->alloc;
1235	$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)
1236	or return;	2089	or return;
1237		2090
1238	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2091	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1239	if delete $self->{load_original};	2092	if delete $self->{load_original};
1240		2093
1241	if (my $uniq = $path->uniq_path) {	2094	if (my $uniq = $self->uniq_path) {
1242	utf8::encode $uniq;	2095	utf8::encode $uniq;
1243	if (aio_open $uniq, O_RDONLY, 0) {	2096	unless (aio_stat $uniq) {
		2097	if (my $f = new_from_file cf::object::thawer $uniq) {
1244	$self->clear_unique_items;	2098	$self->clear_unique_items;
1245	$self->load_objects ($uniq, 0);	2099	$self->_load_objects ($f);
		2100	$f->resolve_delayed_derefs;
		2101	}
1246	}	2102	}
1247	}	2103	}
1248		2104
1249	Coro::cede;	2105	$f->resolve_delayed_derefs;
1250		2106
		2107	cf::cede_to_tick;
1251	# now do the right thing for maps	2108	# now do the right thing for maps
1252	$self->link_multipart_objects;	2109	$self->link_multipart_objects;
1253
1254	if ($self->{path}->is_style_map) {
1255	$self->{deny_save} = 1;
1256	$self->{deny_reset} = 1;
1257	} else {
1258	$self->fix_auto_apply;
1259	$self->decay_objects;
1260	$self->update_buttons;
1261	$self->set_darkness_map;
1262	$self->difficulty ($self->estimate_difficulty)	2110	$self->difficulty ($self->estimate_difficulty)
1263	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;
1264	$self->activate;	2121	$self->activate;
1265	}	2122	}
1266		2123
1267	Coro::cede;	2124	$self->{last_save} = $cf::RUNTIME;
		2125	$self->last_access ($cf::RUNTIME);
1268		2126
1269	$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	}
1270	}	2169	}
1271		2170
1272	sub find_sync {	2171	sub find_sync {
1273	my ($path, $origin) = @_;	2172	my ($path, $origin) = @_;
1274		2173
1275	cf::sync_job {	2174	cf::sync_job { find $path, $origin }
1276	my $map = cf::map::find $path, $origin;
1277	$map
1278	}
1279	}	2175	}
1280		2176
1281	sub do_load_sync {	2177	sub do_load_sync {
1282	my ($map) = @_;	2178	my ($map) = @_;
1283		2179
		2180	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2181	if $Coro::current == $Coro::main;
		2182
1284	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	()
1285	}	2217	}
1286		2218
1287	sub save {	2219	sub save {
1288	my ($self) = @_;	2220	my ($self) = @_;
1289		2221
1290	my $lock = cf::lock_acquire "map_data:" . $self->path;	2222	my $lock = cf::lock_acquire "map_data:$self->{path}";
1291		2223
1292	$self->{last_save} = $cf::RUNTIME;	2224	$self->{last_save} = $cf::RUNTIME;
1293		2225
1294	return unless $self->dirty;	2226	return unless $self->dirty;
1295		2227
1296	my $save = $self->{path}->save_path; utf8::encode $save;	2228	my $save = $self->save_path; utf8::encode $save;
1297	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	2229	my $uniq = $self->uniq_path; utf8::encode $uniq;
1298		2230
1299	$self->{load_path} = $save;	2231	$self->{load_path} = $save;
1300		2232
1301	return if $self->{deny_save};	2233	return if $self->{deny_save};
1302		2234
1303	local $self->{last_access} = $self->last_access;#d#	2235	local $self->{last_access} = $self->last_access;#d#
1304		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
1305	if ($uniq) {	2244	if ($uniq) {
1306	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2245	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1307	$self->save_objects ($uniq, cf::IO_UNIQUES);	2246	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1308	} else {	2247	} else {
1309	$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);
1310	}	2249	}
1311	}	2250	}
1312		2251
1313	sub swap_out {	2252	sub swap_out {
1314	my ($self) = @_;	2253	my ($self) = @_;
1315		2254
1316	# save first because save cedes	2255	# save first because save cedes
1317	$self->save;	2256	$self->save;
1318		2257
1319	my $lock = cf::lock_acquire "map_data:" . $self->path;	2258	my $lock = cf::lock_acquire "map_data:$self->{path}";
1320		2259
1321	return if $self->players;	2260	return if $self->players;
1322	return if $self->in_memory != cf::MAP_IN_MEMORY;	2261	return if $self->in_memory != cf::MAP_ACTIVE;
1323	return if $self->{deny_save};	2262	return if $self->{deny_save};
1324		2263
		2264	$self->in_memory (cf::MAP_SWAPPED);
		2265
		2266	$self->deactivate;
		2267	$_->clear_links_to ($self) for values %cf::MAP;
1325	$self->clear;	2268	$self->clear;
1326	$self->in_memory (cf::MAP_SWAPPED);
1327	}	2269	}
1328		2270
1329	sub reset_at {	2271	sub reset_at {
1330	my ($self) = @_;	2272	my ($self) = @_;
1331		2273
1332	# TODO: safety, remove and allow resettable per-player maps	2274	# TODO: safety, remove and allow resettable per-player maps
1333	return 1e99 if $self->{path}{user_rel};
1334	return 1e99 if $self->{deny_reset};	2275	return 1e99 if $self->{deny_reset};
1335		2276
1336	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2277	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1337	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;
1338		2279
…		…
1343	my ($self) = @_;	2284	my ($self) = @_;
1344		2285
1345	$self->reset_at <= $cf::RUNTIME	2286	$self->reset_at <= $cf::RUNTIME
1346	}	2287	}
1347		2288
1348	sub unlink_save {
1349	my ($self) = @_;
1350
1351	utf8::encode (my $save = $self->{path}->save_path);
1352	aioreq_pri 3; IO::AIO::aio_unlink $save;
1353	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1354	}
1355
1356	sub rename {
1357	my ($self, $new_path) = @_;
1358
1359	$self->unlink_save;
1360
1361	delete $cf::MAP{$self->path};
1362	$self->{path} = new cf::path $new_path;
1363	$self->path ($self->{path}->as_string);
1364	$cf::MAP{$self->path} = $self;
1365
1366	$self->save;
1367	}
1368
1369	sub reset {	2289	sub reset {
1370	my ($self) = @_;	2290	my ($self) = @_;
1371		2291
1372	my $lock = cf::lock_acquire "map_data:" . $self->path;	2292	my $lock = cf::lock_acquire "map_data:$self->{path}";
1373		2293
1374	return if $self->players;	2294	return if $self->players;
1375	return if $self->{path}{user_rel};#d#
1376		2295
1377	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	}
1378		2307
1379	delete $cf::MAP{$self->path};	2308	delete $cf::MAP{$self->path};
1380		2309
		2310	$self->deactivate;
1381	$_->clear_links_to ($self) for values %cf::MAP;	2311	$_->clear_links_to ($self) for values %cf::MAP;
		2312	$self->clear;
1382		2313
1383	$self->unlink_save;	2314	$self->unlink_save;
1384	$self->destroy;	2315	$self->destroy;
1385	}	2316	}
1386		2317
1387	my $nuke_counter = "aaaa";	2318	my $nuke_counter = "aaaa";
1388		2319
1389	sub nuke {	2320	sub nuke {
1390	my ($self) = @_;	2321	my ($self) = @_;
1391		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};
1392	$self->{deny_save} = 1;	2332	$self->{deny_save} = 1;
1393	$self->reset_timeout (1);	2333	$self->reset_timeout (1);
1394	$self->rename ("{nuke}/" . ($nuke_counter++));	2334	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2335
		2336	$cf::MAP{$self->path} = $self;
		2337	}
		2338
1395	$self->reset; # polite request, might not happen	2339	$self->reset; # polite request, might not happen
1396	}	2340	}
1397		2341
1398	sub customise_for {	2342	=item $maps = cf::map::tmp_maps
1399	my ($map, $ob) = @_;
1400		2343
1401	if ($map->per_player) {	2344	Returns an arrayref with all map paths of currently instantiated and saved
1402	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	2345	maps. May block.
		2346
		2347	=cut
		2348
		2349	sub tmp_maps() {
1403	}	2350	[
1404		2351	map {
1405	$map	2352	utf8::decode $_;
		2353	/\.map$/
		2354	? normalise $_
		2355	: ()
		2356	} @{ aio_readdir $TMPDIR or [] }
		2357	]
1406	}	2358	}
1407		2359
1408	sub emergency_save {	2360	=item $maps = cf::map::random_maps
1409	my $freeze_guard = cf::freeze_mainloop;
1410		2361
1411	warn "enter emergency map save\n";	2362	Returns an arrayref with all map paths of currently instantiated and saved
		2363	random maps. May block.
1412		2364
1413	cf::sync_job {	2365	=cut
1414	warn "begin emergency map save\n";	2366
1415	$_->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
1416	};	2448	}
1417
1418	warn "end emergency map save\n";
1419	}	2449	}
1420		2450
1421	package cf;	2451	package cf;
1422		2452
1423	=back	2453	=back
1424
1425		2454
1426	=head3 cf::object::player	2455	=head3 cf::object::player
1427		2456
1428	=over 4	2457	=over 4
1429		2458
…		…
1432	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>
1433	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
1434	dialogue with the given NPC character.	2463	dialogue with the given NPC character.
1435		2464
1436	=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	};
1437		2480
1438	# rough implementation of a future "reply" method that works	2481	# rough implementation of a future "reply" method that works
1439	# with dialog boxes.	2482	# with dialog boxes.
1440	#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
1441	sub cf::object::player::reply($$$;$) {	2484	sub cf::object::player::reply($$$;$) {
…		…
1443		2486
1444	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2487	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1445		2488
1446	if ($self->{record_replies}) {	2489	if ($self->{record_replies}) {
1447	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2490	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2491
1448	} 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 {
1449	$msg = $npc->name . " says: $msg" if $npc;	2500	$msg = $npc->name . " says: $msg" if $npc;
1450	$self->message ($msg, $flags);	2501	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2502	}
1451	}	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 (@_);
1452	}	2514	}
1453		2515
1454	=item $player_object->may ("access")	2516	=item $player_object->may ("access")
1455		2517
1456	Returns wether the given player is authorized to access resource "access"	2518	Returns wether the given player is authorized to access resource "access"
…		…
1469		2531
1470	=item $player_object->enter_link	2532	=item $player_object->enter_link
1471		2533
1472	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}>).
1473		2535
1474	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
1475	I<MUST> call C<leave_link> as soon as possible, though.	2537	I<MUST> call C<leave_link> as soon as possible, though.
1476		2538
		2539	Will never block.
		2540
1477	=item $player_object->leave_link ($map, $x, $y)	2541	=item $player_object->leave_link ($map, $x, $y)
1478		2542
1479	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
1480	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
1481	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
1482	to the emergency map position.	2546	fails, to the emergency map position.
1483		2547
1484	Might block.	2548	Might block.
1485		2549
1486	=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	}
1487		2561
1488	sub cf::object::player::enter_link {	2562	sub cf::object::player::enter_link {
1489	my ($self) = @_;	2563	my ($self) = @_;
1490		2564
1491	$self->deactivate_recursive;	2565	$self->deactivate_recursive;
1492		2566
1493	return if $self->map == $LINK_MAP;	2567	return if UNIVERSAL::isa $self->map, "ext::map_link";
1494		2568
1495	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2569	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1496	if $self->map;	2570	if $self->map && $self->map->{path} ne "{link}";
1497		2571
1498	$self->enter_map ($LINK_MAP, 20, 20);	2572	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1499	}	2573	}
1500		2574
1501	sub cf::object::player::leave_link {	2575	sub cf::object::player::leave_link {
1502	my ($self, $map, $x, $y) = @_;	2576	my ($self, $map, $x, $y) = @_;
		2577
		2578	return unless $self->contr->active;
1503		2579
1504	my $link_pos = delete $self->{_link_pos};	2580	my $link_pos = delete $self->{_link_pos};
1505		2581
1506	unless ($map) {	2582	unless ($map) {
1507	# restore original map position	2583	# restore original map position
…		…
1521	# use -1 or undef as default coordinates, not 0, 0	2597	# use -1 or undef as default coordinates, not 0, 0
1522	($x, $y) = ($map->enter_x, $map->enter_y)	2598	($x, $y) = ($map->enter_x, $map->enter_y)
1523	if $x <=0 && $y <= 0;	2599	if $x <=0 && $y <= 0;
1524		2600
1525	$map->load;	2601	$map->load;
		2602	$map->load_neighbours;
1526		2603
		2604	return unless $self->contr->active;
1527	$self->activate_recursive;	2605	$self->activate_recursive;
		2606
		2607	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1528	$self->enter_map ($map, $x, $y);	2608	$self->enter_map ($map, $x, $y);
1529	}	2609	}
1530		2610
1531	cf::player->attach (	2611	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1532	on_logout => sub {
1533	my ($pl) = @_;
1534		2612
1535	# abort map switching before logout	2613	Moves the player to the given map-path and coordinates by first freezing
1536	if ($pl->ob->{_link_pos}) {	2614	her, loading and preparing them map, calling the provided $check callback
1537	cf::sync_job {	2615	that has to return the map if sucecssful, and then unfreezes the player on
1538	$pl->ob->leave_link	2616	the new (success) or old (failed) map position. In either case, $done will
1539	};	2617	be called at the end of this process.
1540	}
1541	},
1542	on_login => sub {
1543	my ($pl) = @_;
1544		2618
1545	# try to abort aborted map switching on player login :)
1546	# should happen only on crashes
1547	if ($pl->ob->{_link_pos}) {
1548
1549	$pl->ob->enter_link;
1550	(Coro::async_pool {
1551	# we need this sleep as the login has a concurrent enter_exit running
1552	# and this sleep increases chances of the player not ending up in scorn
1553	Coro::Timer::sleep 1;
1554	$pl->ob->leave_link;
1555	})->prio (2);
1556	}
1557	},
1558	);
1559
1560	=item $player_object->goto ($path, $x, $y)
1561
1562	=cut	2619	=cut
		2620
		2621	our $GOTOGEN;
1563		2622
1564	sub cf::object::player::goto {	2623	sub cf::object::player::goto {
1565	my ($self, $path, $x, $y) = @_;	2624	my ($self, $path, $x, $y, $check, $done) = @_;
		2625
		2626	# do generation counting so two concurrent goto's will be executed in-order
		2627	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1566		2628
1567	$self->enter_link;	2629	$self->enter_link;
1568		2630
1569	(Coro::async_pool {	2631	(async {
1570	$path = new cf::path $path;	2632	$Coro::current->{desc} = "player::goto $path $x $y";
1571		2633
1572	my $map = cf::map::find $path->as_string;	2634	# *tag paths override both path and x|y
		2635	if ($path =~ /^\*(.*)$/) {
		2636	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2637	my $ob = $obs[rand @obs];
		2638
		2639	# see if we actually can go there
		2640	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2641	$ob = $obs[rand @obs];
		2642	} else {
		2643	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2644	}
		2645	# else put us there anyways for now #d#
		2646
		2647	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2648	} else {
		2649	($path, $x, $y) = (undef, undef, undef);
		2650	}
		2651	}
		2652
		2653	my $map = eval {
		2654	my $map = defined $path ? cf::map::find $path : undef;
		2655
		2656	if ($map) {
1573	$map = $map->customise_for ($self) if $map;	2657	$map = $map->customise_for ($self);
1574		2658	$map = $check->($map) if $check && $map;
1575	# warn "entering ", $map->path, " at ($x, $y)\n"	2659	} else {
1576	# if $map;
1577
1578	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2660	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2661	}
1579		2662
		2663	$map
		2664	};
		2665
		2666	if ($@) {
		2667	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2668	LOG llevError | logBacktrace, Carp::longmess $@;
		2669	}
		2670
		2671	if ($gen == $self->{_goto_generation}) {
		2672	delete $self->{_goto_generation};
1580	$self->leave_link ($map, $x, $y);	2673	$self->leave_link ($map, $x, $y);
		2674	}
		2675
		2676	$done->() if $done;
1581	})->prio (1);	2677	})->prio (1);
1582	}	2678	}
1583		2679
1584	=item $player_object->enter_exit ($exit_object)	2680	=item $player_object->enter_exit ($exit_object)
1585		2681
…		…
1587		2683
1588	sub parse_random_map_params {	2684	sub parse_random_map_params {
1589	my ($spec) = @_;	2685	my ($spec) = @_;
1590		2686
1591	my $rmp = { # defaults	2687	my $rmp = { # defaults
1592	xsize => 10,	2688	xsize => (cf::rndm 15, 40),
1593	ysize => 10,	2689	ysize => (cf::rndm 15, 40),
		2690	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2691	#layout => string,
1594	};	2692	};
1595		2693
1596	for (split /\n/, $spec) {	2694	for (split /\n/, $spec) {
1597	my ($k, $v) = split /\s+/, $_, 2;	2695	my ($k, $v) = split /\s+/, $_, 2;
1598		2696
…		…
1610	# that depends on the exit object	2708	# that depends on the exit object
1611		2709
1612	my $rmp = parse_random_map_params $exit->msg;	2710	my $rmp = parse_random_map_params $exit->msg;
1613		2711
1614	if ($exit->map) {	2712	if ($exit->map) {
1615	$rmp->{region} = $exit->map->region_name;	2713	$rmp->{region} = $exit->region->name;
1616	$rmp->{origin_map} = $exit->map->path;	2714	$rmp->{origin_map} = $exit->map->path;
1617	$rmp->{origin_x} = $exit->x;	2715	$rmp->{origin_x} = $exit->x;
1618	$rmp->{origin_y} = $exit->y;	2716	$rmp->{origin_y} = $exit->y;
		2717
		2718	$exit->map->touch;
1619	}	2719	}
1620		2720
1621	$rmp->{random_seed} ||= $exit->random_seed;	2721	$rmp->{random_seed} ||= $exit->random_seed;
1622		2722
1623	my $data = cf::to_json $rmp;	2723	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1624	my $md5 = Digest::MD5::md5_hex $data;	2724	my $md5 = Digest::MD5::md5_hex $data;
		2725	my $meta = "$RANDOMDIR/$md5.meta";
1625		2726
1626	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2727	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1627	aio_write $fh, 0, (length $data), $data, 0;	2728	aio_write $fh, 0, (length $data), $data, 0;
		2729	undef $fh;
		2730	aio_rename "$meta~", $meta;
1628		2731
		2732	my $slaying = "?random/$md5";
		2733
		2734	if ($exit->valid) {
1629	$exit->slaying ("?random/$md5");	2735	$exit->slaying ("?random/$md5");
1630	$exit->msg (undef);	2736	$exit->msg (undef);
		2737	}
1631	}	2738	}
1632	}	2739	}
1633		2740
1634	sub cf::object::player::enter_exit {	2741	sub cf::object::player::enter_exit {
1635	my ($self, $exit) = @_;	2742	my ($self, $exit) = @_;
1636		2743
1637	return unless $self->type == cf::PLAYER;	2744	return unless $self->type == cf::PLAYER;
1638		2745
1639	$self->enter_link;	2746	$self->enter_link;
1640		2747
1641	(Coro::async_pool {	2748	(async {
1642	$self->deactivate_recursive; # just to be sure	2749	$Coro::current->{desc} = "enter_exit";
		2750
1643	unless (eval {	2751	unless (eval {
		2752	$self->deactivate_recursive; # just to be sure
		2753
		2754	# random map handling
		2755	{
		2756	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2757
1644	prepare_random_map $exit	2758	prepare_random_map $exit
1645	if $exit->slaying eq "/!";	2759	if $exit->slaying eq "/!";
		2760	}
1646		2761
1647	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;	2762	my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1648	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);	2763	my $x = $exit->stats->hp;
		2764	my $y = $exit->stats->sp;
1649		2765
		2766	$self->goto ($map, $x, $y);
		2767
		2768	# if exit is damned, update players death & WoR home-position
		2769	$self->contr->savebed ($map, $x, $y)
		2770	if $exit->flag (cf::FLAG_DAMNED);
		2771
1650	1;	2772	1
1651	}) {	2773	}) {
1652	$self->message ("Something went wrong deep within the crossfire server. "	2774	$self->message ("Something went wrong deep within the crossfire server. "
1653	. "I'll try to bring you back to the map you were before. "	2775	. "I'll try to bring you back to the map you were before. "
1654	. "Please report this to the dungeon master",	2776	. "Please report this to the dungeon master!",
1655	cf::NDI_UNIQUE | cf::NDI_RED);	2777	cf::NDI_UNIQUE | cf::NDI_RED);
1656		2778
1657	warn "ERROR in enter_exit: $@";	2779	warn "ERROR in enter_exit: $@";
1658	$self->leave_link;	2780	$self->leave_link;
1659	}	2781	}
1660	})->prio (1);	2782	})->prio (1);
…		…
1673		2795
1674	sub cf::client::send_drawinfo {	2796	sub cf::client::send_drawinfo {
1675	my ($self, $text, $flags) = @_;	2797	my ($self, $text, $flags) = @_;
1676		2798
1677	utf8::encode $text;	2799	utf8::encode $text;
1678	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2800	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1679	}	2801	}
1680		2802
		2803	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2804
		2805	Send a drawinfo or msg packet to the client, formatting the msg for the
		2806	client if neccessary. C<$type> should be a string identifying the type of
		2807	the message, with C<log> being the default. If C<$color> is negative, suppress
		2808	the message unless the client supports the msg packet.
		2809
		2810	=cut
		2811
		2812	# non-persistent channels (usually the info channel)
		2813	our %CHANNEL = (
		2814	"c/identify" => {
		2815	id => "infobox",
		2816	title => "Identify",
		2817	reply => undef,
		2818	tooltip => "Items recently identified",
		2819	},
		2820	"c/examine" => {
		2821	id => "infobox",
		2822	title => "Examine",
		2823	reply => undef,
		2824	tooltip => "Signs and other items you examined",
		2825	},
		2826	"c/book" => {
		2827	id => "infobox",
		2828	title => "Book",
		2829	reply => undef,
		2830	tooltip => "The contents of a note or book",
		2831	},
		2832	"c/lookat" => {
		2833	id => "infobox",
		2834	title => "Look",
		2835	reply => undef,
		2836	tooltip => "What you saw there",
		2837	},
		2838	"c/who" => {
		2839	id => "infobox",
		2840	title => "Players",
		2841	reply => undef,
		2842	tooltip => "Shows players who are currently online",
		2843	},
		2844	"c/body" => {
		2845	id => "infobox",
		2846	title => "Body Parts",
		2847	reply => undef,
		2848	tooltip => "Shows which body parts you posess and are available",
		2849	},
		2850	"c/uptime" => {
		2851	id => "infobox",
		2852	title => "Uptime",
		2853	reply => undef,
		2854	tooltip => "How long the server has been running since last restart",
		2855	},
		2856	"c/mapinfo" => {
		2857	id => "infobox",
		2858	title => "Map Info",
		2859	reply => undef,
		2860	tooltip => "Information related to the maps",
		2861	},
		2862	"c/party" => {
		2863	id => "party",
		2864	title => "Party",
		2865	reply => "gsay ",
		2866	tooltip => "Messages and chat related to your party",
		2867	},
		2868	);
		2869
		2870	sub cf::client::send_msg {
		2871	my ($self, $channel, $msg, $color, @extra) = @_;
		2872
		2873	$msg = $self->pl->expand_cfpod ($msg);
		2874
		2875	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2876
		2877	# check predefined channels, for the benefit of C
		2878	if ($CHANNEL{$channel}) {
		2879	$channel = $CHANNEL{$channel};
		2880
		2881	$self->ext_msg (channel_info => $channel)
		2882	if $self->can_msg;
		2883
		2884	$channel = $channel->{id};
		2885
		2886	} elsif (ref $channel) {
		2887	# send meta info to client, if not yet sent
		2888	unless (exists $self->{channel}{$channel->{id}}) {
		2889	$self->{channel}{$channel->{id}} = $channel;
		2890	$self->ext_msg (channel_info => $channel)
		2891	if $self->can_msg;
		2892	}
		2893
		2894	$channel = $channel->{id};
		2895	}
		2896
		2897	return unless @extra || length $msg;
		2898
		2899	if ($self->can_msg) {
		2900	# default colour, mask it out
		2901	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2902	if $color & cf::NDI_DEF;
		2903
		2904	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2905	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2906	} else {
		2907	if ($color >= 0) {
		2908	# replace some tags by gcfclient-compatible ones
		2909	for ($msg) {
		2910	1 while
		2911	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2912	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2913	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2914	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2915	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2916	}
		2917
		2918	$color &= cf::NDI_COLOR_MASK;
		2919
		2920	utf8::encode $msg;
		2921
		2922	if (0 && $msg =~ /\[/) {
		2923	# COMMAND/INFO
		2924	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2925	} else {
		2926	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2927	$self->send_packet ("drawinfo $color $msg")
		2928	}
		2929	}
		2930	}
		2931	}
		2932
		2933	=item $client->ext_msg ($type, @msg)
		2934
		2935	Sends an ext event to the client.
		2936
		2937	=cut
		2938
		2939	sub cf::client::ext_msg($$@) {
		2940	my ($self, $type, @msg) = @_;
		2941
		2942	if ($self->extcmd == 2) {
		2943	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2944	} elsif ($self->extcmd == 1) { # TODO: remove
		2945	push @msg, msgtype => "event_$type";
		2946	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2947	}
		2948	}
		2949
		2950	=item $client->ext_reply ($msgid, @msg)
		2951
		2952	Sends an ext reply to the client.
		2953
		2954	=cut
		2955
		2956	sub cf::client::ext_reply($$@) {
		2957	my ($self, $id, @msg) = @_;
		2958
		2959	if ($self->extcmd == 2) {
		2960	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2961	} elsif ($self->extcmd == 1) {
		2962	#TODO: version 1, remove
		2963	unshift @msg, msgtype => "reply", msgid => $id;
		2964	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2965	}
		2966	}
1681		2967
1682	=item $success = $client->query ($flags, "text", \&cb)	2968	=item $success = $client->query ($flags, "text", \&cb)
1683		2969
1684	Queues a query to the client, calling the given callback with	2970	Queues a query to the client, calling the given callback with
1685	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2971	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1686	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2972	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1687		2973
1688	Queries can fail, so check the return code. Or don't, as queries will become	2974	Queries can fail, so check the return code. Or don't, as queries will
1689	reliable at some point in the future.	2975	become reliable at some point in the future.
1690		2976
1691	=cut	2977	=cut
1692		2978
1693	sub cf::client::query {	2979	sub cf::client::query {
1694	my ($self, $flags, $text, $cb) = @_;	2980	my ($self, $flags, $text, $cb) = @_;
…		…
1702	utf8::encode $text;	2988	utf8::encode $text;
1703	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2989	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1704		2990
1705	$self->send_packet ($self->{query_queue}[0][0])	2991	$self->send_packet ($self->{query_queue}[0][0])
1706	if @{ $self->{query_queue} } == 1;	2992	if @{ $self->{query_queue} } == 1;
		2993
		2994	1
1707	}	2995	}
1708		2996
1709	cf::client->attach (	2997	cf::client->attach (
		2998	on_connect => sub {
		2999	my ($ns) = @_;
		3000
		3001	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		3002	},
1710	on_reply => sub {	3003	on_reply => sub {
1711	my ($ns, $msg) = @_;	3004	my ($ns, $msg) = @_;
1712		3005
1713	# this weird shuffling is so that direct followup queries	3006	# this weird shuffling is so that direct followup queries
1714	# get handled first	3007	# get handled first
1715	my $queue = delete $ns->{query_queue}	3008	my $queue = delete $ns->{query_queue}
1716	or return; # be conservative, not sure how that can happen, but we saw a crash here	3009	or return; # be conservative, not sure how that can happen, but we saw a crash here
1717		3010
1718	(shift @$queue)->[1]->($msg);	3011	(shift @$queue)->[1]->($msg);
		3012	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1719		3013
1720	push @{ $ns->{query_queue} }, @$queue;	3014	push @{ $ns->{query_queue} }, @$queue;
1721		3015
1722	if (@{ $ns->{query_queue} } == @$queue) {	3016	if (@{ $ns->{query_queue} } == @$queue) {
1723	if (@$queue) {	3017	if (@$queue) {
…		…
1725	} else {	3019	} else {
1726	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3020	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1727	}	3021	}
1728	}	3022	}
1729	},	3023	},
		3024	on_exticmd => sub {
		3025	my ($ns, $buf) = @_;
		3026
		3027	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		3028
		3029	if (ref $msg) {
		3030	my ($type, $reply, @payload) =
		3031	"ARRAY" eq ref $msg
		3032	? @$msg
		3033	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		3034
		3035	my @reply;
		3036
		3037	if (my $cb = $EXTICMD{$type}) {
		3038	@reply = $cb->($ns, @payload);
		3039	}
		3040
		3041	$ns->ext_reply ($reply, @reply)
		3042	if $reply;
		3043
		3044	} else {
		3045	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		3046	}
		3047
		3048	cf::override;
		3049	},
1730	);	3050	);
1731		3051
1732	=item $client->coro (\&cb)	3052	=item $client->async (\&cb)
1733		3053
1734	Create a new coroutine, running the specified callback. The coroutine will	3054	Create a new coroutine, running the specified callback. The coroutine will
1735	be automatically cancelled when the client gets destroyed (e.g. on logout,	3055	be automatically cancelled when the client gets destroyed (e.g. on logout,
1736	or loss of connection).	3056	or loss of connection).
1737		3057
1738	=cut	3058	=cut
1739		3059
1740	sub cf::client::coro {	3060	sub cf::client::async {
1741	my ($self, $cb) = @_;	3061	my ($self, $cb) = @_;
1742		3062
1743	my $coro = &Coro::async_pool ($cb);	3063	my $coro = &Coro::async ($cb);
1744		3064
1745	$coro->on_destroy (sub {	3065	$coro->on_destroy (sub {
1746	delete $self->{_coro}{$coro+0};	3066	delete $self->{_coro}{$coro+0};
1747	});	3067	});
1748		3068
…		…
1775	our $safe = new Safe "safe";	3095	our $safe = new Safe "safe";
1776	our $safe_hole = new Safe::Hole;	3096	our $safe_hole = new Safe::Hole;
1777		3097
1778	$SIG{FPE} = 'IGNORE';	3098	$SIG{FPE} = 'IGNORE';
1779		3099
1780	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3100	$safe->permit_only (Opcode::opset qw(
		3101	:base_core :base_mem :base_orig :base_math
		3102	grepstart grepwhile mapstart mapwhile
		3103	sort time
		3104	));
1781		3105
1782	# here we export the classes and methods available to script code	3106	# here we export the classes and methods available to script code
1783		3107
1784	=pod	3108	=pod
1785		3109
1786	The following fucntions and emthods are available within a safe environment:	3110	The following functions and methods are available within a safe environment:
1787		3111
1788	cf::object contr pay_amount pay_player map	3112	cf::object
		3113	contr pay_amount pay_player map x y force_find force_add destroy
		3114	insert remove name archname title slaying race decrease split
		3115
1789	cf::object::player player	3116	cf::object::player
1790	cf::player peaceful	3117	player
1791	cf::map trigger	3118
		3119	cf::player
		3120	peaceful
		3121
		3122	cf::map
		3123	trigger
1792		3124
1793	=cut	3125	=cut
1794		3126
1795	for (	3127	for (
1796	["cf::object" => qw(contr pay_amount pay_player map)],	3128	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3129	insert remove inv nrof name archname title slaying race
		3130	decrease split destroy)],
1797	["cf::object::player" => qw(player)],	3131	["cf::object::player" => qw(player)],
1798	["cf::player" => qw(peaceful)],	3132	["cf::player" => qw(peaceful)],
1799	["cf::map" => qw(trigger)],	3133	["cf::map" => qw(trigger)],
1800	) {	3134	) {
1801	no strict 'refs';	3135	no strict 'refs';
…		…
1872	=back	3206	=back
1873		3207
1874	=cut	3208	=cut
1875		3209
1876	#############################################################################	3210	#############################################################################
		3211	# the server's init and main functions
1877		3212
1878	=head2 EXTENSION DATABASE SUPPORT	3213	sub load_facedata($) {
		3214	my ($path) = @_;
1879		3215
1880	Crossfire maintains a very simple database for extension use. It can	3216	# HACK to clear player env face cache, we need some signal framework
1881	currently store anything that can be serialised using Storable, which	3217	# for this (global event?)
1882	excludes objects.	3218	%ext::player_env::MUSIC_FACE_CACHE = ();
1883		3219
1884	The parameter C<$family> should best start with the name of the extension	3220	my $enc = JSON::XS->new->utf8->canonical->relaxed;
1885	using it, it should be unique.
1886		3221
1887	=over 4	3222	warn "loading facedata from $path\n";
1888		3223
1889	=item $hashref = cf::db_get $family	3224	my $facedata;
		3225	0 < aio_load $path, $facedata
		3226	or die "$path: $!";
1890		3227
1891	Return a hashref for use by the extension C<$family>, which can be	3228	$facedata = Coro::Storable::thaw $facedata;
1892	modified. After modifications, you have to call C<cf::db_dirty> or
1893	C<cf::db_sync>.
1894		3229
1895	=item $value = cf::db_get $family => $key	3230	$facedata->{version} == 2
		3231	or cf::cleanup "$path: version mismatch, cannot proceed.";
1896		3232
1897	Returns a single value from the database	3233	# patch in the exptable
1898		3234	$facedata->{resource}{"res/exp_table"} = {
1899	=item cf::db_put $family => $hashref	3235	type => FT_RSRC,
1900		3236	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1901	Stores the given family hashref into the database. Updates are delayed, if
1902	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1903
1904	=item cf::db_put $family => $key => $value
1905
1906	Stores the given C<$value> in the family hash. Updates are delayed, if you
1907	want the data to be synced to disk immediately, use C<cf::db_sync>.
1908
1909	=item cf::db_dirty
1910
1911	Marks the database as dirty, to be updated at a later time.
1912
1913	=item cf::db_sync
1914
1915	Immediately write the database to disk I<if it is dirty>.
1916
1917	=cut
1918
1919	our $DB;
1920
1921	{
1922	my $path = cf::localdir . "/database.pst";
1923
1924	sub db_load() {
1925	$DB = stat $path ? Storable::retrieve $path : { };
1926	}
1927
1928	my $pid;
1929
1930	sub db_save() {
1931	waitpid $pid, 0 if $pid;
1932	if (0 == ($pid = fork)) {
1933	$DB->{_meta}{version} = 1;
1934	Storable::nstore $DB, "$path~";
1935	rename "$path~", $path;
1936	cf::_exit 0 if defined $pid;
1937	}
1938	}
1939
1940	my $dirty;
1941
1942	sub db_sync() {
1943	db_save if $dirty;
1944	undef $dirty;
1945	}
1946
1947	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1948	db_sync;
1949	});	3237	};
		3238	cf::cede_to_tick;
1950		3239
1951	sub db_dirty() {
1952	$dirty = 1;
1953	$idle->start;
1954	}	3240	{
		3241	my $faces = $facedata->{faceinfo};
1955		3242
1956	sub db_get($;$) {	3243	while (my ($face, $info) = each %$faces) {
1957	@_ >= 2	3244	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1958	? $DB->{$_[0]}{$_[1]}
1959	: ($DB->{$_[0]} ||= { })
1960	}
1961		3245
1962	sub db_put($$;$) {	3246	cf::face::set_visibility $idx, $info->{visibility};
1963	if (@_ >= 3) {	3247	cf::face::set_magicmap $idx, $info->{magicmap};
1964	$DB->{$_[0]}{$_[1]} = $_[2];	3248	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
1965	} else {	3249	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1966	$DB->{$_[0]} = $_[1];
1967	}
1968	db_dirty;
1969	}
1970		3250
1971	cf::global->attach (	3251	cf::cede_to_tick;
1972	prio => 10000,
1973	on_cleanup => sub {
1974	db_sync;
1975	},	3252	}
1976	);
1977	}
1978		3253
1979	#############################################################################	3254	while (my ($face, $info) = each %$faces) {
1980	# the server's main()	3255	next unless $info->{smooth};
1981		3256
1982	sub cfg_load {	3257	my $idx = cf::face::find $face
		3258	or next;
		3259
		3260	if (my $smooth = cf::face::find $info->{smooth}) {
		3261	cf::face::set_smooth $idx, $smooth;
		3262	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3263	} else {
		3264	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3265	}
		3266
		3267	cf::cede_to_tick;
		3268	}
		3269	}
		3270
		3271	{
		3272	my $anims = $facedata->{animinfo};
		3273
		3274	while (my ($anim, $info) = each %$anims) {
		3275	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3276	cf::cede_to_tick;
		3277	}
		3278
		3279	cf::anim::invalidate_all; # d'oh
		3280	}
		3281
		3282	{
		3283	# TODO: for gcfclient pleasure, we should give resources
		3284	# that gcfclient doesn't grok a >10000 face index.
		3285	my $res = $facedata->{resource};
		3286
		3287	while (my ($name, $info) = each %$res) {
		3288	if (defined $info->{type}) {
		3289	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3290	my $data;
		3291
		3292	if ($info->{type} & 1) {
		3293	# prepend meta info
		3294
		3295	my $meta = $enc->encode ({
		3296	name => $name,
		3297	%{ $info->{meta} || {} },
		3298	});
		3299
		3300	$data = pack "(w/a*)*", $meta, $info->{data};
		3301	} else {
		3302	$data = $info->{data};
		3303	}
		3304
		3305	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3306	cf::face::set_type $idx, $info->{type};
		3307	} else {
		3308	$RESOURCE{$name} = $info;
		3309	}
		3310
		3311	cf::cede_to_tick;
		3312	}
		3313	}
		3314
		3315	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3316
		3317	1
		3318	}
		3319
		3320	cf::global->attach (on_resource_update => sub {
		3321	if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
		3322	$soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
		3323
		3324	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3325	my $sound = $soundconf->{compat}[$_]
		3326	or next;
		3327
		3328	my $face = cf::face::find "sound/$sound->[1]";
		3329	cf::sound::set $sound->[0] => $face;
		3330	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3331	}
		3332
		3333	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3334	my $face = cf::face::find "sound/$v";
		3335	cf::sound::set $k => $face;
		3336	}
		3337	}
		3338	});
		3339
		3340	register_exticmd fx_want => sub {
		3341	my ($ns, $want) = @_;
		3342
		3343	while (my ($k, $v) = each %$want) {
		3344	$ns->fx_want ($k, $v);
		3345	}
		3346	};
		3347
		3348	sub load_resource_file($) {
		3349	my $guard = lock_acquire "load_resource_file";
		3350
		3351	my $status = load_resource_file_ $_[0];
		3352	get_slot 0.1, 100;
		3353	cf::arch::commit_load;
		3354
		3355	$status
		3356	}
		3357
		3358	sub reload_regions {
		3359	# HACK to clear player env face cache, we need some signal framework
		3360	# for this (global event?)
		3361	%ext::player_env::MUSIC_FACE_CACHE = ();
		3362
		3363	load_resource_file "$MAPDIR/regions"
		3364	or die "unable to load regions file\n";
		3365
		3366	for (cf::region::list) {
		3367	$_->{match} = qr/$_->{match}/
		3368	if exists $_->{match};
		3369	}
		3370	}
		3371
		3372	sub reload_facedata {
		3373	load_facedata "$DATADIR/facedata"
		3374	or die "unable to load facedata\n";
		3375	}
		3376
		3377	sub reload_archetypes {
		3378	load_resource_file "$DATADIR/archetypes"
		3379	or die "unable to load archetypes\n";
		3380	}
		3381
		3382	sub reload_treasures {
		3383	load_resource_file "$DATADIR/treasures"
		3384	or die "unable to load treasurelists\n";
		3385	}
		3386
		3387	sub reload_resources {
		3388	warn "reloading resource files...\n";
		3389
		3390	reload_facedata;
		3391	reload_archetypes;
		3392	reload_regions;
		3393	reload_treasures;
		3394
		3395	warn "finished reloading resource files\n";
		3396	}
		3397
		3398	sub init {
		3399	my $guard = freeze_mainloop;
		3400
		3401	reload_resources;
		3402	}
		3403
		3404	sub reload_config {
1983	open my $fh, "<:utf8", cf::confdir . "/config"	3405	open my $fh, "<:utf8", "$CONFDIR/config"
1984	or return;	3406	or return;
1985		3407
1986	local $/;	3408	local $/;
1987	*CFG = YAML::Syck::Load <$fh>;	3409	*CFG = YAML::Load <$fh>;
1988		3410
1989	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3411	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
1990		3412
1991	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	3413	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
1992	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};	3414	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
1993		3415
1994	if (exists $CFG{mlockall}) {	3416	if (exists $CFG{mlockall}) {
1995	eval {	3417	eval {
1996	$CFG{mlockall} ? &mlockall : &munlockall	3418	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
1997	and die "WARNING: m(un)lockall failed: $!\n";	3419	and die "WARNING: m(un)lockall failed: $!\n";
1998	};	3420	};
1999	warn $@ if $@;	3421	warn $@ if $@;
2000	}	3422	}
2001	}	3423	}
2002		3424
2003	sub main {	3425	sub main {
2004	# we must not ever block the main coroutine	3426	# we must not ever block the main coroutine
2005	local $Coro::idle = sub {	3427	local $Coro::idle = sub {
2006	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3428	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2007	Coro::async_pool { Event::one_event };	3429	(async {
		3430	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3431	EV::loop EV::LOOP_ONESHOT;
		3432	})->prio (Coro::PRIO_MAX);
2008	};	3433	};
2009		3434
2010	cfg_load;	3435	{
2011	db_load;	3436	my $guard = freeze_mainloop;
		3437	reload_config;
		3438	db_init;
2012	load_extensions;	3439	load_extensions;
		3440
		3441	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3442	evthread_start IO::AIO::poll_fileno;
		3443	}
		3444
2013	Event::loop;	3445	EV::loop;
2014	}	3446	}
2015		3447
2016	#############################################################################	3448	#############################################################################
2017	# initialisation	3449	# initialisation and cleanup
2018		3450
		3451	# install some emergency cleanup handlers
		3452	BEGIN {
		3453	our %SIGWATCHER = ();
		3454	for my $signal (qw(INT HUP TERM)) {
		3455	$SIGWATCHER{$signal} = EV::signal $signal, sub {
		3456	cf::cleanup "SIG$signal";
		3457	};
		3458	}
		3459	}
		3460
		3461	sub write_runtime_sync {
		3462	my $runtime = "$LOCALDIR/runtime";
		3463
		3464	# first touch the runtime file to show we are still running:
		3465	# the fsync below can take a very very long time.
		3466
		3467	IO::AIO::aio_utime $runtime, undef, undef;
		3468
		3469	my $guard = cf::lock_acquire "write_runtime";
		3470
		3471	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3472	or return;
		3473
		3474	my $value = $cf::RUNTIME + 90 + 10;
		3475	# 10 is the runtime save interval, for a monotonic clock
		3476	# 60 allows for the watchdog to kill the server.
		3477
		3478	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3479	and return;
		3480
		3481	# always fsync - this file is important
		3482	aio_fsync $fh
		3483	and return;
		3484
		3485	# touch it again to show we are up-to-date
		3486	aio_utime $fh, undef, undef;
		3487
		3488	close $fh
		3489	or return;
		3490
		3491	aio_rename "$runtime~", $runtime
		3492	and return;
		3493
		3494	warn "runtime file written.\n";
		3495
		3496	1
		3497	}
		3498
		3499	our $uuid_lock;
		3500	our $uuid_skip;
		3501
		3502	sub write_uuid_sync($) {
		3503	$uuid_skip ||= $_[0];
		3504
		3505	return if $uuid_lock;
		3506	local $uuid_lock = 1;
		3507
		3508	my $uuid = "$LOCALDIR/uuid";
		3509
		3510	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3511	or return;
		3512
		3513	my $value = uuid_str $uuid_skip + uuid_seq uuid_cur;
		3514	$uuid_skip = 0;
		3515
		3516	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3517	and return;
		3518
		3519	# always fsync - this file is important
		3520	aio_fsync $fh
		3521	and return;
		3522
		3523	close $fh
		3524	or return;
		3525
		3526	aio_rename "$uuid~", $uuid
		3527	and return;
		3528
		3529	warn "uuid file written ($value).\n";
		3530
		3531	1
		3532
		3533	}
		3534
		3535	sub write_uuid($$) {
		3536	my ($skip, $sync) = @_;
		3537
		3538	$sync ? write_uuid_sync $skip
		3539	: async { write_uuid_sync $skip };
		3540	}
		3541
		3542	sub emergency_save() {
		3543	my $freeze_guard = cf::freeze_mainloop;
		3544
		3545	warn "enter emergency perl save\n";
		3546
		3547	cf::sync_job {
		3548	# use a peculiar iteration method to avoid tripping on perl
		3549	# refcount bugs in for. also avoids problems with players
		3550	# and maps saved/destroyed asynchronously.
		3551	warn "begin emergency player save\n";
		3552	for my $login (keys %cf::PLAYER) {
		3553	my $pl = $cf::PLAYER{$login} or next;
		3554	$pl->valid or next;
		3555	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
		3556	$pl->save;
		3557	}
		3558	warn "end emergency player save\n";
		3559
		3560	warn "begin emergency map save\n";
		3561	for my $path (keys %cf::MAP) {
		3562	my $map = $cf::MAP{$path} or next;
		3563	$map->valid or next;
		3564	$map->save;
		3565	}
		3566	warn "end emergency map save\n";
		3567
		3568	warn "begin emergency database checkpoint\n";
		3569	BDB::db_env_txn_checkpoint $DB_ENV;
		3570	warn "end emergency database checkpoint\n";
		3571
		3572	warn "begin write uuid\n";
		3573	write_uuid_sync 1;
		3574	warn "end write uuid\n";
		3575	};
		3576
		3577	warn "leave emergency perl save\n";
		3578	}
		3579
		3580	sub post_cleanup {
		3581	my ($make_core) = @_;
		3582
		3583	warn Carp::longmess "post_cleanup backtrace"
		3584	if $make_core;
		3585	}
		3586
2019	sub reload() {	3587	sub do_reload_perl() {
2020	# can/must only be called in main	3588	# can/must only be called in main
2021	if ($Coro::current != $Coro::main) {	3589	if ($Coro::current != $Coro::main) {
2022	warn "can only reload from main coroutine\n";	3590	warn "can only reload from main coroutine";
2023	return;	3591	return;
2024	}	3592	}
2025		3593
2026	warn "reloading...";	3594	warn "reloading...";
2027		3595
2028	my $guard = freeze_mainloop;	3596	warn "entering sync_job";
		3597
		3598	cf::sync_job {
		3599	cf::write_runtime_sync; # external watchdog should not bark
2029	cf::emergency_save;	3600	cf::emergency_save;
		3601	cf::write_runtime_sync; # external watchdog should not bark
2030		3602
2031	eval {	3603	warn "syncing database to disk";
		3604	BDB::db_env_txn_checkpoint $DB_ENV;
		3605
2032	# if anything goes wrong in here, we should simply crash as we already saved	3606	# if anything goes wrong in here, we should simply crash as we already saved
2033		3607
2034	# cancel all watchers	3608	warn "flushing outstanding aio requests";
2035	for (Event::all_watchers) {	3609	for (;;) {
2036	$_->cancel if $_->data & WF_AUTOCANCEL;	3610	BDB::flush;
		3611	IO::AIO::flush;
		3612	Coro::cede_notself;
		3613	last unless IO::AIO::nreqs || BDB::nreqs;
		3614	warn "iterate...";
2037	}	3615	}
2038		3616
		3617	++$RELOAD;
		3618
2039	# cancel all extension coros	3619	warn "cancelling all extension coros";
2040	$_->cancel for values %EXT_CORO;	3620	$_->cancel for values %EXT_CORO;
2041	%EXT_CORO = ();	3621	%EXT_CORO = ();
2042		3622
2043	# unload all extensions	3623	warn "removing commands";
2044	for (@exts) {	3624	%COMMAND = ();
		3625
		3626	warn "removing ext/exti commands";
		3627	%EXTCMD = ();
		3628	%EXTICMD = ();
		3629
		3630	warn "unloading/nuking all extensions";
		3631	for my $pkg (@EXTS) {
2045	warn "unloading <$_>";	3632	warn "... unloading $pkg";
2046	unload_extension $_;	3633
		3634	if (my $cb = $pkg->can ("unload")) {
		3635	eval {
		3636	$cb->($pkg);
		3637	1
		3638	} or warn "$pkg unloaded, but with errors: $@";
2047	}	3639	}
2048		3640
		3641	warn "... nuking $pkg";
		3642	Symbol::delete_package $pkg;
		3643	}
		3644
2049	# unload all modules loaded from $LIBDIR	3645	warn "unloading all perl modules loaded from $LIBDIR";
2050	while (my ($k, $v) = each %INC) {	3646	while (my ($k, $v) = each %INC) {
2051	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3647	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2052		3648
2053	warn "removing <$k>";	3649	warn "... unloading $k";
2054	delete $INC{$k};	3650	delete $INC{$k};
2055		3651
2056	$k =~ s/\.pm$//;	3652	$k =~ s/\.pm$//;
2057	$k =~ s/\//::/g;	3653	$k =~ s/\//::/g;
2058		3654
…		…
2061	}	3657	}
2062		3658
2063	Symbol::delete_package $k;	3659	Symbol::delete_package $k;
2064	}	3660	}
2065		3661
2066	# sync database to disk
2067	cf::db_sync;
2068	IO::AIO::flush;
2069
2070	# get rid of safe::, as good as possible	3662	warn "getting rid of safe::, as good as possible";
2071	Symbol::delete_package "safe::$_"	3663	Symbol::delete_package "safe::$_"
2072	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3664	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2073		3665
2074	# remove register_script_function callbacks
2075	# TODO
2076
2077	# unload cf.pm "a bit"	3666	warn "unloading cf.pm \"a bit\"";
2078	delete $INC{"cf.pm"};	3667	delete $INC{"cf.pm"};
		3668	delete $INC{"cf/pod.pm"};
2079		3669
2080	# don't, removes xs symbols, too,	3670	# don't, removes xs symbols, too,
2081	# and global variables created in xs	3671	# and global variables created in xs
2082	#Symbol::delete_package __PACKAGE__;	3672	#Symbol::delete_package __PACKAGE__;
2083		3673
2084	# reload cf.pm	3674	warn "unload completed, starting to reload now";
		3675
2085	warn "reloading cf.pm";	3676	warn "reloading cf.pm";
2086	require cf;	3677	require cf;
2087	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3678	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2088		3679
2089	# load config and database again	3680	warn "loading config and database again";
2090	cf::cfg_load;	3681	cf::reload_config;
2091	cf::db_load;
2092		3682
2093	# load extensions
2094	warn "load extensions";	3683	warn "loading extensions";
2095	cf::load_extensions;	3684	cf::load_extensions;
2096		3685
2097	# reattach attachments to objects	3686	warn "reattaching attachments to objects/players";
2098	warn "reattach";	3687	_global_reattach; # objects, sockets
2099	_global_reattach;	3688	warn "reattaching attachments to maps";
		3689	reattach $_ for values %MAP;
		3690	warn "reattaching attachments to players";
		3691	reattach $_ for values %PLAYER;
		3692
		3693	warn "leaving sync_job";
		3694
		3695	1
		3696	} or do {
		3697	warn $@;
		3698	cf::cleanup "error while reloading, exiting.";
2100	};	3699	};
2101		3700
2102	if ($@) {	3701	warn "reloaded";
2103	warn $@;
2104	warn "error while reloading, exiting.";
2105	exit 1;
2106	}
2107
2108	warn "reloaded successfully";
2109	};	3702	};
2110		3703
2111	#############################################################################	3704	our $RELOAD_WATCHER; # used only during reload
2112		3705
2113	unless ($LINK_MAP) {	3706	sub reload_perl() {
2114	$LINK_MAP = cf::map::new;	3707	# doing reload synchronously and two reloads happen back-to-back,
		3708	# coro crashes during coro_state_free->destroy here.
2115		3709
2116	$LINK_MAP->width (41);	3710	$RELOAD_WATCHER ||= EV::timer 0, 0, sub {
2117	$LINK_MAP->height (41);	3711	do_reload_perl;
2118	$LINK_MAP->alloc;	3712	undef $RELOAD_WATCHER;
2119	$LINK_MAP->path ("{link}");	3713	};
2120	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2121	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2122
2123	# dirty hack because... archetypes are not yet loaded
2124	Event->timer (
2125	after => 2,
2126	cb => sub {
2127	$_[0]->w->cancel;
2128
2129	# provide some exits "home"
2130	my $exit = cf::object::new "exit";
2131
2132	$exit->slaying ($EMERGENCY_POSITION->[0]);
2133	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2134	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2135
2136	$LINK_MAP->insert ($exit->clone, 19, 19);
2137	$LINK_MAP->insert ($exit->clone, 19, 20);
2138	$LINK_MAP->insert ($exit->clone, 19, 21);
2139	$LINK_MAP->insert ($exit->clone, 20, 19);
2140	$LINK_MAP->insert ($exit->clone, 20, 21);
2141	$LINK_MAP->insert ($exit->clone, 21, 19);
2142	$LINK_MAP->insert ($exit->clone, 21, 20);
2143	$LINK_MAP->insert ($exit->clone, 21, 21);
2144
2145	$exit->destroy;
2146	});
2147
2148	$LINK_MAP->{deny_save} = 1;
2149	$LINK_MAP->{deny_reset} = 1;
2150
2151	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2152	}	3714	}
2153
2154	register "<global>", __PACKAGE__;
2155		3715
2156	register_command "reload" => sub {	3716	register_command "reload" => sub {
2157	my ($who, $arg) = @_;	3717	my ($who, $arg) = @_;
2158		3718
2159	if ($who->flag (FLAG_WIZ)) {	3719	if ($who->flag (FLAG_WIZ)) {
2160	$who->message ("start of reload.");
2161	reload;
2162	$who->message ("end of reload.");	3720	$who->message ("reloading server.");
		3721	async {
		3722	$Coro::current->{desc} = "perl_reload";
		3723	reload_perl;
		3724	};
2163	}	3725	}
2164	};	3726	};
2165		3727
2166	unshift @INC, $LIBDIR;	3728	unshift @INC, $LIBDIR;
2167		3729
2168	$TICK_WATCHER = Event->timer (	3730	my $bug_warning = 0;
2169	reentrant => 0,	3731
2170	prio => 0,	3732	our @WAIT_FOR_TICK;
2171	at => $NEXT_TICK || $TICK,	3733	our @WAIT_FOR_TICK_BEGIN;
2172	data => WF_AUTOCANCEL,	3734
2173	cb => sub {	3735	sub wait_for_tick {
		3736	return if tick_inhibit || $Coro::current == $Coro::main;
		3737
		3738	my $signal = new Coro::Signal;
		3739	push @WAIT_FOR_TICK, $signal;
		3740	$signal->wait;
		3741	}
		3742
		3743	sub wait_for_tick_begin {
		3744	return if tick_inhibit || $Coro::current == $Coro::main;
		3745
		3746	my $signal = new Coro::Signal;
		3747	push @WAIT_FOR_TICK_BEGIN, $signal;
		3748	$signal->wait;
		3749	}
		3750
		3751	sub tick {
		3752	if ($Coro::current != $Coro::main) {
		3753	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3754	unless ++$bug_warning > 10;
		3755	return;
		3756	}
		3757
2174	cf::server_tick; # one server iteration	3758	cf::server_tick; # one server iteration
2175	$RUNTIME += $TICK;
2176	$NEXT_TICK += $TICK;
2177		3759
2178	# if we are delayed by four ticks or more, skip them all	3760	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2179	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3761	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2180		3762	Coro::async_pool {
2181	$TICK_WATCHER->at ($NEXT_TICK);	3763	$Coro::current->{desc} = "runtime saver";
2182	$TICK_WATCHER->start;
2183	},
2184	);
2185
2186	IO::AIO::max_poll_time $TICK * 0.2;
2187
2188	Event->io (
2189	fd => IO::AIO::poll_fileno,
2190	poll => 'r',
2191	prio => 5,
2192	data => WF_AUTOCANCEL,
2193	cb => \&IO::AIO::poll_cb,
2194	);
2195
2196	Event->timer (
2197	data => WF_AUTOCANCEL,
2198	after => 0,
2199	interval => 10,
2200	cb => sub {
2201	(Coro::unblock_sub {
2202	write_runtime	3764	write_runtime_sync
2203	or warn "ERROR: unable to write runtime file: $!";	3765	or warn "ERROR: unable to write runtime file: $!";
2204	})->();	3766	};
2205	},	3767	}
2206	);	3768
		3769	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3770	$sig->send;
		3771	}
		3772	while (my $sig = shift @WAIT_FOR_TICK) {
		3773	$sig->send;
		3774	}
		3775
		3776	$LOAD = ($NOW - $TICK_START) / $TICK;
		3777	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3778
		3779	if (0) {
		3780	if ($NEXT_TICK) {
		3781	my $jitter = $TICK_START - $NEXT_TICK;
		3782	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		3783	warn "jitter $JITTER\n";#d#
		3784	}
		3785	}
		3786	}
		3787
		3788	{
		3789	# configure BDB
		3790
		3791	BDB::min_parallel 8;
		3792	BDB::max_poll_reqs $TICK * 0.1;
		3793	$AnyEvent::BDB::WATCHER->priority (1);
		3794
		3795	unless ($DB_ENV) {
		3796	$DB_ENV = BDB::db_env_create;
		3797	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
		3798	| BDB::LOG_AUTOREMOVE, 1);
		3799	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3800	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3801
		3802	cf::sync_job {
		3803	eval {
		3804	BDB::db_env_open
		3805	$DB_ENV,
		3806	$BDBDIR,
		3807	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3808	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3809	0666;
		3810
		3811	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3812	};
		3813
		3814	cf::cleanup "db_env_open(db): $@" if $@;
		3815	};
		3816	}
		3817
		3818	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3819	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3820	};
		3821	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		3822	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3823	};
		3824	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3825	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3826	};
		3827	}
		3828
		3829	{
		3830	# configure IO::AIO
		3831
		3832	IO::AIO::min_parallel 8;
		3833	IO::AIO::max_poll_time $TICK * 0.1;
		3834	$AnyEvent::AIO::WATCHER->priority (1);
		3835	}
		3836
		3837	my $_log_backtrace;
		3838
		3839	sub _log_backtrace {
		3840	my ($msg, @addr) = @_;
		3841
		3842	$msg =~ s/\n//;
		3843
		3844	# limit the # of concurrent backtraces
		3845	if ($_log_backtrace < 2) {
		3846	++$_log_backtrace;
		3847	async {
		3848	$Coro::current->{desc} = "abt $msg";
		3849
		3850	my @bt = fork_call {
		3851	@addr = map { sprintf "%x", $_ } @addr;
		3852	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3853	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3854	or die "addr2line: $!";
		3855
		3856	my @funcs;
		3857	my @res = <$fh>;
		3858	chomp for @res;
		3859	while (@res) {
		3860	my ($func, $line) = splice @res, 0, 2, ();
		3861	push @funcs, "[$func] $line";
		3862	}
		3863
		3864	@funcs
		3865	};
		3866
		3867	LOG llevInfo, "[ABT] $msg\n";
		3868	LOG llevInfo, "[ABT] $_\n" for @bt;
		3869	--$_log_backtrace;
		3870	};
		3871	} else {
		3872	LOG llevInfo, "[ABT] $msg\n";
		3873	LOG llevInfo, "[ABT] [suppressed]\n";
		3874	}
		3875	}
		3876
		3877	# load additional modules
		3878	use cf::pod;
2207		3879
2208	END { cf::emergency_save }	3880	END { cf::emergency_save }
2209		3881
2210	1	3882	1
2211		3883

Diff Legend

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