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.41 by root, Fri Aug 25 15:25:12 2006 UTC vs.
Revision 1.613 by root, Mon Nov 26 13: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;
		24
		25	use common::sense;
2		26
3	use Symbol;	27	use Symbol;
4	use List::Util;	28	use List::Util;
5	use Storable;	29	use Socket;
		30	use EV;
6	use Opcode;	31	use Opcode;
7	use Safe;	32	use Safe;
8	use Safe::Hole;	33	use Safe::Hole;
		34	use Storable ();
		35	use Carp ();
9		36
10	use Time::HiRes;
11	use Event;	37	use AnyEvent ();
12	$Event::Eval = 1; # no idea why this is required, but it is	38	use AnyEvent::IO ();
		39	use AnyEvent::DNS ();
13		40
14	use strict;	41	use Coro ();
		42	use Coro::State;
		43	use Coro::Handle;
		44	use Coro::EV;
		45	use Coro::AnyEvent;
		46	use Coro::Timer;
		47	use Coro::Signal;
		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 ();
15		55
		56	use Guard ();
		57	use JSON::XS 2.01 ();
		58	use BDB ();
		59	use Data::Dumper;
		60	use Fcntl;
		61	use YAML::XS ();
		62	use IO::AIO ();
		63	use Compress::LZF;
		64	use Digest::MD5 ();
		65
		66	AnyEvent::detect;
		67
		68	# configure various modules to our taste
		69	#
		70	$Storable::canonical = 1; # reduce rsync transfers
		71	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		72
		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" };
		81
		82	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		83
		84	our @ORIG_INC;
		85
16	our %COMMAND = ();	86	our %COMMAND = ();
		87	our %COMMAND_TIME = ();
		88
		89	our @EXTS = (); # list of extension package names
		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
		96
		97	our $RELOAD; # number of reloads so far, non-zero while in reload
17	our @EVENT;	98	our @EVENT;
18	our @PLUGIN_EVENT;	99	our @REFLECT; # set by XS
19	our %PROP_TYPE;	100	our %REFLECT; # set by us
20	our %PROP_IDX;
21	our $LIBDIR = maps_directory "perl";
22		101
23	our $TICK = MAX_TIME * 1e-6;	102	our $CONFDIR = confdir;
24	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
25	our $NEXT_TICK;	128	our $NEXT_TICK;
		129	our $USE_FSYNC = 1; # use fsync to write maps - default on
26		130
27	BEGIN {	131	our $BDB_DEADLOCK_WATCHER;
28	@PLUGIN_EVENT = map lc, @PLUGIN_EVENT;	132	our $BDB_CHECKPOINT_WATCHER;
		133	our $BDB_TRICKLE_WATCHER;
		134	our $DB_ENV;
29		135
30	*CORE::GLOBAL::warn = sub {	136	our @EXTRA_MODULES = qw(pod match mapscript incloader);
		137
		138	our %CFG;
		139	our %EXT_CFG; # cfgkeyname => [var-ref, defaultvalue]
		140
		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	}
		188
		189	#############################################################################
		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
		202	=head2 GLOBAL VARIABLES
		203
		204	=over 4
		205
		206	=item $cf::UPTIME
		207
		208	The timestamp of the server start (so not actually an "uptime").
		209
		210	=item $cf::SERVER_TICK
		211
		212	An unsigned integer that starts at zero when the server is started and is
		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.
		220
		221	=item $cf::TICK
		222
		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.
		248
		249	=item %cf::CFG
		250
		251	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
		252	from wherever your confdir points to.
		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
		290	=back
		291
		292	=cut
		293
		294	sub error(@) { LOG llevError, join "", @_ }
		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 {
31	my $msg = join "", @_;	301	my $msg = join "", @_;
		302
32	$msg .= "\n"	303	$msg .= "\n"
33	unless $msg =~ /\n$/;	304	unless $msg =~ /\n$/;
34		305
35	print STDERR "cfperl: $msg";	306	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
36	LOG llevError, "cfperl: $msg";
37	};
38	}
39		307
40	my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!	308	LOG llevWarn, $msg;
		309	};
41		310
42	# generate property mutators	311	$Coro::State::DIEHOOK = sub {
43	sub prop_gen {	312	return unless $^S eq 0; # "eq", not "=="
44	my ($prefix, $class) = @_;
45		313
46	no strict 'refs';	314	error Carp::longmess $_[0];
47		315
48	for my $prop (keys %PROP_TYPE) {	316	if (in_main) {#d#
49	$prop =~ /^\Q$prefix\E_(.*$)/ or next;	317	error "DIEHOOK called in main context, Coro bug?\n";#d#
50	my $sub = lc $1;	318	return;#d#
		319	}#d#
51		320
52	my $type = $PROP_TYPE{$prop};	321	# kill coroutine otherwise
53	my $idx = $PROP_IDX {$prop};	322	Coro::terminate
		323	};
54		324
55	*{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {	325	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
56	$_[0]->get_property ($type, $idx)	326	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
57	};	327	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
58		328	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
59	*{"$class\::set_$sub"} = sub {	329	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
60	$_[0]->set_property ($type, $idx, $_[1]);	330	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
61	} unless $ignore_set{$prop};
62	}
63	}
64
65	# auto-generate most of the API
66
67	prop_gen OBJECT_PROP => "cf::object";
68	# CFAPI_OBJECT_ANIMATION?
69	prop_gen PLAYER_PROP => "cf::object::player";
70
71	prop_gen MAP_PROP => "cf::map";
72	prop_gen ARCH_PROP => "cf::arch";
73
74	# guessed hierarchies
75
76	@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)
77	@safe::cf::object::map::ISA = @cf::object::map::ISA = 'cf::object';
78		332
79	# 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
80	# within the Safe compartment.	334	# within the Safe compartment.
81	for my $pkg (qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region cf::arch)) {	335	for my $pkg (qw(
82	no strict 'refs';	336	cf::global cf::attachable
		337	cf::object cf::object::player
		338	cf::client cf::player
		339	cf::arch cf::living
		340	cf::map cf::mapspace
		341	cf::party cf::region
		342	)) {
83	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	343	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
84	}	344	}
85		345
86	$Event::DIED = sub {	346	$EV::DIED = sub {
87	warn "error in event callback: @_";	347	warn "error in event callback: $@";
88	};	348	};
89		349
90	my %ext_pkg;
91	my @exts;
92	my @hook;
93	my %command;
94	my %extcmd;
95
96	#############################################################################	350	#############################################################################
97	# "new" plug-in system
98		351
99	=item cf::object::attach ... # NYI	352	sub fork_call(&@);
		353	sub get_slot($;$$);
100		354
101	=item cf::attach_global ...	355	#############################################################################
102		356
103	=item cf::attach_to_type ...	357	=head2 UTILITY FUNCTIONS
104		358
105	=item cf::attach_to_objects ...	359	=over 4
106		360
107	=item cf::attach_to_players ...	361	=item dumpval $ref
108		362
109	=item cf::attach_to_maps ...	363	=cut
110		364
111	prio => $number, # lower is earlier	365	sub dumpval {
112	on_xxx => \&cb,	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
		436	=item $ref = cf::decode_json $json
		437
		438	Converts a JSON string into the corresponding perl data structure.
		439
		440	=item $json = cf::encode_json $ref
		441
		442	Converts a perl data structure into its JSON representation.
		443
		444	=cut
		445
		446	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
		447
		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 });
		927	}
		928
		929	=back
		930
		931	=cut
		932
		933	#############################################################################
		934
		935	=head2 ATTACHABLE OBJECTS
		936
		937	Many objects in deliantra are so-called attachable objects. That means you can
		938	attach callbacks/event handlers (a collection of which is called an "attachment")
		939	to it. All such attachable objects support the following methods.
		940
		941	In the following description, CLASS can be any of C<global>, C<object>
		942	C<player>, C<client> or C<map> (i.e. the attachable objects in
		943	Deliantra).
		944
		945	=over 4
		946
		947	=item $attachable->attach ($attachment, key => $value...)
		948
		949	=item $attachable->detach ($attachment)
		950
		951	Attach/detach a pre-registered attachment to a specific object and give it
		952	the specified key/value pairs as arguments.
		953
		954	Example, attach a minesweeper attachment to the given object, making it a
		955	10x10 minesweeper game:
		956
		957	$obj->attach (minesweeper => width => 10, height => 10);
		958
		959	=item $bool = $attachable->attached ($name)
		960
		961	Checks wether the named attachment is currently attached to the object.
		962
		963	=item cf::CLASS->attach ...
		964
		965	=item cf::CLASS->detach ...
		966
		967	Define an anonymous attachment and attach it to all objects of the given
		968	CLASS. See the next function for an explanation of its arguments.
		969
		970	You can attach to global events by using the C<cf::global> class.
		971
		972	Example, log all player logins:
		973
		974	cf::player->attach (
		975	on_login => sub {
		976	my ($pl) = @_;
		977	...
		978	},
		979	);
		980
		981	Example, attach to the jeweler skill:
		982
		983	cf::object->attach (
		984	type => cf::SKILL,
		985	subtype => cf::SK_JEWELER,
		986	on_use_skill => sub {
		987	my ($sk, $ob, $part, $dir, $msg) = @_;
		988	...
		989	},
		990	);
		991
		992	=item cf::CLASS::attachment $name, ...
		993
		994	Register an attachment by C<$name> through which attachable objects of the
		995	given CLASS can refer to this attachment.
		996
		997	Some classes such as deliantra maps and objects can specify attachments
		998	that are attached at load/instantiate time, thus the need for a name.
		999
		1000	These calls expect any number of the following handler/hook descriptions:
		1001
		1002	=over 4
		1003
		1004	=item prio => $number
		1005
		1006	Set the priority for all following handlers/hooks (unless overwritten
		1007	by another C<prio> setting). Lower priority handlers get executed
		1008	earlier. The default priority is C<0>, and many built-in handlers are
		1009	registered at priority C<-1000>, so lower priorities should not be used
		1010	unless you know what you are doing.
		1011
		1012	=item type => $type
		1013
		1014	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		1015	given type of objects only (the additional parameter C<subtype> can be
		1016	used to further limit to the given subtype).
		1017
		1018	=item on_I<event> => \&cb
		1019
		1020	Call the given code reference whenever the named event happens (event is
		1021	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
		1022	handlers are recognised generally depends on the type of object these
		1023	handlers attach to).
		1024
		1025	See F<include/eventinc.h> for the full list of events supported, and their
		1026	class.
		1027
113	package => package::,	1028	=item package => package::
		1029
		1030	Look for sub functions of the name C<< on_I<event> >> in the given
		1031	package and register them. Only handlers for eevents supported by the
		1032	object/class are recognised.
		1033
		1034	=back
		1035
		1036	Example, define an attachment called "sockpuppet" that calls the given
		1037	event handler when a monster attacks:
		1038
		1039	cf::object::attachment sockpuppet =>
		1040	on_skill_attack => sub {
		1041	my ($self, $victim) = @_;
		1042	...
		1043	}
		1044	}
		1045
		1046	=item $attachable->valid
		1047
		1048	Just because you have a perl object does not mean that the corresponding
		1049	C-level object still exists. If you try to access an object that has no
		1050	valid C counterpart anymore you get an exception at runtime. This method
		1051	can be used to test for existence of the C object part without causing an
		1052	exception.
114		1053
115	=cut	1054	=cut
116		1055
117	# the following variables are defined in .xs and must not be re-created	1056	# the following variables are defined in .xs and must not be re-created
118	our @CB_GLOBAL = (); # registry for all global events	1057	our @CB_GLOBAL = (); # registry for all global events
119	our @CB_OBJECT = ();	1058	our @CB_ATTACHABLE = (); # registry for all attachables
		1059	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
120	our @CB_PLAYER = ();	1060	our @CB_PLAYER = ();
		1061	our @CB_CLIENT = ();
121	our @CB_TYPE = (); # registry for type (cf-object class) based events	1062	our @CB_TYPE = (); # registry for type (cf-object class) based events
122	our @CB_MAP = ();	1063	our @CB_MAP = ();
123		1064
		1065	my %attachment;
		1066
		1067	sub cf::attachable::thawer_merge {
		1068	# simply override everything except _meta
		1069	local $_[0]{_meta};
		1070	%{$_[0]} = %{$_[1]};
		1071	}
		1072
