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.95 by root, Fri Dec 22 02:04:20 2006 UTC vs.
Revision 1.423 by root, Sun Apr 20 00:44:13 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	chmod SAVE_MODE, $fh;
		1147	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		1148	aio_fsync $fh if $cf::USE_FSYNC;
		1149	close $fh;
		1150
		1151	if (@$objs) {
		1152	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		1153	chmod SAVE_MODE, $fh;
		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	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	local $cf::PLAYER_LOADING{$login} = $pl;
		1462	$f->resolve_delayed_derefs;
		1463	$cf::PLAYER{$login} = $pl
		1464	}
		1465	}
		1466	}
		1467
		1468	sub save($) {
		1469	my ($pl) = @_;
		1470
		1471	return if $pl->{deny_save};
		1472
		1473	my $path = path $pl;
		1474	my $guard = cf::lock_acquire "user_save:$path";
		1475
		1476	return if $pl->{deny_save};
		1477
		1478	aio_mkdir playerdir $pl, 0770;
		1479	$pl->{last_save} = $cf::RUNTIME;
		1480
		1481	cf::get_slot 0.01;
		1482
		1483	$pl->save_pl ($path);
		1484	cf::cede_to_tick;
		1485	}
		1486
		1487	sub new($) {
		1488	my ($login) = @_;
		1489
		1490	my $self = create;
		1491
		1492	$self->ob->name ($login);
		1493	$self->{deny_save} = 1;
		1494
		1495	$cf::PLAYER{$login} = $self;
		1496
		1497	$self
		1498	}
		1499
		1500	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1501
		1502	=cut
		1503
		1504	sub send_msg {
		1505	my $ns = shift->ns
		1506	or return;
		1507	$ns->send_msg (@_);
		1508	}
		1509
		1510	=item $pl->quit_character
		1511
		1512	Nukes the player without looking back. If logged in, the connection will
		1513	be destroyed. May block for a long time.
		1514
		1515	=cut
		1516
		1517	sub quit_character {
		1518	my ($pl) = @_;
		1519
		1520	my $name = $pl->ob->name;
		1521
		1522	$pl->{deny_save} = 1;
		1523	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1524
		1525	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1526	$pl->deactivate;
		1527	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1528	$pl->ns->destroy if $pl->ns;
		1529
		1530	my $path = playerdir $pl;
		1531	my $temp = "$path~$cf::RUNTIME~deleting~";
		1532	aio_rename $path, $temp;
		1533	delete $cf::PLAYER{$pl->ob->name};
		1534	$pl->destroy;
		1535
		1536	my $prefix = qr<^~\Q$name\E/>;
		1537
		1538	# nuke player maps
		1539	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1540
		1541	IO::AIO::aio_rmtree $temp;
		1542	}
		1543
		1544	=item $pl->kick
		1545
		1546	Kicks a player out of the game. This destroys the connection.
		1547
		1548	=cut
		1549
		1550	sub kick {
		1551	my ($pl, $kicker) = @_;
		1552
		1553	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1554	$pl->killer ("kicked");
		1555	$pl->ns->destroy;
		1556	}
		1557
		1558	=item cf::player::list_logins
		1559
		1560	Returns am arrayref of all valid playernames in the system, can take a
		1561	while and may block, so not sync_job-capable, ever.
		1562
		1563	=cut
		1564
		1565	sub list_logins {
		1566	my $dirs = aio_readdir $PLAYERDIR
		1567	or return [];
		1568
		1569	my @logins;
		1570
		1571	for my $login (@$dirs) {
		1572	my $path = path $login;
		1573
		1574	# a .pst is a dead give-away for a valid player
		1575	unless (-e "$path.pst") {
		1576	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
		1577	aio_read $fh, 0, 512, my $buf, 0 or next;
		1578	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1579	}
		1580
		1581	utf8::decode $login;
		1582	push @logins, $login;
		1583	}
		1584
		1585	\@logins
		1586	}
		1587
		1588	=item $player->maps
		1589
		1590	Returns an arrayref of map paths that are private for this
		1591	player. May block.
		1592
		1593	=cut
		1594
		1595	sub maps($) {
		1596	my ($pl) = @_;
		1597
		1598	$pl = ref $pl ? $pl->ob->name : $pl;
		1599
		1600	my $files = aio_readdir playerdir $pl
		1601	or return;
		1602
		1603	my @paths;
		1604
		1605	for (@$files) {
		1606	utf8::decode $_;
		1607	next if /\.(?:pl|pst)$/;
		1608	next unless /^$PATH_SEP/o;
		1609
		1610	push @paths, cf::map::normalise "~$pl/$_";
		1611	}
		1612
		1613	\@paths
		1614	}
		1615
		1616	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1617
		1618	Expand crossfire pod fragments into protocol xml.
		1619
		1620	=cut
		1621
		1622	use re 'eval';
		1623
		1624	my $group;
		1625	my $interior; $interior = qr{
		1626	# match a pod interior sequence sans C<< >>
		1627	(?:
		1628	\ (.*?)\ (?{ $group = $^N })
		1629	| < (??{$interior}) >
		1630	)
		1631	}x;
		1632
		1633	sub expand_cfpod {
		1634	my ($self, $pod) = @_;
		1635
		1636	my $xml;
		1637
		1638	while () {
		1639	if ($pod =~ /\G( (?: [^BCGHITU]+ | .(?!<) )+ )/xgcs) {
		1640	$group = $1;
		1641
		1642	$group =~ s/&/&amp;/g;
		1643	$group =~ s/</&lt;/g;
		1644
		1645	$xml .= $group;
		1646	} elsif ($pod =~ m%\G
		1647	([BCGHITU])
		1648	<
		1649	(?:
		1650	([^<>]*) (?{ $group = $^N })
		1651	| < $interior >
		1652	)
		1653	>
		1654	%gcsx
		1655	) {
		1656	my ($code, $data) = ($1, $group);
		1657
		1658	if ($code eq "B") {
		1659	$xml .= "<b>" . expand_cfpod ($self, $data) . "</b>";
		1660	} elsif ($code eq "I") {
		1661	$xml .= "<i>" . expand_cfpod ($self, $data) . "</i>";
		1662	} elsif ($code eq "U") {
		1663	$xml .= "<u>" . expand_cfpod ($self, $data) . "</u>";
		1664	} elsif ($code eq "C") {
		1665	$xml .= "<tt>" . expand_cfpod ($self, $data) . "</tt>";
		1666	} elsif ($code eq "T") {
		1667	$xml .= "<big><b>" . expand_cfpod ($self, $data) . "</b></big>";
		1668	} elsif ($code eq "G") {
		1669	my ($male, $female) = split /\|/, $data;
		1670	$data = $self->gender ? $female : $male;
		1671	$xml .= expand_cfpod ($self, $data);
		1672	} elsif ($code eq "H") {
		1673	$xml .= ("<fg name=\"lightblue\">[" . expand_cfpod ($self, $data) . " (Use hintmode to suppress hints)]</fg>",
		1674	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1675	"")
		1676	[$self->{hintmode}];
		1677	} else {
		1678	$xml .= "error processing '$code($data)' directive";
		1679	}
		1680	} else {
		1681	if ($pod =~ /\G(.+)/) {
		1682	warn "parse error while expanding $pod (at $1)";
		1683	}
		1684	last;
		1685	}
		1686	}
		1687
		1688	for ($xml) {
		1689	# create single paragraphs (very hackish)
		1690	s/(?<=\S)\n(?=\w)/ /g;
		1691
		1692	# compress some whitespace
		1693	s/\s+\n/\n/g; # ws line-ends
		1694	s/\n\n+/\n/g; # double lines
		1695	s/^\n+//; # beginning lines
		1696	s/\n+$//; # ending lines
		1697	}
		1698
		1699	$xml
		1700	}
		1701
		1702	no re 'eval';
		1703
		1704	sub hintmode {
		1705	$_[0]{hintmode} = $_[1] if @_ > 1;
		1706	$_[0]{hintmode}
		1707	}
		1708
		1709	=item $player->ext_reply ($msgid, @msg)
		1710
		1711	Sends an ext reply to the player.
		1712
		1713	=cut
		1714
		1715	sub ext_reply($$@) {
		1716	my ($self, $id, @msg) = @_;
		1717
		1718	$self->ns->ext_reply ($id, @msg)
		1719	}
		1720
		1721	=item $player->ext_msg ($type, @msg)
		1722
		1723	Sends an ext event to the client.
		1724
		1725	=cut
		1726
		1727	sub ext_msg($$@) {
		1728	my ($self, $type, @msg) = @_;
		1729
		1730	$self->ns->ext_msg ($type, @msg);
		1731	}
		1732
		1733	=head3 cf::region
		1734
		1735	=over 4
		1736
		1737	=cut
		1738
		1739	package cf::region;
		1740
		1741	=item cf::region::find_by_path $path
		1742
		1743	Tries to decuce the likely region for a map knowing only its path.
		1744
		1745	=cut
		1746
		1747	sub find_by_path($) {
		1748	my ($path) = @_;
		1749
		1750	my ($match, $specificity);
		1751
		1752	for my $region (list) {
		1753	if ($region->{match} && $path =~ $region->{match}) {
		1754	($match, $specificity) = ($region, $region->specificity)
		1755	if $region->specificity > $specificity;
		1756	}
		1757	}
		1758
		1759	$match
		1760	}
		1761
		1762	=back
		1763
		1764	=head3 cf::map
		1765
		1766	=over 4
		1767
		1768	=cut
		1769
		1770	package cf::map;
		1771
		1772	use Fcntl;
		1773	use Coro::AIO;
		1774
		1775	use overload
		1776	'""' => \&as_string,
		1777	fallback => 1;
		1778
		1779	our $MAX_RESET = 3600;
		1780	our $DEFAULT_RESET = 3000;
		1781
		1782	sub generate_random_map {
		1783	my ($self, $rmp) = @_;
		1784
		1785	my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
		1786
		1787	# mit "rum" bekleckern, nicht
		1788	$self->_create_random_map (
		1789	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1790	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1791	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1792	$rmp->{exit_on_final_map},
		1793	$rmp->{xsize}, $rmp->{ysize},
		1794	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1795	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1796	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1797	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1798	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1799	(cf::region::find $rmp->{region}), $rmp->{custom}
		1800	)
		1801	}
		1802
		1803	=item cf::map->register ($regex, $prio)
		1804
		1805	Register a handler for the map path matching the given regex at the
		1806	givne priority (higher is better, built-in handlers have priority 0, the
		1807	default).
		1808
		1809	=cut
		1810
