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.110 by root, Mon Jan 1 11:21:55 2007 UTC vs.
Revision 1.446 by root, Tue Sep 16 16:03:02 2008 UTC

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

Diff Legend

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