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.153 by root, Mon Jan 8 23:36:16 2007 UTC vs.
Revision 1.575 by root, Sat Aug 13 20:20:30 2011 UTC

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

Diff Legend

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