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.88 by root, Fri Dec 15 19:29:18 2006 UTC vs.
Revision 1.490 by root, Sat Oct 24 06:16:40 2009 UTC

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

Diff Legend

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