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

Diff Legend

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