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.140 by root, Fri Jan 5 20:04:02 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 (Coro::PRIO_MAX); # 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 $RANDOM_MAPS = cf::localdir . "/random";	120	our $LINK_MAP; # the special {link} map, which is always available
55	our %EXT_CORO;	121
		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
56		129
57	binmode STDOUT;	130	binmode STDOUT;
58	binmode STDERR;	131	binmode STDERR;
59		132
60	# read virtual server time, if available	133	# read virtual server time, if available
61	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	134	unless ($RUNTIME || !-e $RUNTIMEFILE) {
62	open my $fh, "<", cf::localdir . "/runtime"	135	open my $fh, "<", $RUNTIMEFILE
63	or die "unable to read runtime file: $!";	136	or die "unable to read $RUNTIMEFILE file: $!";
64	$RUNTIME = <$fh> + 0.;	137	$RUNTIME = <$fh> + 0.;
65	}	138	}
66		139
67	mkdir cf::localdir;	140	mkdir $_
68	mkdir cf::localdir . "/" . cf::playerdir;	141	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
69	mkdir cf::localdir . "/" . cf::tmpdir;
70	mkdir cf::localdir . "/" . cf::uniquedir;
71	mkdir $RANDOM_MAPS;
72		142
73	# a special map that is always available
74	our $LINK_MAP;
75	our $EMERGENCY_POSITION;	143	our $EMERGENCY_POSITION;
		144
		145	sub cf::map::normalise;
76		146
77	#############################################################################	147	#############################################################################
78		148
79	=head2 GLOBAL VARIABLES	149	=head2 GLOBAL VARIABLES
80		150
…		…
87	=item $cf::RUNTIME	157	=item $cf::RUNTIME
88		158
89	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
90	every server tick.	160	every server tick.
91		161
92	=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
93		165
94	The perl library directory, where extensions and cf-specific modules can	166	Various directories - "/etc", read-only install directory, perl-library
95	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.
96		170
97	=item $cf::NOW	171	=item $cf::NOW
98		172
99	The time of the last (current) server tick.	173	The time of the last (current) server tick.
100		174
101	=item $cf::TICK	175	=item $cf::TICK
102		176
103	The interval between server ticks, in seconds.	177	The interval between server ticks, in seconds.
104		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
105	=item %cf::CFG	189	=item %cf::CFG
106		190
107	Configuration for the server, loaded from C</etc/crossfire/config>, or	191	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
108	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.
109		205
110	=back	206	=back
111		207
112	=cut	208	=cut
113		209
114	BEGIN {	210	BEGIN {
115	*CORE::GLOBAL::warn = sub {	211	*CORE::GLOBAL::warn = sub {
116	my $msg = join "", @_;	212	my $msg = join "", @_;
117	utf8::encode $msg;
118		213
119	$msg .= "\n"	214	$msg .= "\n"
120	unless $msg =~ /\n$/;	215	unless $msg =~ /\n$/;
121		216
		217	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		218
122	LOG llevError, "cfperl: $msg";	219	LOG llevError, $msg;
123	};	220	};
124	}	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#?
125		237
126	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	238	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
127	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	239	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
128	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	240	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
129	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	241	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
130	@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';
131	@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)
132		245
133	# 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
134	# within the Safe compartment.	247	# within the Safe compartment.
135	for my $pkg (qw(	248	for my $pkg (qw(
136	cf::global cf::attachable	249	cf::global cf::attachable
137	cf::object cf::object::player	250	cf::object cf::object::player
138	cf::client cf::player	251	cf::client cf::player
139	cf::arch cf::living	252	cf::arch cf::living
		253	cf::map cf::mapspace
140	cf::map cf::party cf::region	254	cf::party cf::region
141	)) {	255	)) {
142	no strict 'refs';
143	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	256	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
144	}	257	}
145		258
146	$Event::DIED = sub {	259	$EV::DIED = sub {
147	warn "error in event callback: @_";	260	warn "error in event callback: @_";
148	};	261	};
149		262
150	my %ext_pkg;	263	#############################################################################
151	my @exts;
152	my @hook;
153		264
154	=head2 UTILITY FUNCTIONS	265	=head2 UTILITY FUNCTIONS
155		266
156	=over 4	267	=over 4
157		268
158	=cut	269	=item dumpval $ref
159		270
160	use JSON::Syck (); # TODO# replace by JSON::PC once working	271	=cut
161		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
162	=item $ref = cf::from_json $json	292	=item $ref = cf::decode_json $json
163		293
164	Converts a JSON string into the corresponding perl data structure.	294	Converts a JSON string into the corresponding perl data structure.
165		295
166	=cut
167
168	sub from_json($) {
169	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
170	JSON::Syck::Load $_[0]
171	}
172
173	=item $json = cf::to_json $ref	296	=item $json = cf::encode_json $ref
174		297
175	Converts a perl data structure into its JSON representation.	298	Converts a perl data structure into its JSON representation.
176		299
177	=cut	300	=cut
178		301
179	sub to_json($) {	302	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
180	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	303
181	JSON::Syck::Dump $_[0]	304	sub encode_json($) { $json_coder->encode ($_[0]) }
182	}	305	sub decode_json($) { $json_coder->decode ($_[0]) }
183		306
184	=item cf::lock_wait $string	307	=item cf::lock_wait $string
185		308
186	Wait until the given lock is available. See cf::lock_acquire.	309	Wait until the given lock is available. See cf::lock_acquire.
187		310
…		…
190	Wait until the given lock is available and then acquires it and returns	313	Wait until the given lock is available and then acquires it and returns
191	a Coro::guard object. If the guard object gets destroyed (goes out of scope,	314	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
192	for example when the coroutine gets canceled), the lock is automatically	315	for example when the coroutine gets canceled), the lock is automatically
193	returned.	316	returned.
194		317
		318	Locks are *not* recursive, locking from the same coro twice results in a
		319	deadlocked coro.
		320
195	Lock names should begin with a unique identifier (for example, cf::map::find	321	Lock names should begin with a unique identifier (for example, cf::map::find
196	uses map_find and cf::map::load uses map_load).	322	uses map_find and cf::map::load uses map_load).
197		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
198	=cut	328	=cut
199		329
200	our %LOCK;	330	our %LOCK;
		331	our %LOCKER;#d#
