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.84 by root, Mon Dec 11 02:54:57 2006 UTC vs.
Revision 1.517 by root, Thu Apr 15 06:07:51 2010 UTC

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

Diff Legend

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