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

Diff Legend

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