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.103 by root, Sat Dec 30 10:16:11 2006 UTC vs.
Revision 1.574 by root, Sun May 8 21:51:27 2011 UTC

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

Diff Legend

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