124	sub _attach_cb($\%$$$) {	1073	sub _attach_cb($$$$) {
125	my ($registry, $undo, $event, $prio, $cb) = @_;	1074	my ($registry, $event, $prio, $cb) = @_;
126		1075
127	use sort 'stable';	1076	use sort 'stable';
128		1077
129	$cb = [$prio, $cb];	1078	$cb = [$prio, $cb];
130		1079
131	@{$registry->[$event]} = sort	1080	@{$registry->[$event]} = sort
132	{ $a->[0] cmp $b->[0] }	1081	{ $a->[0] cmp $b->[0] }
133	@{$registry->[$event] || []}, $cb;	1082	@{$registry->[$event] || []}, $cb;
134
135	push @{$undo->{cb}}, [$event, $cb];
136	}	1083	}
		1084
		1085	# hack
		1086	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
137		1087
138	# attach handles attaching event callbacks	1088	# attach handles attaching event callbacks
139	# the only thing the caller has to do is pass the correct	1089	# the only thing the caller has to do is pass the correct
140	# registry (== where the callback attaches to).	1090	# registry (== where the callback attaches to).
141	sub _attach(\@$\@) {	1091	sub _attach {
142	my ($registry, $klass, $arg) = @_;	1092	my ($registry, $klass, @arg) = @_;
143		1093
		1094	my $object_type;
144	my $prio = 0;	1095	my $prio = 0;
145
146	my %undo = (
147	registry => $registry,
148	cb => [],
149	);
150
151	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;	1096	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
152		1097
		1098	#TODO: get rid of this hack
		1099	if ($attachable_klass{$klass}) {
		1100	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		1101	}
		1102
153	while (@$arg) {	1103	while (@arg) {
154	my $type = shift @$arg;	1104	my $type = shift @arg;
155		1105
156	if ($type eq "prio") {	1106	if ($type eq "prio") {
157	$prio = shift @$arg;	1107	$prio = shift @arg;
		1108
		1109	} elsif ($type eq "type") {
		1110	$object_type = shift @arg;
		1111	$registry = $CB_TYPE[$object_type] ||= [];
		1112
		1113	} elsif ($type eq "subtype") {
		1114	defined $object_type or Carp::croak "subtype specified without type";
		1115	my $object_subtype = shift @arg;
		1116	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
158		1117
159	} elsif ($type eq "package") {	1118	} elsif ($type eq "package") {
160	my $pkg = shift @$arg;	1119	my $pkg = shift @arg;
161		1120
162	while (my ($name, $id) = each %cb_id) {	1121	while (my ($name, $id) = each %cb_id) {
163	if (my $cb = $pkg->can ($name)) {	1122	if (my $cb = $pkg->can ($name)) {
164	_attach_cb $registry, %undo, $id, $prio, $cb;	1123	_attach_cb $registry, $id, $prio, $cb;
165	}	1124	}
166	}	1125	}
167		1126
168	} elsif (exists $cb_id{$type}) {	1127	} elsif (exists $cb_id{$type}) {
169	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @$arg;	1128	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
170		1129
171	} elsif (ref $type) {	1130	} elsif (ref $type) {
172	warn "attaching objects not supported, ignoring.\n";	1131	error "attaching objects not supported, ignoring.\n";
173		1132
174	} else {	1133	} else {
175	shift @$arg;	1134	shift @arg;
176	warn "attach argument '$type' not supported, ignoring.\n";	1135	error "attach argument '$type' not supported, ignoring.\n";
177	}	1136	}
178	}	1137	}
179
180	\%undo
181	}	1138	}
182		1139
183	sub cf::object::attach {	1140	sub _object_attach {
184	die;	1141	my ($obj, $name, %arg) = @_;
185	}
186		1142
187	sub attach_global {	1143	return if exists $obj->{_attachment}{$name};
188	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
189	}
190		1144
191	sub attach_to_type {	1145	if (my $attach = $attachment{$name}) {
192	my $type = shift;	1146	my $registry = $obj->registry;
193	_attach @{$CB_TYPE[$type]}, KLASS_OBJECT, @_
194	}
195		1147
196	sub attach_to_objects {	1148	for (@$attach) {
197	_attach @CB_OBJECT, KLASS_OBJECT, @_	1149	my ($klass, @attach) = @$_;
198	}	1150	_attach $registry, $klass, @attach;
		1151	}
199		1152
200	sub attach_to_players {	1153	$obj->{$name} = \%arg;
201	_attach @CB_PLAYER, KLASS_PLAYER, @_	1154	} else {
202	}	1155	info "object uses attachment '$name' which is not available, postponing.\n";
		1156	}
203		1157
204	sub attach_to_maps {	1158	$obj->{_attachment}{$name} = undef;
205	_attach @CB_MAP, KLASS_MAP, @_	1159	}
		1160
		1161	sub cf::attachable::attach {
		1162	if (ref $_[0]) {
		1163	_object_attach @_;
		1164	} else {
		1165	_attach shift->_attach_registry, @_;
		1166	}
		1167	_recalc_want;
		1168	};
		1169
		1170	# all those should be optimised
		1171	sub cf::attachable::detach {
		1172	my ($obj, $name) = @_;
		1173
		1174	if (ref $obj) {
		1175	delete $obj->{_attachment}{$name};
		1176	reattach ($obj);
		1177	} else {
		1178	Carp::croak "cannot, currently, detach class attachments";
		1179	}
		1180	_recalc_want;
		1181	};
		1182
		1183	sub cf::attachable::attached {
		1184	my ($obj, $name) = @_;
		1185
		1186	exists $obj->{_attachment}{$name}
		1187	}
		1188
		1189	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
		1190	eval "#line " . __LINE__ . " 'cf.pm'
		1191	sub cf::\L$klass\E::_attach_registry {
		1192	(\\\@CB_$klass, KLASS_$klass)
		1193	}
		1194
		1195	sub cf::\L$klass\E::attachment {
		1196	my \$name = shift;
		1197
		1198	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		1199	}
		1200	";
		1201	die if $@;
206	}	1202	}
207		1203
208	our $override;	1204	our $override;
		1205	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
209		1206
210	sub override() {	1207	sub override {
211	$override = 1	1208	$override = 1;
		1209	@INVOKE_RESULTS = (@_);
212	}	1210	}
213		1211
214	sub invoke {	1212	sub do_invoke {
215	my $event = shift;	1213	my $event = shift;
216	my $callbacks = shift;	1214	my $callbacks = shift;
217		1215
		1216	@INVOKE_RESULTS = ();
		1217
218	local $override;	1218	local $override;
219		1219
220	for (@$callbacks) {	1220	for (@$callbacks) {
221	eval { &{$_->[1]} };	1221	eval { &{$_->[1]} };
222		1222
223	if ($@) {	1223	if ($@) {
224	warn "$@";
225	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	1224	error "$@", "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
226	override;	1225	override;
227	}	1226	}
228		1227
229	return 1 if $override;	1228	return 1 if $override;
230	}	1229	}
231		1230
232	0	1231	0
233	}	1232	}
234		1233
		1234	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
		1235
		1236	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		1237
		1238	Generate an object-specific event with the given arguments.
		1239
		1240	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		1241	removed in future versions), and there is no public API to access override
		1242	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
		1243
		1244	=back
		1245
		1246	=cut
		1247
235	#############################################################################	1248	#############################################################################
236	# old plug-in events	1249	# object support
237		1250
238	sub inject_event {	1251	sub _object_equal($$);
239	my $extension = shift;	1252	sub _object_equal($$) {
240	my $event_code = shift;	1253	my ($a, $b) = @_;
241		1254
242	my $cb = $hook[$event_code]{$extension}	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	}
		1317
		1318	cf::attachable->attach (
		1319	prio => -1000000,
		1320	on_instantiate => sub {
		1321	my ($obj, $data) = @_;
		1322
		1323	$data = decode_json $data;
		1324
		1325	for (@$data) {
		1326	my ($name, $args) = @$_;
		1327
		1328	$obj->attach ($name, %{$args || {} });
		1329	}
		1330	},
		1331	on_reattach => \&reattach,
		1332	on_clone => sub {
		1333	my ($src, $dst) = @_;
		1334
		1335	@{$dst->registry} = @{$src->registry};
		1336
		1337	%$dst = %$src;
		1338
		1339	%{$dst->{_attachment}} = %{$src->{_attachment}}
		1340	if exists $src->{_attachment};
		1341	},
		1342	);
		1343
		1344	sub object_freezer_save {
		1345	my ($filename, $rdata, $objs) = @_;
		1346
		1347	sync_job {
		1348	if (length $$rdata) {
		1349	utf8::decode (my $decname = $filename);
		1350	trace sprintf "saving %s (%d,%d)\n",
		1351	$decname, length $$rdata, scalar @$objs
		1352	if $VERBOSE_IO;
		1353
		1354	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		1355	aio_chmod $fh, SAVE_MODE;
		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	}
		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;
		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;
		1383	} else {
		1384	error "unable to save objects: $filename~: $!\n";
		1385	}
		1386	} else {
		1387	aio_unlink $filename;
		1388	aio_unlink "$filename.pst";
		1389	}
		1390	};
		1391	}
		1392
		1393	sub object_freezer_as_string {
		1394	my ($rdata, $objs) = @_;
		1395
		1396	use Data::Dumper;
		1397
		1398	$$rdata . Dumper $objs
		1399	}
		1400
		1401	sub object_thawer_load {
		1402	my ($filename) = @_;
		1403
		1404	my ($data, $av);
		1405
		1406	(aio_load $filename, $data) >= 0
243	or return;	1407	or return;
244		1408
245	&$cb	1409	unless (aio_stat "$filename.pst") {
246	}	1410	(aio_load "$filename.pst", $av) >= 0
247
248	sub inject_global_event {
249	my $event = shift;
250
251	my $cb = $hook[$event]
252	or return;	1411	or return;
253		1412
254	List::Util::max map &$_, values %$cb	1413	my $st = eval { Coro::Storable::thaw $av };
255	}	1414	$av = $st->{objs};
256
257	sub inject_command {
258	my ($name, $obj, $params) = @_;
259
260	for my $cmd (@{ $command{$name} }) {
261	$cmd->[1]->($obj, $params);
262	}	1415	}
263		1416
264	-1	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)
265	}	1423	}
		1424
		1425	=head2 COMMAND CALLBACKS
		1426
		1427	=over 4
		1428
		1429	=cut
		1430
		1431	#############################################################################
		1432	# command handling &c
		1433
		1434	=item cf::register_command $name => \&callback($ob,$args)
		1435
		1436	Register a callback for execution when the client sends the user command
		1437	$name.
		1438
		1439	=cut
266		1440
267	sub register_command {	1441	sub register_command {
268	my ($name, $time, $cb) = @_;	1442	my ($name, $cb) = @_;
269		1443
270	my $caller = caller;	1444	my $caller = caller;
271	#warn "registering command '$name/$time' to '$caller'";	1445	#warn "registering command '$name/$time' to '$caller'";
272		1446
273	push @{ $command{$name} }, [$time, $cb, $caller];	1447	push @{ $COMMAND{$name} }, [$caller, $cb];
274	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
275	}	1448	}
276		1449
		1450	=item cf::register_extcmd $name => \&callback($pl,@args)
		1451
		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.
		1457
		1458	The values will be sent back to the client.
		1459
		1460	=item cf::register_async_extcmd $name => \&callback($pl,$reply->(...),@args)
		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
