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.93 by root, Thu Dec 21 22:41:35 2006 UTC vs.
Revision 1.444 by root, Mon Sep 8 11:27:25 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
		69
		70	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
20		71
21	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	72	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22		73
23	our %COMMAND = ();	74	our %COMMAND = ();
24	our %COMMAND_TIME = ();	75	our %COMMAND_TIME = ();
		76
		77	our @EXTS = (); # list of extension package names
25	our %EXTCMD = ();	78	our %EXTCMD = ();
		79	our %EXTICMD = ();
		80	our %EXT_CORO = (); # coroutines bound to extensions
		81	our %EXT_MAP = (); # pluggable maps
26		82
27	_init_vars;	83	our $RELOAD; # number of reloads so far
28
29	our @EVENT;	84	our @EVENT;
30	our $LIBDIR = datadir . "/ext";
31		85
32	our $TICK = MAX_TIME * 1e-6;	86	our $CONFDIR = confdir;
33	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
34	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;
35		108
36	our %CFG;	109	our %CFG;
37		110
38	our $UPTIME; $UPTIME ||= time;	111	our $UPTIME; $UPTIME ||= time;
		112	our $RUNTIME;
		113	our $NOW;
		114
		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;
39		143
40	#############################################################################	144	#############################################################################
41		145
42	=head2 GLOBAL VARIABLES	146	=head2 GLOBAL VARIABLES
43		147
…		…
45		149
46	=item $cf::UPTIME	150	=item $cf::UPTIME
47		151
48	The timestamp of the server start (so not actually an uptime).	152	The timestamp of the server start (so not actually an uptime).
49		153
50	=item $cf::LIBDIR	154	=item $cf::RUNTIME
51		155
52	The perl library directory, where extensions and cf-specific modules can	156	The time this server has run, starts at 0 and is increased by $cf::TICK on
53	be found. It will be added to C<@INC> automatically.	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.
54		171
55	=item $cf::TICK	172	=item $cf::TICK
56		173
57	The interval between server ticks, in seconds.	174	The interval between server ticks, in seconds.
58		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
59	=item %cf::CFG	186	=item %cf::CFG
60		187
61	Configuration for the server, loaded from C</etc/crossfire/config>, or	188	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
62	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.
63		202
64	=back	203	=back
65		204
66	=cut	205	=cut
67		206
68	BEGIN {	207	BEGIN {
69	*CORE::GLOBAL::warn = sub {	208	*CORE::GLOBAL::warn = sub {
70	my $msg = join "", @_;	209	my $msg = join "", @_;
		210
71	$msg .= "\n"	211	$msg .= "\n"
72	unless $msg =~ /\n$/;	212	unless $msg =~ /\n$/;
73		213
74	print STDERR "cfperl: $msg";	214	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		215
75	LOG llevError, "cfperl: $msg";	216	LOG llevError, $msg;
76	};	217	};
77	}	218	}
		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#?
78		234
79	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	235	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
80	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	236	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
81	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	237	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
82	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	238	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
83	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	239	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		240	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
84	@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)
85		242
86	# 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
87	# within the Safe compartment.	244	# within the Safe compartment.
88	for my $pkg (qw(	245	for my $pkg (qw(
89	cf::global	246	cf::global cf::attachable
90	cf::object cf::object::player	247	cf::object cf::object::player
91	cf::client cf::player	248	cf::client cf::player
92	cf::arch cf::living	249	cf::arch cf::living
		250	cf::map cf::mapspace
93	cf::map cf::party cf::region	251	cf::party cf::region
94	)) {	252	)) {
95	no strict 'refs';
96	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	253	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
97	}	254	}
98		255
99	$Event::DIED = sub {	256	$EV::DIED = sub {
100	warn "error in event callback: @_";	257	warn "error in event callback: @_";
101	};	258	};
102		259
103	my %ext_pkg;	260	#############################################################################
104	my @exts;
105	my @hook;
106		261
107	=head2 UTILITY FUNCTIONS	262	=head2 UTILITY FUNCTIONS
108		263
109	=over 4	264	=over 4
110		265
111	=cut	266	=item dumpval $ref
112		267
113	use JSON::Syck (); # TODO# replace by JSON::PC once working	268	=cut
114		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
115	=item $ref = cf::from_json $json	289	=item $ref = cf::decode_json $json
116		290
117	Converts a JSON string into the corresponding perl data structure.	291	Converts a JSON string into the corresponding perl data structure.
118		292
119	=cut
120
121	sub from_json($) {
122	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
123	JSON::Syck::Load $_[0]
124	}
125
126	=item $json = cf::to_json $ref	293	=item $json = cf::encode_json $ref
127		294
128	Converts a perl data structure into its JSON representation.	295	Converts a perl data structure into its JSON representation.
129		296
130	=cut	297	=cut
131		298
132	sub to_json($) {	299	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
133	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	300
134	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 });
135	}	722	}
136		723
137	=back	724	=back
138		725
139	=cut	726	=cut
140		727
141	#############################################################################	728	#############################################################################
142		729
143	=head2 ATTACHABLE OBJECTS	730	=head2 ATTACHABLE OBJECTS
144		731
145	You can define and attach attachments to each "attachable" object in	732	Many objects in crossfire are so-called attachable objects. That means you can
146	crossfire+ (objects, players, clients, maps and the special "global"	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
147	class). In the following description, CLASS can be any of C<global>,	736	In the following description, CLASS can be any of C<global>, C<object>
148	C<object> C<player>, C<client> or C<map>.	737	C<player>, C<client> or C<map> (i.e. the attachable objects in
		738	Deliantra).
149		739
150	=over 4	740	=over 4
151		741
		742	=item $attachable->attach ($attachment, key => $value...)
		743
		744	=item $attachable->detach ($attachment)
		745
		746	Attach/detach a pre-registered attachment to a specific object and give it
		747	the specified key/value pairs as arguments.
		748
		749	Example, attach a minesweeper attachment to the given object, making it a
		750	10x10 minesweeper game:
		751
		752	$obj->attach (minesweeper => width => 10, height => 10);
		753
		754	=item $bool = $attachable->attached ($name)
		755
		756	Checks wether the named attachment is currently attached to the object.
		757
		758	=item cf::CLASS->attach ...
		759
		760	=item cf::CLASS->detach ...
		761
		762	Define an anonymous attachment and attach it to all objects of the given
		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
152	=item cf::CLASS::attachment $name, ...	787	=item cf::CLASS::attachment $name, ...
153		788
154	Register an attachment by name through which attachable objects can refer	789	Register an attachment by C<$name> through which attachable objects of the
155	to this attachment.	790	given CLASS can refer to this attachment.
156		791
157	=item $bool = $attachable->attached ($name)	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.
158		794
159	Checks wether the named attachment is currently attached to the object.
160
161	=item $attachable->attach ($attachment, key => $value...)
162
163	=item $attachable->detach ($attachment)
164
165	Attach/detach a pre-registered attachment either to a specific object
166	(C<$attachable>) or all objects of the given class (if C<$attachable> is a
167	class in a static method call).
168
169	You can attach to global events by using the C<cf::global> class.
170
171	These method calls expect any number of the following handler/hook	795	These calls expect any number of the following handler/hook descriptions:
172	descriptions:
173		796
174	=over 4	797	=over 4
175		798
176	=item prio => $number	799	=item prio => $number
177		800
…		…
203	package and register them. Only handlers for eevents supported by the	826	package and register them. Only handlers for eevents supported by the
204	object/class are recognised.	827	object/class are recognised.
205		828
206	=back	829	=back
207		830
		831	Example, define an attachment called "sockpuppet" that calls the given
		832	event handler when a monster attacks:
		833
		834	cf::object::attachment sockpuppet =>
		835	on_skill_attack => sub {
		836	my ($self, $victim) = @_;
		837	...
		838	}
		839	}
		840
		841	=item $attachable->valid
		842
		843	Just because you have a perl object does not mean that the corresponding
		844	C-level object still exists. If you try to access an object that has no
		845	valid C counterpart anymore you get an exception at runtime. This method
		846	can be used to test for existence of the C object part without causing an
		847	exception.
		848
208	=cut	849	=cut
209		850
210	# the following variables are defined in .xs and must not be re-created	851	# the following variables are defined in .xs and must not be re-created
211	our @CB_GLOBAL = (); # registry for all global events	852	our @CB_GLOBAL = (); # registry for all global events
		853	our @CB_ATTACHABLE = (); # registry for all attachables
212	our @CB_OBJECT = (); # all objects (should not be used except in emergency)	854	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
213	our @CB_PLAYER = ();	855	our @CB_PLAYER = ();
214	our @CB_CLIENT = ();	856	our @CB_CLIENT = ();
215	our @CB_TYPE = (); # registry for type (cf-object class) based events	857	our @CB_TYPE = (); # registry for type (cf-object class) based events
216	our @CB_MAP = ();	858	our @CB_MAP = ();
217		859
218	my %attachment;	860	my %attachment;
		861
		862	sub cf::attachable::thawer_merge {
		863	# simply override everything except _meta
		864	local $_[0]{_meta};
		865	%{$_[0]} = %{$_[1]};
		866	}
219		867
220	sub _attach_cb($$$$) {	868	sub _attach_cb($$$$) {
221	my ($registry, $event, $prio, $cb) = @_;	869	my ($registry, $event, $prio, $cb) = @_;
222		870
223	use sort 'stable';	871	use sort 'stable';
…		…
226		874
227	@{$registry->[$event]} = sort	875	@{$registry->[$event]} = sort
228	{ $a->[0] cmp $b->[0] }	876	{ $a->[0] cmp $b->[0] }
229	@{$registry->[$event] || []}, $cb;	877	@{$registry->[$event] || []}, $cb;
230	}	878	}
		879
		880	# hack
		881	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
231		882
232	# attach handles attaching event callbacks	883	# attach handles attaching event callbacks
233	# the only thing the caller has to do is pass the correct	884	# the only thing the caller has to do is pass the correct
234	# registry (== where the callback attaches to).	885	# registry (== where the callback attaches to).
235	sub _attach {	886	sub _attach {
…		…
237		888
238	my $object_type;	889	my $object_type;
239	my $prio = 0;	890	my $prio = 0;
240	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;	891	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
241		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
242	while (@arg) {	898	while (@arg) {
243	my $type = shift @arg;	899	my $type = shift @arg;
244		900
245	if ($type eq "prio") {	901	if ($type eq "prio") {
246	$prio = shift @arg;	902	$prio = shift @arg;
…		…
250	$registry = $CB_TYPE[$object_type] ||= [];	906	$registry = $CB_TYPE[$object_type] ||= [];
251		907
252	} elsif ($type eq "subtype") {	908	} elsif ($type eq "subtype") {
253	defined $object_type or Carp::croak "subtype specified without type";	909	defined $object_type or Carp::croak "subtype specified without type";
254	my $object_subtype = shift @arg;	910	my $object_subtype = shift @arg;
255	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	911	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
256		912
257	} elsif ($type eq "package") {	913	} elsif ($type eq "package") {
258	my $pkg = shift @arg;	914	my $pkg = shift @arg;
259		915
260	while (my ($name, $id) = each %cb_id) {	916	while (my ($name, $id) = each %cb_id) {
…		…
289	_attach $registry, $klass, @attach;	945	_attach $registry, $klass, @attach;
290	}	946	}
291		947
292	$obj->{$name} = \%arg;	948	$obj->{$name} = \%arg;
293	} else {	949	} else {
294	warn "object uses attachment '$name' that is not available, postponing.\n";	950	warn "object uses attachment '$name' which is not available, postponing.\n";
295	}	951	}
296		952
297	$obj->{_attachment}{$name} = undef;	953	$obj->{_attachment}{$name} = undef;
298	}	954	}
299		955
…		…
301	if (ref $_[0]) {	957	if (ref $_[0]) {
302	_object_attach @_;	958	_object_attach @_;
303	} else {	959	} else {
304	_attach shift->_attach_registry, @_;	960	_attach shift->_attach_registry, @_;
305	}	961	}
		962	_recalc_want;
306	};	963	};
307		964
308	# all those should be optimised	965	# all those should be optimised
309	sub cf::attachable::detach {	966	sub cf::attachable::detach {
310	my ($obj, $name) = @_;	967	my ($obj, $name) = @_;
…		…
313	delete $obj->{_attachment}{$name};	970	delete $obj->{_attachment}{$name};
314	reattach ($obj);	971	reattach ($obj);
315	} else {	972	} else {
316	Carp::croak "cannot, currently, detach class attachments";	973	Carp::croak "cannot, currently, detach class attachments";
317	}	974	}
		975	_recalc_want;