201		332
202	sub lock_wait($) {	333	sub lock_wait($) {
203	my ($key) = @_;	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#
204		340
205	# wait for lock, if any	341	# wait for lock, if any
206	while ($LOCK{$key}) {	342	while ($LOCK{$key}) {
207	push @{ $LOCK{$key} }, $Coro::current;	343	push @{ $LOCK{$key} }, $Coro::current;
208	Coro::schedule;	344	Coro::schedule;
…		…
214		350
215	# wait, to be sure we are not locked	351	# wait, to be sure we are not locked
216	lock_wait $key;	352	lock_wait $key;
217		353
218	$LOCK{$key} = [];	354	$LOCK{$key} = [];
		355	$LOCKER{$key} = $Coro::current;#d#
219		356
220	Coro::guard {	357	Coro::guard {
		358	delete $LOCKER{$key};#d#
221	# wake up all waiters, to be on the safe side	359	# wake up all waiters, to be on the safe side
222	$_->ready for @{ delete $LOCK{$key} };	360	$_->ready for @{ delete $LOCK{$key} };
223	}	361	}
224	}	362	}
225		363
		364	sub lock_active($) {
		365	my ($key) = @_;
		366
		367	! ! $LOCK{$key}
		368	}
		369
226	sub freeze_mainloop {	370	sub freeze_mainloop {
227	return unless $TICK_WATCHER->is_active;	371	tick_inhibit_inc;
228		372
229	my $guard = Coro::guard { $TICK_WATCHER->start };	373	Coro::guard \&tick_inhibit_dec;
230	$TICK_WATCHER->stop;	374	}
231	$guard	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;
232	}	449	}
233		450
234	=item cf::async { BLOCK }	451	=item cf::async { BLOCK }
235		452
236	Currently the same as Coro::async_pool, meaning you cannot use	453	Currently the same as Coro::async_pool, meaning you cannot use
…		…
241		458
242	BEGIN { *async = \&Coro::async_pool }	459	BEGIN { *async = \&Coro::async_pool }
243		460
244	=item cf::sync_job { BLOCK }	461	=item cf::sync_job { BLOCK }
245		462
246	The design of crossfire+ requires that the main coro ($Coro::main) is	463	The design of Deliantra requires that the main coroutine ($Coro::main)
247	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
248	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.
249		467
250	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
251	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
252	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
253	fast or be very important.	471	fast or be very important.
…		…
256		474
257	sub sync_job(&) {	475	sub sync_job(&) {
258	my ($job) = @_;	476	my ($job) = @_;
259		477
260	if ($Coro::current == $Coro::main) {	478	if ($Coro::current == $Coro::main) {
		479	my $time = EV::time;
		480
261	# this is the main coro, too bad, we have to block	481	# this is the main coro, too bad, we have to block
262	# till the operation succeeds, freezing the server :/	482	# till the operation succeeds, freezing the server :/
263		483
264	# TODO: use suspend/resume instead	484	LOG llevError, Carp::longmess "sync job";#d#
265	# (but this is cancel-safe)	485
266	my $freeze_guard = freeze_mainloop;	486	my $freeze_guard = freeze_mainloop;
267		487
268	my $busy = 1;	488	my $busy = 1;
269	my @res;	489	my @res;
270		490
271	(async {	491	(async {
		492	$Coro::current->desc ("sync job coro");
272	@res = eval { $job->() };	493	@res = eval { $job->() };
273	warn $@ if $@;	494	warn $@ if $@;
274	undef $busy;	495	undef $busy;
275	})->prio (Coro::PRIO_MAX);	496	})->prio (Coro::PRIO_MAX);
276		497
277	while ($busy) {	498	while ($busy) {
278	unless (Coro::cede) {	499	if (Coro::nready) {
279	Coro::nready ? Event::one_event 0 : Event::one_event;
280	Coro::cede_notself unless Coro::cede;	500	Coro::cede_notself;
		501	} else {
		502	EV::loop EV::LOOP_ONESHOT;
281	}	503	}
282	}	504	}
		505
		506	my $time = EV::time - $time;
		507
		508	$TICK_START += $time; # do not account sync jobs to server load
283		509
284	wantarray ? @res : $res[0]	510	wantarray ? @res : $res[0]
285	} else {	511	} else {
286	# we are in another coroutine, how wonderful, everything just works	512	# we are in another coroutine, how wonderful, everything just works
287		513
…		…
289	}	515	}
290	}	516	}
291		517
292	=item $coro = cf::async_ext { BLOCK }	518	=item $coro = cf::async_ext { BLOCK }
293		519
294	Like async, but this coro is automcatially being canceled when the	520	Like async, but this coro is automatically being canceled when the
295	extension calling this is being unloaded.	521	extension calling this is being unloaded.
296		522
297	=cut	523	=cut
298		524
299	sub async_ext(&) {	525	sub async_ext(&) {
…		…
307	$EXT_CORO{$coro+0} = $coro;	533	$EXT_CORO{$coro+0} = $coro;
308		534
309	$coro	535	$coro
310	}	536	}
311		537
312	sub write_runtime {	538	=item fork_call { }, $args
313	my $runtime = cf::localdir . "/runtime";
314		539
315	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	540	Executes the given code block with the given arguments in a seperate
316	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.
317		544
318	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	545	=cut
319	(aio_write $fh, 0, (length $value), $value, 0) <= 0
320	and return;
321		546
322	aio_fsync $fh	547	sub fork_call(&@) {
323	and return;	548	my ($cb, @args) = @_;
324		549
325	close $fh	550	# we seemingly have to make a local copy of the whole thing,
326	or return;	551	# otherwise perl prematurely frees the stuff :/
		552	# TODO: investigate and fix (likely this will be rather laborious)
327		553
328	aio_rename "$runtime~", $runtime	554	my @res = Coro::Util::fork_eval {
329	and return;	555	reset_signals;
		556	&$cb
		557	}, @args;
330		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
331	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 });
332	}	725	}
333		726
334	=back	727	=back
335		728
336	=cut	729	=cut
337
338	#############################################################################
339
340	package cf::path;
341
342	sub new {
343	my ($class, $path, $base) = @_;
344
345	$path = $path->as_string if ref $path;
346
347	my $self = bless { }, $class;
348
349	# {... are special paths that are not touched
350	# ?xxx/... are special absolute paths
351	# ?random/... random maps
352	# /! non-realised random map exit
353	# /... normal maps
354	# ~/... per-player maps without a specific player (DO NOT USE)
355	# ~user/... per-player map of a specific user
356
357	if ($path =~ /^{/) {
358	# fine as it is
359	} elsif ($path =~ s{^\?random/}{}) {
360	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
361	$self->{random} = cf::from_json $data;
362	} else {
363	if ($path =~ s{^~([^/]+)?}{}) {
364	$self->{user_rel} = 1;
365
366	if (defined $1) {
367	$self->{user} = $1;
368	} elsif ($base =~ m{^~([^/]+)/}) {
369	$self->{user} = $1;
370	} else {
371	warn "cannot resolve user-relative path without user <$path,$base>\n";
372	}
373	} elsif ($path =~ /^\//) {
374	# already absolute
375	} else {
376	$base =~ s{[^/]+/?$}{};
377	return $class->new ("$base/$path");
378	}
379
380	for ($path) {
381	redo if s{/\.?/}{/};
382	redo if s{/[^/]+/\.\./}{/};
383	}
384	}
385
386	$self->{path} = $path;
387
388	$self
389	}
390
391	# the name / primary key / in-game path
392	sub as_string {
393	my ($self) = @_;
394
395	$self->{user_rel} ? "~$self->{user}$self->{path}"
396	: $self->{random} ? "?random/$self->{path}"
397	: $self->{path}
398	}
399
400	# the displayed name, this is a one way mapping
401	sub visible_name {
402	my ($self) = @_;
403
404	# if (my $rmp = $self->{random}) {
405	# # todo: be more intelligent about this
406	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
407	# } else {
408	$self->as_string
409	# }
410	}
411
412	# escape the /'s in the path
413	sub _escaped_path {
414	# ∕ is U+2215
415	(my $path = $_[0]{path}) =~ s/\//∕/g;
416	$path
417	}
418
419	# the original (read-only) location
420	sub load_path {
421	my ($self) = @_;
422
423	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
424	}
425
426	# the temporary/swap location
427	sub save_path {
428	my ($self) = @_;
429
430	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
431	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
432	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
433	}
434
435	# the unique path, might be eq to save_path
436	sub uniq_path {
437	my ($self) = @_;
438
439	$self->{user_rel} || $self->{random}
440	? undef
441	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
442	}
443
444	# return random map parameters, or undef
445	sub random_map_params {
446	my ($self) = @_;
447
448	$self->{random}
449	}
450
451	# this is somewhat ugly, but style maps do need special treatment
452	sub is_style_map {
453	$_[0]{path} =~ m{^/styles/}
454	}
455
456	package cf;
457		730
458	#############################################################################	731	#############################################################################
459		732
460	=head2 ATTACHABLE OBJECTS	733	=head2 ATTACHABLE OBJECTS
461		734
…		…
463	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")
464	to it. All such attachable objects support the following methods.	737	to it. All such attachable objects support the following methods.
465		738
466	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>
467	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
468	crossfire+).	741	Deliantra).
469		742
470	=over 4	743	=over 4
471		744
472	=item $attachable->attach ($attachment, key => $value...)	745	=item $attachable->attach ($attachment, key => $value...)
473		746
…		…
587	our @CB_TYPE = (); # registry for type (cf-object class) based events	860	our @CB_TYPE = (); # registry for type (cf-object class) based events
588	our @CB_MAP = ();	861	our @CB_MAP = ();
589		862
590	my %attachment;	863	my %attachment;
591		864
		865	sub cf::attachable::thawer_merge {
		866	# simply override everything except _meta
		867	local $_[0]{_meta};
		868	%{$_[0]} = %{$_[1]};
		869	}
		870
592	sub _attach_cb($$$$) {	871	sub _attach_cb($$$$) {
593	my ($registry, $event, $prio, $cb) = @_;	872	my ($registry, $event, $prio, $cb) = @_;
594		873
595	use sort 'stable';	874	use sort 'stable';
596		875
…		…
630	$registry = $CB_TYPE[$object_type] ||= [];	909	$registry = $CB_TYPE[$object_type] ||= [];
631		910
632	} elsif ($type eq "subtype") {	911	} elsif ($type eq "subtype") {
633	defined $object_type or Carp::croak "subtype specified without type";	912	defined $object_type or Carp::croak "subtype specified without type";
634	my $object_subtype = shift @arg;	913	my $object_subtype = shift @arg;
635	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	914	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
636		915
637	} elsif ($type eq "package") {	916	} elsif ($type eq "package") {
638	my $pkg = shift @arg;	917	my $pkg = shift @arg;
639		918
640	while (my ($name, $id) = each %cb_id) {	919	while (my ($name, $id) = each %cb_id) {
…		…
669	_attach $registry, $klass, @attach;	948	_attach $registry, $klass, @attach;
670	}	949	}
671		950
672	$obj->{$name} = \%arg;	951	$obj->{$name} = \%arg;
673	} else {	952	} else {
674	warn "object uses attachment '$name' that is not available, postponing.\n";	953	warn "object uses attachment '$name' which is not available, postponing.\n";
675	}	954	}
676		955
677	$obj->{_attachment}{$name} = undef;	956	$obj->{_attachment}{$name} = undef;
678	}	957	}
679		958
…		…
681	if (ref $_[0]) {	960	if (ref $_[0]) {
682	_object_attach @_;	961	_object_attach @_;
683	} else {	962	} else {
684	_attach shift->_attach_registry, @_;	963	_attach shift->_attach_registry, @_;
685	}	964	}
		965	_recalc_want;
686	};	966	};
687		967
688	# all those should be optimised	968	# all those should be optimised
689	sub cf::attachable::detach {	969	sub cf::attachable::detach {
690	my ($obj, $name) = @_;	970	my ($obj, $name) = @_;
…		…
693	delete $obj->{_attachment}{$name};	973	delete $obj->{_attachment}{$name};
694	reattach ($obj);	974	reattach ($obj);
695	} else {	975	} else {
696	Carp::croak "cannot, currently, detach class attachments";	976	Carp::croak "cannot, currently, detach class attachments";
697	}	977	}
		978	_recalc_want;