277	sub register_extcmd {	1482	sub register_extcmd($$) {
278	my ($name, $cb) = @_;	1483	my ($name, $cb) = @_;
279		1484
280	my $caller = caller;	1485	$EXTCMD{$name} = $cb;
281	#warn "registering extcmd '$name' to '$caller'";
282
283	$extcmd{$name} = [$cb, $caller];
284	}	1486	}
285		1487
286	sub register {	1488	sub register_async_extcmd($$) {
287	my ($base, $pkg) = @_;	1489	my ($name, $cb) = @_;
288		1490
289	for my $idx (0 .. $#PLUGIN_EVENT) {	1491	$EXTACMD{$name} = $cb;
290	if (my $ref = $pkg->can ("on_$PLUGIN_EVENT[$idx]")) {	1492	}
291	#warn "registering $PLUGIN_EVENT[$idx] hook to '$pkg'\n";	1493
292	$hook[$idx]{$base} = $ref;	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 ();
		1507
		1508	cf::player->attach (
		1509	on_unknown_command => sub {
		1510	my ($pl, $name, $params) = @_;
		1511
		1512	my $cb = $COMMAND{$name}
		1513	or return;
		1514
		1515	for my $cmd (@$cb) {
		1516	$cmd->[1]->($pl->ob, $params);
293	}	1517	}
		1518
		1519	cf::override;
294	}	1520	},
295	}	1521	on_extcmd => sub {
		1522	my ($pl, $buf) = @_;
296		1523
297	sub load_extension {	1524	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
298	my ($path) = @_;
299		1525
300	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1526	if (ref $msg) {
301	my $base = $1;	1527	my ($type, $reply, @payload) = @$msg; # version 1 used %type, $id, %$hash
302	my $pkg = $1;
303	$pkg =~ s/[^[:word:]]/_/g;
304	$pkg = "ext::$pkg";
305		1528
306	warn "loading '$path' into '$pkg'\n";	1529	if (my $cb = $EXTACMD{$type}) {
		1530	$cb->(
		1531	$pl,
		1532	sub {
		1533	$pl->ext_msg ("reply-$reply", @_)
		1534	if $reply;
		1535	},
		1536	@payload
		1537	);
		1538	} else {
		1539	my @reply;
307		1540
308	open my $fh, "<:utf8", $path	1541	if (my $cb = $EXTCMD{$type}) {
309	or die "$path: $!";	1542	@reply = $cb->($pl, @payload);
		1543	}
310		1544
311	my $source =	1545	$pl->ext_msg ("reply-$reply", @reply)
312	"package $pkg; use strict; use utf8;\n"	1546	if $reply;
313	. "#line 1 \"$path\"\n{\n"	1547	}
314	. (do { local $/; <$fh> })
315	. "\n};\n1";
316		1548
317	eval $source
318	or die "$path: $@";
319
320	push @exts, $pkg;
321	$ext_pkg{$base} = $pkg;
322
323	# no strict 'refs';
324	# @{"$pkg\::ISA"} = ext::;
325
326	register $base, $pkg;
327	}
328
329	sub unload_extension {
330	my ($pkg) = @_;
331
332	warn "removing extension $pkg\n";
333
334	# remove hooks
335	for my $idx (0 .. $#PLUGIN_EVENT) {
336	delete $hook[$idx]{$pkg};
337	}
338
339	# remove commands
340	for my $name (keys %command) {
341	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
342
343	if (@cb) {
344	$command{$name} = \@cb;
345	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
346	} else {	1549	} else {
347	delete $command{$name};	1550	error "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
348	delete $COMMAND{"$name\000"};
349	}	1551	}
		1552
		1553	cf::override;
350	}	1554	},
		1555	);
351		1556
352	# remove extcmds	1557	# "readahead" all extensions
353	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	1558	sub cache_extensions {
354	delete $extcmd{$name};	1559	my $grp = IO::AIO::aio_group;
		1560
		1561	add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
		1562	for (grep /\.ext$/, @{$_[0]}) {
		1563	add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
		1564	}
355	}	1565	};
356		1566
357	if (my $cb = $pkg->can ("on_unload")) {	1567	$grp
358	eval {	1568	}
359	$cb->($pkg);
360	1
361	} or warn "$pkg unloaded, but with errors: $@";
362	}
363		1569
364	Symbol::delete_package $pkg;	1570	sub _ext_cfg_reg($$$$) {
		1571	my ($rvar, $varname, $cfgname, $default) = @_;
		1572
		1573	$cfgname = lc $varname
		1574	unless length $cfgname;
		1575
		1576	$EXT_CFG{$cfgname} = [$rvar, $default];
		1577
		1578	$$rvar = exists $CFG{$cfgname} ? $CFG{$cfgname} : $default;
365	}	1579	}
366		1580
367	sub load_extensions {	1581	sub load_extensions {
368	my $LIBDIR = maps_directory "perl";	1582	info "loading extensions...";
369		1583
		1584	%EXT_CFG = ();
		1585
		1586	cf::sync_job {
		1587	my %todo;
		1588
370	for my $ext (<$LIBDIR/*.ext>) {	1589	for my $path (<$LIBDIR/*.ext>) {
371	next unless -r $ext;	1590	next unless -r $path;
372	eval {	1591
373	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,
374	1	1607	);
375	} or warn "$ext not loaded: $@";
376	}
377	}
378		1608
379	sub _perl_reload(&) {	1609	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
380	my ($msg) = @_;	1610	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
381		1611
382	$msg->("reloading...");	1612	$ext{source} =
		1613	"package $pkg; use common::sense;\n"
		1614	. "#line 1 \"$path\"\n{\n"
		1615	. $source
		1616	. "\n};\n1";
383		1617
384	eval {	1618	$todo{$base} = \%ext;
385	# 1. cancel all watchers
386	$_->cancel for Event::all_watchers;
387
388	# 2. unload all extensions
389	for (@exts) {
390	$msg->("unloading <$_>");
391	unload_extension $_;
392	}	1619	}
393		1620
394	# 3. unload all modules loaded from $LIBDIR	1621	my $pass = 0;
		1622	my %done;
		1623	while (%todo) {
		1624	my $progress;
		1625
		1626	++$pass;
		1627
		1628	ext:
395	while (my ($k, $v) = each %INC) {	1629	while (my ($k, $v) = each %todo) {
396	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	1630	for (split /,\s*/, $v->{meta}{depends}) {
		1631	next ext
		1632	unless exists $done{$_};
		1633	}
397		1634
398	$msg->("removing <$k>");	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";
399	delete $INC{$k};	1655	delete $todo{$k};
		1656	} else {
		1657	$done{$k} = delete $todo{$k};
		1658	push @EXTS, $v->{pkg};
		1659	$progress = 1;
400		1660
401	$k =~ s/\.pm$//;	1661	info "$v->{base}: extension inactive.\n"
402	$k =~ s/\//::/g;	1662	unless $active;
403		1663	}
404	if (my $cb = $k->can ("unload_module")) {
405	$cb->();
406	}	1664	}
407		1665
408	Symbol::delete_package $k;	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;
409	}	1675	}
410
411	# 4. get rid of safe::, as good as possible
412	Symbol::delete_package "safe::$_"
413	for qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region);
414
415	# 5. remove register_script_function callbacks
416	# TODO
417		1676	}
418	# 6. unload cf.pm "a bit"
419	delete $INC{"cf.pm"};
420
421	# don't, removes xs symbols, too,
422	# and global variables created in xs
423	#Symbol::delete_package __PACKAGE__;
424
425	# 7. reload cf.pm
426	$msg->("reloading cf.pm");
427	require cf;
428	};	1677	};
429	$msg->($@) if $@;
430
431	$msg->("reloaded");
432	};
433
434	sub perl_reload() {
435	_perl_reload {
436	warn $_[0];
437	print "$_[0]\n";
438	};
439	}	1678	}
440
441	register_command "perl-reload", 0, sub {
442	my ($who, $arg) = @_;
443
444	if ($who->flag (FLAG_WIZ)) {
445	_perl_reload {
446	warn $_[0];
447	$who->message ($_[0]);
448	};
449	}
450	};
451		1679
452	#############################################################################	1680	#############################################################################
453	# utility functions
454		1681
455	use JSON::Syck (); # TODO# replace by JSON::PC once working	1682	=back
456		1683
457	sub from_json($) {	1684	=head2 CORE EXTENSIONS
458	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
459	JSON::Syck::Load $_[0]
460	}
461		1685
462	sub to_json($) {	1686	Functions and methods that extend core deliantra objects.
463	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
464	JSON::Syck::Dump $_[0]
465	}
466		1687
467	#############################################################################	1688	=cut
468	# extcmd framework, basically convert ext <msg>
469	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
470		1689
471	sub on_extcmd {	1690	package cf::player;
472	my ($pl, $buf) = @_;
473		1691
474	my $msg = eval { from_json $buf };	1692	use Coro::AIO;
475		1693
476	if (ref $msg) {	1694	=head3 cf::player
477	if (my $cb = $extcmd{$msg->{msgtype}}) {
478	if (my %reply = $cb->[0]->($pl, $msg)) {
479	$pl->ext_reply ($msg->{msgid}, %reply);
480	}
481	}
482	} else {
483	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
484	}
485		1695
486	1	1696	=over 4
487	}
488		1697
489	#############################################################################	1698	=item cf::player::num_playing
490	# load/save/clean perl data associated with a map
491		1699
492	*cf::mapsupport::on_clean = sub {	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($) {
493	my ($map) = @_;	1736	my ($login) = @_;
494		1737
495	my $path = $map->tmpname;	1738	$cf::PLAYER{$login}
496	defined $path or return;	1739	or !aio_stat path $login
		1740	}
497		1741
498	unlink "$path.cfperl";	1742	sub find($) {
499	};	1743	return $cf::PLAYER{$_[0]} || do {
		1744	my $login = $_[0];
500		1745
501	*cf::mapsupport::on_swapin =	1746	my $guard = cf::lock_acquire "user_find:$login";
502	*cf::mapsupport::on_load = sub {
503	my ($map) = @_;
504		1747
505	my $path = $map->tmpname;	1748	$cf::PLAYER{$_[0]} || do {
506	$path = $map->path unless defined $path;	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";
507		1755
508	open my $fh, "<:raw", "$path.cfperl"	1756	my $f = new_from_file cf::object::thawer path $login
509	or return; # no perl data	1757	or return;
510		1758
511	my $data = Storable::thaw do { local $/; <$fh> };	1759	my $pl = cf::player::load_pl $f
		1760	or return;
512		1761
513	$data->{version} <= 1	1762	local $cf::PLAYER_LOADING{$login} = $pl;
514	or return; # too new	1763	$f->resolve_delayed_derefs;
515		1764	$cf::PLAYER{$login} = $pl
516	$map->_set_obs ($data->{obs});
517	};
518
519	*cf::mapsupport::on_swapout = sub {
520	my ($map) = @_;
521
522	my $path = $map->tmpname;
523	$path = $map->path unless defined $path;
524
525	my $obs = $map->_get_obs;
526
527	if (defined $obs) {
528	open my $fh, ">:raw", "$path.cfperl"
529	or die "$path.cfperl: $!";
530
531	stat $path;
532
533	print $fh Storable::nfreeze {
534	size => (stat _)[7],
535	time => (stat _)[9],
536	version => 1,
537	obs => $obs,
538	};	1765	}
539
540	chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g*
541	} else {
542	unlink "$path.cfperl";
543	}	1766	}
544	};
545
546	attach_to_maps prio => -10000, package => cf::mapsupport::;
547
548	#############################################################################
549	# load/save perl data associated with player->ob objects
550
551	sub all_objects(@) {
552	@_, map all_objects ($_->inv), @_
553	}	1767	}
554		1768
555	attach_to_players	1769	cf::player->attach (
556	on_load => sub {	1770	on_load => sub {
557	my ($pl, $path) = @_;	1771	my ($pl, $path) = @_;
558		1772
559	for my $o (all_objects $pl->ob) {	1773	# restore slots saved in save, below
560	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1774	my $slots = delete $pl->{_slots};
561	$o->set_ob_key_value ("_perl_data");
562		1775
563	%$o = %{ Storable::thaw pack "H*", $value };	1776	$pl->ob->current_weapon ($slots->[0]);
		1777	$pl->combat_ob ($slots->[1]);
		1778	$pl->ranged_ob ($slots->[2]);
		1779	},
		1780	);
		1781
		1782	sub save($) {
		1783	my ($pl) = @_;
		1784
		1785	return if $pl->{deny_save};
		1786
		1787	my $path = path $pl;
		1788	my $guard = cf::lock_acquire "user_save:$path";
		1789
		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
		1957
		1958	=over 4
		1959
		1960	=cut
		1961
		1962	package cf::region;
		1963
		1964	=item cf::region::find_by_path $path
		1965
		1966	Tries to decuce the likely region for a map knowing only its path.
		1967
		1968	=cut
		1969
		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 {
		2036	my ($self, $merge) = @_;
		2037
		2038	# we have to keep some variables in memory intact
		2039	local $self->{path};
		2040	local $self->{load_path};
		2041
		2042	$self->SUPER::thawer_merge ($merge);
		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	}
564	}	2302	}
		2303
		2304	$f->resolve_delayed_derefs;
		2305	} else {
		2306	$self->post_load_original
		2307	if delete $self->{load_original};
565	}	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);
566	},	2329	}
567	on_save => sub {
568	my ($pl, $path) = @_;
569		2330
570	$_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)	2331	$self->post_load;
571	for grep %$_, all_objects $pl->ob;	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;
572	},	2381	}
573	;
574		2382
575	#############################################################################	2383	$MAP_PREFETCH{$path} |= $load;
576	# core extensions - in perl
577		2384
578	=item cf::player::exists $login	2385	$MAP_PREFETCHER ||= cf::async {
		2386	$Coro::current->{desc} = "map prefetcher";
579		2387
580	Returns true when the given account exists.	2388	while (%MAP_PREFETCH) {
		2389	while (my ($k, $v) = each %MAP_PREFETCH) {
		2390	if (my $map = find $k) {
		2391	$map->load if $v;
		2392	}
581		2393
582	=cut	2394	delete $MAP_PREFETCH{$k};
		2395	}
		2396	}
		2397	undef $MAP_PREFETCHER;
		2398	};
		2399	$MAP_PREFETCHER->prio (6);
