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.100 by root, Mon Dec 25 11:25:49 2006 UTC vs.
Revision 1.614 by root, Mon Nov 26 15:12:16 2012 UTC

		1	#
		2	# This file is part of Deliantra, the Roguelike Realtime MMORPG.
		3	#
		4	# Copyright (©) 2006,2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
		5	#
		6	# Deliantra is free software: you can redistribute it and/or modify it under
		7	# the terms of the Affero GNU General Public License as published by the
		8	# Free Software Foundation, either version 3 of the License, or (at your
		9	# 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 Affero GNU General Public License
		17	# and the GNU General Public License along with this program. If not, see
		18	# <http://www.gnu.org/licenses/>.
		19	#
		20	# The authors can be reached via e-mail to <support@deliantra.net>
		21	#
		22
1	package cf;	23	package cf;
2		24
3	use utf8;	25	use common::sense;
4	use strict;
5		26
6	use Symbol;	27	use Symbol;
7	use List::Util;	28	use List::Util;
8	use Storable;	29	use Socket;
		30	use EV;
9	use Opcode;	31	use Opcode;
10	use Safe;	32	use Safe;
11	use Safe::Hole;	33	use Safe::Hole;
		34	use Storable ();
		35	use Carp ();
12		36
		37	use AnyEvent ();
		38	use AnyEvent::IO ();
		39	use AnyEvent::DNS ();
		40
13	use Coro;	41	use Coro ();
		42	use Coro::State;
		43	use Coro::Handle;
		44	use Coro::EV;
14	use Coro::Event;	45	use Coro::AnyEvent;
15	use Coro::Timer;	46	use Coro::Timer;
16	use Coro::Signal;	47	use Coro::Signal;
17	use Coro::Semaphore;	48	use Coro::Semaphore;
		49	use Coro::SemaphoreSet;
		50	use Coro::AnyEvent;
		51	use Coro::AIO;
		52	use Coro::BDB 1.6;
		53	use Coro::Storable;
		54	use Coro::Util ();
18		55
19	use IO::AIO 2.3;	56	use Guard ();
		57	use JSON::XS 2.01 ();
		58	use BDB ();
		59	use Data::Dumper;
		60	use Fcntl;
20	use YAML::Syck ();	61	use YAML::XS ();
21	use Time::HiRes;	62	use IO::AIO ();
		63	use Compress::LZF;
		64	use Digest::MD5 ();
22		65
23	use Event; $Event::Eval = 1; # no idea why this is required, but it is	66	AnyEvent::detect;
24		67
25	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	68	# configure various modules to our taste
26	$YAML::Syck::ImplicitUnicode = 1;	69	#
		70	$Storable::canonical = 1; # reduce rsync transfers
		71	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
27		72
28	$Coro::main->prio (Coro::PRIO_MIN);	73	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
		74
		75	# make sure c-lzf reinitialises itself
		76	Compress::LZF::set_serializer "Storable", "Storable::net_mstore", "Storable::mretrieve";
		77	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		78
		79	# strictly for debugging
		80	$SIG{QUIT} = sub { Carp::cluck "SIGQUIT" };
29		81
30	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	82	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		83
		84	our @ORIG_INC;
31		85
32	our %COMMAND = ();	86	our %COMMAND = ();
33	our %COMMAND_TIME = ();	87	our %COMMAND_TIME = ();
		88
		89	our @EXTS = (); # list of extension package names
34	our %EXTCMD = ();	90	our %EXTCMD = ();
		91	our %EXTACMD = ();
		92	our %EXTICMD = ();
		93	our %EXTIACMD = ();
		94	our %EXT_CORO = (); # coroutines bound to extensions
		95	our %EXT_MAP = (); # pluggable maps
35		96
		97	our $RELOAD; # number of reloads so far, non-zero while in reload
36	our @EVENT;	98	our @EVENT;
37	our $LIBDIR = datadir . "/ext";	99	our @REFLECT; # set by XS
		100	our %REFLECT; # set by us
38		101
39	our $TICK = MAX_TIME * 1e-6;	102	our $CONFDIR = confdir;
40	our $TICK_WATCHER;	103
		104	our $DATADIR = datadir;
		105	our $LIBDIR = "$DATADIR/ext";
		106	our $PODDIR = "$DATADIR/pod";
		107	our $MAPDIR = "$DATADIR/" . mapdir;
		108
		109	our $LOCALDIR = localdir;
		110	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		111	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		112	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		113	our $RANDOMDIR = "$LOCALDIR/random";
		114	our $BDBDIR = "$LOCALDIR/db";
		115	our $PIDFILE = "$LOCALDIR/pid";
		116	our $RUNTIMEFILE = "$LOCALDIR/runtime";
		117
		118	#our %RESOURCE; # unused
		119
		120	our $OUTPUT_RATE_MIN = 3000;
		121	our $OUTPUT_RATE_MAX = 1000000;
		122
		123	our $MAX_LINKS = 32; # how many chained exits to follow
		124	our $VERBOSE_IO = 1;
		125
		126	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
		127	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
41	our $NEXT_TICK;	128	our $NEXT_TICK;
		129	our $USE_FSYNC = 1; # use fsync to write maps - default on
		130
		131	our $BDB_DEADLOCK_WATCHER;
		132	our $BDB_CHECKPOINT_WATCHER;
		133	our $BDB_TRICKLE_WATCHER;
		134	our $DB_ENV;
		135
		136	our @EXTRA_MODULES = qw(pod match mapscript incloader);
42		137
43	our %CFG;	138	our %CFG;
		139	our %EXT_CFG; # cfgkeyname => [var-ref, defaultvalue]
44		140
45	our $UPTIME; $UPTIME ||= time;	141	our $UPTIME; $UPTIME ||= time;
		142	our $RUNTIME = 0;
		143	our $SERVER_TICK = 0;
		144	our $NOW;
		145
		146	our (%PLAYER, %PLAYER_LOADING); # all users
		147	our (%MAP, %MAP_LOADING ); # all maps
		148	our $LINK_MAP; # the special {link} map, which is always available
		149
		150	# used to convert map paths into valid unix filenames by replacing / by ∕
		151	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		152
		153	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		154	our $LOADAVG; # same thing, but with alpha-smoothing
		155	our $JITTER; # average jitter
		156	our $TICK_START; # for load detecting purposes
		157
		158	our @POST_INIT;
		159
		160	our $REATTACH_ON_RELOAD; # set to true to force object reattach on reload (slow)
		161	our $REALLY_UNLOOP; # never set to true, please :)
		162
		163	our $WAIT_FOR_TICK = new Coro::Signal;
		164	our @WAIT_FOR_TICK_BEGIN;
		165
		166	binmode STDOUT;
		167	binmode STDERR;
		168
		169	# read virtual server time, if available
		170	unless ($RUNTIME || !-e $RUNTIMEFILE) {
		171	open my $fh, "<", $RUNTIMEFILE
		172	or die "unable to read $RUNTIMEFILE file: $!";
		173	$RUNTIME = <$fh> + 0.;
		174	}
		175
		176	eval "sub TICK() { $TICK } 1" or die;
		177
		178	mkdir $_
		179	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
		180
		181	our $EMERGENCY_POSITION;
		182
		183	sub cf::map::normalise;
		184
		185	sub in_main() {
		186	$Coro::current == $Coro::main
		187	}
46		188
47	#############################################################################	189	#############################################################################
48		190
		191	%REFLECT = ();
		192	for (@REFLECT) {
		193	my $reflect = JSON::XS::decode_json $_;
		194	$REFLECT{$reflect->{class}} = $reflect;
		195	}
		196
		197	# this is decidedly evil
		198	$REFLECT{object}{flags} = { map +($_ => undef), grep $_, map /^FLAG_([A-Z0-9_]+)$/ && lc $1, keys %{"cf::"} };
		199
		200	#############################################################################
		201
49	=head2 GLOBAL VARIABLES	202	=head2 GLOBAL VARIABLES
50		203
51	=over 4	204	=over 4
52		205
53	=item $cf::UPTIME	206	=item $cf::UPTIME
54		207
55	The timestamp of the server start (so not actually an uptime).	208	The timestamp of the server start (so not actually an "uptime").
56		209
57	=item $cf::LIBDIR	210	=item $cf::SERVER_TICK
58		211
59	The perl library directory, where extensions and cf-specific modules can	212	An unsigned integer that starts at zero when the server is started and is
60	be found. It will be added to C<@INC> automatically.	213	incremented on every tick.
		214
		215	=item $cf::NOW
		216
		217	The (real) time of the last (current) server tick - updated before and
		218	after tick processing, so this is useful only as a rough "what time is it
		219	now" estimate.
61		220
62	=item $cf::TICK	221	=item $cf::TICK
63		222
64	The interval between server ticks, in seconds.	223	The interval between each server tick, in seconds.
		224
		225	=item $cf::RUNTIME
		226
		227	The time this server has run, starts at 0 and is increased by $cf::TICK on
		228	every server tick.
		229
		230	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		231	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		232	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
		233
		234	Various directories - "/etc", read-only install directory, perl-library
		235	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		236	unique-items directory, player file directory, random maps directory and
		237	database environment.
		238
		239	=item $cf::LOADAVG
		240
		241	The current CPU load on the server (alpha-smoothed), as a value between 0
		242	(none) and 1 (overloaded), indicating how much time is spent on processing
		243	objects per tick. Healthy values are < 0.5.
		244
		245	=item $cf::LOAD
		246
		247	The raw value load value from the last tick.
65		248
66	=item %cf::CFG	249	=item %cf::CFG
67		250
68	Configuration for the server, loaded from C</etc/crossfire/config>, or	251	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
69	from wherever your confdir points to.	252	from wherever your confdir points to.
70		253
		254	=item cf::wait_for_tick, cf::wait_for_tick_begin
		255
		256	These are functions that inhibit the current coroutine one tick.
		257	cf::wait_for_tick_begin only returns directly I<after> the tick
		258	processing (and consequently, can only wake one thread per tick), while
		259	cf::wait_for_tick wakes up all waiters after tick processing.
		260
		261	Note that cf::wait_for_tick will immediately return when the server is not
		262	ticking, making it suitable for small pauses in threads that need to run
		263	when the server is paused. If that is not applicable (i.e. you I<really>
		264	want to wait, use C<$cf::WAIT_FOR_TICK>).
		265
		266	=item $cf::WAIT_FOR_TICK
		267
		268	Note that C<cf::wait_for_tick> is probably the correct thing to use. This
		269	variable contains a L<Coro::Signal> that is broadcats after every server
		270	tick. Calling C<< ->wait >> on it will suspend the caller until after the
		271	next server tick.
		272
		273	=cut
		274
		275	sub wait_for_tick();
		276	sub wait_for_tick_begin();
		277
		278	=item @cf::INVOKE_RESULTS
		279
		280	This array contains the results of the last C<invoke ()> call. When
		281	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		282	that call.
		283
		284	=item %cf::REFLECT
		285
		286	Contains, for each (C++) class name, a hash reference with information
		287	about object members (methods, scalars, arrays and flags) and other
		288	metadata, which is useful for introspection.
		289
71	=back	290	=back
72		291
73	=cut	292	=cut
74		293
75	BEGIN {	294	sub error(@) { LOG llevError, join "", @_ }
76	*CORE::GLOBAL::warn = sub {	295	sub warn (@) { LOG llevWarn , join "", @_ }
		296	sub info (@) { LOG llevInfo , join "", @_ }
		297	sub debug(@) { LOG llevDebug, join "", @_ }
		298	sub trace(@) { LOG llevTrace, join "", @_ }
		299
		300	$Coro::State::WARNHOOK = sub {
77	my $msg = join "", @_;	301	my $msg = join "", @_;
		302
78	$msg .= "\n"	303	$msg .= "\n"
79	unless $msg =~ /\n$/;	304	unless $msg =~ /\n$/;
80		305
81	print STDERR "cfperl: $msg";	306	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
82	LOG llevError, "cfperl: $msg";	307
83	};	308	LOG llevWarn, $msg;
84	}	309	};
		310
		311	$Coro::State::DIEHOOK = sub {
		312	return unless $^S eq 0; # "eq", not "=="
		313
		314	error Carp::longmess $_[0];
		315
		316	if (in_main) {#d#
		317	error "DIEHOOK called in main context, Coro bug?\n";#d#
		318	return;#d#
		319	}#d#
		320
		321	# kill coroutine otherwise
		322	Coro::terminate
		323	};
85		324
86	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	325	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
87	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	326	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
88	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	327	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
89	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	328	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
90	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	329	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		330	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
91	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	331	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
92		332
93	# we bless all objects into (empty) derived classes to force a method lookup	333	# we bless all objects into (empty) derived classes to force a method lookup
94	# within the Safe compartment.	334	# within the Safe compartment.
95	for my $pkg (qw(	335	for my $pkg (qw(
96	cf::global cf::attachable	336	cf::global cf::attachable
97	cf::object cf::object::player	337	cf::object cf::object::player
98	cf::client cf::player	338	cf::client cf::player
99	cf::arch cf::living	339	cf::arch cf::living
		340	cf::map cf::mapspace
100	cf::map cf::party cf::region	341	cf::party cf::region
101	)) {	342	)) {
102	no strict 'refs';
103	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	343	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
104	}	344	}
105		345
106	$Event::DIED = sub {	346	$EV::DIED = sub {
107	warn "error in event callback: @_";	347	warn "error in event callback: $@";
108	};	348	};
109		349
110	my %ext_pkg;	350	#############################################################################
111	my @exts;	351
112	my @hook;	352	sub fork_call(&@);
		353	sub get_slot($;$$);
		354
		355	#############################################################################
113		356
114	=head2 UTILITY FUNCTIONS	357	=head2 UTILITY FUNCTIONS
115		358
116	=over 4	359	=over 4
117		360
118	=cut	361	=item dumpval $ref
119		362
120	use JSON::Syck (); # TODO# replace by JSON::PC once working	363	=cut
121		364
		365	sub dumpval {
		366	eval {
		367	local $SIG{__DIE__};
		368	my $d;
		369	if (1) {
		370	$d = new Data::Dumper([$_[0]], ["*var"]);
		371	$d->Terse(1);
		372	$d->Indent(2);
		373	$d->Quotekeys(0);
		374	$d->Useqq(1);
		375	#$d->Bless(...);
		376	$d->Seen($_[1]) if @_ > 1;
		377	$d = $d->Dump();
		378	}
		379	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		380	$d
		381	} || "[unable to dump $_[0]: '$@']";
		382	}
		383
		384	=item $scalar = cf::load_file $path
		385
		386	Loads the given file from path and returns its contents. Croaks on error
		387	and can block.
		388
		389	=cut
		390
		391	sub load_file($) {
		392	0 <= aio_load $_[0], my $data
		393	or Carp::croak "$_[0]: $!";
		394
		395	$data
		396	}
		397
		398	=item $success = cf::replace_file $path, $data, $sync
		399
		400	Atomically replaces the file at the given $path with new $data, and
		401	optionally $sync the data to disk before replacing the file.
		402
		403	=cut
		404
		405	sub replace_file($$;$) {
		406	my ($path, $data, $sync) = @_;
		407
		408	my $lock = cf::lock_acquire ("replace_file:$path");
		409
		410	my $fh = aio_open "$path~", Fcntl::O_WRONLY | Fcntl::O_CREAT | Fcntl::O_TRUNC, 0644
		411	or return;
		412
		413	$data = $data->() if ref $data;
		414
		415	length $data == aio_write $fh, 0, (length $data), $data, 0
		416	or return;
		417
		418	!$sync
		419	or !aio_fsync $fh
		420	or return;
		421
		422	aio_close $fh
		423	and return;
		424
		425	aio_rename "$path~", $path
		426	and return;
		427
		428	if ($sync) {
		429	$path =~ s%/[^/]*$%%;
		430	aio_pathsync $path;
		431	}
		432
		433	1
		434	}
		435
