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.108 by root, Sun Dec 31 21:02:05 2006 UTC vs.
Revision 1.507 by root, Sat Mar 20 02:24:38 2010 UTC

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

Diff Legend

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