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

Diff Legend

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