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.82 by root, Sun Dec 3 20:59:52 2006 UTC vs.
Revision 1.439 by root, Mon Jul 14 16:42:49 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 1.6;
		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 ();
10	use IO::AIO ();	55	use IO::AIO ();
11	use YAML::Syck ();
12	use Time::HiRes;	56	use Time::HiRes;
13	use Event;	57	use Compress::LZF;
14	$Event::Eval = 1; # no idea why this is required, but it is	58	use Digest::MD5 ();
15		59
16	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	60	AnyEvent::detect;
17	$YAML::Syck::ImplicitUnicode = 1;
18		61
19	use strict;	62	# configure various modules to our taste
		63	#
		64	$Storable::canonical = 1; # reduce rsync transfers
		65	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		66	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
20		67
21	_init_vars;	68	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
22		69
		70	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		71
23	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
24	our @EVENT;	82	our @EVENT;
25	our $LIBDIR = maps_directory "perl";
26		83
27	our $TICK = MAX_TIME * 1e-6;	84	our $CONFDIR = confdir;
28	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
29	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;
30		106
31	our %CFG;	107	our %CFG;
32		108
33	our $uptime;	109	our $UPTIME; $UPTIME ||= time;
		110	our $RUNTIME;
		111	our $NOW;
34		112
35	$uptime ||= time;	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;
36		141
37	#############################################################################	142	#############################################################################
38		143
39	=head2 GLOBAL VARIABLES	144	=head2 GLOBAL VARIABLES
40		145
41	=over 4	146	=over 4
42		147
43	=item $cf::LIBDIR	148	=item $cf::UPTIME
44		149
45	The perl library directory, where extensions and cf-specific modules can	150	The timestamp of the server start (so not actually an uptime).
46	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.
47		169
48	=item $cf::TICK	170	=item $cf::TICK
49		171
50	The interval between server ticks, in seconds.	172	The interval between server ticks, in seconds.
51		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
52	=item %cf::CFG	184	=item %cf::CFG
53		185
54	Configuration for the server, loaded from C</etc/crossfire/config>, or	186	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
55	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.
56		200
57	=back	201	=back
58		202
59	=cut	203	=cut
60		204
61	BEGIN {	205	BEGIN {
62	*CORE::GLOBAL::warn = sub {	206	*CORE::GLOBAL::warn = sub {
63	my $msg = join "", @_;	207	my $msg = join "", @_;
		208
64	$msg .= "\n"	209	$msg .= "\n"
65	unless $msg =~ /\n$/;	210	unless $msg =~ /\n$/;
66		211
67	print STDERR "cfperl: $msg";	212	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		213
68	LOG llevError, "cfperl: $msg";	214	LOG llevError, $msg;
69	};	215	};
70	}	216	}
71		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';
72	@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)
73		240
74	# 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
75	# within the Safe compartment.	242	# within the Safe compartment.
76	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	)) {
77	no strict 'refs';	250	no strict 'refs';
78	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	251	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
79	}	252	}
80		253
81	$Event::DIED = sub {	254	$EV::DIED = sub {
82	warn "error in event callback: @_";	255	warn "error in event callback: @_";
83	};	256	};
84		257
85	my %ext_pkg;	258	#############################################################################
86	my @exts;
87	my @hook;
88	my %command;
89	my %extcmd;
90		259
91	=head2 UTILITY FUNCTIONS	260	=head2 UTILITY FUNCTIONS
92		261
93	=over 4	262	=over 4
94		263
95	=cut	264	=item dumpval $ref
96		265
97	use JSON::Syck (); # TODO# replace by JSON::PC once working	266	=cut
98		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
99	=item $ref = cf::from_json $json	287	=item $ref = cf::decode_json $json
100		288
101	Converts a JSON string into the corresponding perl data structure.	289	Converts a JSON string into the corresponding perl data structure.
102		290
103	=cut
104
105	sub from_json($) {
106	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
107	JSON::Syck::Load $_[0]
108	}
109
110	=item $json = cf::to_json $ref	291	=item $json = cf::encode_json $ref
111		292
112	Converts a perl data structure into its JSON representation.	293	Converts a perl data structure into its JSON representation.
113		294
114	=cut	295	=cut
115		296
116	sub to_json($) {	297	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
117	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	298
118	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 });
119	}	720	}
120		721
121	=back	722	=back
122		723
123	=cut	724	=cut
124		725
125	#############################################################################	726	#############################################################################
126		727
127	=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).
128		737
129	=over 4	738	=over 4
130		739
131	=item $object->attach ($attachment, key => $value...)
132
133	=item $object->detach ($attachment)
134
135	Attach/detach a pre-registered attachment to an object.
136
137	=item $player->attach ($attachment, key => $value...)
138
139	=item $player->detach ($attachment)
140
141	Attach/detach a pre-registered attachment to a player.
142
143	=item $map->attach ($attachment, key => $value...)	740	=item $attachable->attach ($attachment, key => $value...)
144		741
145	=item $map->detach ($attachment)	742	=item $attachable->detach ($attachment)
146		743
147	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.
148		746
149	=item $bool = $object->attached ($name)	747	Example, attach a minesweeper attachment to the given object, making it a
		748	10x10 minesweeper game:
