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

Diff Legend

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