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

Diff Legend

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