122	=item $ref = cf::from_json $json	436	=item $ref = cf::decode_json $json
123		437
124	Converts a JSON string into the corresponding perl data structure.	438	Converts a JSON string into the corresponding perl data structure.
125		439
126	=cut
127
128	sub from_json($) {
129	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
130	JSON::Syck::Load $_[0]
131	}
132
133	=item $json = cf::to_json $ref	440	=item $json = cf::encode_json $ref
134		441
135	Converts a perl data structure into its JSON representation.	442	Converts a perl data structure into its JSON representation.
136		443
137	=cut	444	=cut
138		445
139	sub to_json($) {	446	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
140	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	447
141	JSON::Syck::Dump $_[0]	448	sub encode_json($) { $json_coder->encode ($_[0]) }
		449	sub decode_json($) { $json_coder->decode ($_[0]) }
		450
		451	=item $ref = cf::decode_storable $scalar
		452
		453	Same as Coro::Storable::thaw, so blocks.
		454
		455	=cut
		456
		457	BEGIN { *decode_storable = \&Coro::Storable::thaw }
		458
		459	=item $ref = cf::decode_yaml $scalar
		460
		461	Same as YAML::XS::Load, but doesn't leak, because it forks (and thus blocks).
		462
		463	=cut
		464
		465	sub decode_yaml($) {
		466	fork_call { YAML::XS::Load $_[0] } @_
		467	}
		468
		469	=item $scalar = cf::unlzf $scalar
		470
		471	Same as Compress::LZF::compress, but takes server ticks into account, so
		472	blocks.
		473
		474	=cut
		475
		476	sub unlzf($) {
		477	# we assume 100mb/s minimum decompression speed (noncompressible data on a ~2ghz machine)
		478	cf::get_slot +(length $_[0]) / 100_000_000, 0, "unlzf";
		479	Compress::LZF::decompress $_[0]
		480	}
		481
		482	=item cf::post_init { BLOCK }
		483
		484	Execute the given codeblock, I<after> all extensions have been (re-)loaded,
		485	but I<before> the server starts ticking again.
		486
		487	The codeblock will have a single boolean argument to indicate whether this
		488	is a reload or not.
		489
		490	=cut
		491
		492	sub post_init(&) {
		493	push @POST_INIT, shift;
		494	}
		495
		496	sub _post_init {
		497	trace "running post_init jobs";
		498
		499	# run them in parallel...
		500
		501	my @join;
		502
		503	while () {
		504	push @join, map &Coro::async ($_, 0), @POST_INIT;
		505	@POST_INIT = ();
		506
		507	@join or last;
		508
		509	(pop @join)->join;
		510	}
		511	}
		512
		513	=item cf::lock_wait $string
		514
		515	Wait until the given lock is available. See cf::lock_acquire.
		516
		517	=item my $lock = cf::lock_acquire $string
		518
		519	Wait until the given lock is available and then acquires it and returns
		520	a L<Guard> object. If the guard object gets destroyed (goes out of scope,
		521	for example when the coroutine gets canceled), the lock is automatically
		522	returned.
		523
		524	Locks are *not* recursive, locking from the same coro twice results in a
		525	deadlocked coro.
		526
		527	Lock names should begin with a unique identifier (for example, cf::map::find
		528	uses map_find and cf::map::load uses map_load).
		529
		530	=item $locked = cf::lock_active $string
		531
		532	Return true if the lock is currently active, i.e. somebody has locked it.
		533
		534	=cut
		535
		536	our $LOCKS = new Coro::SemaphoreSet;
		537
		538	sub lock_wait($) {
		539	$LOCKS->wait ($_[0]);
		540	}
		541
		542	sub lock_acquire($) {
		543	$LOCKS->guard ($_[0])
		544	}
		545
		546	sub lock_active($) {
		547	$LOCKS->count ($_[0]) < 1
		548	}
		549
		550	sub freeze_mainloop {
		551	tick_inhibit_inc;
		552
		553	&Guard::guard (\&tick_inhibit_dec);
		554	}
		555
		556	=item cf::periodic $interval, $cb
		557
		558	Like EV::periodic, but randomly selects a starting point so that the actions
		559	get spread over time.
		560
		561	=cut
		562
		563	sub periodic($$) {
		564	my ($interval, $cb) = @_;
		565
		566	my $start = rand List::Util::min 180, $interval;
		567
		568	EV::periodic $start, $interval, 0, $cb
		569	}
		570
		571	=item cf::get_slot $time[, $priority[, $name]]
		572
		573	Allocate $time seconds of blocking CPU time at priority C<$priority>
		574	(default: 0): This call blocks and returns only when you have at least
		575	C<$time> seconds of cpu time till the next tick. The slot is only valid
		576	till the next cede.
		577
		578	Background jobs should use a priority less than zero, interactive jobs
		579	should use 100 or more.
		580
		581	The optional C<$name> can be used to identify the job to run. It might be
		582	used for statistical purposes and should identify the same time-class.
		583
		584	Useful for short background jobs.
		585
		586	=cut
		587
		588	our @SLOT_QUEUE;
		589	our $SLOT_QUEUE;
		590	our $SLOT_DECAY = 0.9;
		591
		592	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		593	$SLOT_QUEUE = Coro::async {
		594	$Coro::current->desc ("timeslot manager");
		595
		596	my $signal = new Coro::Signal;
		597	my $busy;
		598
		599	while () {
		600	next_job:
		601
		602	Coro::cede;
		603
		604	my $avail = cf::till_tick;
		605
		606	for (0 .. $#SLOT_QUEUE) {
		607	if ($SLOT_QUEUE[$_][0] <= $avail) {
		608	$busy = 0;
		609	my $job = splice @SLOT_QUEUE, $_, 1, ();
		610	$job->[2]->send;
		611	goto next_job;
		612	} else {
		613	$SLOT_QUEUE[$_][0] *= $SLOT_DECAY;
		614	}
		615	}
		616
		617	if (@SLOT_QUEUE) {
		618	wait_for_tick;
		619	} else {
		620	$busy = 0;
		621	Coro::schedule;
		622	}
		623	}
		624	};
		625
		626	sub get_slot($;$$) {
		627	return if tick_inhibit || $Coro::current == $Coro::main;
		628
		629	my ($time, $pri, $name) = @_;
		630
		631	$time = clamp $time, 0.01, $TICK * .6;
		632
		633	my $sig = new Coro::Signal;
		634
		635	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		636	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		637	$SLOT_QUEUE->ready;
		638	$sig->wait;
		639	}
		640
		641	=item cf::async { BLOCK }
		642
		643	Currently the same as Coro::async_pool, meaning you cannot use
		644	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		645	thing you are allowed to do is call C<prio> on it.
		646
		647	=cut
		648
		649	BEGIN { *async = \&Coro::async_pool }
		650
		651	=item cf::sync_job { BLOCK }
		652
		653	The design of Deliantra requires that the main coroutine ($Coro::main)
		654	is always able to handle events or runnable, as Deliantra is only
		655	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		656	acceptable.
		657
		658	If it must be done, put the blocking parts into C<sync_job>. This will run
		659	the given BLOCK in another coroutine while waiting for the result. The
		660	server will be frozen during this time, so the block should either finish
		661	fast or be very important.
		662
		663	=cut
		664
		665	sub sync_job(&) {
		666	my ($job) = @_;
		667
		668	if (in_main) {
		669	my $time = AE::time;
		670
		671	# this is the main coro, too bad, we have to block
		672	# till the operation succeeds, freezing the server :/
		673
		674	#LOG llevError, Carp::longmess "sync job";#d#
		675
		676	my $freeze_guard = freeze_mainloop;
		677
		678	my $busy = 1;
		679	my @res;
		680
		681	(async {
		682	$Coro::current->desc ("sync job coro");
		683	@res = eval { $job->() };
		684	error $@ if $@;
		685	undef $busy;
		686	})->prio (Coro::PRIO_MAX);
		687
		688	while ($busy) {
		689	if (Coro::nready) {
		690	Coro::cede_notself;
		691	} else {
		692	EV::loop EV::LOOP_ONESHOT;
		693	}
		694	}
		695
		696	my $time = AE::time - $time;
		697
		698	$TICK_START += $time; # do not account sync jobs to server load
		699
		700	wantarray ? @res : $res[0]
		701	} else {
		702	# we are in another coroutine, how wonderful, everything just works
		703
		704	$job->()
		705	}
		706	}
		707
		708	=item $coro = cf::async_ext { BLOCK }
		709
		710	Like async, but this coro is automatically being canceled when the
		711	extension calling this is being unloaded.
		712
		713	=cut
		714
		715	sub async_ext(&) {
		716	my $cb = shift;
		717
		718	my $coro = &Coro::async ($cb);
		719
		720	$coro->on_destroy (sub {
		721	delete $EXT_CORO{$coro+0};
		722	});
		723	$EXT_CORO{$coro+0} = $coro;
		724
		725	$coro
		726	}
		727
		728	=item fork_call { }, @args
		729
		730	Executes the given code block with the given arguments in a seperate
		731	process, returning the results. Everything must be serialisable with
		732	Coro::Storable. May, of course, block. Note that the executed sub may
		733	never block itself or use any form of event handling.
		734
		735	=cut
		736
		737	sub post_fork {
		738	reset_signals;
		739	}
		740
		741	sub fork_call(&@) {
		742	my ($cb, @args) = @_;
		743
		744	my @res = Coro::Util::fork_eval {
		745	cf::post_fork;
		746	&$cb
		747	} @args;
		748
		749	wantarray ? @res : $res[-1]
		750	}
		751
		752	sub objinfo {
		753	(
		754	"counter value" => cf::object::object_count,
		755	"objects created" => cf::object::create_count,
		756	"objects destroyed" => cf::object::destroy_count,
		757	"freelist size" => cf::object::free_count,
		758	"allocated objects" => cf::object::objects_size,
		759	"active objects" => cf::object::actives_size,
		760	)
		761	}
		762
		763	=item $coin = coin_from_name $name
		764
		765	=cut
		766
		767	our %coin_alias = (
		768	"silver" => "silvercoin",
		769	"silvercoin" => "silvercoin",
		770	"silvercoins" => "silvercoin",
		771	"gold" => "goldcoin",
		772	"goldcoin" => "goldcoin",
		773	"goldcoins" => "goldcoin",
		774	"platinum" => "platinacoin",
		775	"platinumcoin" => "platinacoin",
		776	"platinumcoins" => "platinacoin",
		777	"platina" => "platinacoin",
		778	"platinacoin" => "platinacoin",
		779	"platinacoins" => "platinacoin",
		780	"royalty" => "royalty",
		781	"royalties" => "royalty",
		782	);
		783
		784	sub coin_from_name($) {
		785	$coin_alias{$_[0]}
		786	? cf::arch::find $coin_alias{$_[0]}
		787	: undef
		788	}
		789
		790	=item $value = cf::db_get $family => $key
		791
		792	Returns a single value from the environment database.
		793
		794	=item cf::db_put $family => $key => $value
		795
		796	Stores the given C<$value> in the family. It can currently store binary
		797	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		798
		799	=item $db = cf::db_table "name"
		800
		801	Create and/or open a new database table. The string must not be "db" and must be unique
		802	within each server.
		803
		804	=cut
		805
		806	sub db_table($) {
		807	cf::error "db_get called from main context"
		808	if $Coro::current == $Coro::main;
		809
		810	my ($name) = @_;
		811	my $db = BDB::db_create $DB_ENV;
		812
		813	eval {
		814	$db->set_flags (BDB::CHKSUM);
		815
		816	utf8::encode $name;
		817	BDB::db_open $db, undef, $name, undef, BDB::BTREE,
		818	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		819	cf::cleanup "db_open(db): $!" if $!;
		820	};
		821	cf::cleanup "db_open(db): $@" if $@;
		822
		823	$db
		824	}
		825
		826	our $DB;
		827
		828	sub db_init {
		829	$DB ||= db_table "db";
		830	}
		831
		832	sub db_get($$) {
		833	my $key = "$_[0]/$_[1]";
		834
		835	cf::error "db_get called from main context"
		836	if $Coro::current == $Coro::main;
		837
		838	BDB::db_get $DB, undef, $key, my $data;
		839
		840	$! ? ()
		841	: $data
		842	}
		843
		844	sub db_put($$$) {
		845	BDB::dbreq_pri 4;
		846	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		847	}
		848
		849	=item cf::cache $id => [$paths...], $processversion => $process
		850
		851	Generic caching function that returns the value of the resource $id,
		852	caching and regenerating as required.
		853
		854	This function can block.
		855
		856	=cut
		857
		858	sub cache {
		859	my ($id, $src, $processversion, $process) = @_;
		860
		861	my $meta =
		862	join "\x00",
		863	$processversion,
		864	map {
		865	aio_stat $_
		866	and Carp::croak "$_: $!";
		867
		868	($_, (stat _)[7,9])
		869	} @$src;
		870
		871	my $dbmeta = db_get cache => "$id/meta";
		872	if ($dbmeta ne $meta) {
		873	# changed, we may need to process
		874
		875	my @data;
		876	my $md5;
		877
		878	for (0 .. $#$src) {
		879	$data[$_] = load_file $src->[$_];
		880	}
		881
		882	# if processing is expensive, check
		883	# checksum first
		884	if (1) {
		885	$md5 =
		886	join "\x00",
		887	$processversion,
		888	map {
		889	cf::cede_to_tick;
		890	($src->[$_], Digest::MD5::md5_hex $data[$_])
		891	} 0.. $#$src;
		892
		893
		894	my $dbmd5 = db_get cache => "$id/md5";
		895	if ($dbmd5 eq $md5) {
		896	db_put cache => "$id/meta", $meta;
		897
		898	return db_get cache => "$id/data";
		899	}
		900	}
		901
		902	my $t1 = EV::time;
		903	my $data = $process->(\@data);
		904	my $t2 = EV::time;
		905
		906	info "cache: '$id' processed in ", $t2 - $t1, "s\n";
		907
		908	db_put cache => "$id/data", $data;
		909	db_put cache => "$id/md5" , $md5;
		910	db_put cache => "$id/meta", $meta;
		911
		912	return $data;
		913	}
		914
		915	db_get cache => "$id/data"
		916	}
		917
		918	=item cf::datalog type => key => value, ...
		919
		920	Log a datalog packet of the given type with the given key-value pairs.
		921
		922	=cut
		923
		924	sub datalog($@) {
		925	my ($type, %kv) = @_;
		926	info "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
142	}	927	}
143		928
144	=back	929	=back
145		930
146	=cut	931	=cut
147		932
148	#############################################################################	933	#############################################################################
149		934
150	=head2 ATTACHABLE OBJECTS	935	=head2 ATTACHABLE OBJECTS
151		936
152	Many objects in crossfire are so-called attachable objects. That means you can	937	Many objects in deliantra are so-called attachable objects. That means you can
153	attach callbacks/event handlers (a collection of which is called an "attachment")	938	attach callbacks/event handlers (a collection of which is called an "attachment")
154	to it. All such attachable objects support the following methods.	939	to it. All such attachable objects support the following methods.
155		940
156	In the following description, CLASS can be any of C<global>, C<object>	941	In the following description, CLASS can be any of C<global>, C<object>
157	C<player>, C<client> or C<map> (i.e. the attachable objects in	942	C<player>, C<client> or C<map> (i.e. the attachable objects in
158	crossfire+).	943	Deliantra).
159		944
160	=over 4	945	=over 4
161		946
162	=item $attachable->attach ($attachment, key => $value...)	947	=item $attachable->attach ($attachment, key => $value...)
163		948
…		…
207	=item cf::CLASS::attachment $name, ...	992	=item cf::CLASS::attachment $name, ...
208		993
209	Register an attachment by C<$name> through which attachable objects of the	994	Register an attachment by C<$name> through which attachable objects of the
210	given CLASS can refer to this attachment.	995	given CLASS can refer to this attachment.
211		996
212	Some classes such as crossfire maps and objects can specify attachments	997	Some classes such as deliantra maps and objects can specify attachments
213	that are attached at load/instantiate time, thus the need for a name.	998	that are attached at load/instantiate time, thus the need for a name.
214		999
215	These calls expect any number of the following handler/hook descriptions:	1000	These calls expect any number of the following handler/hook descriptions:
216		1001
217	=over 4	1002	=over 4
…		…
277	our @CB_TYPE = (); # registry for type (cf-object class) based events	1062	our @CB_TYPE = (); # registry for type (cf-object class) based events
278	our @CB_MAP = ();	1063	our @CB_MAP = ();
279		1064
280	my %attachment;	1065	my %attachment;
281		1066
		1067	sub cf::attachable::thawer_merge {
		1068	# simply override everything except _meta
		1069	local $_[0]{_meta};
		1070	%{$_[0]} = %{$_[1]};
		1071	}
		1072
282	sub _attach_cb($$$$) {	1073	sub _attach_cb($$$$) {
283	my ($registry, $event, $prio, $cb) = @_;	1074	my ($registry, $event, $prio, $cb) = @_;
284		1075
285	use sort 'stable';	1076	use sort 'stable';
286		1077
…		…
320	$registry = $CB_TYPE[$object_type] ||= [];	1111	$registry = $CB_TYPE[$object_type] ||= [];
321		1112
322	} elsif ($type eq "subtype") {	1113	} elsif ($type eq "subtype") {
323	defined $object_type or Carp::croak "subtype specified without type";	1114	defined $object_type or Carp::croak "subtype specified without type";
324	my $object_subtype = shift @arg;	1115	my $object_subtype = shift @arg;
325	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	1116	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
326		1117
327	} elsif ($type eq "package") {	1118	} elsif ($type eq "package") {
328	my $pkg = shift @arg;	1119	my $pkg = shift @arg;
329		1120
330	while (my ($name, $id) = each %cb_id) {	1121	while (my ($name, $id) = each %cb_id) {
…		…
335		1126
336	} elsif (exists $cb_id{$type}) {	1127	} elsif (exists $cb_id{$type}) {
337	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;	1128	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
338		1129
339	} elsif (ref $type) {	1130	} elsif (ref $type) {
340	warn "attaching objects not supported, ignoring.\n";	1131	error "attaching objects not supported, ignoring.\n";
341		1132
342	} else {	1133	} else {
343	shift @arg;	1134	shift @arg;
344	warn "attach argument '$type' not supported, ignoring.\n";	1135	error "attach argument '$type' not supported, ignoring.\n";
345	}	1136	}
346	}	1137	}
347	}	1138	}
348		1139
349	sub _object_attach {	1140	sub _object_attach {
…		…
359	_attach $registry, $klass, @attach;	1150	_attach $registry, $klass, @attach;
360	}	1151	}
361		1152
362	$obj->{$name} = \%arg;	1153	$obj->{$name} = \%arg;
363	} else {	1154	} else {
364	warn "object uses attachment '$name' that is not available, postponing.\n";	1155	info "object uses attachment '$name' which is not available, postponing.\n";
365	}	1156	}
366		1157
367	$obj->{_attachment}{$name} = undef;	1158	$obj->{_attachment}{$name} = undef;
368	}	1159	}
369		1160
…		…
371	if (ref $_[0]) {	1162	if (ref $_[0]) {
372	_object_attach @_;	1163	_object_attach @_;
373	} else {	1164	} else {
374	_attach shift->_attach_registry, @_;	1165	_attach shift->_attach_registry, @_;
375	}	1166	}
		1167	_recalc_want;
376	};	1168	};
377		1169
378	# all those should be optimised	1170	# all those should be optimised
379	sub cf::attachable::detach {	1171	sub cf::attachable::detach {
380	my ($obj, $name) = @_;	1172	my ($obj, $name) = @_;
…		…
383	delete $obj->{_attachment}{$name};	1175	delete $obj->{_attachment}{$name};
384	reattach ($obj);	1176	reattach ($obj);
385	} else {	1177	} else {
386	Carp::croak "cannot, currently, detach class attachments";	1178	Carp::croak "cannot, currently, detach class attachments";
387	}	1179	}
		1180	_recalc_want;
388	};	1181	};
389		1182
390	sub cf::attachable::attached {	1183	sub cf::attachable::attached {
391	my ($obj, $name) = @_;	1184	my ($obj, $name) = @_;
392		1185
…		…
407	";	1200	";
408	die if $@;	1201	die if $@;
409	}	1202	}
410		1203
411	our $override;	1204	our $override;
412	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	1205	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
413		1206
414	sub override {	1207	sub override {
415	$override = 1;	1208	$override = 1;
416	@invoke_results = ();	1209	@INVOKE_RESULTS = (@_);
417	}	1210	}
418		1211
419	sub do_invoke {	1212	sub do_invoke {
420	my $event = shift;	1213	my $event = shift;
421	my $callbacks = shift;	1214	my $callbacks = shift;
422		1215
423	@invoke_results = ();	1216	@INVOKE_RESULTS = ();
424		1217
425	local $override;	1218	local $override;
426		1219
427	for (@$callbacks) {	1220	for (@$callbacks) {
428	eval { &{$_->[1]} };	1221	eval { &{$_->[1]} };
429		1222
430	if ($@) {	1223	if ($@) {
431	warn "$@";
432	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";	1224	error "$@", "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
433	override;	1225	override;
434	}	1226	}
435		1227
436	return 1 if $override;	1228	return 1 if $override;
437	}	1229	}
438		1230
439	0	1231	0
440	}	1232	}
441		1233
442	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1234	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
443		1235
444	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1236	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
445		1237
446	Generate an object-specific event with the given arguments.	1238	Generate an object-specific event with the given arguments.
447		1239
448	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	1240	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
449	removed in future versions), and there is no public API to access override	1241	removed in future versions), and there is no public API to access override
450	results (if you must, access C<@cf::invoke_results> directly).	1242	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
451		1243
452	=back	1244	=back
453		1245
454	=cut	1246	=cut
455		1247
456	#############################################################################	1248	#############################################################################
457	# object support	1249	# object support
		1250
		1251	sub _object_equal($$);
		1252	sub _object_equal($$) {
		1253	my ($a, $b) = @_;
		1254
		1255	return 0 unless (ref $a) eq (ref $b);
		1256
		1257	if ("HASH" eq ref $a) {
		1258	my @ka = keys %$a;
		1259	my @kb = keys %$b;
		1260
		1261	return 0 if @ka != @kb;
		1262
		1263	for (0 .. $#ka) {
		1264	return 0 unless $ka[$_] eq $kb[$_];
		1265	return 0 unless _object_equal $a->{$ka[$_]}, $b->{$kb[$_]};
		1266	}
		1267
		1268	} elsif ("ARRAY" eq ref $a) {
		1269
		1270	return 0 if @$a != @$b;
		1271
		1272	for (0 .. $#$a) {
		1273	return 0 unless _object_equal $a->[$_], $b->[$_];
		1274	}
		1275
		1276	} elsif ($a ne $b) {
		1277	return 0;
		1278	}
		1279
		1280	1
		1281	}
		1282
		1283	our $SLOW_MERGES;#d#
		1284	sub _can_merge {
		1285	my ($ob1, $ob2) = @_;
		1286
		1287	++$SLOW_MERGES;#d#
		1288
		1289	# we do the slow way here
		1290	return _object_equal $ob1, $ob2
		1291	}
		1292
		1293	sub reattach {
		1294	# basically do the same as instantiate, without calling instantiate
		1295	my ($obj) = @_;
		1296
		1297	# no longer needed after getting rid of delete_package?
		1298	#bless $obj, ref $obj; # re-bless in case extensions have been reloaded
		1299
		1300	my $registry = $obj->registry;
		1301
		1302	@$registry = ();
		1303
		1304	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
		1305
		1306	for my $name (keys %{ $obj->{_attachment} || {} }) {
		1307	if (my $attach = $attachment{$name}) {
		1308	for (@$attach) {
		1309	my ($klass, @attach) = @$_;
		1310	_attach $registry, $klass, @attach;
		1311	}
		1312	} else {
		1313	info "object uses attachment '$name' that is not available, postponing.\n";
		1314	}
		1315	}
		1316	}