318	};	976	};
319		977
320	sub cf::attachable::attached {	978	sub cf::attachable::attached {
321	my ($obj, $name) = @_;	979	my ($obj, $name) = @_;
322		980
323	exists $obj->{_attachment}{$name}	981	exists $obj->{_attachment}{$name}
324	}	982	}
325		983
326	for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) {	984	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
327	eval "#line " . __LINE__ . " 'cf.pm'	985	eval "#line " . __LINE__ . " 'cf.pm'
328	sub cf::\L$klass\E::_attach_registry {	986	sub cf::\L$klass\E::_attach_registry {
329	(\\\@CB_$klass, KLASS_$klass)	987	(\\\@CB_$klass, KLASS_$klass)
330	}	988	}
331		989
…		…
337	";	995	";
338	die if $@;	996	die if $@;
339	}	997	}
340		998
341	our $override;	999	our $override;
342	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	1000	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
343		1001
344	sub override {	1002	sub override {
345	$override = 1;	1003	$override = 1;
346	@invoke_results = ();	1004	@INVOKE_RESULTS = (@_);
347	}	1005	}
348		1006
349	sub do_invoke {	1007	sub do_invoke {
350	my $event = shift;	1008	my $event = shift;
351	my $callbacks = shift;	1009	my $callbacks = shift;
352		1010
353	@invoke_results = ();	1011	@INVOKE_RESULTS = ();
354		1012
355	local $override;	1013	local $override;
356		1014
357	for (@$callbacks) {	1015	for (@$callbacks) {
358	eval { &{$_->[1]} };	1016	eval { &{$_->[1]} };
…		…
367	}	1025	}
368		1026
369	0	1027	0
370	}	1028	}
371		1029
372	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	1030	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
373		1031
374	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
375
376	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
377
378	=item $bool = $client->invoke (EVENT_CLIENT_XXX, ...)	1032	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
379		1033
380	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
381
382	Generate a global/object/player/map-specific event with the given arguments.	1034	Generate an object-specific event with the given arguments.
383		1035
384	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be	1036	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
385	removed in future versions), and there is no public API to access override	1037	removed in future versions), and there is no public API to access override
386	results (if you must, access C<@cf::invoke_results> directly).	1038	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
387
388	=back
389
390	=cut
391
392	#############################################################################
393
394	=head2 METHODS VALID FOR ALL ATTACHABLE OBJECTS
395
396	Attachable objects includes objects, players, clients and maps.
397
398	=over 4
399
400	=item $object->valid
401
402	Just because you have a perl object does not mean that the corresponding
403	C-level object still exists. If you try to access an object that has no
404	valid C counterpart anymore you get an exception at runtime. This method
405	can be used to test for existence of the C object part without causing an
406	exception.
407		1039
408	=back	1040	=back
409		1041
410	=cut	1042	=cut
411		1043
412	#############################################################################	1044	#############################################################################
413	# object support	1045	# object support
414		1046
415	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 {
416	my ($obj, $data) = @_;	1081	my ($ob1, $ob2) = @_;
417		1082
418	$data = from_json $data;	1083	++$SLOW_MERGES;#d#
419		1084
420	for (@$data) {	1085	# we do the slow way here
421	my ($name, $args) = @$_;	1086	return _object_equal $ob1, $ob2
422
423	$obj->attach ($name, %{$args || {} });
424	}
425	}	1087	}
426		1088
427	# basically do the same as instantiate, without calling instantiate
428	sub reattach {	1089	sub reattach {
		1090	# basically do the same as instantiate, without calling instantiate
429	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
430	my $registry = $obj->registry;	1096	my $registry = $obj->registry;
431		1097
432	@$registry = ();	1098	@$registry = ();
433		1099
434	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	1100	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
…		…
443	warn "object uses attachment '$name' that is not available, postponing.\n";	1109	warn "object uses attachment '$name' that is not available, postponing.\n";
444	}	1110	}
445	}	1111	}
446	}	1112	}
447		1113
448	sub object_freezer_save {	1114	cf::attachable->attach (
449	my ($filename, $rdata, $objs) = @_;
450
451	if (length $$rdata) {
452	warn sprintf "saving %s (%d,%d)\n",
453	$filename, length $$rdata, scalar @$objs;
454
455	if (open my $fh, ">:raw", "$filename~") {
456	chmod SAVE_MODE, $fh;
457	syswrite $fh, $$rdata;
458	close $fh;
459
460	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
461	chmod SAVE_MODE, $fh;
462	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
463	close $fh;
464	rename "$filename.pst~", "$filename.pst";
465	} else {
466	unlink "$filename.pst";
467	}
468
469	rename "$filename~", $filename;
470	} else {
471	warn "FATAL: $filename~: $!\n";
472	}
473	} else {
474	unlink $filename;
475	unlink "$filename.pst";
476	}
477	}
478
479	sub object_freezer_as_string {
480	my ($rdata, $objs) = @_;
481
482	use Data::Dumper;
483
484	$$rdata . Dumper $objs
485	}
486
487	sub object_thawer_load {
488	my ($filename) = @_;
489
490	local $/;
491
492	my $av;
493
494	#TODO: use sysread etc.
495	if (open my $data, "<:raw:perlio", $filename) {
496	$data = <$data>;
497	if (open my $pst, "<:raw:perlio", "$filename.pst") {
498	$av = eval { (Storable::thaw <$pst>)->{objs} };
499	}
500	return ($data, $av);
501	}
502
503	()
504	}
505
506	cf::object->attach (
507	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,
508	on_clone => sub {	1128	on_clone => sub {
509	my ($src, $dst) = @_;	1129	my ($src, $dst) = @_;
510		1130
511	@{$dst->registry} = @{$src->registry};	1131	@{$dst->registry} = @{$src->registry};
512		1132
…		…
515	%{$dst->{_attachment}} = %{$src->{_attachment}}	1135	%{$dst->{_attachment}} = %{$src->{_attachment}}
516	if exists $src->{_attachment};	1136	if exists $src->{_attachment};
517	},	1137	},
518	);	1138	);
519		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
		1215
520	#############################################################################	1216	#############################################################################
521	# command handling &c	1217	# command handling &c
522		1218
523	=item cf::register_command $name => \&callback($ob,$args);	1219	=item cf::register_command $name => \&callback($ob,$args);
524		1220
…		…
536	push @{ $COMMAND{$name} }, [$caller, $cb];	1232	push @{ $COMMAND{$name} }, [$caller, $cb];
537	}	1233	}
538		1234
539	=item cf::register_extcmd $name => \&callback($pl,$packet);	1235	=item cf::register_extcmd $name => \&callback($pl,$packet);
540		1236
541	Register a callbackf ro execution when the client sends an extcmd packet.	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.
542		1242
543	If the callback returns something, it is sent back as if reply was being	1243	If the callback returns something, it is sent back as if reply was being
544	called.	1244	called.
545		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
546	=cut	1257	=cut
547		1258
548	sub register_extcmd {	1259	sub register_extcmd {
549	my ($name, $cb) = @_;	1260	my ($name, $cb) = @_;
550		1261
551	my $caller = caller;
552	#warn "registering extcmd '$name' to '$caller'";
553
554	$EXTCMD{$name} = [$cb, $caller];	1262	$EXTCMD{$name} = $cb;
		1263	}
		1264
		1265	sub register_exticmd {
		1266	my ($name, $cb) = @_;
		1267
		1268	$EXTICMD{$name} = $cb;
555	}	1269	}
556		1270
557	cf::player->attach (	1271	cf::player->attach (
558	on_command => sub {	1272	on_command => sub {
559	my ($pl, $name, $params) = @_;	1273	my ($pl, $name, $params) = @_;
…		…
568	cf::override;	1282	cf::override;
569	},	1283	},
570	on_extcmd => sub {	1284	on_extcmd => sub {
571	my ($pl, $buf) = @_;	1285	my ($pl, $buf) = @_;
572		1286
573	my $msg = eval { from_json $buf };	1287	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
574		1288
575	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
576	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1297	if (my $cb = $EXTCMD{$type}) {
577	if (my %reply = $cb->[0]->($pl, $msg)) {	1298	@reply = $cb->($pl, @payload);
578	$pl->ext_reply ($msg->{msgid}, %reply);
579	}
580	}	1299	}
		1300
		1301	$pl->ext_reply ($reply, @reply)
		1302	if $reply;
		1303
581	} else {	1304	} else {
582	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1305	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
583	}	1306	}
584		1307
585	cf::override;	1308	cf::override;
586	},	1309	},
587	);	1310	);
588		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 have 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	=item $player->ext_reply ($msgid, @msg)
		1629
		1630	Sends an ext reply to the player.
		1631
		1632	=cut
		1633
		1634	sub ext_reply($$@) {
		1635	my ($self, $id, @msg) = @_;
		1636
		1637	$self->ns->ext_reply ($id, @msg)
		1638	}
		1639
		1640	=item $player->ext_msg ($type, @msg)
		1641
		1642	Sends an ext event to the client.
		1643
		1644	=cut
		1645
		1646	sub ext_msg($$@) {
		1647	my ($self, $type, @msg) = @_;
		1648
		1649	$self->ns->ext_msg ($type, @msg);
		1650	}
		1651
		1652	=head3 cf::region
		1653
		1654	=over 4
		1655
		1656	=cut
		1657
		1658	package cf::region;
		1659
		1660	=item cf::region::find_by_path $path
		1661
		1662	Tries to decuce the likely region for a map knowing only its path.
		1663
		1664	=cut
		1665
		1666	sub find_by_path($) {
		1667	my ($path) = @_;
		1668
		1669	my ($match, $specificity);
		1670
		1671	for my $region (list) {
		1672	if ($region->{match} && $path =~ $region->{match}) {
		1673	($match, $specificity) = ($region, $region->specificity)
		1674	if $region->specificity > $specificity;
		1675	}
		1676	}
		1677
		1678	$match
		1679	}
		1680
		1681	=back
		1682
		1683	=head3 cf::map
		1684
		1685	=over 4
		1686
		1687	=cut
		1688
		1689	package cf::map;
		1690
		1691	use Fcntl;
		1692	use Coro::AIO;
		1693
		1694	use overload
		1695	'""' => \&as_string,
		1696	fallback => 1;
		1697
		1698	our $MAX_RESET = 3600;
		1699	our $DEFAULT_RESET = 3000;
		1700
		1701	sub generate_random_map {
		1702	my ($self, $rmp) = @_;
		1703
		1704	my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
		1705
		1706	# mit "rum" bekleckern, nicht
		1707	$self->_create_random_map (
		1708	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1709	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1710	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1711	$rmp->{exit_on_final_map},
		1712	$rmp->{xsize}, $rmp->{ysize},
		1713	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1714	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1715	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1716	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1717	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1718	(cf::region::find $rmp->{region}), $rmp->{custom}
		1719	)
		1720	}
		1721
		1722	=item cf::map->register ($regex, $prio)
		1723
		1724	Register a handler for the map path matching the given regex at the
		1725	givne priority (higher is better, built-in handlers have priority 0, the
		1726	default).
		1727
		1728	=cut
		1729