583		2400
584	sub cf::player::exists($) {	2401	()
585	cf::player::find $_[0]
586	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
587	}	2402	}
588		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;
		2678
		2679	=back
		2680
		2681	=head3 cf::object::player
		2682
		2683	=over 4
		2684
589	=item $player->reply ($npc, $msg[, $flags])	2685	=item $player_object->reply ($npc, $msg[, $flags])
590		2686
591	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>
592	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
593	dialogue with the given NPC character.	2689	dialogue with the given NPC character.
594		2690
595	=cut	2691	=cut
596		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	};
		2706
597	# rough implementation of a future "reply" method that works	2707	# rough implementation of a future "reply" method that works
598	# with dialog boxes.	2708	# with dialog boxes.
		2709	#TODO: the first argument must go, split into a $npc->reply_to ( method
599	sub cf::object::player::reply($$$;$) {	2710	sub cf::object::player::reply($$$;$) {
600	my ($self, $npc, $msg, $flags) = @_;	2711	my ($self, $npc, $msg, $flags) = @_;
601		2712
602	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2713	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
603		2714
604	if ($self->{record_replies}) {	2715	if ($self->{record_replies}) {
605	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2716	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2717
606	} 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 {
607	$msg = $npc->name . " says: $msg" if $npc;	2726	$msg = $npc->name . " says: $msg" if $npc;
608	$self->message ($msg, $flags);	2727	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2728	}
		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 (@_);
		2740	}
		2741
		2742	=item $player_object->may ("access")
		2743
		2744	Returns wether the given player is authorized to access resource "access"
		2745	(e.g. "command_wizcast").
		2746
		2747	=cut
		2748
		2749	sub cf::object::player::may {
		2750	my ($self, $access) = @_;
		2751
		2752	$self->flag (cf::FLAG_WIZ) ||
		2753	(ref $cf::CFG{"may_$access"}
		2754	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		2755	: $cf::CFG{"may_$access"})
		2756	}
		2757
		2758	=item $player_object->enter_link
		2759
		2760	Freezes the player and moves him/her to a special map (C<{link}>).
		2761
		2762	The player should be reasonably safe there for short amounts of time (e.g.
		2763	for loading a map). You I<MUST> call C<leave_link> as soon as possible,
		2764	though, as the player cannot control the character while it is on the link
		2765	map.
		2766
		2767	Will never block.
		2768
		2769	=item $player_object->leave_link ($map, $x, $y)
		2770
		2771	Moves the player out of the special C<{link}> map onto the specified
		2772	map. If the map is not valid (or omitted), the player will be moved back
		2773	to the location he/she was before the call to C<enter_link>, or, if that
		2774	fails, to the emergency map position.
		2775
		2776	Might block.
		2777
		2778	=cut
		2779
		2780	sub link_map {
		2781	unless ($LINK_MAP) {
		2782	$LINK_MAP = cf::map::find "{link}"
		2783	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2784	$LINK_MAP->load;
		2785	}
		2786
		2787	$LINK_MAP
		2788	}
		2789
		2790	sub cf::object::player::enter_link {
		2791	my ($self) = @_;
		2792
		2793	$self->deactivate_recursive;
		2794
		2795	++$self->{_link_recursion};
		2796
		2797	return if UNIVERSAL::isa $self->map, "ext::map_link";
		2798
		2799	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		2800	if $self->map && $self->map->{path} ne "{link}";
		2801
		2802	$self->enter_map ($LINK_MAP || link_map, 3, 3);
		2803	}
		2804
		2805	sub cf::object::player::leave_link {
		2806	my ($self, $map, $x, $y) = @_;
		2807
		2808	return unless $self->contr->active;
		2809
		2810	my $link_pos = delete $self->{_link_pos};
		2811
		2812	unless ($map) {
		2813	# restore original map position
		2814	($map, $x, $y) = @{ $link_pos || [] };
		2815	$map = cf::map::find $map;
		2816
		2817	unless ($map) {
		2818	($map, $x, $y) = @$EMERGENCY_POSITION;
		2819	$map = cf::map::find $map
		2820	or die "FATAL: cannot load emergency map\n";
		2821	}
		2822	}
		2823
		2824	($x, $y) = (-1, -1)
		2825	unless (defined $x) && (defined $y);
		2826
		2827	# use -1 or undef as default coordinates, not 0, 0
		2828	($x, $y) = ($map->enter_x, $map->enter_y)
		2829	if $x <= 0 && $y <= 0;
		2830
		2831	$map->load;
		2832
		2833	return unless $self->contr->active;
		2834
		2835	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
		2836	if ($self->enter_map ($map, $x, $y)) {
		2837	# entering was successful
		2838	delete $self->{_link_recursion};
		2839	# only activate afterwards, to support waiting in hooks
		2840	$self->activate_recursive;
		2841	}
		2842
		2843	}
		2844
		2845	=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
		2846
		2847	Moves the player to the given map-path and coordinates by first freezing
		2848	her, loading and preparing them map, calling the provided $check callback
		2849	that has to return the map if sucecssful, and then unfreezes the player on
		2850	the new (success) or old (failed) map position. In either case, $done will
		2851	be called at the end of this process.
		2852
		2853	Note that $check will be called with a potentially non-loaded map, so if
		2854	it needs a loaded map it has to call C<< ->load >>.
		2855
		2856	=cut
		2857
		2858	our $GOTOGEN;
		2859
		2860	sub cf::object::player::goto {
		2861	my ($self, $path, $x, $y, $check, $done) = @_;
		2862
		2863	if ($self->{_link_recursion} >= $MAX_LINKS) {
		2864	error "FATAL: link recursion exceeded, ", $self->name, " goto $path $x $y, redirecting.";
		2865	$self->failmsg ("Something went wrong inside the server - please contact an administrator!");
		2866	($path, $x, $y) = @$EMERGENCY_POSITION;
		2867	}
		2868
		2869	# do generation counting so two concurrent goto's will be executed in-order
		2870	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
		2871
		2872	$self->enter_link;
		2873
		2874	(async {
		2875	$Coro::current->{desc} = "player::goto $path $x $y";
		2876
		2877	# *tag paths override both path and x|y
		2878	if ($path =~ /^\*(.*)$/) {
		2879	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2880	my $ob = $obs[rand @obs];
		2881
		2882	# see if we actually can go there
		2883	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2884	$ob = $obs[rand @obs];
		2885	} else {
		2886	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2887	}
		2888	# else put us there anyways for now #d#
		2889
		2890	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2891	} else {
		2892	($path, $x, $y) = (undef, undef, undef);
		2893	}
		2894	}
		2895
		2896	my $map = eval {
		2897	my $map = defined $path ? cf::map::find $path, $self->map : undef;
		2898
		2899	if ($map) {
		2900	$map = $map->customise_for ($self);
		2901	$map = $check->($map, $x, $y, $self) if $check && $map;
		2902	} else {
		2903	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2904	}
		2905
		2906	$map
		2907	};
		2908
		2909	if ($@) {
		2910	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2911	LOG llevError | logBacktrace, Carp::longmess $@;
		2912	}
		2913
		2914	if ($gen == $self->{_goto_generation}) {
		2915	delete $self->{_goto_generation};
		2916	$self->leave_link ($map, $x, $y);
		2917	}
		2918
		2919	$done->($self) if $done;
		2920	})->prio (1);
		2921	}
		2922
		2923	=item $player_object->enter_exit ($exit_object)
		2924
		2925	=cut
		2926
		2927	sub parse_random_map_params {
		2928	my ($spec) = @_;
		2929
		2930	my $rmp = { # defaults
		2931	xsize => (cf::rndm 15, 40),
		2932	ysize => (cf::rndm 15, 40),
		2933	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2934	#layout => string,
609	}	2935	};
610	}
611		2936
612	=item $player->ext_reply ($msgid, $msgtype, %msg)	2937	for (split /\n/, $spec) {
		2938	my ($k, $v) = split /\s+/, $_, 2;
613		2939
		2940	$rmp->{lc $k} = $v if (length $k) && (length $v);
		2941	}
		2942
		2943	$rmp
		2944	}
		2945
		2946	sub prepare_random_map {
		2947	my ($exit) = @_;
		2948
		2949	# all this does is basically replace the /! path by
		2950	# a new random map path (?random/...) with a seed
		2951	# that depends on the exit object
		2952
		2953	my $rmp = parse_random_map_params $exit->msg;
		2954
		2955	if ($exit->map) {
		2956	$rmp->{region} = $exit->region->name;
		2957	$rmp->{origin_map} = $exit->map->path;
		2958	$rmp->{origin_x} = $exit->x;
		2959	$rmp->{origin_y} = $exit->y;
		2960
		2961	$exit->map->touch;
		2962	}
		2963
		2964	$rmp->{random_seed} ||= $exit->random_seed;
		2965
		2966	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
		2967	my $md5 = Digest::MD5::md5_hex $data;
		2968	my $meta = "$RANDOMDIR/$md5.meta";
		2969
		2970	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		2971	aio_write $fh, 0, (length $data), $data, 0;
		2972	undef $fh;
		2973	aio_rename "$meta~", $meta;
		2974
		2975	my $slaying = "?random/$md5";
		2976
		2977	if ($exit->valid) {
		2978	$exit->slaying ("?random/$md5");
		2979	$exit->msg (undef);
		2980	}
		2981	}
		2982	}
		2983
		2984	sub cf::object::player::enter_exit {
		2985	my ($self, $exit) = @_;
		2986
		2987	return unless $self->type == cf::PLAYER;
		2988
		2989	$self->enter_link;
		2990
		2991	(async {
		2992	$Coro::current->{desc} = "enter_exit";
		2993
		2994	unless (eval {
		2995	$self->deactivate_recursive; # just to be sure
		2996
		2997	my $map = cf::map::normalise $exit->slaying, $exit->map;
		2998	my $x = $exit->stats->hp;
		2999	my $y = $exit->stats->sp;
		3000
		3001	# special map handling
		3002	my $slaying = $exit->slaying;
		3003
		3004	# special map handling
		3005	if ($slaying eq "/!") {
		3006	my $guard = cf::lock_acquire "exit_prepare:$exit";
		3007
		3008	prepare_random_map $exit
		3009	if $exit->slaying eq "/!"; # need to re-check after getting the lock
		3010
		3011	$map = $exit->slaying;
		3012
		3013	} elsif ($slaying eq '!up') {
		3014	$map = $exit->map->tile_path (cf::TILE_UP);
		3015	$x = $exit->x;
		3016	$y = $exit->y;
		3017
		3018	} elsif ($slaying eq '!down') {
		3019	$map = $exit->map->tile_path (cf::TILE_DOWN);
		3020	$x = $exit->x;
		3021	$y = $exit->y;
		3022	}
		3023
		3024	$self->goto ($map, $x, $y);
		3025
		3026	# if exit is damned, update players death & WoR home-position
		3027	$self->contr->savebed ($map, $x, $y)
		3028	if $exit->flag (cf::FLAG_DAMNED);
		3029
		3030	1
		3031	}) {
		3032	$self->message ("Something went wrong deep within the deliantra server. "
		3033	. "I'll try to bring you back to the map you were before. "
		3034	. "Please report this to the dungeon master!",
		3035	cf::NDI_UNIQUE | cf::NDI_RED);
		3036
		3037	error "ERROR in enter_exit: $@";
		3038	$self->leave_link;
		3039	}
		3040	})->prio (1);
		3041	}
		3042
		3043	=head3 cf::client
		3044
		3045	=over 4
		3046
		3047	=item $client->send_big_packet ($pkt)
		3048
		3049	Like C<send_packet>, but tries to compress large packets, and fragments
		3050	them as required.
		3051
		3052	=cut
		3053
		3054	our $MAXFRAGSIZE = cf::MAXSOCKBUF - 64;
		3055
		3056	sub cf::client::send_big_packet {
		3057	my ($self, $pkt) = @_;
		3058
		3059	# try lzf for large packets
		3060	$pkt = "lzf " . Compress::LZF::compress $pkt
		3061	if 1024 <= length $pkt and $self->{can_lzf};
		3062
		3063	# split very large packets
		3064	if ($MAXFRAGSIZE < length $pkt and $self->{can_lzf}) {
		3065	$self->send_packet ("frag $_") for unpack "(a$MAXFRAGSIZE)*", $pkt;
		3066	$pkt = "frag";
		3067	}
		3068
		3069	$self->send_packet ($pkt);
		3070	}
		3071
		3072	=item $client->send_msg ($channel, $msg, $color, [extra...])
		3073
		3074	Send a msg packet to the client, formatting the msg for the client if
		3075	necessary. C<$type> should be a string identifying the type of the
		3076	message, with C<log> being the default. If C<$color> is negative, suppress
		3077	the message unless the client supports the msg packet.
		3078
		3079	=cut
		3080
		3081	# non-persistent channels (usually the info channel)
		3082	our %CHANNEL = (
		3083	"c/motd" => {
		3084	id => "infobox",
		3085	title => "MOTD",
		3086	reply => undef,
		3087	tooltip => "The message of the day",
		3088	},
		3089	"c/identify" => {
		3090	id => "infobox",
		3091	title => "Identify",
		3092	reply => undef,
		3093	tooltip => "Items recently identified",
		3094	},
		3095	"c/examine" => {
		3096	id => "infobox",
		3097	title => "Examine",
		3098	reply => undef,
		3099	tooltip => "Signs and other items you examined",
		3100	},
		3101	"c/shopinfo" => {
		3102	id => "infobox",
		3103	title => "Shop Info",
		3104	reply => undef,
		3105	tooltip => "What your bargaining skill tells you about the shop",
		3106	},
		3107	"c/book" => {
		3108	id => "infobox",
		3109	title => "Book",
		3110	reply => undef,
		3111	tooltip => "The contents of a note or book",
		3112	},
		3113	"c/lookat" => {
		3114	id => "infobox",
		3115	title => "Look",
		3116	reply => undef,
		3117	tooltip => "What you saw there",
		3118	},
		3119	"c/who" => {
		3120	id => "infobox",
		3121	title => "Players",
		3122	reply => undef,
		3123	tooltip => "Shows players who are currently online",
		3124	},
		3125	"c/body" => {
		3126	id => "infobox",
		3127	title => "Body Parts",
		3128	reply => undef,
		3129	tooltip => "Shows which body parts you posess and are available",
		3130	},
		3131	"c/statistics" => {
		3132	id => "infobox",
		3133	title => "Statistics",
		3134	reply => undef,
		3135	tooltip => "Shows your primary statistics",
		3136	},
		3137	"c/skills" => {
		3138	id => "infobox",
		3139	title => "Skills",
		3140	reply => undef,
		3141	tooltip => "Shows your experience per skill and item power",
		3142	},
		3143	"c/shopitems" => {
		3144	id => "infobox",
		3145	title => "Shop Items",
		3146	reply => undef,
		3147	tooltip => "Shows the items currently for sale in this shop",
		3148	},
		3149	"c/resistances" => {
		3150	id => "infobox",
		3151	title => "Resistances",
		3152	reply => undef,
		3153	tooltip => "Shows your resistances",
		3154	},
		3155	"c/pets" => {
		3156	id => "infobox",
		3157	title => "Pets",
		3158	reply => undef,
		3159	tooltip => "Shows information abotu your pets/a specific pet",
		3160	},
		3161	"c/perceiveself" => {
		3162	id => "infobox",
		3163	title => "Perceive Self",
		3164	reply => undef,
		3165	tooltip => "You gained detailed knowledge about yourself",
		3166	},
		3167	"c/uptime" => {
		3168	id => "infobox",
		3169	title => "Uptime",
		3170	reply => undef,
		3171	tooltip => "How long the server has been running since last restart",
		3172	},
		3173	"c/mapinfo" => {
		3174	id => "infobox",
		3175	title => "Map Info",
		3176	reply => undef,
		3177	tooltip => "Information related to the maps",
		3178	},
		3179	"c/party" => {
		3180	id => "party",
		3181	title => "Party",
		3182	reply => "gsay ",
		3183	tooltip => "Messages and chat related to your party",
		3184	},
		3185	"c/death" => {
		3186	id => "death",
		3187	title => "Death",
		3188	reply => undef,
		3189	tooltip => "Reason for and more info about your most recent death",
		3190	},
		3191	"c/fatal" => {
		3192	id => "fatal",
		3193	title => "Fatal Error",
		3194	reply => undef,
		3195	tooltip => "Reason for the server disconnect",
		3196	},
		3197	"c/say" => $SAY_CHANNEL,
		3198	"c/chat" => $CHAT_CHANNEL,
		3199	);
		3200
		3201	sub cf::client::send_msg {
		3202	my ($self, $channel, $msg, $color, @extra) = @_;
		3203
		3204	$msg = $self->pl->expand_cfpod ($msg)
		3205	unless $color & cf::NDI_VERBATIM;
		3206
		3207	$color &= cf::NDI_CLIENT_MASK; # just in case...
		3208
		3209	# check predefined channels, for the benefit of C
		3210	if ($CHANNEL{$channel}) {
		3211	$channel = $CHANNEL{$channel};
		3212
		3213	$self->ext_msg (channel_info => $channel);
		3214	$channel = $channel->{id};
		3215
		3216	} elsif (ref $channel) {
		3217	# send meta info to client, if not yet sent
		3218	unless (exists $self->{channel}{$channel->{id}}) {
		3219	$self->{channel}{$channel->{id}} = $channel;
		3220	$self->ext_msg (channel_info => $channel);
		3221	}
		3222
		3223	$channel = $channel->{id};
		3224	}
		3225
		3226	return unless @extra || length $msg;
		3227
		3228	# default colour, mask it out
		3229	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		3230	if $color & cf::NDI_DEF;
		3231
		3232	my $pkt = "msg "
		3233	. $self->{json_coder}->encode (
		3234	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
		3235	);
		3236
		3237	$self->send_big_packet ($pkt);
		3238	}
		3239
		3240	=item $client->ext_msg ($type, @msg)
		3241