458		1317
459	cf::attachable->attach (	1318	cf::attachable->attach (
460	prio => -1000000,	1319	prio => -1000000,
461	on_instantiate => sub {	1320	on_instantiate => sub {
462	my ($obj, $data) = @_;	1321	my ($obj, $data) = @_;
463		1322
464	$data = from_json $data;	1323	$data = decode_json $data;
465		1324
466	for (@$data) {	1325	for (@$data) {
467	my ($name, $args) = @$_;	1326	my ($name, $args) = @$_;
468		1327
469	$obj->attach ($name, %{$args || {} });	1328	$obj->attach ($name, %{$args || {} });
470	}	1329	}
471	},	1330	},
472	on_reattach => sub {	1331	on_reattach => \&reattach,
473	# basically do the same as instantiate, without calling instantiate
474	my ($obj) = @_;
475	my $registry = $obj->registry;
476
477	@$registry = ();
478
479	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
480
481	for my $name (keys %{ $obj->{_attachment} || {} }) {
482	if (my $attach = $attachment{$name}) {
483	for (@$attach) {
484	my ($klass, @attach) = @$_;
485	_attach $registry, $klass, @attach;
486	}
487	} else {
488	warn "object uses attachment '$name' that is not available, postponing.\n";
489	}
490	}
491	},
492	on_clone => sub {	1332	on_clone => sub {
493	my ($src, $dst) = @_;	1333	my ($src, $dst) = @_;
494		1334
495	@{$dst->registry} = @{$src->registry};	1335	@{$dst->registry} = @{$src->registry};
496		1336
…		…
502	);	1342	);
503		1343
504	sub object_freezer_save {	1344	sub object_freezer_save {
505	my ($filename, $rdata, $objs) = @_;	1345	my ($filename, $rdata, $objs) = @_;
506		1346
		1347	sync_job {
507	if (length $$rdata) {	1348	if (length $$rdata) {
		1349	utf8::decode (my $decname = $filename);
508	warn sprintf "saving %s (%d,%d)\n",	1350	trace sprintf "saving %s (%d,%d)\n",
509	$filename, length $$rdata, scalar @$objs;	1351	$decname, length $$rdata, scalar @$objs
		1352	if $VERBOSE_IO;
510		1353
511	if (open my $fh, ">:raw", "$filename~") {	1354	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
512	chmod SAVE_MODE, $fh;
513	syswrite $fh, $$rdata;
514	close $fh;
515
516	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
517	chmod SAVE_MODE, $fh;	1355	aio_chmod $fh, SAVE_MODE;
518	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };	1356	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		1357	if ($cf::USE_FSYNC) {
		1358	aio_sync_file_range $fh, 0, 0, IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE | IO::AIO::SYNC_FILE_RANGE_WRITE | IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER;
		1359	aio_fsync $fh;
		1360	}
519	close $fh;	1361	aio_close $fh;
		1362
		1363	if (@$objs) {
		1364	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		1365	aio_chmod $fh, SAVE_MODE;
		1366	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
		1367	aio_write $fh, 0, (length $data), $data, 0;
		1368	if ($cf::USE_FSYNC) {
		1369	aio_sync_file_range $fh, 0, 0, IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE | IO::AIO::SYNC_FILE_RANGE_WRITE | IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER;
		1370	aio_fsync $fh;
		1371	}
		1372	aio_close $fh;
520	rename "$filename.pst~", "$filename.pst";	1373	aio_rename "$filename.pst~", "$filename.pst";
		1374	}
		1375	} else {
		1376	aio_unlink "$filename.pst";
		1377	}
		1378
		1379	aio_rename "$filename~", $filename;
		1380
		1381	$filename =~ s%/[^/]+$%%;
		1382	aio_pathsync $filename if $cf::USE_FSYNC;
521	} else {	1383	} else {
522	unlink "$filename.pst";	1384	error "unable to save objects: $filename~: $!\n";
523	}	1385	}
524
525	rename "$filename~", $filename;
526	} else {	1386	} else {
527	warn "FATAL: $filename~: $!\n";
528	}
529	} else {
530	unlink $filename;	1387	aio_unlink $filename;
531	unlink "$filename.pst";	1388	aio_unlink "$filename.pst";
		1389	}
532	}	1390	};
533	}	1391	}
534		1392
535	sub object_freezer_as_string {	1393	sub object_freezer_as_string {
536	my ($rdata, $objs) = @_;	1394	my ($rdata, $objs) = @_;
537		1395
…		…
541	}	1399	}
542		1400
543	sub object_thawer_load {	1401	sub object_thawer_load {
544	my ($filename) = @_;	1402	my ($filename) = @_;
545		1403
546	local $/;
547
548	my $av;
549
550	#TODO: use sysread etc.
551	if (open my $data, "<:raw:perlio", $filename) {
552	$data = <$data>;
553	if (open my $pst, "<:raw:perlio", "$filename.pst") {
554	$av = eval { (Storable::thaw <$pst>)->{objs} };
555	}
556	return ($data, $av);	1404	my ($data, $av);
557	}
558		1405
559	()	1406	(aio_load $filename, $data) >= 0
		1407	or return;
		1408
		1409	unless (aio_stat "$filename.pst") {
		1410	(aio_load "$filename.pst", $av) >= 0
		1411	or return;
		1412
		1413	my $st = eval { Coro::Storable::thaw $av };
		1414	$av = $st->{objs};
		1415	}
		1416
		1417	utf8::decode (my $decname = $filename);
		1418	trace sprintf "loading %s (%d,%d)\n",
		1419	$decname, length $data, scalar @{$av || []}
		1420	if $VERBOSE_IO;
		1421
		1422	($data, $av)
560	}	1423	}
		1424
		1425	=head2 COMMAND CALLBACKS
		1426
		1427	=over 4
		1428
		1429	=cut
561		1430
562	#############################################################################	1431	#############################################################################
563	# command handling &c	1432	# command handling &c
564		1433
565	=item cf::register_command $name => \&callback($ob,$args);	1434	=item cf::register_command $name => \&callback($ob,$args)
566		1435
567	Register a callback for execution when the client sends the user command	1436	Register a callback for execution when the client sends the user command
568	$name.	1437	$name.
569		1438
570	=cut	1439	=cut
…		…
576	#warn "registering command '$name/$time' to '$caller'";	1445	#warn "registering command '$name/$time' to '$caller'";
577		1446
578	push @{ $COMMAND{$name} }, [$caller, $cb];	1447	push @{ $COMMAND{$name} }, [$caller, $cb];
579	}	1448	}
580		1449
581	=item cf::register_extcmd $name => \&callback($pl,$packet);	1450	=item cf::register_extcmd $name => \&callback($pl,@args)
582		1451
583	Register a callbackf ro execution when the client sends an extcmd packet.	1452	Register a callback for execution when the client sends an (synchronous)
		1453	extcmd packet. Ext commands will be processed in the order they are
		1454	received by the server, like other user commands. The first argument is
		1455	the logged-in player. Ext commands can only be processed after a player
		1456	has logged in successfully.
584		1457
585	If the callback returns something, it is sent back as if reply was being	1458	The values will be sent back to the client.
586	called.
587		1459
588	=cut	1460	=item cf::register_async_extcmd $name => \&callback($pl,$reply->(...),@args)
589		1461
		1462	Same as C<cf::register_extcmd>, but instead of returning values, the
		1463	callback needs to clal the C<$reply> function.
		1464
		1465	=item cf::register_exticmd $name => \&callback($ns,@args)
		1466
		1467	Register a callback for execution when the client sends an (asynchronous)
		1468	exticmd packet. Exti commands are processed by the server as soon as they
		1469	are received, i.e. out of order w.r.t. other commands. The first argument
		1470	is a client socket. Exti commands can be received anytime, even before
		1471	log-in.
		1472
		1473	The values will be sent back to the client.
		1474
		1475	=item cf::register_async_exticmd $name => \&callback($ns,$reply->(...),@args)
		1476
		1477	Same as C<cf::register_extcmd>, but instead of returning values, the
		1478	callback needs to clal the C<$reply> function.
		1479
		1480	=cut
		1481
590	sub register_extcmd {	1482	sub register_extcmd($$) {
591	my ($name, $cb) = @_;	1483	my ($name, $cb) = @_;
592		1484
593	my $caller = caller;
594	#warn "registering extcmd '$name' to '$caller'";
595
596	$EXTCMD{$name} = [$cb, $caller];	1485	$EXTCMD{$name} = $cb;
597	}	1486	}
		1487
		1488	sub register_async_extcmd($$) {
		1489	my ($name, $cb) = @_;
		1490
		1491	$EXTACMD{$name} = $cb;
		1492	}
		1493
		1494	sub register_exticmd($$) {
		1495	my ($name, $cb) = @_;
		1496
		1497	$EXTICMD{$name} = $cb;
		1498	}
		1499
		1500	sub register_async_exticmd($$) {
		1501	my ($name, $cb) = @_;
		1502
		1503	$EXTIACMD{$name} = $cb;
		1504	}
		1505
		1506	use File::Glob ();
598		1507
599	cf::player->attach (	1508	cf::player->attach (
600	on_command => sub {	1509	on_unknown_command => sub {
601	my ($pl, $name, $params) = @_;	1510	my ($pl, $name, $params) = @_;
602		1511
603	my $cb = $COMMAND{$name}	1512	my $cb = $COMMAND{$name}
604	or return;	1513	or return;
605		1514
…		…
610	cf::override;	1519	cf::override;
611	},	1520	},
612	on_extcmd => sub {	1521	on_extcmd => sub {
613	my ($pl, $buf) = @_;	1522	my ($pl, $buf) = @_;
614		1523
615	my $msg = eval { from_json $buf };	1524	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
616		1525
617	if (ref $msg) {	1526	if (ref $msg) {
		1527	my ($type, $reply, @payload) = @$msg; # version 1 used %type, $id, %$hash
		1528
618	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1529	if (my $cb = $EXTACMD{$type}) {
619	if (my %reply = $cb->[0]->($pl, $msg)) {	1530	$cb->(
620	$pl->ext_reply ($msg->{msgid}, %reply);	1531	$pl,
		1532	sub {
		1533	$pl->ext_msg ("reply-$reply", @_)
		1534	if $reply;
		1535	},
		1536	@payload
		1537	);
		1538	} else {
		1539	my @reply;
		1540
		1541	if (my $cb = $EXTCMD{$type}) {
		1542	@reply = $cb->($pl, @payload);
621	}	1543	}
		1544
		1545	$pl->ext_msg ("reply-$reply", @reply)
		1546	if $reply;
622	}	1547	}
		1548
623	} else {	1549	} else {
624	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1550	error "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
625	}	1551	}
626		1552
627	cf::override;	1553	cf::override;
628	},	1554	},
629	);	1555	);
630		1556
631	sub register {	1557	# "readahead" all extensions
632	my ($base, $pkg) = @_;
633
634	#TODO
635	}
636
637	sub load_extension {	1558	sub cache_extensions {
638	my ($path) = @_;	1559	my $grp = IO::AIO::aio_group;
639		1560
640	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1561	add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
641	my $base = $1;	1562	for (grep /\.ext$/, @{$_[0]}) {
642	my $pkg = $1;	1563	add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
643	$pkg =~ s/[^[:word:]]/_/g;
644	$pkg = "ext::$pkg";
645
646	warn "loading '$path' into '$pkg'\n";
647
648	open my $fh, "<:utf8", $path
649	or die "$path: $!";
650
651	my $source =
652	"package $pkg; use strict; use utf8;\n"
653	. "#line 1 \"$path\"\n{\n"
654	. (do { local $/; <$fh> })
655	. "\n};\n1";
656
657	eval $source
658	or die $@ ? "$path: $@\n"
659	: "extension disabled.\n";
660
661	push @exts, $pkg;
662	$ext_pkg{$base} = $pkg;
663
664	# no strict 'refs';
665	# @{"$pkg\::ISA"} = ext::;
666
667	register $base, $pkg;
668	}
669
670	sub unload_extension {
671	my ($pkg) = @_;
672
673	warn "removing extension $pkg\n";
674
675	# remove hooks
676	#TODO
677	# for my $idx (0 .. $#PLUGIN_EVENT) {
678	# delete $hook[$idx]{$pkg};
679	# }
680
681	# remove commands
682	for my $name (keys %COMMAND) {
683	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
684
685	if (@cb) {
686	$COMMAND{$name} = \@cb;
687	} else {
688	delete $COMMAND{$name};
689	}	1564	}
690	}	1565	};
691		1566
692	# remove extcmds	1567	$grp
693	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {	1568	}
694	delete $EXTCMD{$name};
695	}
696		1569
697	if (my $cb = $pkg->can ("unload")) {	1570	sub _ext_cfg_reg($$$$) {
698	eval {	1571	my ($rvar, $varname, $cfgname, $default) = @_;
699	$cb->($pkg);
700	1
701	} or warn "$pkg unloaded, but with errors: $@";
702	}
703		1572
704	Symbol::delete_package $pkg;	1573	$cfgname = lc $varname
		1574	unless length $cfgname;
		1575
		1576	$EXT_CFG{$cfgname} = [$rvar, $default];
		1577
		1578	$$rvar = exists $CFG{$cfgname} ? $CFG{$cfgname} : $default;
705	}	1579	}
706		1580
707	sub load_extensions {	1581	sub load_extensions {
		1582	info "loading extensions...";
		1583
		1584	%EXT_CFG = ();
		1585
		1586	cf::sync_job {
		1587	my %todo;
		1588
708	for my $ext (<$LIBDIR/*.ext>) {	1589	for my $path (<$LIBDIR/*.ext>) {
709	next unless -r $ext;	1590	next unless -r $path;
710	eval {	1591
711	load_extension $ext;	1592	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1593	my $base = $1;
		1594	my $pkg = $1;
		1595	$pkg =~ s/[^[:word:]]/_/g;
		1596	$pkg = "ext::$pkg";
		1597
		1598	open my $fh, "<:utf8", $path
		1599	or die "$path: $!";
		1600
		1601	my $source = do { local $/; <$fh> };
		1602
		1603	my %ext = (
		1604	path => $path,
		1605	base => $base,
		1606	pkg => $pkg,
		1607	);
		1608
		1609	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1610	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1611
		1612	$ext{source} =
		1613	"package $pkg; use common::sense;\n"
		1614	. "#line 1 \"$path\"\n{\n"
		1615	. $source
		1616	. "\n};\n1";
		1617
		1618	$todo{$base} = \%ext;
		1619	}
		1620
		1621	my $pass = 0;
		1622	my %done;
		1623	while (%todo) {
		1624	my $progress;
		1625
		1626	++$pass;
		1627
		1628	ext:
		1629	while (my ($k, $v) = each %todo) {
		1630	for (split /,\s*/, $v->{meta}{depends}) {
		1631	next ext
		1632	unless exists $done{$_};
		1633	}
		1634
		1635	trace "... pass $pass, loading '$k' into '$v->{pkg}'\n";
		1636
		1637	my $source = $v->{source};
		1638
		1639	# support "CONF varname :confname = default" pseudo-statements
		1640	$source =~ s{
		1641	^ CONF \s+ ([^\s:=]+) \s* (?:: \s* ([^\s:=]+) \s* )? = ([^\n#]+)
		1642	}{
		1643	"our \$$1; BEGIN { cf::_ext_cfg_reg \\\$$1, q\x00$1\x00, q\x00$2\x00, $3 }";
		1644	}gmxe;
		1645
		1646	my $active = eval $source;
		1647
		1648	if (length $@) {
		1649	error "$v->{path}: $@\n";
		1650
		1651	cf::cleanup "mandatory extension '$k' failed to load, exiting."
		1652	if exists $v->{meta}{mandatory};
		1653
		1654	warn "$v->{base}: optional extension cannot be loaded, skipping.\n";
		1655	delete $todo{$k};
		1656	} else {
		1657	$done{$k} = delete $todo{$k};
		1658	push @EXTS, $v->{pkg};
		1659	$progress = 1;
		1660
		1661	info "$v->{base}: extension inactive.\n"
		1662	unless $active;
		1663	}
712	1	1664	}
713	} or warn "$ext not loaded: $@";	1665
		1666	unless ($progress) {
		1667	warn "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n";
		1668
		1669	while (my ($k, $v) = each %todo) {
		1670	cf::cleanup "mandatory extension '$k' has unresolved dependencies, exiting."
		1671	if exists $v->{meta}{mandatory};
		1672	}
		1673
		1674	last;
		1675	}
		1676	}
714	}	1677	};
715	}	1678	}
716		1679
717	#############################################################################	1680	#############################################################################
718	# load/save/clean perl data associated with a map
719		1681
720	*cf::mapsupport::on_clean = sub {	1682	=back
		1683
		1684	=head2 CORE EXTENSIONS
		1685
		1686	Functions and methods that extend core deliantra objects.
		1687
		1688	=cut
		1689
		1690	package cf::player;
		1691
		1692	use Coro::AIO;
		1693
		1694	=head3 cf::player
		1695
		1696	=over 4
		1697
		1698	=item cf::player::num_playing
		1699
		1700	Returns the official number of playing players, as per the Crossfire metaserver rules.
		1701
		1702	=cut
		1703
		1704	sub num_playing {
		1705	scalar grep
		1706	$_->ob->map
		1707	&& !$_->hidden
		1708	&& !$_->ob->flag (cf::FLAG_WIZ),
		1709	cf::player::list
		1710	}
		1711
		1712	=item cf::player::find $login
		1713
		1714	Returns the given player object, loading it if necessary (might block).
		1715
		1716	=cut
		1717
		1718	sub playerdir($) {
		1719	"$PLAYERDIR/"
		1720	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		1721	}
		1722
		1723	sub path($) {
		1724	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		1725
		1726	(playerdir $login) . "/playerdata"
		1727	}
		1728
		1729	sub find_active($) {
		1730	$cf::PLAYER{$_[0]}
		1731	and $cf::PLAYER{$_[0]}->active
		1732	and $cf::PLAYER{$_[0]}
		1733	}
		1734
		1735	sub exists($) {
721	my ($map) = @_;	1736	my ($login) = @_;
722		1737
723	my $path = $map->tmpname;	1738	$cf::PLAYER{$login}
724	defined $path or return;	1739	or !aio_stat path $login
725
726	unlink "$path.pst";
727	};
728
729	cf::map->attach (prio => -10000, package => cf::mapsupport::);
730
731	#############################################################################
732	# load/save perl data associated with player->ob objects
733
734	sub all_objects(@) {
735	@_, map all_objects ($_->inv), @_
736	}	1740	}
737		1741
738	# TODO: compatibility cruft, remove when no longer needed	1742	sub find($) {
		1743	return $cf::PLAYER{$_[0]} || do {
		1744	my $login = $_[0];
		1745
		1746	my $guard = cf::lock_acquire "user_find:$login";
		1747
		1748	$cf::PLAYER{$_[0]} || do {
		1749	# rename old playerfiles to new ones
		1750	#TODO: remove when no longer required
		1751	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1752	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1753	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1754	aio_unlink +(playerdir $login) . "/$login.pl";
		1755
		1756	my $f = new_from_file cf::object::thawer path $login
		1757	or return;
		1758
		1759	my $pl = cf::player::load_pl $f
		1760	or return;
		1761
		1762	local $cf::PLAYER_LOADING{$login} = $pl;
		1763	$f->resolve_delayed_derefs;
		1764	$cf::PLAYER{$login} = $pl
		1765	}
		1766	}
		1767	}
		1768
