ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

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

Diff Legend

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