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.115 by root, Mon Jan 1 16:50:10 2007 UTC vs.
Revision 1.606 by root, Sun Nov 18 08:34:23 2012 UTC

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

Diff Legend

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