739	cf::player->attach (	1769	cf::player->attach (
740	on_load => sub {	1770	on_load => sub {
741	my ($pl, $path) = @_;	1771	my ($pl, $path) = @_;
742		1772
743	for my $o (all_objects $pl->ob) {	1773	# restore slots saved in save, below
744	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1774	my $slots = delete $pl->{_slots};
745	$o->set_ob_key_value ("_perl_data");
746		1775
747	%$o = %{ Storable::thaw pack "H*", $value };	1776	$pl->ob->current_weapon ($slots->[0]);
748	}	1777	$pl->combat_ob ($slots->[1]);
749	}	1778	$pl->ranged_ob ($slots->[2]);
750	},	1779	},
751	);	1780	);
752		1781
753	#############################################################################	1782	sub save($) {
		1783	my ($pl) = @_;
754		1784
755	=head2 CORE EXTENSIONS	1785	return if $pl->{deny_save};
756		1786
757	Functions and methods that extend core crossfire objects.	1787	my $path = path $pl;
		1788	my $guard = cf::lock_acquire "user_save:$path";
758		1789
759	=head3 cf::player	1790	return if $pl->{deny_save};
		1791
		1792	aio_mkdir playerdir $pl, 0770;
		1793	$pl->{last_save} = $cf::RUNTIME;
		1794
		1795	cf::get_slot 0.01;
		1796
		1797	# save slots, to be restored later
		1798	local $pl->{_slots} = [$pl->ob->current_weapon, $pl->combat_ob, $pl->ranged_ob];
		1799
		1800	$pl->save_pl ($path);
		1801	cf::cede_to_tick;
		1802	}
		1803
		1804	sub new($) {
		1805	my ($login) = @_;
		1806
		1807	my $self = create;
		1808
		1809	$self->ob->name ($login);
		1810	$self->{deny_save} = 1;
		1811
		1812	$cf::PLAYER{$login} = $self;
		1813
		1814	$self
		1815	}
		1816
		1817	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1818
		1819	=cut
		1820
		1821	sub send_msg {
		1822	my $ns = shift->ns
		1823	or return;
		1824	$ns->send_msg (@_);
		1825	}
		1826
		1827	=item $pl->quit_character
		1828
		1829	Nukes the player without looking back. If logged in, the connection will
		1830	be destroyed. May block for a long time.
		1831
		1832	=cut
		1833
		1834	sub quit_character {
		1835	my ($pl) = @_;
		1836
		1837	my $name = $pl->ob->name;
		1838
		1839	$pl->{deny_save} = 1;
		1840	$pl->password ("*"); # this should lock out the player until we have nuked the dir
		1841
		1842	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->ns;
		1843	$pl->deactivate;
		1844
		1845	my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
		1846	$pl->invoke (cf::EVENT_PLAYER_QUIT) if $pl->ns;
		1847	ext::highscore::check ($pl->ob);
		1848
		1849	$pl->ns->destroy if $pl->ns;
		1850
		1851	my $path = playerdir $pl;
		1852	my $temp = "$path~$cf::RUNTIME~deleting~";
		1853	aio_rename $path, $temp;
		1854	delete $cf::PLAYER{$pl->ob->name};
		1855	$pl->destroy;
		1856
		1857	my $prefix = qr<^~\Q$name\E/>;
		1858
		1859	# nuke player maps
		1860	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1861
		1862	IO::AIO::aio_rmtree $temp;
		1863	}
		1864
		1865	=item $pl->kick
		1866
		1867	Kicks a player out of the game. This destroys the connection.
		1868
		1869	=cut
		1870
		1871	sub kick {
		1872	my ($pl, $kicker) = @_;
		1873
		1874	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1875	$pl->killer ("kicked");
		1876	$pl->ns->destroy;
		1877	}
		1878
		1879	=item cf::player::list_logins
		1880
		1881	Returns am arrayref of all valid playernames in the system, can take a
		1882	while and may block, so not sync_job-capable, ever.
		1883
		1884	=cut
		1885
		1886	sub list_logins {
		1887	my $dirs = aio_readdir $PLAYERDIR
		1888	or return [];
		1889
		1890	my @logins;
		1891
		1892	for my $login (@$dirs) {
		1893	my $path = path $login;
		1894
		1895	# a .pst is a dead give-away for a valid player
		1896	# if no pst file found, open and chekc for blocked users
		1897	if (aio_stat "$path.pst") {
		1898	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
		1899	aio_read $fh, 0, 512, my $buf, 0 or next;
		1900	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1901	}
		1902
		1903	utf8::decode $login;
		1904	push @logins, $login;
		1905	}
		1906
		1907	\@logins
		1908	}
		1909
		1910	=item $player->maps
		1911
		1912	=item cf::player::maps $login
		1913
		1914	Returns an arrayref of map paths that are private for this
		1915	player. May block.
		1916
		1917	=cut
		1918
		1919	sub maps($) {
		1920	my ($pl) = @_;
		1921
		1922	$pl = ref $pl ? $pl->ob->name : $pl;
		1923
		1924	my $files = aio_readdir playerdir $pl
		1925	or return;
		1926
		1927	my @paths;
		1928
		1929	for (@$files) {
		1930	utf8::decode $_;
		1931	next if /\.(?:pl|pst)$/;
		1932	next unless /^$PATH_SEP/o;
		1933
		1934	push @paths, cf::map::normalise "~$pl/$_";
		1935	}
		1936
		1937	\@paths
		1938	}
		1939
		1940	=item $protocol_xml = $player->expand_cfpod ($cfpod)
		1941
		1942	Expand deliantra pod fragments into protocol xml.
		1943
		1944	=item $player->ext_msg ($type, @msg)
		1945
		1946	Sends an ext event to the client.
		1947
		1948	=cut
		1949
		1950	sub ext_msg($$@) {
		1951	my ($self, $type, @msg) = @_;
		1952
		1953	$self->ns->ext_msg ($type, @msg);
		1954	}
		1955
		1956	=head3 cf::region
760		1957
761	=over 4	1958	=over 4
762		1959
763	=item cf::player::exists $login
764
765	Returns true when the given account exists.
766
767	=cut	1960	=cut
768		1961
769	sub cf::player::exists($) {	1962	package cf::region;
770	cf::player::find $_[0]
771	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
772	}
773		1963
774	=item $player->ext_reply ($msgid, $msgtype, %msg)	1964	=item cf::region::find_by_path $path
775		1965
776	Sends an ext reply to the player.	1966	Tries to decuce the likely region for a map knowing only its path.
777		1967
778	=cut	1968	=cut
779		1969
780	sub cf::player::ext_reply($$$%) {	1970	sub find_by_path($) {
		1971	my ($path) = @_;
		1972
		1973	$path =~ s/^~[^\/]*//; # skip ~login
		1974
		1975	my ($match, $specificity);
		1976
		1977	for my $region (list) {
		1978	if ($region->{match} && $path =~ $region->{match}) {
		1979	($match, $specificity) = ($region, $region->specificity)
		1980	if $region->specificity > $specificity;
		1981	}
		1982	}
		1983
		1984	$match
		1985	}
		1986
		1987	=back
		1988
		1989	=head3 cf::map
		1990
		1991	=over 4
		1992
		1993	=cut
		1994
		1995	package cf::map;
		1996
		1997	use Fcntl;
		1998	use Coro::AIO;
		1999
		2000	use overload
		2001	'""' => \&as_string,
		2002	fallback => 1;
		2003
		2004	our $MAX_RESET = 3600;
		2005	our $DEFAULT_RESET = 3000;
		2006
		2007	sub generate_random_map {
		2008	my ($self, $rmp) = @_;
		2009
		2010	my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
		2011
		2012	$self->_create_random_map ($rmp);
		2013	}
		2014
		2015	=item cf::map->register ($regex, $prio)
		2016
		2017	Register a handler for the map path matching the given regex at the
		2018	givne priority (higher is better, built-in handlers have priority 0, the
		2019	default).
		2020
		2021	=cut
		2022
		2023	sub register {
		2024	my (undef, $regex, $prio) = @_;
		2025	my $pkg = caller;
		2026
		2027	push @{"$pkg\::ISA"}, __PACKAGE__;
		2028
		2029	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		2030	}
		2031
		2032	# also paths starting with '/'
		2033	$EXT_MAP{"cf::map::wrap"} = [0, qr{^(?=/)}];
		2034
		2035	sub thawer_merge {
781	my ($self, $id, %msg) = @_;	2036	my ($self, $merge) = @_;
782		2037
783	$msg{msgid} = $id;	2038	# we have to keep some variables in memory intact
		2039	local $self->{path};
		2040	local $self->{load_path};
784		2041
785	$self->send ("ext " . to_json \%msg);	2042	$self->SUPER::thawer_merge ($merge);
786	}	2043	}
		2044
		2045	sub normalise {
		2046	my ($path, $base) = @_;
		2047
		2048	$path = "$path"; # make sure it's a string
		2049
		2050	$path =~ s/\.map$//;
		2051
		2052	# map plan:
		2053	#
		2054	# /! non-realised random map exit (special hack!)
		2055	# {... are special paths that are not being touched
		2056	# ?xxx/... are special absolute paths
		2057	# ?random/... random maps
		2058	# /... normal maps
		2059	# ~user/... per-player map of a specific user
		2060
		2061	$path =~ s/$PATH_SEP/\//go;
		2062
		2063	# treat it as relative path if it starts with
		2064	# something that looks reasonable
		2065	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		2066	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		2067
		2068	$base =~ s{[^/]+/?$}{};
		2069	$path = "$base/$path";
		2070	}
		2071
		2072	for ($path) {
		2073	redo if s{/\.?/}{/};
		2074	redo if s{/[^/]+/\.\./}{/};
		2075	}
		2076
		2077	$path
		2078	}
		2079
		2080	sub new_from_path {
		2081	my (undef, $path, $base) = @_;
		2082
		2083	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		2084
		2085	$path = normalise $path, $base;
		2086
		2087	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		2088	if ($path =~ $EXT_MAP{$pkg}[1]) {
		2089	my $self = bless cf::map::new, $pkg;
		2090	$self->{path} = $path; $self->path ($path);
		2091	$self->init; # pass $1 etc.
		2092	return $self;
		2093	}
		2094	}
		2095
		2096	Carp::cluck "unable to resolve path '$path' (base '$base')";
		2097	()
		2098	}
		2099
		2100	# may re-bless or do other evil things
		2101	sub init {
		2102	my ($self) = @_;
		2103
		2104	$self
		2105	}
		2106
		2107	sub as_string {
		2108	my ($self) = @_;
		2109
		2110	"$self->{path}"
		2111	}
		2112
		2113	# the displayed name, this is a one way mapping
		2114	sub visible_name {
		2115	&as_string
		2116	}
		2117
		2118	# the original (read-only) location
		2119	sub load_path {
		2120	my ($self) = @_;
		2121
		2122	"$MAPDIR/$self->{path}.map"
		2123	}
		2124
		2125	# the temporary/swap location
		2126	sub save_path {
		2127	my ($self) = @_;
		2128
		2129	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
		2130	"$TMPDIR/$path.map"
		2131	}
		2132
		2133	# the unique path, undef == no special unique path
		2134	sub uniq_path {
		2135	my ($self) = @_;
		2136
		2137	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
		2138	"$UNIQUEDIR/$path"
		2139	}
		2140
		2141	sub decay_objects {
		2142	my ($self) = @_;
		2143
		2144	return if $self->{deny_reset};
		2145
		2146	$self->do_decay_objects;
		2147	}
		2148
		2149	sub unlink_save {
		2150	my ($self) = @_;
		2151
		2152	utf8::encode (my $save = $self->save_path);
		2153	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		2154	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		2155	}
		2156
		2157	sub load_header_from($) {
		2158	my ($self, $path) = @_;
		2159
		2160	utf8::encode $path;
		2161	my $f = new_from_file cf::object::thawer $path
		2162	or return;
		2163
		2164	$self->_load_header ($f)
		2165	or return;
		2166
		2167	local $MAP_LOADING{$self->{path}} = $self;
		2168	$f->resolve_delayed_derefs;
		2169
		2170	$self->{load_path} = $path;
		2171
		2172	1
		2173	}
		2174
		2175	# used to laod the header of an original map
		2176	sub load_header_orig {
		2177	my ($self) = @_;
		2178
		2179	$self->load_header_from ($self->load_path)
		2180	}
		2181
		2182	# used to laod the header of an instantiated map
		2183	sub load_header_temp {
		2184	my ($self) = @_;
		2185
		2186	$self->load_header_from ($self->save_path)
		2187	}
		2188
		2189	# called after loading the header from an instantiated map
		2190	sub prepare_temp {
		2191	my ($self) = @_;
		2192
		2193	$self->last_access ((delete $self->{last_access})
		2194	|| $cf::RUNTIME); #d#
		2195	# safety
		2196	$self->{instantiate_time} = $cf::RUNTIME
		2197	if $self->{instantiate_time} > $cf::RUNTIME;
		2198	}
		2199
		2200	# called after loading the header from an original map
		2201	sub prepare_orig {
		2202	my ($self) = @_;
		2203
		2204	$self->{load_original} = 1;
		2205	$self->{instantiate_time} = $cf::RUNTIME;
		2206	$self->last_access ($cf::RUNTIME);
		2207	$self->instantiate;
		2208	}
		2209
		2210	sub load_header {
		2211	my ($self) = @_;
		2212
		2213	if ($self->load_header_temp) {
		2214	$self->prepare_temp;
		2215	} else {
		2216	$self->load_header_orig
		2217	or return;
		2218	$self->prepare_orig;
		2219	}
		2220
		2221	$self->{deny_reset} = 1
		2222	if $self->no_reset;
		2223
		2224	$self->default_region (cf::region::find_by_path $self->{path})
		2225	unless $self->default_region;
		2226
		2227	1
		2228	}
		2229
		2230	sub find;
		2231	sub find {
		2232	my ($path, $origin) = @_;
		2233
		2234	cf::cede_to_tick;
		2235
		2236	$path = normalise $path, $origin;
		2237
		2238	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
		2239	my $guard2 = cf::lock_acquire "map_find:$path";
		2240
		2241	$cf::MAP{$path} || do {
		2242	my $map = new_from_path cf::map $path
		2243	or return;
		2244
		2245	$map->{last_save} = $cf::RUNTIME;
		2246
		2247	$map->load_header
		2248	or return;
		2249
		2250	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		2251	# doing this can freeze the server in a sync job, obviously
		2252	#$cf::WAIT_FOR_TICK->wait;
		2253	undef $guard2;
		2254	undef $guard1;
		2255	$map->reset;
		2256	return find $path;
		2257	}
		2258
		2259	$cf::MAP{$path} = $map
		2260	}
		2261	}
		2262
		2263	sub pre_load { }
		2264	#sub post_load { } # XS
		2265
		2266	sub load {
		2267	my ($self) = @_;
		2268
		2269	local $self->{deny_reset} = 1; # loading can take a long time
		2270
		2271	my $path = $self->{path};
		2272
		2273	{
		2274	my $guard = cf::lock_acquire "map_data:$path";
		2275
		2276	return unless $self->valid;
		2277	return unless $self->state == cf::MAP_SWAPPED;
		2278
		2279	$self->alloc;
		2280
		2281	$self->pre_load;
		2282	cf::cede_to_tick;
		2283
		2284	if (exists $self->{load_path}) {
		2285	my $f = new_from_file cf::object::thawer $self->{load_path};
		2286	$f->skip_block;
		2287	$self->_load_objects ($f)
		2288	or return;
		2289
		2290	$self->post_load_original
		2291	if delete $self->{load_original};
		2292
		2293	if (my $uniq = $self->uniq_path) {
		2294	utf8::encode $uniq;
		2295	unless (aio_stat $uniq) {
		2296	if (my $f = new_from_file cf::object::thawer $uniq) {
		2297	$self->clear_unique_items;
		2298	$self->_load_objects ($f);
		2299	$f->resolve_delayed_derefs;
		2300	}
		2301	}
		2302	}
		2303
		2304	$f->resolve_delayed_derefs;
		2305	} else {
		2306	$self->post_load_original
		2307	if delete $self->{load_original};
		2308	}
		2309
		2310	$self->state (cf::MAP_INACTIVE);
		2311
		2312	cf::cede_to_tick;
		2313	# now do the right thing for maps
		2314	$self->link_multipart_objects;
		2315	$self->difficulty ($self->estimate_difficulty)
		2316	unless $self->difficulty;
		2317	cf::cede_to_tick;
		2318
		2319	unless ($self->{deny_activate}) {
		2320	$self->decay_objects;
		2321	$self->fix_auto_apply;
		2322	$self->update_buttons;
		2323	cf::cede_to_tick;
		2324	#$self->activate; # no longer activate maps automatically
		2325	}
		2326
		2327	$self->{last_save} = $cf::RUNTIME;
		2328	$self->last_access ($cf::RUNTIME);
		2329	}
		2330
		2331	$self->post_load;
		2332
		2333	1
		2334	}
		2335
		2336	# customize the map for a given player, i.e.
		2337	# return the _real_ map. used by e.g. per-player
		2338	# maps to change the path to ~playername/mappath
		2339	sub customise_for {
		2340	my ($self, $ob) = @_;
		2341
		2342	return find "~" . $ob->name . "/" . $self->{path}
		2343	if $self->per_player;
		2344
		2345	# return find "?party/" . $ob->name . "/" . $self->{path}
		2346	# if $self->per_party;
		2347
		2348	$self
		2349	}
		2350
		2351	sub find_sync {
		2352	my ($path, $origin) = @_;
		2353
		2354	# it's a bug to call this from the main context
		2355	return cf::LOG cf::llevError | cf::logBacktrace, "do_find_sync"
		2356	if $Coro::current == $Coro::main;
		2357
		2358	find $path, $origin
		2359	}
		2360
		2361	sub do_load_sync {
		2362	my ($map) = @_;
		2363
		2364	# it's a bug to call this from the main context
		2365	return cf::LOG cf::llevError | cf::logBacktrace, "do_load_sync"
		2366	if $Coro::current == $Coro::main;
		2367
		2368	$map->load;
		2369	}
		2370
		2371	our %MAP_PREFETCH;
		2372	our $MAP_PREFETCHER = undef;
		2373
		2374	sub find_async {
		2375	my ($path, $origin, $load) = @_;
		2376
		2377	$path = normalise $path, $origin;
		2378
		2379	if (my $map = $cf::MAP{$path}) {
		2380	return $map if !$load || $map->linkable;
		2381	}
		2382
		2383	$MAP_PREFETCH{$path} |= $load;
		2384
		2385	$MAP_PREFETCHER ||= cf::async {
		2386	$Coro::current->{desc} = "map prefetcher";
		2387
		2388	while (%MAP_PREFETCH) {
		2389	while (my ($k, $v) = each %MAP_PREFETCH) {
		2390	if (my $map = find $k) {
		2391	$map->load if $v;
		2392	}
		2393
		2394	delete $MAP_PREFETCH{$k};
		2395	}
		2396	}
		2397	undef $MAP_PREFETCHER;
		2398	};
		2399	$MAP_PREFETCHER->prio (6);
		2400
		2401	()
		2402	}
		2403
		2404	# common code, used by both ->save and ->swapout
		2405	sub _save {
		2406	my ($self) = @_;
		2407
		2408	$self->{last_save} = $cf::RUNTIME;
		2409
		2410	return unless $self->dirty;
		2411
		2412	my $save = $self->save_path; utf8::encode $save;
		2413	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2414
		2415	$self->{load_path} = $save;
		2416
		2417	return if $self->{deny_save};
		2418
		2419	local $self->{last_access} = $self->last_access;#d#
		2420
		2421	cf::async {
		2422	$Coro::current->{desc} = "map player save";
		2423	$_->contr->save for $self->players;
		2424	};
		2425
		2426	cf::get_slot 0.02;
		2427
		2428	if ($uniq) {
		2429	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		2430	$self->_save_objects ($uniq, cf::IO_UNIQUES);
		2431	} else {
		2432	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
		2433	}
		2434	}
		2435
		2436	sub save {
		2437	my ($self) = @_;
		2438
		2439	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2440
		2441	$self->_save;
		2442	}
		2443
		2444	sub swap_out {
		2445	my ($self) = @_;
		2446
		2447	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2448
		2449	return if !$self->linkable;
		2450	return if $self->{deny_save};
		2451	return if $self->players;
		2452
		2453	# first deactivate the map and "unlink" it from the core
		2454	$self->deactivate;
		2455	$_->clear_links_to ($self) for values %cf::MAP;
		2456	$self->state (cf::MAP_SWAPPED);
		2457
		2458	# then atomically save
		2459	$self->_save;
		2460
		2461	# then free the map
		2462	$self->clear;
		2463	}
		2464
		2465	sub reset_at {
		2466	my ($self) = @_;
		2467
		2468	# TODO: safety, remove and allow resettable per-player maps
		2469	return 1e99 if $self->{deny_reset};
		2470
		2471	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		2472	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		2473
		2474	$time + $to
		2475	}
		2476
		2477	sub should_reset {
		2478	my ($self) = @_;
		2479
		2480	$self->reset_at <= $cf::RUNTIME
		2481	}
		2482
		2483	sub reset {
		2484	my ($self) = @_;
		2485
		2486	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2487
		2488	return if $self->players;
		2489
		2490	cf::trace "resetting map ", $self->path, "\n";
		2491
		2492	$self->state (cf::MAP_SWAPPED);
		2493
		2494	# need to save uniques path
		2495	unless ($self->{deny_save}) {
		2496	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2497
		2498	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2499	if $uniq;
		2500	}
		2501
		2502	delete $cf::MAP{$self->path};
		2503
		2504	$self->deactivate;
		2505	$_->clear_links_to ($self) for values %cf::MAP;
		2506	$self->clear;
		2507
		2508	$self->unlink_save;
		2509	$self->destroy;
		2510	}
		2511
		2512	my $nuke_counter = "aaaa";
		2513
		2514	sub nuke {
		2515	my ($self) = @_;
		2516
		2517	{
		2518	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2519
		2520	delete $cf::MAP{$self->path};
		2521
		2522	$self->unlink_save;
		2523
		2524	bless $self, "cf::map::wrap";
		2525	delete $self->{deny_reset};
		2526	$self->{deny_save} = 1;
		2527	$self->reset_timeout (1);
		2528	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2529
		2530	$cf::MAP{$self->path} = $self;
		2531	}
		2532
		2533	$self->reset; # polite request, might not happen
		2534	}
		2535
		2536	=item $maps = cf::map::tmp_maps
		2537
		2538	Returns an arrayref with all map paths of currently instantiated and saved
		2539	maps. May block.
		2540
		2541	=cut
		2542
		2543	sub tmp_maps() {
		2544	[
		2545	map {
		2546	utf8::decode $_;
		2547	/\.map$/
		2548	? normalise $_
		2549	: ()
		2550	} @{ aio_readdir $TMPDIR or [] }
		2551	]
		2552	}
		2553
		2554	=item $maps = cf::map::random_maps
		2555
		2556	Returns an arrayref with all map paths of currently instantiated and saved
		2557	random maps. May block.
		2558
		2559	=cut
		2560
		2561	sub random_maps() {
		2562	[
		2563	map {
		2564	utf8::decode $_;
		2565	/\.map$/
		2566	? normalise "?random/$_"
		2567	: ()
		2568	} @{ aio_readdir $RANDOMDIR or [] }
		2569	]
		2570	}
		2571
		2572	=item cf::map::unique_maps
		2573
		2574	Returns an arrayref of paths of all shared maps that have
		2575	instantiated unique items. May block.
		2576
		2577	=cut
		2578
		2579	sub unique_maps() {
		2580	[
		2581	map {
		2582	utf8::decode $_;
		2583	s/\.map$//; # TODO future compatibility hack
		2584	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
		2585	? ()
		2586	: normalise $_
		2587	} @{ aio_readdir $UNIQUEDIR or [] }
		2588	]
		2589	}
		2590
		2591	=item cf::map::static_maps
		2592
		2593	Returns an arrayref if paths of all static maps (all preinstalled F<.map>
		2594	file in the shared directory excluding F</styles> and F</editor>). May
		2595	block.
		2596
		2597	=cut
		2598
		2599	sub static_maps() {
		2600	my @dirs = "";
		2601	my @maps;
		2602
		2603	while (@dirs) {
		2604	my $dir = shift @dirs;
		2605
		2606	next if $dir eq "/styles" || $dir eq "/editor";
		2607
		2608	my ($dirs, $files) = Coro::AIO::aio_scandir "$MAPDIR$dir", 2
		2609	or return;
		2610
		2611	for (@$files) {
		2612	s/\.map$// or next;
		2613	utf8::decode $_;
		2614	push @maps, "$dir/$_";
		2615	}
		2616
		2617	push @dirs, map "$dir/$_", @$dirs;
		2618	}
		2619
		2620	\@maps
		2621	}
		2622
		2623	=back
		2624
		2625	=head3 cf::object
		2626
		2627	=cut
		2628
		2629	package cf::object;
		2630
		2631	=over 4
		2632
		2633	=item $ob->inv_recursive
		2634
		2635	Returns the inventory of the object I<and> their inventories, recursively,
		2636	but I<not> the object itself.
		2637
		2638	=cut
		2639
		2640	sub inv_recursive_;
		2641	sub inv_recursive_ {
		2642	map { $_, inv_recursive_ $_->inv } @_
		2643	}
		2644
		2645	sub inv_recursive {
		2646	inv_recursive_ inv $_[0]
		2647	}
		2648
		2649	=item $ref = $ob->ref
		2650
		2651	Creates and returns a persistent reference to an object that can be stored as a string.
		2652
		2653	=item $ob = cf::object::deref ($refstring)
		2654
		2655	returns the objetc referenced by refstring. may return undef when it cannot find the object,
		2656	even if the object actually exists. May block.
		2657
		2658	=cut
		2659
		2660	sub deref {
		2661	my ($ref) = @_;
		2662
		2663	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2664	my ($uuid, $name) = ($1, $2);
		2665	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2666	or return;
		2667	$pl->ob->uuid eq $uuid
		2668	or return;
		2669
		2670	$pl->ob
		2671	} else {
		2672	warn "$ref: cannot resolve object reference\n";
		2673	undef
		2674	}
		2675	}
		2676
		2677	package cf;