635	sub register {	1811	sub register {
		1812	my (undef, $regex, $prio) = @_;
		1813	my $pkg = caller;
		1814
		1815	no strict;
		1816	push @{"$pkg\::ISA"}, __PACKAGE__;
		1817
		1818	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1819	}
		1820
		1821	# also paths starting with '/'
		1822	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1823
		1824	sub thawer_merge {
636	my ($base, $pkg) = @_;	1825	my ($self, $merge) = @_;
637		1826
638	#TODO	1827	# we have to keep some variables in memory intact
639	}	1828	local $self->{path};
		1829	local $self->{load_path};
640		1830
641	sub load_extension {	1831	$self->SUPER::thawer_merge ($merge);
		1832	}
		1833
		1834	sub normalise {
642	my ($path) = @_;	1835	my ($path, $base) = @_;
643		1836
644	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1837	$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		1838
650	warn "loading '$path' into '$pkg'\n";	1839	$path =~ s/\.map$//;
651		1840
652	open my $fh, "<:utf8", $path	1841	# map plan:
653	or die "$path: $!";	1842	#
		1843	# /! non-realised random map exit (special hack!)
		1844	# {... are special paths that are not being touched
		1845	# ?xxx/... are special absolute paths
		1846	# ?random/... random maps
		1847	# /... normal maps
		1848	# ~user/... per-player map of a specific user
654		1849
655	my $source =	1850	$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		1851
661	eval $source	1852	# treat it as relative path if it starts with
662	or die $@ ? "$path: $@\n"	1853	# something that looks reasonable
663	: "extension disabled.\n";	1854	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1855	$base or Carp::carp "normalise called with relative path and no base: '$path'";
664		1856
665	push @exts, $pkg;	1857	$base =~ s{[^/]+/?$}{};
666	$ext_pkg{$base} = $pkg;	1858	$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	# }	1859	}
684		1860
685	# remove commands	1861	for ($path) {
686	for my $name (keys %COMMAND) {	1862	redo if s{//}{/};
687	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };	1863	redo if s{/\.?/}{/};
		1864	redo if s{/[^/]+/\.\./}{/};
		1865	}
688		1866
689	if (@cb) {	1867	$path
690	$COMMAND{$name} = \@cb;	1868	}
		1869
		1870	sub new_from_path {
		1871	my (undef, $path, $base) = @_;
		1872
		1873	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1874
		1875	$path = normalise $path, $base;
		1876
		1877	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1878	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1879	my $self = bless cf::map::new, $pkg;
		1880	$self->{path} = $path; $self->path ($path);
		1881	$self->init; # pass $1 etc.
		1882	return $self;
		1883	}
		1884	}
		1885
		1886	Carp::cluck "unable to resolve path '$path' (base '$base').";
		1887	()
		1888	}
		1889
		1890	sub init {
		1891	my ($self) = @_;
		1892
		1893	$self
		1894	}
		1895
		1896	sub as_string {
		1897	my ($self) = @_;
		1898
		1899	"$self->{path}"
		1900	}
		1901
		1902	# the displayed name, this is a one way mapping
		1903	sub visible_name {
		1904	&as_string
		1905	}
		1906
		1907	# the original (read-only) location
		1908	sub load_path {
		1909	my ($self) = @_;
		1910
		1911	"$MAPDIR/$self->{path}.map"
		1912	}
		1913
		1914	# the temporary/swap location
		1915	sub save_path {
		1916	my ($self) = @_;
		1917
		1918	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
		1919	"$TMPDIR/$path.map"
		1920	}
		1921
		1922	# the unique path, undef == no special unique path
		1923	sub uniq_path {
		1924	my ($self) = @_;
		1925
		1926	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
		1927	"$UNIQUEDIR/$path"
		1928	}
		1929
		1930	# and all this just because we cannot iterate over
		1931	# all maps in C++...
		1932	sub change_all_map_light {
		1933	my ($change) = @_;
		1934
		1935	$_->change_map_light ($change)
		1936	for grep $_->outdoor, values %cf::MAP;
		1937	}
		1938
		1939	sub decay_objects {
		1940	my ($self) = @_;
		1941
		1942	return if $self->{deny_reset};
		1943
		1944	$self->do_decay_objects;
		1945	}
		1946
		1947	sub unlink_save {
		1948	my ($self) = @_;
		1949
		1950	utf8::encode (my $save = $self->save_path);
		1951	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1952	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1953	}
		1954
		1955	sub load_header_from($) {
		1956	my ($self, $path) = @_;
		1957
		1958	utf8::encode $path;
		1959	my $f = new_from_file cf::object::thawer $path
		1960	or return;
		1961
		1962	$self->_load_header ($f)
		1963	or return;
		1964
		1965	local $MAP_LOADING{$self->{path}} = $self;
		1966	$f->resolve_delayed_derefs;
		1967
		1968	$self->{load_path} = $path;
		1969
		1970	1
		1971	}
		1972
		1973	sub load_header_orig {
		1974	my ($self) = @_;
		1975
		1976	$self->load_header_from ($self->load_path)
		1977	}
		1978
		1979	sub load_header_temp {
		1980	my ($self) = @_;
		1981
		1982	$self->load_header_from ($self->save_path)
		1983	}
		1984
		1985	sub prepare_temp {
		1986	my ($self) = @_;
		1987
		1988	$self->last_access ((delete $self->{last_access})
		1989	|| $cf::RUNTIME); #d#
		1990	# safety
		1991	$self->{instantiate_time} = $cf::RUNTIME
		1992	if $self->{instantiate_time} > $cf::RUNTIME;
		1993	}
		1994
		1995	sub prepare_orig {
		1996	my ($self) = @_;
		1997
		1998	$self->{load_original} = 1;
		1999	$self->{instantiate_time} = $cf::RUNTIME;
		2000	$self->last_access ($cf::RUNTIME);
		2001	$self->instantiate;
		2002	}
		2003
		2004	sub load_header {
		2005	my ($self) = @_;
		2006
		2007	if ($self->load_header_temp) {
		2008	$self->prepare_temp;
691	} else {	2009	} else {
692	delete $COMMAND{$name};	2010	$self->load_header_orig
693	}	2011	or return;
		2012	$self->prepare_orig;
		2013	}
		2014
		2015	$self->{deny_reset} = 1
		2016	if $self->no_reset;
		2017
		2018	$self->default_region (cf::region::find_by_path $self->{path})
		2019	unless $self->default_region;
		2020
694	}	2021	1
		2022	}