150		749
151	=item $bool = $player->attached ($name)	750	$obj->attach (minesweeper => width => 10, height => 10);
152		751
153	=item $bool = $map->attached ($name)	752	=item $bool = $attachable->attached ($name)
154		753
155	Checks wether the named attachment is currently attached to the object.	754	Checks wether the named attachment is currently attached to the object.
156		755
157	=item cf::attach_global ...	756	=item cf::CLASS->attach ...
158		757
159	Attach handlers for global events.	758	=item cf::CLASS->detach ...
160		759
161	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
162	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:
163		794
164	=over 4	795	=over 4
165		796
166	=item prio => $number	797	=item prio => $number
167		798
…		…
169	by another C<prio> setting). Lower priority handlers get executed	800	by another C<prio> setting). Lower priority handlers get executed
170	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
171	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
172	unless you know what you are doing.	803	unless you know what you are doing.
173		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
174	=item on_I<event> => \&cb	811	=item on_I<event> => \&cb
175		812
176	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
177	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
178	handlers are recognised generally depends on the type of object these	815	handlers are recognised generally depends on the type of object these
…		…
187	package and register them. Only handlers for eevents supported by the	824	package and register them. Only handlers for eevents supported by the
188	object/class are recognised.	825	object/class are recognised.
189		826
190	=back	827	=back
191		828
192	=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:
193		831
194	Attach handlers for a specific object type (e.g. TRANSPORT) and	832	cf::object::attachment sockpuppet =>
195	subtype. If C<$subtype> is zero or undef, matches all objects of the given	833	on_skill_attack => sub {
196	type.	834	my ($self, $victim) = @_;
197		835	...
198	=item cf::attach_to_objects ...
199
200	Attach handlers to all objects. Do not use this except for debugging or
201	very rare events, as handlers are (obviously) called for I<all> objects in
202	the game.
203
204	=item cf::attach_to_players ...
205
206	Attach handlers to all players.
207
208	=item cf::attach_to_maps ...
209
210	Attach handlers to all maps.
211
212	=item cf:register_attachment $name, ...
213
214	Register an attachment by name through which objects can refer to this
215	attachment.
216
217	=item cf:register_player_attachment $name, ...
218
219	Register an attachment by name through which players can refer to this
220	attachment.
221
222	=item cf:register_map_attachment $name, ...
223
224	Register an attachment by name through which maps can refer to this
225	attachment.
226
227	=cut
228
229	# the following variables are defined in .xs and must not be re-created
230	our @CB_GLOBAL = (); # registry for all global events
231	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
232	our @CB_PLAYER = ();
233	our @CB_TYPE = (); # registry for type (cf-object class) based events
234	our @CB_MAP = ();
235
236	my %attachment;
237
238	sub _attach_cb($\%$$$) {
239	my ($registry, $undo, $event, $prio, $cb) = @_;
240
241	use sort 'stable';
242
243	$cb = [$prio, $cb];
244
245	@{$registry->[$event]} = sort
246	{ $a->[0] cmp $b->[0] }
247	@{$registry->[$event] || []}, $cb;
248
249	push @{$undo->{cb}}, [$event, $cb];
250	}
251
252	# attach handles attaching event callbacks
253	# the only thing the caller has to do is pass the correct
254	# registry (== where the callback attaches to).
255	sub _attach(\@$@) {
256	my ($registry, $klass, @arg) = @_;
257
258	my $prio = 0;
259
260	my %undo = (
261	registry => $registry,
262	cb => [],
263	);
264
265	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
266
267	while (@arg) {
268	my $type = shift @arg;
269
270	if ($type eq "prio") {
271	$prio = shift @arg;
272
273	} elsif ($type eq "package") {
274	my $pkg = shift @arg;
275
276	while (my ($name, $id) = each %cb_id) {
277	if (my $cb = $pkg->can ($name)) {
278	_attach_cb $registry, %undo, $id, $prio, $cb;
279	}
280	}	836	}
281
282	} elsif (exists $cb_id{$type}) {
283	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
284
285	} elsif (ref $type) {
286	warn "attaching objects not supported, ignoring.\n";
287
288	} else {
289	shift @arg;
290	warn "attach argument '$type' not supported, ignoring.\n";
291	}
292	}
293
294	\%undo
295	}
296
297	sub _attach_attachment {
298	my ($obj, $name, %arg) = @_;
299
300	return if exists $obj->{_attachment}{$name};
301
302	my $res;
303
304	if (my $attach = $attachment{$name}) {
305	my $registry = $obj->registry;
306
307	for (@$attach) {
308	my ($klass, @attach) = @$_;
309	$res = _attach @$registry, $klass, @attach;
310	}
311
312	$obj->{$name} = \%arg;
313	} else {
314	warn "object uses attachment '$name' that is not available, postponing.\n";
315	}
316
317	$obj->{_attachment}{$name} = undef;
318
319	$res->{attachment} = $name;
320	$res
321	}
322
323	*cf::object::attach =
324	*cf::player::attach =
325	*cf::map::attach = sub {
326	my ($obj, $name, %arg) = @_;
327
328	_attach_attachment $obj, $name, %arg;
329	};
330
331	# all those should be optimised
332	*cf::object::detach =
333	*cf::player::detach =
334	*cf::map::detach = sub {
335	my ($obj, $name) = @_;
336
337	delete $obj->{_attachment}{$name};
338	reattach ($obj);
339	};
340
341	*cf::object::attached =
342	*cf::player::attached =
343	*cf::map::attached = sub {
344	my ($obj, $name) = @_;
345
346	exists $obj->{_attachment}{$name}
347	};
348
349	sub attach_global {
350	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
351	}
352
353	sub attach_to_type {
354	my $type = shift;
355	my $subtype = shift;
356
357	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
358	}
359
360	sub attach_to_objects {
361	_attach @CB_OBJECT, KLASS_OBJECT, @_
362	}
363
364	sub attach_to_players {
365	_attach @CB_PLAYER, KLASS_PLAYER, @_
366	}
367
368	sub attach_to_maps {
369	_attach @CB_MAP, KLASS_MAP, @_
370	}
371
372	sub register_attachment {
373	my $name = shift;
374
375	$attachment{$name} = [[KLASS_OBJECT, @_]];
376	}
377
378	sub register_player_attachment {
379	my $name = shift;
380
381	$attachment{$name} = [[KLASS_PLAYER, @_]];
382	}
383
384	sub register_map_attachment {
385	my $name = shift;
386
387	$attachment{$name} = [[KLASS_MAP, @_]];
388	}
389
390	our $override;
391	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
392
393	sub override {
394	$override = 1;
395	@invoke_results = ();
396	}
397
398	sub do_invoke {
399	my $event = shift;
400	my $callbacks = shift;
401
402	@invoke_results = ();
403
404	local $override;
405
406	for (@$callbacks) {
407	eval { &{$_->[1]} };
408
409	if ($@) {
410	warn "$@";
411	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
412	override;
413	}
414
415	return 1 if $override;
416	}
417
418	0	837	}
419	}
420		838
421	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	839	=item $attachable->valid
422
423	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
424
425	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
426
427	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
428
429	Generate a global/object/player/map-specific event with the given arguments.
430
431	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
432	removed in future versions), and there is no public API to access override
433	results (if you must, access C<@cf::invoke_results> directly).
434
435	=back
436
437	=cut
438
439	#############################################################################
440
441	=head2 METHODS VALID FOR ALL CORE OBJECTS
442
443	=over 4
444
445	=item $object->valid, $player->valid, $map->valid
446		840
447	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
448	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
449	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
450	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
451	exception.	845	exception.
452		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
453	=back	1038	=back
454		1039
455	=cut	1040	=cut
456
457	*cf::object::valid =
458	*cf::player::valid =
459	*cf::map::valid = \&cf::_valid;
460		1041
461	#############################################################################	1042	#############################################################################
462	# object support	1043	# object support
463		1044
464	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 {
465	my ($obj, $data) = @_;	1079	my ($ob1, $ob2) = @_;
466		1080
467	$data = from_json $data;	1081	++$SLOW_MERGES;#d#
468		1082
469	for (@$data) {	1083	# we do the slow way here
470	my ($name, $args) = @$_;	1084	return _object_equal $ob1, $ob2
471
472	$obj->attach ($name, %{$args || {} });
473	}
474	}	1085	}
475		1086
476	# basically do the same as instantiate, without calling instantiate
477	sub reattach {	1087	sub reattach {
		1088	# basically do the same as instantiate, without calling instantiate
478	my ($obj) = @_;	1089	my ($obj) = @_;
		1090
		1091	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
		1092
479	my $registry = $obj->registry;	1093	my $registry = $obj->registry;
480		1094
481	@$registry = ();	1095	@$registry = ();
482		1096
483	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	1097	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
484		1098
485	for my $name (keys %{ $obj->{_attachment} || {} }) {	1099	for my $name (keys %{ $obj->{_attachment} || {} }) {
486	if (my $attach = $attachment{$name}) {	1100	if (my $attach = $attachment{$name}) {
487	for (@$attach) {	1101	for (@$attach) {
488	my ($klass, @attach) = @$_;	1102	my ($klass, @attach) = @$_;
489	_attach @$registry, $klass, @attach;	1103	_attach $registry, $klass, @attach;
490	}	1104	}
491	} else {	1105	} else {
492	warn "object uses attachment '$name' that is not available, postponing.\n";	1106	warn "object uses attachment '$name' that is not available, postponing.\n";
493	}	1107	}
494	}	1108	}
495	}	1109	}
496		1110
497	sub object_freezer_save {	1111	cf::attachable->attach (
498	my ($filename, $rdata, $objs) = @_;
499
500	if (length $$rdata) {
501	warn sprintf "saving %s (%d,%d)\n",
502	$filename, length $$rdata, scalar @$objs;
503
504	if (open my $fh, ">:raw", "$filename~") {
505	chmod SAVE_MODE, $fh;
506	syswrite $fh, $$rdata;
507	close $fh;
508
509	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
510	chmod SAVE_MODE, $fh;
511	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
512	close $fh;
513	rename "$filename.pst~", "$filename.pst";
514	} else {
515	unlink "$filename.pst";
516	}
517
518	rename "$filename~", $filename;
519	} else {
520	warn "FATAL: $filename~: $!\n";
521	}
522	} else {
523	unlink $filename;
524	unlink "$filename.pst";
525	}
526	}
527
528	sub object_freezer_as_string {
529	my ($rdata, $objs) = @_;
530
531	use Data::Dumper;
532
533	$$rdata . Dumper $objs
534	}
535
536	sub object_thawer_load {
537	my ($filename) = @_;
538
539	local $/;
540
541	my $av;
542
543	#TODO: use sysread etc.
544	if (open my $data, "<:raw:perlio", $filename) {
545	$data = <$data>;
546	if (open my $pst, "<:raw:perlio", "$filename.pst") {
547	$av = eval { (Storable::thaw <$pst>)->{objs} };
548	}
549	return ($data, $av);
550	}
551
552	()
553	}
554
555	attach_to_objects
556	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,
557	on_clone => sub {	1125	on_clone => sub {
558	my ($src, $dst) = @_;	1126	my ($src, $dst) = @_;
559		1127
560	@{$dst->registry} = @{$src->registry};	1128	@{$dst->registry} = @{$src->registry};
561		1129
562	%$dst = %$src;	1130	%$dst = %$src;
563		1131
564	%{$dst->{_attachment}} = %{$src->{_attachment}}	1132	%{$dst->{_attachment}} = %{$src->{_attachment}}
565	if exists $src->{_attachment};	1133	if exists $src->{_attachment};
566	},	1134	},
567	;	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
568		1212
569	#############################################################################	1213	#############################################################################
570	# old plug-in events	1214	# command handling &c
571		1215
572	sub inject_event {	1216	=item cf::register_command $name => \&callback($ob,$args);
573	my $extension = shift;
574	my $event_code = shift;
575		1217
576	my $cb = $hook[$event_code]{$extension}	1218	Register a callback for execution when the client sends the user command
577	or return;	1219	$name.
578		1220
579	&$cb	1221	=cut
580	}
581
582	sub inject_global_event {
583	my $event = shift;
584
585	my $cb = $hook[$event]
586	or return;
587
588	List::Util::max map &$_, values %$cb
589	}
590
591	sub inject_command {
592	my ($name, $obj, $params) = @_;
593
594	for my $cmd (@{ $command{$name} }) {
595	$cmd->[1]->($obj, $params);
596	}
597
598	-1
599	}
600		1222
601	sub register_command {	1223	sub register_command {
602	my ($name, $time, $cb) = @_;	1224	my ($name, $cb) = @_;
603		1225
604	my $caller = caller;	1226	my $caller = caller;
605	#warn "registering command '$name/$time' to '$caller'";	1227	#warn "registering command '$name/$time' to '$caller'";
606		1228
607	push @{ $command{$name} }, [$time, $cb, $caller];	1229	push @{ $COMMAND{$name} }, [$caller, $cb];
608	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
609	}	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
610		1255
611	sub register_extcmd {	1256	sub register_extcmd {
612	my ($name, $cb) = @_;	1257	my ($name, $cb) = @_;
613		1258
614	my $caller = caller;	1259	$EXTCMD{$name} = $cb;
615	#warn "registering extcmd '$name' to '$caller'";
616
617	$extcmd{$name} = [$cb, $caller];
618	}	1260	}
619		1261
620	sub register {	1262	sub register_exticmd {
621	my ($base, $pkg) = @_;	1263	my ($name, $cb) = @_;
622		1264
623	#TODO	1265	$EXTICMD{$name} = $cb;
624	}	1266	}
625		1267
626	sub load_extension {	1268	cf::player->attach (
627	my ($path) = @_;	1269	on_command => sub {
		1270	my ($pl, $name, $params) = @_;
628		1271
629	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1272	my $cb = $COMMAND{$name}
630	my $base = $1;	1273	or return;
631	my $pkg = $1;
632	$pkg =~ s/[^[:word:]]/_/g;
633	$pkg = "ext::$pkg";
634		1274
635	warn "loading '$path' into '$pkg'\n";	1275	for my $cmd (@$cb) {
636		1276	$cmd->[1]->($pl->ob, $params);
637	open my $fh, "<:utf8", $path
638	or die "$path: $!";
639
640	my $source =
641	"package $pkg; use strict; use utf8;\n"
642	. "#line 1 \"$path\"\n{\n"
643	. (do { local $/; <$fh> })
644	. "\n};\n1";
645
646	eval $source
647	or die $@ ? "$path: $@\n"
648	: "extension disabled.\n";
649
650	push @exts, $pkg;
651	$ext_pkg{$base} = $pkg;
652
653	# no strict 'refs';
654	# @{"$pkg\::ISA"} = ext::;
655
656	register $base, $pkg;
657	}
658
659	sub unload_extension {
660	my ($pkg) = @_;
661
662	warn "removing extension $pkg\n";
663
664	# remove hooks
665	#TODO
666	# for my $idx (0 .. $#PLUGIN_EVENT) {
667	# delete $hook[$idx]{$pkg};
668	# }
669
670	# remove commands
671	for my $name (keys %command) {
672	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
673
674	if (@cb) {
675	$command{$name} = \@cb;
676	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
677	} else {
678	delete $command{$name};
679	delete $COMMAND{"$name\000"};
680	}	1277	}
		1278
		1279	cf::override;
681	}	1280	},
682
683	# remove extcmds
684	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
685	delete $extcmd{$name};
686	}
687
688	if (my $cb = $pkg->can ("unload")) {
689	eval {
690	$cb->($pkg);
691	1
692	} or warn "$pkg unloaded, but with errors: $@";
693	}
694
695	Symbol::delete_package $pkg;
696	}
697
698	sub load_extensions {
699	my $LIBDIR = maps_directory "perl";
700
701	for my $ext (<$LIBDIR/*.ext>) {
702	next unless -r $ext;
703	eval {
704	load_extension $ext;
705	1
706	} or warn "$ext not loaded: $@";
707	}
708	}
709
710	#############################################################################
711	# extcmd framework, basically convert ext <msg>
712	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
713
714	attach_to_players
715	on_extcmd => sub {	1281	on_extcmd => sub {
716	my ($pl, $buf) = @_;	1282	my ($pl, $buf) = @_;
717		1283
718	my $msg = eval { from_json $buf };	1284	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
719		1285
720	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
721	if (my $cb = $extcmd{$msg->{msgtype}}) {	1294	if (my $cb = $EXTCMD{$type}) {
722	if (my %reply = $cb->[0]->($pl, $msg)) {	1295	@reply = $cb->($pl, @payload);
723	$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->post_load_original
		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;
724	}	2101	}
725	}	2102	}
726	} else {
727	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
728	}	2103	}
729		2104
730	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);
731	},	2128	}
732	;
733		2129
734	#############################################################################	2130	$self->post_load;
735	# load/save/clean perl data associated with a map	2131	}
736		2132
737	*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 {
738	my ($map) = @_;	2147	my ($map) = @_;
739		2148
740	my $path = $map->tmpname;	2149	my @neigh; # diagonal neighbours
741	defined $path or return;
742		2150
743	unlink "$path.pst";	2151	for (0 .. 3) {
744	};	2152	my $neigh = $map->tile_path ($_)
		2153	or next;
		2154	$neigh = find $neigh, $map
		2155	or next;
		2156	$neigh->load;
745		2157
746	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	}
747		2162
748	#############################################################################	2163	for (grep defined $_->[0], @neigh) {
749	# load/save perl data associated with player->ob objects	2164	my ($path, $origin) = @$_;
750		2165	my $neigh = find $path, $origin
751	sub all_objects(@) {	2166	or next;
752	@_, map all_objects ($_->inv), @_	2167	$neigh->load;
		2168	}
753	}	2169	}
754		2170
755	# TODO: compatibility cruft, remove when no longer needed	2171	sub find_sync {
756	attach_to_players	2172	my ($path, $origin) = @_;
757	on_load => sub {
758	my ($pl, $path) = @_;
759		2173
760	for my $o (all_objects $pl->ob) {	2174	cf::sync_job { find $path, $origin }
761	if (my $value = $o->get_ob_key_value ("_perl_data")) {	2175	}
762	$o->set_ob_key_value ("_perl_data");
763		2176
764	%$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};
765	}	2210	}
766	}	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);
767	},	2249	}
768	;	2250	}
769		2251
770	#############################################################################	2252	sub swap_out {
		2253	my ($self) = @_;
771		2254
772	=head2 CORE EXTENSIONS	2255	# save first because save cedes
		2256	$self->save;
773		2257
774	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;
775		2404
776	=over 4	2405	=over 4
777		2406
778	=item cf::player::exists $login	2407	=item $ob->inv_recursive
779		2408
780	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.
781		2411
782	=cut	2412	=cut
783		2413
784	sub cf::player::exists($) {	2414	sub inv_recursive_;
785	cf::player::find $_[0]	2415	sub inv_recursive_ {
786	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	2416	map { $_, inv_recursive_ $_->inv } @_
787	}	2417	}
		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
788		2458
789	=item $player_object->reply ($npc, $msg[, $flags])	2459	=item $player_object->reply ($npc, $msg[, $flags])
790		2460
791	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>
792	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
793	dialogue with the given NPC character.	2463	dialogue with the given NPC character.
794		2464
795	=cut	2465	=cut
796		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
797	# rough implementation of a future "reply" method that works	2481	# rough implementation of a future "reply" method that works
798	# with dialog boxes.	2482	# with dialog boxes.
		2483	#TODO: the first argument must go, split into a $npc->reply_to ( method
799	sub cf::object::player::reply($$$;$) {	2484	sub cf::object::player::reply($$$;$) {
800	my ($self, $npc, $msg, $flags) = @_;	2485	my ($self, $npc, $msg, $flags) = @_;
801		2486
802	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2487	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
803		2488
804	if ($self->{record_replies}) {	2489	if ($self->{record_replies}) {
805	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2490	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2491
806	} 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 {
807	$msg = $npc->name . " says: $msg" if $npc;	2500	$msg = $npc->name . " says: $msg" if $npc;
808	$self->message ($msg, $flags);	2501	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2502	}
809	}	2503	}
810	}	2504	}
811		2505
812	=item $player->ext_reply ($msgid, $msgtype, %msg)	2506	=item $object->send_msg ($channel, $msg, $color, [extra...])
813		2507
814	Sends an ext reply to the player.
815
816	=cut	2508	=cut
817		2509
818	sub cf::player::ext_reply($$$%) {	2510	sub cf::object::send_msg {
819	my ($self, $id, %msg) = @_;	2511	my $pl = shift->contr
820		2512	or return;
821	$msg{msgid} = $id;	2513	$pl->send_msg (@_);
822
823	$self->send ("ext " . to_json \%msg);
824	}	2514	}
825		2515
826	=item $player_object->may ("access")	2516	=item $player_object->may ("access")
827		2517
828	Returns wether the given player is authorized to access resource "access"	2518	Returns wether the given player is authorized to access resource "access"
…		…
837	(ref $cf::CFG{"may_$access"}	2527	(ref $cf::CFG{"may_$access"}
838	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	2528	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
839	: $cf::CFG{"may_$access"})	2529	: $cf::CFG{"may_$access"})
840	}	2530	}
841		2531
842	=cut	2532	=item $player_object->enter_link
843		2533
844	#############################################################################	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,
		2695	};
		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
		2953	=item $client->ext_reply ($msgid, @msg)
		2954
		2955	Sends an ext reply to the client.
		2956
		2957	=cut
		2958
		2959	sub cf::client::ext_reply($$@) {
		2960	my ($self, $id, @msg) = @_;
		2961
		2962	if ($self->extcmd == 2) {
		2963	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @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	}
		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	);
		3084
		3085	=back
		3086
845		3087
846	=head2 SAFE SCRIPTING	3088	=head2 SAFE SCRIPTING
847		3089
848	Functions that provide a safe environment to compile and execute	3090	Functions that provide a safe environment to compile and execute
849	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
…		…
856	our $safe = new Safe "safe";	3098	our $safe = new Safe "safe";
857	our $safe_hole = new Safe::Hole;	3099	our $safe_hole = new Safe::Hole;
858		3100
859	$SIG{FPE} = 'IGNORE';	3101	$SIG{FPE} = 'IGNORE';
860		3102
861	$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	));
862		3108
863	# here we export the classes and methods available to script code	3109	# here we export the classes and methods available to script code
864		3110
865	=pod	3111	=pod
866		3112
867	The following fucntions and emthods are available within a safe environment:	3113	The following functions and methods are available within a safe environment:
868		3114
869	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
870	cf::object::player player	3119	cf::object::player
871	cf::player peaceful	3120	player
		3121
		3122	cf::player
		3123	peaceful
		3124
		3125	cf::map
		3126	trigger
872		3127
873	=cut	3128	=cut
874		3129
875	for (	3130	for (
876	["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 change_exp)],
877	["cf::object::player" => qw(player)],	3134	["cf::object::player" => qw(player)],
878	["cf::player" => qw(peaceful)],	3135	["cf::player" => qw(peaceful)],
		3136	["cf::map" => qw(trigger)],
879	) {	3137	) {
880	no strict 'refs';	3138	no strict 'refs';
881	my ($pkg, @funs) = @$_;	3139	my ($pkg, @funs) = @$_;
882	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3140	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
883	for @funs;	3141	for @funs;
…		…
951	=back	3209	=back
952		3210
953	=cut	3211	=cut
954		3212
955	#############################################################################	3213	#############################################################################
		3214	# the server's init and main functions
956		3215
957	=head2 EXTENSION DATABASE SUPPORT	3216	sub load_facedata($) {
		3217	my ($path) = @_;
958		3218
959	Crossfire maintains a very simple database for extension use. It can	3219	# HACK to clear player env face cache, we need some signal framework
960	currently store anything that can be serialised using Storable, which	3220	# for this (global event?)
961	excludes objects.	3221	%ext::player_env::MUSIC_FACE_CACHE = ();
962		3222
963	The parameter C<$family> should best start with the name of the extension	3223	my $enc = JSON::XS->new->utf8->canonical->relaxed;
964	using it, it should be unique.
965		3224
966	=over 4	3225	warn "loading facedata from $path\n";
967		3226
968	=item $hashref = cf::db_get $family	3227	my $facedata;
		3228	0 < aio_load $path, $facedata
		3229	or die "$path: $!";
969		3230
970	Return a hashref for use by the extension C<$family>, which can be	3231	$facedata = Coro::Storable::thaw $facedata;
971	modified. After modifications, you have to call C<cf::db_dirty> or
972	C<cf::db_sync>.
973		3232
974	=item $value = cf::db_get $family => $key	3233	$facedata->{version} == 2
		3234	or cf::cleanup "$path: version mismatch, cannot proceed.";
975		3235
976	Returns a single value from the database	3236	# patch in the exptable
977		3237	$facedata->{resource}{"res/exp_table"} = {
978	=item cf::db_put $family => $hashref	3238	type => FT_RSRC,
979		3239	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
980	Stores the given family hashref into the database. Updates are delayed, if
981	you want the data to be synced to disk immediately, use C<cf::db_sync>.
982
983	=item cf::db_put $family => $key => $value
984
985	Stores the given C<$value> in the family hash. Updates are delayed, if you
986	want the data to be synced to disk immediately, use C<cf::db_sync>.
987
988	=item cf::db_dirty
989
990	Marks the database as dirty, to be updated at a later time.
991
992	=item cf::db_sync
993
994	Immediately write the database to disk I<if it is dirty>.
995
996	=cut
997
998	our $DB;
999
1000	{
1001	my $path = cf::localdir . "/database.pst";
1002
1003	sub db_load() {
1004	warn "loading database $path\n";#d# remove later
1005	$DB = stat $path ? Storable::retrieve $path : { };
1006	}
1007
1008	my $pid;
1009
1010	sub db_save() {
1011	warn "saving database $path\n";#d# remove later
1012	waitpid $pid, 0 if $pid;
1013	if (0 == ($pid = fork)) {
1014	$DB->{_meta}{version} = 1;
1015	Storable::nstore $DB, "$path~";
1016	rename "$path~", $path;
1017	cf::_exit 0 if defined $pid;
1018	}
1019	}
1020
1021	my $dirty;
1022
1023	sub db_sync() {
1024	db_save if $dirty;
1025	undef $dirty;
1026	}
1027
1028	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {
1029	db_sync;
1030	});	3240	};
		3241	cf::cede_to_tick;
1031		3242
1032	sub db_dirty() {
1033	$dirty = 1;
1034	$idle->start;
1035	}	3243	{
		3244	my $faces = $facedata->{faceinfo};
1036		3245
1037	sub db_get($;$) {	3246	while (my ($face, $info) = each %$faces) {
1038	@_ >= 2	3247	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1039	? $DB->{$_[0]}{$_[1]}
1040	: ($DB->{$_[0]} ||= { })
1041	}
1042		3248
1043	sub db_put($$;$) {	3249	cf::face::set_visibility $idx, $info->{visibility};
1044	if (@_ >= 3) {	3250	cf::face::set_magicmap $idx, $info->{magicmap};
1045	$DB->{$_[0]}{$_[1]} = $_[2];	3251	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
1046	} else {	3252	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1047	$DB->{$_[0]} = $_[1];
1048	}
1049	db_dirty;
1050	}
1051		3253
1052	attach_global	3254	cf::cede_to_tick;
1053	prio => 10000,
1054	on_cleanup => sub {
1055	db_sync;
1056	},	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);
1057	;	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;
1058	}	3450	}
1059		3451
1060	#############################################################################	3452	#############################################################################
1061	# the server's main()	3453	# initialisation and cleanup
1062		3454
1063	sub cfg_load {	3455	# install some emergency cleanup handlers
1064	open my $fh, "<:utf8", cf::confdir . "/config"	3456	BEGIN {
		3457	our %SIGWATCHER = ();
		3458	for my $signal (qw(INT HUP TERM)) {
		3459	$SIGWATCHER{$signal} = EV::signal $signal, sub {
		3460	cf::cleanup "SIG$signal";
		3461	};
		3462	}
		3463	}
		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
1065	or return;	3476	or return;
1066		3477
1067	local $/;	3478	my $value = $cf::RUNTIME + 90 + 10;
1068	*CFG = YAML::Syck::Load <$fh>;	3479	# 10 is the runtime save interval, for a monotonic clock
1069	}	3480	# 60 allows for the watchdog to kill the server.
1070		3481
1071	sub main {	3482	(aio_write $fh, 0, (length $value), $value, 0) <= 0
1072	cfg_load;	3483	and return;
1073	db_load;
1074	load_extensions;
1075	Event::loop;
1076	}
1077		3484
1078	#############################################################################	3485	# always fsync - this file is important
1079	# initialisation	3486	aio_fsync $fh
		3487	and return;
1080		3488
1081	sub _perl_reload(&) {	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 {
1082	my ($msg) = @_;	3585	my ($make_core) = @_;
1083		3586
1084	$msg->("reloading...");	3587	warn Carp::longmess "post_cleanup backtrace"
		3588	if $make_core;
		3589	}
1085		3590
1086	eval {	3591	sub do_reload_perl() {
1087	# cancel all watchers	3592	# can/must only be called in main
1088	$_->cancel for Event::all_watchers;	3593	if ($Coro::current != $Coro::main) {
		3594	warn "can only reload from main coroutine";
		3595	return;
		3596	}
1089		3597
1090	# unload all extensions	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";
1091	for (@exts) {	3613	for (;;) {
1092	$msg->("unloading <$_>");	3614	BDB::flush;
1093	unload_extension $_;	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: $@";
1094	}	3643	}
1095		3644
		3645	warn "... nuking $pkg";
		3646	Symbol::delete_package $pkg;
		3647	}
		3648
1096	# unload all modules loaded from $LIBDIR	3649	warn "unloading all perl modules loaded from $LIBDIR";
1097	while (my ($k, $v) = each %INC) {	3650	while (my ($k, $v) = each %INC) {
1098	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3651	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1099		3652
1100	$msg->("removing <$k>");	3653	warn "... unloading $k";
1101	delete $INC{$k};	3654	delete $INC{$k};
1102		3655
1103	$k =~ s/\.pm$//;	3656	$k =~ s/\.pm$//;
1104	$k =~ s/\//::/g;	3657	$k =~ s/\//::/g;
1105		3658
…		…
1108	}	3661	}
1109		3662
1110	Symbol::delete_package $k;	3663	Symbol::delete_package $k;
1111	}	3664	}
1112		3665
1113	# sync database to disk
1114	cf::db_sync;
1115
1116	# get rid of safe::, as good as possible	3666	warn "getting rid of safe::, as good as possible";
1117	Symbol::delete_package "safe::$_"	3667	Symbol::delete_package "safe::$_"
1118	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);
1119		3669
1120	# remove register_script_function callbacks
1121	# TODO
1122
1123	# unload cf.pm "a bit"	3670	warn "unloading cf.pm \"a bit\"";
1124	delete $INC{"cf.pm"};	3671	delete $INC{"cf.pm"};
		3672	delete $INC{"cf/pod.pm"};
1125		3673
1126	# don't, removes xs symbols, too,	3674	# don't, removes xs symbols, too,
1127	# and global variables created in xs	3675	# and global variables created in xs
1128	#Symbol::delete_package __PACKAGE__;	3676	#Symbol::delete_package __PACKAGE__;
1129		3677
1130	# reload cf.pm	3678	warn "unload completed, starting to reload now";
		3679
1131	$msg->("reloading cf.pm");	3680	warn "reloading cf.pm";
1132	require cf;	3681	require cf;
		3682	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1133		3683
1134	# load config and database again	3684	warn "loading config and database again";
1135	cf::cfg_load;	3685	cf::reload_config;
1136	cf::db_load;
1137		3686
1138	# load extensions	3687	warn "loading extensions";
1139	$msg->("load extensions");
1140	cf::load_extensions;	3688	cf::load_extensions;
1141		3689
1142	# reattach attachments to objects	3690	warn "reattaching attachments to objects/players";
1143	$msg->("reattach");	3691	_global_reattach; # objects, sockets
1144	_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.";
1145	};	3703	};
1146	$msg->($@) if $@;
1147		3704
1148	$msg->("reloaded");	3705	warn "reloaded";
1149	};	3706	};
1150		3707
1151	sub perl_reload() {	3708	our $RELOAD_WATCHER; # used only during reload
1152	_perl_reload {	3709
1153	warn $_[0];	3710	sub reload_perl() {
1154	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;
1155	};	3717	};
1156	}	3718	}
1157		3719
1158	register_command "perl-reload", 0, sub {	3720	register_command "reload" => sub {
1159	my ($who, $arg) = @_;	3721	my ($who, $arg) = @_;
1160		3722
1161	if ($who->flag (FLAG_WIZ)) {	3723	if ($who->flag (FLAG_WIZ)) {
1162	_perl_reload {	3724	$who->message ("reloading server.");
1163	warn $_[0];	3725	async {
1164	$who->message ($_[0]);	3726	$Coro::current->{desc} = "perl_reload";
		3727	reload_perl;
1165	};	3728	};
1166	}	3729	}
1167	};	3730	};
1168		3731
1169	register "<global>", __PACKAGE__;
1170
1171	unshift @INC, $LIBDIR;	3732	unshift @INC, $LIBDIR;
1172		3733
1173	$TICK_WATCHER = Event->timer (	3734	my $bug_warning = 0;
1174	prio => 1,	3735
1175	async => 1,	3736	our @WAIT_FOR_TICK;
1176	at => $NEXT_TICK || 1,	3737	our @WAIT_FOR_TICK_BEGIN;
1177	cb => sub {	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
1178	cf::server_tick; # one server iteration	3762	cf::server_tick; # one server iteration
1179		3763
1180	my $NOW = Event::time;	3764	if ($NOW >= $NEXT_RUNTIME_WRITE) {
1181	$NEXT_TICK += $TICK;	3765	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
1182		3766	Coro::async_pool {
1183	# if we are delayed by four ticks or more, skip them all	3767	$Coro::current->{desc} = "runtime saver";
1184	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	3768	write_runtime_sync
1185		3769	or warn "ERROR: unable to write runtime file: $!";
1186	$TICK_WATCHER->at ($NEXT_TICK);	3770	};
1187	$TICK_WATCHER->start;
1188	},	3771	}
1189	);
1190		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);
		3802	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		3803	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		3804	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3805	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3806
		3807	cf::sync_job {
		3808	eval {
		3809	BDB::db_env_open
		3810	$DB_ENV,
		3811	$BDBDIR,
		3812	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3813	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3814	0666;
		3815
		3816	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3817	};
		3818
		3819	cf::cleanup "db_env_open(db): $@" if $@;
		3820	};
		3821	}
		3822
		3823	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3824	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3825	};
		3826	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		3827	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3828	};
		3829	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3830	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3831	};
		3832	}
		3833
		3834	{
		3835	# configure IO::AIO
		3836
		3837	IO::AIO::min_parallel 8;
1191	IO::AIO::max_poll_time $TICK * 0.2;	3838	IO::AIO::max_poll_time $TICK * 0.1;
		3839	undef $AnyEvent::AIO::WATCHER;
		3840	}
1192		3841
1193	Event->io (fd => IO::AIO::poll_fileno,	3842	my $_log_backtrace;
1194	poll => 'r',	3843
1195	prio => 5,	3844	sub _log_backtrace {
1196	cb => \&IO::AIO::poll_cb);	3845	my ($msg, @addr) = @_;
		3846
		3847	$msg =~ s/\n//;
		3848
		3849	# limit the # of concurrent backtraces
		3850	if ($_log_backtrace < 2) {
		3851	++$_log_backtrace;
		3852	async {
		3853	$Coro::current->{desc} = "abt $msg";
		3854
		3855	my @bt = fork_call {
		3856	@addr = map { sprintf "%x", $_ } @addr;
		3857	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3858	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3859	or die "addr2line: $!";
		3860
		3861	my @funcs;
		3862	my @res = <$fh>;
		3863	chomp for @res;
		3864	while (@res) {
		3865	my ($func, $line) = splice @res, 0, 2, ();
		3866	push @funcs, "[$func] $line";
		3867	}
		3868
		3869	@funcs
		3870	};
		3871
		3872	LOG llevInfo, "[ABT] $msg\n";
		3873	LOG llevInfo, "[ABT] $_\n" for @bt;
		3874	--$_log_backtrace;
		3875	};
		3876	} else {
		3877	LOG llevInfo, "[ABT] $msg\n";
		3878	LOG llevInfo, "[ABT] [suppressed]\n";
		3879	}
		3880	}
		3881
		3882	# load additional modules
		3883	use cf::pod;
		3884
		3885	END { cf::emergency_save }
1197		3886
1198	1	3887	1
1199		3888

Diff Legend

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