787		2678
788	=back	2679	=back
789		2680
790	=head3 cf::object::player	2681	=head3 cf::object::player
791		2682
…		…
796	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	2687	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
797	can be C<undef>. Does the right thing when the player is currently in a	2688	can be C<undef>. Does the right thing when the player is currently in a
798	dialogue with the given NPC character.	2689	dialogue with the given NPC character.
799		2690
800	=cut	2691	=cut
		2692
		2693	our $SAY_CHANNEL = {
		2694	id => "say",
		2695	title => "Map",
		2696	reply => "say ",
		2697	tooltip => "Things said to and replied from NPCs near you and other players on the same map only.",
		2698	};
		2699
		2700	our $CHAT_CHANNEL = {
		2701	id => "chat",
		2702	title => "Chat",
		2703	reply => "chat ",
		2704	tooltip => "Player chat and shouts, global to the server.",
		2705	};
801		2706
802	# rough implementation of a future "reply" method that works	2707	# rough implementation of a future "reply" method that works
803	# with dialog boxes.	2708	# with dialog boxes.
804	#TODO: the first argument must go, split into a $npc->reply_to ( method	2709	#TODO: the first argument must go, split into a $npc->reply_to ( method
805	sub cf::object::player::reply($$$;$) {	2710	sub cf::object::player::reply($$$;$) {
…		…
807		2712
808	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2713	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
809		2714
810	if ($self->{record_replies}) {	2715	if ($self->{record_replies}) {
811	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2716	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2717
812	} else {	2718	} else {
		2719	my $pl = $self->contr;
		2720
		2721	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2722	my $dialog = $pl->{npc_dialog};
		2723	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2724
		2725	} else {
813	$msg = $npc->name . " says: $msg" if $npc;	2726	$msg = $npc->name . " says: $msg" if $npc;
814	$self->message ($msg, $flags);	2727	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2728	}
815	}	2729	}
		2730	}
		2731
		2732	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2733
		2734	=cut
		2735
		2736	sub cf::object::send_msg {
		2737	my $pl = shift->contr
		2738	or return;
		2739	$pl->send_msg (@_);
816	}	2740	}
817		2741
818	=item $player_object->may ("access")	2742	=item $player_object->may ("access")
819		2743
820	Returns wether the given player is authorized to access resource "access"	2744	Returns wether the given player is authorized to access resource "access"
821	(e.g. "command_wizcast").	2745	(e.g. "command_wizcast").
822		2746
		2747	This is implemented by checking a config setting of C<may_access> where
		2748	C<access> is replaced by the access string. The following alternatives are
		2749	possible (and are tested in order):
		2750
		2751	=over 4
		2752
		2753	=item * Player is DM
		2754
		2755	The request will succeed.
		2756
		2757	=item * may_access is an array reference
		2758
		2759	If either the player nickname or UUID is in the array, the request will
		2760	succeed, otherwise it will fail.
		2761
		2762	=item * may_access is a true value
		2763
		2764	The request will succeed.
		2765
		2766	=item * may_access is missing or false
		2767
		2768	The request will fail.
		2769
		2770	=back
		2771
823	=cut	2772	=cut
824		2773
825	sub cf::object::player::may {	2774	sub cf::object::player::may {
826	my ($self, $access) = @_;	2775	my ($self, $access) = @_;
827		2776
828	$self->flag (cf::FLAG_WIZ) ||	2777	$self->flag (cf::FLAG_WIZ) ||
829	(ref $cf::CFG{"may_$access"}	2778	(ref $cf::CFG{"may_$access"}
830	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	2779	? scalar grep $self->name eq $_ || $self->uuid eq $_, @{$cf::CFG{"may_$access"}}
831	: $cf::CFG{"may_$access"})	2780	: $cf::CFG{"may_$access"})
832	}	2781	}
833		2782
		2783	=item $player_object->enter_link
		2784
		2785	Freezes the player and moves him/her to a special map (C<{link}>).
		2786
		2787	The player should be reasonably safe there for short amounts of time (e.g.
		2788	for loading a map). You I<MUST> call C<leave_link> as soon as possible,
		2789	though, as the player cannot control the character while it is on the link
		2790	map.
		2791
		2792	Will never block.
		2793
		2794	=item $player_object->leave_link ($map, $x, $y)
		2795
		2796	Moves the player out of the special C<{link}> map onto the specified
		2797	map. If the map is not valid (or omitted), the player will be moved back
		2798	to the location he/she was before the call to C<enter_link>, or, if that
		2799	fails, to the emergency map position.
		2800
		2801	Might block.
		2802
		2803	=cut
		2804
		2805	sub link_map {
		2806	unless ($LINK_MAP) {
		2807	$LINK_MAP = cf::map::find "{link}"
		2808	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2809	$LINK_MAP->load;
		2810	}
		2811
		2812	$LINK_MAP
		2813	}
		2814
		2815	sub cf::object::player::enter_link {
		2816	my ($self) = @_;
		2817
		2818	$self->deactivate_recursive;
		2819
		2820	++$self->{_link_recursion};
		2821
		2822	return if UNIVERSAL::isa $self->map, "ext::map_link";
		2823
		2824	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		2825	if $self->map && $self->map->{path} ne "{link}";
		2826
		2827	$self->enter_map ($LINK_MAP || link_map, 3, 3);
		2828	}
		2829
		2830	sub cf::object::player::leave_link {
		2831	my ($self, $map, $x, $y) = @_;
		2832
		2833	return unless $self->contr->active;
		2834
		2835	my $link_pos = delete $self->{_link_pos};
		2836
		2837	unless ($map) {
		2838	# restore original map position
		2839	($map, $x, $y) = @{ $link_pos || [] };
		2840	$map = cf::map::find $map;
		2841
		2842	unless ($map) {
		2843	($map, $x, $y) = @$EMERGENCY_POSITION;
		2844	$map = cf::map::find $map
		2845	or die "FATAL: cannot load emergency map\n";
		2846	}
		2847	}
		2848
		2849	($x, $y) = (-1, -1)
		2850	unless (defined $x) && (defined $y);
		2851
		2852	# use -1 or undef as default coordinates, not 0, 0
		2853	($x, $y) = ($map->enter_x, $map->enter_y)
		2854	if $x <= 0 && $y <= 0;
		2855
		2856	$map->load;
		2857
		2858	return unless $self->contr->active;
		2859
		2860	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
		2861	if ($self->enter_map ($map, $x, $y)) {
		2862	# entering was successful
		2863	delete $self->{_link_recursion};
		2864	# only activate afterwards, to support waiting in hooks
		2865	$self->activate_recursive;
		2866	}
		2867
		2868	}
		2869
		2870	=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
		2871
		2872	Moves the player to the given map-path and coordinates by first freezing
		2873	her, loading and preparing them map, calling the provided $check callback
		2874	that has to return the map if sucecssful, and then unfreezes the player on
		2875	the new (success) or old (failed) map position. In either case, $done will
		2876	be called at the end of this process.
		2877
		2878	Note that $check will be called with a potentially non-loaded map, so if
		2879	it needs a loaded map it has to call C<< ->load >>.
		2880
		2881	=cut
		2882
		2883	our $GOTOGEN;
		2884
		2885	sub cf::object::player::goto {
		2886	my ($self, $path, $x, $y, $check, $done) = @_;
		2887
		2888	if ($self->{_link_recursion} >= $MAX_LINKS) {
		2889	error "FATAL: link recursion exceeded, ", $self->name, " goto $path $x $y, redirecting.";
		2890	$self->failmsg ("Something went wrong inside the server - please contact an administrator!");
		2891	($path, $x, $y) = @$EMERGENCY_POSITION;
		2892	}
		2893
		2894	# do generation counting so two concurrent goto's will be executed in-order
		2895	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
		2896
		2897	$self->enter_link;
		2898
		2899	(async {
		2900	$Coro::current->{desc} = "player::goto $path $x $y";
		2901
		2902	# *tag paths override both path and x|y
		2903	if ($path =~ /^\*(.*)$/) {
		2904	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2905	my $ob = $obs[rand @obs];
		2906
		2907	# see if we actually can go there
		2908	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2909	$ob = $obs[rand @obs];
		2910	} else {
		2911	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2912	}
		2913	# else put us there anyways for now #d#
		2914
		2915	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2916	} else {
		2917	($path, $x, $y) = (undef, undef, undef);
		2918	}
		2919	}
		2920
		2921	my $map = eval {
		2922	my $map = defined $path ? cf::map::find $path, $self->map : undef;
		2923
		2924	if ($map) {
		2925	$map = $map->customise_for ($self);
		2926	$map = $check->($map, $x, $y, $self) if $check && $map;
		2927	} else {
		2928	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2929	}
		2930
		2931	$map
		2932	};
		2933
		2934	if ($@) {
		2935	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2936	LOG llevError | logBacktrace, Carp::longmess $@;
		2937	}
		2938
		2939	if ($gen == $self->{_goto_generation}) {
		2940	delete $self->{_goto_generation};
		2941	$self->leave_link ($map, $x, $y);
		2942	}
		2943
		2944	$done->($self) if $done;
		2945	})->prio (1);
		2946	}
		2947
		2948	=item $player_object->enter_exit ($exit_object)
		2949
		2950	=cut
		2951
		2952	sub parse_random_map_params {
		2953	my ($spec) = @_;
		2954
		2955	my $rmp = { # defaults
		2956	xsize => (cf::rndm 15, 40),
		2957	ysize => (cf::rndm 15, 40),
		2958	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2959	#layout => string,
		2960	};
		2961
		2962	for (split /\n/, $spec) {
		2963	my ($k, $v) = split /\s+/, $_, 2;
		2964
		2965	$rmp->{lc $k} = $v if (length $k) && (length $v);
		2966	}
		2967
		2968	$rmp
		2969	}
		2970
		2971	sub prepare_random_map {
		2972	my ($exit) = @_;
		2973
		2974	# all this does is basically replace the /! path by
		2975	# a new random map path (?random/...) with a seed
		2976	# that depends on the exit object
		2977
		2978	my $rmp = parse_random_map_params $exit->msg;
		2979
		2980	if ($exit->map) {
		2981	$rmp->{region} = $exit->region->name;
		2982	$rmp->{origin_map} = $exit->map->path;
		2983	$rmp->{origin_x} = $exit->x;
		2984	$rmp->{origin_y} = $exit->y;
		2985
		2986	$exit->map->touch;
		2987	}
		2988
		2989	$rmp->{random_seed} ||= $exit->random_seed;
		2990
		2991	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
		2992	my $md5 = Digest::MD5::md5_hex $data;
		2993	my $meta = "$RANDOMDIR/$md5.meta";
		2994
		2995	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		2996	aio_write $fh, 0, (length $data), $data, 0;
		2997	undef $fh;
		2998	aio_rename "$meta~", $meta;
		2999
		3000	my $slaying = "?random/$md5";
		3001
		3002	if ($exit->valid) {
		3003	$exit->slaying ("?random/$md5");
		3004	$exit->msg (undef);
		3005	}
		3006	}
		3007	}
		3008
		3009	sub cf::object::player::enter_exit {
		3010	my ($self, $exit) = @_;
		3011
		3012	return unless $self->type == cf::PLAYER;
		3013
		3014	$self->enter_link;
		3015
		3016	(async {
		3017	$Coro::current->{desc} = "enter_exit";
		3018
		3019	unless (eval {
		3020	$self->deactivate_recursive; # just to be sure
		3021
		3022	my $map = cf::map::normalise $exit->slaying, $exit->map;
		3023	my $x = $exit->stats->hp;
		3024	my $y = $exit->stats->sp;
		3025
		3026	# special map handling
		3027	my $slaying = $exit->slaying;
		3028
		3029	# special map handling
		3030	if ($slaying eq "/!") {
		3031	my $guard = cf::lock_acquire "exit_prepare:$exit";
		3032
		3033	prepare_random_map $exit
		3034	if $exit->slaying eq "/!"; # need to re-check after getting the lock
		3035
		3036	$map = $exit->slaying;
		3037
		3038	} elsif ($slaying eq '!up') {
		3039	$map = $exit->map->tile_path (cf::TILE_UP);
		3040	$x = $exit->x;
		3041	$y = $exit->y;
		3042
		3043	} elsif ($slaying eq '!down') {
		3044	$map = $exit->map->tile_path (cf::TILE_DOWN);
		3045	$x = $exit->x;
		3046	$y = $exit->y;
		3047	}
		3048
		3049	$self->goto ($map, $x, $y);
		3050
		3051	# if exit is damned, update players death & WoR home-position
		3052	$self->contr->savebed ($map, $x, $y)
		3053	if $exit->flag (cf::FLAG_DAMNED);
		3054
		3055	1
		3056	}) {
		3057	$self->message ("Something went wrong deep within the deliantra server. "
		3058	. "I'll try to bring you back to the map you were before. "
		3059	. "Please report this to the dungeon master!",
		3060	cf::NDI_UNIQUE | cf::NDI_RED);
		3061
		3062	error "ERROR in enter_exit: $@";
		3063	$self->leave_link;
		3064	}
		3065	})->prio (1);
		3066	}
		3067
