ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.107 by root, Sun Dec 31 18:10:40 2006 UTC vs.
Revision 1.544 by root, Thu May 6 21:58:07 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
3	use utf8;	25	use common::sense;
4	use strict;
5		26
6	use Symbol;	27	use Symbol;
7	use List::Util;	28	use List::Util;
8	use Storable;	29	use Socket;
		30	use EV;
9	use Opcode;	31	use Opcode;
10	use Safe;	32	use Safe;
11	use Safe::Hole;	33	use Safe::Hole;
		34	use Storable ();
		35	use Carp ();
12		36
		37	use Guard ();
13	use Coro 3.3;	38	use Coro ();
		39	use Coro::State;
		40	use Coro::Handle;
		41	use Coro::EV;
14	use Coro::Event;	42	use Coro::AnyEvent;
15	use Coro::Timer;	43	use Coro::Timer;
16	use Coro::Signal;	44	use Coro::Signal;
17	use Coro::Semaphore;	45	use Coro::Semaphore;
		46	use Coro::SemaphoreSet;
		47	use Coro::AnyEvent;
18	use Coro::AIO;	48	use Coro::AIO;
		49	use Coro::BDB 1.6;
		50	use Coro::Storable;
		51	use Coro::Util ();
19		52
		53	use JSON::XS 2.01 ();
		54	use BDB ();
		55	use Data::Dumper;
20	use Fcntl;	56	use Fcntl;
21	use IO::AIO 2.31 ();
22	use YAML::Syck ();	57	use YAML::XS ();
		58	use IO::AIO ();
23	use Time::HiRes;	59	use Time::HiRes;
		60	use Compress::LZF;
		61	use Digest::MD5 ();
24		62
25	use Event; $Event::Eval = 1; # no idea why this is required, but it is	63	AnyEvent::detect;
26		64
27	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	65	# configure various modules to our taste
28	$YAML::Syck::ImplicitUnicode = 1;	66	#
		67	$Storable::canonical = 1; # reduce rsync transfers
		68	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
29		69
30	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority	70	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
		71
		72	# make sure c-lzf reinitialises itself
		73	Compress::LZF::set_serializer "Storable", "Storable::net_mstore", "Storable::mretrieve";
		74	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		75
		76	# strictly for debugging
		77	$SIG{QUIT} = sub { Carp::cluck "SIGQUIT" };
31		78
32	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	79	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		80
		81	our @ORIG_INC;
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 incloader);
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	353
176	JSON::Syck::Dump $_[0]	354	sub encode_json($) { $json_coder->encode ($_[0]) }
		355	sub decode_json($) { $json_coder->decode ($_[0]) }
		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;
177	}	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 }
178		505
179	=item cf::sync_job { BLOCK }	506	=item cf::sync_job { BLOCK }
180		507
181	The design of crossfire+ requires that the main coro ($Coro::main) is	508	The design of Deliantra requires that the main coroutine ($Coro::main)
182	always able to handle events or runnable, as crossfire+ is only partly	509	is always able to handle events or runnable, as Deliantra is only
183	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	510	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		511	acceptable.
184		512
185	If it must be done, put the blocking parts into C<sync_job>. This will run	513	If it must be done, put the blocking parts into C<sync_job>. This will run
186	the given BLOCK in another coroutine while waiting for the result. The	514	the given BLOCK in another coroutine while waiting for the result. The
187	server will be frozen during this time, so the block should either finish	515	server will be frozen during this time, so the block should either finish
188	fast or be very important.	516	fast or be very important.
…		…
190	=cut	518	=cut
191		519
192	sub sync_job(&) {	520	sub sync_job(&) {
193	my ($job) = @_;	521	my ($job) = @_;
194		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
195	my $busy = 1;	533	my $busy = 1;
196	my @res;	534	my @res;
197		535
198	# TODO: use suspend/resume instead	536	(async {
199	local $FREEZE = 1;	537	$Coro::current->desc ("sync job coro");
200
201	my $coro = Coro::async {
202	@res = eval { $job->() };	538	@res = eval { $job->() };
203	warn $@ if $@;	539	error $@ if $@;
204	undef $busy;	540	undef $busy;
205	};
206
207	if ($Coro::current == $Coro::main) {
208	$coro->prio (Coro::PRIO_MAX);	541	})->prio (Coro::PRIO_MAX);
		542
209	while ($busy) {	543	while ($busy) {
		544	if (Coro::nready) {
210	Coro::cede_notself;	545	Coro::cede_notself;
211	Event::one_event unless Coro::nready;	546	} else {
		547	EV::loop EV::LOOP_ONESHOT;
212	}	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]
213	} else {	556	} else {
214	$coro->join;	557	# we are in another coroutine, how wonderful, everything just works
		558
		559	$job->()
215	}	560	}
216
217	wantarray ? @res : $res[0]
218	}	561	}
219		562
220	=item $coro = cf::coro { BLOCK }	563	=item $coro = cf::async_ext { BLOCK }
221		564
222	Creates and returns a new coro. This coro is automcatially being canceled	565	Like async, but this coro is automatically being canceled when the
223	when the extension calling this is being unloaded.	566	extension calling this is being unloaded.
224		567
225	=cut	568	=cut
226		569
227	sub coro(&) {	570	sub async_ext(&) {
228	my $cb = shift;	571	my $cb = shift;
229		572
230	my $coro; $coro = async {	573	my $coro = &Coro::async ($cb);
231	eval {
232	$cb->();
233	};
234	warn $@ if $@;
235	};
236		574
237	$coro->on_destroy (sub {	575	$coro->on_destroy (sub {
238	delete $EXT_CORO{$coro+0};	576	delete $EXT_CORO{$coro+0};
239	});	577	});
240	$EXT_CORO{$coro+0} = $coro;	578	$EXT_CORO{$coro+0} = $coro;
241		579
242	$coro	580	$coro
243	}	581	}
244		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
245	=back	785	=back
246		786
247	=cut	787	=cut
248		788
249	#############################################################################	789	#############################################################################
250		790
251	=head2 ATTACHABLE OBJECTS	791	=head2 ATTACHABLE OBJECTS
252		792
253	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
254	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")
255	to it. All such attachable objects support the following methods.	795	to it. All such attachable objects support the following methods.
256		796
257	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>
258	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
259	crossfire+).	799	Deliantra).
260		800
261	=over 4	801	=over 4
262		802
263	=item $attachable->attach ($attachment, key => $value...)	803	=item $attachable->attach ($attachment, key => $value...)
264		804
…		…
308	=item cf::CLASS::attachment $name, ...	848	=item cf::CLASS::attachment $name, ...
309		849
310	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
311	given CLASS can refer to this attachment.	851	given CLASS can refer to this attachment.
312		852
313	Some classes such as crossfire maps and objects can specify attachments	853	Some classes such as deliantra maps and objects can specify attachments
314	that are attached at load/instantiate time, thus the need for a name.	854	that are attached at load/instantiate time, thus the need for a name.
315		855
316	These calls expect any number of the following handler/hook descriptions:	856	These calls expect any number of the following handler/hook descriptions:
317		857
318	=over 4	858	=over 4
…		…
378	our @CB_TYPE = (); # registry for type (cf-object class) based events	918	our @CB_TYPE = (); # registry for type (cf-object class) based events
379	our @CB_MAP = ();	919	our @CB_MAP = ();
380		920
381	my %attachment;	921	my %attachment;
382		922
		923	sub cf::attachable::thawer_merge {
		924	# simply override everything except _meta
		925	local $_[0]{_meta};
		926	%{$_[0]} = %{$_[1]};
		927	}
		928
383	sub _attach_cb($$$$) {	929	sub _attach_cb($$$$) {
384	my ($registry, $event, $prio, $cb) = @_;	930	my ($registry, $event, $prio, $cb) = @_;
385		931
386	use sort 'stable';	932	use sort 'stable';
387		933
…		…
421	$registry = $CB_TYPE[$object_type] ||= [];	967	$registry = $CB_TYPE[$object_type] ||= [];
422		968
423	} elsif ($type eq "subtype") {	969	} elsif ($type eq "subtype") {
424	defined $object_type or Carp::croak "subtype specified without type";	970	defined $object_type or Carp::croak "subtype specified without type";
425	my $object_subtype = shift @arg;	971	my $object_subtype = shift @arg;
426	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	972	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
427		973
428	} elsif ($type eq "package") {	974	} elsif ($type eq "package") {
429	my $pkg = shift @arg;	975	my $pkg = shift @arg;
430		976
431	while (my ($name, $id) = each %cb_id) {	977	while (my ($name, $id) = each %cb_id) {
…		…
436		982
437	} elsif (exists $cb_id{$type}) {	983	} elsif (exists $cb_id{$type}) {
438	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;	984	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
439		985
440	} elsif (ref $type) {	986	} elsif (ref $type) {
441	warn "attaching objects not supported, ignoring.\n";	987	error "attaching objects not supported, ignoring.\n";
442		988
443	} else {	989	} else {
444	shift @arg;	990	shift @arg;
445	warn "attach argument '$type' not supported, ignoring.\n";	991	error "attach argument '$type' not supported, ignoring.\n";
446	}	992	}
447	}	993	}
448	}	994	}
449		995
450	sub _object_attach {	996	sub _object_attach {
…		…
460	_attach $registry, $klass, @attach;	1006	_attach $registry, $klass, @attach;
461	}	1007	}
462		1008
463	$obj->{$name} = \%arg;	1009	$obj->{$name} = \%arg;
464	} else {	1010	} else {
465	warn "object uses attachment '$name' that is not available, postponing.\n";	1011	info "object uses attachment '$name' which is not available, postponing.\n";
466	}	1012	}
467		1013
468	$obj->{_attachment}{$name} = undef;	1014	$obj->{_attachment}{$name} = undef;
469	}	1015	}
470		1016
…		…
472	if (ref $_[0]) {	1018	if (ref $_[0]) {
473	_object_attach @_;	1019	_object_attach @_;
474	} else {	1020	} else {
475	_attach shift->_attach_registry, @_;	1021	_attach shift->_attach_registry, @_;
476	}	1022	}
		1023	_recalc_want;
477	};	1024	};
478		1025
479	# all those should be optimised	1026	# all those should be optimised
480	sub cf::attachable::detach {	1027	sub cf::attachable::detach {
481	my ($obj, $name) = @_;	1028	my ($obj, $name) = @_;
…		…
484	delete $obj->{_attachment}{$name};	1031	delete $obj->{_attachment}{$name};
485	reattach ($obj);	1032	reattach ($obj);
486	} else {	1033	} else {
487	Carp::croak "cannot, currently, detach class attachments";	1034	Carp::croak "cannot, currently, detach class attachments";
488	}	1035	}
		1036	_recalc_want;
