ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

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

Diff Legend

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