834	=head3 cf::client	3068	=head3 cf::client
835		3069
836	=over 4	3070	=over 4
837		3071
838	=item $client->send_drawinfo ($text, $flags)	3072	=item $client->send_big_packet ($pkt)
839		3073
840	Sends a drawinfo packet to the client. Circumvents output buffering so	3074	Like C<send_packet>, but tries to compress large packets, and fragments
841	should not be used under normal circumstances.	3075	them as required.
842		3076
843	=cut	3077	=cut
844		3078
		3079	our $MAXFRAGSIZE = cf::MAXSOCKBUF - 64;
		3080
		3081	sub cf::client::send_big_packet {
		3082	my ($self, $pkt) = @_;
		3083
		3084	# try lzf for large packets
		3085	$pkt = "lzf " . Compress::LZF::compress $pkt
		3086	if 1024 <= length $pkt and $self->{can_lzf};
		3087
		3088	# split very large packets
		3089	if ($MAXFRAGSIZE < length $pkt and $self->{can_lzf}) {
		3090	$self->send_packet ("frag $_") for unpack "(a$MAXFRAGSIZE)*", $pkt;
		3091	$pkt = "frag";
		3092	}
		3093
		3094	$self->send_packet ($pkt);
		3095	}
		3096
		3097	=item $client->send_msg ($channel, $msg, $color, [extra...])
		3098
		3099	Send a msg packet to the client, formatting the msg for the client if
		3100	necessary. C<$type> should be a string identifying the type of the
		3101	message, with C<log> being the default. If C<$color> is negative, suppress
		3102	the message unless the client supports the msg packet.
		3103
		3104	=cut
		3105
		3106	# non-persistent channels (usually the info channel)
		3107	our %CHANNEL = (
		3108	"c/motd" => {
		3109	id => "infobox",
		3110	title => "MOTD",
		3111	reply => undef,
		3112	tooltip => "The message of the day",
		3113	},
		3114	"c/identify" => {
		3115	id => "infobox",
		3116	title => "Identify",
		3117	reply => undef,
		3118	tooltip => "Items recently identified",
		3119	},
		3120	"c/examine" => {
		3121	id => "infobox",
		3122	title => "Examine",
		3123	reply => undef,
		3124	tooltip => "Signs and other items you examined",
		3125	},
		3126	"c/shopinfo" => {
		3127	id => "infobox",
		3128	title => "Shop Info",
		3129	reply => undef,
		3130	tooltip => "What your bargaining skill tells you about the shop",
		3131	},
		3132	"c/book" => {
		3133	id => "infobox",
		3134	title => "Book",
		3135	reply => undef,
		3136	tooltip => "The contents of a note or book",
		3137	},
		3138	"c/lookat" => {
		3139	id => "infobox",
		3140	title => "Look",
		3141	reply => undef,
		3142	tooltip => "What you saw there",
		3143	},
		3144	"c/who" => {
		3145	id => "infobox",
		3146	title => "Players",
		3147	reply => undef,
		3148	tooltip => "Shows players who are currently online",
		3149	},
		3150	"c/body" => {
		3151	id => "infobox",
		3152	title => "Body Parts",
		3153	reply => undef,
		3154	tooltip => "Shows which body parts you posess and are available",
		3155	},
		3156	"c/statistics" => {
		3157	id => "infobox",
		3158	title => "Statistics",
		3159	reply => undef,
		3160	tooltip => "Shows your primary statistics",
		3161	},
		3162	"c/skills" => {
		3163	id => "infobox",
		3164	title => "Skills",
		3165	reply => undef,
		3166	tooltip => "Shows your experience per skill and item power",
		3167	},
		3168	"c/shopitems" => {
		3169	id => "infobox",
		3170	title => "Shop Items",
		3171	reply => undef,
		3172	tooltip => "Shows the items currently for sale in this shop",
		3173	},
		3174	"c/resistances" => {
		3175	id => "infobox",
		3176	title => "Resistances",
		3177	reply => undef,
		3178	tooltip => "Shows your resistances",
		3179	},
		3180	"c/pets" => {
		3181	id => "infobox",
		3182	title => "Pets",
		3183	reply => undef,
		3184	tooltip => "Shows information abotu your pets/a specific pet",
		3185	},
		3186	"c/perceiveself" => {
		3187	id => "infobox",
		3188	title => "Perceive Self",
		3189	reply => undef,
		3190	tooltip => "You gained detailed knowledge about yourself",
		3191	},
		3192	"c/uptime" => {
		3193	id => "infobox",
		3194	title => "Uptime",
		3195	reply => undef,
		3196	tooltip => "How long the server has been running since last restart",
		3197	},
		3198	"c/mapinfo" => {
		3199	id => "infobox",
		3200	title => "Map Info",
		3201	reply => undef,
		3202	tooltip => "Information related to the maps",
		3203	},
		3204	"c/party" => {
		3205	id => "party",
		3206	title => "Party",
		3207	reply => "gsay ",
		3208	tooltip => "Messages and chat related to your party",
		3209	},
		3210	"c/death" => {
		3211	id => "death",
		3212	title => "Death",
		3213	reply => undef,
		3214	tooltip => "Reason for and more info about your most recent death",
		3215	},
		3216	"c/fatal" => {
		3217	id => "fatal",
		3218	title => "Fatal Error",
		3219	reply => undef,
		3220	tooltip => "Reason for the server disconnect",
		3221	},
		3222	"c/say" => $SAY_CHANNEL,
		3223	"c/chat" => $CHAT_CHANNEL,
		3224	);
		3225
845	sub cf::client::send_drawinfo {	3226	sub cf::client::send_msg {
		3227	my ($self, $channel, $msg, $color, @extra) = @_;
		3228
		3229	$msg = $self->pl->expand_cfpod ($msg)
		3230	unless $color & cf::NDI_VERBATIM;
		3231
		3232	$color &= cf::NDI_CLIENT_MASK; # just in case...
		3233
		3234	# check predefined channels, for the benefit of C
		3235	if ($CHANNEL{$channel}) {
		3236	$channel = $CHANNEL{$channel};
		3237
		3238	$self->ext_msg (channel_info => $channel);
		3239	$channel = $channel->{id};
		3240
		3241	} elsif (ref $channel) {
		3242	# send meta info to client, if not yet sent
		3243	unless (exists $self->{channel}{$channel->{id}}) {
		3244	$self->{channel}{$channel->{id}} = $channel;
		3245	$self->ext_msg (channel_info => $channel);
		3246	}
		3247
		3248	$channel = $channel->{id};
		3249	}
		3250
		3251	return unless @extra || length $msg;
		3252
		3253	# default colour, mask it out
		3254	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		3255	if $color & cf::NDI_DEF;
		3256
		3257	my $pkt = "msg "
		3258	. $self->{json_coder}->encode (
		3259	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
		3260	);
		3261
		3262	$self->send_big_packet ($pkt);
		3263	}
		3264
		3265	=item $client->ext_msg ($type, @msg)
		3266
		3267	Sends an ext event to the client.
		3268
		3269	=cut
		3270
		3271	sub cf::client::ext_msg($$@) {
846	my ($self, $text, $flags) = @_;	3272	my ($self, $type, @msg) = @_;
847		3273
848	utf8::encode $text;	3274	$self->send_big_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
849	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
850	}	3275	}
851
852		3276
853	=item $success = $client->query ($flags, "text", \&cb)	3277	=item $success = $client->query ($flags, "text", \&cb)
854		3278
855	Queues a query to the client, calling the given callback with	3279	Queues a query to the client, calling the given callback with
856	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	3280	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
857	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	3281	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
858		3282
859	Queries can fail, so check the return code. Or don't, as queries will become	3283	Queries can fail, so check the return code. Or don't, as queries will
860	reliable at some point in the future.	3284	become reliable at some point in the future.
861		3285
862	=cut	3286	=cut
863		3287
864	sub cf::client::query {	3288	sub cf::client::query {
865	my ($self, $flags, $text, $cb) = @_;	3289	my ($self, $flags, $text, $cb) = @_;
…		…
873	utf8::encode $text;	3297	utf8::encode $text;
874	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	3298	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
875		3299
876	$self->send_packet ($self->{query_queue}[0][0])	3300	$self->send_packet ($self->{query_queue}[0][0])
877	if @{ $self->{query_queue} } == 1;	3301	if @{ $self->{query_queue} } == 1;
		3302
		3303	1
		3304	}
		3305
		3306	=item $client->update_command_faces
		3307
		3308	=cut
		3309
		3310	our %COMMAND_FACE;
		3311
		3312	sub cf::client::update_command_faces {
		3313	my ($self) = @_;
		3314
		3315	my @faces = grep $_,
		3316	$COMMAND_FACE{preferred},
		3317	$COMMAND_FACE{standard},
		3318	$COMMAND_FACE{skill},
		3319	$self->pl->ob->flag (cf::FLAG_WIZ) ? $COMMAND_FACE{dm} : (),
		3320	$COMMAND_FACE{emote},
		3321	;
		3322
		3323	$self->send_face ($_)
		3324	for @faces;
		3325	$self->flush_fx;
		3326
		3327	$self->ext_msg (command_list => @faces);
		3328	}
		3329
		3330	=item cf::client::set_command_face $type, $commands
		3331
		3332	=cut
		3333
		3334	sub cf::client::set_command_face {
		3335	my ($type, $list) = @_;
		3336
		3337	my $idx = &cf::face::set ( #d# ugly forward reference
		3338	"command_list/$type" => cf::FT_RSRC,
		3339	JSON::XS->new->utf8->encode ([ sort @$list ])
		3340	);
		3341
		3342	$COMMAND_FACE{$type} = $idx;
878	}	3343	}
879		3344
880	cf::client->attach (	3345	cf::client->attach (
		3346	on_connect => sub {
		3347	my ($ns) = @_;
		3348
		3349	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		3350	},
881	on_reply => sub {	3351	on_reply => sub {
882	my ($ns, $msg) = @_;	3352	my ($ns, $msg) = @_;
883		3353
884	# this weird shuffling is so that direct followup queries	3354	# this weird shuffling is so that direct followup queries
885	# get handled first	3355	# get handled first
886	my $queue = delete $ns->{query_queue};	3356	my $queue = delete $ns->{query_queue}
		3357	or return; # be conservative, not sure how that can happen, but we saw a crash here
887		3358
888	(shift @$queue)->[1]->($msg);	3359	(shift @$queue)->[1]->($msg);
		3360	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
889		3361
890	push @{ $ns->{query_queue} }, @$queue;	3362	push @{ $ns->{query_queue} }, @$queue;
891		3363
892	if (@{ $ns->{query_queue} } == @$queue) {	3364	if (@{ $ns->{query_queue} } == @$queue) {
893	if (@$queue) {	3365	if (@$queue) {
…		…
895	} else {	3367	} else {
896	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3368	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
897	}	3369	}
898	}	3370	}
899	},	3371	},
		3372	on_exticmd => sub {
		3373	my ($ns, $buf) = @_;
		3374
		3375	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		3376
		3377	if (ref $msg) {
		3378	my ($type, $reply, @payload) = @$msg; # version 1 used %type, $id, %$hash
		3379
		3380	if (my $cb = $EXTIACMD{$type}) {
		3381	$cb->(
		3382	$ns,
		3383	sub {
		3384	$ns->ext_msg ("reply-$reply", @_)
		3385	if $reply;
		3386	},
		3387	@payload
		3388	);
		3389	} else {
		3390	my @reply;
		3391
		3392	if (my $cb = $EXTICMD{$type}) {
		3393	@reply = $cb->($ns, @payload);
		3394	}
		3395
		3396	$ns->ext_msg ("reply-$reply", @reply)
		3397	if $reply;
		3398	}
		3399	} else {
		3400	error "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		3401	}
		3402
		3403	cf::override;
		3404	},
900	);	3405	);
901		3406
902	=item $client->coro (\&cb)	3407	=item $client->async (\&cb)
903		3408
904	Create a new coroutine, running the specified callback. The coroutine will	3409	Create a new coroutine, running the specified callback. The coroutine will
905	be automatically cancelled when the client gets destroyed (e.g. on logout,	3410	be automatically cancelled when the client gets destroyed (e.g. on logout,
906	or loss of connection).	3411	or loss of connection).
907		3412
908	=cut	3413	=cut
909		3414
910	sub cf::client::coro {	3415	sub cf::client::async {
911	my ($self, $cb) = @_;	3416	my ($self, $cb) = @_;
912		3417
913	my $coro; $coro = async {	3418	my $coro = &Coro::async ($cb);
914	eval {	3419
915	$cb->();	3420	$coro->on_destroy (sub {
916	};
917	warn $@ if $@;
918	delete $self->{_coro}{$coro+0};	3421	delete $self->{_coro}{$coro+0};
919	};	3422	});
920		3423
921	$self->{_coro}{$coro+0} = $coro;	3424	$self->{_coro}{$coro+0} = $coro;
		3425
		3426	$coro
922	}	3427	}
923		3428
924	cf::client->attach (	3429	cf::client->attach (
925	on_destroy => sub {	3430	on_client_destroy => sub {
926	my ($ns) = @_;	3431	my ($ns) = @_;
927		3432
928	$_->cancel for values %{ (delete $ns->{_coro}) || {} };	3433	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
929	},	3434	},
930	);	3435	);
…		…
945	our $safe = new Safe "safe";	3450	our $safe = new Safe "safe";
946	our $safe_hole = new Safe::Hole;	3451	our $safe_hole = new Safe::Hole;
947		3452
948	$SIG{FPE} = 'IGNORE';	3453	$SIG{FPE} = 'IGNORE';
949		3454
950	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3455	$safe->permit_only (Opcode::opset qw(
		3456	:base_core :base_mem :base_orig :base_math :base_loop
		3457	grepstart grepwhile mapstart mapwhile
		3458	sort time
		3459	));
951		3460
952	# here we export the classes and methods available to script code	3461	# here we export the classes and methods available to script code
953		3462
954	=pod	3463	=pod
955		3464
956	The following fucntions and emthods are available within a safe environment:	3465	The following functions and methods are available within a safe environment:
957		3466
958	cf::object contr pay_amount pay_player map	3467	cf::object
		3468	contr pay_amount pay_player map x y force_find force_add destroy
		3469	insert remove name archname title slaying race decrease split
		3470	value
		3471
959	cf::object::player player	3472	cf::object::player
960	cf::player peaceful	3473	player
961	cf::map trigger	3474
		3475	cf::player
		3476	peaceful
		3477
		3478	cf::map
		3479	trigger
962		3480
963	=cut	3481	=cut
964		3482
965	for (	3483	for (
966	["cf::object" => qw(contr pay_amount pay_player map)],	3484	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3485	insert remove inv nrof name archname title slaying race
		3486	decrease split destroy change_exp value msg lore send_msg)],
967	["cf::object::player" => qw(player)],	3487	["cf::object::player" => qw(player)],
968	["cf::player" => qw(peaceful)],	3488	["cf::player" => qw(peaceful send_msg)],
969	["cf::map" => qw(trigger)],	3489	["cf::map" => qw(trigger)],
970	) {	3490	) {
971	no strict 'refs';
972	my ($pkg, @funs) = @$_;	3491	my ($pkg, @funs) = @$_;
973	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3492	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
974	for @funs;	3493	for @funs;
975	}	3494	}
976		3495
…		…
991		3510
992	my $qcode = $code;	3511	my $qcode = $code;
993	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3512	$qcode =~ s/"/‟/g; # not allowed in #line filenames
994	$qcode =~ s/\n/\\n/g;	3513	$qcode =~ s/\n/\\n/g;
995		3514
		3515	%vars = (_dummy => 0) unless %vars;
		3516
		3517	my @res;
