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

Diff Legend

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