614	Sends an ext reply to the player.	3242	Sends an ext event to the client.
615		3243
616	=cut	3244	=cut
617		3245
618	sub cf::player::ext_reply($$$%) {	3246	sub cf::client::ext_msg($$@) {
619	my ($self, $id, %msg) = @_;	3247	my ($self, $type, @msg) = @_;
620		3248
621	$msg{msgid} = $id;	3249	$self->send_big_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
622
623	$self->send ("ext " . to_json \%msg);
624	}	3250	}
625		3251
626	#############################################################################	3252	=item $success = $client->query ($flags, "text", \&cb)
627	# map scripting support
628		3253
		3254	Queues a query to the client, calling the given callback with
		3255	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		3256	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		3257
		3258	Queries can fail, so check the return code. Or don't, as queries will
		3259	become reliable at some point in the future.
		3260
		3261	=cut
		3262
		3263	sub cf::client::query {
		3264	my ($self, $flags, $text, $cb) = @_;
		3265
		3266	return unless $self->state == ST_PLAYING
		3267	|| $self->state == ST_SETUP
		3268	|| $self->state == ST_CUSTOM;
		3269
		3270	$self->state (ST_CUSTOM);
		3271
		3272	utf8::encode $text;
		3273	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		3274
		3275	$self->send_packet ($self->{query_queue}[0][0])
		3276	if @{ $self->{query_queue} } == 1;
		3277
		3278	1
		3279	}
		3280
		3281	=item $client->update_command_faces
		3282
		3283	=cut
		3284
		3285	our %COMMAND_FACE;
		3286
		3287	sub cf::client::update_command_faces {
		3288	my ($self) = @_;
		3289
		3290	my @faces = grep $_,
		3291	$COMMAND_FACE{preferred},
		3292	$COMMAND_FACE{standard},
		3293	$COMMAND_FACE{skill},
		3294	$self->pl->ob->flag (cf::FLAG_WIZ) ? $COMMAND_FACE{dm} : (),
		3295	$COMMAND_FACE{emote},
		3296	;
		3297
		3298	$self->send_face ($_)
		3299	for @faces;
		3300	$self->flush_fx;
		3301
		3302	$self->ext_msg (command_list => @faces);
		3303	}
		3304
		3305	=item cf::client::set_command_face $type, $commands
		3306
		3307	=cut
		3308
		3309	sub cf::client::set_command_face {
		3310	my ($type, $list) = @_;
		3311
		3312	my $idx = &cf::face::set ( #d# ugly forward reference
		3313	"command_list/$type" => cf::FT_RSRC,
		3314	JSON::XS->new->utf8->encode ([ sort @$list ])
		3315	);
		3316
		3317	$COMMAND_FACE{$type} = $idx;
		3318	}
		3319
		3320	cf::client->attach (
		3321	on_connect => sub {
		3322	my ($ns) = @_;
		3323
		3324	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		3325	},
		3326	on_reply => sub {
		3327	my ($ns, $msg) = @_;
		3328
		3329	# this weird shuffling is so that direct followup queries
		3330	# get handled first
		3331	my $queue = delete $ns->{query_queue}
		3332	or return; # be conservative, not sure how that can happen, but we saw a crash here
		3333
		3334	(shift @$queue)->[1]->($msg);
		3335	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
		3336
		3337	push @{ $ns->{query_queue} }, @$queue;
		3338
		3339	if (@{ $ns->{query_queue} } == @$queue) {
		3340	if (@$queue) {
		3341	$ns->send_packet ($ns->{query_queue}[0][0]);
		3342	} else {
		3343	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		3344	}
		3345	}
		3346	},
		3347	on_exticmd => sub {
		3348	my ($ns, $buf) = @_;
		3349
		3350	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		3351
		3352	if (ref $msg) {
		3353	my ($type, $reply, @payload) = @$msg; # version 1 used %type, $id, %$hash
		3354
		3355	if (my $cb = $EXTIACMD{$type}) {
		3356	$cb->(
		3357	$ns,
		3358	sub {
		3359	$ns->ext_msg ("reply-$reply", @_)
		3360	if $reply;
		3361	},
		3362	@payload
		3363	);
		3364	} else {
		3365	my @reply;
		3366
		3367	if (my $cb = $EXTICMD{$type}) {
		3368	@reply = $cb->($ns, @payload);
		3369	}
		3370
		3371	$ns->ext_msg ("reply-$reply", @reply)
		3372	if $reply;
		3373	}
		3374	} else {
		3375	error "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		3376	}
		3377
		3378	cf::override;
		3379	},
		3380	);
		3381
		3382	=item $client->async (\&cb)
		3383
		3384	Create a new coroutine, running the specified callback. The coroutine will
		3385	be automatically cancelled when the client gets destroyed (e.g. on logout,
		3386	or loss of connection).
		3387
		3388	=cut
		3389
		3390	sub cf::client::async {
		3391	my ($self, $cb) = @_;
		3392
		3393	my $coro = &Coro::async ($cb);
		3394
		3395	$coro->on_destroy (sub {
		3396	delete $self->{_coro}{$coro+0};
		3397	});
		3398
		3399	$self->{_coro}{$coro+0} = $coro;
		3400
		3401	$coro
		3402	}
		3403
		3404	cf::client->attach (
		3405	on_client_destroy => sub {
		3406	my ($ns) = @_;
		3407
		3408	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		3409	},
		3410	);
		3411
		3412	=back
		3413
		3414
		3415	=head2 SAFE SCRIPTING
		3416
		3417	Functions that provide a safe environment to compile and execute
		3418	snippets of perl code without them endangering the safety of the server
		3419	itself. Looping constructs, I/O operators and other built-in functionality
		3420	is not available in the safe scripting environment, and the number of
		3421	functions and methods that can be called is greatly reduced.
		3422
		3423	=cut
		3424
629	our $safe = new Safe "ext";	3425	our $safe = new Safe "safe";
630	our $safe_hole = new Safe::Hole;	3426	our $safe_hole = new Safe::Hole;
631		3427
632	$SIG{FPE} = 'IGNORE';	3428	$SIG{FPE} = 'IGNORE';
633		3429
634	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3430	$safe->permit_only (Opcode::opset qw(
		3431	:base_core :base_mem :base_orig :base_math :base_loop
		3432	grepstart grepwhile mapstart mapwhile
		3433	sort time
		3434	));
635		3435
636	# here we export the classes and methods available to script code	3436	# here we export the classes and methods available to script code
637		3437
		3438	=pod
		3439
		3440	The following functions and methods are available within a safe environment:
		3441
		3442	cf::object
		3443	contr pay_amount pay_player map x y force_find force_add destroy
		3444	insert remove name archname title slaying race decrease split
		3445	value
		3446
		3447	cf::object::player
		3448	player
		3449
		3450	cf::player
		3451	peaceful
		3452
		3453	cf::map
		3454	trigger
		3455
		3456	=cut
		3457
638	for (	3458	for (
639	["cf::object" => qw(contr pay_amount pay_player)],	3459	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3460	insert remove inv nrof name archname title slaying race
		3461	decrease split destroy change_exp value msg lore send_msg)],
640	["cf::object::player" => qw(player)],	3462	["cf::object::player" => qw(player)],
641	["cf::player" => qw(peaceful)],	3463	["cf::player" => qw(peaceful send_msg)],
		3464	["cf::map" => qw(trigger)],
642	) {	3465	) {
643	no strict 'refs';
644	my ($pkg, @funs) = @$_;	3466	my ($pkg, @funs) = @$_;
645	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3467	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
646	for @funs;	3468	for @funs;
647	}	3469	}
648		3470
		3471	=over 4
		3472
		3473	=item @retval = safe_eval $code, [var => value, ...]
		3474
		3475	Compiled and executes the given perl code snippet. additional var/value
		3476	pairs result in temporary local (my) scalar variables of the given name
		3477	that are available in the code snippet. Example:
		3478
		3479	my $five = safe_eval '$first + $second', first => 1, second => 4;
		3480
		3481	=cut
		3482
