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.71 by root, Sun Oct 1 10:59:30 2006 UTC vs.
Revision 1.436 by root, Sun Jun 15 20:32:51 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;
		54	use YAML ();
		55	use IO::AIO ();
10	use Time::HiRes;	56	use Time::HiRes;
11	use Event;	57	use Compress::LZF;
12	$Event::Eval = 1; # no idea why this is required, but it is	58	use Digest::MD5 ();
13		59
14	use strict;	60	AnyEvent::detect;
15		61
16	_init_vars;	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
17		67
		68	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
		69
		70	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		71
18	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
19	our @EVENT;	82	our @EVENT;
20	our $LIBDIR = maps_directory "perl";
21		83
22	our $TICK = MAX_TIME * 1e-6;	84	our $CONFDIR = confdir;
23	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
24	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;
25		106
26	our %CFG;	107	our %CFG;
27		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
28	#############################################################################	142	#############################################################################
29		143
30	=head2 GLOBAL VARIABLES	144	=head2 GLOBAL VARIABLES
31		145
32	=over 4	146	=over 4
33		147
34	=item $cf::LIBDIR	148	=item $cf::UPTIME
35		149
36	The perl library directory, where extensions and cf-specific modules can	150	The timestamp of the server start (so not actually an uptime).
37	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.
38		169
39	=item $cf::TICK	170	=item $cf::TICK
40		171
41	The interval between server ticks, in seconds.	172	The interval between server ticks, in seconds.
42		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
43	=item %cf::CFG	184	=item %cf::CFG
44		185
45	Configuration for the server, loaded from C</etc/crossfire/config>, or	186	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
46	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.
47		200
48	=back	201	=back
49		202
50	=cut	203	=cut
51		204
52	BEGIN {	205	BEGIN {
53	*CORE::GLOBAL::warn = sub {	206	*CORE::GLOBAL::warn = sub {
54	my $msg = join "", @_;	207	my $msg = join "", @_;
		208
55	$msg .= "\n"	209	$msg .= "\n"
56	unless $msg =~ /\n$/;	210	unless $msg =~ /\n$/;
57		211
58	print STDERR "cfperl: $msg";	212	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		213
59	LOG llevError, "cfperl: $msg";	214	LOG llevError, $msg;
60	};	215	};
61	}	216	}
62		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';
63	@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)
64		240
65	# 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
66	# within the Safe compartment.	242	# within the Safe compartment.
67	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	)) {
68	no strict 'refs';	250	no strict 'refs';
69	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	251	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
70	}	252	}
71		253
72	$Event::DIED = sub {	254	$EV::DIED = sub {
73	warn "error in event callback: @_";	255	warn "error in event callback: @_";
74	};	256	};
75		257
76	my %ext_pkg;	258	#############################################################################
77	my @exts;
78	my @hook;
79	my %command;
80	my %extcmd;
81		259
82	=head2 UTILITY FUNCTIONS	260	=head2 UTILITY FUNCTIONS
83		261
84	=over 4	262	=over 4
85		263
86	=cut	264	=item dumpval $ref
87		265
88	use JSON::Syck (); # TODO# replace by JSON::PC once working	266	=cut
89		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
90	=item $ref = cf::from_json $json	287	=item $ref = cf::decode_json $json
91		288
92	Converts a JSON string into the corresponding perl data structure.	289	Converts a JSON string into the corresponding perl data structure.
93		290
94	=cut
95
96	sub from_json($) {
97	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
98	JSON::Syck::Load $_[0]
99	}
100
101	=item $json = cf::to_json $ref	291	=item $json = cf::encode_json $ref
102		292
103	Converts a perl data structure into its JSON representation.	293	Converts a perl data structure into its JSON representation.
104		294
105	=cut	295	=cut
106		296
107	sub to_json($) {	297	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
108	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	298
109	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 });
110	}	720	}
111		721
112	=back	722	=back
113		723
114	=cut	724	=cut
115		725
116	#############################################################################	726	#############################################################################
117		727
118	=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).
119		737
120	=over 4	738	=over 4
121		739
122	=item $object->attach ($attachment, key => $value...)
123
124	=item $object->detach ($attachment)
125
126	Attach/detach a pre-registered attachment to an object.
127
128	=item $player->attach ($attachment, key => $value...)
129
130	=item $player->detach ($attachment)
131
132	Attach/detach a pre-registered attachment to a player.
133
134	=item $map->attach ($attachment, key => $value...)	740	=item $attachable->attach ($attachment, key => $value...)
135		741
136	=item $map->detach ($attachment)	742	=item $attachable->detach ($attachment)
137		743
138	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.
139		746
140	=item $bool = $object->attached ($name)	747	Example, attach a minesweeper attachment to the given object, making it a
		748	10x10 minesweeper game:
141		749
142	=item $bool = $player->attached ($name)	750	$obj->attach (minesweeper => width => 10, height => 10);
143		751
144	=item $bool = $map->attached ($name)	752	=item $bool = $attachable->attached ($name)
145		753
146	Checks wether the named attachment is currently attached to the object.	754	Checks wether the named attachment is currently attached to the object.
147		755
148	=item cf::attach_global ...	756	=item cf::CLASS->attach ...
149		757
150	Attach handlers for global events.	758	=item cf::CLASS->detach ...
151		759
152	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
153	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:
154		794
155	=over 4	795	=over 4
156		796
157	=item prio => $number	797	=item prio => $number
158		798
…		…
160	by another C<prio> setting). Lower priority handlers get executed	800	by another C<prio> setting). Lower priority handlers get executed
161	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
162	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
163	unless you know what you are doing.	803	unless you know what you are doing.
164		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
165	=item on_I<event> => \&cb	811	=item on_I<event> => \&cb
166		812
167	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
168	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
169	handlers are recognised generally depends on the type of object these	815	handlers are recognised generally depends on the type of object these
…		…
178	package and register them. Only handlers for eevents supported by the	824	package and register them. Only handlers for eevents supported by the
179	object/class are recognised.	825	object/class are recognised.
180		826
181	=back	827	=back
182		828
183	=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:
184		831
185	Attach handlers for a specific object type (e.g. TRANSPORT) and	832	cf::object::attachment sockpuppet =>
186	subtype. If C<$subtype> is zero or undef, matches all objects of the given	833	on_skill_attack => sub {
187	type.	834	my ($self, $victim) = @_;
188		835	...
189	=item cf::attach_to_objects ...
190
191	Attach handlers to all objects. Do not use this except for debugging or
192	very rare events, as handlers are (obviously) called for I<all> objects in
193	the game.
194
195	=item cf::attach_to_players ...
196
197	Attach handlers to all players.
198
199	=item cf::attach_to_maps ...
200
201	Attach handlers to all maps.
202
203	=item cf:register_attachment $name, ...
204
205	Register an attachment by name through which objects can refer to this
206	attachment.
207
208	=item cf:register_player_attachment $name, ...
209
210	Register an attachment by name through which players can refer to this
211	attachment.
212
213	=item cf:register_map_attachment $name, ...
214
215	Register an attachment by name through which maps can refer to this
216	attachment.
217
218	=cut
219
220	# the following variables are defined in .xs and must not be re-created
221	our @CB_GLOBAL = (); # registry for all global events
222	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
223	our @CB_PLAYER = ();
224	our @CB_TYPE = (); # registry for type (cf-object class) based events
225	our @CB_MAP = ();
226
227	my %attachment;
228
229	sub _attach_cb($\%$$$) {
230	my ($registry, $undo, $event, $prio, $cb) = @_;
231
232	use sort 'stable';
233
234	$cb = [$prio, $cb];
235
236	@{$registry->[$event]} = sort
237	{ $a->[0] cmp $b->[0] }
238	@{$registry->[$event] || []}, $cb;
239
240	push @{$undo->{cb}}, [$event, $cb];
241	}
242
243	# attach handles attaching event callbacks
244	# the only thing the caller has to do is pass the correct
245	# registry (== where the callback attaches to).
246	sub _attach(\@$@) {
247	my ($registry, $klass, @arg) = @_;
248
249	my $prio = 0;
250
251	my %undo = (
252	registry => $registry,
253	cb => [],
254	);
255
256	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
257
258	while (@arg) {
259	my $type = shift @arg;
260
261	if ($type eq "prio") {
262	$prio = shift @arg;
263
264	} elsif ($type eq "package") {
265	my $pkg = shift @arg;
266
267	while (my ($name, $id) = each %cb_id) {
268	if (my $cb = $pkg->can ($name)) {
269	_attach_cb $registry, %undo, $id, $prio, $cb;
270	}
271	}	836	}
272
273	} elsif (exists $cb_id{$type}) {
274	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
275
276	} elsif (ref $type) {
277	warn "attaching objects not supported, ignoring.\n";
278
279	} else {
280	shift @arg;
281	warn "attach argument '$type' not supported, ignoring.\n";
282	}
283	}
284
285	\%undo
286	}
287
288	sub _attach_attachment {
289	my ($obj, $name, %arg) = @_;
290
291	return if exists $obj->{_attachment}{$name};
292
293	my $res;
294
295	if (my $attach = $attachment{$name}) {
296	my $registry = $obj->registry;
297
298	for (@$attach) {
299	my ($klass, @attach) = @$_;
300	$res = _attach @$registry, $klass, @attach;
301	}
302
303	$obj->{$name} = \%arg;
304	} else {
305	warn "object uses attachment '$name' that is not available, postponing.\n";
306	}
307
308	$obj->{_attachment}{$name} = undef;
309
310	$res->{attachment} = $name;
311	$res
312	}
313
314	*cf::object::attach =
315	*cf::player::attach =
316	*cf::map::attach = sub {
317	my ($obj, $name, %arg) = @_;
318
319	_attach_attachment $obj, $name, %arg;
320	};
321
322	# all those should be optimised
323	*cf::object::detach =
324	*cf::player::detach =
325	*cf::map::detach = sub {
326	my ($obj, $name) = @_;
327
328	delete $obj->{_attachment}{$name};
329	reattach ($obj);
330	};
331
332	*cf::object::attached =
333	*cf::player::attached =
334	*cf::map::attached = sub {
335	my ($obj, $name) = @_;
336
337	exists $obj->{_attachment}{$name}
338	};
339
340	sub attach_global {
341	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
342	}
343
344	sub attach_to_type {
345	my $type = shift;
346	my $subtype = shift;
347
348	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
349	}
350
351	sub attach_to_objects {
352	_attach @CB_OBJECT, KLASS_OBJECT, @_
353	}
354
355	sub attach_to_players {
356	_attach @CB_PLAYER, KLASS_PLAYER, @_
357	}
358
359	sub attach_to_maps {
360	_attach @CB_MAP, KLASS_MAP, @_
361	}
362
363	sub register_attachment {
364	my $name = shift;
365
366	$attachment{$name} = [[KLASS_OBJECT, @_]];
367	}
368
369	sub register_player_attachment {
370	my $name = shift;
371
372	$attachment{$name} = [[KLASS_PLAYER, @_]];
373	}
374
375	sub register_map_attachment {
376	my $name = shift;
377
378	$attachment{$name} = [[KLASS_MAP, @_]];
379	}
380
381	our $override;
382	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
383
384	sub override {
385	$override = 1;
386	@invoke_results = ();
387	}
388
389	sub do_invoke {
390	my $event = shift;
391	my $callbacks = shift;
392
393	@invoke_results = ();
394
395	local $override;
396
397	for (@$callbacks) {
398	eval { &{$_->[1]} };
399
400	if ($@) {
401	warn "$@";
402	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
403	override;
404	}
405
406	return 1 if $override;
407	}
408
409	0	837	}
410	}
411		838
412	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	839	=item $attachable->valid
413
414	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
415
416	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
417
418	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
419
420	Generate a global/object/player/map-specific event with the given arguments.
421
422	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
423	removed in future versions), and there is no public API to access override
424	results (if you must, access C<@cf::invoke_results> directly).
425
426	=back
427
428	=cut
429
430	#############################################################################
431
432	=head2 METHODS VALID FOR ALL CORE OBJECTS
433
434	=over 4
435
436	=item $object->valid, $player->valid, $map->valid
437		840
438	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
439	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
440	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
441	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
442	exception.	845	exception.
443		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
444	=back	1038	=back
445		1039
446	=cut	1040	=cut
447
448	*cf::object::valid =
449	*cf::player::valid =
450	*cf::map::valid = \&cf::_valid;
451		1041
452	#############################################################################	1042	#############################################################################
453	# object support	1043	# object support
454		1044
455	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 {
456	my ($obj, $data) = @_;	1079	my ($ob1, $ob2) = @_;
457		1080
458	$data = from_json $data;	1081	++$SLOW_MERGES;#d#
459		1082
460	for (@$data) {	1083	# we do the slow way here
461	my ($name, $args) = @$_;	1084	return _object_equal $ob1, $ob2
462
463	$obj->attach ($name, %{$args || {} });
464	}
465	}	1085	}
466		1086
467	# basically do the same as instantiate, without calling instantiate
468	sub reattach {	1087	sub reattach {
		1088	# basically do the same as instantiate, without calling instantiate
469	my ($obj) = @_;	1089	my ($obj) = @_;
		1090
		1091	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
		1092
470	my $registry = $obj->registry;	1093	my $registry = $obj->registry;
471		1094
472	@$registry = ();	1095	@$registry = ();
473		1096
474	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	1097	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
475		1098
476	for my $name (keys %{ $obj->{_attachment} || {} }) {	1099	for my $name (keys %{ $obj->{_attachment} || {} }) {
477	if (my $attach = $attachment{$name}) {	1100	if (my $attach = $attachment{$name}) {
478	for (@$attach) {	1101	for (@$attach) {
479	my ($klass, @attach) = @$_;	1102	my ($klass, @attach) = @$_;
480	_attach @$registry, $klass, @attach;	1103	_attach $registry, $klass, @attach;
481	}	1104	}
482	} else {	1105	} else {
483	warn "object uses attachment '$name' that is not available, postponing.\n";	1106	warn "object uses attachment '$name' that is not available, postponing.\n";
484	}	1107	}
485	}	1108	}
486	}	1109	}
487		1110
488	sub object_freezer_save {	1111	cf::attachable->attach (
489	my ($filename, $rdata, $objs) = @_;
490
491	if (length $$rdata) {
492	warn sprintf "saving %s (%d,%d)\n",
493	$filename, length $$rdata, scalar @$objs;
494
495	if (open my $fh, ">:raw", "$filename~") {
496	chmod SAVE_MODE, $fh;
497	syswrite $fh, $$rdata;
498	close $fh;
499
500	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
501	chmod SAVE_MODE, $fh;
502	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
503	close $fh;
504	rename "$filename.pst~", "$filename.pst";
505	} else {
506	unlink "$filename.pst";
507	}
508
509	rename "$filename~", $filename;
510	} else {
511	warn "FATAL: $filename~: $!\n";
512	}
513	} else {
514	unlink $filename;
515	unlink "$filename.pst";
516	}
517	}
518
519	sub object_thawer_load {
520	my ($filename) = @_;
521
522	local $/;
523
524	my $av;
525
526	#TODO: use sysread etc.
527	if (open my $data, "<:raw:perlio", $filename) {
528	$data = <$data>;
529	if (open my $pst, "<:raw:perlio", "$filename.pst") {
530	$av = eval { (Storable::thaw <$pst>)->{objs} };
531	}
532	return ($data, $av);
533	}
534
535	()
536	}
537
538	attach_to_objects
539	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,
540	on_clone => sub {	1125	on_clone => sub {
541	my ($src, $dst) = @_;	1126	my ($src, $dst) = @_;
542		1127
543	@{$dst->registry} = @{$src->registry};	1128	@{$dst->registry} = @{$src->registry};
544		1129
545	%$dst = %$src;	1130	%$dst = %$src;
546		1131
547	%{$dst->{_attachment}} = %{$src->{_attachment}}	1132	%{$dst->{_attachment}} = %{$src->{_attachment}}
548	if exists $src->{_attachment};	1133	if exists $src->{_attachment};
549	},	1134	},
550	;	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
551		1212
552	#############################################################################	1213	#############################################################################
553	# old plug-in events	1214	# command handling &c
554		1215
555	sub inject_event {	1216	=item cf::register_command $name => \&callback($ob,$args);
556	my $extension = shift;
557	my $event_code = shift;
558		1217
559	my $cb = $hook[$event_code]{$extension}	1218	Register a callback for execution when the client sends the user command
560	or return;	1219	$name.
561		1220
562	&$cb	1221	=cut
563	}
564
565	sub inject_global_event {
566	my $event = shift;
567
568	my $cb = $hook[$event]
569	or return;
570
571	List::Util::max map &$_, values %$cb
572	}
573
574	sub inject_command {
575	my ($name, $obj, $params) = @_;
576
577	for my $cmd (@{ $command{$name} }) {
578	$cmd->[1]->($obj, $params);
579	}
580
581	-1
582	}
583		1222
584	sub register_command {	1223	sub register_command {
585	my ($name, $time, $cb) = @_;	1224	my ($name, $cb) = @_;
586		1225
587	my $caller = caller;	1226	my $caller = caller;
588	#warn "registering command '$name/$time' to '$caller'";	1227	#warn "registering command '$name/$time' to '$caller'";
589		1228
590	push @{ $command{$name} }, [$time, $cb, $caller];	1229	push @{ $COMMAND{$name} }, [$caller, $cb];
591	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
592	}	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
593		1255
594	sub register_extcmd {	1256	sub register_extcmd {
595	my ($name, $cb) = @_;	1257	my ($name, $cb) = @_;
596		1258
597	my $caller = caller;	1259	$EXTCMD{$name} = $cb;
598	#warn "registering extcmd '$name' to '$caller'";
599
600	$extcmd{$name} = [$cb, $caller];
601	}	1260	}
602		1261
603	sub register {	1262	sub register_exticmd {
604	my ($base, $pkg) = @_;	1263	my ($name, $cb) = @_;
605		1264
606	#TODO	1265	$EXTICMD{$name} = $cb;
607	}	1266	}
608		1267
609	sub load_extension {	1268	cf::player->attach (
610	my ($path) = @_;	1269	on_command => sub {
		1270	my ($pl, $name, $params) = @_;
611		1271
612	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1272	my $cb = $COMMAND{$name}
613	my $base = $1;	1273	or return;
614	my $pkg = $1;
615	$pkg =~ s/[^[:word:]]/_/g;
616	$pkg = "ext::$pkg";
617		1274
618	warn "loading '$path' into '$pkg'\n";	1275	for my $cmd (@$cb) {
619		1276	$cmd->[1]->($pl->ob, $params);
620	open my $fh, "<:utf8", $path
621	or die "$path: $!";
622
623	my $source =
624	"package $pkg; use strict; use utf8;\n"
625	. "#line 1 \"$path\"\n{\n"
626	. (do { local $/; <$fh> })
627	. "\n};\n1";
628
629	eval $source
630	or die "$path: $@";
631
632	push @exts, $pkg;
633	$ext_pkg{$base} = $pkg;
634
635	# no strict 'refs';
636	# @{"$pkg\::ISA"} = ext::;
637
638	register $base, $pkg;
639	}
640
641	sub unload_extension {
642	my ($pkg) = @_;
643
644	warn "removing extension $pkg\n";
645
646	# remove hooks
647	#TODO
648	# for my $idx (0 .. $#PLUGIN_EVENT) {
649	# delete $hook[$idx]{$pkg};
650	# }
651
652	# remove commands
653	for my $name (keys %command) {
654	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
655
656	if (@cb) {
657	$command{$name} = \@cb;
658	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
659	} else {
660	delete $command{$name};
661	delete $COMMAND{"$name\000"};
662	}	1277	}
		1278
		1279	cf::override;
663	}	1280	},
664
665	# remove extcmds
666	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
667	delete $extcmd{$name};
668	}
669
670	if (my $cb = $pkg->can ("unload")) {
671	eval {
672	$cb->($pkg);
673	1
674	} or warn "$pkg unloaded, but with errors: $@";
675	}
676
677	Symbol::delete_package $pkg;
678	}
679
680	sub load_extensions {
681	my $LIBDIR = maps_directory "perl";
682
683	for my $ext (<$LIBDIR/*.ext>) {
684	next unless -r $ext;
685	eval {
686	load_extension $ext;
687	1
688	} or warn "$ext not loaded: $@";
689	}
690	}
691
692	#############################################################################
693	# extcmd framework, basically convert ext <msg>
694	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
695
696	attach_to_players
697	on_extcmd => sub {	1281	on_extcmd => sub {
698	my ($pl, $buf) = @_;	1282	my ($pl, $buf) = @_;
699		1283
700	my $msg = eval { from_json $buf };	1284	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
701		1285
702	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
703	if (my $cb = $extcmd{$msg->{msgtype}}) {	1294	if (my $cb = $EXTCMD{$type}) {
704	if (my %reply = $cb->[0]->($pl, $msg)) {	1295	@reply = $cb->($pl, @payload);
705	$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;
706	}	2101	}
707	}	2102	}
708	} else {
709	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
710	}	2103	}
711		2104
712	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);
713	},	2128	}
714	;
715		2129
716	#############################################################################	2130	$self->post_load;
717	# load/save/clean perl data associated with a map	2131	}
718		2132
719	*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 {
720	my ($map) = @_;	2147	my ($map) = @_;
721		2148
722	my $path = $map->tmpname;	2149	my @neigh; # diagonal neighbours
723	defined $path or return;
724		2150
725	unlink "$path.pst";	2151	for (0 .. 3) {
726	};	2152	my $neigh = $map->tile_path ($_)
		2153	or next;
		2154	$neigh = find $neigh, $map
		2155	or next;
		2156	$neigh->load;
727		2157
728	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	}
729		2162
730	#############################################################################	2163	for (grep defined $_->[0], @neigh) {
731	# load/save perl data associated with player->ob objects	2164	my ($path, $origin) = @$_;
732		2165	my $neigh = find $path, $origin
733	sub all_objects(@) {	2166	or next;
734	@_, map all_objects ($_->inv), @_	2167	$neigh->load;
		2168	}
735	}	2169	}
736		2170
737	# TODO: compatibility cruft, remove when no longer needed	2171	sub find_sync {
738	attach_to_players	2172	my ($path, $origin) = @_;
739	on_load => sub {
740	my ($pl, $path) = @_;
741		2173
742	for my $o (all_objects $pl->ob) {	2174	cf::sync_job { find $path, $origin }
743	if (my $value = $o->get_ob_key_value ("_perl_data")) {	2175	}
744	$o->set_ob_key_value ("_perl_data");
745		2176
746	%$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};
747	}	2210	}
748	}	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);
749	},	2249	}
750	;	2250	}
751		2251
752	#############################################################################	2252	sub swap_out {
		2253	my ($self) = @_;
753		2254
754	=head2 CORE EXTENSIONS	2255	# save first because save cedes
		2256	$self->save;
755		2257
756	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;
757		2404
758	=over 4	2405	=over 4
759		2406
760	=item cf::player::exists $login	2407	=item $ob->inv_recursive
761		2408
762	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.
763		2411
764	=cut	2412	=cut
765		2413
766	sub cf::player::exists($) {	2414	sub inv_recursive_;
767	cf::player::find $_[0]	2415	sub inv_recursive_ {
768	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	2416	map { $_, inv_recursive_ $_->inv } @_
769	}	2417	}
770		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
771	=item $player->reply ($npc, $msg[, $flags])	2459	=item $player_object->reply ($npc, $msg[, $flags])
772		2460
773	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>
774	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
775	dialogue with the given NPC character.	2463	dialogue with the given NPC character.
776		2464
777	=cut	2465	=cut
778		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
779	# rough implementation of a future "reply" method that works	2481	# rough implementation of a future "reply" method that works
780	# with dialog boxes.	2482	# with dialog boxes.
		2483	#TODO: the first argument must go, split into a $npc->reply_to ( method
781	sub cf::object::player::reply($$$;$) {	2484	sub cf::object::player::reply($$$;$) {
782	my ($self, $npc, $msg, $flags) = @_;	2485	my ($self, $npc, $msg, $flags) = @_;
783		2486
784	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2487	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
785		2488
786	if ($self->{record_replies}) {	2489	if ($self->{record_replies}) {
787	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2490	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2491
788	} 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 {
789	$msg = $npc->name . " says: $msg" if $npc;	2500	$msg = $npc->name . " says: $msg" if $npc;
790	$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	Note that $check will be called with a potentially non-loaded map, so if
		2620	it needs a loaded map it has to call C<< ->load >>.
		2621
		2622	=cut
		2623
		2624	our $GOTOGEN;
		2625
		2626	sub cf::object::player::goto {
		2627	my ($self, $path, $x, $y, $check, $done) = @_;
		2628
		2629	# do generation counting so two concurrent goto's will be executed in-order
		2630	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
		2631
		2632	$self->enter_link;
		2633
		2634	(async {
		2635	$Coro::current->{desc} = "player::goto $path $x $y";
		2636
		2637	# *tag paths override both path and x|y
		2638	if ($path =~ /^\*(.*)$/) {
		2639	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2640	my $ob = $obs[rand @obs];
		2641
		2642	# see if we actually can go there
		2643	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2644	$ob = $obs[rand @obs];
		2645	} else {
		2646	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2647	}
		2648	# else put us there anyways for now #d#
		2649
		2650	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2651	} else {
		2652	($path, $x, $y) = (undef, undef, undef);
		2653	}
		2654	}
		2655
		2656	my $map = eval {
		2657	my $map = defined $path ? cf::map::find $path : undef;
		2658
		2659	if ($map) {
		2660	$map = $map->customise_for ($self);
		2661	$map = $check->($map) if $check && $map;
		2662	} else {
		2663	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2664	}
		2665
		2666	$map
		2667	};
		2668
		2669	if ($@) {
		2670	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2671	LOG llevError | logBacktrace, Carp::longmess $@;
		2672	}
		2673
		2674	if ($gen == $self->{_goto_generation}) {
		2675	delete $self->{_goto_generation};
		2676	$self->leave_link ($map, $x, $y);
		2677	}
		2678
		2679	$done->() if $done;
		2680	})->prio (1);
		2681	}
		2682
		2683	=item $player_object->enter_exit ($exit_object)
		2684
		2685	=cut
		2686
		2687	sub parse_random_map_params {
		2688	my ($spec) = @_;
		2689
		2690	my $rmp = { # defaults
		2691	xsize => (cf::rndm 15, 40),
		2692	ysize => (cf::rndm 15, 40),
		2693	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2694	#layout => string,
791	}	2695	};
792	}
793		2696
		2697	for (split /\n/, $spec) {
		2698	my ($k, $v) = split /\s+/, $_, 2;
		2699
		2700	$rmp->{lc $k} = $v if (length $k) && (length $v);
		2701	}
		2702
		2703	$rmp
		2704	}
		2705
		2706	sub prepare_random_map {
		2707	my ($exit) = @_;
		2708
		2709	# all this does is basically replace the /! path by
		2710	# a new random map path (?random/...) with a seed
		2711	# that depends on the exit object
		2712
		2713	my $rmp = parse_random_map_params $exit->msg;
		2714
		2715	if ($exit->map) {
		2716	$rmp->{region} = $exit->region->name;
		2717	$rmp->{origin_map} = $exit->map->path;
		2718	$rmp->{origin_x} = $exit->x;
		2719	$rmp->{origin_y} = $exit->y;
		2720
		2721	$exit->map->touch;
		2722	}
		2723
		2724	$rmp->{random_seed} ||= $exit->random_seed;
		2725
		2726	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
		2727	my $md5 = Digest::MD5::md5_hex $data;
		2728	my $meta = "$RANDOMDIR/$md5.meta";
		2729
		2730	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		2731	aio_write $fh, 0, (length $data), $data, 0;
		2732	undef $fh;
		2733	aio_rename "$meta~", $meta;
		2734
		2735	my $slaying = "?random/$md5";
		2736
		2737	if ($exit->valid) {
		2738	$exit->slaying ("?random/$md5");
		2739	$exit->msg (undef);
		2740	}
		2741	}
		2742	}
		2743
		2744	sub cf::object::player::enter_exit {
		2745	my ($self, $exit) = @_;
		2746
		2747	return unless $self->type == cf::PLAYER;
		2748
		2749	$self->enter_link;
		2750
		2751	(async {
		2752	$Coro::current->{desc} = "enter_exit";
		2753
		2754	unless (eval {
		2755	$self->deactivate_recursive; # just to be sure
		2756
		2757	# random map handling
		2758	{
		2759	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2760
		2761	prepare_random_map $exit
		2762	if $exit->slaying eq "/!";
		2763	}
		2764
		2765	my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2766	my $x = $exit->stats->hp;
		2767	my $y = $exit->stats->sp;
		2768
		2769	$self->goto ($map, $x, $y);
		2770
		2771	# if exit is damned, update players death & WoR home-position
		2772	$self->contr->savebed ($map, $x, $y)
		2773	if $exit->flag (cf::FLAG_DAMNED);
		2774
		2775	1
		2776	}) {
		2777	$self->message ("Something went wrong deep within the crossfire server. "
		2778	. "I'll try to bring you back to the map you were before. "
		2779	. "Please report this to the dungeon master!",
		2780	cf::NDI_UNIQUE | cf::NDI_RED);
		2781
		2782	warn "ERROR in enter_exit: $@";
		2783	$self->leave_link;
		2784	}
		2785	})->prio (1);
		2786	}
		2787
		2788	=head3 cf::client
		2789
		2790	=over 4
		2791
		2792	=item $client->send_drawinfo ($text, $flags)
		2793
		2794	Sends a drawinfo packet to the client. Circumvents output buffering so
		2795	should not be used under normal circumstances.
		2796
		2797	=cut
		2798
		2799	sub cf::client::send_drawinfo {
		2800	my ($self, $text, $flags) = @_;
		2801
		2802	utf8::encode $text;
		2803	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
		2804	}
		2805
		2806	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2807
		2808	Send a drawinfo or msg packet to the client, formatting the msg for the
		2809	client if neccessary. C<$type> should be a string identifying the type of
		2810	the message, with C<log> being the default. If C<$color> is negative, suppress
		2811	the message unless the client supports the msg packet.
		2812
		2813	=cut
		2814
		2815	# non-persistent channels (usually the info channel)
		2816	our %CHANNEL = (
		2817	"c/identify" => {
		2818	id => "infobox",
		2819	title => "Identify",
		2820	reply => undef,
		2821	tooltip => "Items recently identified",
		2822	},
		2823	"c/examine" => {
		2824	id => "infobox",
		2825	title => "Examine",
		2826	reply => undef,
		2827	tooltip => "Signs and other items you examined",
		2828	},
		2829	"c/book" => {
		2830	id => "infobox",
		2831	title => "Book",
		2832	reply => undef,
		2833	tooltip => "The contents of a note or book",
		2834	},
		2835	"c/lookat" => {
		2836	id => "infobox",
		2837	title => "Look",
		2838	reply => undef,
		2839	tooltip => "What you saw there",
		2840	},
		2841	"c/who" => {
		2842	id => "infobox",
		2843	title => "Players",
		2844	reply => undef,
		2845	tooltip => "Shows players who are currently online",
		2846	},
		2847	"c/body" => {
		2848	id => "infobox",
		2849	title => "Body Parts",
		2850	reply => undef,
		2851	tooltip => "Shows which body parts you posess and are available",
		2852	},
		2853	"c/uptime" => {
		2854	id => "infobox",
		2855	title => "Uptime",
		2856	reply => undef,
		2857	tooltip => "How long the server has been running since last restart",
		2858	},
		2859	"c/mapinfo" => {
		2860	id => "infobox",
		2861	title => "Map Info",
		2862	reply => undef,
		2863	tooltip => "Information related to the maps",
		2864	},
		2865	"c/party" => {
		2866	id => "party",
		2867	title => "Party",
		2868	reply => "gsay ",
		2869	tooltip => "Messages and chat related to your party",
		2870	},
		2871	);
		2872
		2873	sub cf::client::send_msg {
		2874	my ($self, $channel, $msg, $color, @extra) = @_;
		2875
		2876	$msg = $self->pl->expand_cfpod ($msg);
		2877
		2878	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2879
		2880	# check predefined channels, for the benefit of C
		2881	if ($CHANNEL{$channel}) {
		2882	$channel = $CHANNEL{$channel};
		2883
		2884	$self->ext_msg (channel_info => $channel)
		2885	if $self->can_msg;
		2886
		2887	$channel = $channel->{id};
		2888
		2889	} elsif (ref $channel) {
		2890	# send meta info to client, if not yet sent
		2891	unless (exists $self->{channel}{$channel->{id}}) {
		2892	$self->{channel}{$channel->{id}} = $channel;
		2893	$self->ext_msg (channel_info => $channel)
		2894	if $self->can_msg;
		2895	}
		2896
		2897	$channel = $channel->{id};
		2898	}
		2899
		2900	return unless @extra || length $msg;
		2901
		2902	if ($self->can_msg) {
		2903	# default colour, mask it out
		2904	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2905	if $color & cf::NDI_DEF;
		2906
		2907	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2908	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2909	} else {
		2910	if ($color >= 0) {
		2911	# replace some tags by gcfclient-compatible ones
		2912	for ($msg) {
		2913	1 while
		2914	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2915	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2916	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2917	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2918	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2919	}
		2920
		2921	$color &= cf::NDI_COLOR_MASK;
		2922
		2923	utf8::encode $msg;
		2924
		2925	if (0 && $msg =~ /\[/) {
		2926	# COMMAND/INFO
		2927	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2928	} else {
		2929	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2930	$self->send_packet ("drawinfo $color $msg")
		2931	}
		2932	}
		2933	}
		2934	}
		2935
		2936	=item $client->ext_msg ($type, @msg)
		2937
		2938	Sends an ext event to the client.
		2939
		2940	=cut
		2941
		2942	sub cf::client::ext_msg($$@) {
		2943	my ($self, $type, @msg) = @_;
		2944
		2945	if ($self->extcmd == 2) {
		2946	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2947	} elsif ($self->extcmd == 1) { # TODO: remove
		2948	push @msg, msgtype => "event_$type";
		2949	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2950	}
		2951	}
		2952
794	=item $player->ext_reply ($msgid, $msgtype, %msg)	2953	=item $client->ext_reply ($msgid, @msg)
795		2954
796	Sends an ext reply to the player.	2955	Sends an ext reply to the client.
797		2956
798	=cut	2957	=cut
799		2958
800	sub cf::player::ext_reply($$$%) {	2959	sub cf::client::ext_reply($$@) {
801	my ($self, $id, %msg) = @_;	2960	my ($self, $id, @msg) = @_;
802		2961
803	$msg{msgid} = $id;	2962	if ($self->extcmd == 2) {
804		2963	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
805	$self->send ("ext " . to_json \%msg);	2964	} elsif ($self->extcmd == 1) {
		2965	#TODO: version 1, remove
		2966	unshift @msg, msgtype => "reply", msgid => $id;
		2967	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2968	}
806	}	2969	}
		2970
		2971	=item $success = $client->query ($flags, "text", \&cb)
		2972
		2973	Queues a query to the client, calling the given callback with
		2974	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		2975	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		2976
		2977	Queries can fail, so check the return code. Or don't, as queries will
		2978	become reliable at some point in the future.
		2979
		2980	=cut
		2981
		2982	sub cf::client::query {
		2983	my ($self, $flags, $text, $cb) = @_;
		2984
		2985	return unless $self->state == ST_PLAYING
		2986	|| $self->state == ST_SETUP
		2987	|| $self->state == ST_CUSTOM;
		2988
		2989	$self->state (ST_CUSTOM);
		2990
		2991	utf8::encode $text;
		2992	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		2993
		2994	$self->send_packet ($self->{query_queue}[0][0])
		2995	if @{ $self->{query_queue} } == 1;
		2996
		2997	1
		2998	}
		2999
		3000	cf::client->attach (
		3001	on_connect => sub {
		3002	my ($ns) = @_;
		3003
		3004	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		3005	},
		3006	on_reply => sub {
		3007	my ($ns, $msg) = @_;
		3008
		3009	# this weird shuffling is so that direct followup queries
		3010	# get handled first
		3011	my $queue = delete $ns->{query_queue}
		3012	or return; # be conservative, not sure how that can happen, but we saw a crash here
		3013
		3014	(shift @$queue)->[1]->($msg);
		3015	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
		3016
		3017	push @{ $ns->{query_queue} }, @$queue;
		3018
		3019	if (@{ $ns->{query_queue} } == @$queue) {
		3020	if (@$queue) {
		3021	$ns->send_packet ($ns->{query_queue}[0][0]);
		3022	} else {
		3023	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		3024	}
		3025	}
		3026	},
		3027	on_exticmd => sub {
		3028	my ($ns, $buf) = @_;
		3029
		3030	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		3031
		3032	if (ref $msg) {
		3033	my ($type, $reply, @payload) =
		3034	"ARRAY" eq ref $msg
		3035	? @$msg
		3036	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		3037
		3038	my @reply;
		3039
		3040	if (my $cb = $EXTICMD{$type}) {
		3041	@reply = $cb->($ns, @payload);
		3042	}
		3043
		3044	$ns->ext_reply ($reply, @reply)
		3045	if $reply;
		3046
		3047	} else {
		3048	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		3049	}
		3050
		3051	cf::override;
		3052	},
		3053	);
		3054
		3055	=item $client->async (\&cb)
		3056
		3057	Create a new coroutine, running the specified callback. The coroutine will
		3058	be automatically cancelled when the client gets destroyed (e.g. on logout,
		3059	or loss of connection).
		3060
		3061	=cut
		3062
		3063	sub cf::client::async {
		3064	my ($self, $cb) = @_;
		3065
		3066	my $coro = &Coro::async ($cb);
		3067
		3068	$coro->on_destroy (sub {
		3069	delete $self->{_coro}{$coro+0};
		3070	});
		3071
		3072	$self->{_coro}{$coro+0} = $coro;
		3073
		3074	$coro
		3075	}
		3076
		3077	cf::client->attach (
		3078	on_destroy => sub {
		3079	my ($ns) = @_;
		3080
		3081	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		3082	},
		3083	);
807		3084
808	=back	3085	=back
809		3086
810	=cut
811
812	#############################################################################
813		3087
814	=head2 SAFE SCRIPTING	3088	=head2 SAFE SCRIPTING
815		3089
816	Functions that provide a safe environment to compile and execute	3090	Functions that provide a safe environment to compile and execute
817	snippets of perl code without them endangering the safety of the server	3091	snippets of perl code without them endangering the safety of the server
818	itself. Looping constructs, I/O operators and other built-in functionality	3092	itself. Looping constructs, I/O operators and other built-in functionality
819	is not available in the safe scripting environment, and the number of	3093	is not available in the safe scripting environment, and the number of
820	functions and methods that cna be called is greatly reduced.	3094	functions and methods that can be called is greatly reduced.
821		3095
822	=cut	3096	=cut
823		3097
824	our $safe = new Safe "safe";	3098	our $safe = new Safe "safe";
825	our $safe_hole = new Safe::Hole;	3099	our $safe_hole = new Safe::Hole;
826		3100
827	$SIG{FPE} = 'IGNORE';	3101	$SIG{FPE} = 'IGNORE';
828		3102
829	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3103	$safe->permit_only (Opcode::opset qw(
		3104	:base_core :base_mem :base_orig :base_math
		3105	grepstart grepwhile mapstart mapwhile
		3106	sort time
		3107	));
830		3108
831	# here we export the classes and methods available to script code	3109	# here we export the classes and methods available to script code
832		3110
833	=pod	3111	=pod
834		3112
835	The following fucntions and emthods are available within a safe environment:	3113	The following functions and methods are available within a safe environment:
836		3114
837	cf::object contr pay_amount pay_player	3115	cf::object
		3116	contr pay_amount pay_player map x y force_find force_add destroy
		3117	insert remove name archname title slaying race decrease split
		3118
838	cf::object::player player	3119	cf::object::player
839	cf::player peaceful	3120	player
		3121
		3122	cf::player
		3123	peaceful
		3124
		3125	cf::map
		3126	trigger
840		3127
841	=cut	3128	=cut
842		3129
843	for (	3130	for (
844	["cf::object" => qw(contr pay_amount pay_player)],	3131	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3132	insert remove inv nrof name archname title slaying race
		3133	decrease split destroy)],
845	["cf::object::player" => qw(player)],	3134	["cf::object::player" => qw(player)],
846	["cf::player" => qw(peaceful)],	3135	["cf::player" => qw(peaceful)],
		3136	["cf::map" => qw(trigger)],
847	) {	3137	) {
848	no strict 'refs';	3138	no strict 'refs';
849	my ($pkg, @funs) = @$_;	3139	my ($pkg, @funs) = @$_;
850	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3140	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
851	for @funs;	3141	for @funs;
…		…
919	=back	3209	=back
920		3210
921	=cut	3211	=cut
922		3212
923	#############################################################################	3213	#############################################################################
		3214	# the server's init and main functions
924		3215
925	=head2 EXTENSION DATABASE SUPPORT	3216	sub load_facedata($) {
		3217	my ($path) = @_;
926		3218
927	Crossfire maintains a very simple database for extension use. It can	3219	# HACK to clear player env face cache, we need some signal framework
928	currently store anything that can be serialised using Storable, which	3220	# for this (global event?)
929	excludes objects.	3221	%ext::player_env::MUSIC_FACE_CACHE = ();
930		3222
931	The parameter C<$family> should best start with the name of the extension	3223	my $enc = JSON::XS->new->utf8->canonical->relaxed;
932	using it, it should be unique.
933		3224
934	=over 4	3225	warn "loading facedata from $path\n";
935		3226
936	=item $hashref = cf::db_get $family	3227	my $facedata;
		3228	0 < aio_load $path, $facedata
		3229	or die "$path: $!";
937		3230
938	Return a hashref for use by the extension C<$family>, which can be	3231	$facedata = Coro::Storable::thaw $facedata;
939	modified. After modifications, you have to call C<cf::db_dirty> or
940	C<cf::db_sync>.
941		3232
942	=item $value = cf::db_get $family => $key	3233	$facedata->{version} == 2
		3234	or cf::cleanup "$path: version mismatch, cannot proceed.";
943		3235
944	Returns a single value from the database	3236	# patch in the exptable
945		3237	$facedata->{resource}{"res/exp_table"} = {
946	=item cf::db_put $family => $hashref	3238	type => FT_RSRC,
947		3239	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
948	Stores the given family hashref into the database. Updates are delayed, if
949	you want the data to be synced to disk immediately, use C<cf::db_sync>.
950
951	=item cf::db_put $family => $key => $value
952
953	Stores the given C<$value> in the family hash. Updates are delayed, if you
954	want the data to be synced to disk immediately, use C<cf::db_sync>.
955
956	=item cf::db_dirty
957
958	Marks the database as dirty, to be updated at a later time.
959
960	=item cf::db_sync
961
962	Immediately write the database to disk I<if it is dirty>.
963
964	=cut
965
966	{
967	my $db;
968	my $path = cf::localdir . "/database.pst";
969
970	sub db_load() {
971	warn "loading database $path\n";#d# remove later
972	$db = stat $path ? Storable::retrieve $path : { };
973	}
974
975	my $pid;
976
977	sub db_save() {
978	warn "saving database $path\n";#d# remove later
979	waitpid $pid, 0 if $pid;
980	if (0 == ($pid = fork)) {
981	$db->{_meta}{version} = 1;
982	Storable::nstore $db, "$path~";
983	rename "$path~", $path;
984	cf::_exit 0 if defined $pid;
985	}
986	}
987
988	my $dirty;
989
990	sub db_sync() {
991	db_save if $dirty;
992	undef $dirty;
993	}
994
995	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {
996	db_sync;
997	});	3240	};
		3241	cf::cede_to_tick;
998		3242
999	sub db_dirty() {
1000	$dirty = 1;
1001	$idle->start;
1002	}	3243	{
		3244	my $faces = $facedata->{faceinfo};
1003		3245
1004	sub db_get($;$) {	3246	while (my ($face, $info) = each %$faces) {
1005	@_ >= 2	3247	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1006	? $db->{$_[0]}{$_[1]}
1007	: ($db->{$_[0]} ||= { })
1008	}
1009		3248
1010	sub db_put($$;$) {	3249	cf::face::set_visibility $idx, $info->{visibility};
1011	if (@_ >= 3) {	3250	cf::face::set_magicmap $idx, $info->{magicmap};
1012	$db->{$_[0]}{$_[1]} = $_[2];	3251	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
1013	} else {	3252	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1014	$db->{$_[0]} = $_[1];
1015	}
1016	db_dirty;
1017	}
1018		3253
1019	attach_global	3254	cf::cede_to_tick;
1020	prio => 10000,
1021	on_cleanup => sub {
1022	db_sync;
1023	},	3255	}
		3256
		3257	while (my ($face, $info) = each %$faces) {
		3258	next unless $info->{smooth};
		3259
		3260	my $idx = cf::face::find $face
		3261	or next;
		3262
		3263	if (my $smooth = cf::face::find $info->{smooth}) {
		3264	cf::face::set_smooth $idx, $smooth;
		3265	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3266	} else {
		3267	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3268	}
		3269
		3270	cf::cede_to_tick;
		3271	}
		3272	}
		3273
		3274	{
		3275	my $anims = $facedata->{animinfo};
		3276
		3277	while (my ($anim, $info) = each %$anims) {
		3278	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3279	cf::cede_to_tick;
		3280	}
		3281
		3282	cf::anim::invalidate_all; # d'oh
		3283	}
		3284
		3285	{
		3286	# TODO: for gcfclient pleasure, we should give resources
		3287	# that gcfclient doesn't grok a >10000 face index.
		3288	my $res = $facedata->{resource};
		3289
		3290	while (my ($name, $info) = each %$res) {
		3291	if (defined $info->{type}) {
		3292	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3293	my $data;
		3294
		3295	if ($info->{type} & 1) {
		3296	# prepend meta info
		3297
		3298	my $meta = $enc->encode ({
		3299	name => $name,
		3300	%{ $info->{meta} || {} },
		3301	});
		3302
		3303	$data = pack "(w/a*)*", $meta, $info->{data};
		3304	} else {
		3305	$data = $info->{data};
		3306	}
		3307
		3308	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3309	cf::face::set_type $idx, $info->{type};
		3310	} else {
		3311	$RESOURCE{$name} = $info;
		3312	}
		3313
		3314	cf::cede_to_tick;
		3315	}
		3316	}
		3317
		3318	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3319
		3320	1
		3321	}
		3322
		3323	cf::global->attach (on_resource_update => sub {
		3324	if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
		3325	$soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
		3326
		3327	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3328	my $sound = $soundconf->{compat}[$_]
		3329	or next;
		3330
		3331	my $face = cf::face::find "sound/$sound->[1]";
		3332	cf::sound::set $sound->[0] => $face;
		3333	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3334	}
		3335
		3336	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3337	my $face = cf::face::find "sound/$v";
		3338	cf::sound::set $k => $face;
		3339	}
		3340	}
		3341	});
		3342
		3343	register_exticmd fx_want => sub {
		3344	my ($ns, $want) = @_;
		3345
		3346	while (my ($k, $v) = each %$want) {
		3347	$ns->fx_want ($k, $v);
		3348	}
		3349	};
		3350
		3351	sub load_resource_file($) {
		3352	my $guard = lock_acquire "load_resource_file";
		3353
		3354	my $status = load_resource_file_ $_[0];
		3355	get_slot 0.1, 100;
		3356	cf::arch::commit_load;
		3357
		3358	$status
		3359	}
		3360
		3361	sub reload_regions {
		3362	# HACK to clear player env face cache, we need some signal framework
		3363	# for this (global event?)
		3364	%ext::player_env::MUSIC_FACE_CACHE = ();
		3365
		3366	load_resource_file "$MAPDIR/regions"
		3367	or die "unable to load regions file\n";
		3368
		3369	for (cf::region::list) {
		3370	$_->{match} = qr/$_->{match}/
		3371	if exists $_->{match};
		3372	}
		3373	}
		3374
		3375	sub reload_facedata {
		3376	load_facedata "$DATADIR/facedata"
		3377	or die "unable to load facedata\n";
		3378	}
		3379
		3380	sub reload_archetypes {
		3381	load_resource_file "$DATADIR/archetypes"
		3382	or die "unable to load archetypes\n";
		3383	}
		3384
		3385	sub reload_treasures {
		3386	load_resource_file "$DATADIR/treasures"
		3387	or die "unable to load treasurelists\n";
		3388	}
		3389
		3390	sub reload_resources {
		3391	warn "reloading resource files...\n";
		3392
		3393	reload_facedata;
		3394	reload_archetypes;
		3395	reload_regions;
		3396	reload_treasures;
		3397
		3398	warn "finished reloading resource files\n";
		3399	}
		3400
		3401	sub init {
		3402	my $guard = freeze_mainloop;
		3403
		3404	evthread_start IO::AIO::poll_fileno;
		3405
		3406	reload_resources;
		3407	}
		3408
		3409	sub reload_config {
		3410	open my $fh, "<:utf8", "$CONFDIR/config"
		3411	or return;
		3412
		3413	local $/;
		3414	*CFG = YAML::Load <$fh>;
		3415
		3416	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		3417
		3418	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		3419	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		3420
		3421	if (exists $CFG{mlockall}) {
		3422	eval {
		3423	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		3424	and die "WARNING: m(un)lockall failed: $!\n";
		3425	};
		3426	warn $@ if $@;
		3427	}
		3428	}
		3429
		3430	sub main {
		3431	# we must not ever block the main coroutine
		3432	local $Coro::idle = sub {
		3433	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		3434	(async {
		3435	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3436	EV::loop EV::LOOP_ONESHOT;
		3437	})->prio (Coro::PRIO_MAX);
1024	;	3438	};
		3439
		3440	{
		3441	my $guard = freeze_mainloop;
		3442	reload_config;
		3443	db_init;
		3444	load_extensions;
		3445
		3446	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3447	}
		3448
		3449	EV::loop;
1025	}	3450	}
1026		3451
1027	#############################################################################	3452	#############################################################################
1028	# the server's main()	3453	# initialisation and cleanup
1029		3454
1030	sub main {	3455	# install some emergency cleanup handlers
1031	db_load;	3456	BEGIN {
1032	load_extensions;	3457	our %SIGWATCHER = ();
1033	Event::loop;	3458	for my $signal (qw(INT HUP TERM)) {
1034	}	3459	$SIGWATCHER{$signal} = EV::signal $signal, sub {
1035		3460	cf::cleanup "SIG$signal";
1036	#############################################################################
1037	# initialisation
1038
1039	sub _perl_reload(&) {
1040	my ($msg) = @_;
1041
1042	$msg->("reloading...");
1043
1044	eval {
1045	# cancel all watchers
1046	$_->cancel for Event::all_watchers;
1047
1048	# unload all extensions
1049	for (@exts) {
1050	$msg->("unloading <$_>");
1051	unload_extension $_;
1052	}	3461	};
		3462	}
		3463	}
1053		3464
		3465	sub write_runtime_sync {
		3466	my $runtime = "$LOCALDIR/runtime";
		3467
		3468	# first touch the runtime file to show we are still running:
		3469	# the fsync below can take a very very long time.
		3470
		3471	IO::AIO::aio_utime $runtime, undef, undef;
		3472
		3473	my $guard = cf::lock_acquire "write_runtime";
		3474
		3475	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3476	or return;
		3477
		3478	my $value = $cf::RUNTIME + 90 + 10;
		3479	# 10 is the runtime save interval, for a monotonic clock
		3480	# 60 allows for the watchdog to kill the server.
		3481
		3482	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3483	and return;
		3484
		3485	# always fsync - this file is important
		3486	aio_fsync $fh
		3487	and return;
		3488
		3489	# touch it again to show we are up-to-date
		3490	aio_utime $fh, undef, undef;
		3491
		3492	close $fh
		3493	or return;
		3494
		3495	aio_rename "$runtime~", $runtime
		3496	and return;
		3497
		3498	warn "runtime file written.\n";
		3499
		3500	1
		3501	}
		3502
		3503	our $uuid_lock;
		3504	our $uuid_skip;
		3505
		3506	sub write_uuid_sync($) {
		3507	$uuid_skip ||= $_[0];
		3508
		3509	return if $uuid_lock;
		3510	local $uuid_lock = 1;
		3511
		3512	my $uuid = "$LOCALDIR/uuid";
		3513
		3514	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3515	or return;
		3516
		3517	my $value = uuid_str $uuid_skip + uuid_seq uuid_cur;
		3518	$uuid_skip = 0;
		3519
		3520	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3521	and return;
		3522
		3523	# always fsync - this file is important
		3524	aio_fsync $fh
		3525	and return;
		3526
		3527	close $fh
		3528	or return;
		3529
		3530	aio_rename "$uuid~", $uuid
		3531	and return;
		3532
		3533	warn "uuid file written ($value).\n";
		3534
		3535	1
		3536
		3537	}
		3538
		3539	sub write_uuid($$) {
		3540	my ($skip, $sync) = @_;
		3541
		3542	$sync ? write_uuid_sync $skip
		3543	: async { write_uuid_sync $skip };
		3544	}
		3545
		3546	sub emergency_save() {
		3547	my $freeze_guard = cf::freeze_mainloop;
		3548
		3549	warn "enter emergency perl save\n";
		3550
		3551	cf::sync_job {
		3552	# use a peculiar iteration method to avoid tripping on perl
		3553	# refcount bugs in for. also avoids problems with players
		3554	# and maps saved/destroyed asynchronously.
		3555	warn "begin emergency player save\n";
		3556	for my $login (keys %cf::PLAYER) {
		3557	my $pl = $cf::PLAYER{$login} or next;
		3558	$pl->valid or next;
		3559	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
		3560	$pl->save;
		3561	}
		3562	warn "end emergency player save\n";
		3563
		3564	warn "begin emergency map save\n";
		3565	for my $path (keys %cf::MAP) {
		3566	my $map = $cf::MAP{$path} or next;
		3567	$map->valid or next;
		3568	$map->save;
		3569	}
		3570	warn "end emergency map save\n";
		3571
		3572	warn "begin emergency database checkpoint\n";
		3573	BDB::db_env_txn_checkpoint $DB_ENV;
		3574	warn "end emergency database checkpoint\n";
		3575
		3576	warn "begin write uuid\n";
		3577	write_uuid_sync 1;
		3578	warn "end write uuid\n";
		3579	};
		3580
		3581	warn "leave emergency perl save\n";
		3582	}
		3583
		3584	sub post_cleanup {
		3585	my ($make_core) = @_;
		3586
		3587	warn Carp::longmess "post_cleanup backtrace"
		3588	if $make_core;
		3589	}
		3590
		3591	sub do_reload_perl() {
		3592	# can/must only be called in main
		3593	if ($Coro::current != $Coro::main) {
		3594	warn "can only reload from main coroutine";
		3595	return;
		3596	}
		3597
		3598	warn "reloading...";
		3599
		3600	warn "entering sync_job";
		3601
		3602	cf::sync_job {
		3603	cf::write_runtime_sync; # external watchdog should not bark
		3604	cf::emergency_save;
		3605	cf::write_runtime_sync; # external watchdog should not bark
		3606
		3607	warn "syncing database to disk";
		3608	BDB::db_env_txn_checkpoint $DB_ENV;
		3609
		3610	# if anything goes wrong in here, we should simply crash as we already saved
		3611
		3612	warn "flushing outstanding aio requests";
		3613	for (;;) {
		3614	BDB::flush;
		3615	IO::AIO::flush;
		3616	Coro::cede_notself;
		3617	last unless IO::AIO::nreqs || BDB::nreqs;
		3618	warn "iterate...";
		3619	}
		3620
		3621	++$RELOAD;
		3622
		3623	warn "cancelling all extension coros";
		3624	$_->cancel for values %EXT_CORO;
		3625	%EXT_CORO = ();
		3626
		3627	warn "removing commands";
		3628	%COMMAND = ();
		3629
		3630	warn "removing ext/exti commands";
		3631	%EXTCMD = ();
		3632	%EXTICMD = ();
		3633
		3634	warn "unloading/nuking all extensions";
		3635	for my $pkg (@EXTS) {
		3636	warn "... unloading $pkg";
		3637
		3638	if (my $cb = $pkg->can ("unload")) {
		3639	eval {
		3640	$cb->($pkg);
		3641	1
		3642	} or warn "$pkg unloaded, but with errors: $@";
		3643	}
		3644
		3645	warn "... nuking $pkg";
		3646	Symbol::delete_package $pkg;
		3647	}
		3648
1054	# unload all modules loaded from $LIBDIR	3649	warn "unloading all perl modules loaded from $LIBDIR";
1055	while (my ($k, $v) = each %INC) {	3650	while (my ($k, $v) = each %INC) {
1056	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3651	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1057		3652
1058	$msg->("removing <$k>");	3653	warn "... unloading $k";
1059	delete $INC{$k};	3654	delete $INC{$k};
1060		3655
1061	$k =~ s/\.pm$//;	3656	$k =~ s/\.pm$//;
1062	$k =~ s/\//::/g;	3657	$k =~ s/\//::/g;
1063		3658
…		…
1066	}	3661	}
1067		3662
1068	Symbol::delete_package $k;	3663	Symbol::delete_package $k;
1069	}	3664	}
1070		3665
1071	# sync database to disk
1072	cf::db_sync;
1073
1074	# get rid of safe::, as good as possible	3666	warn "getting rid of safe::, as good as possible";
1075	Symbol::delete_package "safe::$_"	3667	Symbol::delete_package "safe::$_"
1076	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	3668	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1077		3669
1078	# remove register_script_function callbacks
1079	# TODO
1080
1081	# unload cf.pm "a bit"	3670	warn "unloading cf.pm \"a bit\"";
1082	delete $INC{"cf.pm"};	3671	delete $INC{"cf.pm"};
		3672	delete $INC{"cf/pod.pm"};
1083		3673
1084	# don't, removes xs symbols, too,	3674	# don't, removes xs symbols, too,
1085	# and global variables created in xs	3675	# and global variables created in xs
1086	#Symbol::delete_package __PACKAGE__;	3676	#Symbol::delete_package __PACKAGE__;
1087		3677
1088	# reload cf.pm	3678	warn "unload completed, starting to reload now";
		3679
1089	$msg->("reloading cf.pm");	3680	warn "reloading cf.pm";
1090	require cf;	3681	require cf;
		3682	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1091		3683
1092	# load database again	3684	warn "loading config and database again";
1093	cf::db_load;	3685	cf::reload_config;
1094		3686
1095	# load extensions	3687	warn "loading extensions";
1096	$msg->("load extensions");
1097	cf::load_extensions;	3688	cf::load_extensions;
1098		3689
1099	# reattach attachments to objects	3690	warn "reattaching attachments to objects/players";
1100	$msg->("reattach");	3691	_global_reattach; # objects, sockets
1101	_global_reattach;	3692	warn "reattaching attachments to maps";
		3693	reattach $_ for values %MAP;
		3694	warn "reattaching attachments to players";
		3695	reattach $_ for values %PLAYER;
		3696
		3697	warn "leaving sync_job";
		3698
		3699	1
		3700	} or do {
		3701	warn $@;
		3702	cf::cleanup "error while reloading, exiting.";
1102	};	3703	};
1103	$msg->($@) if $@;
1104		3704
1105	$msg->("reloaded");	3705	warn "reloaded";
1106	};	3706	};
1107		3707
1108	sub perl_reload() {	3708	our $RELOAD_WATCHER; # used only during reload
1109	_perl_reload {	3709
1110	warn $_[0];	3710	sub reload_perl() {
1111	print "$_[0]\n";	3711	# doing reload synchronously and two reloads happen back-to-back,
		3712	# coro crashes during coro_state_free->destroy here.
		3713
		3714	$RELOAD_WATCHER ||= EV::timer 0, 0, sub {
		3715	do_reload_perl;
		3716	undef $RELOAD_WATCHER;
1112	};	3717	};
1113	}	3718	}
1114		3719
1115	register_command "perl-reload", 0, sub {	3720	register_command "reload" => sub {
1116	my ($who, $arg) = @_;	3721	my ($who, $arg) = @_;
1117		3722
1118	if ($who->flag (FLAG_WIZ)) {	3723	if ($who->flag (FLAG_WIZ)) {
1119	_perl_reload {	3724	$who->message ("reloading server.");
1120	warn $_[0];	3725	async {
1121	$who->message ($_[0]);	3726	$Coro::current->{desc} = "perl_reload";
		3727	reload_perl;
1122	};	3728	};
1123	}	3729	}
1124	};	3730	};
1125		3731
1126	register "<global>", __PACKAGE__;
1127
1128	unshift @INC, $LIBDIR;	3732	unshift @INC, $LIBDIR;
1129		3733
1130	$TICK_WATCHER = Event->timer (	3734	my $bug_warning = 0;
1131	prio => 1,	3735
1132	at => $NEXT_TICK || 1,	3736	our @WAIT_FOR_TICK;
1133	cb => sub {	3737	our @WAIT_FOR_TICK_BEGIN;
		3738
		3739	sub wait_for_tick {
		3740	return if tick_inhibit || $Coro::current == $Coro::main;
		3741
		3742	my $signal = new Coro::Signal;
		3743	push @WAIT_FOR_TICK, $signal;
		3744	$signal->wait;
		3745	}
		3746
		3747	sub wait_for_tick_begin {
		3748	return if tick_inhibit || $Coro::current == $Coro::main;
		3749
		3750	my $signal = new Coro::Signal;
		3751	push @WAIT_FOR_TICK_BEGIN, $signal;
		3752	$signal->wait;
		3753	}
		3754
		3755	sub tick {
		3756	if ($Coro::current != $Coro::main) {
		3757	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3758	unless ++$bug_warning > 10;
		3759	return;
		3760	}
		3761
1134	cf::server_tick; # one server iteration	3762	cf::server_tick; # one server iteration
1135		3763
1136	my $NOW = Event::time;	3764	if ($NOW >= $NEXT_RUNTIME_WRITE) {
1137	$NEXT_TICK += $TICK;	3765	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
1138		3766	Coro::async_pool {
1139	# if we are delayed by four ticks, skip them all	3767	$Coro::current->{desc} = "runtime saver";
1140	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	3768	write_runtime_sync
1141		3769	or warn "ERROR: unable to write runtime file: $!";
1142	$TICK_WATCHER->at ($NEXT_TICK);	3770	};
1143	$TICK_WATCHER->start;
1144	},	3771	}
1145	);	3772
		3773	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3774	$sig->send;
		3775	}
		3776	while (my $sig = shift @WAIT_FOR_TICK) {
		3777	$sig->send;
		3778	}
		3779
		3780	$LOAD = ($NOW - $TICK_START) / $TICK;
		3781	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3782
		3783	if (0) {
		3784	if ($NEXT_TICK) {
		3785	my $jitter = $TICK_START - $NEXT_TICK;
		3786	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		3787	warn "jitter $JITTER\n";#d#
		3788	}
		3789	}
		3790	}
		3791
		3792	{
		3793	# configure BDB
		3794
		3795	BDB::min_parallel 8;
		3796	BDB::max_poll_reqs $TICK * 0.1;
		3797	$AnyEvent::BDB::WATCHER->priority (1);
		3798
		3799	unless ($DB_ENV) {
		3800	$DB_ENV = BDB::db_env_create;
		3801	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
		3802	| BDB::LOG_AUTOREMOVE, 1);
		3803	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3804	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3805
		3806	cf::sync_job {
		3807	eval {
		3808	BDB::db_env_open
		3809	$DB_ENV,
		3810	$BDBDIR,
		3811	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3812	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3813	0666;
		3814
		3815	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3816	};
		3817
		3818	cf::cleanup "db_env_open(db): $@" if $@;
		3819	};
		3820	}
		3821
		3822	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3823	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3824	};
		3825	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		3826	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3827	};
		3828	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3829	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3830	};
		3831	}
		3832
		3833	{
		3834	# configure IO::AIO
		3835
		3836	IO::AIO::min_parallel 8;
		3837	IO::AIO::max_poll_time $TICK * 0.1;
		3838	undef $AnyEvent::AIO::WATCHER;
		3839	}
		3840
		3841	my $_log_backtrace;
		3842
		3843	sub _log_backtrace {
		3844	my ($msg, @addr) = @_;
		3845
		3846	$msg =~ s/\n//;
		3847
		3848	# limit the # of concurrent backtraces
		3849	if ($_log_backtrace < 2) {
		3850	++$_log_backtrace;
		3851	async {
		3852	$Coro::current->{desc} = "abt $msg";
		3853
		3854	my @bt = fork_call {
		3855	@addr = map { sprintf "%x", $_ } @addr;
		3856	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3857	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3858	or die "addr2line: $!";
		3859
		3860	my @funcs;
		3861	my @res = <$fh>;
		3862	chomp for @res;
		3863	while (@res) {
		3864	my ($func, $line) = splice @res, 0, 2, ();
		3865	push @funcs, "[$func] $line";
		3866	}
		3867
		3868	@funcs
		3869	};
		3870
		3871	LOG llevInfo, "[ABT] $msg\n";
		3872	LOG llevInfo, "[ABT] $_\n" for @bt;
		3873	--$_log_backtrace;
		3874	};
		3875	} else {
		3876	LOG llevInfo, "[ABT] $msg\n";
		3877	LOG llevInfo, "[ABT] [suppressed]\n";
		3878	}
		3879	}
		3880
		3881	# load additional modules
		3882	use cf::pod;
		3883
		3884	END { cf::emergency_save }
1146		3885
1147	1	3886	1
1148		3887

Diff Legend

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