489	};	1037	};
490		1038
491	sub cf::attachable::attached {	1039	sub cf::attachable::attached {
492	my ($obj, $name) = @_;	1040	my ($obj, $name) = @_;
493		1041
…		…
508	";	1056	";
509	die if $@;	1057	die if $@;
510	}	1058	}
511		1059
512	our $override;	1060	our $override;
513	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?
514		1062
515	sub override {	1063	sub override {
516	$override = 1;	1064	$override = 1;
517	@invoke_results = ();	1065	@INVOKE_RESULTS = (@_);
518	}	1066	}
519		1067
520	sub do_invoke {	1068	sub do_invoke {
521	my $event = shift;	1069	my $event = shift;
522	my $callbacks = shift;	1070	my $callbacks = shift;
523		1071
524	@invoke_results = ();	1072	@INVOKE_RESULTS = ();
525		1073
526	local $override;	1074	local $override;
527		1075
528	for (@$callbacks) {	1076	for (@$callbacks) {
529	eval { &{$_->[1]} };	1077	eval { &{$_->[1]} };
530		1078
531	if ($@) {	1079	if ($@) {
532	warn "$@";
533	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";	1080	error "$@", "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
534	override;	1081	override;
535	}	1082	}
536		1083
537	return 1 if $override;	1084	return 1 if $override;
538	}	1085	}
539		1086
540	0	1087	0
541	}	1088	}
542		1089
543	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1090	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
544		1091
545	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1092	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
546		1093
547	Generate an object-specific event with the given arguments.	1094	Generate an object-specific event with the given arguments.
548		1095
549	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
550	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
551	results (if you must, access C<@cf::invoke_results> directly).	1098	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
552		1099
553	=back	1100	=back
554		1101
555	=cut	1102	=cut
556		1103
557	#############################################################################	1104	#############################################################################
558	# 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	}
559		1148
560	sub reattach {	1149	sub reattach {
561	# basically do the same as instantiate, without calling instantiate	1150	# basically do the same as instantiate, without calling instantiate
562	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
563		1155
564	my $registry = $obj->registry;	1156	my $registry = $obj->registry;
565		1157
566	@$registry = ();	1158	@$registry = ();
567		1159
…		…
572	for (@$attach) {	1164	for (@$attach) {
573	my ($klass, @attach) = @$_;	1165	my ($klass, @attach) = @$_;
574	_attach $registry, $klass, @attach;	1166	_attach $registry, $klass, @attach;
575	}	1167	}
576	} else {	1168	} else {
577	warn "object uses attachment '$name' that is not available, postponing.\n";	1169	info "object uses attachment '$name' that is not available, postponing.\n";
578	}	1170	}
579	}	1171	}
580	}	1172	}
581		1173
582	cf::attachable->attach (	1174	cf::attachable->attach (
583	prio => -1000000,	1175	prio => -1000000,
584	on_instantiate => sub {	1176	on_instantiate => sub {
585	my ($obj, $data) = @_;	1177	my ($obj, $data) = @_;
586		1178
587	$data = from_json $data;	1179	$data = decode_json $data;
588		1180
589	for (@$data) {	1181	for (@$data) {
590	my ($name, $args) = @$_;	1182	my ($name, $args) = @$_;
591		1183
592	$obj->attach ($name, %{$args || {} });	1184	$obj->attach ($name, %{$args || {} });
…		…
608	sub object_freezer_save {	1200	sub object_freezer_save {
609	my ($filename, $rdata, $objs) = @_;	1201	my ($filename, $rdata, $objs) = @_;
610		1202
611	sync_job {	1203	sync_job {
612	if (length $$rdata) {	1204	if (length $$rdata) {
		1205	utf8::decode (my $decname = $filename);
613	warn sprintf "saving %s (%d,%d)\n",	1206	trace sprintf "saving %s (%d,%d)\n",
614	$filename, length $$rdata, scalar @$objs;	1207	$decname, length $$rdata, scalar @$objs
		1208	if $VERBOSE_IO;
615		1209
616	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1210	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
617	chmod SAVE_MODE, $fh;	1211	aio_chmod $fh, SAVE_MODE;
618	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;
619	aio_fsync $fh;	1215	aio_fsync $fh;
		1216	}
620	close $fh;	1217	aio_close $fh;
621		1218
622	if (@$objs) {	1219	if (@$objs) {
623	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) {
624	chmod SAVE_MODE, $fh;	1221	aio_chmod $fh, SAVE_MODE;
625	my $data = Storable::nfreeze { version => 1, objs => $objs };	1222	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
626	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;
627	aio_fsync $fh;	1226	aio_fsync $fh;
		1227	}
628	close $fh;	1228	aio_close $fh;
629	aio_rename "$filename.pst~", "$filename.pst";	1229	aio_rename "$filename.pst~", "$filename.pst";
630	}	1230	}
631	} else {	1231	} else {
632	aio_unlink "$filename.pst";	1232	aio_unlink "$filename.pst";
633	}	1233	}
634		1234
635	aio_rename "$filename~", $filename;	1235	aio_rename "$filename~", $filename;
		1236
		1237	$filename =~ s%/[^/]+$%%;
		1238	aio_pathsync $filename if $cf::USE_FSYNC;
636	} else {	1239	} else {
637	warn "FATAL: $filename~: $!\n";	1240	error "unable to save objects: $filename~: $!\n";
638	}	1241	}
639	} else {	1242	} else {
640	aio_unlink $filename;	1243	aio_unlink $filename;
641	aio_unlink "$filename.pst";	1244	aio_unlink "$filename.pst";
642	}	1245	}
643	}	1246	};
644	}	1247	}
645		1248
646	sub object_freezer_as_string {	1249	sub object_freezer_as_string {
647	my ($rdata, $objs) = @_;	1250	my ($rdata, $objs) = @_;
648		1251
…		…
660	or return;	1263	or return;
661		1264
662	unless (aio_stat "$filename.pst") {	1265	unless (aio_stat "$filename.pst") {
663	(aio_load "$filename.pst", $av) >= 0	1266	(aio_load "$filename.pst", $av) >= 0
664	or return;	1267	or return;
		1268
665	$av = eval { (Storable::thaw <$av>)->{objs} };	1269	my $st = eval { Coro::Storable::thaw $av };
		1270	$av = $st->{objs};
666	}	1271	}
667		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
668	return ($data, $av);	1278	($data, $av)
669	}	1279	}
		1280
		1281	=head2 COMMAND CALLBACKS
		1282
		1283	=over 4
		1284
		1285	=cut
670		1286
671	#############################################################################	1287	#############################################################################
672	# command handling &c	1288	# command handling &c
673		1289
674	=item cf::register_command $name => \&callback($ob,$args);	1290	=item cf::register_command $name => \&callback($ob,$args);
…		…
687	push @{ $COMMAND{$name} }, [$caller, $cb];	1303	push @{ $COMMAND{$name} }, [$caller, $cb];
688	}	1304	}
689		1305
690	=item cf::register_extcmd $name => \&callback($pl,$packet);	1306	=item cf::register_extcmd $name => \&callback($pl,$packet);
691		1307
692	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.
693		1313
694	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
695	called.	1315	called.
696		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
697	=cut	1328	=cut
698		1329
699	sub register_extcmd {	1330	sub register_extcmd {
700	my ($name, $cb) = @_;	1331	my ($name, $cb) = @_;
701		1332
702	my $caller = caller;
703	#warn "registering extcmd '$name' to '$caller'";
704
705	$EXTCMD{$name} = [$cb, $caller];	1333	$EXTCMD{$name} = $cb;
706	}	1334	}
		1335
		1336	sub register_exticmd {
		1337	my ($name, $cb) = @_;
		1338
		1339	$EXTICMD{$name} = $cb;
		1340	}
		1341
		1342	use File::Glob ();
