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.94 by root, Thu Dec 21 23:02:54 2006 UTC vs.
Revision 1.432 by root, Mon May 5 22:38:47 2008 UTC

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

Diff Legend

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