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.93 by root, Thu Dec 21 22:41:35 2006 UTC vs.
Revision 1.573 by root, Sun May 8 12:40:42 2011 UTC

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

Diff Legend

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