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

Diff Legend

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