996	local $_;	3518	local $_;
997	local @safe::cf::_safe_eval_args = values %vars;
998		3519
999	my $eval =	3520	my $eval =
1000	"do {\n"	3521	"do {\n"
1001	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	3522	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
1002	. "#line 0 \"{$qcode}\"\n"	3523	. "#line 0 \"{$qcode}\"\n"
1003	. $code	3524	. $code
1004	. "\n}"	3525	. "\n}"
1005	;	3526	;
1006		3527
		3528	if ($CFG{safe_eval}) {
1007	sub_generation_inc;	3529	sub_generation_inc;
		3530	local @safe::cf::_safe_eval_args = values %vars;
1008	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);	3531	@res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
1009	sub_generation_inc;	3532	sub_generation_inc;
		3533	} else {
		3534	local @cf::_safe_eval_args = values %vars;
		3535	@res = wantarray ? eval eval : scalar eval $eval;
		3536	}
1010		3537
1011	if ($@) {	3538	if ($@) {
1012	warn "$@";	3539	warn "$@",
1013	warn "while executing safe code '$code'\n";	3540	"while executing safe code '$code'\n",
1014	warn "with arguments " . (join " ", %vars) . "\n";	3541	"with arguments " . (join " ", %vars) . "\n";
1015	}	3542	}
1016		3543
1017	wantarray ? @res : $res[0]	3544	wantarray ? @res : $res[0]
1018	}	3545	}
1019		3546
…		…
1033	=cut	3560	=cut
1034		3561
1035	sub register_script_function {	3562	sub register_script_function {
1036	my ($fun, $cb) = @_;	3563	my ($fun, $cb) = @_;
1037		3564
1038	no strict 'refs';	3565	$fun = "safe::$fun" if $CFG{safe_eval};
1039	*{"safe::$fun"} = $safe_hole->wrap ($cb);	3566	*$fun = $safe_hole->wrap ($cb);
1040	}	3567	}
1041		3568
1042	=back	3569	=back
1043		3570
1044	=cut	3571	=cut
1045		3572
1046	#############################################################################	3573	#############################################################################
1047		3574	# the server's init and main functions
1048	=head2 EXTENSION DATABASE SUPPORT
1049
1050	Crossfire maintains a very simple database for extension use. It can
1051	currently store anything that can be serialised using Storable, which
1052	excludes objects.
1053
1054	The parameter C<$family> should best start with the name of the extension
1055	using it, it should be unique.
1056
1057	=over 4
1058
1059	=item $hashref = cf::db_get $family
1060
1061	Return a hashref for use by the extension C<$family>, which can be
1062	modified. After modifications, you have to call C<cf::db_dirty> or
1063	C<cf::db_sync>.
1064
1065	=item $value = cf::db_get $family => $key
1066
1067	Returns a single value from the database
1068
1069	=item cf::db_put $family => $hashref
1070
1071	Stores the given family hashref into the database. Updates are delayed, if
1072	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1073
1074	=item cf::db_put $family => $key => $value
1075
1076	Stores the given C<$value> in the family hash. Updates are delayed, if you
1077	want the data to be synced to disk immediately, use C<cf::db_sync>.
1078
1079	=item cf::db_dirty
1080
1081	Marks the database as dirty, to be updated at a later time.
1082
1083	=item cf::db_sync
1084
1085	Immediately write the database to disk I<if it is dirty>.
1086
1087	=cut
1088
1089	our $DB;
1090		3575
1091	{	3576	{
1092	my $path = cf::localdir . "/database.pst";	3577	package cf::face;
1093		3578
1094	sub db_load() {	3579	our %HASH; # hash => idx
1095	warn "loading database $path\n";#d# remove later	3580	our @DATA; # dynamically-created facedata, only faceste 0 used
1096	$DB = stat $path ? Storable::retrieve $path : { };	3581	our @FOFS; # file offset, if > 0
1097	}	3582	our @SIZE; # size of face, in octets
		3583	our @META; # meta hash of face, if any
		3584	our $DATAFH; # facedata filehandle
1098		3585
1099	my $pid;	3586	# internal api, not finalised
		3587	sub set {
		3588	my ($name, $type, $data) = @_;
1100		3589
1101	sub db_save() {	3590	my $idx = cf::face::find $name;
1102	warn "saving database $path\n";#d# remove later
1103	waitpid $pid, 0 if $pid;
1104	if (0 == ($pid = fork)) {
1105	$DB->{_meta}{version} = 1;
1106	Storable::nstore $DB, "$path~";
1107	rename "$path~", $path;
1108	cf::_exit 0 if defined $pid;
1109	}
1110	}
1111		3591
1112	my $dirty;	3592	if ($idx) {
1113		3593	delete $HASH{cf::face::get_csum $idx};
1114	sub db_sync() {
1115	db_save if $dirty;
1116	undef $dirty;
1117	}
1118
1119	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1120	db_sync;
1121	});
1122
1123	sub db_dirty() {
1124	$dirty = 1;
1125	$idle->start;
1126	}
1127
1128	sub db_get($;$) {
1129	@_ >= 2
1130	? $DB->{$_[0]}{$_[1]}
1131	: ($DB->{$_[0]} ||= { })
1132	}
1133
1134	sub db_put($$;$) {
1135	if (@_ >= 3) {
1136	$DB->{$_[0]}{$_[1]} = $_[2];
1137	} else {	3594	} else {
1138	$DB->{$_[0]} = $_[1];	3595	$idx = cf::face::alloc $name;
1139	}
1140	db_dirty;
1141	}
1142
1143	cf::global->attach (
1144	prio => 10000,
1145	on_cleanup => sub {
1146	db_sync;
1147	},	3596	}
		3597
		3598	my $hash = cf::face::mangle_csum Digest::MD5::md5 $data;
		3599
		3600	cf::face::set_type $idx, $type;
		3601	cf::face::set_csum $idx, 0, $hash;
		3602
		3603	# we need to destroy the SV itself, not just modify it, as a running ix
		3604	# might hold a reference to it: "delete" achieves that.
		3605	delete $FOFS[0][$idx];
		3606	delete $DATA[0][$idx];
		3607	$DATA[0][$idx] = $data;
		3608	$SIZE[0][$idx] = length $data;
		3609	delete $META[$idx];
		3610	$HASH{$hash} = $idx;#d#
		3611
		3612	$idx
		3613	}
		3614
		3615	sub _get_data($$$) {
		3616	my ($idx, $set, $cb) = @_;
		3617
		3618	if (defined $DATA[$set][$idx]) {
		3619	$cb->($DATA[$set][$idx]);
		3620	} elsif (my $fofs = $FOFS[$set][$idx]) {
		3621	my $size = $SIZE[$set][$idx];
		3622	my $buf;
		3623	IO::AIO::aio_read $DATAFH, $fofs, $size, $buf, 0, sub {
		3624	if ($_[0] == $size) {
		3625	#cf::debug "read face $idx, $size from $fofs as ", length $buf;#d#
		3626	$cb->($buf);
		3627	} else {
		3628	cf::error "INTERNAL ERROR: unable to read facedata for face $idx#$set ($size, $fofs), ignoring request.";
		3629	}
		3630	};
		3631	} else {
		3632	cf::error "requested facedata for unknown face $idx#$set, ignoring.";
		3633	}
		3634	}
		3635
		3636	# rather ineffient
		3637	sub cf::face::get_data($;$) {
		3638	my ($idx, $set) = @_;
		3639
		3640	_get_data $idx, $set, Coro::rouse_cb;
		3641	Coro::rouse_wait
		3642	}
		3643
		3644	sub cf::face::ix {
		3645	my ($ns, $set, $idx, $pri) = @_;
		3646
		3647	_get_data $idx, $set, sub {
		3648	$ns->ix_send ($idx, $pri, $_[0]);
		3649	};
		3650	}
		3651	}
		3652
		3653	sub load_facedata($) {
		3654	my ($path) = @_;
		3655
		3656	my $enc = JSON::XS->new->utf8->canonical->relaxed;
		3657
		3658	trace "loading facedata from $path\n";
		3659
		3660	my $facedata = decode_storable load_file "$path/faceinfo";
		3661
		3662	$facedata->{version} == 2
		3663	or cf::cleanup "$path/faceinfo: version mismatch, cannot proceed.";
		3664
		3665	my $fh = aio_open "$DATADIR/facedata", IO::AIO::O_RDONLY, 0
		3666	or cf::cleanup "$path/facedata: $!, cannot proceed.";
		3667
		3668	get_slot 1, -100, "load_facedata"; # make sure we get a very big slot
		3669
		3670	# BEGIN ATOMIC
		3671	# from here on, everything must be atomic - no thread switch allowed
		3672	my $t1 = EV::time;
		3673
		3674	{
		3675	my $faces = $facedata->{faceinfo};
		3676
		3677	for my $face (sort keys %$faces) {
		3678	my $info = $faces->{$face};
		3679	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		3680
		3681	cf::face::set_visibility $idx, $info->{visibility};
		3682	cf::face::set_magicmap $idx, $info->{magicmap};
		3683	cf::face::set_csum $idx, 0, $info->{hash64}; $cf::face::SIZE[0][$idx] = $info->{size64}; $cf::face::FOFS[0][$idx] = $info->{fofs64};
		3684	cf::face::set_csum $idx, 1, $info->{hash32}; $cf::face::SIZE[1][$idx] = $info->{size32}; $cf::face::FOFS[1][$idx] = $info->{fofs32};
		3685	cf::face::set_csum $idx, 2, $info->{glyph}; $cf::face::DATA[2][$idx] = $info->{glyph};
		3686	$cf::face::HASH{$info->{hash64}} = $idx;
		3687	delete $cf::face::META[$idx];
		3688	}
		3689
		3690	while (my ($face, $info) = each %$faces) {
		3691	next unless $info->{smooth};
		3692
		3693	my $idx = cf::face::find $face
		3694	or next;
		3695
		3696	if (my $smooth = cf::face::find $info->{smooth}) {
		3697	cf::face::set_smooth $idx, $smooth;
		3698	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3699	} else {
		3700	error "smooth face '$info->{smooth}' not found for face '$face'";
		3701	}
		3702	}
		3703	}
		3704
		3705	{
		3706	my $anims = $facedata->{animinfo};
		3707
		3708	while (my ($anim, $info) = each %$anims) {
		3709	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3710	}
		3711
		3712	cf::anim::invalidate_all; # d'oh
		3713	}
		3714
		3715	{
		3716	my $res = $facedata->{resource};
		3717
		3718	while (my ($name, $info) = each %$res) {
		3719	if (defined (my $type = $info->{type})) {
		3720	# TODO: different hash - must free and use new index, or cache ixface data queue
		3721	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3722
		3723	cf::face::set_type $idx, $type;
		3724	cf::face::set_csum $idx, 0, $info->{hash};
		3725	$cf::face::SIZE[0][$idx] = $info->{size};
		3726	$cf::face::FOFS[0][$idx] = $info->{fofs};
		3727	$cf::face::META[$idx] = $type & 1 ? undef : $info->{meta}; # preserve meta unless prepended already
		3728	$cf::face::HASH{$info->{hash}} = $idx;
		3729	} else {
		3730	# $RESOURCE{$name} = $info; # unused
		3731	}
		3732	}
		3733	}
		3734
		3735	($fh, $cf::face::DATAFH) = ($cf::face::DATAFH, $fh);
		3736
		3737	# HACK to clear player env face cache, we need some signal framework
		3738	# for this (global event?)
		3739	%ext::player_env::MUSIC_FACE_CACHE = ();
		3740
		3741	# END ATOMIC
		3742
		3743	cf::debug "facedata atomic update time ", EV::time - $t1;
		3744
		3745	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3746
		3747	aio_close $fh if $fh; # close old facedata
		3748
		3749	1
		3750	}
		3751
		3752	register_exticmd fx_want => sub {
		3753	my ($ns, $want) = @_;
		3754
		3755	while (my ($k, $v) = each %$want) {
		3756	$ns->fx_want ($k, $v);
		3757	}
		3758	};
		3759
		3760	sub load_resource_file($) {
		3761	my $guard = lock_acquire "load_resource_file";
		3762
		3763	my $status = load_resource_file_ $_[0];
		3764	get_slot 0.1, 100;
		3765	cf::arch::commit_load;
		3766
		3767	$status
		3768	}
		3769
		3770	sub reload_exp_table {
		3771	_reload_exp_table;
		3772
		3773	cf::face::set
		3774	"res/exp_table" => FT_RSRC,
		3775	JSON::XS->new->utf8->canonical->encode (
		3776	[map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]
		3777	);
		3778	}
		3779
		3780	sub reload_materials {
		3781	_reload_materials;
		3782	}
		3783
		3784	sub reload_regions {
		3785	# HACK to clear player env face cache, we need some signal framework
		3786	# for this (global event?)
		3787	%ext::player_env::MUSIC_FACE_CACHE = ();
		3788
		3789	load_resource_file "$MAPDIR/regions"
		3790	or die "unable to load regions file\n";
		3791
		3792	for (cf::region::list) {
		3793	$_->{match} = qr/$_->{match}/
		3794	if exists $_->{match};
		3795	}
		3796	}
		3797
		3798	sub reload_facedata {
		3799	load_facedata $DATADIR
		3800	or die "unable to load facedata\n";
		3801	}
		3802
		3803	sub reload_archetypes {
		3804	load_resource_file "$DATADIR/archetypes"
		3805	or die "unable to load archetypes\n";
		3806
		3807	cf::face::set
		3808	"res/skill_info" => FT_RSRC,
		3809	JSON::XS->new->utf8->canonical->encode (
		3810	[map [cf::arch::skillvec ($_)->name], 0 .. cf::arch::skillvec_size - 1]
		3811	);
		3812
		3813	cf::face::set
		3814	"res/spell_paths" => FT_RSRC,
		3815	JSON::XS->new->utf8->canonical->encode (
		3816	[map [cf::spellpathnames ($_)], 0 .. NRSPELLPATHS - 1]
		3817	);
		3818
		3819	# command completion
		3820	my @commands;
		3821
		3822	for (0..cf::arch::skillvec_size - 1) {
		3823	my $skill = cf::arch::skillvec $_;
		3824	my $name = $skill->name;
		3825	my $flags = cf::skill_flags $skill->subtype;
		3826
		3827	push @commands, "ready_skill $name" if $flags & (SF_COMBAT | SF_RANGED | SF_GRACE);
		3828	push @commands, "use_skill $name" if $flags & (SF_USE | SF_AUTARK | SF_GRACE);
		3829	}
		3830
		3831	cf::client::set_command_face skill => \@commands;
		3832	}
		3833
		3834	sub reload_treasures {
		3835	load_resource_file "$DATADIR/treasures"
		3836	or die "unable to load treasurelists\n";
		3837	}
		3838
		3839	sub reload_sound {
		3840	trace "loading sound config from $DATADIR/sound\n";
		3841
		3842	my $soundconf = JSON::XS->new->utf8->relaxed->decode (load_file "$DATADIR/sound");
		3843
		3844	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3845	my $sound = $soundconf->{compat}[$_]
		3846	or next;
		3847
		3848	my $face = cf::face::find "sound/$sound->[1]";
		3849	cf::sound::set $sound->[0] => $face;
		3850	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3851	}
		3852
		3853	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3854	my $face = cf::face::find "sound/$v";
		3855	cf::sound::set $k => $face;
		3856	}
		3857	}
		3858
		3859	sub reload_resources {
		3860	trace "reloading resource files...\n";
		3861
		3862	reload_materials;
		3863	reload_facedata;
		3864	reload_exp_table;
		3865	reload_sound;
		3866	reload_archetypes;
		3867	reload_regions;
		3868	reload_treasures;
		3869
		3870	trace "finished reloading resource files\n";
		3871	}
		3872
		3873	sub reload_config {
		3874	trace "reloading config file...\n";
		3875
		3876	my $config = load_file "$CONFDIR/config";
		3877	utf8::decode $config;
		3878	*CFG = decode_yaml $config;
		3879
		3880	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
		3881
		3882	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		3883	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		3884
		3885	if (exists $CFG{mlockall}) {
		3886	eval {
		3887	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		3888	and die "WARNING: m(un)lockall failed: $!\n";
		3889	};
		3890	warn $@ if $@;
		3891	}
		3892	}
		3893
		3894	sub pidfile() {
		3895	sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
		3896	or die "$PIDFILE: $!";
		3897	flock $fh, &Fcntl::LOCK_EX
		3898	or die "$PIDFILE: flock: $!";
		3899	$fh
		3900	}
		3901
		3902	# make sure only one server instance is running at any one time
		3903	sub atomic {
		3904	my $fh = pidfile;
		3905
		3906	my $pid = <$fh>;
		3907	kill 9, $pid if $pid > 0;
		3908
		3909	seek $fh, 0, 0;
		3910	print $fh $$;
		3911	}
		3912
		3913	sub main_loop {
		3914	trace "EV::loop starting\n";
		3915	if (1) {
		3916	EV::loop;
		3917	}
		3918	trace "EV::loop returned\n";
		3919	goto &main_loop unless $REALLY_UNLOOP;
		3920	}
		3921
		3922	sub main {
		3923	cf::init_globals; # initialise logging
		3924
		3925	LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
		3926	LOG llevInfo, "Copyright (C) 2005-2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
		3927	LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
		3928	LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
		3929
		3930	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3931
		3932	# we must not ever block the main coroutine
		3933	$Coro::idle = sub {
		3934	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		3935	(async {
		3936	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3937	EV::loop EV::LOOP_ONESHOT;
		3938	})->prio (Coro::PRIO_MAX);
1148	);	3939	};
		3940
		3941	evthread_start IO::AIO::poll_fileno;
		3942
		3943	cf::sync_job {
		3944	cf::incloader::init ();
		3945
		3946	db_init;
		3947
		3948	cf::init_anim;
		3949	cf::init_attackmess;
		3950	cf::init_dynamic;
		3951
		3952	cf::load_settings;
		3953
		3954	reload_resources;
		3955	reload_config;
		3956
		3957	cf::init_uuid;
		3958	cf::init_signals;
		3959	cf::init_skills;
		3960
		3961	cf::init_beforeplay;
		3962
		3963	atomic;
		3964
		3965	load_extensions;
		3966
		3967	utime time, time, $RUNTIMEFILE;
		3968
		3969	# no (long-running) fork's whatsoever before this point(!)
		3970	use POSIX ();
		3971	POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
		3972
		3973	cf::_post_init 0;
		3974	};
		3975
		3976	cf::object::thawer::errors_are_fatal 0;
		3977	info "parse errors in files are no longer fatal from this point on.\n";
		3978
		3979	AE::postpone {
		3980	undef &main; # free gobs of memory :)
		3981	};
		3982
		3983	goto &main_loop;