695		2023
696	# remove extcmds	2024	sub find;
697	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {	2025	sub find {
698	delete $EXTCMD{$name};	2026	my ($path, $origin) = @_;
		2027
		2028	$path = normalise $path, $origin && $origin->path;
		2029
		2030	cf::lock_wait "map_data:$path";#d#remove
		2031	cf::lock_wait "map_find:$path";
		2032
		2033	$cf::MAP{$path} || do {
		2034	my $guard1 = cf::lock_acquire "map_find:$path";
		2035	my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
		2036
		2037	my $map = new_from_path cf::map $path
		2038	or return;
		2039
		2040	$map->{last_save} = $cf::RUNTIME;
		2041
		2042	$map->load_header
		2043	or return;
		2044
		2045	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		2046	# doing this can freeze the server in a sync job, obviously
		2047	#$cf::WAIT_FOR_TICK->wait;
		2048	undef $guard1;
		2049	undef $guard2;
		2050	$map->reset;
		2051	return find $path;
		2052	}
		2053
		2054	$cf::MAP{$path} = $map
		2055	}
		2056	}
		2057
		2058	sub pre_load { }
		2059	sub post_load { }
		2060
		2061	sub load {
		2062	my ($self) = @_;
		2063
		2064	local $self->{deny_reset} = 1; # loading can take a long time
		2065
		2066	my $path = $self->{path};
		2067
699	}	2068	{
		2069	my $guard = cf::lock_acquire "map_data:$path";
700		2070
701	if (my $cb = $pkg->can ("unload")) {	2071	return unless $self->valid;
702	eval {	2072	return unless $self->in_memory == cf::MAP_SWAPPED;
703	$cb->($pkg);	2073
		2074	$self->in_memory (cf::MAP_LOADING);
		2075
		2076	$self->alloc;
		2077
		2078	$self->pre_load;
		2079	cf::cede_to_tick;
		2080
		2081	my $f = new_from_file cf::object::thawer $self->{load_path};
		2082	$f->skip_block;
		2083	$self->_load_objects ($f)
		2084	or return;
		2085
		2086	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		2087	if delete $self->{load_original};
		2088
		2089	if (my $uniq = $self->uniq_path) {
		2090	utf8::encode $uniq;
		2091	unless (aio_stat $uniq) {
		2092	if (my $f = new_from_file cf::object::thawer $uniq) {
		2093	$self->clear_unique_items;
		2094	$self->_load_objects ($f);
		2095	$f->resolve_delayed_derefs;
		2096	}
704	1	2097	}
705	} or warn "$pkg unloaded, but with errors: $@";	2098	}
706	}
707		2099
708	Symbol::delete_package $pkg;	2100	$f->resolve_delayed_derefs;
709	}
710		2101
711	sub load_extensions {	2102	cf::cede_to_tick;
712	for my $ext (<$LIBDIR/*.ext>) {	2103	# now do the right thing for maps
713	next unless -r $ext;	2104	$self->link_multipart_objects;
714	eval {	2105	$self->difficulty ($self->estimate_difficulty)
715	load_extension $ext;	2106	unless $self->difficulty;
716	1	2107	cf::cede_to_tick;
717	} or warn "$ext not loaded: $@";
718	}
719	}
720		2108
721	#############################################################################	2109	unless ($self->{deny_activate}) {
722	# load/save/clean perl data associated with a map	2110	$self->decay_objects;
		2111	$self->fix_auto_apply;
		2112	$self->update_buttons;
		2113	cf::cede_to_tick;
		2114	$self->set_darkness_map;
		2115	cf::cede_to_tick;
		2116	$self->activate;
		2117	}
723		2118
724	*cf::mapsupport::on_clean = sub {	2119	$self->{last_save} = $cf::RUNTIME;
		2120	$self->last_access ($cf::RUNTIME);
		2121
		2122	$self->in_memory (cf::MAP_ACTIVE);
		2123	}
		2124
		2125	$self->post_load;
		2126	}
		2127
		2128	sub customise_for {
		2129	my ($self, $ob) = @_;
		2130
		2131	return find "~" . $ob->name . "/" . $self->{path}
		2132	if $self->per_player;
		2133
		2134	# return find "?party/" . $ob->name . "/" . $self->{path}
		2135	# if $self->per_party;
		2136
		2137	$self
		2138	}
		2139
		2140	# find and load all maps in the 3x3 area around a map
		2141	sub load_neighbours {
725	my ($map) = @_;	2142	my ($map) = @_;
726		2143
727	my $path = $map->tmpname;	2144	my @neigh; # diagonal neighbours
728	defined $path or return;
729		2145
730	unlink "$path.pst";	2146	for (0 .. 3) {
731	};	2147	my $neigh = $map->tile_path ($_)
		2148	or next;
		2149	$neigh = find $neigh, $map
		2150	or next;
		2151	$neigh->load;
732		2152
733	cf::map->attach (prio => -10000, package => cf::mapsupport::);	2153	push @neigh,
		2154	[$neigh->tile_path (($_ + 3) % 4), $neigh],
		2155	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		2156	}
734		2157
735	#############################################################################	2158	for (grep defined $_->[0], @neigh) {
736	# load/save perl data associated with player->ob objects	2159	my ($path, $origin) = @$_;
737		2160	my $neigh = find $path, $origin
738	sub all_objects(@) {	2161	or next;
739	@_, map all_objects ($_->inv), @_	2162	$neigh->load;
		2163	}
740	}	2164	}
741		2165
742	# TODO: compatibility cruft, remove when no longer needed	2166	sub find_sync {
743	cf::player->attach (	2167	my ($path, $origin) = @_;
744	on_load => sub {
745	my ($pl, $path) = @_;
746		2168
747	for my $o (all_objects $pl->ob) {	2169	cf::sync_job { find $path, $origin }
748	if (my $value = $o->get_ob_key_value ("_perl_data")) {	2170	}
749	$o->set_ob_key_value ("_perl_data");
750		2171
751	%$o = %{ Storable::thaw pack "H*", $value };	2172	sub do_load_sync {
		2173	my ($map) = @_;
		2174
		2175	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2176	if $Coro::current == $Coro::main;
		2177
		2178	cf::sync_job { $map->load };
		2179	}
		2180
		2181	our %MAP_PREFETCH;
		2182	our $MAP_PREFETCHER = undef;
		2183
		2184	sub find_async {
		2185	my ($path, $origin, $load) = @_;
		2186
		2187	$path = normalise $path, $origin && $origin->{path};
		2188
		2189	if (my $map = $cf::MAP{$path}) {
		2190	return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
		2191	}
		2192
		2193	$MAP_PREFETCH{$path} |= $load;
		2194
		2195	$MAP_PREFETCHER ||= cf::async {
		2196	$Coro::current->{desc} = "map prefetcher";
		2197
		2198	while (%MAP_PREFETCH) {
		2199	while (my ($k, $v) = each %MAP_PREFETCH) {
		2200	if (my $map = find $k) {
		2201	$map->load if $v;
		2202	}
		2203
		2204	delete $MAP_PREFETCH{$k};
752	}	2205	}
753	}	2206	}
		2207	undef $MAP_PREFETCHER;
		2208	};
		2209	$MAP_PREFETCHER->prio (6);
		2210
		2211	()
		2212	}
		2213
		2214	sub save {
		2215	my ($self) = @_;
		2216
		2217	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2218
		2219	$self->{last_save} = $cf::RUNTIME;
		2220
		2221	return unless $self->dirty;
		2222
		2223	my $save = $self->save_path; utf8::encode $save;
		2224	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2225
		2226	$self->{load_path} = $save;
		2227
		2228	return if $self->{deny_save};
		2229
		2230	local $self->{last_access} = $self->last_access;#d#
		2231
		2232	cf::async {
		2233	$Coro::current->{desc} = "map player save";
		2234	$_->contr->save for $self->players;
		2235	};
		2236
		2237	cf::get_slot 0.02;
		2238
		2239	if ($uniq) {
		2240	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		2241	$self->_save_objects ($uniq, cf::IO_UNIQUES);
		2242	} else {
		2243	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
754	},	2244	}
755	);	2245	}
756		2246
757	#############################################################################	2247	sub swap_out {
		2248	my ($self) = @_;
758		2249
759	=head2 CORE EXTENSIONS	2250	# save first because save cedes
		2251	$self->save;
760		2252
761	Functions and methods that extend core crossfire objects.	2253	my $lock = cf::lock_acquire "map_data:$self->{path}";
762		2254
763	=head3 cf::player	2255	return if $self->players;
		2256	return if $self->in_memory != cf::MAP_ACTIVE;
		2257	return if $self->{deny_save};
		2258
		2259	$self->in_memory (cf::MAP_SWAPPED);
		2260
		2261	$self->deactivate;
		2262	$_->clear_links_to ($self) for values %cf::MAP;
		2263	$self->clear;
		2264	}
		2265
		2266	sub reset_at {
		2267	my ($self) = @_;
		2268
		2269	# TODO: safety, remove and allow resettable per-player maps
		2270	return 1e99 if $self->{deny_reset};
		2271
		2272	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		2273	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		2274
		2275	$time + $to
		2276	}
		2277
		2278	sub should_reset {
		2279	my ($self) = @_;
		2280
		2281	$self->reset_at <= $cf::RUNTIME
		2282	}
		2283
		2284	sub reset {
		2285	my ($self) = @_;
		2286
		2287	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2288
		2289	return if $self->players;
		2290
		2291	warn "resetting map ", $self->path;
		2292
		2293	$self->in_memory (cf::MAP_SWAPPED);
		2294
		2295	# need to save uniques path
		2296	unless ($self->{deny_save}) {
		2297	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2298
		2299	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2300	if $uniq;
		2301	}
		2302
		2303	delete $cf::MAP{$self->path};
		2304
		2305	$self->deactivate;
		2306	$_->clear_links_to ($self) for values %cf::MAP;
		2307	$self->clear;
		2308
		2309	$self->unlink_save;
		2310	$self->destroy;
		2311	}
		2312
		2313	my $nuke_counter = "aaaa";
		2314
		2315	sub nuke {
		2316	my ($self) = @_;
		2317
		2318	{
		2319	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2320
		2321	delete $cf::MAP{$self->path};
		2322
		2323	$self->unlink_save;
		2324
		2325	bless $self, "cf::map";
		2326	delete $self->{deny_reset};
		2327	$self->{deny_save} = 1;
		2328	$self->reset_timeout (1);
		2329	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2330
		2331	$cf::MAP{$self->path} = $self;
		2332	}
		2333
		2334	$self->reset; # polite request, might not happen
		2335	}
		2336
		2337	=item $maps = cf::map::tmp_maps
		2338
		2339	Returns an arrayref with all map paths of currently instantiated and saved
		2340	maps. May block.
		2341
		2342	=cut
		2343
		2344	sub tmp_maps() {
		2345	[
		2346	map {
		2347	utf8::decode $_;
		2348	/\.map$/
		2349	? normalise $_
		2350	: ()
		2351	} @{ aio_readdir $TMPDIR or [] }
		2352	]
		2353	}
		2354
		2355	=item $maps = cf::map::random_maps
		2356
		2357	Returns an arrayref with all map paths of currently instantiated and saved
		2358	random maps. May block.
		2359
		2360	=cut
		2361
		2362	sub random_maps() {
		2363	[
		2364	map {
		2365	utf8::decode $_;
		2366	/\.map$/
		2367	? normalise "?random/$_"
		2368	: ()
		2369	} @{ aio_readdir $RANDOMDIR or [] }
		2370	]
		2371	}
		2372
		2373	=item cf::map::unique_maps
		2374
		2375	Returns an arrayref of paths of all shared maps that have
		2376	instantiated unique items. May block.
		2377
		2378	=cut
		2379
		2380	sub unique_maps() {
		2381	[
		2382	map {
		2383	utf8::decode $_;
		2384	s/\.map$//; # TODO future compatibility hack
		2385	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
		2386	? ()
		2387	: normalise $_
		2388	} @{ aio_readdir $UNIQUEDIR or [] }
		2389	]
		2390	}
		2391
		2392	=back
		2393
		2394	=head3 cf::object
		2395
		2396	=cut
		2397
		2398	package cf::object;
764		2399
765	=over 4	2400	=over 4
766		2401
767	=item cf::player::exists $login	2402	=item $ob->inv_recursive
768		2403
769	Returns true when the given account exists.	2404	Returns the inventory of the object I<and> their inventories, recursively,
		2405	but I<not> the object itself.
770		2406
771	=cut	2407	=cut
772		2408
773	sub cf::player::exists($) {	2409	sub inv_recursive_;
774	cf::player::find $_[0]	2410	sub inv_recursive_ {
775	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	2411	map { $_, inv_recursive_ $_->inv } @_
776	}	2412	}
777		2413
778	=item $player->ext_reply ($msgid, $msgtype, %msg)	2414	sub inv_recursive {
779		2415	inv_recursive_ inv $_[0]
780	Sends an ext reply to the player.
781
782	=cut
783
784	sub cf::player::ext_reply($$$%) {
785	my ($self, $id, %msg) = @_;
786
787	$msg{msgid} = $id;
788
789	$self->send ("ext " . to_json \%msg);
790	}	2416	}
		2417
		2418	=item $ref = $ob->ref
		2419
		2420	Creates and returns a persistent reference to an object that can be stored as a string.
		2421
		2422	=item $ob = cf::object::deref ($refstring)
		2423
		2424	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2425	even if the object actually exists. May block.
		2426
		2427	=cut
		2428
		2429	sub deref {
		2430	my ($ref) = @_;
		2431
		2432	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2433	my ($uuid, $name) = ($1, $2);
		2434	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2435	or return;
		2436	$pl->ob->uuid eq $uuid
		2437	or return;
		2438
		2439	$pl->ob
		2440	} else {
		2441	warn "$ref: cannot resolve object reference\n";
		2442	undef
		2443	}
		2444	}
		2445
		2446	package cf;
791		2447
792	=back	2448	=back
793		2449
794	=head3 cf::object::player	2450	=head3 cf::object::player
795		2451
…		…
811		2467
812	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2468	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
813		2469
814	if ($self->{record_replies}) {	2470	if ($self->{record_replies}) {
815	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2471	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2472
816	} else {	2473	} else {
		2474	my $pl = $self->contr;
		2475
		2476	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2477	my $dialog = $pl->{npc_dialog};
		2478	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2479
		2480	} else {
817	$msg = $npc->name . " says: $msg" if $npc;	2481	$msg = $npc->name . " says: $msg" if $npc;
818	$self->message ($msg, $flags);	2482	$self->message ($msg, $flags);
		2483	}
819	}	2484	}
		2485	}
		2486
		2487	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2488
		2489	=cut
		2490
		2491	sub cf::object::send_msg {
		2492	my $pl = shift->contr
		2493	or return;
		2494	$pl->send_msg (@_);
820	}	2495	}
821		2496
822	=item $player_object->may ("access")	2497	=item $player_object->may ("access")
823		2498
824	Returns wether the given player is authorized to access resource "access"	2499	Returns wether the given player is authorized to access resource "access"
…		…
833	(ref $cf::CFG{"may_$access"}	2508	(ref $cf::CFG{"may_$access"}
834	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	2509	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
835	: $cf::CFG{"may_$access"})	2510	: $cf::CFG{"may_$access"})
836	}	2511	}
837		2512
		2513	=item $player_object->enter_link
		2514
		2515	Freezes the player and moves him/her to a special map (C<{link}>).
		2516
		2517	The player should be reasonably safe there for short amounts of time. You
		2518	I<MUST> call C<leave_link> as soon as possible, though.
		2519
		2520	Will never block.
		2521
		2522	=item $player_object->leave_link ($map, $x, $y)
		2523
		2524	Moves the player out of the special C<{link}> map onto the specified
		2525	map. If the map is not valid (or omitted), the player will be moved back
		2526	to the location he/she was before the call to C<enter_link>, or, if that
		2527	fails, to the emergency map position.
		2528
		2529	Might block.
		2530
		2531	=cut
		2532
		2533	sub link_map {
		2534	unless ($LINK_MAP) {
		2535	$LINK_MAP = cf::map::find "{link}"
		2536	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2537	$LINK_MAP->load;
		2538	}
		2539
		2540	$LINK_MAP
		2541	}
		2542
		2543	sub cf::object::player::enter_link {
		2544	my ($self) = @_;
		2545
		2546	$self->deactivate_recursive;
		2547
		2548	return if UNIVERSAL::isa $self->map, "ext::map_link";
		2549
		2550	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		2551	if $self->map && $self->map->{path} ne "{link}";
		2552
		2553	$self->enter_map ($LINK_MAP || link_map, 10, 10);
		2554	}
		2555
		2556	sub cf::object::player::leave_link {
		2557	my ($self, $map, $x, $y) = @_;
		2558
		2559	return unless $self->contr->active;
		2560
		2561	my $link_pos = delete $self->{_link_pos};
		2562
		2563	unless ($map) {
		2564	# restore original map position
		2565	($map, $x, $y) = @{ $link_pos || [] };
		2566	$map = cf::map::find $map;
		2567
		2568	unless ($map) {
		2569	($map, $x, $y) = @$EMERGENCY_POSITION;
		2570	$map = cf::map::find $map
		2571	or die "FATAL: cannot load emergency map\n";
		2572	}
		2573	}
		2574
		2575	($x, $y) = (-1, -1)
		2576	unless (defined $x) && (defined $y);
		2577
		2578	# use -1 or undef as default coordinates, not 0, 0
		2579	($x, $y) = ($map->enter_x, $map->enter_y)
		2580	if $x <=0 && $y <= 0;
		2581
		2582	$map->load;
		2583	$map->load_neighbours;
		2584
		2585	return unless $self->contr->active;
		2586	$self->activate_recursive;
		2587
		2588	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
		2589	$self->enter_map ($map, $x, $y);
		2590	}
		2591
		2592	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
		2593
		2594	Moves the player to the given map-path and coordinates by first freezing
		2595	her, loading and preparing them map, calling the provided $check callback
		2596	that has to return the map if sucecssful, and then unfreezes the player on
		2597	the new (success) or old (failed) map position. In either case, $done will
		2598	be called at the end of this process.
		2599
		2600	=cut
		2601
		2602	our $GOTOGEN;
		2603
		2604	sub cf::object::player::goto {
		2605	my ($self, $path, $x, $y, $check, $done) = @_;
		2606
		2607	# do generation counting so two concurrent goto's will be executed in-order
		2608	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
		2609
		2610	$self->enter_link;
		2611
		2612	(async {
		2613	$Coro::current->{desc} = "player::goto $path $x $y";
		2614
		2615	# *tag paths override both path and x|y
		2616	if ($path =~ /^\*(.*)$/) {
		2617	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2618	my $ob = $obs[rand @obs];
		2619
		2620	# see if we actually can go there
		2621	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2622	$ob = $obs[rand @obs];
		2623	} else {
		2624	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2625	}
		2626	# else put us there anyways for now #d#
		2627
		2628	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2629	} else {
		2630	($path, $x, $y) = (undef, undef, undef);
		2631	}
		2632	}
		2633
		2634	my $map = eval {
		2635	my $map = defined $path ? cf::map::find $path : undef;
		2636
		2637	if ($map) {
		2638	$map = $map->customise_for ($self);
		2639	$map = $check->($map) if $check && $map;
		2640	} else {
		2641	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2642	}
		2643
		2644	$map
		2645	};
		2646
		2647	if ($@) {
		2648	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2649	LOG llevError | logBacktrace, Carp::longmess $@;
		2650	}
		2651
		2652	if ($gen == $self->{_goto_generation}) {
		2653	delete $self->{_goto_generation};
		2654	$self->leave_link ($map, $x, $y);
		2655	}
		2656
		2657	$done->() if $done;
		2658	})->prio (1);
		2659	}
		2660
		2661	=item $player_object->enter_exit ($exit_object)
		2662
		2663	=cut
		2664
		2665	sub parse_random_map_params {
		2666	my ($spec) = @_;
		2667
		2668	my $rmp = { # defaults
		2669	xsize => (cf::rndm 15, 40),
		2670	ysize => (cf::rndm 15, 40),
		2671	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2672	#layout => string,
		2673	};
		2674
		2675	for (split /\n/, $spec) {
		2676	my ($k, $v) = split /\s+/, $_, 2;
		2677
		2678	$rmp->{lc $k} = $v if (length $k) && (length $v);
		2679	}
		2680
		2681	$rmp
		2682	}
		2683
		2684	sub prepare_random_map {
		2685	my ($exit) = @_;
		2686
		2687	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2688
		2689	# all this does is basically replace the /! path by
		2690	# a new random map path (?random/...) with a seed
		2691	# that depends on the exit object
		2692
		2693	my $rmp = parse_random_map_params $exit->msg;
		2694
		2695	if ($exit->map) {
		2696	$rmp->{region} = $exit->region->name;
		2697	$rmp->{origin_map} = $exit->map->path;
		2698	$rmp->{origin_x} = $exit->x;
		2699	$rmp->{origin_y} = $exit->y;
		2700	}
		2701
		2702	$rmp->{random_seed} ||= $exit->random_seed;
		2703
		2704	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
		2705	my $md5 = Digest::MD5::md5_hex $data;
		2706	my $meta = "$RANDOMDIR/$md5.meta";
		2707
		2708	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		2709	aio_write $fh, 0, (length $data), $data, 0;
		2710	undef $fh;
		2711	aio_rename "$meta~", $meta;
		2712
		2713	$exit->slaying ("?random/$md5");
		2714	$exit->msg (undef);
		2715	}
		2716	}
		2717
		2718	sub cf::object::player::enter_exit {
		2719	my ($self, $exit) = @_;
		2720
		2721	return unless $self->type == cf::PLAYER;
		2722
		2723	if ($exit->slaying eq "/!") {
		2724	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2725	# the problem is that $exit might not survive long enough
		2726	# so it needs to be done right now, right here
		2727	cf::sync_job { prepare_random_map $exit };
		2728	}
		2729
		2730	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2731	my $hp = $exit->stats->hp;
		2732	my $sp = $exit->stats->sp;
		2733
		2734	$self->enter_link;
		2735
		2736	# if exit is damned, update players death & WoR home-position
		2737	$self->contr->savebed ($slaying, $hp, $sp)
		2738	if $exit->flag (FLAG_DAMNED);
		2739
		2740	(async {
		2741	$Coro::current->{desc} = "enter_exit $slaying $hp $sp";
		2742
		2743	$self->deactivate_recursive; # just to be sure
		2744	unless (eval {
		2745	$self->goto ($slaying, $hp, $sp);
		2746
		2747	1;
		2748	}) {
		2749	$self->message ("Something went wrong deep within the crossfire server. "
		2750	. "I'll try to bring you back to the map you were before. "
		2751	. "Please report this to the dungeon master!",
		2752	cf::NDI_UNIQUE | cf::NDI_RED);
		2753
		2754	warn "ERROR in enter_exit: $@";
		2755	$self->leave_link;
		2756	}
		2757	})->prio (1);
		2758	}
		2759
838	=head3 cf::client	2760	=head3 cf::client
839		2761
840	=over 4	2762	=over 4
841		2763
842	=item $client->send_drawinfo ($text, $flags)	2764	=item $client->send_drawinfo ($text, $flags)
…		…
848		2770
849	sub cf::client::send_drawinfo {	2771	sub cf::client::send_drawinfo {
850	my ($self, $text, $flags) = @_;	2772	my ($self, $text, $flags) = @_;
851		2773
852	utf8::encode $text;	2774	utf8::encode $text;
853	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2775	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
854	}	2776	}
855		2777
		2778	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2779
		2780	Send a drawinfo or msg packet to the client, formatting the msg for the
		2781	client if neccessary. C<$type> should be a string identifying the type of
		2782	the message, with C<log> being the default. If C<$color> is negative, suppress
		2783	the message unless the client supports the msg packet.
		2784
		2785	=cut
		2786
		2787	# non-persistent channels (usually the info channel)
		2788	our %CHANNEL = (
		2789	"c/identify" => {
		2790	id => "infobox",
		2791	title => "Identify",
		2792	reply => undef,
		2793	tooltip => "Items recently identified",
		2794	},
		2795	"c/examine" => {
		2796	id => "infobox",
		2797	title => "Examine",
		2798	reply => undef,
		2799	tooltip => "Signs and other items you examined",
		2800	},
		2801	"c/book" => {
		2802	id => "infobox",
		2803	title => "Book",
		2804	reply => undef,
		2805	tooltip => "The contents of a note or book",
		2806	},
		2807	"c/lookat" => {
		2808	id => "infobox",
		2809	title => "Look",
		2810	reply => undef,
		2811	tooltip => "What you saw there",
		2812	},
		2813	"c/who" => {
		2814	id => "infobox",
		2815	title => "Players",
		2816	reply => undef,
		2817	tooltip => "Shows players who are currently online",
		2818	},
		2819	"c/body" => {
		2820	id => "infobox",
		2821	title => "Body Parts",
		2822	reply => undef,
		2823	tooltip => "Shows which body parts you posess and are available",
		2824	},
		2825	"c/uptime" => {
		2826	id => "infobox",
		2827	title => "Uptime",
		2828	reply => undef,
		2829	tooltip => "How long the server has been running since last restart",
		2830	},
		2831	"c/mapinfo" => {
		2832	id => "infobox",
		2833	title => "Map Info",
		2834	reply => undef,
		2835	tooltip => "Information related to the maps",
		2836	},
		2837	);
		2838
		2839	sub cf::client::send_msg {
		2840	my ($self, $channel, $msg, $color, @extra) = @_;
		2841
		2842	$msg = $self->pl->expand_cfpod ($msg);
		2843
		2844	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2845
		2846	# check predefined channels, for the benefit of C
		2847	if ($CHANNEL{$channel}) {
		2848	$channel = $CHANNEL{$channel};
		2849
		2850	$self->ext_msg (channel_info => $channel)
		2851	if $self->can_msg;
		2852
		2853	$channel = $channel->{id};
		2854
		2855	} elsif (ref $channel) {
		2856	# send meta info to client, if not yet sent
		2857	unless (exists $self->{channel}{$channel->{id}}) {
		2858	$self->{channel}{$channel->{id}} = $channel;
		2859	$self->ext_msg (channel_info => $channel)
		2860	if $self->can_msg;
		2861	}
		2862
		2863	$channel = $channel->{id};
		2864	}
		2865
		2866	return unless @extra || length $msg;
		2867
		2868	if ($self->can_msg) {
		2869	# default colour, mask it out
		2870	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2871	if $color & cf::NDI_DEF;
		2872
		2873	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2874	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2875	} else {
		2876	if ($color >= 0) {
		2877	# replace some tags by gcfclient-compatible ones
		2878	for ($msg) {
		2879	1 while
		2880	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2881	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2882	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2883	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2884	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2885	}
		2886
		2887	$color &= cf::NDI_COLOR_MASK;
		2888
		2889	utf8::encode $msg;
		2890
		2891	if (0 && $msg =~ /\[/) {
		2892	# COMMAND/INFO
		2893	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2894	} else {
		2895	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2896	$self->send_packet ("drawinfo $color $msg")
		2897	}
		2898	}
		2899	}
		2900	}
		2901
		2902	=item $client->ext_msg ($type, @msg)
		2903
		2904	Sends an ext event to the client.
		2905
		2906	=cut
		2907
		2908	sub cf::client::ext_msg($$@) {
		2909	my ($self, $type, @msg) = @_;
		2910
		2911	if ($self->extcmd == 2) {
		2912	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2913	} elsif ($self->extcmd == 1) { # TODO: remove
		2914	push @msg, msgtype => "event_$type";
		2915	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2916	}
		2917	}
		2918
		2919	=item $client->ext_reply ($msgid, @msg)
		2920
		2921	Sends an ext reply to the client.
		2922
		2923	=cut
		2924
		2925	sub cf::client::ext_reply($$@) {
		2926	my ($self, $id, @msg) = @_;
		2927
		2928	if ($self->extcmd == 2) {
		2929	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2930	} elsif ($self->extcmd == 1) {
		2931	#TODO: version 1, remove
		2932	unshift @msg, msgtype => "reply", msgid => $id;
		2933	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2934	}
		2935	}
856		2936
857	=item $success = $client->query ($flags, "text", \&cb)	2937	=item $success = $client->query ($flags, "text", \&cb)
858		2938
859	Queues a query to the client, calling the given callback with	2939	Queues a query to the client, calling the given callback with
860	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2940	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
861	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2941	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
862		2942
863	Queries can fail, so check the return code. Or don't, as queries will become	2943	Queries can fail, so check the return code. Or don't, as queries will
864	reliable at some point in the future.	2944	become reliable at some point in the future.
865		2945
866	=cut	2946	=cut
867		2947
868	sub cf::client::query {	2948	sub cf::client::query {
869	my ($self, $flags, $text, $cb) = @_;	2949	my ($self, $flags, $text, $cb) = @_;
…		…
877	utf8::encode $text;	2957	utf8::encode $text;
878	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2958	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
879		2959
880	$self->send_packet ($self->{query_queue}[0][0])	2960	$self->send_packet ($self->{query_queue}[0][0])
881	if @{ $self->{query_queue} } == 1;	2961	if @{ $self->{query_queue} } == 1;
		2962
		2963	1
882	}	2964	}
883		2965
884	cf::client->attach (	2966	cf::client->attach (
		2967	on_connect => sub {
		2968	my ($ns) = @_;
		2969
		2970	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2971	},
885	on_reply => sub {	2972	on_reply => sub {
886	my ($ns, $msg) = @_;	2973	my ($ns, $msg) = @_;
887		2974
888	# this weird shuffling is so that direct followup queries	2975	# this weird shuffling is so that direct followup queries
889	# get handled first	2976	# get handled first
890	my $queue = delete $ns->{query_queue};	2977	my $queue = delete $ns->{query_queue}
		2978	or return; # be conservative, not sure how that can happen, but we saw a crash here
891		2979
892	(shift @$queue)->[1]->($msg);	2980	(shift @$queue)->[1]->($msg);
		2981	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
893		2982
894	push @{ $ns->{query_queue} }, @$queue;	2983	push @{ $ns->{query_queue} }, @$queue;
895		2984
896	if (@{ $ns->{query_queue} } == @$queue) {	2985	if (@{ $ns->{query_queue} } == @$queue) {
897	if (@$queue) {	2986	if (@$queue) {
898	$ns->send_packet ($ns->{query_queue}[0][0]);	2987	$ns->send_packet ($ns->{query_queue}[0][0]);
899	} else {	2988	} else {
900	$ns->state (ST_PLAYING);	2989	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
901	}	2990	}
902	}	2991	}
		2992	},
		2993	on_exticmd => sub {
		2994	my ($ns, $buf) = @_;
		2995
		2996	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2997
		2998	if (ref $msg) {
		2999	my ($type, $reply, @payload) =
		3000	"ARRAY" eq ref $msg
		3001	? @$msg
		3002	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		3003
		3004	my @reply;
		3005
		3006	if (my $cb = $EXTICMD{$type}) {
		3007	@reply = $cb->($ns, @payload);
		3008	}
		3009
		3010	$ns->ext_reply ($reply, @reply)
		3011	if $reply;
		3012
		3013	} else {
		3014	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		3015	}
		3016
		3017	cf::override;
		3018	},
		3019	);
		3020
		3021	=item $client->async (\&cb)
		3022
		3023	Create a new coroutine, running the specified callback. The coroutine will
		3024	be automatically cancelled when the client gets destroyed (e.g. on logout,
		3025	or loss of connection).
		3026
		3027	=cut
		3028
		3029	sub cf::client::async {
		3030	my ($self, $cb) = @_;
		3031
		3032	my $coro = &Coro::async ($cb);
		3033
		3034	$coro->on_destroy (sub {
		3035	delete $self->{_coro}{$coro+0};
		3036	});
		3037
		3038	$self->{_coro}{$coro+0} = $coro;
		3039
		3040	$coro
		3041	}
		3042
		3043	cf::client->attach (
		3044	on_destroy => sub {
		3045	my ($ns) = @_;
		3046
		3047	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
903	},	3048	},
904	);	3049	);
905		3050
906	=back	3051	=back
907		3052
…		…
919	our $safe = new Safe "safe";	3064	our $safe = new Safe "safe";
920	our $safe_hole = new Safe::Hole;	3065	our $safe_hole = new Safe::Hole;
921		3066
922	$SIG{FPE} = 'IGNORE';	3067	$SIG{FPE} = 'IGNORE';
923		3068
924	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3069	$safe->permit_only (Opcode::opset qw(
		3070	:base_core :base_mem :base_orig :base_math
		3071	grepstart grepwhile mapstart mapwhile
		3072	sort time
		3073	));
925		3074
926	# here we export the classes and methods available to script code	3075	# here we export the classes and methods available to script code
927		3076
928	=pod	3077	=pod
929		3078
930	The following fucntions and emthods are available within a safe environment:	3079	The following functions and methods are available within a safe environment:
931		3080
932	cf::object contr pay_amount pay_player map	3081	cf::object
		3082	contr pay_amount pay_player map x y force_find force_add destroy
		3083	insert remove name archname title slaying race decrease_ob_nr
		3084
933	cf::object::player player	3085	cf::object::player
934	cf::player peaceful	3086	player
935	cf::map trigger	3087
		3088	cf::player
		3089	peaceful
		3090
		3091	cf::map
		3092	trigger
936		3093
937	=cut	3094	=cut
938		3095
939	for (	3096	for (
940	["cf::object" => qw(contr pay_amount pay_player map)],	3097	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3098	insert remove inv name archname title slaying race
		3099	decrease_ob_nr destroy)],
941	["cf::object::player" => qw(player)],	3100	["cf::object::player" => qw(player)],
942	["cf::player" => qw(peaceful)],	3101	["cf::player" => qw(peaceful)],
943	["cf::map" => qw(trigger)],	3102	["cf::map" => qw(trigger)],
944	) {	3103	) {
945	no strict 'refs';	3104	no strict 'refs';
…		…
1016	=back	3175	=back
1017		3176
1018	=cut	3177	=cut
1019		3178
1020	#############################################################################	3179	#############################################################################
		3180	# the server's init and main functions
1021		3181
1022	=head2 EXTENSION DATABASE SUPPORT	3182	sub load_facedata($) {
		3183	my ($path) = @_;
1023		3184
1024	Crossfire maintains a very simple database for extension use. It can	3185	# HACK to clear player env face cache, we need some signal framework
1025	currently store anything that can be serialised using Storable, which	3186	# for this (global event?)
1026	excludes objects.	3187	%ext::player_env::MUSIC_FACE_CACHE = ();
1027		3188
1028	The parameter C<$family> should best start with the name of the extension	3189	my $enc = JSON::XS->new->utf8->canonical->relaxed;
1029	using it, it should be unique.
1030		3190
1031	=over 4	3191	warn "loading facedata from $path\n";
1032		3192
1033	=item $hashref = cf::db_get $family	3193	my $facedata;
		3194	0 < aio_load $path, $facedata
		3195	or die "$path: $!";
1034		3196
1035	Return a hashref for use by the extension C<$family>, which can be	3197	$facedata = Coro::Storable::thaw $facedata;
1036	modified. After modifications, you have to call C<cf::db_dirty> or
1037	C<cf::db_sync>.
1038		3198
1039	=item $value = cf::db_get $family => $key	3199	$facedata->{version} == 2
		3200	or cf::cleanup "$path: version mismatch, cannot proceed.";
1040		3201
1041	Returns a single value from the database	3202	# patch in the exptable
1042		3203	$facedata->{resource}{"res/exp_table"} = {
1043	=item cf::db_put $family => $hashref	3204	type => FT_RSRC,
1044		3205	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1045	Stores the given family hashref into the database. Updates are delayed, if
1046	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1047
1048	=item cf::db_put $family => $key => $value
1049
1050	Stores the given C<$value> in the family hash. Updates are delayed, if you
1051	want the data to be synced to disk immediately, use C<cf::db_sync>.
1052
1053	=item cf::db_dirty
1054
1055	Marks the database as dirty, to be updated at a later time.
1056
1057	=item cf::db_sync
1058
1059	Immediately write the database to disk I<if it is dirty>.
1060
1061	=cut
1062
1063	our $DB;
1064
1065	{
1066	my $path = cf::localdir . "/database.pst";
1067
1068	sub db_load() {
1069	warn "loading database $path\n";#d# remove later
1070	$DB = stat $path ? Storable::retrieve $path : { };
1071	}
1072
1073	my $pid;
1074
1075	sub db_save() {
1076	warn "saving database $path\n";#d# remove later
1077	waitpid $pid, 0 if $pid;
1078	if (0 == ($pid = fork)) {
1079	$DB->{_meta}{version} = 1;
1080	Storable::nstore $DB, "$path~";
1081	rename "$path~", $path;
1082	cf::_exit 0 if defined $pid;
1083	}
1084	}
1085
1086	my $dirty;
1087
1088	sub db_sync() {
1089	db_save if $dirty;
1090	undef $dirty;
1091	}
1092
1093	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1094	db_sync;
1095	});	3206	};
		3207	cf::cede_to_tick;
1096		3208
1097	sub db_dirty() {
1098	$dirty = 1;
1099	$idle->start;
1100	}	3209	{
		3210	my $faces = $facedata->{faceinfo};
1101		3211
1102	sub db_get($;$) {	3212	while (my ($face, $info) = each %$faces) {
1103	@_ >= 2	3213	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1104	? $DB->{$_[0]}{$_[1]}
1105	: ($DB->{$_[0]} ||= { })
1106	}
1107		3214
1108	sub db_put($$;$) {	3215	cf::face::set_visibility $idx, $info->{visibility};
1109	if (@_ >= 3) {	3216	cf::face::set_magicmap $idx, $info->{magicmap};
1110	$DB->{$_[0]}{$_[1]} = $_[2];	3217	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
1111	} else {	3218	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1112	$DB->{$_[0]} = $_[1];
1113	}
1114	db_dirty;
1115	}
1116		3219
1117	cf::global->attach (	3220	cf::cede_to_tick;
1118	prio => 10000,
1119	on_cleanup => sub {
1120	db_sync;
1121	},	3221	}
		3222
		3223	while (my ($face, $info) = each %$faces) {
		3224	next unless $info->{smooth};
		3225
		3226	my $idx = cf::face::find $face
		3227	or next;
		3228
		3229	if (my $smooth = cf::face::find $info->{smooth}) {
		3230	cf::face::set_smooth $idx, $smooth;
		3231	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3232	} else {
		3233	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3234	}
		3235
		3236	cf::cede_to_tick;
		3237	}
		3238	}
		3239
		3240	{
		3241	my $anims = $facedata->{animinfo};
		3242
		3243	while (my ($anim, $info) = each %$anims) {
		3244	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3245	cf::cede_to_tick;
		3246	}
		3247
		3248	cf::anim::invalidate_all; # d'oh
		3249	}
		3250
		3251	{
		3252	# TODO: for gcfclient pleasure, we should give resources
		3253	# that gcfclient doesn't grok a >10000 face index.
		3254	my $res = $facedata->{resource};
		3255
		3256	while (my ($name, $info) = each %$res) {
		3257	if (defined $info->{type}) {
		3258	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3259	my $data;
		3260
		3261	if ($info->{type} & 1) {
		3262	# prepend meta info
		3263
		3264	my $meta = $enc->encode ({
		3265	name => $name,
		3266	%{ $info->{meta} || {} },
		3267	});
		3268
		3269	$data = pack "(w/a*)*", $meta, $info->{data};
		3270	} else {
		3271	$data = $info->{data};
		3272	}
		3273
		3274	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3275	cf::face::set_type $idx, $info->{type};
		3276	} else {
		3277	$RESOURCE{$name} = $info;
		3278	}
		3279
		3280	cf::cede_to_tick;
		3281	}
		3282	}
		3283
		3284	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3285
		3286	1
		3287	}
		3288
		3289	cf::global->attach (on_resource_update => sub {
		3290	if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
		3291	$soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
		3292
		3293	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3294	my $sound = $soundconf->{compat}[$_]
		3295	or next;
		3296
		3297	my $face = cf::face::find "sound/$sound->[1]";
		3298	cf::sound::set $sound->[0] => $face;
		3299	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3300	}
		3301
		3302	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3303	my $face = cf::face::find "sound/$v";
		3304	cf::sound::set $k => $face;
		3305	}
		3306	}
		3307	});
		3308
		3309	register_exticmd fx_want => sub {
		3310	my ($ns, $want) = @_;
		3311
		3312	while (my ($k, $v) = each %$want) {
		3313	$ns->fx_want ($k, $v);
		3314	}
		3315	};
		3316
		3317	sub load_resource_file($) {
		3318	my $status = load_resource_file_ $_[0];
		3319	get_slot 0.1, 100;
		3320	cf::arch::commit_load;
		3321	$status
		3322	}
		3323
		3324	sub reload_regions {
		3325	# HACK to clear player env face cache, we need some signal framework
		3326	# for this (global event?)
		3327	%ext::player_env::MUSIC_FACE_CACHE = ();
		3328
		3329	load_resource_file "$MAPDIR/regions"
		3330	or die "unable to load regions file\n";
		3331
		3332	for (cf::region::list) {
		3333	$_->{match} = qr/$_->{match}/
		3334	if exists $_->{match};
		3335	}
		3336	}
		3337
		3338	sub reload_facedata {
		3339	load_facedata "$DATADIR/facedata"
		3340	or die "unable to load facedata\n";
		3341	}
		3342
		3343	sub reload_archetypes {
		3344	load_resource_file "$DATADIR/archetypes"
		3345	or die "unable to load archetypes\n";
		3346	}
		3347
		3348	sub reload_treasures {
		3349	load_resource_file "$DATADIR/treasures"
		3350	or die "unable to load treasurelists\n";
		3351	}
		3352
		3353	sub reload_resources {
		3354	warn "reloading resource files...\n";
		3355
		3356	reload_facedata;
		3357	reload_archetypes;
		3358	reload_regions;
		3359	reload_treasures;
		3360
		3361	warn "finished reloading resource files\n";
		3362	}
		3363
		3364	sub init {
		3365	my $guard = freeze_mainloop;
		3366
		3367	reload_resources;
		3368	}
		3369
		3370	sub reload_config {
		3371	open my $fh, "<:utf8", "$CONFDIR/config"
		3372	or return;
		3373
		3374	local $/;
		3375	*CFG = YAML::Load <$fh>;
		3376
		3377	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		3378
		3379	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		3380	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		3381
		3382	if (exists $CFG{mlockall}) {
		3383	eval {
		3384	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		3385	and die "WARNING: m(un)lockall failed: $!\n";
		3386	};
		3387	warn $@ if $@;
		3388	}
		3389	}
		3390
		3391	sub main {
		3392	# we must not ever block the main coroutine
		3393	local $Coro::idle = sub {
		3394	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		3395	(async {
		3396	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3397	EV::loop EV::LOOP_ONESHOT;
		3398	})->prio (Coro::PRIO_MAX);
1122	);	3399	};
		3400
		3401	{
		3402	my $guard = freeze_mainloop;
		3403	reload_config;
		3404	db_init;
		3405	load_extensions;
		3406
		3407	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3408	evthread_start IO::AIO::poll_fileno;
		3409	}
		3410
		3411	EV::loop;
1123	}	3412	}
1124		3413
1125	#############################################################################	3414	#############################################################################
1126	# the server's main()	3415	# initialisation and cleanup
1127		3416
1128	sub cfg_load {	3417	# install some emergency cleanup handlers
1129	open my $fh, "<:utf8", cf::confdir . "/config"	3418	BEGIN {
		3419	our %SIGWATCHER = ();
		3420	for my $signal (qw(INT HUP TERM)) {
		3421	$SIGWATCHER{$signal} = EV::signal $signal, sub {
		3422	cf::cleanup "SIG$signal";
		3423	};
		3424	}
		3425	}
		3426
		3427	sub write_runtime_sync {
		3428	my $runtime = "$LOCALDIR/runtime";
		3429
		3430	# first touch the runtime file to show we are still running:
		3431	# the fsync below can take a very very long time.
		3432
		3433	IO::AIO::aio_utime $runtime, undef, undef;
		3434
		3435	my $guard = cf::lock_acquire "write_runtime";
		3436
		3437	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
1130	or return;	3438	or return;
1131		3439
1132	local $/;	3440	my $value = $cf::RUNTIME + 90 + 10;
1133	*CFG = YAML::Syck::Load <$fh>;	3441	# 10 is the runtime save interval, for a monotonic clock
1134	}	3442	# 60 allows for the watchdog to kill the server.
1135		3443
1136	sub main {	3444	(aio_write $fh, 0, (length $value), $value, 0) <= 0
1137	cfg_load;	3445	and return;
1138	db_load;
1139	load_extensions;
1140	Event::loop;
1141	}
1142		3446
1143	#############################################################################	3447	# always fsync - this file is important
1144	# initialisation	3448	aio_fsync $fh
		3449	and return;
1145		3450
1146	sub _perl_reload(&) {	3451	# touch it again to show we are up-to-date
		3452	aio_utime $fh, undef, undef;
		3453
		3454	close $fh
		3455	or return;
		3456
		3457	aio_rename "$runtime~", $runtime
		3458	and return;
		3459
		3460	warn "runtime file written.\n";
		3461
		3462	1
		3463	}
		3464
		3465	our $uuid_lock;
		3466	our $uuid_skip;
		3467
		3468	sub write_uuid_sync($) {
		3469	$uuid_skip ||= $_[0];
		3470
		3471	return if $uuid_lock;
		3472	local $uuid_lock = 1;
		3473
		3474	my $uuid = "$LOCALDIR/uuid";
		3475
		3476	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3477	or return;
		3478
		3479	my $value = uuid_str $uuid_skip + uuid_seq uuid_cur;
		3480	$uuid_skip = 0;
		3481
		3482	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3483	and return;
		3484
		3485	# always fsync - this file is important
		3486	aio_fsync $fh
		3487	and return;
		3488
		3489	close $fh
		3490	or return;
		3491
		3492	aio_rename "$uuid~", $uuid
		3493	and return;
		3494
		3495	warn "uuid file written ($value).\n";
		3496
		3497	1
		3498
		3499	}
		3500
		3501	sub write_uuid($$) {
		3502	my ($skip, $sync) = @_;
		3503
		3504	$sync ? write_uuid_sync $skip
		3505	: async { write_uuid_sync $skip };
		3506	}
		3507
		3508	sub emergency_save() {
		3509	my $freeze_guard = cf::freeze_mainloop;
		3510
		3511	warn "enter emergency perl save\n";
		3512
		3513	cf::sync_job {
		3514	# use a peculiar iteration method to avoid tripping on perl
		3515	# refcount bugs in for. also avoids problems with players
		3516	# and maps saved/destroyed asynchronously.
		3517	warn "begin emergency player save\n";
		3518	for my $login (keys %cf::PLAYER) {
		3519	my $pl = $cf::PLAYER{$login} or next;
		3520	$pl->valid or next;
		3521	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
		3522	$pl->save;
		3523	}
		3524	warn "end emergency player save\n";
		3525
		3526	warn "begin emergency map save\n";
		3527	for my $path (keys %cf::MAP) {
		3528	my $map = $cf::MAP{$path} or next;
		3529	$map->valid or next;
		3530	$map->save;
		3531	}
		3532	warn "end emergency map save\n";
		3533
		3534	warn "begin emergency database checkpoint\n";
		3535	BDB::db_env_txn_checkpoint $DB_ENV;
		3536	warn "end emergency database checkpoint\n";
		3537
		3538	warn "begin write uuid\n";
		3539	write_uuid_sync 1;
		3540	warn "end write uuid\n";
		3541	};
		3542
		3543	warn "leave emergency perl save\n";
		3544	}
		3545
		3546	sub post_cleanup {
1147	my ($msg) = @_;	3547	my ($make_core) = @_;
1148		3548
1149	$msg->("reloading...");	3549	warn Carp::longmess "post_cleanup backtrace"
		3550	if $make_core;
		3551	}
1150		3552
1151	eval {	3553	sub do_reload_perl() {
1152	# cancel all watchers	3554	# can/must only be called in main
1153	for (Event::all_watchers) {	3555	if ($Coro::current != $Coro::main) {
1154	$_->cancel if $_->data & WF_AUTOCANCEL;	3556	warn "can only reload from main coroutine";
		3557	return;
		3558	}
		3559
		3560	warn "reloading...";
		3561
		3562	warn "entering sync_job";
		3563
		3564	cf::sync_job {
		3565	cf::write_runtime_sync; # external watchdog should not bark
		3566	cf::emergency_save;
		3567	cf::write_runtime_sync; # external watchdog should not bark
		3568
		3569	warn "syncing database to disk";
		3570	BDB::db_env_txn_checkpoint $DB_ENV;
		3571
		3572	# if anything goes wrong in here, we should simply crash as we already saved
		3573
		3574	warn "flushing outstanding aio requests";
		3575	for (;;) {
		3576	BDB::flush;
		3577	IO::AIO::flush;
		3578	Coro::cede_notself;
		3579	last unless IO::AIO::nreqs || BDB::nreqs;
		3580	warn "iterate...";
		3581	}
		3582
		3583	++$RELOAD;
		3584
		3585	warn "cancelling all extension coros";
		3586	$_->cancel for values %EXT_CORO;
		3587	%EXT_CORO = ();
		3588
		3589	warn "removing commands";
		3590	%COMMAND = ();
		3591
		3592	warn "removing ext/exti commands";
		3593	%EXTCMD = ();
		3594	%EXTICMD = ();
		3595
		3596	warn "unloading/nuking all extensions";
		3597	for my $pkg (@EXTS) {
		3598	warn "... unloading $pkg";
		3599
		3600	if (my $cb = $pkg->can ("unload")) {
		3601	eval {
		3602	$cb->($pkg);
		3603	1
		3604	} or warn "$pkg unloaded, but with errors: $@";
1155	}	3605	}
1156		3606
1157	# unload all extensions	3607	warn "... nuking $pkg";
1158	for (@exts) {	3608	Symbol::delete_package $pkg;
1159	$msg->("unloading <$_>");
1160	unload_extension $_;
1161	}	3609	}
1162		3610
1163	# unload all modules loaded from $LIBDIR	3611	warn "unloading all perl modules loaded from $LIBDIR";
1164	while (my ($k, $v) = each %INC) {	3612	while (my ($k, $v) = each %INC) {
1165	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3613	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1166		3614
1167	$msg->("removing <$k>");	3615	warn "... unloading $k";
1168	delete $INC{$k};	3616	delete $INC{$k};
1169		3617
1170	$k =~ s/\.pm$//;	3618	$k =~ s/\.pm$//;
1171	$k =~ s/\//::/g;	3619	$k =~ s/\//::/g;
1172		3620
…		…
1175	}	3623	}
1176		3624
1177	Symbol::delete_package $k;	3625	Symbol::delete_package $k;
1178	}	3626	}
1179		3627
1180	# sync database to disk
1181	cf::db_sync;
1182
1183	# get rid of safe::, as good as possible	3628	warn "getting rid of safe::, as good as possible";
1184	Symbol::delete_package "safe::$_"	3629	Symbol::delete_package "safe::$_"
1185	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	3630	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1186		3631
1187	# remove register_script_function callbacks
1188	# TODO
1189
1190	# unload cf.pm "a bit"	3632	warn "unloading cf.pm \"a bit\"";
1191	delete $INC{"cf.pm"};	3633	delete $INC{"cf.pm"};
		3634	delete $INC{"cf/pod.pm"};
1192		3635
1193	# don't, removes xs symbols, too,	3636	# don't, removes xs symbols, too,
1194	# and global variables created in xs	3637	# and global variables created in xs
1195	#Symbol::delete_package __PACKAGE__;	3638	#Symbol::delete_package __PACKAGE__;
1196		3639
1197	# reload cf.pm	3640	warn "unload completed, starting to reload now";
		3641
1198	$msg->("reloading cf.pm");	3642	warn "reloading cf.pm";
1199	require cf;	3643	require cf;
		3644	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1200		3645
1201	# load config and database again	3646	warn "loading config and database again";
1202	cf::cfg_load;	3647	cf::reload_config;
1203	cf::db_load;
1204		3648
1205	# load extensions	3649	warn "loading extensions";
1206	$msg->("load extensions");
1207	cf::load_extensions;	3650	cf::load_extensions;
1208		3651
1209	# reattach attachments to objects	3652	warn "reattaching attachments to objects/players";
1210	$msg->("reattach");	3653	_global_reattach; # objects, sockets
1211	_global_reattach;	3654	warn "reattaching attachments to maps";
		3655	reattach $_ for values %MAP;
		3656	warn "reattaching attachments to players";
		3657	reattach $_ for values %PLAYER;
		3658
		3659	warn "leaving sync_job";
		3660
		3661	1
		3662	} or do {
		3663	warn $@;
		3664	cf::cleanup "error while reloading, exiting.";
1212	};	3665	};
1213	$msg->($@) if $@;
1214		3666
1215	$msg->("reloaded");	3667	warn "reloaded";
1216	};	3668	};
1217		3669
1218	sub perl_reload() {	3670	our $RELOAD_WATCHER; # used only during reload
1219	_perl_reload {	3671
1220	warn $_[0];	3672	sub reload_perl() {
1221	print "$_[0]\n";	3673	# doing reload synchronously and two reloads happen back-to-back,
		3674	# coro crashes during coro_state_free->destroy here.
		3675
		3676	$RELOAD_WATCHER ||= EV::timer 0, 0, sub {
		3677	do_reload_perl;
		3678	undef $RELOAD_WATCHER;
1222	};	3679	};
1223	}	3680	}
1224		3681
1225	register "<global>", __PACKAGE__;
1226
1227	register_command "perl-reload" => sub {	3682	register_command "reload" => sub {
1228	my ($who, $arg) = @_;	3683	my ($who, $arg) = @_;
1229		3684
1230	if ($who->flag (FLAG_WIZ)) {	3685	if ($who->flag (FLAG_WIZ)) {
1231	_perl_reload {	3686	$who->message ("reloading server.");
1232	warn $_[0];	3687	async {
1233	$who->message ($_[0]);	3688	$Coro::current->{desc} = "perl_reload";
		3689	reload_perl;
1234	};	3690	};
1235	}	3691	}
1236	};	3692	};
1237		3693
1238	unshift @INC, $LIBDIR;	3694	unshift @INC, $LIBDIR;
1239		3695
1240	$TICK_WATCHER = Event->timer (	3696	my $bug_warning = 0;
1241	prio => 0,	3697
1242	at => $NEXT_TICK || 1,	3698	our @WAIT_FOR_TICK;
1243	data => WF_AUTOCANCEL,	3699	our @WAIT_FOR_TICK_BEGIN;
1244	cb => sub {	3700
		3701	sub wait_for_tick {
		3702	return if tick_inhibit || $Coro::current == $Coro::main;
		3703
		3704	my $signal = new Coro::Signal;
		3705	push @WAIT_FOR_TICK, $signal;
		3706	$signal->wait;
		3707	}
		3708
		3709	sub wait_for_tick_begin {
		3710	return if tick_inhibit || $Coro::current == $Coro::main;
		3711
		3712	my $signal = new Coro::Signal;
		3713	push @WAIT_FOR_TICK_BEGIN, $signal;
		3714	$signal->wait;
		3715	}
		3716
		3717	sub tick {
		3718	if ($Coro::current != $Coro::main) {
		3719	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3720	unless ++$bug_warning > 10;
		3721	return;
		3722	}
		3723
1245	cf::server_tick; # one server iteration	3724	cf::server_tick; # one server iteration
1246		3725
1247	my $NOW = Event::time;	3726	if ($NOW >= $NEXT_RUNTIME_WRITE) {
1248	$NEXT_TICK += $TICK;	3727	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
1249		3728	Coro::async_pool {
1250	# if we are delayed by four ticks or more, skip them all	3729	$Coro::current->{desc} = "runtime saver";
1251	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	3730	write_runtime_sync
1252		3731	or warn "ERROR: unable to write runtime file: $!";
1253	$TICK_WATCHER->at ($NEXT_TICK);	3732	};
1254	$TICK_WATCHER->start;
1255	},	3733	}
1256	);
1257		3734
		3735	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3736	$sig->send;
		3737	}
		3738	while (my $sig = shift @WAIT_FOR_TICK) {
		3739	$sig->send;
		3740	}
		3741
		3742	$LOAD = ($NOW - $TICK_START) / $TICK;
		3743	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3744
		3745	if (0) {
		3746	if ($NEXT_TICK) {
		3747	my $jitter = $TICK_START - $NEXT_TICK;
		3748	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		3749	warn "jitter $JITTER\n";#d#
		3750	}
		3751	}
		3752	}
		3753
		3754	{
		3755	# configure BDB
		3756
		3757	BDB::min_parallel 8;
		3758	BDB::max_poll_reqs $TICK * 0.1;
		3759	$Coro::BDB::WATCHER->priority (1);
		3760
		3761	unless ($DB_ENV) {
		3762	$DB_ENV = BDB::db_env_create;
		3763	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
		3764	| BDB::LOG_AUTOREMOVE, 1);
		3765	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3766	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3767
		3768	cf::sync_job {
		3769	eval {
		3770	BDB::db_env_open
		3771	$DB_ENV,
		3772	$BDBDIR,
		3773	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3774	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3775	0666;
		3776
		3777	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3778	};
		3779
		3780	cf::cleanup "db_env_open(db): $@" if $@;
		3781	};
		3782	}
		3783
		3784	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3785	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3786	};
		3787	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		3788	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3789	};
		3790	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3791	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3792	};
		3793	}
		3794
		3795	{
		3796	# configure IO::AIO
		3797
		3798	IO::AIO::min_parallel 8;
1258	IO::AIO::max_poll_time $TICK * 0.2;	3799	IO::AIO::max_poll_time $TICK * 0.1;
		3800	$Coro::AIO::WATCHER->priority (1);
		3801	}
1259		3802
1260	Event->io (fd => IO::AIO::poll_fileno,	3803	my $_log_backtrace;
1261	poll => 'r',	3804
1262	prio => 5,	3805	sub _log_backtrace {
1263	data => WF_AUTOCANCEL,	3806	my ($msg, @addr) = @_;
1264	cb => \&IO::AIO::poll_cb);	3807
		3808	$msg =~ s/\n//;
		3809
		3810	# limit the # of concurrent backtraces
		3811	if ($_log_backtrace < 2) {
		3812	++$_log_backtrace;
		3813	async {
		3814	$Coro::current->{desc} = "abt $msg";
		3815
		3816	my @bt = fork_call {
		3817	@addr = map { sprintf "%x", $_ } @addr;
		3818	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3819	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3820	or die "addr2line: $!";
		3821
		3822	my @funcs;
		3823	my @res = <$fh>;
		3824	chomp for @res;
		3825	while (@res) {
		3826	my ($func, $line) = splice @res, 0, 2, ();
		3827	push @funcs, "[$func] $line";
		3828	}
		3829
		3830	@funcs
		3831	};
		3832
		3833	LOG llevInfo, "[ABT] $msg\n";
		3834	LOG llevInfo, "[ABT] $_\n" for @bt;
		3835	--$_log_backtrace;
		3836	};
		3837	} else {
		3838	LOG llevInfo, "[ABT] $msg\n";
		3839	LOG llevInfo, "[ABT] [suppressed]\n";
		3840	}
		3841	}
		3842
		3843	# load additional modules
		3844	use cf::pod;
		3845
		3846	END { cf::emergency_save }
1265		3847
1266	1	3848	1
1267		3849

Diff Legend

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