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

Diff Legend

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