1149	}	3984	}
1150		3985
1151	#############################################################################	3986	#############################################################################
1152	# the server's main()	3987	# initialisation and cleanup
1153		3988
1154	sub cfg_load {	3989	# install some emergency cleanup handlers
1155	open my $fh, "<:utf8", cf::confdir . "/config"	3990	BEGIN {
		3991	our %SIGWATCHER = ();
		3992	for my $signal (qw(INT HUP TERM)) {
		3993	$SIGWATCHER{$signal} = AE::signal $signal, sub {
		3994	cf::cleanup "SIG$signal";
		3995	};
		3996	}
		3997	}
		3998
		3999	sub write_runtime_sync {
		4000	my $t0 = AE::time;
		4001
		4002	# first touch the runtime file to show we are still running:
		4003	# the fsync below can take a very very long time.
		4004
		4005	IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
		4006
		4007	my $guard = cf::lock_acquire "write_runtime";
		4008
		4009	my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644
1156	or return;	4010	or return;
1157		4011
1158	local $/;	4012	my $value = $cf::RUNTIME + 90 + 10;
1159	*CFG = YAML::Syck::Load <$fh>;	4013	# 10 is the runtime save interval, for a monotonic clock
1160	}	4014	# 60 allows for the watchdog to kill the server.
1161		4015
1162	sub main {	4016	(aio_write $fh, 0, (length $value), $value, 0) <= 0
1163	cfg_load;	4017	and return;
1164	db_load;	4018
		4019	# always fsync - this file is important
		4020	aio_fsync $fh
		4021	and return;
		4022
		4023	# touch it again to show we are up-to-date
		4024	aio_utime $fh, undef, undef;
		4025
		4026	close $fh
		4027	or return;
		4028
		4029	aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
		4030	and return;
		4031
		4032	trace sprintf "runtime file written (%gs).\n", AE::time - $t0;
		4033
		4034	1
		4035	}
		4036
		4037	our $uuid_lock;
		4038	our $uuid_skip;
		4039
		4040	sub write_uuid_sync($) {
		4041	$uuid_skip ||= $_[0];
		4042
		4043	return if $uuid_lock;
		4044	local $uuid_lock = 1;
		4045
		4046	my $uuid = "$LOCALDIR/uuid";
		4047
		4048	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		4049	or return;
		4050
		4051	my $value = uuid_seq uuid_cur;
		4052
		4053	unless ($value) {
		4054	info "cowardly refusing to write zero uuid value!\n";
		4055	return;
		4056	}
		4057
		4058	my $value = uuid_str $value + $uuid_skip;
		4059	$uuid_skip = 0;
		4060
		4061	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		4062	and return;
		4063
		4064	# always fsync - this file is important
		4065	aio_fsync $fh
		4066	and return;
		4067
		4068	close $fh
		4069	or return;
		4070
		4071	aio_rename "$uuid~", $uuid
		4072	and return;
		4073
		4074	trace "uuid file written ($value).\n";
		4075
		4076	1
		4077
		4078	}
		4079
		4080	sub write_uuid($$) {
		4081	my ($skip, $sync) = @_;
		4082
		4083	$sync ? write_uuid_sync $skip
		4084	: async { write_uuid_sync $skip };
		4085	}
		4086
		4087	sub emergency_save() {
		4088	my $freeze_guard = cf::freeze_mainloop;
		4089
		4090	info "emergency_perl_save: enter\n";
		4091
		4092	# this is a trade-off: we want to be very quick here, so
		4093	# save all maps without fsync, and later call a global sync
		4094	# (which in turn might be very very slow)
		4095	local $USE_FSYNC = 0;
		4096
		4097	cf::sync_job {
		4098	cf::write_runtime_sync; # external watchdog should not bark
		4099
		4100	# use a peculiar iteration method to avoid tripping on perl
		4101	# refcount bugs in for. also avoids problems with players
		4102	# and maps saved/destroyed asynchronously.
		4103	info "emergency_perl_save: begin player save\n";
		4104	for my $login (keys %cf::PLAYER) {
		4105	my $pl = $cf::PLAYER{$login} or next;
		4106	$pl->valid or next;
		4107	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
		4108	$pl->save;
		4109	}
		4110	info "emergency_perl_save: end player save\n";
		4111
		4112	cf::write_runtime_sync; # external watchdog should not bark
		4113
		4114	info "emergency_perl_save: begin map save\n";
		4115	for my $path (keys %cf::MAP) {
		4116	my $map = $cf::MAP{$path} or next;
		4117	$map->valid or next;
		4118	$map->save;
		4119	}
		4120	info "emergency_perl_save: end map save\n";
		4121
		4122	cf::write_runtime_sync; # external watchdog should not bark
		4123
		4124	info "emergency_perl_save: begin database checkpoint\n";
		4125	BDB::db_env_txn_checkpoint $DB_ENV;
		4126	info "emergency_perl_save: end database checkpoint\n";
		4127
		4128	info "emergency_perl_save: begin write uuid\n";
		4129	write_uuid_sync 1;
		4130	info "emergency_perl_save: end write uuid\n";
		4131
		4132	cf::write_runtime_sync; # external watchdog should not bark
		4133
		4134	trace "emergency_perl_save: syncing database to disk";
		4135	BDB::db_env_txn_checkpoint $DB_ENV;
		4136
		4137	info "emergency_perl_save: starting sync\n";
		4138	IO::AIO::aio_sync sub {
		4139	info "emergency_perl_save: finished sync\n";
		4140	};
		4141
		4142	cf::write_runtime_sync; # external watchdog should not bark
		4143
		4144	trace "emergency_perl_save: flushing outstanding aio requests";
		4145	while (IO::AIO::nreqs || BDB::nreqs) {
		4146	Coro::AnyEvent::sleep 0.01; # let the sync_job do it's thing
		4147	}
		4148
		4149	cf::write_runtime_sync; # external watchdog should not bark
		4150	};
		4151
		4152	info "emergency_perl_save: leave\n";
		4153	}
		4154
		4155	sub post_cleanup {
		4156	my ($make_core) = @_;
		4157
		4158	IO::AIO::flush;
		4159
		4160	error Carp::longmess "post_cleanup backtrace"
		4161	if $make_core;
		4162
		4163	my $fh = pidfile;
		4164	unlink $PIDFILE if <$fh> == $$;
		4165	}
		4166
		4167	# a safer delete_package, copied from Symbol
		4168	sub clear_package($) {
		4169	my $pkg = shift;
		4170
		4171	# expand to full symbol table name if needed
		4172	unless ($pkg =~ /^main::.*::$/) {
		4173	$pkg = "main$pkg" if $pkg =~ /^::/;
		4174	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		4175	$pkg .= '::' unless $pkg =~ /::$/;
		4176	}
		4177
		4178	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		4179	my $stem_symtab = *{$stem}{HASH};
		4180
		4181	defined $stem_symtab and exists $stem_symtab->{$leaf}
		4182	or return;
		4183
		4184	# clear all symbols
		4185	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		4186	for my $name (keys %$leaf_symtab) {
		4187	_gv_clear *{"$pkg$name"};
		4188	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		4189	}
		4190	}
		4191
		4192	sub do_reload_perl() {
		4193	# can/must only be called in main
		4194	unless (in_main) {
		4195	error "can only reload from main coroutine";
		4196	return;
		4197	}
		4198
		4199	return if $RELOAD++;
		4200
		4201	my $t1 = AE::time;
		4202
		4203	while ($RELOAD) {
		4204	cf::get_slot 0.1, -1, "reload_perl";
		4205	info "perl_reload: reloading...";
		4206
		4207	trace "perl_reload: entering sync_job";
		4208
		4209	cf::sync_job {
		4210	#cf::emergency_save;
		4211
		4212	trace "perl_reload: cancelling all extension coros";
		4213	$_->cancel for values %EXT_CORO;
		4214	%EXT_CORO = ();
		4215
		4216	trace "perl_reload: removing commands";
		4217	%COMMAND = ();
		4218
		4219	trace "perl_reload: removing ext/exti commands";
		4220	%EXTCMD = ();
		4221	%EXTICMD = ();
		4222
		4223	trace "perl_reload: unloading/nuking all extensions";
		4224	for my $pkg (@EXTS) {
		4225	trace "... unloading $pkg";
		4226
		4227	if (my $cb = $pkg->can ("unload")) {
		4228	eval {
		4229	$cb->($pkg);
		4230	1
		4231	} or error "$pkg unloaded, but with errors: $@";
		4232	}
		4233
		4234	trace "... clearing $pkg";
		4235	clear_package $pkg;
		4236	}
		4237
		4238	trace "perl_reload: unloading all perl modules loaded from $LIBDIR";
		4239	while (my ($k, $v) = each %INC) {
		4240	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		4241
		4242	trace "... unloading $k";
		4243	delete $INC{$k};
		4244
		4245	$k =~ s/\.pm$//;
		4246	$k =~ s/\//::/g;
		4247
		4248	if (my $cb = $k->can ("unload_module")) {
		4249	$cb->();
		4250	}
		4251
		4252	clear_package $k;
		4253	}
		4254
		4255	trace "perl_reload: getting rid of safe::, as good as possible";
		4256	clear_package "safe::$_"
		4257	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
		4258
		4259	trace "perl_reload: unloading cf.pm \"a bit\"";
		4260	delete $INC{"cf.pm"};
		4261	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
		4262
		4263	# don't, removes xs symbols, too,
		4264	# and global variables created in xs
		4265	#clear_package __PACKAGE__;
		4266
		4267	info "perl_reload: unload completed, starting to reload now";
		4268
		4269	trace "perl_reload: reloading cf.pm";
		4270	require cf;
		4271	cf::_connect_to_perl_1;
		4272
		4273	trace "perl_reload: loading config and database again";
		4274	cf::reload_config;
		4275
		4276	trace "perl_reload: loading extensions";
1165	load_extensions;	4277	cf::load_extensions;
1166	Event::loop;	4278
		4279	if ($REATTACH_ON_RELOAD) {
		4280	trace "perl_reload: reattaching attachments to objects/players";
		4281	_global_reattach; # objects, sockets
		4282	trace "perl_reload: reattaching attachments to maps";
		4283	reattach $_ for values %MAP;
		4284	trace "perl_reload: reattaching attachments to players";
		4285	reattach $_ for values %PLAYER;
		4286	}
		4287
		4288	cf::_post_init 1;
		4289
		4290	trace "perl_reload: leaving sync_job";
		4291
		4292	1
		4293	} or do {
		4294	error $@;
		4295	cf::cleanup "perl_reload: error, exiting.";
		4296	};
		4297
		4298	--$RELOAD;
		4299	}
		4300
		4301	$t1 = AE::time - $t1;
		4302	info "perl_reload: completed in ${t1}s\n";
		4303	};
		4304
		4305	our $RELOAD_WATCHER; # used only during reload
		4306
		4307	sub reload_perl() {
		4308	# doing reload synchronously and two reloads happen back-to-back,
		4309	# coro crashes during coro_state_free->destroy here.
		4310
		4311	$RELOAD_WATCHER ||= cf::async {
		4312	Coro::AIO::aio_wait cache_extensions;
		4313
		4314	$RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub {
		4315	do_reload_perl;
		4316	undef $RELOAD_WATCHER;
		4317	};
		4318	};
1167	}	4319	}
		4320
		4321	register_command "reload" => sub {
		4322	my ($who, $arg) = @_;
		4323
		4324	if ($who->flag (FLAG_WIZ)) {
		4325	$who->message ("reloading server.");
		4326	async {
		4327	$Coro::current->{desc} = "perl_reload";
		4328	reload_perl;
		4329	};
		4330	}
		4331	};
1168		4332
1169	#############################################################################	4333	#############################################################################
1170	# initialisation
1171		4334
1172	sub _perl_reload(&) {	4335	my $bug_warning = 0;
1173	my ($msg) = @_;
1174		4336
1175	$msg->("reloading...");	4337	sub wait_for_tick() {
		4338	return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
1176		4339
1177	eval {	4340	$WAIT_FOR_TICK->wait;
1178	# cancel all watchers	4341	}
1179	for (Event::all_watchers) {	4342
1180	$_->cancel if $_->data & WF_AUTOCANCEL;	4343	sub wait_for_tick_begin() {
		4344	return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
		4345
		4346	my $signal = new Coro::Signal;
		4347	push @WAIT_FOR_TICK_BEGIN, $signal;
		4348	$signal->wait;
		4349	}
		4350
		4351	sub tick {
		4352	if ($Coro::current != $Coro::main) {
		4353	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		4354	unless ++$bug_warning > 10;
		4355	return;
		4356	}
		4357
		4358	cf::one_tick; # one server iteration
		4359
		4360	#for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
		4361
		4362	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		4363	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
		4364	Coro::async_pool {
		4365	$Coro::current->{desc} = "runtime saver";
		4366	write_runtime_sync
		4367	or error "ERROR: unable to write runtime file: $!";
1181	}	4368	};
		4369	}
1182		4370
1183	# unload all extensions	4371	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
1184	for (@exts) {	4372	$sig->send;
1185	$msg->("unloading <$_>");	4373	}
1186	unload_extension $_;	4374	$WAIT_FOR_TICK->broadcast;
1187	}
1188		4375
1189	# unload all modules loaded from $LIBDIR	4376	$LOAD = ($NOW - $TICK_START) / $TICK;
1190	while (my ($k, $v) = each %INC) {	4377	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
1191	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1192		4378
1193	$msg->("removing <$k>");	4379	if (0) {
1194	delete $INC{$k};	4380	if ($NEXT_TICK) {
		4381	my $jitter = $TICK_START - $NEXT_TICK;
		4382	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		4383	debug "jitter $JITTER\n";#d#
		4384	}
		4385	}
		4386	}
1195		4387
1196	$k =~ s/\.pm$//;	4388	{
1197	$k =~ s/\//::/g;	4389	# configure BDB
		4390	info "initialising database";
1198		4391
1199	if (my $cb = $k->can ("unload_module")) {	4392	BDB::min_parallel 16;
1200	$cb->();	4393	BDB::max_poll_reqs $TICK * 0.1;
		4394	#$AnyEvent::BDB::WATCHER->priority (1);
		4395
		4396	unless ($DB_ENV) {
		4397	$DB_ENV = BDB::db_env_create;
		4398	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		4399	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		4400	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		4401	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		4402	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		4403
		4404	cf::sync_job {
		4405	eval {
		4406	BDB::db_env_open
		4407	$DB_ENV,
		4408	$BDBDIR,
		4409	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		4410	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		4411	0666;
		4412
		4413	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
1201	}	4414	};
1202		4415
1203	Symbol::delete_package $k;	4416	cf::cleanup "db_env_open(db): $@" if $@;
1204	}	4417	};
		4418	}
1205		4419
1206	# sync database to disk	4420	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
1207	cf::db_sync;	4421	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
1208
1209	# get rid of safe::, as good as possible
1210	Symbol::delete_package "safe::$_"
1211	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
1212
1213	# remove register_script_function callbacks
1214	# TODO
1215
1216	# unload cf.pm "a bit"
1217	delete $INC{"cf.pm"};
1218
1219	# don't, removes xs symbols, too,
1220	# and global variables created in xs
1221	#Symbol::delete_package __PACKAGE__;
1222
1223	# reload cf.pm
1224	$msg->("reloading cf.pm");
1225	require cf;
1226	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1227
1228
1229	# load config and database again
1230	cf::cfg_load;
1231	cf::db_load;
1232
1233	# load extensions
1234	$msg->("load extensions");
1235	cf::load_extensions;
1236
1237	# reattach attachments to objects
1238	$msg->("reattach");
1239	_global_reattach;
1240	};	4422	};
1241	$msg->($@) if $@;	4423	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
1242		4424	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
1243	$msg->("reloaded");
1244	};
1245
1246	sub perl_reload() {
1247	_perl_reload {
1248	warn $_[0];
1249	print "$_[0]\n";
1250	};	4425	};
1251	}	4426	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		4427	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		4428	};
1252		4429
1253	register "<global>", __PACKAGE__;	4430	info "database initialised";
		4431	}
1254		4432
1255	register_command "perl-reload" => sub {	4433	{
		4434	# configure IO::AIO
		4435
		4436	info "initialising aio";
		4437	IO::AIO::min_parallel 8;
		4438	IO::AIO::max_poll_time $TICK * 0.1;
		4439	undef $AnyEvent::AIO::WATCHER;
		4440	info "aio initialised";
		4441	}
		4442
		4443	our $_log_backtrace;
		4444	our $_log_backtrace_last;
		4445
		4446	sub _log_backtrace {
1256	my ($who, $arg) = @_;	4447	my ($msg, @addr) = @_;
1257		4448
1258	if ($who->flag (FLAG_WIZ)) {	4449	$msg =~ s/\n$//;
1259	_perl_reload {	4450
1260	warn $_[0];	4451	if ($_log_backtrace_last eq $msg) {
1261	$who->message ($_[0]);	4452	LOG llevInfo, "[ABT] $msg\n";
		4453	LOG llevInfo, "[ABT] [duplicate, suppressed]\n";
		4454	# limit the # of concurrent backtraces
		4455	} elsif ($_log_backtrace < 2) {
		4456	$_log_backtrace_last = $msg;
		4457	++$_log_backtrace;
		4458	my $perl_bt = Carp::longmess $msg;
		4459	async {
		4460	$Coro::current->{desc} = "abt $msg";
		4461
		4462	my @bt = fork_call {
		4463	@addr = map { sprintf "%x", $_ } @addr;
		4464	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		4465	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		4466	or die "addr2line: $!";
		4467
		4468	my @funcs;
		4469	my @res = <$fh>;
		4470	chomp for @res;
		4471	while (@res) {
		4472	my ($func, $line) = splice @res, 0, 2, ();
		4473	push @funcs, "[$func] $line";
		4474	}
		4475
		4476	@funcs
		4477	};
		4478
		4479	LOG llevInfo, "[ABT] $perl_bt\n";
		4480	LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
		4481	LOG llevInfo, "[ABT] $_\n" for @bt;
		4482	--$_log_backtrace;
1262	};	4483	};
1263	}	4484	} else {
1264	};	4485	LOG llevInfo, "[ABT] $msg\n";
1265		4486	LOG llevInfo, "[ABT] [overload, suppressed]\n";
1266	unshift @INC, $LIBDIR;
1267
1268	$TICK_WATCHER = Event->timer (
1269	prio => 0,
1270	at => $NEXT_TICK || 1,
1271	data => WF_AUTOCANCEL,
1272	cb => sub {
1273	cf::server_tick; # one server iteration
1274
1275	my $NOW = Event::time;
1276	$NEXT_TICK += $TICK;
1277
1278	# if we are delayed by four ticks or more, skip them all
1279	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1280
1281	$TICK_WATCHER->at ($NEXT_TICK);
1282	$TICK_WATCHER->start;
1283	},	4487	}
1284	);	4488	}
1285		4489
1286	IO::AIO::max_poll_time $TICK * 0.2;	4490	# load additional modules
		4491	require "cf/$_.pm" for @EXTRA_MODULES;
		4492	cf::_connect_to_perl_2;
1287		4493
1288	Event->io (fd => IO::AIO::poll_fileno,	4494	END { cf::emergency_save }
1289	poll => 'r',
1290	prio => 5,
1291	data => WF_AUTOCANCEL,
1292	cb => \&IO::AIO::poll_cb);
1293		4495
1294	1	4496	1
1295		4497

Diff Legend

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