649	sub safe_eval($;@) {	3483	sub safe_eval($;@) {
650	my ($code, %vars) = @_;	3484	my ($code, %vars) = @_;
651		3485
652	my $qcode = $code;	3486	my $qcode = $code;
653	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3487	$qcode =~ s/"/‟/g; # not allowed in #line filenames
654	$qcode =~ s/\n/\\n/g;	3488	$qcode =~ s/\n/\\n/g;
655		3489
		3490	%vars = (_dummy => 0) unless %vars;
		3491
		3492	my @res;
656	local $_;	3493	local $_;
657	local @safe::cf::_safe_eval_args = values %vars;
658		3494
659	$code =	3495	my $eval =
660	"do {\n"	3496	"do {\n"
661	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	3497	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
662	. "#line 0 \"{$qcode}\"\n"	3498	. "#line 0 \"{$qcode}\"\n"
663	. $code	3499	. $code
664	. "\n}"	3500	. "\n}"
665	;	3501	;
666		3502
		3503	if ($CFG{safe_eval}) {
667	sub_generation_inc;	3504	sub_generation_inc;
		3505	local @safe::cf::_safe_eval_args = values %vars;
668	my @res = wantarray ? $safe->reval ($code) : scalar $safe->reval ($code);	3506	@res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
669	sub_generation_inc;	3507	sub_generation_inc;
		3508	} else {
		3509	local @cf::_safe_eval_args = values %vars;
		3510	@res = wantarray ? eval eval : scalar eval $eval;
		3511	}
		3512
		3513	if ($@) {
		3514	warn "$@",
		3515	"while executing safe code '$code'\n",
		3516	"with arguments " . (join " ", %vars) . "\n";
		3517	}
670		3518
671	wantarray ? @res : $res[0]	3519	wantarray ? @res : $res[0]
672	}	3520	}
		3521
		3522	=item cf::register_script_function $function => $cb
		3523
		3524	Register a function that can be called from within map/npc scripts. The
		3525	function should be reasonably secure and should be put into a package name
		3526	like the extension.
		3527
		3528	Example: register a function that gets called whenever a map script calls
		3529	C<rent::overview>, as used by the C<rent> extension.
		3530
		3531	cf::register_script_function "rent::overview" => sub {
		3532	...
		3533	};
		3534
		3535	=cut
673		3536
674	sub register_script_function {	3537	sub register_script_function {
675	my ($fun, $cb) = @_;	3538	my ($fun, $cb) = @_;
676		3539
677	no strict 'refs';	3540	$fun = "safe::$fun" if $CFG{safe_eval};
678	*{"safe::$fun"} = $safe_hole->wrap ($cb);	3541	*$fun = $safe_hole->wrap ($cb);
679	}	3542	}
		3543
		3544	=back
		3545
		3546	=cut
680		3547
681	#############################################################################	3548	#############################################################################
682	# the server's main()	3549	# the server's init and main functions
		3550
		3551	{
		3552	package cf::face;
		3553
		3554	our %HASH; # hash => idx
		3555	our @DATA; # dynamically-created facedata, only faceste 0 used
		3556	our @FOFS; # file offset, if > 0
		3557	our @SIZE; # size of face, in octets
		3558	our @META; # meta hash of face, if any
		3559	our $DATAFH; # facedata filehandle
		3560
		3561	# internal api, not finalised
		3562	sub set {
		3563	my ($name, $type, $data) = @_;
		3564
		3565	my $idx = cf::face::find $name;
		3566
		3567	if ($idx) {
		3568	delete $HASH{cf::face::get_csum $idx};
		3569	} else {
		3570	$idx = cf::face::alloc $name;
		3571	}
		3572
		3573	my $hash = cf::face::mangle_csum Digest::MD5::md5 $data;
		3574
		3575	cf::face::set_type $idx, $type;
		3576	cf::face::set_csum $idx, 0, $hash;
		3577
		3578	# we need to destroy the SV itself, not just modify it, as a running ix
		3579	# might hold a reference to it: "delete" achieves that.
		3580	delete $FOFS[0][$idx];
		3581	delete $DATA[0][$idx];
		3582	$DATA[0][$idx] = $data;
		3583	$SIZE[0][$idx] = length $data;
		3584	delete $META[$idx];
		3585	$HASH{$hash} = $idx;#d#
		3586
		3587	$idx
		3588	}
		3589
		3590	sub _get_data($$$) {
		3591	my ($idx, $set, $cb) = @_;
		3592
		3593	if (defined $DATA[$set][$idx]) {
		3594	$cb->($DATA[$set][$idx]);
		3595	} elsif (my $fofs = $FOFS[$set][$idx]) {
		3596	my $size = $SIZE[$set][$idx];
		3597	my $buf;
		3598	IO::AIO::aio_read $DATAFH, $fofs, $size, $buf, 0, sub {
		3599	if ($_[0] == $size) {
		3600	#cf::debug "read face $idx, $size from $fofs as ", length $buf;#d#
		3601	$cb->($buf);
		3602	} else {
		3603	cf::error "INTERNAL ERROR: unable to read facedata for face $idx#$set ($size, $fofs), ignoring request.";
		3604	}
		3605	};
		3606	} else {
		3607	cf::error "requested facedata for unknown face $idx#$set, ignoring.";
		3608	}
		3609	}
		3610
		3611	# rather ineffient
		3612	sub cf::face::get_data($;$) {
		3613	my ($idx, $set) = @_;
		3614
		3615	_get_data $idx, $set, Coro::rouse_cb;
		3616	Coro::rouse_wait
		3617	}
		3618
		3619	sub cf::face::ix {
		3620	my ($ns, $set, $idx, $pri) = @_;
		3621
		3622	_get_data $idx, $set, sub {
		3623	$ns->ix_send ($idx, $pri, $_[0]);
		3624	};
		3625	}
		3626	}
		3627
		3628	sub load_facedata($) {
		3629	my ($path) = @_;
		3630
		3631	my $enc = JSON::XS->new->utf8->canonical->relaxed;
		3632
		3633	trace "loading facedata from $path\n";
		3634
		3635	my $facedata = decode_storable load_file "$path/faceinfo";
		3636
		3637	$facedata->{version} == 2
		3638	or cf::cleanup "$path/faceinfo: version mismatch, cannot proceed.";
		3639
		3640	my $fh = aio_open "$DATADIR/facedata", IO::AIO::O_RDONLY, 0
		3641	or cf::cleanup "$path/facedata: $!, cannot proceed.";
		3642
		3643	get_slot 1, -100, "load_facedata"; # make sure we get a very big slot
		3644
		3645	# BEGIN ATOMIC
		3646	# from here on, everything must be atomic - no thread switch allowed
		3647	my $t1 = EV::time;
		3648
		3649	{
		3650	my $faces = $facedata->{faceinfo};
		3651
		3652	for my $face (sort keys %$faces) {
		3653	my $info = $faces->{$face};
		3654	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		3655
		3656	cf::face::set_visibility $idx, $info->{visibility};
		3657	cf::face::set_magicmap $idx, $info->{magicmap};
		3658	cf::face::set_csum $idx, 0, $info->{hash64}; $cf::face::SIZE[0][$idx] = $info->{size64}; $cf::face::FOFS[0][$idx] = $info->{fofs64};
		3659	cf::face::set_csum $idx, 1, $info->{hash32}; $cf::face::SIZE[1][$idx] = $info->{size32}; $cf::face::FOFS[1][$idx] = $info->{fofs32};
		3660	cf::face::set_csum $idx, 2, $info->{glyph}; $cf::face::DATA[2][$idx] = $info->{glyph};
		3661	$cf::face::HASH{$info->{hash64}} = $idx;
		3662	delete $cf::face::META[$idx];
		3663	}
		3664
		3665	while (my ($face, $info) = each %$faces) {
		3666	next unless $info->{smooth};
		3667
		3668	my $idx = cf::face::find $face
		3669	or next;
		3670
		3671	if (my $smooth = cf::face::find $info->{smooth}) {
		3672	cf::face::set_smooth $idx, $smooth;
		3673	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3674	} else {
		3675	error "smooth face '$info->{smooth}' not found for face '$face'";
		3676	}
		3677	}
		3678	}
		3679
		3680	{
		3681	my $anims = $facedata->{animinfo};
		3682
		3683	while (my ($anim, $info) = each %$anims) {
		3684	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3685	}
		3686
		3687	cf::anim::invalidate_all; # d'oh
		3688	}
		3689
		3690	{
		3691	my $res = $facedata->{resource};
		3692
		3693	while (my ($name, $info) = each %$res) {
		3694	if (defined (my $type = $info->{type})) {
		3695	# TODO: different hash - must free and use new index, or cache ixface data queue
		3696	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3697
		3698	cf::face::set_type $idx, $type;
		3699	cf::face::set_csum $idx, 0, $info->{hash};
		3700	$cf::face::SIZE[0][$idx] = $info->{size};
		3701	$cf::face::FOFS[0][$idx] = $info->{fofs};
		3702	$cf::face::META[$idx] = $type & 1 ? undef : $info->{meta}; # preserve meta unless prepended already
		3703	$cf::face::HASH{$info->{hash}} = $idx;
		3704	} else {
		3705	# $RESOURCE{$name} = $info; # unused
		3706	}
		3707	}
		3708	}
		3709
		3710	($fh, $cf::face::DATAFH) = ($cf::face::DATAFH, $fh);
		3711
		3712	# HACK to clear player env face cache, we need some signal framework
		3713	# for this (global event?)
		3714	%ext::player_env::MUSIC_FACE_CACHE = ();
		3715
		3716	# END ATOMIC
		3717
		3718	cf::debug "facedata atomic update time ", EV::time - $t1;
		3719
		3720	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3721
		3722	aio_close $fh if $fh; # close old facedata
		3723
		3724	1
		3725	}
		3726
		3727	register_exticmd fx_want => sub {
		3728	my ($ns, $want) = @_;
		3729
		3730	while (my ($k, $v) = each %$want) {
		3731	$ns->fx_want ($k, $v);
		3732	}
		3733	};
		3734
		3735	sub load_resource_file($) {
		3736	my $guard = lock_acquire "load_resource_file";
		3737
		3738	my $status = load_resource_file_ $_[0];
		3739	get_slot 0.1, 100;
		3740	cf::arch::commit_load;
		3741
		3742	$status
		3743	}
		3744
		3745	sub reload_exp_table {
		3746	_reload_exp_table;
		3747
		3748	cf::face::set
		3749	"res/exp_table" => FT_RSRC,
		3750	JSON::XS->new->utf8->canonical->encode (
		3751	[map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]
		3752	);
		3753	}
		3754
		3755	sub reload_materials {
		3756	_reload_materials;
		3757	}
		3758
		3759	sub reload_regions {
		3760	# HACK to clear player env face cache, we need some signal framework
		3761	# for this (global event?)
		3762	%ext::player_env::MUSIC_FACE_CACHE = ();
		3763
		3764	load_resource_file "$MAPDIR/regions"
		3765	or die "unable to load regions file\n";
		3766
		3767	for (cf::region::list) {
		3768	$_->{match} = qr/$_->{match}/
		3769	if exists $_->{match};
		3770	}
		3771	}
		3772
		3773	sub reload_facedata {
		3774	load_facedata $DATADIR
		3775	or die "unable to load facedata\n";
		3776	}
		3777
		3778	sub reload_archetypes {
		3779	load_resource_file "$DATADIR/archetypes"
		3780	or die "unable to load archetypes\n";
		3781
		3782	cf::face::set
		3783	"res/skill_info" => FT_RSRC,
		3784	JSON::XS->new->utf8->canonical->encode (
		3785	[map [cf::arch::skillvec ($_)->name], 0 .. cf::arch::skillvec_size - 1]
		3786	);
		3787
		3788	cf::face::set
		3789	"res/spell_paths" => FT_RSRC,
		3790	JSON::XS->new->utf8->canonical->encode (
		3791	[map [cf::spellpathnames ($_)], 0 .. NRSPELLPATHS - 1]
		3792	);
		3793
		3794	# command completion
		3795	my @commands;
		3796
		3797	for (0..cf::arch::skillvec_size - 1) {
		3798	my $skill = cf::arch::skillvec $_;
		3799	my $name = $skill->name;
		3800	my $flags = cf::skill_flags $skill->subtype;
		3801
		3802	push @commands, "ready_skill $name" if $flags & (SF_COMBAT | SF_RANGED | SF_GRACE);
		3803	push @commands, "use_skill $name" if $flags & (SF_USE | SF_AUTARK | SF_GRACE);
		3804	}
		3805
		3806	cf::client::set_command_face skill => \@commands;
		3807	}
		3808
		3809	sub reload_treasures {
		3810	load_resource_file "$DATADIR/treasures"
		3811	or die "unable to load treasurelists\n";
		3812	}
		3813
		3814	sub reload_sound {
		3815	trace "loading sound config from $DATADIR/sound\n";
		3816
		3817	my $soundconf = JSON::XS->new->utf8->relaxed->decode (load_file "$DATADIR/sound");
		3818
		3819	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3820	my $sound = $soundconf->{compat}[$_]
		3821	or next;
		3822
		3823	my $face = cf::face::find "sound/$sound->[1]";
		3824	cf::sound::set $sound->[0] => $face;
		3825	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3826	}
		3827
		3828	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3829	my $face = cf::face::find "sound/$v";
		3830	cf::sound::set $k => $face;
		3831	}
		3832	}
		3833
		3834	sub reload_resources {
		3835	trace "reloading resource files...\n";
		3836
		3837	reload_materials;
		3838	reload_facedata;
		3839	reload_exp_table;
		3840	reload_sound;
		3841	reload_archetypes;
		3842	reload_regions;
		3843	reload_treasures;
		3844
		3845	trace "finished reloading resource files\n";
		3846	}
		3847
		3848	sub reload_config {
		3849	trace "reloading config file...\n";
		3850
		3851	my $config = load_file "$CONFDIR/config";
		3852	utf8::decode $config;
		3853	*CFG = decode_yaml $config;
		3854
		3855	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
		3856
		3857	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		3858	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		3859
		3860	if (exists $CFG{mlockall}) {
		3861	eval {
		3862	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		3863	and die "WARNING: m(un)lockall failed: $!\n";
		3864	};
		3865	warn $@ if $@;
		3866	}
		3867	}
		3868
		3869	sub pidfile() {
		3870	sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
		3871	or die "$PIDFILE: $!";
		3872	flock $fh, &Fcntl::LOCK_EX
		3873	or die "$PIDFILE: flock: $!";
		3874	$fh
		3875	}
		3876
		3877	# make sure only one server instance is running at any one time
		3878	sub atomic {
		3879	my $fh = pidfile;
		3880
		3881	my $pid = <$fh>;
		3882	kill 9, $pid if $pid > 0;
		3883
		3884	seek $fh, 0, 0;
		3885	print $fh $$;
		3886	}
		3887
		3888	sub main_loop {
		3889	trace "EV::loop starting\n";
		3890	if (1) {
		3891	EV::loop;
		3892	}
		3893	trace "EV::loop returned\n";
		3894	goto &main_loop unless $REALLY_UNLOOP;
		3895	}
