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.110 by root, Mon Jan 1 11:21:55 2007 UTC vs.
Revision 1.479 by root, Thu Oct 8 05:04:27 2009 UTC

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

Diff Legend

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