ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.106 by root, Sun Dec 31 17:29:22 2006 UTC vs.
Revision 1.528 by root, Fri Apr 23 04:42:12 2010 UTC

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

Diff Legend

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