ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

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

Diff Legend

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