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

Diff Legend

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