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

Diff Legend

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