698	};	979	};
699		980
700	sub cf::attachable::attached {	981	sub cf::attachable::attached {
701	my ($obj, $name) = @_;	982	my ($obj, $name) = @_;
702		983
…		…
717	";	998	";
718	die if $@;	999	die if $@;
719	}	1000	}
720		1001
721	our $override;	1002	our $override;
722	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?
723		1004
724	sub override {	1005	sub override {
725	$override = 1;	1006	$override = 1;
726	@invoke_results = ();	1007	@INVOKE_RESULTS = (@_);
727	}	1008	}
728		1009
729	sub do_invoke {	1010	sub do_invoke {
730	my $event = shift;	1011	my $event = shift;
731	my $callbacks = shift;	1012	my $callbacks = shift;
732		1013
733	@invoke_results = ();	1014	@INVOKE_RESULTS = ();
734		1015
735	local $override;	1016	local $override;
736		1017
737	for (@$callbacks) {	1018	for (@$callbacks) {
738	eval { &{$_->[1]} };	1019	eval { &{$_->[1]} };
…		…
747	}	1028	}
748		1029
749	0	1030	0
750	}	1031	}
751		1032
752	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1033	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
753		1034
754	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1035	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
755		1036
756	Generate an object-specific event with the given arguments.	1037	Generate an object-specific event with the given arguments.
757		1038
758	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
759	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
760	results (if you must, access C<@cf::invoke_results> directly).	1041	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
761		1042
762	=back	1043	=back
763		1044
764	=cut	1045	=cut
765		1046
766	#############################################################################	1047	#############################################################################
767	# 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	}
768		1091
769	sub reattach {	1092	sub reattach {
770	# basically do the same as instantiate, without calling instantiate	1093	# basically do the same as instantiate, without calling instantiate
771	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
772		1098
773	my $registry = $obj->registry;	1099	my $registry = $obj->registry;
774		1100
775	@$registry = ();	1101	@$registry = ();
776		1102
…		…
791	cf::attachable->attach (	1117	cf::attachable->attach (
792	prio => -1000000,	1118	prio => -1000000,
793	on_instantiate => sub {	1119	on_instantiate => sub {
794	my ($obj, $data) = @_;	1120	my ($obj, $data) = @_;
795		1121
796	$data = from_json $data;	1122	$data = decode_json $data;
797		1123
798	for (@$data) {	1124	for (@$data) {
799	my ($name, $args) = @$_;	1125	my ($name, $args) = @$_;
800		1126
801	$obj->attach ($name, %{$args || {} });	1127	$obj->attach ($name, %{$args || {} });
…		…
817	sub object_freezer_save {	1143	sub object_freezer_save {
818	my ($filename, $rdata, $objs) = @_;	1144	my ($filename, $rdata, $objs) = @_;
819		1145
820	sync_job {	1146	sync_job {
821	if (length $$rdata) {	1147	if (length $$rdata) {
		1148	utf8::decode (my $decname = $filename);
822	warn sprintf "saving %s (%d,%d)\n",	1149	warn sprintf "saving %s (%d,%d)\n",
823	$filename, length $$rdata, scalar @$objs;	1150	$decname, length $$rdata, scalar @$objs;
824		1151
825	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1152	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
826	chmod SAVE_MODE, $fh;	1153	aio_chmod $fh, SAVE_MODE;
827	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1154	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
828	aio_fsync $fh;	1155	aio_fsync $fh if $cf::USE_FSYNC;
829	close $fh;	1156	aio_close $fh;
830		1157
831	if (@$objs) {	1158	if (@$objs) {
832	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) {
833	chmod SAVE_MODE, $fh;	1160	aio_chmod $fh, SAVE_MODE;
834	my $data = Storable::nfreeze { version => 1, objs => $objs };	1161	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
835	aio_write $fh, 0, (length $data), $data, 0;	1162	aio_write $fh, 0, (length $data), $data, 0;
836	aio_fsync $fh;	1163	aio_fsync $fh if $cf::USE_FSYNC;
837	close $fh;	1164	aio_close $fh;
838	aio_rename "$filename.pst~", "$filename.pst";	1165	aio_rename "$filename.pst~", "$filename.pst";
839	}	1166	}
840	} else {	1167	} else {
841	aio_unlink "$filename.pst";	1168	aio_unlink "$filename.pst";
842	}	1169	}
…		…
847	}	1174	}
848	} else {	1175	} else {
849	aio_unlink $filename;	1176	aio_unlink $filename;
850	aio_unlink "$filename.pst";	1177	aio_unlink "$filename.pst";
851	}	1178	}
852	}	1179	};
853	}	1180	}
854		1181
855	sub object_freezer_as_string {	1182	sub object_freezer_as_string {
856	my ($rdata, $objs) = @_;	1183	my ($rdata, $objs) = @_;
857		1184
…		…
869	or return;	1196	or return;
870		1197
871	unless (aio_stat "$filename.pst") {	1198	unless (aio_stat "$filename.pst") {
872	(aio_load "$filename.pst", $av) >= 0	1199	(aio_load "$filename.pst", $av) >= 0
873	or return;	1200	or return;
		1201
874	$av = eval { (Storable::thaw $av)->{objs} };	1202	my $st = eval { Coro::Storable::thaw $av };
		1203	$av = $st->{objs};
875	}	1204	}
876		1205
		1206	utf8::decode (my $decname = $filename);
877	warn sprintf "loading %s (%d)\n",	1207	warn sprintf "loading %s (%d,%d)\n",
878	$filename, length $data, scalar @{$av || []};#d#	1208	$decname, length $data, scalar @{$av || []};
		1209
879	return ($data, $av);	1210	($data, $av)
880	}	1211	}
		1212
		1213	=head2 COMMAND CALLBACKS
		1214
		1215	=over 4
		1216
		1217	=cut
881		1218
882	#############################################################################	1219	#############################################################################
883	# command handling &c	1220	# command handling &c
884		1221
885	=item cf::register_command $name => \&callback($ob,$args);	1222	=item cf::register_command $name => \&callback($ob,$args);
…		…
898	push @{ $COMMAND{$name} }, [$caller, $cb];	1235	push @{ $COMMAND{$name} }, [$caller, $cb];
899	}	1236	}
900		1237
901	=item cf::register_extcmd $name => \&callback($pl,$packet);	1238	=item cf::register_extcmd $name => \&callback($pl,$packet);
902		1239
903	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.
904		1245
905	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
906	called.	1247	called.
907		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
908	=cut	1260	=cut
909		1261
910	sub register_extcmd {	1262	sub register_extcmd {
911	my ($name, $cb) = @_;	1263	my ($name, $cb) = @_;
912		1264
913	my $caller = caller;
914	#warn "registering extcmd '$name' to '$caller'";
915
916	$EXTCMD{$name} = [$cb, $caller];	1265	$EXTCMD{$name} = $cb;
		1266	}
		1267
		1268	sub register_exticmd {
		1269	my ($name, $cb) = @_;
		1270
		1271	$EXTICMD{$name} = $cb;
917	}	1272	}
918		1273
919	cf::player->attach (	1274	cf::player->attach (
920	on_command => sub {	1275	on_command => sub {
921	my ($pl, $name, $params) = @_;	1276	my ($pl, $name, $params) = @_;
…		…
930	cf::override;	1285	cf::override;
931	},	1286	},
932	on_extcmd => sub {	1287	on_extcmd => sub {
933	my ($pl, $buf) = @_;	1288	my ($pl, $buf) = @_;
934		1289
935	my $msg = eval { from_json $buf };	1290	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
936		1291
937	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
938	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1300	if (my $cb = $EXTCMD{$type}) {
939	if (my %reply = $cb->[0]->($pl, $msg)) {	1301	@reply = $cb->($pl, @payload);
940	$pl->ext_reply ($msg->{msgid}, %reply);
941	}
942	}	1302	}
		1303
		1304	$pl->ext_reply ($reply, @reply)
		1305	if $reply;
		1306
943	} else {	1307	} else {
944	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1308	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
945	}	1309	}
946		1310
947	cf::override;	1311	cf::override;
948	},	1312	},
949	);	1313	);
950		1314
951	sub register {
952	my ($base, $pkg) = @_;
953
954	#TODO
955	}
956
957	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($) {
958	my ($path) = @_;	1670	my ($path) = @_;
959		1671
960	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1672	my ($match, $specificity);
961	my $base = $1;
962	my $pkg = $1;
963	$pkg =~ s/[^[:word:]]/_/g;
964	$pkg = "ext::$pkg";
965		1673
966	warn "loading '$path' into '$pkg'\n";	1674	for my $region (list) {
967		1675	if ($region->{match} && $path =~ $region->{match}) {
968	open my $fh, "<:utf8", $path	1676	($match, $specificity) = ($region, $region->specificity)
969	or die "$path: $!";	1677	if $region->specificity > $specificity;
970		1678	}
971	my $source =
972	"package $pkg; use strict; use utf8;\n"
973	. "#line 1 \"$path\"\n{\n"
974	. (do { local $/; <$fh> })
975	. "\n};\n1";
976
977	eval $source
978	or die $@ ? "$path: $@\n"
979	: "extension disabled.\n";
980
981	push @exts, $pkg;
982	$ext_pkg{$base} = $pkg;
983
984	# no strict 'refs';
985	# @{"$pkg\::ISA"} = ext::;
986
987	register $base, $pkg;
988	}
989
990	sub unload_extension {
991	my ($pkg) = @_;
992
993	warn "removing extension $pkg\n";
994
995	# remove hooks
996	#TODO
997	# for my $idx (0 .. $#PLUGIN_EVENT) {
998	# delete $hook[$idx]{$pkg};
999	# }	1679	}
1000		1680
1001	# remove commands	1681	$match
1002	for my $name (keys %COMMAND) {
1003	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1004
1005	if (@cb) {
1006	$COMMAND{$name} = \@cb;
1007	} else {
1008	delete $COMMAND{$name};
1009	}
1010	}
1011
1012	# remove extcmds
1013	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1014	delete $EXTCMD{$name};
1015	}
1016
1017	if (my $cb = $pkg->can ("unload")) {
1018	eval {
1019	$cb->($pkg);
1020	1
1021	} or warn "$pkg unloaded, but with errors: $@";
1022	}
1023
1024	Symbol::delete_package $pkg;
1025	}
1026
1027	sub load_extensions {
1028	for my $ext (<$LIBDIR/*.ext>) {
1029	next unless -r $ext;
1030	eval {
1031	load_extension $ext;
1032	1
1033	} or warn "$ext not loaded: $@";
1034	}
1035	}
1036
1037	#############################################################################
1038	# load/save/clean perl data associated with a map
1039
1040	*cf::mapsupport::on_clean = sub {
1041	my ($map) = @_;
1042
1043	my $path = $map->tmpname;
1044	defined $path or return;
1045
1046	unlink "$path.pst";
1047	};
1048
1049	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1050
1051	#############################################################################
1052	# load/save perl data associated with player->ob objects
1053
1054	sub all_objects(@) {
1055	@_, map all_objects ($_->inv), @_
1056	}
1057
1058	# TODO: compatibility cruft, remove when no longer needed
1059	cf::player->attach (
1060	on_load => sub {
1061	my ($pl, $path) = @_;
1062
1063	for my $o (all_objects $pl->ob) {
1064	if (my $value = $o->get_ob_key_value ("_perl_data")) {
1065	$o->set_ob_key_value ("_perl_data");
1066
1067	%$o = %{ Storable::thaw pack "H*", $value };
1068	}
1069	}
1070	},
1071	);
1072
1073	#############################################################################
1074
1075	=head2 CORE EXTENSIONS
1076
1077	Functions and methods that extend core crossfire objects.
1078
1079	=head3 cf::player
1080
1081	=over 4
1082
1083	=item cf::player::exists $login
1084
1085	Returns true when the given account exists.
1086
1087	=cut
1088
1089	sub cf::player::exists($) {
1090	cf::player::find $_[0]
1091	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1092	}
1093
1094	=item $player->ext_reply ($msgid, $msgtype, %msg)
1095
1096	Sends an ext reply to the player.
1097
1098	=cut
1099
1100	sub cf::player::ext_reply($$$%) {
1101	my ($self, $id, %msg) = @_;
1102
1103	$msg{msgid} = $id;
1104
1105	$self->send ("ext " . to_json \%msg);
1106	}	1682	}
1107		1683
1108	=back	1684	=back
1109
1110		1685
1111	=head3 cf::map	1686	=head3 cf::map
1112		1687
1113	=over 4	1688	=over 4
1114		1689
…		…
1117	package cf::map;	1692	package cf::map;
1118		1693
1119	use Fcntl;	1694	use Fcntl;
1120	use Coro::AIO;	1695	use Coro::AIO;
1121		1696
		1697	use overload
		1698	'""' => \&as_string,
		1699	fallback => 1;
		1700
1122	our $MAX_RESET = 3600;	1701	our $MAX_RESET = 3600;
1123	our $DEFAULT_RESET = 3000;	1702	our $DEFAULT_RESET = 3000;
1124		1703
1125	sub generate_random_map {	1704	sub generate_random_map {
1126	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
1127		1708
1128	# mit "rum" bekleckern, nicht	1709	# mit "rum" bekleckern, nicht
1129	cf::map::_create_random_map	1710	$self->_create_random_map (
1130	$path,
1131	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1711	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1132	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1712	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1133	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1713	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1134	$rmp->{exit_on_final_map},	1714	$rmp->{exit_on_final_map},
1135	$rmp->{xsize}, $rmp->{ysize},	1715	$rmp->{xsize}, $rmp->{ysize},
1136	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1716	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1137	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1717	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1138	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1718	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1139	$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},
1140	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1720	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1141	(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"
1142	}	1850	}
1143		1851
1144	# and all this just because we cannot iterate over	1852	# and all this just because we cannot iterate over
1145	# all maps in C++...	1853	# all maps in C++...
1146	sub change_all_map_light {	1854	sub change_all_map_light {
…		…
1148		1856
1149	$_->change_map_light ($change)	1857	$_->change_map_light ($change)
1150	for grep $_->outdoor, values %cf::MAP;	1858	for grep $_->outdoor, values %cf::MAP;
1151	}	1859	}
1152		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
1153	sub try_load_header($) {	1877	sub load_header_from($) {
1154	my ($path) = @_;	1878	my ($self, $path) = @_;
1155		1879
1156	utf8::encode $path;	1880	utf8::encode $path;
1157	aio_open $path, O_RDONLY, 0	1881	my $f = new_from_file cf::object::thawer $path
1158	or return;	1882	or return;
1159		1883
1160	my $map = cf::map::new	1884	$self->_load_header ($f)
1161	or return;	1885	or return;
1162		1886
1163	# for better error messages only, will be overwritten	1887	local $MAP_LOADING{$self->{path}} = $self;
1164	$map->path ($path);	1888	$f->resolve_delayed_derefs;
1165		1889
1166	$map->load_header ($path)	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
1167	or return;	1933	or return;
		1934	$self->prepare_orig;
		1935	}
1168		1936
1169	$map->{load_path} = $path;	1937	$self->{deny_reset} = 1
		1938	if $self->no_reset;
1170		1939
1171	$map	1940	$self->default_region (cf::region::find_by_path $self->{path})
		1941	unless $self->default_region;
		1942
		1943	1
1172	}	1944	}
1173		1945
1174	sub find;	1946	sub find;
1175	sub find {	1947	sub find {
1176	my ($path, $origin) = @_;	1948	my ($path, $origin) = @_;
1177		1949
1178	#warn "find<$path,$origin>\n";#d#
1179
1180	$path = new cf::path $path, $origin && $origin->path;	1950	$path = normalise $path, $origin && $origin->path;
1181	my $key = $path->as_string;
1182		1951
		1952	cf::lock_wait "map_data:$path";#d#remove
1183	cf::lock_wait "map_find:$key";	1953	cf::lock_wait "map_find:$path";
1184		1954
1185	$cf::MAP{$key} || do {	1955	$cf::MAP{$path} || do {
		1956	my $guard1 = cf::lock_acquire "map_data:$path"; # just for the fun of it
1186	my $guard = cf::lock_acquire "map_find:$key";	1957	my $guard2 = cf::lock_acquire "map_find:$path";
1187		1958
1188	# do it the slow way	1959	my $map = new_from_path cf::map $path
1189	my $map = try_load_header $path->save_path;
1190
1191	Coro::cede;
1192
1193	if ($map) {
1194	$map->last_access ((delete $map->{last_access})
1195	|| $cf::RUNTIME); #d#
1196	# safety
1197	$map->{instantiate_time} = $cf::RUNTIME
1198	if $map->{instantiate_time} > $cf::RUNTIME;
1199	} else {
1200	if (my $rmp = $path->random_map_params) {
1201	$map = generate_random_map $key, $rmp;
1202	} else {
1203	$map = try_load_header $path->load_path;
1204	}
1205
1206	$map or return;	1960	or return;
1207		1961
1208	$map->{load_original} = 1;
1209	$map->{instantiate_time} = $cf::RUNTIME;
1210	$map->last_access ($cf::RUNTIME);
1211	$map->instantiate;
1212
1213	# per-player maps become, after loading, normal maps
1214	$map->per_player (0) if $path->{user_rel};
1215	}
1216
1217	$map->path ($key);
1218	$map->{path} = $path;
1219	$map->{last_save} = $cf::RUNTIME;	1962	$map->{last_save} = $cf::RUNTIME;
1220		1963
1221	Coro::cede;	1964	$map->load_header
		1965	or return;
1222		1966
1223	if ($map->should_reset) {	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;
1224	$map->reset;	1972	$map->reset;
1225	undef $guard;
1226	$map = find $path	1973	return find $path;
1227	or return;
1228	}	1974	}
1229		1975
1230	$cf::MAP{$key} = $map	1976	$cf::MAP{$path} = $map
1231	}	1977	}
1232	}	1978	}
		1979
		1980	sub pre_load { }
		1981	sub post_load { }
1233		1982
1234	sub load {	1983	sub load {
1235	my ($self) = @_;	1984	my ($self) = @_;
1236		1985
		1986	local $self->{deny_reset} = 1; # loading can take a long time
		1987
1237	my $path = $self->{path};	1988	my $path = $self->{path};
		1989
		1990	{
1238	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	1991	my $guard = cf::lock_acquire "map_data:$path";
1239		1992
		1993	return unless $self->valid;
1240	return if $self->in_memory != cf::MAP_SWAPPED;	1994	return unless $self->in_memory == cf::MAP_SWAPPED;
1241		1995
1242	$self->in_memory (cf::MAP_LOADING);	1996	$self->in_memory (cf::MAP_LOADING);
1243		1997
1244	$self->alloc;	1998	$self->alloc;
1245	$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)
1246	or return;	2006	or return;
1247		2007
1248	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2008	$self->post_load_original
1249	if delete $self->{load_original};	2009	if delete $self->{load_original};
1250		2010
1251	if (my $uniq = $path->uniq_path) {	2011	if (my $uniq = $self->uniq_path) {
1252	utf8::encode $uniq;	2012	utf8::encode $uniq;
1253	if (aio_open $uniq, O_RDONLY, 0) {	2013	unless (aio_stat $uniq) {
		2014	if (my $f = new_from_file cf::object::thawer $uniq) {
1254	$self->clear_unique_items;	2015	$self->clear_unique_items;
1255	$self->load_objects ($uniq, 0);	2016	$self->_load_objects ($f);
		2017	$f->resolve_delayed_derefs;
		2018	}
1256	}	2019	}
1257	}	2020	}
1258		2021
1259	Coro::cede;	2022	$f->resolve_delayed_derefs;
1260		2023
		2024	cf::cede_to_tick;
1261	# now do the right thing for maps	2025	# now do the right thing for maps
1262	$self->link_multipart_objects;	2026	$self->link_multipart_objects;
1263
1264	if ($self->{path}->is_style_map) {
1265	$self->{deny_save} = 1;
1266	$self->{deny_reset} = 1;
1267	} else {
1268	$self->fix_auto_apply;
1269	$self->decay_objects;
1270	$self->update_buttons;
1271	$self->set_darkness_map;
1272	$self->difficulty ($self->estimate_difficulty)	2027	$self->difficulty ($self->estimate_difficulty)
1273	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;
1274	$self->activate;	2038	$self->activate;
1275	}	2039	}
1276		2040
1277	Coro::cede;	2041	$self->{last_save} = $cf::RUNTIME;
		2042	$self->last_access ($cf::RUNTIME);
1278		2043
1279	$self->in_memory (cf::MAP_IN_MEMORY);	2044	$self->in_memory (cf::MAP_ACTIVE);
		2045	}
		2046
		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	}
1280	}	2086	}
1281		2087
1282	sub find_sync {	2088	sub find_sync {
1283	my ($path, $origin) = @_;	2089	my ($path, $origin) = @_;
1284		2090
1285	cf::sync_job { cf::map::find $path, $origin }	2091	cf::sync_job { find $path, $origin }
1286	}	2092	}
1287		2093
1288	sub do_load_sync {	2094	sub do_load_sync {
1289	my ($map) = @_;	2095	my ($map) = @_;
1290		2096
		2097	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2098	if $Coro::current == $Coro::main;
		2099
1291	cf::sync_job { $map->load };	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;
		2130	};
		2131	$MAP_PREFETCHER->prio (6);
		2132
		2133	()
1292	}	2134	}
1293		2135
1294	sub save {	2136	sub save {
1295	my ($self) = @_;	2137	my ($self) = @_;
1296		2138
1297	my $lock = cf::lock_acquire "map_data:" . $self->path;	2139	my $lock = cf::lock_acquire "map_data:$self->{path}";
1298		2140
1299	$self->{last_save} = $cf::RUNTIME;	2141	$self->{last_save} = $cf::RUNTIME;
1300		2142
1301	return unless $self->dirty;	2143	return unless $self->dirty;
1302		2144
1303	my $save = $self->{path}->save_path; utf8::encode $save;	2145	my $save = $self->save_path; utf8::encode $save;
1304	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	2146	my $uniq = $self->uniq_path; utf8::encode $uniq;
1305		2147
1306	$self->{load_path} = $save;	2148	$self->{load_path} = $save;
1307		2149
1308	return if $self->{deny_save};	2150	return if $self->{deny_save};
1309		2151
1310	local $self->{last_access} = $self->last_access;#d#	2152	local $self->{last_access} = $self->last_access;#d#
1311		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;
		2160
1312	if ($uniq) {	2161	if ($uniq) {
1313	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2162	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1314	$self->save_objects ($uniq, cf::IO_UNIQUES);	2163	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1315	} else {	2164	} else {
1316	$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);
1317	}	2166	}
1318	}	2167	}
1319		2168
1320	sub swap_out {	2169	sub swap_out {
1321	my ($self) = @_;	2170	my ($self) = @_;
1322		2171
1323	# save first because save cedes	2172	# save first because save cedes
1324	$self->save;	2173	$self->save;
1325		2174
1326	my $lock = cf::lock_acquire "map_data:" . $self->path;	2175	my $lock = cf::lock_acquire "map_data:$self->{path}";
1327		2176
1328	return if $self->players;	2177	return if $self->players;
1329	return if $self->in_memory != cf::MAP_IN_MEMORY;	2178	return if $self->in_memory != cf::MAP_ACTIVE;
1330	return if $self->{deny_save};	2179	return if $self->{deny_save};
1331		2180
		2181	$self->in_memory (cf::MAP_SWAPPED);
		2182
		2183	$self->deactivate;
		2184	$_->clear_links_to ($self) for values %cf::MAP;
1332	$self->clear;	2185	$self->clear;
1333	$self->in_memory (cf::MAP_SWAPPED);
1334	}	2186	}
1335		2187
1336	sub reset_at {	2188	sub reset_at {
1337	my ($self) = @_;	2189	my ($self) = @_;
1338		2190
1339	# TODO: safety, remove and allow resettable per-player maps	2191	# TODO: safety, remove and allow resettable per-player maps
1340	return 1e99 if $self->{path}{user_rel};
1341	return 1e99 if $self->{deny_reset};	2192	return 1e99 if $self->{deny_reset};
1342		2193
1343	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2194	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1344	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2195	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1345		2196
…		…
1350	my ($self) = @_;	2201	my ($self) = @_;
1351		2202
1352	$self->reset_at <= $cf::RUNTIME	2203	$self->reset_at <= $cf::RUNTIME
1353	}	2204	}
1354		2205
1355	sub unlink_save {
1356	my ($self) = @_;
1357
1358	utf8::encode (my $save = $self->{path}->save_path);
1359	aioreq_pri 3; IO::AIO::aio_unlink $save;
1360	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1361	}
1362
1363	sub rename {
1364	my ($self, $new_path) = @_;
1365
1366	$self->unlink_save;
1367
1368	delete $cf::MAP{$self->path};
1369	$self->{path} = new cf::path $new_path;
1370	$self->path ($self->{path}->as_string);
1371	$cf::MAP{$self->path} = $self;
1372
1373	$self->save;
1374	}
1375
1376	sub reset {	2206	sub reset {
1377	my ($self) = @_;	2207	my ($self) = @_;
1378		2208
1379	my $lock = cf::lock_acquire "map_data:" . $self->path;	2209	my $lock = cf::lock_acquire "map_data:$self->{path}";
1380		2210
1381	return if $self->players;	2211	return if $self->players;
1382	return if $self->{path}{user_rel};#d#
1383		2212
1384	warn "resetting map ", $self->path;#d#	2213	warn "resetting map ", $self->path;
		2214
		2215	$self->in_memory (cf::MAP_SWAPPED);
		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	}
1385		2224
1386	delete $cf::MAP{$self->path};	2225	delete $cf::MAP{$self->path};
1387		2226
		2227	$self->deactivate;
1388	$_->clear_links_to ($self) for values %cf::MAP;	2228	$_->clear_links_to ($self) for values %cf::MAP;
		2229	$self->clear;
1389		2230
1390	$self->unlink_save;	2231	$self->unlink_save;
1391	$self->destroy;	2232	$self->destroy;
1392	}	2233	}
1393		2234
1394	my $nuke_counter = "aaaa";	2235	my $nuke_counter = "aaaa";
1395		2236
1396	sub nuke {	2237	sub nuke {
1397	my ($self) = @_;	2238	my ($self) = @_;
1398		2239
		2240	{
		2241	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2242
		2243	delete $cf::MAP{$self->path};
		2244
		2245	$self->unlink_save;
		2246
		2247	bless $self, "cf::map";
		2248	delete $self->{deny_reset};
1399	$self->{deny_save} = 1;	2249	$self->{deny_save} = 1;
1400	$self->reset_timeout (1);	2250	$self->reset_timeout (1);
1401	$self->rename ("{nuke}/" . ($nuke_counter++));	2251	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2252
		2253	$cf::MAP{$self->path} = $self;
		2254	}
		2255
1402	$self->reset; # polite request, might not happen	2256	$self->reset; # polite request, might not happen
1403	}	2257	}
1404		2258
1405	sub customise_for {	2259	=item $maps = cf::map::tmp_maps
1406	my ($map, $ob) = @_;
1407		2260
1408	if ($map->per_player) {	2261	Returns an arrayref with all map paths of currently instantiated and saved
1409	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	2262	maps. May block.
		2263
		2264	=cut
		2265
		2266	sub tmp_maps() {
1410	}	2267	[
1411		2268	map {
1412	$map	2269	utf8::decode $_;
		2270	/\.map$/
		2271	? normalise $_
		2272	: ()
		2273	} @{ aio_readdir $TMPDIR or [] }
		2274	]
1413	}	2275	}
1414		2276
1415	sub emergency_save {	2277	=item $maps = cf::map::random_maps
1416	my $freeze_guard = cf::freeze_mainloop;
1417		2278
1418	warn "enter emergency map save\n";	2279	Returns an arrayref with all map paths of currently instantiated and saved
		2280	random maps. May block.
1419		2281
1420	cf::sync_job {	2282	=cut
1421	warn "begin emergency map save\n";	2283
1422	$_->save for values %cf::MAP;	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
1423	};	2365	}
1424
1425	warn "end emergency map save\n";
1426	}	2366	}
1427		2367
1428	package cf;	2368	package cf;
1429		2369
1430	=back	2370	=back
1431
1432		2371
1433	=head3 cf::object::player	2372	=head3 cf::object::player
1434		2373
1435	=over 4	2374	=over 4
1436		2375
…		…
1439	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>
1440	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
1441	dialogue with the given NPC character.	2380	dialogue with the given NPC character.
1442		2381
1443	=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	};
1444		2397
1445	# rough implementation of a future "reply" method that works	2398	# rough implementation of a future "reply" method that works
1446	# with dialog boxes.	2399	# with dialog boxes.
1447	#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
1448	sub cf::object::player::reply($$$;$) {	2401	sub cf::object::player::reply($$$;$) {
…		…
1450		2403
1451	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2404	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1452		2405
1453	if ($self->{record_replies}) {	2406	if ($self->{record_replies}) {
1454	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2407	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2408
1455	} 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 {
1456	$msg = $npc->name . " says: $msg" if $npc;	2417	$msg = $npc->name . " says: $msg" if $npc;
1457	$self->message ($msg, $flags);	2418	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2419	}
1458	}	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 (@_);
1459	}	2431	}
1460		2432
1461	=item $player_object->may ("access")	2433	=item $player_object->may ("access")
1462		2434
1463	Returns wether the given player is authorized to access resource "access"	2435	Returns wether the given player is authorized to access resource "access"
…		…
1476		2448
1477	=item $player_object->enter_link	2449	=item $player_object->enter_link
1478		2450
1479	Freezes the player and moves him/her to a special map (C<{link}>).	2451	Freezes the player and moves him/her to a special map (C<{link}>).
1480		2452
1481	The player should be reaosnably safe there for short amounts of time. You	2453	The player should be reasonably safe there for short amounts of time (e.g.
1482	I<MUST> call C<leave_link> as soon as possible, though.	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.
1483		2459
1484	=item $player_object->leave_link ($map, $x, $y)	2460	=item $player_object->leave_link ($map, $x, $y)
1485		2461
1486	Moves the player out of the specila link map onto the given map. If the	2462	Moves the player out of the special C<{link}> map onto the specified
1487	map is not valid (or omitted), the player will be moved back to the	2463	map. If the map is not valid (or omitted), the player will be moved back
1488	location he/she was before the call to C<enter_link>, or, if that fails,	2464	to the location he/she was before the call to C<enter_link>, or, if that
1489	to the emergency map position.	2465	fails, to the emergency map position.
1490		2466
1491	Might block.	2467	Might block.
1492		2468
1493	=cut	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	}
1494		2480
1495	sub cf::object::player::enter_link {	2481	sub cf::object::player::enter_link {
1496	my ($self) = @_;	2482	my ($self) = @_;
1497		2483
1498	$self->deactivate_recursive;	2484	$self->deactivate_recursive;
1499		2485
1500	return if $self->map == $LINK_MAP;	2486	return if UNIVERSAL::isa $self->map, "ext::map_link";
1501		2487
1502	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2488	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1503	if $self->map;	2489	if $self->map && $self->map->{path} ne "{link}";
1504		2490
1505	$self->enter_map ($LINK_MAP, 20, 20);	2491	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1506	}	2492	}
1507		2493
1508	sub cf::object::player::leave_link {	2494	sub cf::object::player::leave_link {
1509	my ($self, $map, $x, $y) = @_;	2495	my ($self, $map, $x, $y) = @_;
		2496
		2497	return unless $self->contr->active;
1510		2498
1511	my $link_pos = delete $self->{_link_pos};	2499	my $link_pos = delete $self->{_link_pos};
1512		2500
1513	unless ($map) {	2501	unless ($map) {
1514	# restore original map position	2502	# restore original map position
…		…
1528	# use -1 or undef as default coordinates, not 0, 0	2516	# use -1 or undef as default coordinates, not 0, 0
1529	($x, $y) = ($map->enter_x, $map->enter_y)	2517	($x, $y) = ($map->enter_x, $map->enter_y)
1530	if $x <=0 && $y <= 0;	2518	if $x <=0 && $y <= 0;
1531		2519
1532	$map->load;	2520	$map->load;
		2521	$map->load_neighbours;
1533		2522
		2523	return unless $self->contr->active;
		2524	$self->flag (cf::FLAG_DEBUG, 0);#d# temp
1534	$self->activate_recursive;	2525	$self->activate_recursive;
		2526
		2527	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1535	$self->enter_map ($map, $x, $y);	2528	$self->enter_map ($map, $x, $y);
1536	}	2529	}
1537		2530
1538	cf::player->attach (	2531	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1539	on_logout => sub {
1540	my ($pl) = @_;
1541		2532
1542	# abort map switching before logout	2533	Moves the player to the given map-path and coordinates by first freezing
1543	if ($pl->ob->{_link_pos}) {	2534	her, loading and preparing them map, calling the provided $check callback
1544	cf::sync_job {	2535	that has to return the map if sucecssful, and then unfreezes the player on
1545	$pl->ob->leave_link	2536	the new (success) or old (failed) map position. In either case, $done will
1546	};	2537	be called at the end of this process.
1547	}
1548	},
1549	on_login => sub {
1550	my ($pl) = @_;
1551		2538
1552	# try to abort aborted map switching on player login :)	2539	Note that $check will be called with a potentially non-loaded map, so if
1553	# should happen only on crashes	2540	it needs a loaded map it has to call C<< ->load >>.
1554	if ($pl->ob->{_link_pos}) {
1555		2541
1556	$pl->ob->enter_link;
1557	(async {
1558	# we need this sleep as the login has a concurrent enter_exit running
1559	# and this sleep increases chances of the player not ending up in scorn
1560	$pl->ob->reply (undef,
1561	"There was an internal problem at your last logout, "
1562	. "the server will try to bring you to your intended destination in a second.",
1563	cf::NDI_RED);
1564	Coro::Timer::sleep 1;
1565	$pl->ob->leave_link;
1566	})->prio (2);
1567	}
1568	},
1569	);
1570
1571	=item $player_object->goto ($path, $x, $y)
1572
1573	=cut	2542	=cut
		2543
		2544	our $GOTOGEN;
1574		2545
1575	sub cf::object::player::goto {	2546	sub cf::object::player::goto {
1576	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;
1577		2551
1578	$self->enter_link;	2552	$self->enter_link;
1579		2553
1580	(async {	2554	(async {
1581	$path = new cf::path $path;	2555	$Coro::current->{desc} = "player::goto $path $x $y";
1582		2556
1583	my $map = cf::map::find $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) {
1584	$map = $map->customise_for ($self) if $map;	2580	$map = $map->customise_for ($self);
1585		2581	$map = $check->($map) if $check && $map;
1586	# warn "entering ", $map->path, " at ($x, $y)\n"	2582	} else {
1587	# if $map;
1588
1589	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2583	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2584	}
1590		2585
		2586	$map
		2587	};
		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};
1591	$self->leave_link ($map, $x, $y);	2596	$self->leave_link ($map, $x, $y);
		2597	}
		2598
		2599	$done->() if $done;
1592	})->prio (1);	2600	})->prio (1);
1593	}	2601	}
1594		2602
1595	=item $player_object->enter_exit ($exit_object)	2603	=item $player_object->enter_exit ($exit_object)
1596		2604
…		…
1598		2606
1599	sub parse_random_map_params {	2607	sub parse_random_map_params {
1600	my ($spec) = @_;	2608	my ($spec) = @_;
1601		2609
1602	my $rmp = { # defaults	2610	my $rmp = { # defaults
1603	xsize => 10,	2611	xsize => (cf::rndm 15, 40),
1604	ysize => 10,	2612	ysize => (cf::rndm 15, 40),
		2613	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2614	#layout => string,
1605	};	2615	};
1606		2616
1607	for (split /\n/, $spec) {	2617	for (split /\n/, $spec) {
1608	my ($k, $v) = split /\s+/, $_, 2;	2618	my ($k, $v) = split /\s+/, $_, 2;
1609		2619
…		…
1621	# that depends on the exit object	2631	# that depends on the exit object
1622		2632
1623	my $rmp = parse_random_map_params $exit->msg;	2633	my $rmp = parse_random_map_params $exit->msg;
1624		2634
1625	if ($exit->map) {	2635	if ($exit->map) {
1626	$rmp->{region} = $exit->map->region_name;	2636	$rmp->{region} = $exit->region->name;
1627	$rmp->{origin_map} = $exit->map->path;	2637	$rmp->{origin_map} = $exit->map->path;
1628	$rmp->{origin_x} = $exit->x;	2638	$rmp->{origin_x} = $exit->x;
1629	$rmp->{origin_y} = $exit->y;	2639	$rmp->{origin_y} = $exit->y;
		2640
		2641	$exit->map->touch;
1630	}	2642	}
1631		2643
1632	$rmp->{random_seed} ||= $exit->random_seed;	2644	$rmp->{random_seed} ||= $exit->random_seed;
1633		2645
1634	my $data = cf::to_json $rmp;	2646	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1635	my $md5 = Digest::MD5::md5_hex $data;	2647	my $md5 = Digest::MD5::md5_hex $data;
		2648	my $meta = "$RANDOMDIR/$md5.meta";
1636		2649
1637	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) {
1638	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;
1639		2654
		2655	my $slaying = "?random/$md5";
		2656
		2657	if ($exit->valid) {
1640	$exit->slaying ("?random/$md5");	2658	$exit->slaying ("?random/$md5");
1641	$exit->msg (undef);	2659	$exit->msg (undef);
		2660	}
1642	}	2661	}
1643	}	2662	}
1644		2663
1645	sub cf::object::player::enter_exit {	2664	sub cf::object::player::enter_exit {
1646	my ($self, $exit) = @_;	2665	my ($self, $exit) = @_;
…		…
1648	return unless $self->type == cf::PLAYER;	2667	return unless $self->type == cf::PLAYER;
1649		2668
1650	$self->enter_link;	2669	$self->enter_link;
1651		2670
1652	(async {	2671	(async {
1653	$self->deactivate_recursive; # just to be sure	2672	$Coro::current->{desc} = "enter_exit";
		2673
1654	unless (eval {	2674	unless (eval {
		2675	$self->deactivate_recursive; # just to be sure
		2676
		2677	# random map handling
		2678	{
		2679	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2680
1655	prepare_random_map $exit	2681	prepare_random_map $exit
1656	if $exit->slaying eq "/!";	2682	if $exit->slaying eq "/!";
		2683	}
1657		2684
1658	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;
1659	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);	2686	my $x = $exit->stats->hp;
		2687	my $y = $exit->stats->sp;
1660		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
1661	1;	2695	1
1662	}) {	2696	}) {
1663	$self->message ("Something went wrong deep within the crossfire server. "	2697	$self->message ("Something went wrong deep within the crossfire server. "
1664	. "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. "
1665	. "Please report this to the dungeon master",	2699	. "Please report this to the dungeon master!",
1666	cf::NDI_UNIQUE | cf::NDI_RED);	2700	cf::NDI_UNIQUE | cf::NDI_RED);
1667		2701
1668	warn "ERROR in enter_exit: $@";	2702	warn "ERROR in enter_exit: $@";
1669	$self->leave_link;	2703	$self->leave_link;
1670	}	2704	}
1671	})->prio (1);	2705	})->prio (1);
…		…
1684		2718
1685	sub cf::client::send_drawinfo {	2719	sub cf::client::send_drawinfo {
1686	my ($self, $text, $flags) = @_;	2720	my ($self, $text, $flags) = @_;
1687		2721
1688	utf8::encode $text;	2722	utf8::encode $text;
1689	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2723	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1690	}	2724	}
1691		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	}
1692		2904
1693	=item $success = $client->query ($flags, "text", \&cb)	2905	=item $success = $client->query ($flags, "text", \&cb)
1694		2906
1695	Queues a query to the client, calling the given callback with	2907	Queues a query to the client, calling the given callback with
1696	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>,
1697	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>.
1698		2910
1699	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
1700	reliable at some point in the future.	2912	become reliable at some point in the future.
1701		2913
1702	=cut	2914	=cut
1703		2915
1704	sub cf::client::query {	2916	sub cf::client::query {
1705	my ($self, $flags, $text, $cb) = @_;	2917	my ($self, $flags, $text, $cb) = @_;
…		…
1713	utf8::encode $text;	2925	utf8::encode $text;
1714	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2926	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1715		2927
1716	$self->send_packet ($self->{query_queue}[0][0])	2928	$self->send_packet ($self->{query_queue}[0][0])
1717	if @{ $self->{query_queue} } == 1;	2929	if @{ $self->{query_queue} } == 1;
		2930
		2931	1
1718	}	2932	}
1719		2933
1720	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	},
1721	on_reply => sub {	2940	on_reply => sub {
1722	my ($ns, $msg) = @_;	2941	my ($ns, $msg) = @_;
1723		2942
1724	# this weird shuffling is so that direct followup queries	2943	# this weird shuffling is so that direct followup queries
1725	# get handled first	2944	# get handled first
1726	my $queue = delete $ns->{query_queue}	2945	my $queue = delete $ns->{query_queue}
1727	or return; # be conservative, not sure how that can happen, but we saw a crash here	2946	or return; # be conservative, not sure how that can happen, but we saw a crash here
1728		2947
1729	(shift @$queue)->[1]->($msg);	2948	(shift @$queue)->[1]->($msg);
		2949	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1730		2950
1731	push @{ $ns->{query_queue} }, @$queue;	2951	push @{ $ns->{query_queue} }, @$queue;
1732		2952
1733	if (@{ $ns->{query_queue} } == @$queue) {	2953	if (@{ $ns->{query_queue} } == @$queue) {
1734	if (@$queue) {	2954	if (@$queue) {
…		…
1736	} else {	2956	} else {
1737	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2957	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1738	}	2958	}
1739	}	2959	}
1740	},	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	},
1741	);	2987	);
1742		2988
1743	=item $client->async (\&cb)	2989	=item $client->async (\&cb)
1744		2990
1745	Create a new coroutine, running the specified callback. The coroutine will	2991	Create a new coroutine, running the specified callback. The coroutine will
…		…
1786	our $safe = new Safe "safe";	3032	our $safe = new Safe "safe";
1787	our $safe_hole = new Safe::Hole;	3033	our $safe_hole = new Safe::Hole;
1788		3034
1789	$SIG{FPE} = 'IGNORE';	3035	$SIG{FPE} = 'IGNORE';
1790		3036
1791	$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	));
1792		3042
1793	# here we export the classes and methods available to script code	3043	# here we export the classes and methods available to script code
1794		3044
1795	=pod	3045	=pod
1796		3046
1797	The following fucntions and emthods are available within a safe environment:	3047	The following functions and methods are available within a safe environment:
1798		3048
1799	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
1800	cf::object::player player	3053	cf::object::player
1801	cf::player peaceful	3054	player
1802	cf::map trigger	3055
		3056	cf::player
		3057	peaceful
		3058
		3059	cf::map
		3060	trigger
1803		3061
1804	=cut	3062	=cut
1805		3063
1806	for (	3064	for (
1807	["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)],
1808	["cf::object::player" => qw(player)],	3068	["cf::object::player" => qw(player)],
1809	["cf::player" => qw(peaceful)],	3069	["cf::player" => qw(peaceful)],
1810	["cf::map" => qw(trigger)],	3070	["cf::map" => qw(trigger)],
1811	) {	3071	) {
1812	no strict 'refs';	3072	no strict 'refs';
…		…
1883	=back	3143	=back
1884		3144
1885	=cut	3145	=cut
1886		3146
1887	#############################################################################	3147	#############################################################################
		3148	# the server's init and main functions
1888		3149
1889	=head2 EXTENSION DATABASE SUPPORT	3150	sub load_facedata($) {
		3151	my ($path) = @_;
1890		3152
1891	Crossfire maintains a very simple database for extension use. It can	3153	# HACK to clear player env face cache, we need some signal framework
1892	currently store anything that can be serialised using Storable, which	3154	# for this (global event?)
1893	excludes objects.	3155	%ext::player_env::MUSIC_FACE_CACHE = ();
1894		3156
1895	The parameter C<$family> should best start with the name of the extension	3157	my $enc = JSON::XS->new->utf8->canonical->relaxed;
1896	using it, it should be unique.
1897		3158
1898	=over 4	3159	warn "loading facedata from $path\n";
1899		3160
1900	=item $hashref = cf::db_get $family	3161	my $facedata;
		3162	0 < aio_load $path, $facedata
		3163	or die "$path: $!";
1901		3164
1902	Return a hashref for use by the extension C<$family>, which can be	3165	$facedata = Coro::Storable::thaw $facedata;
1903	modified. After modifications, you have to call C<cf::db_dirty> or
1904	C<cf::db_sync>.
1905		3166
1906	=item $value = cf::db_get $family => $key	3167	$facedata->{version} == 2
		3168	or cf::cleanup "$path: version mismatch, cannot proceed.";
1907		3169
1908	Returns a single value from the database	3170	# patch in the exptable
1909		3171	$facedata->{resource}{"res/exp_table"} = {
1910	=item cf::db_put $family => $hashref	3172	type => FT_RSRC,
1911		3173	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1912	Stores the given family hashref into the database. Updates are delayed, if
1913	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1914
1915	=item cf::db_put $family => $key => $value
1916
1917	Stores the given C<$value> in the family hash. Updates are delayed, if you
1918	want the data to be synced to disk immediately, use C<cf::db_sync>.
1919
1920	=item cf::db_dirty
1921
1922	Marks the database as dirty, to be updated at a later time.
1923
1924	=item cf::db_sync
1925
1926	Immediately write the database to disk I<if it is dirty>.
1927
1928	=cut
1929
1930	our $DB;
1931
1932	{
1933	my $path = cf::localdir . "/database.pst";
1934
1935	sub db_load() {
1936	$DB = stat $path ? Storable::retrieve $path : { };
1937	}
1938
1939	my $pid;
1940
1941	sub db_save() {
1942	waitpid $pid, 0 if $pid;
1943	if (0 == ($pid = fork)) {
1944	$DB->{_meta}{version} = 1;
1945	Storable::nstore $DB, "$path~";
1946	rename "$path~", $path;
1947	cf::_exit 0 if defined $pid;
1948	}
1949	}
1950
1951	my $dirty;
1952
1953	sub db_sync() {
1954	db_save if $dirty;
1955	undef $dirty;
1956	}
1957
1958	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1959	db_sync;
1960	});	3174	};
		3175	cf::cede_to_tick;
1961		3176
1962	sub db_dirty() {
1963	$dirty = 1;
1964	$idle->start;
1965	}	3177	{
		3178	my $faces = $facedata->{faceinfo};
1966		3179
1967	sub db_get($;$) {	3180	while (my ($face, $info) = each %$faces) {
1968	@_ >= 2	3181	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1969	? $DB->{$_[0]}{$_[1]}
1970	: ($DB->{$_[0]} ||= { })
1971	}
1972		3182
1973	sub db_put($$;$) {	3183	cf::face::set_visibility $idx, $info->{visibility};
1974	if (@_ >= 3) {	3184	cf::face::set_magicmap $idx, $info->{magicmap};
1975	$DB->{$_[0]}{$_[1]} = $_[2];	3185	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
1976	} else {	3186	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1977	$DB->{$_[0]} = $_[1];
1978	}
1979	db_dirty;
1980	}
1981		3187
1982	cf::global->attach (	3188	cf::cede_to_tick;
1983	prio => 10000,
1984	on_cleanup => sub {
1985	db_sync;
1986	},	3189	}
1987	);
1988	}
1989		3190
1990	#############################################################################	3191	while (my ($face, $info) = each %$faces) {
1991	# the server's main()	3192	next unless $info->{smooth};
1992		3193
1993	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 {
1994	open my $fh, "<:utf8", cf::confdir . "/config"	3344	open my $fh, "<:utf8", "$CONFDIR/config"
1995	or return;	3345	or return;
1996		3346
1997	local $/;	3347	local $/;
1998	*CFG = YAML::Syck::Load <$fh>;	3348	*CFG = YAML::Load <$fh>;
1999		3349
2000	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3350	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2001		3351
2002	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	3352	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2003	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};	3353	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2004		3354
2005	if (exists $CFG{mlockall}) {	3355	if (exists $CFG{mlockall}) {
2006	eval {	3356	eval {
2007	$CFG{mlockall} ? &mlockall : &munlockall	3357	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2008	and die "WARNING: m(un)lockall failed: $!\n";	3358	and die "WARNING: m(un)lockall failed: $!\n";
2009	};	3359	};
2010	warn $@ if $@;	3360	warn $@ if $@;
2011	}	3361	}
2012	}	3362	}
2013		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 $$;
		3381	}
		3382
2014	sub main {	3383	sub main {
		3384	atomic;
		3385
2015	# we must not ever block the main coroutine	3386	# we must not ever block the main coroutine
2016	local $Coro::idle = sub {	3387	local $Coro::idle = sub {
2017	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3388	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2018	async { Event::one_event };	3389	(async {
		3390	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3391	EV::loop EV::LOOP_ONESHOT;
		3392	})->prio (Coro::PRIO_MAX);
2019	};	3393	};
2020		3394
2021	cfg_load;	3395	{
2022	db_load;	3396	my $guard = freeze_mainloop;
		3397	reload_config;
		3398	db_init;
2023	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
2024	Event::loop;	3409	EV::loop;
2025	}	3410	}
2026		3411
2027	#############################################################################	3412	#############################################################################
2028	# initialisation	3413	# initialisation and cleanup
2029		3414
		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
2030	sub reload() {	3580	sub do_reload_perl() {
2031	# can/must only be called in main	3581	# can/must only be called in main
2032	if ($Coro::current != $Coro::main) {	3582	if ($Coro::current != $Coro::main) {
2033	warn "can only reload from main coroutine\n";	3583	warn "can only reload from main coroutine";
2034	return;	3584	return;
2035	}	3585	}
2036		3586
		3587	return if $RELOAD++;
		3588
		3589	while ($RELOAD) {
2037	warn "reloading...";	3590	warn "reloading...";
2038		3591
2039	my $guard = freeze_mainloop;	3592	warn "entering sync_job";
		3593
		3594	cf::sync_job {
		3595	cf::write_runtime_sync; # external watchdog should not bark
2040	cf::emergency_save;	3596	cf::emergency_save;
		3597	cf::write_runtime_sync; # external watchdog should not bark
2041		3598
2042	eval {	3599	warn "syncing database to disk";
		3600	BDB::db_env_txn_checkpoint $DB_ENV;
		3601
2043	# 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
2044		3603
2045	# cancel all watchers	3604	warn "flushing outstanding aio requests";
2046	for (Event::all_watchers) {	3605	while (IO::AIO::nreqs || BDB::nreqs) {
2047	$_->cancel if $_->data & WF_AUTOCANCEL;	3606	Coro::EV::timer_once 0.01; # let the sync_job do it's thing
2048	}
2049
2050	# cancel all extension coros
2051	$_->cancel for values %EXT_CORO;
2052	%EXT_CORO = ();
2053
2054	# unload all extensions
2055	for (@exts) {
2056	warn "unloading <$_>";
2057	unload_extension $_;
2058	}
2059
2060	# unload all modules loaded from $LIBDIR
2061	while (my ($k, $v) = each %INC) {
2062	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2063
2064	warn "removing <$k>";
2065	delete $INC{$k};
2066
2067	$k =~ s/\.pm$//;
2068	$k =~ s/\//::/g;
2069
2070	if (my $cb = $k->can ("unload_module")) {
2071	$cb->();
2072	}	3607	}
2073		3608
2074	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;
2075	}	3633	}
2076		3634
2077	# sync database to disk	3635	warn "unloading all perl modules loaded from $LIBDIR";
2078	cf::db_sync;	3636	while (my ($k, $v) = each %INC) {
2079	IO::AIO::flush;	3637	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2080		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
2081	# get rid of safe::, as good as possible	3652	warn "getting rid of safe::, as good as possible";
2082	Symbol::delete_package "safe::$_"	3653	clear_package "safe::$_"
2083	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);
2084		3655
2085	# remove register_script_function callbacks	3656	warn "unloading cf.pm \"a bit\"";
2086	# TODO
2087
2088	# unload cf.pm "a bit"
2089	delete $INC{"cf.pm"};	3657	delete $INC{"cf.pm"};
		3658	delete $INC{"cf/pod.pm"};
2090		3659
2091	# don't, removes xs symbols, too,	3660	# don't, removes xs symbols, too,
2092	# and global variables created in xs	3661	# and global variables created in xs
2093	#Symbol::delete_package __PACKAGE__;	3662	#clear_package __PACKAGE__;
2094		3663
2095	# reload cf.pm	3664	warn "unload completed, starting to reload now";
		3665
2096	warn "reloading cf.pm";	3666	warn "reloading cf.pm";
2097	require cf;	3667	require cf;
2098	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3668	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2099		3669
2100	# load config and database again	3670	warn "loading config and database again";
2101	cf::cfg_load;	3671	cf::reload_config;
2102	cf::db_load;
2103		3672
2104	# load extensions
2105	warn "load extensions";	3673	warn "loading extensions";
2106	cf::load_extensions;	3674	cf::load_extensions;
2107		3675
2108	# 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
2109	warn "reattach";	3691	warn "reloaded";
2110	_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;
2111	};	3705	};
2112
2113	if ($@) {
2114	warn $@;
2115	warn "error while reloading, exiting.";
2116	exit 1;
2117	}
2118
2119	warn "reloaded successfully";
2120	};
2121
2122	#############################################################################
2123
2124	unless ($LINK_MAP) {
2125	$LINK_MAP = cf::map::new;
2126
2127	$LINK_MAP->width (41);
2128	$LINK_MAP->height (41);
2129	$LINK_MAP->alloc;
2130	$LINK_MAP->path ("{link}");
2131	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2132	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2133
2134	# dirty hack because... archetypes are not yet loaded
2135	Event->timer (
2136	after => 2,
2137	cb => sub {
2138	$_[0]->w->cancel;
2139
2140	# provide some exits "home"
2141	my $exit = cf::object::new "exit";
2142
2143	$exit->slaying ($EMERGENCY_POSITION->[0]);
2144	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2145	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2146
2147	$LINK_MAP->insert ($exit->clone, 19, 19);
2148	$LINK_MAP->insert ($exit->clone, 19, 20);
2149	$LINK_MAP->insert ($exit->clone, 19, 21);
2150	$LINK_MAP->insert ($exit->clone, 20, 19);
2151	$LINK_MAP->insert ($exit->clone, 20, 21);
2152	$LINK_MAP->insert ($exit->clone, 21, 19);
2153	$LINK_MAP->insert ($exit->clone, 21, 20);
2154	$LINK_MAP->insert ($exit->clone, 21, 21);
2155
2156	$exit->destroy;
2157	});
2158
2159	$LINK_MAP->{deny_save} = 1;
2160	$LINK_MAP->{deny_reset} = 1;
2161
2162	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2163	}	3706	}
2164
2165	register "<global>", __PACKAGE__;
2166		3707
2167	register_command "reload" => sub {	3708	register_command "reload" => sub {
2168	my ($who, $arg) = @_;	3709	my ($who, $arg) = @_;
2169		3710
2170	if ($who->flag (FLAG_WIZ)) {	3711	if ($who->flag (FLAG_WIZ)) {
2171	$who->message ("start of reload.");
2172	reload;
2173	$who->message ("end of reload.");	3712	$who->message ("reloading server.");
		3713	async {
		3714	$Coro::current->{desc} = "perl_reload";
		3715	reload_perl;
		3716	};
2174	}	3717	}
2175	};	3718	};
2176		3719
2177	unshift @INC, $LIBDIR;	3720	unshift @INC, $LIBDIR;
2178		3721
2179	$TICK_WATCHER = Event->timer (	3722	my $bug_warning = 0;
2180	reentrant => 0,	3723
2181	prio => 0,	3724	our @WAIT_FOR_TICK;
2182	at => $NEXT_TICK || $TICK,	3725	our @WAIT_FOR_TICK_BEGIN;
2183	data => WF_AUTOCANCEL,	3726
2184	cb => sub {	3727	sub wait_for_tick {
		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
2185	cf::server_tick; # one server iteration	3750	cf::server_tick; # one server iteration
2186	$RUNTIME += $TICK;
2187	$NEXT_TICK += $TICK;
2188		3751
2189	# if we are delayed by four ticks or more, skip them all	3752	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2190	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3753	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2191		3754	Coro::async_pool {
2192	$TICK_WATCHER->at ($NEXT_TICK);	3755	$Coro::current->{desc} = "runtime saver";
2193	$TICK_WATCHER->start;
2194	},
2195	);
2196
2197	IO::AIO::max_poll_time $TICK * 0.2;
2198
2199	Event->io (
2200	fd => IO::AIO::poll_fileno,
2201	poll => 'r',
2202	prio => 5,
2203	data => WF_AUTOCANCEL,
2204	cb => \&IO::AIO::poll_cb,
2205	);
2206
2207	Event->timer (
2208	data => WF_AUTOCANCEL,
2209	after => 0,
2210	interval => 10,
2211	cb => sub {
2212	(Coro::unblock_sub {
2213	write_runtime	3756	write_runtime_sync
2214	or warn "ERROR: unable to write runtime file: $!";	3757	or warn "ERROR: unable to write runtime file: $!";
2215	})->();	3758	};
2216	},	3759	}
2217	);	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;
2218		3874
2219	END { cf::emergency_save }	3875	END { cf::emergency_save }
2220		3876
2221	1	3877	1
2222		3878

Diff Legend

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