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

Diff Legend

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