589	sub register {	1730	sub register {
		1731	my (undef, $regex, $prio) = @_;
		1732	my $pkg = caller;
		1733
		1734	no strict;
		1735	push @{"$pkg\::ISA"}, __PACKAGE__;
		1736
		1737	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1738	}
		1739
		1740	# also paths starting with '/'
		1741	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1742
		1743	sub thawer_merge {
590	my ($base, $pkg) = @_;	1744	my ($self, $merge) = @_;
591		1745
592	#TODO	1746	# we have to keep some variables in memory intact
593	}	1747	local $self->{path};
		1748	local $self->{load_path};
594		1749
595	sub load_extension {	1750	$self->SUPER::thawer_merge ($merge);
		1751	}
		1752
		1753	sub normalise {
596	my ($path) = @_;	1754	my ($path, $base) = @_;
597		1755
598	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1756	$path = "$path"; # make sure its a string
599	my $base = $1;
600	my $pkg = $1;
601	$pkg =~ s/[^[:word:]]/_/g;
602	$pkg = "ext::$pkg";
603		1757
604	warn "loading '$path' into '$pkg'\n";	1758	$path =~ s/\.map$//;
605		1759
606	open my $fh, "<:utf8", $path	1760	# map plan:
607	or die "$path: $!";	1761	#
		1762	# /! non-realised random map exit (special hack!)
		1763	# {... are special paths that are not being touched
		1764	# ?xxx/... are special absolute paths
		1765	# ?random/... random maps
		1766	# /... normal maps
		1767	# ~user/... per-player map of a specific user
608		1768
609	my $source =	1769	$path =~ s/$PATH_SEP/\//go;
610	"package $pkg; use strict; use utf8;\n"
611	. "#line 1 \"$path\"\n{\n"
612	. (do { local $/; <$fh> })
613	. "\n};\n1";
614		1770
615	eval $source	1771	# treat it as relative path if it starts with
616	or die $@ ? "$path: $@\n"	1772	# something that looks reasonable
617	: "extension disabled.\n";	1773	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1774	$base or Carp::carp "normalise called with relative path and no base: '$path'";
618		1775
619	push @exts, $pkg;	1776	$base =~ s{[^/]+/?$}{};
620	$ext_pkg{$base} = $pkg;	1777	$path = "$base/$path";
621
622	# no strict 'refs';
623	# @{"$pkg\::ISA"} = ext::;
624
625	register $base, $pkg;
626	}
627
628	sub unload_extension {
629	my ($pkg) = @_;
630
631	warn "removing extension $pkg\n";
632
633	# remove hooks
634	#TODO
635	# for my $idx (0 .. $#PLUGIN_EVENT) {
636	# delete $hook[$idx]{$pkg};
637	# }	1778	}
638		1779
639	# remove commands	1780	for ($path) {
640	for my $name (keys %COMMAND) {	1781	redo if s{//}{/};
641	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };	1782	redo if s{/\.?/}{/};
		1783	redo if s{/[^/]+/\.\./}{/};
		1784	}
642		1785
643	if (@cb) {	1786	$path
644	$COMMAND{$name} = \@cb;	1787	}
		1788
		1789	sub new_from_path {
		1790	my (undef, $path, $base) = @_;
		1791
		1792	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1793
		1794	$path = normalise $path, $base;
		1795
		1796	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1797	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1798	my $self = bless cf::map::new, $pkg;
		1799	$self->{path} = $path; $self->path ($path);
		1800	$self->init; # pass $1 etc.
		1801	return $self;
		1802	}
		1803	}
		1804
		1805	Carp::cluck "unable to resolve path '$path' (base '$base').";
		1806	()
		1807	}
		1808
		1809	sub init {
		1810	my ($self) = @_;
		1811
		1812	$self
		1813	}
		1814
		1815	sub as_string {
		1816	my ($self) = @_;
		1817
		1818	"$self->{path}"
		1819	}
		1820
		1821	# the displayed name, this is a one way mapping
		1822	sub visible_name {
		1823	&as_string
		1824	}
		1825
		1826	# the original (read-only) location
		1827	sub load_path {
		1828	my ($self) = @_;
		1829
		1830	"$MAPDIR/$self->{path}.map"
		1831	}
		1832
		1833	# the temporary/swap location
		1834	sub save_path {
		1835	my ($self) = @_;
		1836
		1837	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
		1838	"$TMPDIR/$path.map"
		1839	}
		1840
		1841	# the unique path, undef == no special unique path
		1842	sub uniq_path {
		1843	my ($self) = @_;
		1844
		1845	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
		1846	"$UNIQUEDIR/$path"
		1847	}
		1848
		1849	# and all this just because we cannot iterate over
		1850	# all maps in C++...
		1851	sub change_all_map_light {
		1852	my ($change) = @_;
		1853
		1854	$_->change_map_light ($change)
		1855	for grep $_->outdoor, values %cf::MAP;
		1856	}
		1857
		1858	sub decay_objects {
		1859	my ($self) = @_;
		1860
		1861	return if $self->{deny_reset};
		1862
		1863	$self->do_decay_objects;
		1864	}
		1865
		1866	sub unlink_save {
		1867	my ($self) = @_;
		1868
		1869	utf8::encode (my $save = $self->save_path);
		1870	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1871	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1872	}
		1873
		1874	sub load_header_from($) {
		1875	my ($self, $path) = @_;
		1876
		1877	utf8::encode $path;
		1878	my $f = new_from_file cf::object::thawer $path
		1879	or return;
		1880
		1881	$self->_load_header ($f)
		1882	or return;
		1883
		1884	local $MAP_LOADING{$self->{path}} = $self;
		1885	$f->resolve_delayed_derefs;
		1886
		1887	$self->{load_path} = $path;
		1888
		1889	1
		1890	}
		1891
		1892	sub load_header_orig {
		1893	my ($self) = @_;
		1894
		1895	$self->load_header_from ($self->load_path)
		1896	}
		1897
		1898	sub load_header_temp {
		1899	my ($self) = @_;
		1900
		1901	$self->load_header_from ($self->save_path)
		1902	}
		1903
		1904	sub prepare_temp {
		1905	my ($self) = @_;
		1906
		1907	$self->last_access ((delete $self->{last_access})
		1908	|| $cf::RUNTIME); #d#
		1909	# safety
		1910	$self->{instantiate_time} = $cf::RUNTIME
		1911	if $self->{instantiate_time} > $cf::RUNTIME;
		1912	}
		1913
		1914	sub prepare_orig {
		1915	my ($self) = @_;
		1916
		1917	$self->{load_original} = 1;
		1918	$self->{instantiate_time} = $cf::RUNTIME;
		1919	$self->last_access ($cf::RUNTIME);
		1920	$self->instantiate;
		1921	}
		1922
		1923	sub load_header {
		1924	my ($self) = @_;
		1925
		1926	if ($self->load_header_temp) {
		1927	$self->prepare_temp;
645	} else {	1928	} else {
646	delete $COMMAND{$name};	1929	$self->load_header_orig
647	}	1930	or return;
		1931	$self->prepare_orig;
		1932	}
		1933
		1934	$self->{deny_reset} = 1
		1935	if $self->no_reset;
		1936
		1937	$self->default_region (cf::region::find_by_path $self->{path})
		1938	unless $self->default_region;
		1939
648	}	1940	1
		1941	}
