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

Diff Legend

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