683		3896
684	sub main {	3897	sub main {
685	Event::loop;	3898	cf::init_globals; # initialise logging
		3899
		3900	LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
		3901	LOG llevInfo, "Copyright (C) 2005-2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
		3902	LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
		3903	LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
		3904
		3905	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3906
		3907	# we must not ever block the main coroutine
		3908	$Coro::idle = sub {
		3909	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		3910	(async {
		3911	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3912	EV::loop EV::LOOP_ONESHOT;
		3913	})->prio (Coro::PRIO_MAX);
		3914	};
		3915
		3916	evthread_start IO::AIO::poll_fileno;
		3917
		3918	cf::sync_job {
		3919	cf::incloader::init ();
		3920
		3921	db_init;
		3922
		3923	cf::init_anim;
		3924	cf::init_attackmess;
		3925	cf::init_dynamic;
		3926
		3927	cf::load_settings;
		3928
		3929	reload_resources;
		3930	reload_config;
		3931
		3932	cf::init_uuid;
		3933	cf::init_signals;
		3934	cf::init_skills;
		3935
		3936	cf::init_beforeplay;
		3937
		3938	atomic;
		3939
		3940	load_extensions;
		3941
		3942	utime time, time, $RUNTIMEFILE;
		3943
		3944	# no (long-running) fork's whatsoever before this point(!)
		3945	use POSIX ();
		3946	POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
		3947
		3948	cf::_post_init 0;
		3949	};
		3950
		3951	cf::object::thawer::errors_are_fatal 0;
		3952	info "parse errors in files are no longer fatal from this point on.\n";
		3953
		3954	AE::postpone {
		3955	undef &main; # free gobs of memory :)
		3956	};
		3957
		3958	goto &main_loop;
686	}	3959	}
687		3960
688	#############################################################################	3961	#############################################################################
689	# initialisation	3962	# initialisation and cleanup
690		3963
691	register "<global>", __PACKAGE__;	3964	# install some emergency cleanup handlers
692		3965	BEGIN {
693	unshift @INC, $LIBDIR;	3966	our %SIGWATCHER = ();
694		3967	for my $signal (qw(INT HUP TERM)) {
695	load_extensions;	3968	$SIGWATCHER{$signal} = AE::signal $signal, sub {
696		3969	cf::cleanup "SIG$signal";
697	$TICK_WATCHER = Event->timer (	3970	};
698	prio => 1,
699	at => $NEXT_TICK || 1,
700	cb => sub {
701	cf::server_tick; # one server iteration
702
703	my $NOW = Event::time;
704	$NEXT_TICK += $TICK;
705
706	# if we are delayed by four ticks, skip them all
707	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
708
709	$TICK_WATCHER->at ($NEXT_TICK);
710	$TICK_WATCHER->start;
711	},	3971	}
712	);	3972	}
		3973
		3974	sub write_runtime_sync {
		3975	my $t0 = AE::time;
		3976
		3977	# first touch the runtime file to show we are still running:
		3978	# the fsync below can take a very very long time.
		3979
		3980	IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
		3981
		3982	my $guard = cf::lock_acquire "write_runtime";
		3983
		3984	my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644
		3985	or return;
		3986
		3987	my $value = $cf::RUNTIME + 90 + 10;
		3988	# 10 is the runtime save interval, for a monotonic clock
		3989	# 60 allows for the watchdog to kill the server.
		3990
		3991	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3992	and return;
		3993
		3994	# always fsync - this file is important
		3995	aio_fsync $fh
		3996	and return;
		3997
		3998	# touch it again to show we are up-to-date
		3999	aio_utime $fh, undef, undef;
		4000
		4001	close $fh
		4002	or return;
		4003
		4004	aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
		4005	and return;
		4006
		4007	trace sprintf "runtime file written (%gs).\n", AE::time - $t0;
		4008
		4009	1
		4010	}
		4011
		4012	our $uuid_lock;
		4013	our $uuid_skip;
		4014
		4015	sub write_uuid_sync($) {
		4016	$uuid_skip ||= $_[0];
		4017
		4018	return if $uuid_lock;
		4019	local $uuid_lock = 1;
		4020
		4021	my $uuid = "$LOCALDIR/uuid";
		4022
		4023	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		4024	or return;
		4025
		4026	my $value = uuid_seq uuid_cur;
		4027
		4028	unless ($value) {
		4029	info "cowardly refusing to write zero uuid value!\n";
		4030	return;
		4031	}
		4032
		4033	my $value = uuid_str $value + $uuid_skip;
		4034	$uuid_skip = 0;
		4035
		4036	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		4037	and return;
		4038
		4039	# always fsync - this file is important
		4040	aio_fsync $fh
		4041	and return;
		4042
		4043	close $fh
		4044	or return;
		4045
		4046	aio_rename "$uuid~", $uuid
		4047	and return;
		4048
		4049	trace "uuid file written ($value).\n";
		4050
		4051	1
		4052
		4053	}
		4054
		4055	sub write_uuid($$) {
		4056	my ($skip, $sync) = @_;
		4057
		4058	$sync ? write_uuid_sync $skip
		4059	: async { write_uuid_sync $skip };
		4060	}
		4061
		4062	sub emergency_save() {
		4063	my $freeze_guard = cf::freeze_mainloop;
		4064
		4065	info "emergency_perl_save: enter\n";
		4066
		4067	# this is a trade-off: we want to be very quick here, so
		4068	# save all maps without fsync, and later call a global sync
		4069	# (which in turn might be very very slow)
		4070	local $USE_FSYNC = 0;
		4071
		4072	cf::sync_job {
		4073	cf::write_runtime_sync; # external watchdog should not bark
		4074
		4075	# use a peculiar iteration method to avoid tripping on perl
		4076	# refcount bugs in for. also avoids problems with players
		4077	# and maps saved/destroyed asynchronously.
		4078	info "emergency_perl_save: begin player save\n";
		4079	for my $login (keys %cf::PLAYER) {
		4080	my $pl = $cf::PLAYER{$login} or next;
		4081	$pl->valid or next;
		4082	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
		4083	$pl->save;
		4084	}
		4085	info "emergency_perl_save: end player save\n";
		4086
		4087	cf::write_runtime_sync; # external watchdog should not bark
		4088
		4089	info "emergency_perl_save: begin map save\n";
		4090	for my $path (keys %cf::MAP) {
		4091	my $map = $cf::MAP{$path} or next;
		4092	$map->valid or next;
		4093	$map->save;
		4094	}
		4095	info "emergency_perl_save: end map save\n";
		4096
		4097	cf::write_runtime_sync; # external watchdog should not bark
		4098
		4099	info "emergency_perl_save: begin database checkpoint\n";
		4100	BDB::db_env_txn_checkpoint $DB_ENV;
		4101	info "emergency_perl_save: end database checkpoint\n";
		4102
		4103	info "emergency_perl_save: begin write uuid\n";
		4104	write_uuid_sync 1;
		4105	info "emergency_perl_save: end write uuid\n";
		4106
		4107	cf::write_runtime_sync; # external watchdog should not bark
		4108
		4109	trace "emergency_perl_save: syncing database to disk";
		4110	BDB::db_env_txn_checkpoint $DB_ENV;
		4111
		4112	info "emergency_perl_save: starting sync\n";
		4113	IO::AIO::aio_sync sub {
		4114	info "emergency_perl_save: finished sync\n";
		4115	};
		4116
		4117	cf::write_runtime_sync; # external watchdog should not bark
		4118
		4119	trace "emergency_perl_save: flushing outstanding aio requests";
		4120	while (IO::AIO::nreqs || BDB::nreqs) {
		4121	Coro::AnyEvent::sleep 0.01; # let the sync_job do it's thing
		4122	}
		4123
		4124	cf::write_runtime_sync; # external watchdog should not bark
		4125	};
		4126
		4127	info "emergency_perl_save: leave\n";
		4128	}
		4129
		4130	sub post_cleanup {
		4131	my ($make_core) = @_;
		4132
		4133	IO::AIO::flush;
		4134
		4135	error Carp::longmess "post_cleanup backtrace"
		4136	if $make_core;
		4137
		4138	my $fh = pidfile;
		4139	unlink $PIDFILE if <$fh> == $$;
		4140	}
		4141
		4142	# a safer delete_package, copied from Symbol
		4143	sub clear_package($) {
		4144	my $pkg = shift;
		4145
		4146	# expand to full symbol table name if needed
		4147	unless ($pkg =~ /^main::.*::$/) {
		4148	$pkg = "main$pkg" if $pkg =~ /^::/;
		4149	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		4150	$pkg .= '::' unless $pkg =~ /::$/;
		4151	}
		4152
		4153	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		4154	my $stem_symtab = *{$stem}{HASH};
		4155
		4156	defined $stem_symtab and exists $stem_symtab->{$leaf}
		4157	or return;
		4158
		4159	# clear all symbols
		4160	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		4161	for my $name (keys %$leaf_symtab) {
		4162	_gv_clear *{"$pkg$name"};
		4163	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		4164	}
		4165	}
		4166
		4167	sub do_reload_perl() {
		4168	# can/must only be called in main
		4169	unless (in_main) {
		4170	error "can only reload from main coroutine";
		4171	return;
		4172	}
		4173
		4174	return if $RELOAD++;
		4175
		4176	my $t1 = AE::time;
		4177
		4178	while ($RELOAD) {
		4179	cf::get_slot 0.1, -1, "reload_perl";
		4180	info "perl_reload: reloading...";
		4181
		4182	trace "perl_reload: entering sync_job";
		4183
		4184	cf::sync_job {
		4185	#cf::emergency_save;
		4186
		4187	trace "perl_reload: cancelling all extension coros";
		4188	$_->cancel for values %EXT_CORO;
		4189	%EXT_CORO = ();
		4190
		4191	trace "perl_reload: removing commands";
		4192	%COMMAND = ();
		4193
		4194	trace "perl_reload: removing ext/exti commands";
		4195	%EXTCMD = ();
		4196	%EXTICMD = ();
		4197
		4198	trace "perl_reload: unloading/nuking all extensions";
		4199	for my $pkg (@EXTS) {
		4200	trace "... unloading $pkg";
		4201
		4202	if (my $cb = $pkg->can ("unload")) {
		4203	eval {
		4204	$cb->($pkg);
		4205	1
		4206	} or error "$pkg unloaded, but with errors: $@";
		4207	}
		4208
		4209	trace "... clearing $pkg";
		4210	clear_package $pkg;
		4211	}
		4212
		4213	trace "perl_reload: unloading all perl modules loaded from $LIBDIR";
		4214	while (my ($k, $v) = each %INC) {
		4215	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		4216
		4217	trace "... unloading $k";
		4218	delete $INC{$k};
		4219
		4220	$k =~ s/\.pm$//;
		4221	$k =~ s/\//::/g;
		4222
		4223	if (my $cb = $k->can ("unload_module")) {
		4224	$cb->();
		4225	}
		4226
		4227	clear_package $k;
		4228	}
		4229
		4230	trace "perl_reload: getting rid of safe::, as good as possible";
		4231	clear_package "safe::$_"
		4232	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
		4233
		4234	trace "perl_reload: unloading cf.pm \"a bit\"";
		4235	delete $INC{"cf.pm"};
		4236	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
		4237
		4238	# don't, removes xs symbols, too,
		4239	# and global variables created in xs
		4240	#clear_package __PACKAGE__;
		4241
		4242	info "perl_reload: unload completed, starting to reload now";
		4243
		4244	trace "perl_reload: reloading cf.pm";
		4245	require cf;
		4246	cf::_connect_to_perl_1;
		4247
		4248	trace "perl_reload: loading config and database again";
		4249	cf::reload_config;
		4250
		4251	trace "perl_reload: loading extensions";
		4252	cf::load_extensions;
		4253
		4254	if ($REATTACH_ON_RELOAD) {
		4255	trace "perl_reload: reattaching attachments to objects/players";
		4256	_global_reattach; # objects, sockets
		4257	trace "perl_reload: reattaching attachments to maps";
		4258	reattach $_ for values %MAP;
		4259	trace "perl_reload: reattaching attachments to players";
		4260	reattach $_ for values %PLAYER;
		4261	}
		4262
		4263	cf::_post_init 1;
		4264
		4265	trace "perl_reload: leaving sync_job";
		4266
		4267	1
		4268	} or do {
		4269	error $@;
		4270	cf::cleanup "perl_reload: error, exiting.";
		4271	};
		4272
		4273	--$RELOAD;
		4274	}
		4275
		4276	$t1 = AE::time - $t1;
		4277	info "perl_reload: completed in ${t1}s\n";
		4278	};
		4279
		4280	our $RELOAD_WATCHER; # used only during reload
		4281
		4282	sub reload_perl() {
		4283	# doing reload synchronously and two reloads happen back-to-back,
		4284	# coro crashes during coro_state_free->destroy here.
		4285
		4286	$RELOAD_WATCHER ||= cf::async {
		4287	Coro::AIO::aio_wait cache_extensions;
		4288
		4289	$RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub {
		4290	do_reload_perl;
		4291	undef $RELOAD_WATCHER;
		4292	};
		4293	};
		4294	}
		4295
		4296	register_command "reload" => sub {
		4297	my ($who, $arg) = @_;
		4298
		4299	if ($who->flag (FLAG_WIZ)) {
		4300	$who->message ("reloading server.");
		4301	async {
		4302	$Coro::current->{desc} = "perl_reload";
		4303	reload_perl;
		4304	};
		4305	}
		4306	};
		4307
		4308	#############################################################################
		4309
		4310	my $bug_warning = 0;
		4311
		4312	sub wait_for_tick() {
		4313	return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
		4314
		4315	$WAIT_FOR_TICK->wait;
		4316	}
		4317
		4318	sub wait_for_tick_begin() {
		4319	return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
		4320
		4321	my $signal = new Coro::Signal;
		4322	push @WAIT_FOR_TICK_BEGIN, $signal;
		4323	$signal->wait;
		4324	}
		4325
		4326	sub tick {
		4327	if ($Coro::current != $Coro::main) {
		4328	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		4329	unless ++$bug_warning > 10;
		4330	return;
		4331	}
		4332
		4333	cf::one_tick; # one server iteration
		4334
		4335	#for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
		4336
		4337	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		4338	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
		4339	Coro::async_pool {
		4340	$Coro::current->{desc} = "runtime saver";
		4341	write_runtime_sync
		4342	or error "ERROR: unable to write runtime file: $!";
		4343	};
		4344	}
		4345
		4346	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		4347	$sig->send;
		4348	}
		4349	$WAIT_FOR_TICK->broadcast;
		4350
		4351	$LOAD = ($NOW - $TICK_START) / $TICK;
		4352	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		4353
		4354	if (0) {
		4355	if ($NEXT_TICK) {
		4356	my $jitter = $TICK_START - $NEXT_TICK;
		4357	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		4358	debug "jitter $JITTER\n";#d#
		4359	}
		4360	}
		4361	}
		4362
		4363	{
		4364	# configure BDB
		4365	info "initialising database";
		4366
		4367	BDB::min_parallel 16;
		4368	BDB::max_poll_reqs $TICK * 0.1;
		4369	#$AnyEvent::BDB::WATCHER->priority (1);
		4370
		4371	unless ($DB_ENV) {
		4372	$DB_ENV = BDB::db_env_create;
		4373	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		4374	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		4375	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		4376	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		4377	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		4378
		4379	cf::sync_job {
		4380	eval {
		4381	BDB::db_env_open
		4382	$DB_ENV,
		4383	$BDBDIR,
		4384	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		4385	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		4386	0666;
		4387
		4388	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		4389	};
		4390
		4391	cf::cleanup "db_env_open(db): $@" if $@;
		4392	};
		4393	}
		4394
		4395	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		4396	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		4397	};
		4398	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		4399	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		4400	};
		4401	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		4402	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		4403	};
		4404
		4405	info "database initialised";
		4406	}
		4407
		4408	{
		4409	# configure IO::AIO
		4410
		4411	info "initialising aio";
		4412	IO::AIO::min_parallel 8;
		4413	IO::AIO::max_poll_time $TICK * 0.1;
		4414	undef $AnyEvent::AIO::WATCHER;
		4415	info "aio initialised";
		4416	}
		4417
		4418	our $_log_backtrace;
		4419	our $_log_backtrace_last;
		4420
		4421	sub _log_backtrace {
		4422	my ($msg, @addr) = @_;
		4423
		4424	$msg =~ s/\n$//;
		4425
		4426	if ($_log_backtrace_last eq $msg) {
		4427	LOG llevInfo, "[ABT] $msg\n";
		4428	LOG llevInfo, "[ABT] [duplicate, suppressed]\n";
		4429	# limit the # of concurrent backtraces
		4430	} elsif ($_log_backtrace < 2) {
		4431	$_log_backtrace_last = $msg;
		4432	++$_log_backtrace;
		4433	my $perl_bt = Carp::longmess $msg;
		4434	async {
		4435	$Coro::current->{desc} = "abt $msg";
		4436
		4437	my @bt = fork_call {
		4438	@addr = map { sprintf "%x", $_ } @addr;
		4439	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		4440	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		4441	or die "addr2line: $!";
		4442
		4443	my @funcs;
		4444	my @res = <$fh>;
		4445	chomp for @res;
		4446	while (@res) {
		4447	my ($func, $line) = splice @res, 0, 2, ();
		4448	push @funcs, "[$func] $line";
		4449	}
		4450
		4451	@funcs
		4452	};
		4453
		4454	LOG llevInfo, "[ABT] $perl_bt\n";
		4455	LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
		4456	LOG llevInfo, "[ABT] $_\n" for @bt;
		4457	--$_log_backtrace;
		4458	};
		4459	} else {
		4460	LOG llevInfo, "[ABT] $msg\n";
		4461	LOG llevInfo, "[ABT] [overload, suppressed]\n";
		4462	}
		4463	}
		4464
		4465	# load additional modules
		4466	require "cf/$_.pm" for @EXTRA_MODULES;
		4467	cf::_connect_to_perl_2;
		4468
		4469	END { cf::emergency_save }
713		4470
714	1	4471	1
715		4472

Diff Legend

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