649		1942
650	# remove extcmds	1943	sub find;
651	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {	1944	sub find {
652	delete $EXTCMD{$name};	1945	my ($path, $origin) = @_;
		1946
		1947	$path = normalise $path, $origin && $origin->path;
		1948
		1949	cf::lock_wait "map_data:$path";#d#remove
		1950	cf::lock_wait "map_find:$path";
		1951
		1952	$cf::MAP{$path} || do {
		1953	my $guard1 = cf::lock_acquire "map_data:$path"; # just for the fun of it
		1954	my $guard2 = cf::lock_acquire "map_find:$path";
		1955
		1956	my $map = new_from_path cf::map $path
		1957	or return;
		1958
		1959	$map->{last_save} = $cf::RUNTIME;
		1960
		1961	$map->load_header
		1962	or return;
		1963
		1964	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1965	# doing this can freeze the server in a sync job, obviously
		1966	#$cf::WAIT_FOR_TICK->wait;
		1967	undef $guard2;
		1968	undef $guard1;
		1969	$map->reset;
		1970	return find $path;
		1971	}
		1972
		1973	$cf::MAP{$path} = $map
		1974	}
		1975	}
		1976
		1977	sub pre_load { }
		1978	sub post_load { }
		1979
		1980	sub load {
		1981	my ($self) = @_;
		1982
		1983	local $self->{deny_reset} = 1; # loading can take a long time
		1984
		1985	my $path = $self->{path};
		1986
653	}	1987	{
		1988	my $guard = cf::lock_acquire "map_data:$path";
654		1989
655	if (my $cb = $pkg->can ("unload")) {	1990	return unless $self->valid;
656	eval {	1991	return unless $self->in_memory == cf::MAP_SWAPPED;
657	$cb->($pkg);	1992
		1993	$self->in_memory (cf::MAP_LOADING);
		1994
		1995	$self->alloc;
		1996
		1997	$self->pre_load;
		1998	cf::cede_to_tick;
		1999
		2000	my $f = new_from_file cf::object::thawer $self->{load_path};
		2001	$f->skip_block;
		2002	$self->_load_objects ($f)
		2003	or return;
		2004
		2005	$self->post_load_original
		2006	if delete $self->{load_original};
		2007
		2008	if (my $uniq = $self->uniq_path) {
		2009	utf8::encode $uniq;
		2010	unless (aio_stat $uniq) {
		2011	if (my $f = new_from_file cf::object::thawer $uniq) {
		2012	$self->clear_unique_items;
		2013	$self->_load_objects ($f);
		2014	$f->resolve_delayed_derefs;
		2015	}
658	1	2016	}
659	} or warn "$pkg unloaded, but with errors: $@";	2017	}
660	}
661		2018
662	Symbol::delete_package $pkg;	2019	$f->resolve_delayed_derefs;
663	}
664		2020
665	sub load_extensions {	2021	cf::cede_to_tick;
666	for my $ext (<$LIBDIR/*.ext>) {	2022	# now do the right thing for maps
667	next unless -r $ext;	2023	$self->link_multipart_objects;
668	eval {	2024	$self->difficulty ($self->estimate_difficulty)
669	load_extension $ext;	2025	unless $self->difficulty;
670	1	2026	cf::cede_to_tick;
671	} or warn "$ext not loaded: $@";
672	}
673	}
674		2027
675	#############################################################################	2028	unless ($self->{deny_activate}) {
676	# load/save/clean perl data associated with a map	2029	$self->decay_objects;
		2030	$self->fix_auto_apply;
		2031	$self->update_buttons;
		2032	cf::cede_to_tick;
		2033	$self->set_darkness_map;
		2034	cf::cede_to_tick;
		2035	$self->activate;
		2036	}
677		2037
678	*cf::mapsupport::on_clean = sub {	2038	$self->{last_save} = $cf::RUNTIME;
		2039	$self->last_access ($cf::RUNTIME);
		2040
		2041	$self->in_memory (cf::MAP_ACTIVE);
		2042	}
		2043
		2044	$self->post_load;
		2045	}
		2046
		2047	sub customise_for {
		2048	my ($self, $ob) = @_;
		2049
		2050	return find "~" . $ob->name . "/" . $self->{path}
		2051	if $self->per_player;
		2052
		2053	# return find "?party/" . $ob->name . "/" . $self->{path}
		2054	# if $self->per_party;
		2055
		2056	$self
		2057	}
		2058
		2059	# find and load all maps in the 3x3 area around a map
		2060	sub load_neighbours {
679	my ($map) = @_;	2061	my ($map) = @_;
680		2062
681	my $path = $map->tmpname;	2063	my @neigh; # diagonal neighbours
682	defined $path or return;
683		2064
684	unlink "$path.pst";	2065	for (0 .. 3) {
685	};	2066	my $neigh = $map->tile_path ($_)
		2067	or next;
		2068	$neigh = find $neigh, $map
		2069	or next;
		2070	$neigh->load;
686		2071
687	cf::map->attach (prio => -10000, package => cf::mapsupport::);	2072	push @neigh,
		2073	[$neigh->tile_path (($_ + 3) % 4), $neigh],
		2074	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		2075	}
688		2076
689	#############################################################################	2077	for (grep defined $_->[0], @neigh) {
690	# load/save perl data associated with player->ob objects	2078	my ($path, $origin) = @$_;
691		2079	my $neigh = find $path, $origin
692	sub all_objects(@) {	2080	or next;
693	@_, map all_objects ($_->inv), @_	2081	$neigh->load;
		2082	}
694	}	2083	}
695		2084
696	# TODO: compatibility cruft, remove when no longer needed	2085	sub find_sync {
697	cf::player->attach (	2086	my ($path, $origin) = @_;
698	on_load => sub {
699	my ($pl, $path) = @_;
700		2087
701	for my $o (all_objects $pl->ob) {	2088	cf::sync_job { find $path, $origin }
702	if (my $value = $o->get_ob_key_value ("_perl_data")) {	2089	}
703	$o->set_ob_key_value ("_perl_data");
704		2090
705	%$o = %{ Storable::thaw pack "H*", $value };	2091	sub do_load_sync {
		2092	my ($map) = @_;
		2093
		2094	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2095	if $Coro::current == $Coro::main;
		2096
		2097	cf::sync_job { $map->load };
		2098	}
		2099
		2100	our %MAP_PREFETCH;
		2101	our $MAP_PREFETCHER = undef;
		2102
		2103	sub find_async {
		2104	my ($path, $origin, $load) = @_;
		2105
		2106	$path = normalise $path, $origin && $origin->{path};
		2107
		2108	if (my $map = $cf::MAP{$path}) {
		2109	return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
		2110	}
		2111
		2112	$MAP_PREFETCH{$path} |= $load;
		2113
		2114	$MAP_PREFETCHER ||= cf::async {
		2115	$Coro::current->{desc} = "map prefetcher";
		2116
		2117	while (%MAP_PREFETCH) {
		2118	while (my ($k, $v) = each %MAP_PREFETCH) {
		2119	if (my $map = find $k) {
		2120	$map->load if $v;
		2121	}
		2122
		2123	delete $MAP_PREFETCH{$k};
706	}	2124	}
707	}	2125	}
		2126	undef $MAP_PREFETCHER;
		2127	};
		2128	$MAP_PREFETCHER->prio (6);
		2129
		2130	()
		2131	}
		2132
		2133	sub save {
		2134	my ($self) = @_;
		2135
		2136	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2137
		2138	$self->{last_save} = $cf::RUNTIME;
		2139
		2140	return unless $self->dirty;
		2141
		2142	my $save = $self->save_path; utf8::encode $save;
		2143	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2144
		2145	$self->{load_path} = $save;
		2146
		2147	return if $self->{deny_save};
		2148
		2149	local $self->{last_access} = $self->last_access;#d#
		2150
		2151	cf::async {
		2152	$Coro::current->{desc} = "map player save";
		2153	$_->contr->save for $self->players;
		2154	};
		2155
		2156	cf::get_slot 0.02;
		2157
		2158	if ($uniq) {
		2159	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		2160	$self->_save_objects ($uniq, cf::IO_UNIQUES);
		2161	} else {
		2162	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
708	},	2163	}
709	);	2164	}
710		2165
711	#############################################################################	2166	sub swap_out {
		2167	my ($self) = @_;
712		2168
713	=head2 CORE EXTENSIONS	2169	# save first because save cedes
		2170	$self->save;
714		2171
715	Functions and methods that extend core crossfire objects.	2172	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2173
		2174	return if $self->players;
		2175	return if $self->in_memory != cf::MAP_ACTIVE;
		2176	return if $self->{deny_save};
		2177
		2178	$self->in_memory (cf::MAP_SWAPPED);
		2179
		2180	$self->deactivate;
		2181	$_->clear_links_to ($self) for values %cf::MAP;
		2182	$self->clear;
		2183	}
		2184
		2185	sub reset_at {
		2186	my ($self) = @_;
		2187
		2188	# TODO: safety, remove and allow resettable per-player maps
		2189	return 1e99 if $self->{deny_reset};
		2190
		2191	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		2192	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		2193
		2194	$time + $to
		2195	}
		2196
		2197	sub should_reset {
		2198	my ($self) = @_;
		2199
		2200	$self->reset_at <= $cf::RUNTIME
		2201	}
		2202
		2203	sub reset {
		2204	my ($self) = @_;
		2205
		2206	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2207
		2208	return if $self->players;
		2209
		2210	warn "resetting map ", $self->path;
		2211
		2212	$self->in_memory (cf::MAP_SWAPPED);
		2213
		2214	# need to save uniques path
		2215	unless ($self->{deny_save}) {
		2216	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2217
		2218	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2219	if $uniq;
		2220	}
		2221
		2222	delete $cf::MAP{$self->path};
		2223
		2224	$self->deactivate;
		2225	$_->clear_links_to ($self) for values %cf::MAP;
		2226	$self->clear;
		2227
		2228	$self->unlink_save;
		2229	$self->destroy;
		2230	}
		2231
		2232	my $nuke_counter = "aaaa";
		2233
		2234	sub nuke {
		2235	my ($self) = @_;
		2236
		2237	{
		2238	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2239
		2240	delete $cf::MAP{$self->path};
		2241
		2242	$self->unlink_save;
		2243
		2244	bless $self, "cf::map";
		2245	delete $self->{deny_reset};
		2246	$self->{deny_save} = 1;
		2247	$self->reset_timeout (1);
		2248	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2249
		2250	$cf::MAP{$self->path} = $self;
		2251	}
		2252
		2253	$self->reset; # polite request, might not happen
		2254	}
		2255
		2256	=item $maps = cf::map::tmp_maps
		2257
		2258	Returns an arrayref with all map paths of currently instantiated and saved
		2259	maps. May block.
		2260
		2261	=cut
		2262
		2263	sub tmp_maps() {
		2264	[
		2265	map {
		2266	utf8::decode $_;
		2267	/\.map$/
		2268	? normalise $_
		2269	: ()
		2270	} @{ aio_readdir $TMPDIR or [] }
		2271	]
		2272	}
		2273
		2274	=item $maps = cf::map::random_maps
		2275
		2276	Returns an arrayref with all map paths of currently instantiated and saved
		2277	random maps. May block.
		2278
		2279	=cut
		2280
		2281	sub random_maps() {
		2282	[
		2283	map {
		2284	utf8::decode $_;
		2285	/\.map$/
		2286	? normalise "?random/$_"
		2287	: ()
		2288	} @{ aio_readdir $RANDOMDIR or [] }
		2289	]
		2290	}
		2291
		2292	=item cf::map::unique_maps
		2293
		2294	Returns an arrayref of paths of all shared maps that have
		2295	instantiated unique items. May block.
		2296
		2297	=cut
		2298
		2299	sub unique_maps() {
		2300	[
		2301	map {
		2302	utf8::decode $_;
		2303	s/\.map$//; # TODO future compatibility hack
		2304	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
		2305	? ()
		2306	: normalise $_
		2307	} @{ aio_readdir $UNIQUEDIR or [] }
		2308	]
		2309	}
		2310
		2311	=back
		2312
		2313	=head3 cf::object
		2314
		2315	=cut
		2316
		2317	package cf::object;
716		2318
717	=over 4	2319	=over 4
718		2320
719	=item cf::player::exists $login	2321	=item $ob->inv_recursive
720		2322
721	Returns true when the given account exists.	2323	Returns the inventory of the object I<and> their inventories, recursively,
		2324	but I<not> the object itself.
722		2325
723	=cut	2326	=cut
724		2327
725	sub cf::player::exists($) {	2328	sub inv_recursive_;
726	cf::player::find $_[0]	2329	sub inv_recursive_ {
727	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	2330	map { $_, inv_recursive_ $_->inv } @_
728	}	2331	}
		2332
		2333	sub inv_recursive {
		2334	inv_recursive_ inv $_[0]
		2335	}
		2336
		2337	=item $ref = $ob->ref
		2338
		2339	Creates and returns a persistent reference to an object that can be stored as a string.
		2340
		2341	=item $ob = cf::object::deref ($refstring)
		2342
		2343	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2344	even if the object actually exists. May block.
		2345
		2346	=cut
		2347
		2348	sub deref {
		2349	my ($ref) = @_;
		2350
		2351	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2352	my ($uuid, $name) = ($1, $2);
		2353	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2354	or return;
		2355	$pl->ob->uuid eq $uuid
		2356	or return;
		2357
		2358	$pl->ob
		2359	} else {
		2360	warn "$ref: cannot resolve object reference\n";
		2361	undef
		2362	}
		2363	}
		2364
		2365	package cf;
		2366
		2367	=back
		2368
		2369	=head3 cf::object::player
		2370
		2371	=over 4
729		2372
730	=item $player_object->reply ($npc, $msg[, $flags])	2373	=item $player_object->reply ($npc, $msg[, $flags])
731		2374
732	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	2375	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
733	can be C<undef>. Does the right thing when the player is currently in a	2376	can be C<undef>. Does the right thing when the player is currently in a
734	dialogue with the given NPC character.	2377	dialogue with the given NPC character.
735		2378
736	=cut	2379	=cut
737		2380
		2381	our $SAY_CHANNEL = {
		2382	id => "say",
		2383	title => "Map",
		2384	reply => "say ",
		2385	tooltip => "Things said to and replied from npcs near you and other players on the same map only.",
		2386	};
		2387
		2388	our $CHAT_CHANNEL = {
		2389	id => "chat",
		2390	title => "Chat",
		2391	reply => "chat ",
		2392	tooltip => "Player chat and shouts, global to the server.",
		2393	};
		2394
738	# rough implementation of a future "reply" method that works	2395	# rough implementation of a future "reply" method that works
739	# with dialog boxes.	2396	# with dialog boxes.
		2397	#TODO: the first argument must go, split into a $npc->reply_to ( method
740	sub cf::object::player::reply($$$;$) {	2398	sub cf::object::player::reply($$$;$) {
741	my ($self, $npc, $msg, $flags) = @_;	2399	my ($self, $npc, $msg, $flags) = @_;
742		2400
743	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2401	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
744		2402
745	if ($self->{record_replies}) {	2403	if ($self->{record_replies}) {
746	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2404	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2405
747	} else {	2406	} else {
		2407	my $pl = $self->contr;
		2408
		2409	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2410	my $dialog = $pl->{npc_dialog};
		2411	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2412
		2413	} else {
748	$msg = $npc->name . " says: $msg" if $npc;	2414	$msg = $npc->name . " says: $msg" if $npc;
749	$self->message ($msg, $flags);	2415	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2416	}
750	}	2417	}
751	}	2418	}
752		2419
753	=item $player->ext_reply ($msgid, $msgtype, %msg)	2420	=item $object->send_msg ($channel, $msg, $color, [extra...])
754		2421
755	Sends an ext reply to the player.
756
757	=cut	2422	=cut
758		2423
759	sub cf::player::ext_reply($$$%) {	2424	sub cf::object::send_msg {
760	my ($self, $id, %msg) = @_;	2425	my $pl = shift->contr
761		2426	or return;
762	$msg{msgid} = $id;	2427	$pl->send_msg (@_);
763
764	$self->send ("ext " . to_json \%msg);
765	}	2428	}
766		2429
767	=item $player_object->may ("access")	2430	=item $player_object->may ("access")
768		2431
769	Returns wether the given player is authorized to access resource "access"	2432	Returns wether the given player is authorized to access resource "access"
…		…
778	(ref $cf::CFG{"may_$access"}	2441	(ref $cf::CFG{"may_$access"}
779	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	2442	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
780	: $cf::CFG{"may_$access"})	2443	: $cf::CFG{"may_$access"})
781	}	2444	}
782		2445
783	=cut	2446	=item $player_object->enter_link
784		2447
785	#############################################################################	2448	Freezes the player and moves him/her to a special map (C<{link}>).
		2449
		2450	The player should be reasonably safe there for short amounts of time. You
		2451	I<MUST> call C<leave_link> as soon as possible, though.
		2452
		2453	Will never block.
		2454
		2455	=item $player_object->leave_link ($map, $x, $y)
		2456
		2457	Moves the player out of the special C<{link}> map onto the specified
		2458	map. If the map is not valid (or omitted), the player will be moved back
		2459	to the location he/she was before the call to C<enter_link>, or, if that
		2460	fails, to the emergency map position.
		2461
		2462	Might block.
		2463
		2464	=cut
		2465
		2466	sub link_map {
		2467	unless ($LINK_MAP) {
		2468	$LINK_MAP = cf::map::find "{link}"
		2469	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2470	$LINK_MAP->load;
		2471	}
		2472
		2473	$LINK_MAP
		2474	}
		2475
		2476	sub cf::object::player::enter_link {
		2477	my ($self) = @_;
		2478
		2479	$self->deactivate_recursive;
		2480
		2481	return if UNIVERSAL::isa $self->map, "ext::map_link";
		2482
		2483	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		2484	if $self->map && $self->map->{path} ne "{link}";
		2485
		2486	$self->enter_map ($LINK_MAP || link_map, 10, 10);
		2487	}
		2488
		2489	sub cf::object::player::leave_link {
		2490	my ($self, $map, $x, $y) = @_;
		2491
		2492	return unless $self->contr->active;
		2493
		2494	my $link_pos = delete $self->{_link_pos};
		2495
		2496	unless ($map) {
		2497	# restore original map position
		2498	($map, $x, $y) = @{ $link_pos || [] };
		2499	$map = cf::map::find $map;
		2500
		2501	unless ($map) {
		2502	($map, $x, $y) = @$EMERGENCY_POSITION;
		2503	$map = cf::map::find $map
		2504	or die "FATAL: cannot load emergency map\n";
		2505	}
		2506	}
		2507
		2508	($x, $y) = (-1, -1)
		2509	unless (defined $x) && (defined $y);
		2510
		2511	# use -1 or undef as default coordinates, not 0, 0
		2512	($x, $y) = ($map->enter_x, $map->enter_y)
		2513	if $x <=0 && $y <= 0;
		2514
		2515	$map->load;
		2516	$map->load_neighbours;
		2517
		2518	return unless $self->contr->active;
		2519	$self->activate_recursive;
		2520
		2521	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
		2522	$self->enter_map ($map, $x, $y);
		2523	}
		2524
		2525	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
		2526
		2527	Moves the player to the given map-path and coordinates by first freezing
		2528	her, loading and preparing them map, calling the provided $check callback
		2529	that has to return the map if sucecssful, and then unfreezes the player on
		2530	the new (success) or old (failed) map position. In either case, $done will
		2531	be called at the end of this process.
		2532
		2533	Note that $check will be called with a potentially non-loaded map, so if
		2534	it needs a loaded map it has to call C<< ->load >>.
		2535
		2536	=cut
		2537
		2538	our $GOTOGEN;
		2539
		2540	sub cf::object::player::goto {
		2541	my ($self, $path, $x, $y, $check, $done) = @_;
		2542
		2543	# do generation counting so two concurrent goto's will be executed in-order
		2544	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
		2545
		2546	$self->enter_link;
		2547
		2548	(async {
		2549	$Coro::current->{desc} = "player::goto $path $x $y";
		2550
		2551	# *tag paths override both path and x|y
		2552	if ($path =~ /^\*(.*)$/) {
		2553	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2554	my $ob = $obs[rand @obs];
		2555
		2556	# see if we actually can go there
		2557	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2558	$ob = $obs[rand @obs];
		2559	} else {
		2560	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2561	}
		2562	# else put us there anyways for now #d#
		2563
		2564	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2565	} else {
		2566	($path, $x, $y) = (undef, undef, undef);
		2567	}
		2568	}
		2569
		2570	my $map = eval {
		2571	my $map = defined $path ? cf::map::find $path : undef;
		2572
		2573	if ($map) {
		2574	$map = $map->customise_for ($self);
		2575	$map = $check->($map) if $check && $map;
		2576	} else {
		2577	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2578	}
		2579
		2580	$map
		2581	};
		2582
		2583	if ($@) {
		2584	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2585	LOG llevError | logBacktrace, Carp::longmess $@;
		2586	}
		2587
		2588	if ($gen == $self->{_goto_generation}) {
		2589	delete $self->{_goto_generation};
		2590	$self->leave_link ($map, $x, $y);
		2591	}
		2592
		2593	$done->() if $done;
		2594	})->prio (1);
		2595	}
		2596
		2597	=item $player_object->enter_exit ($exit_object)
		2598
		2599	=cut
		2600
		2601	sub parse_random_map_params {
		2602	my ($spec) = @_;
		2603
		2604	my $rmp = { # defaults
		2605	xsize => (cf::rndm 15, 40),
		2606	ysize => (cf::rndm 15, 40),
		2607	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2608	#layout => string,
		2609	};
		2610
		2611	for (split /\n/, $spec) {
		2612	my ($k, $v) = split /\s+/, $_, 2;
		2613
		2614	$rmp->{lc $k} = $v if (length $k) && (length $v);
		2615	}
		2616
		2617	$rmp
		2618	}
		2619
		2620	sub prepare_random_map {
		2621	my ($exit) = @_;
		2622
		2623	# all this does is basically replace the /! path by
		2624	# a new random map path (?random/...) with a seed
		2625	# that depends on the exit object
		2626
		2627	my $rmp = parse_random_map_params $exit->msg;
		2628
		2629	if ($exit->map) {
		2630	$rmp->{region} = $exit->region->name;
		2631	$rmp->{origin_map} = $exit->map->path;
		2632	$rmp->{origin_x} = $exit->x;
		2633	$rmp->{origin_y} = $exit->y;
		2634
		2635	$exit->map->touch;
		2636	}
		2637
		2638	$rmp->{random_seed} ||= $exit->random_seed;
		2639
		2640	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
		2641	my $md5 = Digest::MD5::md5_hex $data;
		2642	my $meta = "$RANDOMDIR/$md5.meta";
		2643
		2644	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		2645	aio_write $fh, 0, (length $data), $data, 0;
		2646	undef $fh;
		2647	aio_rename "$meta~", $meta;
		2648
		2649	my $slaying = "?random/$md5";
		2650
		2651	if ($exit->valid) {
		2652	$exit->slaying ("?random/$md5");
		2653	$exit->msg (undef);
		2654	}
		2655	}
		2656	}
		2657
		2658	sub cf::object::player::enter_exit {
		2659	my ($self, $exit) = @_;
		2660
		2661	return unless $self->type == cf::PLAYER;
		2662
		2663	$self->enter_link;
		2664
		2665	(async {
		2666	$Coro::current->{desc} = "enter_exit";
		2667
		2668	unless (eval {
		2669	$self->deactivate_recursive; # just to be sure
		2670
		2671	# random map handling
		2672	{
		2673	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2674
		2675	prepare_random_map $exit
		2676	if $exit->slaying eq "/!";
		2677	}
		2678
		2679	my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2680	my $x = $exit->stats->hp;
		2681	my $y = $exit->stats->sp;
		2682
		2683	$self->goto ($map, $x, $y);
		2684
		2685	# if exit is damned, update players death & WoR home-position
		2686	$self->contr->savebed ($map, $x, $y)
		2687	if $exit->flag (cf::FLAG_DAMNED);
		2688
		2689	1
		2690	}) {
		2691	$self->message ("Something went wrong deep within the crossfire server. "
		2692	. "I'll try to bring you back to the map you were before. "
		2693	. "Please report this to the dungeon master!",
		2694	cf::NDI_UNIQUE | cf::NDI_RED);
		2695
		2696	warn "ERROR in enter_exit: $@";
		2697	$self->leave_link;
		2698	}
		2699	})->prio (1);
		2700	}
		2701
		2702	=head3 cf::client
		2703
		2704	=over 4
		2705
		2706	=item $client->send_drawinfo ($text, $flags)
		2707
		2708	Sends a drawinfo packet to the client. Circumvents output buffering so
		2709	should not be used under normal circumstances.
		2710
		2711	=cut
		2712
		2713	sub cf::client::send_drawinfo {
		2714	my ($self, $text, $flags) = @_;
		2715
		2716	utf8::encode $text;
		2717	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
		2718	}
		2719
		2720	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2721
		2722	Send a drawinfo or msg packet to the client, formatting the msg for the
		2723	client if neccessary. C<$type> should be a string identifying the type of
		2724	the message, with C<log> being the default. If C<$color> is negative, suppress
		2725	the message unless the client supports the msg packet.
		2726
		2727	=cut
		2728
		2729	# non-persistent channels (usually the info channel)
		2730	our %CHANNEL = (
		2731	"c/identify" => {
		2732	id => "infobox",
		2733	title => "Identify",
		2734	reply => undef,
		2735	tooltip => "Items recently identified",
		2736	},
		2737	"c/examine" => {
		2738	id => "infobox",
		2739	title => "Examine",
		2740	reply => undef,
		2741	tooltip => "Signs and other items you examined",
		2742	},
		2743	"c/book" => {
		2744	id => "infobox",
		2745	title => "Book",
		2746	reply => undef,
		2747	tooltip => "The contents of a note or book",
		2748	},
		2749	"c/lookat" => {
		2750	id => "infobox",
		2751	title => "Look",
		2752	reply => undef,
		2753	tooltip => "What you saw there",
		2754	},
		2755	"c/who" => {
		2756	id => "infobox",
		2757	title => "Players",
		2758	reply => undef,
		2759	tooltip => "Shows players who are currently online",
		2760	},
		2761	"c/body" => {
		2762	id => "infobox",
		2763	title => "Body Parts",
		2764	reply => undef,
		2765	tooltip => "Shows which body parts you posess and are available",
		2766	},
		2767	"c/uptime" => {
		2768	id => "infobox",
		2769	title => "Uptime",
		2770	reply => undef,
		2771	tooltip => "How long the server has been running since last restart",
		2772	},
		2773	"c/mapinfo" => {
		2774	id => "infobox",
		2775	title => "Map Info",
		2776	reply => undef,
		2777	tooltip => "Information related to the maps",
		2778	},
		2779	"c/party" => {
		2780	id => "party",
		2781	title => "Party",
		2782	reply => "gsay ",
		2783	tooltip => "Messages and chat related to your party",
		2784	},
		2785	);
		2786
		2787	sub cf::client::send_msg {
		2788	my ($self, $channel, $msg, $color, @extra) = @_;
		2789
		2790	$msg = $self->pl->expand_cfpod ($msg);
		2791
		2792	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2793
		2794	# check predefined channels, for the benefit of C
		2795	if ($CHANNEL{$channel}) {
		2796	$channel = $CHANNEL{$channel};
		2797
		2798	$self->ext_msg (channel_info => $channel)
		2799	if $self->can_msg;
		2800
		2801	$channel = $channel->{id};
		2802
		2803	} elsif (ref $channel) {
		2804	# send meta info to client, if not yet sent
		2805	unless (exists $self->{channel}{$channel->{id}}) {
		2806	$self->{channel}{$channel->{id}} = $channel;
		2807	$self->ext_msg (channel_info => $channel)
		2808	if $self->can_msg;
		2809	}
		2810
		2811	$channel = $channel->{id};
		2812	}
		2813
		2814	return unless @extra || length $msg;
		2815
		2816	if ($self->can_msg) {
		2817	# default colour, mask it out
		2818	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2819	if $color & cf::NDI_DEF;
		2820
		2821	my $pkt = "msg "
		2822	. $self->{json_coder}->encode (
		2823	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
		2824	);
		2825
		2826	# try lzf for large packets
		2827	$pkt = "lzf " . Compress::LZF::compress $pkt
		2828	if 1024 <= length $pkt and $self->{can_lzf};
		2829
		2830	# split very large packets
		2831	if (8192 < length $pkt and $self->{can_lzf}) {
		2832	$self->send_packet ("frag $_") for unpack "(a8192)*", $pkt;
		2833	$pkt = "frag";
		2834	}
		2835
		2836	$self->send_packet ($pkt);
		2837	} else {
		2838	if ($color >= 0) {
		2839	# replace some tags by gcfclient-compatible ones
		2840	for ($msg) {
		2841	1 while
		2842	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2843	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2844	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2845	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2846	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2847	}
		2848
		2849	$color &= cf::NDI_COLOR_MASK;
		2850
		2851	utf8::encode $msg;
		2852
		2853	if (0 && $msg =~ /\[/) {
		2854	# COMMAND/INFO
		2855	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2856	} else {
		2857	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2858	$self->send_packet ("drawinfo $color $msg")
		2859	}
		2860	}
		2861	}
		2862	}
		2863
		2864	=item $client->ext_msg ($type, @msg)
		2865
		2866	Sends an ext event to the client.
		2867
		2868	=cut
		2869
		2870	sub cf::client::ext_msg($$@) {
		2871	my ($self, $type, @msg) = @_;
		2872
		2873	if ($self->extcmd == 2) {
		2874	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2875	} elsif ($self->extcmd == 1) { # TODO: remove
		2876	push @msg, msgtype => "event_$type";
		2877	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2878	}
		2879	}
		2880
		2881	=item $client->ext_reply ($msgid, @msg)
		2882
		2883	Sends an ext reply to the client.
		2884
		2885	=cut
		2886
		2887	sub cf::client::ext_reply($$@) {
		2888	my ($self, $id, @msg) = @_;
		2889
		2890	if ($self->extcmd == 2) {
		2891	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2892	} elsif ($self->extcmd == 1) {
		2893	#TODO: version 1, remove
		2894	unshift @msg, msgtype => "reply", msgid => $id;
		2895	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2896	}
		2897	}
		2898
		2899	=item $success = $client->query ($flags, "text", \&cb)
		2900
		2901	Queues a query to the client, calling the given callback with
		2902	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		2903	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		2904
		2905	Queries can fail, so check the return code. Or don't, as queries will
		2906	become reliable at some point in the future.
		2907
		2908	=cut
		2909
		2910	sub cf::client::query {
		2911	my ($self, $flags, $text, $cb) = @_;
		2912
		2913	return unless $self->state == ST_PLAYING
		2914	|| $self->state == ST_SETUP
		2915	|| $self->state == ST_CUSTOM;
		2916
		2917	$self->state (ST_CUSTOM);
		2918
		2919	utf8::encode $text;
		2920	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		2921
		2922	$self->send_packet ($self->{query_queue}[0][0])
		2923	if @{ $self->{query_queue} } == 1;
		2924
		2925	1
		2926	}
		2927
		2928	cf::client->attach (
		2929	on_connect => sub {
		2930	my ($ns) = @_;
		2931
		2932	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2933	},
		2934	on_reply => sub {
		2935	my ($ns, $msg) = @_;
		2936
		2937	# this weird shuffling is so that direct followup queries
		2938	# get handled first
		2939	my $queue = delete $ns->{query_queue}
		2940	or return; # be conservative, not sure how that can happen, but we saw a crash here
		2941
		2942	(shift @$queue)->[1]->($msg);
		2943	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
		2944
		2945	push @{ $ns->{query_queue} }, @$queue;
		2946
		2947	if (@{ $ns->{query_queue} } == @$queue) {
		2948	if (@$queue) {
		2949	$ns->send_packet ($ns->{query_queue}[0][0]);
		2950	} else {
		2951	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		2952	}
		2953	}
		2954	},
		2955	on_exticmd => sub {
		2956	my ($ns, $buf) = @_;
		2957
		2958	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2959
		2960	if (ref $msg) {
		2961	my ($type, $reply, @payload) =
		2962	"ARRAY" eq ref $msg
		2963	? @$msg
		2964	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2965
		2966	my @reply;
		2967
		2968	if (my $cb = $EXTICMD{$type}) {
		2969	@reply = $cb->($ns, @payload);
		2970	}
		2971
		2972	$ns->ext_reply ($reply, @reply)
		2973	if $reply;
		2974
		2975	} else {
		2976	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2977	}
		2978
		2979	cf::override;
		2980	},
		2981	);
		2982
		2983	=item $client->async (\&cb)
		2984
		2985	Create a new coroutine, running the specified callback. The coroutine will
		2986	be automatically cancelled when the client gets destroyed (e.g. on logout,
		2987	or loss of connection).
		2988
		2989	=cut
		2990
		2991	sub cf::client::async {
		2992	my ($self, $cb) = @_;
		2993
		2994	my $coro = &Coro::async ($cb);
		2995
		2996	$coro->on_destroy (sub {
		2997	delete $self->{_coro}{$coro+0};
		2998	});
		2999
		3000	$self->{_coro}{$coro+0} = $coro;
		3001
		3002	$coro
		3003	}
		3004
		3005	cf::client->attach (
		3006	on_destroy => sub {
		3007	my ($ns) = @_;
		3008
		3009	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		3010	},
		3011	);
		3012
		3013	=back
		3014
786		3015
787	=head2 SAFE SCRIPTING	3016	=head2 SAFE SCRIPTING
788		3017
789	Functions that provide a safe environment to compile and execute	3018	Functions that provide a safe environment to compile and execute
790	snippets of perl code without them endangering the safety of the server	3019	snippets of perl code without them endangering the safety of the server
…		…
797	our $safe = new Safe "safe";	3026	our $safe = new Safe "safe";
798	our $safe_hole = new Safe::Hole;	3027	our $safe_hole = new Safe::Hole;
799		3028
800	$SIG{FPE} = 'IGNORE';	3029	$SIG{FPE} = 'IGNORE';
801		3030
802	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3031	$safe->permit_only (Opcode::opset qw(
		3032	:base_core :base_mem :base_orig :base_math
		3033	grepstart grepwhile mapstart mapwhile
		3034	sort time
		3035	));
803		3036
804	# here we export the classes and methods available to script code	3037	# here we export the classes and methods available to script code
805		3038
806	=pod	3039	=pod
807		3040
808	The following fucntions and emthods are available within a safe environment:	3041	The following functions and methods are available within a safe environment:
809		3042
810	cf::object contr pay_amount pay_player map	3043	cf::object
		3044	contr pay_amount pay_player map x y force_find force_add destroy
		3045	insert remove name archname title slaying race decrease split
		3046
811	cf::object::player player	3047	cf::object::player
812	cf::player peaceful	3048	player
813	cf::map trigger	3049
		3050	cf::player
		3051	peaceful
		3052
		3053	cf::map
		3054	trigger
814		3055
815	=cut	3056	=cut
816		3057
817	for (	3058	for (
818	["cf::object" => qw(contr pay_amount pay_player map)],	3059	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3060	insert remove inv nrof name archname title slaying race
		3061	decrease split destroy change_exp)],
819	["cf::object::player" => qw(player)],	3062	["cf::object::player" => qw(player)],
820	["cf::player" => qw(peaceful)],	3063	["cf::player" => qw(peaceful)],
821	["cf::map" => qw(trigger)],	3064	["cf::map" => qw(trigger)],
822	) {	3065	) {
823	no strict 'refs';	3066	no strict 'refs';
…		…
894	=back	3137	=back
895		3138
896	=cut	3139	=cut
897		3140
898	#############################################################################	3141	#############################################################################
		3142	# the server's init and main functions
899		3143
900	=head2 EXTENSION DATABASE SUPPORT	3144	sub load_facedata($) {
		3145	my ($path) = @_;
901		3146
902	Crossfire maintains a very simple database for extension use. It can	3147	# HACK to clear player env face cache, we need some signal framework
903	currently store anything that can be serialised using Storable, which	3148	# for this (global event?)
904	excludes objects.	3149	%ext::player_env::MUSIC_FACE_CACHE = ();
905		3150
906	The parameter C<$family> should best start with the name of the extension	3151	my $enc = JSON::XS->new->utf8->canonical->relaxed;
907	using it, it should be unique.
908		3152
909	=over 4	3153	warn "loading facedata from $path\n";
910		3154
911	=item $hashref = cf::db_get $family	3155	my $facedata;
		3156	0 < aio_load $path, $facedata
		3157	or die "$path: $!";
912		3158
913	Return a hashref for use by the extension C<$family>, which can be	3159	$facedata = Coro::Storable::thaw $facedata;
914	modified. After modifications, you have to call C<cf::db_dirty> or
915	C<cf::db_sync>.
916		3160
917	=item $value = cf::db_get $family => $key	3161	$facedata->{version} == 2
		3162	or cf::cleanup "$path: version mismatch, cannot proceed.";
918		3163
919	Returns a single value from the database	3164	# patch in the exptable
		3165	$facedata->{resource}{"res/exp_table"} = {
		3166	type => FT_RSRC,
		3167	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
		3168	};
		3169	cf::cede_to_tick;
920		3170
921	=item cf::db_put $family => $hashref	3171	{
		3172	my $faces = $facedata->{faceinfo};
922		3173
923	Stores the given family hashref into the database. Updates are delayed, if	3174	while (my ($face, $info) = each %$faces) {
924	you want the data to be synced to disk immediately, use C<cf::db_sync>.	3175	my $idx = (cf::face::find $face) || cf::face::alloc $face;
925		3176
926	=item cf::db_put $family => $key => $value	3177	cf::face::set_visibility $idx, $info->{visibility};
		3178	cf::face::set_magicmap $idx, $info->{magicmap};
		3179	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
		3180	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
927		3181
928	Stores the given C<$value> in the family hash. Updates are delayed, if you	3182	cf::cede_to_tick;
929	want the data to be synced to disk immediately, use C<cf::db_sync>.	3183	}
930		3184
931	=item cf::db_dirty	3185	while (my ($face, $info) = each %$faces) {
		3186	next unless $info->{smooth};
932		3187
933	Marks the database as dirty, to be updated at a later time.	3188	my $idx = cf::face::find $face
		3189	or next;
934		3190
935	=item cf::db_sync	3191	if (my $smooth = cf::face::find $info->{smooth}) {
		3192	cf::face::set_smooth $idx, $smooth;
		3193	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3194	} else {
		3195	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3196	}
936		3197
937	Immediately write the database to disk I<if it is dirty>.	3198	cf::cede_to_tick;
		3199	}
		3200	}
938		3201
939	=cut	3202	{
		3203	my $anims = $facedata->{animinfo};
940		3204
941	our $DB;	3205	while (my ($anim, $info) = each %$anims) {
		3206	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3207	cf::cede_to_tick;
		3208	}
		3209
		3210	cf::anim::invalidate_all; # d'oh
		3211	}
		3212
		3213	{
		3214	# TODO: for gcfclient pleasure, we should give resources
		3215	# that gcfclient doesn't grok a >10000 face index.
		3216	my $res = $facedata->{resource};
		3217
		3218	while (my ($name, $info) = each %$res) {
		3219	if (defined $info->{type}) {
		3220	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3221	my $data;
		3222
		3223	if ($info->{type} & 1) {
		3224	# prepend meta info
		3225
		3226	my $meta = $enc->encode ({
		3227	name => $name,
		3228	%{ $info->{meta} || {} },
		3229	});
		3230
		3231	$data = pack "(w/a*)*", $meta, $info->{data};
		3232	} else {
		3233	$data = $info->{data};
		3234	}
		3235
		3236	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3237	cf::face::set_type $idx, $info->{type};
		3238	} else {
		3239	$RESOURCE{$name} = $info;
		3240	}
		3241
		3242	cf::cede_to_tick;
		3243	}
		3244	}
		3245
		3246	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3247
		3248	1
		3249	}
		3250
		3251	cf::global->attach (on_resource_update => sub {
		3252	if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
		3253	$soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
		3254
		3255	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3256	my $sound = $soundconf->{compat}[$_]
		3257	or next;
		3258
		3259	my $face = cf::face::find "sound/$sound->[1]";
		3260	cf::sound::set $sound->[0] => $face;
		3261	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3262	}
		3263
		3264	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3265	my $face = cf::face::find "sound/$v";
		3266	cf::sound::set $k => $face;
		3267	}
		3268	}
		3269	});
		3270
		3271	register_exticmd fx_want => sub {
		3272	my ($ns, $want) = @_;
		3273
		3274	while (my ($k, $v) = each %$want) {
		3275	$ns->fx_want ($k, $v);
		3276	}
		3277	};
		3278
		3279	sub load_resource_file($) {
		3280	my $guard = lock_acquire "load_resource_file";
		3281
		3282	my $status = load_resource_file_ $_[0];
		3283	get_slot 0.1, 100;
		3284	cf::arch::commit_load;
		3285
		3286	$status
		3287	}
		3288
		3289	sub reload_regions {
		3290	# HACK to clear player env face cache, we need some signal framework
		3291	# for this (global event?)
		3292	%ext::player_env::MUSIC_FACE_CACHE = ();
		3293
		3294	load_resource_file "$MAPDIR/regions"
		3295	or die "unable to load regions file\n";
		3296
		3297	for (cf::region::list) {
		3298	$_->{match} = qr/$_->{match}/
		3299	if exists $_->{match};
		3300	}
		3301	}
		3302
		3303	sub reload_facedata {
		3304	load_facedata "$DATADIR/facedata"
		3305	or die "unable to load facedata\n";
		3306	}
		3307
		3308	sub reload_archetypes {
		3309	load_resource_file "$DATADIR/archetypes"
		3310	or die "unable to load archetypes\n";
		3311	}
		3312
		3313	sub reload_treasures {
		3314	load_resource_file "$DATADIR/treasures"
		3315	or die "unable to load treasurelists\n";
		3316	}
		3317
		3318	sub reload_resources {
		3319	warn "reloading resource files...\n";
		3320
		3321	reload_facedata;
		3322	reload_archetypes;
		3323	reload_regions;
		3324	reload_treasures;
		3325
		3326	warn "finished reloading resource files\n";
		3327	}
		3328
		3329	sub init {
		3330	my $guard = freeze_mainloop;
		3331
		3332	evthread_start IO::AIO::poll_fileno;
		3333
		3334	reload_resources;
		3335	}
		3336
		3337	sub reload_config {
		3338	open my $fh, "<:utf8", "$CONFDIR/config"
		3339	or return;
		3340
		3341	local $/;
		3342	*CFG = YAML::Load <$fh>;
		3343
		3344	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		3345
		3346	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		3347	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		3348
		3349	if (exists $CFG{mlockall}) {
		3350	eval {
		3351	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		3352	and die "WARNING: m(un)lockall failed: $!\n";
		3353	};
		3354	warn $@ if $@;
		3355	}
		3356	}
		3357
		3358	sub main {
		3359	# we must not ever block the main coroutine
		3360	local $Coro::idle = sub {
		3361	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		3362	(async {
		3363	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3364	EV::loop EV::LOOP_ONESHOT;
		3365	})->prio (Coro::PRIO_MAX);
		3366	};
		3367
		3368	{
		3369	my $guard = freeze_mainloop;
		3370	reload_config;
		3371	db_init;
		3372	load_extensions;
		3373
		3374	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3375	}
		3376
		3377	EV::loop;
		3378	}
		3379
		3380	#############################################################################
		3381	# initialisation and cleanup
		3382
		3383	# install some emergency cleanup handlers
		3384	BEGIN {
		3385	our %SIGWATCHER = ();
		3386	for my $signal (qw(INT HUP TERM)) {
		3387	$SIGWATCHER{$signal} = EV::signal $signal, sub {
		3388	cf::cleanup "SIG$signal";
		3389	};
		3390	}
		3391	}
		3392
		3393	sub write_runtime_sync {
		3394	my $runtime = "$LOCALDIR/runtime";
		3395
		3396	# first touch the runtime file to show we are still running:
		3397	# the fsync below can take a very very long time.
		3398
		3399	IO::AIO::aio_utime $runtime, undef, undef;
		3400
		3401	my $guard = cf::lock_acquire "write_runtime";
		3402
		3403	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3404	or return;
		3405
		3406	my $value = $cf::RUNTIME + 90 + 10;
		3407	# 10 is the runtime save interval, for a monotonic clock
		3408	# 60 allows for the watchdog to kill the server.
		3409
		3410	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3411	and return;
		3412
		3413	# always fsync - this file is important
		3414	aio_fsync $fh
		3415	and return;
		3416
		3417	# touch it again to show we are up-to-date
		3418	aio_utime $fh, undef, undef;
		3419
		3420	close $fh
		3421	or return;
		3422
		3423	aio_rename "$runtime~", $runtime
		3424	and return;
		3425
		3426	warn "runtime file written.\n";
		3427
		3428	1
		3429	}
		3430
		3431	our $uuid_lock;
		3432	our $uuid_skip;
		3433
		3434	sub write_uuid_sync($) {
		3435	$uuid_skip ||= $_[0];
		3436
		3437	return if $uuid_lock;
		3438	local $uuid_lock = 1;
		3439
		3440	my $uuid = "$LOCALDIR/uuid";
		3441
		3442	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3443	or return;
		3444
		3445	my $value = uuid_str $uuid_skip + uuid_seq uuid_cur;
		3446	$uuid_skip = 0;
		3447
		3448	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3449	and return;
		3450
		3451	# always fsync - this file is important
		3452	aio_fsync $fh
		3453	and return;
		3454
		3455	close $fh
		3456	or return;
		3457
		3458	aio_rename "$uuid~", $uuid
		3459	and return;
		3460
		3461	warn "uuid file written ($value).\n";
		3462
		3463	1
		3464
		3465	}
		3466
		3467	sub write_uuid($$) {
		3468	my ($skip, $sync) = @_;
		3469
		3470	$sync ? write_uuid_sync $skip
		3471	: async { write_uuid_sync $skip };
		3472	}
		3473
		3474	sub emergency_save() {
		3475	my $freeze_guard = cf::freeze_mainloop;
		3476
		3477	warn "enter emergency perl save\n";
		3478
		3479	cf::sync_job {
		3480	# use a peculiar iteration method to avoid tripping on perl
		3481	# refcount bugs in for. also avoids problems with players
		3482	# and maps saved/destroyed asynchronously.
		3483	warn "begin emergency player save\n";
		3484	for my $login (keys %cf::PLAYER) {
		3485	my $pl = $cf::PLAYER{$login} or next;
		3486	$pl->valid or next;
		3487	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
		3488	$pl->save;
		3489	}
		3490	warn "end emergency player save\n";
		3491
		3492	warn "begin emergency map save\n";
		3493	for my $path (keys %cf::MAP) {
		3494	my $map = $cf::MAP{$path} or next;
		3495	$map->valid or next;
		3496	$map->save;
		3497	}
		3498	warn "end emergency map save\n";
		3499
		3500	warn "begin emergency database checkpoint\n";
		3501	BDB::db_env_txn_checkpoint $DB_ENV;
		3502	warn "end emergency database checkpoint\n";
		3503
		3504	warn "begin write uuid\n";
		3505	write_uuid_sync 1;
		3506	warn "end write uuid\n";
		3507	};
		3508
		3509	warn "leave emergency perl save\n";
		3510	}
		3511
		3512	sub post_cleanup {
		3513	my ($make_core) = @_;
		3514
		3515	warn Carp::longmess "post_cleanup backtrace"
		3516	if $make_core;
		3517	}
		3518
		3519	# a safer delete_package, copied from Symbol
		3520	sub clear_package($) {
		3521	my $pkg = shift;
		3522
		3523	# expand to full symbol table name if needed
		3524	unless ($pkg =~ /^main::.*::$/) {
		3525	$pkg = "main$pkg" if $pkg =~ /^::/;
		3526	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		3527	$pkg .= '::' unless $pkg =~ /::$/;
		3528	}
		3529
		3530	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		3531	my $stem_symtab = *{$stem}{HASH};
		3532
		3533	defined $stem_symtab and exists $stem_symtab->{$leaf}
		3534	or return;
		3535
		3536	# clear all symbols
		3537	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		3538	for my $name (keys %$leaf_symtab) {
		3539	_gv_clear *{"$pkg$name"};
		3540	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		3541	}
		3542	warn "cleared package #$pkg\n";#d#
		3543	}
		3544
		3545	our $RELOAD; # how many times to reload
		3546
		3547	sub do_reload_perl() {
		3548	# can/must only be called in main
		3549	if ($Coro::current != $Coro::main) {
		3550	warn "can only reload from main coroutine";
		3551	return;
		3552	}
		3553
		3554	return if $RELOAD++;
		3555
		3556	while ($RELOAD) {
		3557	warn "reloading...";
		3558
		3559	warn "entering sync_job";
		3560
		3561	cf::sync_job {
		3562	cf::write_runtime_sync; # external watchdog should not bark
		3563	cf::emergency_save;
		3564	cf::write_runtime_sync; # external watchdog should not bark
		3565
		3566	warn "syncing database to disk";
		3567	BDB::db_env_txn_checkpoint $DB_ENV;
		3568
		3569	# if anything goes wrong in here, we should simply crash as we already saved
		3570
		3571	warn "flushing outstanding aio requests";
		3572	while (IO::AIO::nreqs || BDB::nreqs) {
		3573	Coro::EV::timer_once 0.01; # let the sync_job do it's thing
		3574	}
		3575
		3576	warn "cancelling all extension coros";
		3577	$_->cancel for values %EXT_CORO;
		3578	%EXT_CORO = ();
		3579
		3580	warn "removing commands";
		3581	%COMMAND = ();
		3582
		3583	warn "removing ext/exti commands";
		3584	%EXTCMD = ();
		3585	%EXTICMD = ();
		3586
		3587	warn "unloading/nuking all extensions";
		3588	for my $pkg (@EXTS) {
		3589	warn "... unloading $pkg";
		3590
		3591	if (my $cb = $pkg->can ("unload")) {
		3592	eval {
		3593	$cb->($pkg);
		3594	1
		3595	} or warn "$pkg unloaded, but with errors: $@";
		3596	}
		3597
		3598	warn "... clearing $pkg";
		3599	clear_package $pkg;
		3600	}
		3601
		3602	warn "unloading all perl modules loaded from $LIBDIR";
		3603	while (my ($k, $v) = each %INC) {
		3604	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		3605
		3606	warn "... unloading $k";
		3607	delete $INC{$k};
		3608
		3609	$k =~ s/\.pm$//;
		3610	$k =~ s/\//::/g;
		3611
		3612	if (my $cb = $k->can ("unload_module")) {
		3613	$cb->();
		3614	}
		3615
		3616	clear_package $k;
		3617	}
		3618
		3619	warn "getting rid of safe::, as good as possible";
		3620	clear_package "safe::$_"
		3621	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
		3622
		3623	warn "unloading cf.pm \"a bit\"";
		3624	delete $INC{"cf.pm"};
		3625	delete $INC{"cf/pod.pm"};
		3626
		3627	# don't, removes xs symbols, too,
		3628	# and global variables created in xs
		3629	#clear_package __PACKAGE__;
		3630
		3631	warn "unload completed, starting to reload now";
		3632
		3633	warn "reloading cf.pm";
		3634	require cf;
		3635	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
		3636
		3637	warn "loading config and database again";
		3638	cf::reload_config;
		3639
		3640	warn "loading extensions";
		3641	cf::load_extensions;
		3642
		3643	warn "reattaching attachments to objects/players";
		3644	_global_reattach; # objects, sockets
		3645	warn "reattaching attachments to maps";
		3646	reattach $_ for values %MAP;
		3647	warn "reattaching attachments to players";
		3648	reattach $_ for values %PLAYER;
		3649
		3650	warn "leaving sync_job";
		3651
		3652	1
		3653	} or do {
		3654	warn $@;
		3655	cf::cleanup "error while reloading, exiting.";
		3656	};
		3657
		3658	warn "reloaded";
		3659	--$RELOAD;
		3660	}
		3661	};
		3662
		3663	our $RELOAD_WATCHER; # used only during reload
		3664
		3665	sub reload_perl() {
		3666	# doing reload synchronously and two reloads happen back-to-back,
		3667	# coro crashes during coro_state_free->destroy here.
		3668
		3669	$RELOAD_WATCHER ||= EV::timer 0, 0, sub {
		3670	do_reload_perl;
		3671	undef $RELOAD_WATCHER;
		3672	};
		3673	}
		3674
		3675	register_command "reload" => sub {
		3676	my ($who, $arg) = @_;
		3677
		3678	if ($who->flag (FLAG_WIZ)) {
		3679	$who->message ("reloading server.");
		3680	async {
		3681	$Coro::current->{desc} = "perl_reload";
		3682	reload_perl;
		3683	};
		3684	}
		3685	};
		3686
		3687	unshift @INC, $LIBDIR;
		3688
		3689	my $bug_warning = 0;
		3690
		3691	our @WAIT_FOR_TICK;
		3692	our @WAIT_FOR_TICK_BEGIN;
		3693
		3694	sub wait_for_tick {
		3695	return if tick_inhibit || $Coro::current == $Coro::main;
		3696
		3697	my $signal = new Coro::Signal;
		3698	push @WAIT_FOR_TICK, $signal;
		3699	$signal->wait;
		3700	}
		3701
		3702	sub wait_for_tick_begin {
		3703	return if tick_inhibit || $Coro::current == $Coro::main;
		3704
		3705	my $signal = new Coro::Signal;
		3706	push @WAIT_FOR_TICK_BEGIN, $signal;
		3707	$signal->wait;
		3708	}
		3709
		3710	sub tick {
		3711	if ($Coro::current != $Coro::main) {
		3712	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3713	unless ++$bug_warning > 10;
		3714	return;
		3715	}
		3716
		3717	cf::server_tick; # one server iteration
		3718
		3719	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		3720	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
		3721	Coro::async_pool {
		3722	$Coro::current->{desc} = "runtime saver";
		3723	write_runtime_sync
		3724	or warn "ERROR: unable to write runtime file: $!";
		3725	};
		3726	}
		3727
		3728	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3729	$sig->send;
		3730	}
		3731	while (my $sig = shift @WAIT_FOR_TICK) {
		3732	$sig->send;
		3733	}
		3734
		3735	$LOAD = ($NOW - $TICK_START) / $TICK;
		3736	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3737
		3738	if (0) {
		3739	if ($NEXT_TICK) {
		3740	my $jitter = $TICK_START - $NEXT_TICK;
		3741	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		3742	warn "jitter $JITTER\n";#d#
		3743	}
		3744	}
		3745	}
942		3746
943	{	3747	{
944	my $path = cf::localdir . "/database.pst";	3748	# configure BDB
945		3749
946	sub db_load() {	3750	BDB::min_parallel 8;
947	warn "loading database $path\n";#d# remove later	3751	BDB::max_poll_reqs $TICK * 0.1;
948	$DB = stat $path ? Storable::retrieve $path : { };	3752	$AnyEvent::BDB::WATCHER->priority (1);
949	}
950		3753
951	my $pid;	3754	unless ($DB_ENV) {
		3755	$DB_ENV = BDB::db_env_create;
		3756	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		3757	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		3758	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		3759	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3760	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
952		3761
953	sub db_save() {	3762	cf::sync_job {
954	warn "saving database $path\n";#d# remove later
955	waitpid $pid, 0 if $pid;
956	if (0 == ($pid = fork)) {
957	$DB->{_meta}{version} = 1;
958	Storable::nstore $DB, "$path~";
959	rename "$path~", $path;
960	cf::_exit 0 if defined $pid;
961	}
962	}
963
964	my $dirty;
965
966	sub db_sync() {
967	db_save if $dirty;
968	undef $dirty;
969	}
970
971	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
972	db_sync;
973	});
974
975	sub db_dirty() {
976	$dirty = 1;
977	$idle->start;
978	}
979
980	sub db_get($;$) {
981	@_ >= 2
982	? $DB->{$_[0]}{$_[1]}
983	: ($DB->{$_[0]} ||= { })
984	}
985
986	sub db_put($$;$) {
987	if (@_ >= 3) {
988	$DB->{$_[0]}{$_[1]} = $_[2];
989	} else {	3763	eval {
990	$DB->{$_[0]} = $_[1];	3764	BDB::db_env_open
991	}	3765	$DB_ENV,
992	db_dirty;	3766	$BDBDIR,
993	}	3767	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3768	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3769	0666;
994		3770
995	cf::global->attach (	3771	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
996	prio => 10000,
997	on_cleanup => sub {
998	db_sync;
999	},
1000	);
1001	}
1002
1003	#############################################################################
1004	# the server's main()
1005
1006	sub cfg_load {
1007	open my $fh, "<:utf8", cf::confdir . "/config"
1008	or return;
1009
1010	local $/;
1011	*CFG = YAML::Syck::Load <$fh>;
1012	}
1013
1014	sub main {
1015	cfg_load;
1016	db_load;
1017	load_extensions;
1018	Event::loop;
1019	}
1020
1021	#############################################################################
1022	# initialisation
1023
1024	sub _perl_reload(&) {
1025	my ($msg) = @_;
1026
1027	$msg->("reloading...");
1028
1029	eval {
1030	# cancel all watchers
1031	for (Event::all_watchers) {
1032	$_->cancel if $_->data & WF_AUTOCANCEL;
1033	}
1034
1035	# unload all extensions
1036	for (@exts) {
1037	$msg->("unloading <$_>");
1038	unload_extension $_;
1039	}
1040
1041	# unload all modules loaded from $LIBDIR
1042	while (my ($k, $v) = each %INC) {
1043	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1044
1045	$msg->("removing <$k>");
1046	delete $INC{$k};
1047
1048	$k =~ s/\.pm$//;
1049	$k =~ s/\//::/g;
1050
1051	if (my $cb = $k->can ("unload_module")) {
1052	$cb->();
1053	}	3772	};
1054		3773
1055	Symbol::delete_package $k;	3774	cf::cleanup "db_env_open(db): $@" if $@;
1056	}	3775	};
		3776	}
1057		3777
1058	# sync database to disk	3778	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
1059	cf::db_sync;	3779	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
1060
1061	# get rid of safe::, as good as possible
1062	Symbol::delete_package "safe::$_"
1063	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
1064
1065	# remove register_script_function callbacks
1066	# TODO
1067
1068	# unload cf.pm "a bit"
1069	delete $INC{"cf.pm"};
1070
1071	# don't, removes xs symbols, too,
1072	# and global variables created in xs
1073	#Symbol::delete_package __PACKAGE__;
1074
1075	# reload cf.pm
1076	$msg->("reloading cf.pm");
1077	require cf;
1078
1079	# load config and database again
1080	cf::cfg_load;
1081	cf::db_load;
1082
1083	# load extensions
1084	$msg->("load extensions");
1085	cf::load_extensions;
1086
1087	# reattach attachments to objects
1088	$msg->("reattach");
1089	_global_reattach;
1090	};	3780	};
1091	$msg->($@) if $@;	3781	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
1092		3782	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
1093	$msg->("reloaded");
1094	};
1095
1096	sub perl_reload() {
1097	_perl_reload {
1098	warn $_[0];
1099	print "$_[0]\n";
1100	};	3783	};
		3784	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3785	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3786	};
1101	}	3787	}
1102		3788
1103	register "<global>", __PACKAGE__;	3789	{
		3790	# configure IO::AIO
1104		3791
1105	register_command "perl-reload" => sub {	3792	IO::AIO::min_parallel 8;
		3793	IO::AIO::max_poll_time $TICK * 0.1;
		3794	undef $AnyEvent::AIO::WATCHER;
		3795	}
		3796
		3797	my $_log_backtrace;
		3798
		3799	sub _log_backtrace {
1106	my ($who, $arg) = @_;	3800	my ($msg, @addr) = @_;
1107		3801
1108	if ($who->flag (FLAG_WIZ)) {	3802	$msg =~ s/\n//;
1109	_perl_reload {	3803
1110	warn $_[0];	3804	# limit the # of concurrent backtraces
1111	$who->message ($_[0]);	3805	if ($_log_backtrace < 2) {
		3806	++$_log_backtrace;
		3807	async {
		3808	$Coro::current->{desc} = "abt $msg";
		3809
		3810	my @bt = fork_call {
		3811	@addr = map { sprintf "%x", $_ } @addr;
		3812	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3813	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3814	or die "addr2line: $!";
		3815
		3816	my @funcs;
		3817	my @res = <$fh>;
		3818	chomp for @res;
		3819	while (@res) {
		3820	my ($func, $line) = splice @res, 0, 2, ();
		3821	push @funcs, "[$func] $line";
		3822	}
		3823
		3824	@funcs
		3825	};
		3826
		3827	LOG llevInfo, "[ABT] $msg\n";
		3828	LOG llevInfo, "[ABT] $_\n" for @bt;
		3829	--$_log_backtrace;
1112	};	3830	};
1113	}	3831	} else {
1114	};	3832	LOG llevInfo, "[ABT] $msg\n";
1115		3833	LOG llevInfo, "[ABT] [suppressed]\n";
1116	unshift @INC, $LIBDIR;
1117
1118	$TICK_WATCHER = Event->timer (
1119	prio => 0,
1120	at => $NEXT_TICK || 1,
1121	data => WF_AUTOCANCEL,
1122	cb => sub {
1123	cf::server_tick; # one server iteration
1124
1125	my $NOW = Event::time;
1126	$NEXT_TICK += $TICK;
1127
1128	# if we are delayed by four ticks or more, skip them all
1129	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1130
1131	$TICK_WATCHER->at ($NEXT_TICK);
1132	$TICK_WATCHER->start;
1133	},	3834	}
1134	);	3835	}
1135		3836
1136	IO::AIO::max_poll_time $TICK * 0.2;	3837	# load additional modules
		3838	use cf::pod;
1137		3839
1138	Event->io (fd => IO::AIO::poll_fileno,	3840	END { cf::emergency_save }
1139	poll => 'r',
1140	prio => 5,
1141	data => WF_AUTOCANCEL,
1142	cb => \&IO::AIO::poll_cb);
1143		3841
1144	1	3842	1
1145		3843

Diff Legend

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