707		1343
708	cf::player->attach (	1344	cf::player->attach (
709	on_command => sub {	1345	on_unknown_command => sub {
710	my ($pl, $name, $params) = @_;	1346	my ($pl, $name, $params) = @_;
711		1347
712	my $cb = $COMMAND{$name}	1348	my $cb = $COMMAND{$name}
713	or return;	1349	or return;
714		1350
…		…
719	cf::override;	1355	cf::override;
720	},	1356	},
721	on_extcmd => sub {	1357	on_extcmd => sub {
722	my ($pl, $buf) = @_;	1358	my ($pl, $buf) = @_;
723		1359
724	my $msg = eval { from_json $buf };	1360	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
725		1361
726	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
727	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1370	if (my $cb = $EXTCMD{$type}) {
728	if (my %reply = $cb->[0]->($pl, $msg)) {	1371	@reply = $cb->($pl, @payload);
729	$pl->ext_reply ($msg->{msgid}, %reply);
730	}
731	}	1372	}
		1373
		1374	$pl->ext_reply ($reply, @reply)
		1375	if $reply;
		1376
732	} else {	1377	} else {
733	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1378	error "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
734	}	1379	}
735		1380
736	cf::override;	1381	cf::override;
737	},	1382	},
738	);	1383	);
739		1384
740	sub register {	1385	# "readahead" all extensions
741	my ($base, $pkg) = @_;
742
743	#TODO
744	}
745
746	sub load_extension {	1386	sub cache_extensions {
747	my ($path) = @_;	1387	my $grp = IO::AIO::aio_group;
748		1388
749	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1389	add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
750	my $base = $1;	1390	for (grep /\.ext$/, @{$_[0]}) {
751	my $pkg = $1;	1391	add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
752	$pkg =~ s/[^[:word:]]/_/g;
753	$pkg = "ext::$pkg";
754
755	warn "loading '$path' into '$pkg'\n";
756
757	open my $fh, "<:utf8", $path
758	or die "$path: $!";
759
760	my $source =
761	"package $pkg; use strict; use utf8;\n"
762	. "#line 1 \"$path\"\n{\n"
763	. (do { local $/; <$fh> })
764	. "\n};\n1";
765
766	eval $source
767	or die $@ ? "$path: $@\n"
768	: "extension disabled.\n";
769
770	push @exts, $pkg;
771	$ext_pkg{$base} = $pkg;
772
773	# no strict 'refs';
774	# @{"$pkg\::ISA"} = ext::;
775
776	register $base, $pkg;
777	}
778
779	sub unload_extension {
780	my ($pkg) = @_;
781
782	warn "removing extension $pkg\n";
783
784	# remove hooks
785	#TODO
786	# for my $idx (0 .. $#PLUGIN_EVENT) {
787	# delete $hook[$idx]{$pkg};
788	# }
789
790	# remove commands
791	for my $name (keys %COMMAND) {
792	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
793
794	if (@cb) {
795	$COMMAND{$name} = \@cb;
796	} else {
797	delete $COMMAND{$name};
798	}	1392	}
799	}	1393	};
800		1394
801	# remove extcmds	1395	$grp
802	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
803	delete $EXTCMD{$name};
804	}
805
806	if (my $cb = $pkg->can ("unload")) {
807	eval {
808	$cb->($pkg);
809	1
810	} or warn "$pkg unloaded, but with errors: $@";
811	}
812
813	Symbol::delete_package $pkg;
814	}	1396	}
815		1397
816	sub load_extensions {	1398	sub load_extensions {
		1399	info "loading extensions...";
		1400
		1401	cf::sync_job {
		1402	my %todo;
		1403
817	for my $ext (<$LIBDIR/*.ext>) {	1404	for my $path (<$LIBDIR/*.ext>) {
818	next unless -r $ext;	1405	next unless -r $path;
819	eval {	1406
820	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 common::sense;\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	}
821	1	1470	}
822	} 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	}
823	}	1481	};
824	}	1482	}
825		1483
826	#############################################################################	1484	#############################################################################
827	# load/save/clean perl data associated with a map
828		1485
829	*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($) {
830	my ($map) = @_;	1540	my ($login) = @_;
831		1541
832	my $path = $map->tmpname;	1542	$cf::PLAYER{$login}
833	defined $path or return;	1543	or !aio_stat path $login
834
835	unlink "$path.pst";
836	};
837
838	cf::map->attach (prio => -10000, package => cf::mapsupport::);
839
840	#############################################################################
841	# load/save perl data associated with player->ob objects
842
843	sub all_objects(@) {
844	@_, map all_objects ($_->inv), @_
845	}	1544	}
846		1545
847	# 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
848	cf::player->attach (	1573	cf::player->attach (
849	on_load => sub {	1574	on_load => sub {
850	my ($pl, $path) = @_;	1575	my ($pl, $path) = @_;
851		1576
852	for my $o (all_objects $pl->ob) {	1577	# restore slots saved in save, below
853	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1578	my $slots = delete $pl->{_slots};
854	$o->set_ob_key_value ("_perl_data");
855		1579
856	%$o = %{ Storable::thaw pack "H*", $value };	1580	$pl->ob->current_weapon ($slots->[0]);
857	}	1581	$pl->combat_ob ($slots->[1]);
858	}	1582	$pl->ranged_ob ($slots->[2]);
859	},	1583	},
860	);	1584	);
861		1585
862	#############################################################################	1586	sub save($) {
		1587	my ($pl) = @_;
863		1588
864	=head2 CORE EXTENSIONS	1589	return if $pl->{deny_save};
865		1590
866	Functions and methods that extend core crossfire objects.	1591	my $path = path $pl;
		1592	my $guard = cf::lock_acquire "user_save:$path";
867		1593
868	=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
869		1770
870	=over 4	1771	=over 4
871		1772
872	=item cf::player::exists $login
873
874	Returns true when the given account exists.
875
876	=cut	1773	=cut
877		1774
878	sub cf::player::exists($) {	1775	package cf::region;
879	cf::player::find $_[0]
880	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
881	}
882		1776
883	=item $player->ext_reply ($msgid, $msgtype, %msg)	1777	=item cf::region::find_by_path $path
884		1778
885	Sends an ext reply to the player.	1779	Tries to decuce the likely region for a map knowing only its path.
886		1780
887	=cut	1781	=cut
888		1782
889	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	push @{"$pkg\::ISA"}, __PACKAGE__;
		1854
		1855	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1856	}
		1857
		1858	# also paths starting with '/'
		1859	$EXT_MAP{"cf::map::wrap"} = [0, qr{^(?=/)}];
		1860
		1861	sub thawer_merge {
890	my ($self, $id, %msg) = @_;	1862	my ($self, $merge) = @_;
891		1863
892	$msg{msgid} = $id;	1864	# we have to keep some variables in memory intact
		1865	local $self->{path};
		1866	local $self->{load_path};
893		1867
894	$self->send ("ext " . to_json \%msg);	1868	$self->SUPER::thawer_merge ($merge);
895	}	1869	}
		1870
		1871	sub normalise {
		1872	my ($path, $base) = @_;
		1873
		1874	$path = "$path"; # make sure it's a string
		1875
		1876	$path =~ s/\.map$//;
		1877
		1878	# map plan:
		1879	#
		1880	# /! non-realised random map exit (special hack!)
		1881	# {... are special paths that are not being touched
		1882	# ?xxx/... are special absolute paths
		1883	# ?random/... random maps
		1884	# /... normal maps
		1885	# ~user/... per-player map of a specific user
		1886
		1887	$path =~ s/$PATH_SEP/\//go;
		1888
		1889	# treat it as relative path if it starts with
		1890	# something that looks reasonable
		1891	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1892	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1893
		1894	$base =~ s{[^/]+/?$}{};
		1895	$path = "$base/$path";
		1896	}
		1897
		1898	for ($path) {
		1899	redo if s{//}{/};
		1900	redo if s{/\.?/}{/};
		1901	redo if s{/[^/]+/\.\./}{/};
		1902	}
		1903
		1904	$path
		1905	}
		1906
		1907	sub new_from_path {
		1908	my (undef, $path, $base) = @_;
		1909
		1910	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1911
		1912	$path = normalise $path, $base;
		1913
		1914	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1915	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1916	my $self = bless cf::map::new, $pkg;
		1917	$self->{path} = $path; $self->path ($path);
		1918	$self->init; # pass $1 etc.
		1919	return $self;
		1920	}
		1921	}
		1922
		1923	Carp::cluck "unable to resolve path '$path' (base '$base')";
		1924	()
		1925	}
		1926
		1927	sub init {
		1928	my ($self) = @_;
		1929
		1930	$self
		1931	}
		1932
		1933	sub as_string {
		1934	my ($self) = @_;
		1935
		1936	"$self->{path}"
		1937	}
		1938
		1939	# the displayed name, this is a one way mapping
		1940	sub visible_name {
		1941	&as_string
		1942	}
		1943
		1944	# the original (read-only) location
		1945	sub load_path {
		1946	my ($self) = @_;
		1947
		1948	"$MAPDIR/$self->{path}.map"
		1949	}
		1950
		1951	# the temporary/swap location
		1952	sub save_path {
		1953	my ($self) = @_;
		1954
		1955	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
		1956	"$TMPDIR/$path.map"
		1957	}
		1958
		1959	# the unique path, undef == no special unique path
		1960	sub uniq_path {
		1961	my ($self) = @_;
		1962
		1963	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
		1964	"$UNIQUEDIR/$path"
		1965	}
		1966
		1967	sub decay_objects {
		1968	my ($self) = @_;
		1969
		1970	return if $self->{deny_reset};
		1971
		1972	$self->do_decay_objects;
		1973	}
		1974
		1975	sub unlink_save {
		1976	my ($self) = @_;
		1977
		1978	utf8::encode (my $save = $self->save_path);
		1979	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1980	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1981	}
		1982
		1983	sub load_header_from($) {
		1984	my ($self, $path) = @_;
		1985
		1986	utf8::encode $path;
		1987	my $f = new_from_file cf::object::thawer $path
		1988	or return;
		1989
		1990	$self->_load_header ($f)
		1991	or return;
		1992
		1993	local $MAP_LOADING{$self->{path}} = $self;
		1994	$f->resolve_delayed_derefs;
		1995
		1996	$self->{load_path} = $path;
		1997
		1998	1
		1999	}
		2000
		2001	sub load_header_orig {
		2002	my ($self) = @_;
		2003
		2004	$self->load_header_from ($self->load_path)
		2005	}
		2006
		2007	sub load_header_temp {
		2008	my ($self) = @_;
		2009
		2010	$self->load_header_from ($self->save_path)
		2011	}
		2012
		2013	sub prepare_temp {
		2014	my ($self) = @_;
		2015
		2016	$self->last_access ((delete $self->{last_access})
		2017	|| $cf::RUNTIME); #d#
		2018	# safety
		2019	$self->{instantiate_time} = $cf::RUNTIME
		2020	if $self->{instantiate_time} > $cf::RUNTIME;
		2021	}
		2022
		2023	sub prepare_orig {
		2024	my ($self) = @_;
		2025
		2026	$self->{load_original} = 1;
		2027	$self->{instantiate_time} = $cf::RUNTIME;
		2028	$self->last_access ($cf::RUNTIME);
		2029	$self->instantiate;
		2030	}
		2031
		2032	sub load_header {
		2033	my ($self) = @_;
		2034
		2035	if ($self->load_header_temp) {
		2036	$self->prepare_temp;
		2037	} else {
		2038	$self->load_header_orig
		2039	or return;
		2040	$self->prepare_orig;
		2041	}
		2042
		2043	$self->{deny_reset} = 1
		2044	if $self->no_reset;
		2045
		2046	$self->default_region (cf::region::find_by_path $self->{path})
		2047	unless $self->default_region;
		2048
		2049	1
		2050	}
		2051
		2052	sub find;
		2053	sub find {
		2054	my ($path, $origin) = @_;
		2055
		2056	cf::cede_to_tick;
		2057
		2058	$path = normalise $path, $origin && $origin->path;
		2059
		2060	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
		2061	my $guard2 = cf::lock_acquire "map_find:$path";
		2062
		2063	$cf::MAP{$path} || do {
		2064	my $map = new_from_path cf::map $path
		2065	or return;
		2066
		2067	$map->{last_save} = $cf::RUNTIME;
		2068
		2069	$map->load_header
		2070	or return;
		2071
		2072	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		2073	# doing this can freeze the server in a sync job, obviously
		2074	#$cf::WAIT_FOR_TICK->wait;
		2075	undef $guard2;
		2076	undef $guard1;
		2077	$map->reset;
		2078	return find $path;
		2079	}
		2080
		2081	$cf::MAP{$path} = $map
		2082	}
		2083	}
		2084
		2085	sub pre_load { }
		2086	#sub post_load { } # XS
		2087
		2088	sub load {
		2089	my ($self) = @_;
		2090
		2091	local $self->{deny_reset} = 1; # loading can take a long time
		2092
		2093	my $path = $self->{path};
		2094
		2095	{
		2096	my $guard = cf::lock_acquire "map_data:$path";
		2097
		2098	return unless $self->valid;
		2099	return unless $self->in_memory == cf::MAP_SWAPPED;
		2100
		2101	$self->in_memory (cf::MAP_LOADING);
		2102
		2103	$self->alloc;
		2104
		2105	$self->pre_load;
		2106	cf::cede_to_tick;
		2107
		2108	my $f = new_from_file cf::object::thawer $self->{load_path};
		2109	$f->skip_block;
		2110	$self->_load_objects ($f)
		2111	or return;
		2112
		2113	$self->post_load_original
		2114	if delete $self->{load_original};
		2115
		2116	if (my $uniq = $self->uniq_path) {
		2117	utf8::encode $uniq;
		2118	unless (aio_stat $uniq) {
		2119	if (my $f = new_from_file cf::object::thawer $uniq) {
		2120	$self->clear_unique_items;
		2121	$self->_load_objects ($f);
		2122	$f->resolve_delayed_derefs;
		2123	}
		2124	}
		2125	}
		2126
		2127	$f->resolve_delayed_derefs;
		2128
		2129	cf::cede_to_tick;
		2130	# now do the right thing for maps
		2131	$self->link_multipart_objects;
		2132	$self->difficulty ($self->estimate_difficulty)
		2133	unless $self->difficulty;
		2134	cf::cede_to_tick;
		2135
		2136	unless ($self->{deny_activate}) {
		2137	$self->decay_objects;
		2138	$self->fix_auto_apply;
		2139	$self->update_buttons;
		2140	cf::cede_to_tick;
		2141	$self->activate;
		2142	}
		2143
		2144	$self->{last_save} = $cf::RUNTIME;
		2145	$self->last_access ($cf::RUNTIME);
		2146
		2147	$self->in_memory (cf::MAP_ACTIVE);
		2148	}
		2149
		2150	$self->post_load;
		2151	}
		2152
		2153	# customize the map for a given player, i.e.
		2154	# return the _real_ map. used by e.g. per-player
		2155	# maps to change the path to ~playername/mappath
		2156	sub customise_for {
		2157	my ($self, $ob) = @_;
		2158
		2159	return find "~" . $ob->name . "/" . $self->{path}
		2160	if $self->per_player;
		2161
		2162	# return find "?party/" . $ob->name . "/" . $self->{path}
		2163	# if $self->per_party;
		2164
		2165	$self
		2166	}
		2167
		2168	# find and load all maps in the 3x3 area around a map
		2169	sub load_neighbours {
		2170	my ($map) = @_;
		2171
		2172	my @neigh; # diagonal neighbours
		2173
		2174	for (0 .. 3) {
		2175	my $neigh = $map->tile_path ($_)
		2176	or next;
		2177	$neigh = find $neigh, $map
		2178	or next;
		2179	$neigh->load;
		2180
		2181	# now find the diagonal neighbours
		2182	push @neigh,
		2183	[$neigh->tile_path (($_ + 3) % 4), $neigh],
		2184	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		2185	}
		2186
		2187	for (grep defined $_->[0], @neigh) {
		2188	my ($path, $origin) = @$_;
		2189	my $neigh = find $path, $origin
		2190	or next;
		2191	$neigh->load;
		2192	}
		2193	}
		2194
		2195	sub find_sync {
		2196	my ($path, $origin) = @_;
		2197
		2198	return cf::LOG cf::llevError | cf::logBacktrace, "do_find_sync"
		2199	if $Coro::current == $Coro::main;
		2200
		2201	find $path, $origin
		2202	}
		2203
		2204	sub do_load_sync {
		2205	my ($map) = @_;
		2206
		2207	return cf::LOG cf::llevError | cf::logBacktrace, "do_load_sync"
		2208	if $Coro::current == $Coro::main;
		2209
		2210	$map->load;
		2211	}
		2212
		2213	our %MAP_PREFETCH;
		2214	our $MAP_PREFETCHER = undef;
		2215
		2216	sub find_async {
		2217	my ($path, $origin, $load) = @_;
		2218
		2219	$path = normalise $path, $origin && $origin->{path};
		2220
		2221	if (my $map = $cf::MAP{$path}) {
		2222	return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
		2223	}
		2224
		2225	$MAP_PREFETCH{$path} |= $load;
		2226
		2227	$MAP_PREFETCHER ||= cf::async {
		2228	$Coro::current->{desc} = "map prefetcher";
		2229
		2230	while (%MAP_PREFETCH) {
		2231	while (my ($k, $v) = each %MAP_PREFETCH) {
		2232	if (my $map = find $k) {
		2233	$map->load if $v;
		2234	}
		2235
		2236	delete $MAP_PREFETCH{$k};
		2237	}
		2238	}
		2239	undef $MAP_PREFETCHER;
		2240	};
		2241	$MAP_PREFETCHER->prio (6);
		2242
		2243	()
		2244	}
		2245
		2246	# common code, used by both ->save and ->swapout
		2247	sub _save {
		2248	my ($self) = @_;
		2249
		2250	$self->{last_save} = $cf::RUNTIME;
		2251
		2252	return unless $self->dirty;
		2253
		2254	my $save = $self->save_path; utf8::encode $save;
		2255	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2256
		2257	$self->{load_path} = $save;
		2258
		2259	return if $self->{deny_save};
		2260
		2261	local $self->{last_access} = $self->last_access;#d#
		2262
		2263	cf::async {
		2264	$Coro::current->{desc} = "map player save";
		2265	$_->contr->save for $self->players;
		2266	};
		2267
		2268	cf::get_slot 0.02;
		2269
		2270	if ($uniq) {
		2271	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		2272	$self->_save_objects ($uniq, cf::IO_UNIQUES);
		2273	} else {
		2274	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
		2275	}
		2276	}
		2277
		2278	sub save {
		2279	my ($self) = @_;
		2280
		2281	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2282
		2283	$self->_save;
		2284	}
		2285
		2286	sub swap_out {
		2287	my ($self) = @_;
		2288
		2289	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2290
		2291	return if $self->in_memory != cf::MAP_ACTIVE;
		2292	return if $self->{deny_save};
		2293	return if $self->players;
		2294
		2295	# first deactivate the map and "unlink" it from the core
		2296	$self->deactivate;
		2297	$_->clear_links_to ($self) for values %cf::MAP;
		2298	$self->in_memory (cf::MAP_SWAPPED);
		2299
		2300	# then atomically save
		2301	$self->_save;
		2302
		2303	# then free the map
		2304	$self->clear;
		2305	}
		2306
		2307	sub reset_at {
		2308	my ($self) = @_;
		2309
		2310	# TODO: safety, remove and allow resettable per-player maps
		2311	return 1e99 if $self->{deny_reset};
		2312
		2313	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		2314	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		2315
		2316	$time + $to
		2317	}
		2318
		2319	sub should_reset {
		2320	my ($self) = @_;
		2321
		2322	$self->reset_at <= $cf::RUNTIME
		2323	}
		2324
		2325	sub reset {
		2326	my ($self) = @_;
		2327
		2328	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2329
		2330	return if $self->players;
		2331
		2332	cf::trace "resetting map ", $self->path, "\n";
		2333
		2334	$self->in_memory (cf::MAP_SWAPPED);
		2335
		2336	# need to save uniques path
		2337	unless ($self->{deny_save}) {
		2338	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2339
		2340	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2341	if $uniq;
		2342	}
		2343
		2344	delete $cf::MAP{$self->path};
		2345
		2346	$self->deactivate;
		2347	$_->clear_links_to ($self) for values %cf::MAP;
		2348	$self->clear;
		2349
		2350	$self->unlink_save;
		2351	$self->destroy;
		2352	}
		2353
		2354	my $nuke_counter = "aaaa";
		2355
		2356	sub nuke {
		2357	my ($self) = @_;
		2358
		2359	{
		2360	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2361
		2362	delete $cf::MAP{$self->path};
		2363
		2364	$self->unlink_save;
		2365
		2366	bless $self, "cf::map::wrap";
		2367	delete $self->{deny_reset};
		2368	$self->{deny_save} = 1;
		2369	$self->reset_timeout (1);
		2370	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2371
		2372	$cf::MAP{$self->path} = $self;
		2373	}
		2374
		2375	$self->reset; # polite request, might not happen
		2376	}
		2377
		2378	=item $maps = cf::map::tmp_maps
		2379
		2380	Returns an arrayref with all map paths of currently instantiated and saved
		2381	maps. May block.
		2382
		2383	=cut
		2384
		2385	sub tmp_maps() {
		2386	[
		2387	map {
		2388	utf8::decode $_;
		2389	/\.map$/
		2390	? normalise $_
		2391	: ()
		2392	} @{ aio_readdir $TMPDIR or [] }
		2393	]
		2394	}
		2395
		2396	=item $maps = cf::map::random_maps
		2397
		2398	Returns an arrayref with all map paths of currently instantiated and saved
		2399	random maps. May block.
		2400
		2401	=cut
		2402
		2403	sub random_maps() {
		2404	[
		2405	map {
		2406	utf8::decode $_;
		2407	/\.map$/
		2408	? normalise "?random/$_"
		2409	: ()
		2410	} @{ aio_readdir $RANDOMDIR or [] }
		2411	]
		2412	}
		2413
		2414	=item cf::map::unique_maps
		2415
		2416	Returns an arrayref of paths of all shared maps that have
		2417	instantiated unique items. May block.
		2418
		2419	=cut
		2420
		2421	sub unique_maps() {
		2422	[
		2423	map {
		2424	utf8::decode $_;
		2425	s/\.map$//; # TODO future compatibility hack
		2426	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
		2427	? ()
		2428	: normalise $_
		2429	} @{ aio_readdir $UNIQUEDIR or [] }
		2430	]
		2431	}
		2432
		2433	=item cf::map::static_maps
		2434
		2435	Returns an arrayref if paths of all static maps (all preinstalled F<.map>
		2436	file in the shared directory excluding F</styles> and F</editor>). May
		2437	block.
		2438
		2439	=cut
		2440
		2441	sub static_maps() {
		2442	my @dirs = "";
		2443	my @maps;
		2444
		2445	while (@dirs) {
		2446	my $dir = shift @dirs;
		2447
		2448	next if $dir eq "/styles" || $dir eq "/editor";
		2449
		2450	my ($dirs, $files) = Coro::AIO::aio_scandir "$MAPDIR$dir", 2
		2451	or return;
		2452
		2453	for (@$files) {
		2454	s/\.map$// or next;
		2455	utf8::decode $_;
		2456	push @maps, "$dir/$_";
		2457	}
		2458
		2459	push @dirs, map "$dir/$_", @$dirs;
		2460	}
		2461
		2462	\@maps
		2463	}
		2464
		2465	=back
		2466
		2467	=head3 cf::object
		2468
		2469	=cut
		2470
		2471	package cf::object;
		2472
		2473	=over 4
		2474
		2475	=item $ob->inv_recursive
		2476
		2477	Returns the inventory of the object I<and> their inventories, recursively,
		2478	but I<not> the object itself.
		2479
		2480	=cut
		2481
		2482	sub inv_recursive_;
		2483	sub inv_recursive_ {
		2484	map { $_, inv_recursive_ $_->inv } @_
		2485	}
		2486
		2487	sub inv_recursive {
		2488	inv_recursive_ inv $_[0]
		2489	}
		2490
		2491	=item $ref = $ob->ref
		2492
		2493	Creates and returns a persistent reference to an object that can be stored as a string.
		2494
		2495	=item $ob = cf::object::deref ($refstring)
		2496
		2497	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2498	even if the object actually exists. May block.
		2499
		2500	=cut
		2501
		2502	sub deref {
		2503	my ($ref) = @_;
		2504
		2505	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2506	my ($uuid, $name) = ($1, $2);
		2507	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2508	or return;
		2509	$pl->ob->uuid eq $uuid
		2510	or return;
		2511
		2512	$pl->ob
		2513	} else {
		2514	warn "$ref: cannot resolve object reference\n";
		2515	undef
		2516	}
		2517	}
		2518
		2519	package cf;
896		2520
897	=back	2521	=back
898		2522
899	=head3 cf::object::player	2523	=head3 cf::object::player
900		2524
…		…
905	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	2529	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
906	can be C<undef>. Does the right thing when the player is currently in a	2530	can be C<undef>. Does the right thing when the player is currently in a
907	dialogue with the given NPC character.	2531	dialogue with the given NPC character.
908		2532
909	=cut	2533	=cut
		2534
		2535	our $SAY_CHANNEL = {
		2536	id => "say",
		2537	title => "Map",
		2538	reply => "say ",
		2539	tooltip => "Things said to and replied from NPCs near you and other players on the same map only.",
		2540	};
		2541
		2542	our $CHAT_CHANNEL = {
		2543	id => "chat",
		2544	title => "Chat",
		2545	reply => "chat ",
		2546	tooltip => "Player chat and shouts, global to the server.",
		2547	};
910		2548
911	# rough implementation of a future "reply" method that works	2549	# rough implementation of a future "reply" method that works
912	# with dialog boxes.	2550	# with dialog boxes.
913	#TODO: the first argument must go, split into a $npc->reply_to ( method	2551	#TODO: the first argument must go, split into a $npc->reply_to ( method
914	sub cf::object::player::reply($$$;$) {	2552	sub cf::object::player::reply($$$;$) {
…		…
916		2554
917	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2555	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
918		2556
919	if ($self->{record_replies}) {	2557	if ($self->{record_replies}) {
920	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2558	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2559
921	} else {	2560	} else {
		2561	my $pl = $self->contr;
		2562
		2563	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2564	my $dialog = $pl->{npc_dialog};
		2565	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2566
		2567	} else {
922	$msg = $npc->name . " says: $msg" if $npc;	2568	$msg = $npc->name . " says: $msg" if $npc;
923	$self->message ($msg, $flags);	2569	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2570	}
924	}	2571	}
		2572	}
		2573
		2574	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2575
		2576	=cut
		2577
		2578	sub cf::object::send_msg {
		2579	my $pl = shift->contr
		2580	or return;
		2581	$pl->send_msg (@_);
925	}	2582	}
926		2583
927	=item $player_object->may ("access")	2584	=item $player_object->may ("access")
928		2585
929	Returns wether the given player is authorized to access resource "access"	2586	Returns wether the given player is authorized to access resource "access"
…		…
938	(ref $cf::CFG{"may_$access"}	2595	(ref $cf::CFG{"may_$access"}
939	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	2596	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
940	: $cf::CFG{"may_$access"})	2597	: $cf::CFG{"may_$access"})
941	}	2598	}
942		2599
		2600	=item $player_object->enter_link
		2601
		2602	Freezes the player and moves him/her to a special map (C<{link}>).
		2603
		2604	The player should be reasonably safe there for short amounts of time (e.g.
		2605	for loading a map). You I<MUST> call C<leave_link> as soon as possible,
		2606	though, as the player cannot control the character while it is on the link
		2607	map.
		2608
		2609	Will never block.
		2610
		2611	=item $player_object->leave_link ($map, $x, $y)
		2612
		2613	Moves the player out of the special C<{link}> map onto the specified
		2614	map. If the map is not valid (or omitted), the player will be moved back
		2615	to the location he/she was before the call to C<enter_link>, or, if that
		2616	fails, to the emergency map position.
		2617
		2618	Might block.
		2619
		2620	=cut
		2621
		2622	sub link_map {
		2623	unless ($LINK_MAP) {
		2624	$LINK_MAP = cf::map::find "{link}"
		2625	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2626	$LINK_MAP->load;
		2627	}
		2628
		2629	$LINK_MAP
		2630	}
		2631
		2632	sub cf::object::player::enter_link {
		2633	my ($self) = @_;
		2634
		2635	$self->deactivate_recursive;
		2636
		2637	++$self->{_link_recursion};
		2638
		2639	return if UNIVERSAL::isa $self->map, "ext::map_link";
		2640
		2641	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		2642	if $self->map && $self->map->{path} ne "{link}";
		2643
		2644	$self->enter_map ($LINK_MAP || link_map, 3, 3);
		2645	}
		2646
		2647	sub cf::object::player::leave_link {
		2648	my ($self, $map, $x, $y) = @_;
		2649
		2650	return unless $self->contr->active;
		2651
		2652	my $link_pos = delete $self->{_link_pos};
		2653
		2654	unless ($map) {
		2655	# restore original map position
		2656	($map, $x, $y) = @{ $link_pos || [] };
		2657	$map = cf::map::find $map;
		2658
		2659	unless ($map) {
		2660	($map, $x, $y) = @$EMERGENCY_POSITION;
		2661	$map = cf::map::find $map
		2662	or die "FATAL: cannot load emergency map\n";
		2663	}
		2664	}
		2665
		2666	($x, $y) = (-1, -1)
		2667	unless (defined $x) && (defined $y);
		2668
		2669	# use -1 or undef as default coordinates, not 0, 0
		2670	($x, $y) = ($map->enter_x, $map->enter_y)
		2671	if $x <= 0 && $y <= 0;
		2672
		2673	$map->load;
		2674	$map->load_neighbours;
		2675
		2676	return unless $self->contr->active;
		2677
		2678	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
		2679	if ($self->enter_map ($map, $x, $y)) {
		2680	# entering was successful
		2681	delete $self->{_link_recursion};
		2682	# only activate afterwards, to support waiting in hooks
		2683	$self->activate_recursive;
		2684	}
		2685
		2686	}
		2687
		2688	=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
		2689
		2690	Moves the player to the given map-path and coordinates by first freezing
		2691	her, loading and preparing them map, calling the provided $check callback
		2692	that has to return the map if sucecssful, and then unfreezes the player on
		2693	the new (success) or old (failed) map position. In either case, $done will
		2694	be called at the end of this process.
		2695
		2696	Note that $check will be called with a potentially non-loaded map, so if
		2697	it needs a loaded map it has to call C<< ->load >>.
		2698
		2699	=cut
		2700
		2701	our $GOTOGEN;
		2702
		2703	sub cf::object::player::goto {
		2704	my ($self, $path, $x, $y, $check, $done) = @_;
		2705
		2706	if ($self->{_link_recursion} >= $MAX_LINKS) {
		2707	error "FATAL: link recursion exceeded, ", $self->name, " goto $path $x $y, redirecting.";
		2708	$self->failmsg ("Something went wrong inside the server - please contact an administrator!");
		2709	($path, $x, $y) = @$EMERGENCY_POSITION;
		2710	}
		2711
		2712	# do generation counting so two concurrent goto's will be executed in-order
		2713	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
		2714
		2715	$self->enter_link;
		2716
		2717	(async {
		2718	$Coro::current->{desc} = "player::goto $path $x $y";
		2719
		2720	# *tag paths override both path and x|y
		2721	if ($path =~ /^\*(.*)$/) {
		2722	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2723	my $ob = $obs[rand @obs];
		2724
		2725	# see if we actually can go there
		2726	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2727	$ob = $obs[rand @obs];
		2728	} else {
		2729	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2730	}
		2731	# else put us there anyways for now #d#
		2732
		2733	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2734	} else {
		2735	($path, $x, $y) = (undef, undef, undef);
		2736	}
		2737	}
		2738
		2739	my $map = eval {
		2740	my $map = defined $path ? cf::map::find $path : undef;
		2741
		2742	if ($map) {
		2743	$map = $map->customise_for ($self);
		2744	$map = $check->($map, $x, $y, $self) if $check && $map;
		2745	} else {
		2746	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2747	}
		2748
		2749	$map
		2750	};
		2751
		2752	if ($@) {
		2753	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2754	LOG llevError | logBacktrace, Carp::longmess $@;
		2755	}
		2756
		2757	if ($gen == $self->{_goto_generation}) {
		2758	delete $self->{_goto_generation};
		2759	$self->leave_link ($map, $x, $y);
		2760	}
		2761
		2762	$done->($self) if $done;
		2763	})->prio (1);
		2764	}
		2765
		2766	=item $player_object->enter_exit ($exit_object)
		2767
		2768	=cut
		2769
		2770	sub parse_random_map_params {
		2771	my ($spec) = @_;
		2772
		2773	my $rmp = { # defaults
		2774	xsize => (cf::rndm 15, 40),
		2775	ysize => (cf::rndm 15, 40),
		2776	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2777	#layout => string,
		2778	};
		2779
		2780	for (split /\n/, $spec) {
		2781	my ($k, $v) = split /\s+/, $_, 2;
		2782
		2783	$rmp->{lc $k} = $v if (length $k) && (length $v);
		2784	}
		2785
		2786	$rmp
		2787	}
		2788
		2789	sub prepare_random_map {
		2790	my ($exit) = @_;
		2791
		2792	# all this does is basically replace the /! path by
		2793	# a new random map path (?random/...) with a seed
		2794	# that depends on the exit object
		2795
		2796	my $rmp = parse_random_map_params $exit->msg;
		2797
		2798	if ($exit->map) {
		2799	$rmp->{region} = $exit->region->name;
		2800	$rmp->{origin_map} = $exit->map->path;
		2801	$rmp->{origin_x} = $exit->x;
		2802	$rmp->{origin_y} = $exit->y;
		2803
		2804	$exit->map->touch;
		2805	}
		2806
		2807	$rmp->{random_seed} ||= $exit->random_seed;
		2808
		2809	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
		2810	my $md5 = Digest::MD5::md5_hex $data;
		2811	my $meta = "$RANDOMDIR/$md5.meta";
		2812
		2813	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		2814	aio_write $fh, 0, (length $data), $data, 0;
		2815	undef $fh;
		2816	aio_rename "$meta~", $meta;
		2817
		2818	my $slaying = "?random/$md5";
		2819
		2820	if ($exit->valid) {
		2821	$exit->slaying ("?random/$md5");
		2822	$exit->msg (undef);
		2823	}
		2824	}
		2825	}
		2826
		2827	sub cf::object::player::enter_exit {
		2828	my ($self, $exit) = @_;
		2829
		2830	return unless $self->type == cf::PLAYER;
		2831
		2832	$self->enter_link;
		2833
		2834	(async {
		2835	$Coro::current->{desc} = "enter_exit";
		2836
		2837	unless (eval {
		2838	$self->deactivate_recursive; # just to be sure
		2839
		2840	# random map handling
		2841	{
		2842	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2843
		2844	prepare_random_map $exit
		2845	if $exit->slaying eq "/!";
		2846	}
		2847
		2848	my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2849	my $x = $exit->stats->hp;
		2850	my $y = $exit->stats->sp;
		2851
		2852	$self->goto ($map, $x, $y);
		2853
		2854	# if exit is damned, update players death & WoR home-position
		2855	$self->contr->savebed ($map, $x, $y)
		2856	if $exit->flag (cf::FLAG_DAMNED);
		2857
		2858	1
		2859	}) {
		2860	$self->message ("Something went wrong deep within the deliantra server. "
		2861	. "I'll try to bring you back to the map you were before. "
		2862	. "Please report this to the dungeon master!",
		2863	cf::NDI_UNIQUE | cf::NDI_RED);
		2864
		2865	error "ERROR in enter_exit: $@";
		2866	$self->leave_link;
		2867	}
		2868	})->prio (1);
		2869	}
		2870
943	=head3 cf::client	2871	=head3 cf::client
944		2872
945	=over 4	2873	=over 4
946		2874
947	=item $client->send_drawinfo ($text, $flags)	2875	=item $client->send_drawinfo ($text, $flags)
…		…
953		2881
954	sub cf::client::send_drawinfo {	2882	sub cf::client::send_drawinfo {
955	my ($self, $text, $flags) = @_;	2883	my ($self, $text, $flags) = @_;
956		2884
957	utf8::encode $text;	2885	utf8::encode $text;
958	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2886	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
959	}	2887	}
960		2888
		2889	=item $client->send_big_packet ($pkt)
		2890
		2891	Like C<send_packet>, but tries to compress large packets, and fragments
		2892	them as required.
		2893
		2894	=cut
		2895
		2896	our $MAXFRAGSIZE = cf::MAXSOCKBUF - 64;
		2897
		2898	sub cf::client::send_big_packet {
		2899	my ($self, $pkt) = @_;
		2900
		2901	# try lzf for large packets
		2902	$pkt = "lzf " . Compress::LZF::compress $pkt
		2903	if 1024 <= length $pkt and $self->{can_lzf};
		2904
		2905	# split very large packets
		2906	if ($MAXFRAGSIZE < length $pkt and $self->{can_lzf}) {
		2907	$self->send_packet ("frag $_") for unpack "(a$MAXFRAGSIZE)*", $pkt;
		2908	$pkt = "frag";
		2909	}
		2910
		2911	$self->send_packet ($pkt);
		2912	}
		2913
		2914	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2915
		2916	Send a drawinfo or msg packet to the client, formatting the msg for the
		2917	client if neccessary. C<$type> should be a string identifying the type of
		2918	the message, with C<log> being the default. If C<$color> is negative, suppress
		2919	the message unless the client supports the msg packet.
		2920
		2921	=cut
		2922
		2923	# non-persistent channels (usually the info channel)
		2924	our %CHANNEL = (
		2925	"c/motd" => {
		2926	id => "infobox",
		2927	title => "MOTD",
		2928	reply => undef,
		2929	tooltip => "The message of the day",
		2930	},
		2931	"c/identify" => {
		2932	id => "infobox",
		2933	title => "Identify",
		2934	reply => undef,
		2935	tooltip => "Items recently identified",
		2936	},
		2937	"c/examine" => {
		2938	id => "infobox",
		2939	title => "Examine",
		2940	reply => undef,
		2941	tooltip => "Signs and other items you examined",
		2942	},
		2943	"c/shopinfo" => {
		2944	id => "infobox",
		2945	title => "Shop Info",
		2946	reply => undef,
		2947	tooltip => "What your bargaining skill tells you about the shop",
		2948	},
		2949	"c/book" => {
		2950	id => "infobox",
		2951	title => "Book",
		2952	reply => undef,
		2953	tooltip => "The contents of a note or book",
		2954	},
		2955	"c/lookat" => {
		2956	id => "infobox",
		2957	title => "Look",
		2958	reply => undef,
		2959	tooltip => "What you saw there",
		2960	},
		2961	"c/who" => {
		2962	id => "infobox",
		2963	title => "Players",
		2964	reply => undef,
		2965	tooltip => "Shows players who are currently online",
		2966	},
		2967	"c/body" => {
		2968	id => "infobox",
		2969	title => "Body Parts",
		2970	reply => undef,
		2971	tooltip => "Shows which body parts you posess and are available",
		2972	},
		2973	"c/statistics" => {
		2974	id => "infobox",
		2975	title => "Statistics",
		2976	reply => undef,
		2977	tooltip => "Shows your primary statistics",
		2978	},
		2979	"c/skills" => {
		2980	id => "infobox",
		2981	title => "Skills",
		2982	reply => undef,
		2983	tooltip => "Shows your experience per skill and item power",
		2984	},
		2985	"c/shopitems" => {
		2986	id => "infobox",
		2987	title => "Shop Items",
		2988	reply => undef,
		2989	tooltip => "Shows the items currently for sale in this shop",
		2990	},
		2991	"c/resistances" => {
		2992	id => "infobox",
		2993	title => "Resistances",
		2994	reply => undef,
		2995	tooltip => "Shows your resistances",
		2996	},
		2997	"c/pets" => {
		2998	id => "infobox",
		2999	title => "Pets",
		3000	reply => undef,
		3001	tooltip => "Shows information abotu your pets/a specific pet",
		3002	},
		3003	"c/perceiveself" => {
		3004	id => "infobox",
		3005	title => "Perceive Self",
		3006	reply => undef,
		3007	tooltip => "You gained detailed knowledge about yourself",
		3008	},
		3009	"c/uptime" => {
		3010	id => "infobox",
		3011	title => "Uptime",
		3012	reply => undef,
		3013	tooltip => "How long the server has been running since last restart",
		3014	},
		3015	"c/mapinfo" => {
		3016	id => "infobox",
		3017	title => "Map Info",
		3018	reply => undef,
		3019	tooltip => "Information related to the maps",
		3020	},
		3021	"c/party" => {
		3022	id => "party",
		3023	title => "Party",
		3024	reply => "gsay ",
		3025	tooltip => "Messages and chat related to your party",
		3026	},
		3027	"c/death" => {
		3028	id => "death",
		3029	title => "Death",
		3030	reply => undef,
		3031	tooltip => "Reason for and more info about your most recent death",
		3032	},
		3033	"c/say" => $SAY_CHANNEL,
		3034	"c/chat" => $CHAT_CHANNEL,
		3035	);
		3036
		3037	sub cf::client::send_msg {
		3038	my ($self, $channel, $msg, $color, @extra) = @_;
		3039
		3040	$msg = $self->pl->expand_cfpod ($msg)
		3041	unless $color & cf::NDI_VERBATIM;
		3042
		3043	$color &= cf::NDI_CLIENT_MASK; # just in case...
		3044
		3045	# check predefined channels, for the benefit of C
		3046	if ($CHANNEL{$channel}) {
		3047	$channel = $CHANNEL{$channel};
		3048
		3049	$self->ext_msg (channel_info => $channel);
		3050	$channel = $channel->{id};
		3051
		3052	} elsif (ref $channel) {
		3053	# send meta info to client, if not yet sent
		3054	unless (exists $self->{channel}{$channel->{id}}) {
		3055	$self->{channel}{$channel->{id}} = $channel;
		3056	$self->ext_msg (channel_info => $channel);
		3057	}
		3058
		3059	$channel = $channel->{id};
		3060	}
		3061
		3062	return unless @extra || length $msg;
		3063
		3064	# default colour, mask it out
		3065	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		3066	if $color & cf::NDI_DEF;
		3067
		3068	my $pkt = "msg "
		3069	. $self->{json_coder}->encode (
		3070	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
		3071	);
		3072
		3073	$self->send_big_packet ($pkt);
		3074	}
		3075
		3076	=item $client->ext_msg ($type, @msg)
		3077
		3078	Sends an ext event to the client.
		3079
		3080	=cut
		3081
		3082	sub cf::client::ext_msg($$@) {
		3083	my ($self, $type, @msg) = @_;
		3084
		3085	if ($self->extcmd == 2) {
		3086	$self->send_big_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		3087	} elsif ($self->extcmd == 1) { # TODO: remove
		3088	push @msg, msgtype => "event_$type";
		3089	$self->send_big_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		3090	}
		3091	}
		3092
		3093	=item $client->ext_reply ($msgid, @msg)
		3094
		3095	Sends an ext reply to the client.
		3096
		3097	=cut
		3098
		3099	sub cf::client::ext_reply($$@) {
		3100	my ($self, $id, @msg) = @_;
		3101
		3102	if ($self->extcmd == 2) {
		3103	$self->send_big_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		3104	} elsif ($self->extcmd == 1) {
		3105	#TODO: version 1, remove
		3106	unshift @msg, msgtype => "reply", msgid => $id;
		3107	$self->send_big_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		3108	}
		3109	}
961		3110
962	=item $success = $client->query ($flags, "text", \&cb)	3111	=item $success = $client->query ($flags, "text", \&cb)
963		3112
964	Queues a query to the client, calling the given callback with	3113	Queues a query to the client, calling the given callback with
965	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	3114	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
966	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	3115	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
967		3116
968	Queries can fail, so check the return code. Or don't, as queries will become	3117	Queries can fail, so check the return code. Or don't, as queries will
969	reliable at some point in the future.	3118	become reliable at some point in the future.
970		3119
971	=cut	3120	=cut
972		3121
973	sub cf::client::query {	3122	sub cf::client::query {
974	my ($self, $flags, $text, $cb) = @_;	3123	my ($self, $flags, $text, $cb) = @_;
…		…
982	utf8::encode $text;	3131	utf8::encode $text;
983	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	3132	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
984		3133
985	$self->send_packet ($self->{query_queue}[0][0])	3134	$self->send_packet ($self->{query_queue}[0][0])
986	if @{ $self->{query_queue} } == 1;	3135	if @{ $self->{query_queue} } == 1;
		3136
		3137	1
987	}	3138	}
988		3139
989	cf::client->attach (	3140	cf::client->attach (
		3141	on_connect => sub {
		3142	my ($ns) = @_;
		3143
		3144	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		3145	},
990	on_reply => sub {	3146	on_reply => sub {
991	my ($ns, $msg) = @_;	3147	my ($ns, $msg) = @_;
992		3148
993	# this weird shuffling is so that direct followup queries	3149	# this weird shuffling is so that direct followup queries
994	# get handled first	3150	# get handled first
995	my $queue = delete $ns->{query_queue};	3151	my $queue = delete $ns->{query_queue}
		3152	or return; # be conservative, not sure how that can happen, but we saw a crash here
996		3153
997	(shift @$queue)->[1]->($msg);	3154	(shift @$queue)->[1]->($msg);
		3155	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
998		3156
999	push @{ $ns->{query_queue} }, @$queue;	3157	push @{ $ns->{query_queue} }, @$queue;
1000		3158
1001	if (@{ $ns->{query_queue} } == @$queue) {	3159	if (@{ $ns->{query_queue} } == @$queue) {
1002	if (@$queue) {	3160	if (@$queue) {
…		…
1004	} else {	3162	} else {
1005	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3163	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1006	}	3164	}
1007	}	3165	}
1008	},	3166	},
		3167	on_exticmd => sub {
		3168	my ($ns, $buf) = @_;
		3169
		3170	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		3171
		3172	if (ref $msg) {
		3173	my ($type, $reply, @payload) =
		3174	"ARRAY" eq ref $msg
		3175	? @$msg
		3176	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		3177
		3178	my @reply;
		3179
		3180	if (my $cb = $EXTICMD{$type}) {
		3181	@reply = $cb->($ns, @payload);
		3182	}
		3183
		3184	$ns->ext_reply ($reply, @reply)
		3185	if $reply;
		3186
		3187	} else {
		3188	error "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		3189	}
		3190
		3191	cf::override;
		3192	},
1009	);	3193	);
1010		3194
1011	=item $client->coro (\&cb)	3195	=item $client->async (\&cb)
1012		3196
1013	Create a new coroutine, running the specified callback. The coroutine will	3197	Create a new coroutine, running the specified callback. The coroutine will
1014	be automatically cancelled when the client gets destroyed (e.g. on logout,	3198	be automatically cancelled when the client gets destroyed (e.g. on logout,
1015	or loss of connection).	3199	or loss of connection).
1016		3200
1017	=cut	3201	=cut
1018		3202
1019	sub cf::client::coro {	3203	sub cf::client::async {
1020	my ($self, $cb) = @_;	3204	my ($self, $cb) = @_;
1021		3205
1022	my $coro; $coro = async {	3206	my $coro = &Coro::async ($cb);
1023	eval {
1024	$cb->();
1025	};
1026	warn $@ if $@;
1027	};
1028		3207
1029	$coro->on_destroy (sub {	3208	$coro->on_destroy (sub {
1030	delete $self->{_coro}{$coro+0};	3209	delete $self->{_coro}{$coro+0};
1031	});	3210	});
1032		3211
…		…
1034		3213
1035	$coro	3214	$coro
1036	}	3215	}
1037		3216
1038	cf::client->attach (	3217	cf::client->attach (
1039	on_destroy => sub {	3218	on_client_destroy => sub {
1040	my ($ns) = @_;	3219	my ($ns) = @_;
1041		3220
1042	$_->cancel for values %{ (delete $ns->{_coro}) || {} };	3221	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
1043	},	3222	},
1044	);	3223	);
…		…
1059	our $safe = new Safe "safe";	3238	our $safe = new Safe "safe";
1060	our $safe_hole = new Safe::Hole;	3239	our $safe_hole = new Safe::Hole;
1061		3240
1062	$SIG{FPE} = 'IGNORE';	3241	$SIG{FPE} = 'IGNORE';
1063		3242
1064	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3243	$safe->permit_only (Opcode::opset qw(
		3244	:base_core :base_mem :base_orig :base_math :base_loop
		3245	grepstart grepwhile mapstart mapwhile
		3246	sort time
		3247	));
1065		3248
1066	# here we export the classes and methods available to script code	3249	# here we export the classes and methods available to script code
1067		3250
1068	=pod	3251	=pod
1069		3252
1070	The following fucntions and emthods are available within a safe environment:	3253	The following functions and methods are available within a safe environment:
1071		3254
1072	cf::object contr pay_amount pay_player map	3255	cf::object
		3256	contr pay_amount pay_player map x y force_find force_add destroy
		3257	insert remove name archname title slaying race decrease split
		3258	value
		3259
1073	cf::object::player player	3260	cf::object::player
1074	cf::player peaceful	3261	player
1075	cf::map trigger	3262
		3263	cf::player
		3264	peaceful
		3265
		3266	cf::map
		3267	trigger
1076		3268
1077	=cut	3269	=cut
1078		3270
1079	for (	3271	for (
1080	["cf::object" => qw(contr pay_amount pay_player map)],	3272	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3273	insert remove inv nrof name archname title slaying race
		3274	decrease split destroy change_exp value msg lore send_msg)],
1081	["cf::object::player" => qw(player)],	3275	["cf::object::player" => qw(player)],
1082	["cf::player" => qw(peaceful)],	3276	["cf::player" => qw(peaceful send_msg)],
1083	["cf::map" => qw(trigger)],	3277	["cf::map" => qw(trigger)],
1084	) {	3278	) {
1085	no strict 'refs';
1086	my ($pkg, @funs) = @$_;	3279	my ($pkg, @funs) = @$_;
1087	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3280	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
1088	for @funs;	3281	for @funs;
1089	}	3282	}
1090		3283
…		…
1105		3298
1106	my $qcode = $code;	3299	my $qcode = $code;
1107	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3300	$qcode =~ s/"/‟/g; # not allowed in #line filenames
1108	$qcode =~ s/\n/\\n/g;	3301	$qcode =~ s/\n/\\n/g;
1109		3302
		3303	%vars = (_dummy => 0) unless %vars;
		3304
		3305	my @res;
1110	local $_;	3306	local $_;
1111	local @safe::cf::_safe_eval_args = values %vars;
1112		3307
1113	my $eval =	3308	my $eval =
1114	"do {\n"	3309	"do {\n"
1115	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	3310	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
1116	. "#line 0 \"{$qcode}\"\n"	3311	. "#line 0 \"{$qcode}\"\n"
1117	. $code	3312	. $code
1118	. "\n}"	3313	. "\n}"
1119	;	3314	;
1120		3315
		3316	if ($CFG{safe_eval}) {
1121	sub_generation_inc;	3317	sub_generation_inc;
		3318	local @safe::cf::_safe_eval_args = values %vars;
1122	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);	3319	@res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
1123	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	}
1124		3325
1125	if ($@) {	3326	if ($@) {
1126	warn "$@";	3327	warn "$@",
1127	warn "while executing safe code '$code'\n";	3328	"while executing safe code '$code'\n",
1128	warn "with arguments " . (join " ", %vars) . "\n";	3329	"with arguments " . (join " ", %vars) . "\n";
1129	}	3330	}
1130		3331
1131	wantarray ? @res : $res[0]	3332	wantarray ? @res : $res[0]
1132	}	3333	}
1133		3334
…		…
1147	=cut	3348	=cut
1148		3349
1149	sub register_script_function {	3350	sub register_script_function {
1150	my ($fun, $cb) = @_;	3351	my ($fun, $cb) = @_;
1151		3352
1152	no strict 'refs';	3353	$fun = "safe::$fun" if $CFG{safe_eval};
1153	*{"safe::$fun"} = $safe_hole->wrap ($cb);	3354	*$fun = $safe_hole->wrap ($cb);
1154	}	3355	}
1155		3356
1156	=back	3357	=back
1157		3358
1158	=cut	3359	=cut
1159		3360
1160	#############################################################################	3361	#############################################################################
		3362	# the server's init and main functions
1161		3363
1162	=head2 EXTENSION DATABASE SUPPORT	3364	sub load_facedata($) {
		3365	my ($path) = @_;
1163		3366
1164	Crossfire maintains a very simple database for extension use. It can	3367	# HACK to clear player env face cache, we need some signal framework
1165	currently store anything that can be serialised using Storable, which	3368	# for this (global event?)
1166	excludes objects.	3369	%ext::player_env::MUSIC_FACE_CACHE = ();
1167		3370
1168	The parameter C<$family> should best start with the name of the extension	3371	my $enc = JSON::XS->new->utf8->canonical->relaxed;
1169	using it, it should be unique.
1170		3372
1171	=over 4	3373	trace "loading facedata from $path\n";
1172		3374
1173	=item $hashref = cf::db_get $family	3375	my $facedata;
		3376	0 < aio_load $path, $facedata
		3377	or die "$path: $!";
1174		3378
1175	Return a hashref for use by the extension C<$family>, which can be	3379	$facedata = Coro::Storable::thaw $facedata;
1176	modified. After modifications, you have to call C<cf::db_dirty> or
1177	C<cf::db_sync>.
1178		3380
1179	=item $value = cf::db_get $family => $key	3381	$facedata->{version} == 2
		3382	or cf::cleanup "$path: version mismatch, cannot proceed.";
1180		3383
1181	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;
1182		3392
1183	=item cf::db_put $family => $hashref	3393	{
		3394	my $faces = $facedata->{faceinfo};
1184		3395
1185	Stores the given family hashref into the database. Updates are delayed, if	3396	while (my ($face, $info) = each %$faces) {
1186	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;
1187		3398
1188	=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};
1189		3403
1190	Stores the given C<$value> in the family hash. Updates are delayed, if you	3404	cf::cede_to_tick;
1191	want the data to be synced to disk immediately, use C<cf::db_sync>.	3405	}
1192		3406
1193	=item cf::db_dirty	3407	while (my ($face, $info) = each %$faces) {
		3408	next unless $info->{smooth};
1194		3409
1195	Marks the database as dirty, to be updated at a later time.	3410	my $idx = cf::face::find $face
		3411	or next;
1196		3412
1197	=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	}
1198		3419
1199	Immediately write the database to disk I<if it is dirty>.	3420	cf::cede_to_tick;
		3421	}
		3422	}
1200		3423
1201	=cut	3424	{
		3425	my $anims = $facedata->{animinfo};
1202		3426
1203	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_exp {
		3505	cf::init_experience;
		3506	}
		3507
		3508	sub reload_sound {
		3509	trace "loading sound config from $DATADIR/sound\n";
		3510
		3511	0 < Coro::AIO::aio_load "$DATADIR/sound", my $data
		3512	or die "$DATADIR/sound $!";
		3513
		3514	my $soundconf = JSON::XS->new->utf8->relaxed->decode ($data);
		3515
		3516	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3517	my $sound = $soundconf->{compat}[$_]
		3518	or next;
		3519
		3520	my $face = cf::face::find "sound/$sound->[1]";
		3521	cf::sound::set $sound->[0] => $face;
		3522	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3523	}
		3524
		3525	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3526	my $face = cf::face::find "sound/$v";
		3527	cf::sound::set $k => $face;
		3528	}
		3529	}
		3530
		3531	sub reload_resources {
		3532	trace "reloading resource files...\n";
		3533
		3534	reload_exp;
		3535	reload_facedata;
		3536	reload_sound;
		3537	reload_archetypes;
		3538	reload_regions;
		3539	reload_treasures;
		3540
		3541	trace "finished reloading resource files\n";
		3542	}
		3543
		3544	sub reload_config {
		3545	trace "reloading config file...\n";
		3546
		3547	open my $fh, "<:utf8", "$CONFDIR/config"
		3548	or return;
		3549
		3550	local $/;
		3551	*CFG = YAML::XS::Load scalar <$fh>;
		3552
		3553	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
		3554
		3555	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		3556	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		3557
		3558	if (exists $CFG{mlockall}) {
		3559	eval {
		3560	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		3561	and die "WARNING: m(un)lockall failed: $!\n";
		3562	};
		3563	warn $@ if $@;
		3564	}
		3565
		3566	trace "finished reloading resource files\n";
		3567	}
		3568
		3569	sub pidfile() {
		3570	sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
		3571	or die "$PIDFILE: $!";
		3572	flock $fh, &Fcntl::LOCK_EX
		3573	or die "$PIDFILE: flock: $!";
		3574	$fh
		3575	}
		3576
		3577	# make sure only one server instance is running at any one time
		3578	sub atomic {
		3579	my $fh = pidfile;
		3580
		3581	my $pid = <$fh>;
		3582	kill 9, $pid if $pid > 0;
		3583
		3584	seek $fh, 0, 0;
		3585	print $fh $$;
		3586	}
		3587
		3588	sub main_loop {
		3589	trace "EV::loop starting\n";
		3590	if (1) {
		3591	EV::loop;
		3592	}
		3593	trace "EV::loop returned\n";
		3594	goto &main_loop unless $REALLY_UNLOOP;
		3595	}
		3596
		3597	sub main {
		3598	cf::init_globals; # initialise logging
		3599
		3600	LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
		3601	LOG llevInfo, "Copyright (C) 2005-2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
		3602	LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
		3603	LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
		3604
		3605	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3606
		3607	# we must not ever block the main coroutine
		3608	local $Coro::idle = sub {
		3609	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		3610	(async {
		3611	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3612	EV::loop EV::LOOP_ONESHOT;
		3613	})->prio (Coro::PRIO_MAX);
		3614	};
		3615
		3616	evthread_start IO::AIO::poll_fileno;
		3617
		3618	cf::sync_job {
		3619	cf::incloader::init ();
		3620
		3621	cf::init_anim;
		3622	cf::init_attackmess;
		3623	cf::init_dynamic;
		3624
		3625	cf::load_settings;
		3626	cf::load_materials;
		3627
		3628	reload_resources;
		3629	reload_config;
		3630	db_init;
		3631
		3632	cf::init_uuid;
		3633	cf::init_signals;
		3634	cf::init_skills;
		3635
		3636	cf::init_beforeplay;
		3637
		3638	atomic;
		3639
		3640	load_extensions;
		3641
		3642	utime time, time, $RUNTIMEFILE;
		3643
		3644	# no (long-running) fork's whatsoever before this point(!)
		3645	use POSIX ();
		3646	POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
		3647
		3648	(pop @POST_INIT)->(0) while @POST_INIT;
		3649	};
		3650
		3651	cf::object::thawer::errors_are_fatal 0;
		3652	info "parse errors in files are no longer fatal from this point on.\n";
		3653
		3654	my $free_main; $free_main = EV::idle sub {
		3655	undef $free_main;
		3656	undef &main; # free gobs of memory :)
		3657	};
		3658
		3659	goto &main_loop;
		3660	}
		3661
		3662	#############################################################################
		3663	# initialisation and cleanup
		3664
		3665	# install some emergency cleanup handlers
		3666	BEGIN {
		3667	our %SIGWATCHER = ();
		3668	for my $signal (qw(INT HUP TERM)) {
		3669	$SIGWATCHER{$signal} = AE::signal $signal, sub {
		3670	cf::cleanup "SIG$signal";
		3671	};
		3672	}
		3673	}
		3674
		3675	sub write_runtime_sync {
		3676	my $t0 = AE::time;
		3677
		3678	# first touch the runtime file to show we are still running:
		3679	# the fsync below can take a very very long time.
		3680
		3681	IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
		3682
		3683	my $guard = cf::lock_acquire "write_runtime";
		3684
		3685	my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644
		3686	or return;
		3687
		3688	my $value = $cf::RUNTIME + 90 + 10;
		3689	# 10 is the runtime save interval, for a monotonic clock
		3690	# 60 allows for the watchdog to kill the server.
		3691
		3692	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3693	and return;
		3694
		3695	# always fsync - this file is important
		3696	aio_fsync $fh
		3697	and return;
		3698
		3699	# touch it again to show we are up-to-date
		3700	aio_utime $fh, undef, undef;
		3701
		3702	close $fh
		3703	or return;
		3704
		3705	aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
		3706	and return;
		3707
		3708	trace sprintf "runtime file written (%gs).\n", AE::time - $t0;
		3709
		3710	1
		3711	}
		3712
		3713	our $uuid_lock;
		3714	our $uuid_skip;
		3715
		3716	sub write_uuid_sync($) {
		3717	$uuid_skip ||= $_[0];
		3718
		3719	return if $uuid_lock;
		3720	local $uuid_lock = 1;
		3721
		3722	my $uuid = "$LOCALDIR/uuid";
		3723
		3724	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3725	or return;
		3726
		3727	my $value = uuid_seq uuid_cur;
		3728
		3729	unless ($value) {
		3730	info "cowardly refusing to write zero uuid value!\n";
		3731	return;
		3732	}
		3733
		3734	my $value = uuid_str $value + $uuid_skip;
		3735	$uuid_skip = 0;
		3736
		3737	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3738	and return;
		3739
		3740	# always fsync - this file is important
		3741	aio_fsync $fh
		3742	and return;
		3743
		3744	close $fh
		3745	or return;
		3746
		3747	aio_rename "$uuid~", $uuid
		3748	and return;
		3749
		3750	trace "uuid file written ($value).\n";
		3751
		3752	1
		3753
		3754	}
		3755
		3756	sub write_uuid($$) {
		3757	my ($skip, $sync) = @_;
		3758
		3759	$sync ? write_uuid_sync $skip
		3760	: async { write_uuid_sync $skip };
		3761	}
		3762
		3763	sub emergency_save() {
		3764	my $freeze_guard = cf::freeze_mainloop;
		3765
		3766	info "emergency_perl_save: enter\n";
		3767
		3768	# this is a trade-off: we want to be very quick here, so
		3769	# save all maps without fsync, and later call a global sync
		3770	# (which in turn might be very very slow)
		3771	local $USE_FSYNC = 0;
		3772
		3773	cf::sync_job {
		3774	cf::write_runtime_sync; # external watchdog should not bark
		3775
		3776	# use a peculiar iteration method to avoid tripping on perl
		3777	# refcount bugs in for. also avoids problems with players
		3778	# and maps saved/destroyed asynchronously.
		3779	info "emergency_perl_save: begin player save\n";
		3780	for my $login (keys %cf::PLAYER) {
		3781	my $pl = $cf::PLAYER{$login} or next;
		3782	$pl->valid or next;
		3783	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
		3784	$pl->save;
		3785	}
		3786	info "emergency_perl_save: end player save\n";
		3787
		3788	cf::write_runtime_sync; # external watchdog should not bark
		3789
		3790	info "emergency_perl_save: begin map save\n";
		3791	for my $path (keys %cf::MAP) {
		3792	my $map = $cf::MAP{$path} or next;
		3793	$map->valid or next;
		3794	$map->save;
		3795	}
		3796	info "emergency_perl_save: end map save\n";
		3797
		3798	cf::write_runtime_sync; # external watchdog should not bark
		3799
		3800	info "emergency_perl_save: begin database checkpoint\n";
		3801	BDB::db_env_txn_checkpoint $DB_ENV;
		3802	info "emergency_perl_save: end database checkpoint\n";
		3803
		3804	info "emergency_perl_save: begin write uuid\n";
		3805	write_uuid_sync 1;
		3806	info "emergency_perl_save: end write uuid\n";
		3807
		3808	cf::write_runtime_sync; # external watchdog should not bark
		3809
		3810	trace "emergency_perl_save: syncing database to disk";
		3811	BDB::db_env_txn_checkpoint $DB_ENV;
		3812
		3813	info "emergency_perl_save: starting sync\n";
		3814	IO::AIO::aio_sync sub {
		3815	info "emergency_perl_save: finished sync\n";
		3816	};
		3817
		3818	cf::write_runtime_sync; # external watchdog should not bark
		3819
		3820	trace "emergency_perl_save: flushing outstanding aio requests";
		3821	while (IO::AIO::nreqs || BDB::nreqs) {
		3822	Coro::EV::timer_once 0.01; # let the sync_job do it's thing
		3823	}
		3824
		3825	cf::write_runtime_sync; # external watchdog should not bark
		3826	};
		3827
		3828	info "emergency_perl_save: leave\n";
		3829	}
		3830
		3831	sub post_cleanup {
		3832	my ($make_core) = @_;
		3833
		3834	IO::AIO::flush;
		3835
		3836	error Carp::longmess "post_cleanup backtrace"
		3837	if $make_core;
		3838
		3839	my $fh = pidfile;
		3840	unlink $PIDFILE if <$fh> == $$;
		3841	}
		3842
		3843	# a safer delete_package, copied from Symbol
		3844	sub clear_package($) {
		3845	my $pkg = shift;
		3846
		3847	# expand to full symbol table name if needed
		3848	unless ($pkg =~ /^main::.*::$/) {
		3849	$pkg = "main$pkg" if $pkg =~ /^::/;
		3850	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		3851	$pkg .= '::' unless $pkg =~ /::$/;
		3852	}
		3853
		3854	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		3855	my $stem_symtab = *{$stem}{HASH};
		3856
		3857	defined $stem_symtab and exists $stem_symtab->{$leaf}
		3858	or return;
		3859
		3860	# clear all symbols
		3861	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		3862	for my $name (keys %$leaf_symtab) {
		3863	_gv_clear *{"$pkg$name"};
		3864	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		3865	}
		3866	}
		3867
		3868	sub do_reload_perl() {
		3869	# can/must only be called in main
		3870	unless (in_main) {
		3871	error "can only reload from main coroutine";
		3872	return;
		3873	}
		3874
		3875	return if $RELOAD++;
		3876
		3877	my $t1 = AE::time;
		3878
		3879	while ($RELOAD) {
		3880	cf::get_slot 0.1, -1, "reload_perl";
		3881	info "reloading...";
		3882
		3883	trace "entering sync_job";
		3884
		3885	cf::sync_job {
		3886	#cf::emergency_save;
		3887
		3888	trace "cancelling all extension coros";
		3889	$_->cancel for values %EXT_CORO;
		3890	%EXT_CORO = ();
		3891
		3892	trace "removing commands";
		3893	%COMMAND = ();
		3894
		3895	trace "removing ext/exti commands";
		3896	%EXTCMD = ();
		3897	%EXTICMD = ();
		3898
		3899	trace "unloading/nuking all extensions";
		3900	for my $pkg (@EXTS) {
		3901	trace "... unloading $pkg";
		3902
		3903	if (my $cb = $pkg->can ("unload")) {
		3904	eval {
		3905	$cb->($pkg);
		3906	1
		3907	} or error "$pkg unloaded, but with errors: $@";
		3908	}
		3909
		3910	trace "... clearing $pkg";
		3911	clear_package $pkg;
		3912	}
		3913
		3914	trace "unloading all perl modules loaded from $LIBDIR";
		3915	while (my ($k, $v) = each %INC) {
		3916	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		3917
		3918	trace "... unloading $k";
		3919	delete $INC{$k};
		3920
		3921	$k =~ s/\.pm$//;
		3922	$k =~ s/\//::/g;
		3923
		3924	if (my $cb = $k->can ("unload_module")) {
		3925	$cb->();
		3926	}
		3927
		3928	clear_package $k;
		3929	}
		3930
		3931	trace "getting rid of safe::, as good as possible";
		3932	clear_package "safe::$_"
		3933	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
		3934
		3935	trace "unloading cf.pm \"a bit\"";
		3936	delete $INC{"cf.pm"};
		3937	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
		3938
		3939	# don't, removes xs symbols, too,
		3940	# and global variables created in xs
		3941	#clear_package __PACKAGE__;
		3942
		3943	info "unload completed, starting to reload now";
		3944
		3945	trace "reloading cf.pm";
		3946	require cf;
		3947	cf::_connect_to_perl_1;
		3948
		3949	trace "loading config and database again";
		3950	cf::reload_config;
		3951
		3952	trace "loading extensions";
		3953	cf::load_extensions;
		3954
		3955	if ($REATTACH_ON_RELOAD) {
		3956	trace "reattaching attachments to objects/players";
		3957	_global_reattach; # objects, sockets
		3958	trace "reattaching attachments to maps";
		3959	reattach $_ for values %MAP;
		3960	trace "reattaching attachments to players";
		3961	reattach $_ for values %PLAYER;
		3962	}
		3963
		3964	trace "running post_init jobs";
		3965	(pop @POST_INIT)->(1) while @POST_INIT;
		3966
		3967	trace "leaving sync_job";
		3968
		3969	1
		3970	} or do {
		3971	error $@;
		3972	cf::cleanup "error while reloading, exiting.";
		3973	};
		3974
		3975	info "reloaded";
		3976	--$RELOAD;
		3977	}
		3978
		3979	$t1 = AE::time - $t1;
		3980	info "reload completed in ${t1}s\n";
		3981	};
		3982
		3983	our $RELOAD_WATCHER; # used only during reload
		3984
		3985	sub reload_perl() {
		3986	# doing reload synchronously and two reloads happen back-to-back,
		3987	# coro crashes during coro_state_free->destroy here.
		3988
		3989	$RELOAD_WATCHER ||= cf::async {
		3990	Coro::AIO::aio_wait cache_extensions;
		3991
		3992	$RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub {
		3993	do_reload_perl;
		3994	undef $RELOAD_WATCHER;
		3995	};
		3996	};
		3997	}
		3998
		3999	register_command "reload" => sub {
		4000	my ($who, $arg) = @_;
		4001
		4002	if ($who->flag (FLAG_WIZ)) {
		4003	$who->message ("reloading server.");
		4004	async {
		4005	$Coro::current->{desc} = "perl_reload";
		4006	reload_perl;
		4007	};
		4008	}
		4009	};
		4010
		4011	#############################################################################
		4012
		4013	my $bug_warning = 0;
		4014
		4015	our @WAIT_FOR_TICK;
		4016	our @WAIT_FOR_TICK_BEGIN;
		4017
		4018	sub wait_for_tick {
		4019	return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
		4020
		4021	my $signal = new Coro::Signal;
		4022	push @WAIT_FOR_TICK, $signal;
		4023	$signal->wait;
		4024	}
		4025
		4026	sub wait_for_tick_begin {
		4027	return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
		4028
		4029	my $signal = new Coro::Signal;
		4030	push @WAIT_FOR_TICK_BEGIN, $signal;
		4031	$signal->wait;
		4032	}
		4033
		4034	sub tick {
		4035	if ($Coro::current != $Coro::main) {
		4036	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		4037	unless ++$bug_warning > 10;
		4038	return;
		4039	}
		4040
		4041	cf::server_tick; # one server iteration
		4042
		4043	#for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
		4044
		4045	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		4046	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
		4047	Coro::async_pool {
		4048	$Coro::current->{desc} = "runtime saver";
		4049	write_runtime_sync
		4050	or error "ERROR: unable to write runtime file: $!";
		4051	};
		4052	}
		4053
		4054	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		4055	$sig->send;
		4056	}
		4057	while (my $sig = shift @WAIT_FOR_TICK) {
		4058	$sig->send;
		4059	}
		4060
		4061	$LOAD = ($NOW - $TICK_START) / $TICK;
		4062	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		4063
		4064	if (0) {
		4065	if ($NEXT_TICK) {
		4066	my $jitter = $TICK_START - $NEXT_TICK;
		4067	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		4068	debug "jitter $JITTER\n";#d#
		4069	}
		4070	}
		4071	}
1204		4072
1205	{	4073	{
1206	my $path = cf::localdir . "/database.pst";	4074	# configure BDB
1207		4075
1208	sub db_load() {	4076	BDB::min_parallel 16;
1209	warn "loading database $path\n";#d# remove later	4077	BDB::max_poll_reqs $TICK * 0.1;
1210	$DB = stat $path ? Storable::retrieve $path : { };	4078	$AnyEvent::BDB::WATCHER->priority (1);
1211	}
1212		4079
1213	my $pid;	4080	unless ($DB_ENV) {
		4081	$DB_ENV = BDB::db_env_create;
		4082	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		4083	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		4084	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		4085	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		4086	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
1214		4087
1215	sub db_save() {	4088	cf::sync_job {
1216	warn "saving database $path\n";#d# remove later
1217	waitpid $pid, 0 if $pid;
1218	if (0 == ($pid = fork)) {
1219	$DB->{_meta}{version} = 1;
1220	Storable::nstore $DB, "$path~";
1221	rename "$path~", $path;
1222	cf::_exit 0 if defined $pid;
1223	}
1224	}
1225
1226	my $dirty;
1227
1228	sub db_sync() {
1229	db_save if $dirty;
1230	undef $dirty;
1231	}
1232
1233	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1234	db_sync;
1235	});
1236
1237	sub db_dirty() {
1238	$dirty = 1;
1239	$idle->start;
1240	}
1241
1242	sub db_get($;$) {
1243	@_ >= 2
1244	? $DB->{$_[0]}{$_[1]}
1245	: ($DB->{$_[0]} ||= { })
1246	}
1247
1248	sub db_put($$;$) {
1249	if (@_ >= 3) {
1250	$DB->{$_[0]}{$_[1]} = $_[2];
1251	} else {	4089	eval {
1252	$DB->{$_[0]} = $_[1];	4090	BDB::db_env_open
1253	}	4091	$DB_ENV,
1254	db_dirty;	4092	$BDBDIR,
1255	}	4093	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		4094	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		4095	0666;
1256		4096
1257	cf::global->attach (	4097	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
1258	prio => 10000,
1259	on_cleanup => sub {
1260	db_sync;
1261	},
1262	);
1263	}
1264
1265	#############################################################################
1266	# the server's main()
1267
1268	sub cfg_load {
1269	open my $fh, "<:utf8", cf::confdir . "/config"
1270	or return;
1271
1272	local $/;
1273	*CFG = YAML::Syck::Load <$fh>;
1274	}
1275
1276	sub main {
1277	cfg_load;
1278	db_load;
1279	load_extensions;
1280	Event::loop;
1281	}
1282
1283	#############################################################################
1284	# initialisation
1285
1286	sub perl_reload() {
1287	# can/must only be called in main
1288	if ($Coro::current != $Coro::main) {
1289	warn "can only reload from main coroutine\n";
1290	return;
1291	}
1292
1293	warn "reloading...";
1294
1295	local $FREEZE = 1;
1296	cf::emergency_save;
1297
1298	eval {
1299	# if anything goes wrong in here, we should simply crash as we already saved
1300
1301	# cancel all watchers
1302	for (Event::all_watchers) {
1303	$_->cancel if $_->data & WF_AUTOCANCEL;
1304	}
1305
1306	# cancel all extension coros
1307	$_->cancel for values %EXT_CORO;
1308	%EXT_CORO = ();
1309
1310	# unload all extensions
1311	for (@exts) {
1312	warn "unloading <$_>";
1313	unload_extension $_;
1314	}
1315
1316	# unload all modules loaded from $LIBDIR
1317	while (my ($k, $v) = each %INC) {
1318	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1319
1320	warn "removing <$k>";
1321	delete $INC{$k};
1322
1323	$k =~ s/\.pm$//;
1324	$k =~ s/\//::/g;
1325
1326	if (my $cb = $k->can ("unload_module")) {
1327	$cb->();
1328	}	4098	};
1329		4099
1330	Symbol::delete_package $k;	4100	cf::cleanup "db_env_open(db): $@" if $@;
1331	}	4101	};
		4102	}
1332		4103
1333	# sync database to disk	4104	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
1334	cf::db_sync;	4105	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
1335	IO::AIO::flush;
1336
1337	# get rid of safe::, as good as possible
1338	Symbol::delete_package "safe::$_"
1339	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1340
1341	# remove register_script_function callbacks
1342	# TODO
1343
1344	# unload cf.pm "a bit"
1345	delete $INC{"cf.pm"};
1346
1347	# don't, removes xs symbols, too,
1348	# and global variables created in xs
1349	#Symbol::delete_package __PACKAGE__;
1350
1351	# reload cf.pm
1352	warn "reloading cf.pm";
1353	require cf;
1354	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1355
1356	# load config and database again
1357	cf::cfg_load;
1358	cf::db_load;
1359
1360	# load extensions
1361	warn "load extensions";
1362	cf::load_extensions;
1363
1364	# reattach attachments to objects
1365	warn "reattach";
1366	_global_reattach;
1367	};	4106	};
1368		4107	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
1369	if ($@) {	4108	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
1370	warn $@;
1371	warn "error while reloading, exiting.";
1372	exit 1;
1373	}	4109	};
1374		4110	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
1375	warn "reloaded successfully";	4111	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
1376	};
1377
1378	register "<global>", __PACKAGE__;
1379
1380	register_command "perl-reload" => sub {
1381	my ($who, $arg) = @_;
1382
1383	if ($who->flag (FLAG_WIZ)) {
1384	$who->message ("start of reload.");
1385	perl_reload;
1386	$who->message ("end of reload.");
1387	}	4112	};
1388	};	4113	}
1389		4114
1390	unshift @INC, $LIBDIR;	4115	{
		4116	# configure IO::AIO
1391		4117
1392	$TICK_WATCHER = Event->timer (	4118	IO::AIO::min_parallel 8;
1393	reentrant => 0,	4119	IO::AIO::max_poll_time $TICK * 0.1;
1394	prio => 0,	4120	undef $AnyEvent::AIO::WATCHER;
1395	at => $NEXT_TICK || $TICK,	4121	}
1396	data => WF_AUTOCANCEL,	4122
1397	cb => sub {	4123	my $_log_backtrace;
1398	unless ($FREEZE) {	4124
1399	cf::server_tick; # one server iteration	4125	sub _log_backtrace {
1400	$RUNTIME += $TICK;	4126	my ($msg, @addr) = @_;
		4127
		4128	$msg =~ s/\n//;
		4129
		4130	# limit the # of concurrent backtraces
		4131	if ($_log_backtrace < 2) {
		4132	++$_log_backtrace;
		4133	my $perl_bt = Carp::longmess $msg;
		4134	async {
		4135	$Coro::current->{desc} = "abt $msg";
		4136
		4137	my @bt = fork_call {
		4138	@addr = map { sprintf "%x", $_ } @addr;
		4139	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		4140	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		4141	or die "addr2line: $!";
		4142
		4143	my @funcs;
		4144	my @res = <$fh>;
		4145	chomp for @res;
		4146	while (@res) {
		4147	my ($func, $line) = splice @res, 0, 2, ();
		4148	push @funcs, "[$func] $line";
		4149	}
		4150
		4151	@funcs
		4152	};
		4153
		4154	LOG llevInfo, "[ABT] $perl_bt\n";
		4155	LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
		4156	LOG llevInfo, "[ABT] $_\n" for @bt;
		4157	--$_log_backtrace;
1401	}	4158	};
1402		4159	} else {
1403	$NEXT_TICK += $TICK;	4160	LOG llevInfo, "[ABT] $msg\n";
1404		4161	LOG llevInfo, "[ABT] [suppressed]\n";
1405	# if we are delayed by four ticks or more, skip them all
1406	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1407
1408	$TICK_WATCHER->at ($NEXT_TICK);
1409	$TICK_WATCHER->start;
1410	},	4162	}
1411	);	4163	}
1412		4164
1413	IO::AIO::max_poll_time $TICK * 0.2;	4165	# load additional modules
		4166	require "cf/$_.pm" for @EXTRA_MODULES;
		4167	cf::_connect_to_perl_2;
1414		4168
1415	Event->io (fd => IO::AIO::poll_fileno,	4169	END { cf::emergency_save }
1416	poll => 'r',
1417	prio => 5,
1418	data => WF_AUTOCANCEL,
1419	cb => \&IO::AIO::poll_cb);
1420
1421	# we must not ever block the main coroutine
1422	$Coro::idle = sub {
1423	#Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#
1424	warn "FATAL: Coro::idle was called, major BUG\n";
1425	(Coro::unblock_sub {
1426	Event::one_event;
1427	})->();
1428	};
1429		4170
1430	1	4171	1
1431		4172

Diff Legend

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