ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.107 by root, Sun Dec 31 18:10:40 2006 UTC vs.
Revision 1.592 by root, Fri Nov 9 00:11:49 2012 UTC

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

Diff Legend

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