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.120 by root, Tue Jan 2 11:08:36 2007 UTC vs.
Revision 1.478 by root, Thu Sep 17 01:57:31 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
183	JSON::Syck::Dump $_[0]
184	}
185		317
186	=item my $guard = cf::guard { BLOCK }	318	sub encode_json($) { $json_coder->encode ($_[0]) }
		319	sub decode_json($) { $json_coder->decode ($_[0]) }
187		320
188	Run the given callback when the guard object gets destroyed (useful for	321	=item cf::post_init { BLOCK }
189	coroutine cancellations).
190		322
191	You can call C<< ->cancel >> on the guard object to stop the block from	323	Execute the given codeblock, I<after> all extensions have been (re-)loaded,
192	being executed.	324	but I<before> the server starts ticking again.
193		325
194	=cut	326	The cdoeblock will have a single boolean argument to indicate whether this
		327	is a reload or not.
195		328
196	sub guard(&) {	329	=cut
197	bless \(my $cb = $_[0]), cf::guard::;
198	}
199		330
200	sub cf::guard::cancel {	331	sub post_init(&) {
201	${$_[0]} = sub { };	332	push @POST_INIT, shift;
202	}
203
204	sub cf::guard::DESTROY {
205	${$_[0]}->();
206	}	333	}
207		334
208	=item cf::lock_wait $string	335	=item cf::lock_wait $string
209		336
210	Wait until the given lock is available. See cf::lock_acquire.	337	Wait until the given lock is available. See cf::lock_acquire.
211		338
212	=item my $lock = cf::lock_acquire $string	339	=item my $lock = cf::lock_acquire $string
213		340
214	Wait until the given lock is available and then acquires it and returns	341	Wait until the given lock is available and then acquires it and returns
215	a guard object. If the guard object gets destroyed (goes out of scope,	342	a L<Guard> object. If the guard object gets destroyed (goes out of scope,
216	for example when the coroutine gets canceled), the lock is automatically	343	for example when the coroutine gets canceled), the lock is automatically
217	returned.	344	returned.
218		345
		346	Locks are *not* recursive, locking from the same coro twice results in a
		347	deadlocked coro.
		348
219	Lock names should begin with a unique identifier (for example, find_map	349	Lock names should begin with a unique identifier (for example, cf::map::find
220	uses map_find and load_map uses map_load).	350	uses map_find and cf::map::load uses map_load).
221		351
222	=cut	352	=item $locked = cf::lock_active $string
223		353
224	our %LOCK;	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;
225		359
226	sub lock_wait($) {	360	sub lock_wait($) {
227	my ($key) = @_;	361	$LOCKS->wait ($_[0]);
228
229	# wait for lock, if any
230	while ($LOCK{$key}) {
231	push @{ $LOCK{$key} }, $Coro::current;
232	Coro::schedule;
233	}
234	}	362	}
235		363
236	sub lock_acquire($) {	364	sub lock_acquire($) {
237	my ($key) = @_;	365	$LOCKS->guard ($_[0])
238
239	# wait, to be sure we are not locked
240	lock_wait $key;
241
242	$LOCK{$key} = [];
243
244	cf::guard {
245	# wake up all waiters, to be on the safe side
246	$_->ready for @{ delete $LOCK{$key} };
247	}
248	}	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 }
249		462
250	=item cf::sync_job { BLOCK }	463	=item cf::sync_job { BLOCK }
251		464
252	The design of crossfire+ requires that the main coro ($Coro::main) is	465	The design of Deliantra requires that the main coroutine ($Coro::main)
253	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
254	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.
255		469
256	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
257	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
258	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
259	fast or be very important.	473	fast or be very important.
…		…
262		476
263	sub sync_job(&) {	477	sub sync_job(&) {
264	my ($job) = @_;	478	my ($job) = @_;
265		479
266	if ($Coro::current == $Coro::main) {	480	if ($Coro::current == $Coro::main) {
		481	my $time = EV::time;
		482
267	# this is the main coro, too bad, we have to block	483	# this is the main coro, too bad, we have to block
268	# till the operation succeeds, freezing the server :/	484	# till the operation succeeds, freezing the server :/
269		485
270	# TODO: use suspend/resume instead	486	LOG llevError, Carp::longmess "sync job";#d#
271	# (but this is cancel-safe)	487
272	local $FREEZE = 1;	488	my $freeze_guard = freeze_mainloop;
273		489
274	my $busy = 1;	490	my $busy = 1;
275	my @res;	491	my @res;
276		492
277	(Coro::async {	493	(async {
		494	$Coro::current->desc ("sync job coro");
278	@res = eval { $job->() };	495	@res = eval { $job->() };
279	warn $@ if $@;	496	warn $@ if $@;
280	undef $busy;	497	undef $busy;
281	})->prio (Coro::PRIO_MAX);	498	})->prio (Coro::PRIO_MAX);
282		499
283	while ($busy) {	500	while ($busy) {
		501	if (Coro::nready) {
284	Coro::cede_notself;	502	Coro::cede_notself;
285	Event::one_event unless Coro::nready;	503	} else {
		504	EV::loop EV::LOOP_ONESHOT;
286	}	505	}
		506	}
		507
		508	my $time = EV::time - $time;
		509
		510	$TICK_START += $time; # do not account sync jobs to server load
287		511
288	wantarray ? @res : $res[0]	512	wantarray ? @res : $res[0]
289	} else {	513	} else {
290	# we are in another coroutine, how wonderful, everything just works	514	# we are in another coroutine, how wonderful, everything just works
291		515
292	$job->()	516	$job->()
293	}	517	}
294	}	518	}
295		519
296	=item $coro = cf::coro { BLOCK }	520	=item $coro = cf::async_ext { BLOCK }
297		521
298	Creates and returns a new coro. This coro is automcatially being canceled	522	Like async, but this coro is automatically being canceled when the
299	when the extension calling this is being unloaded.	523	extension calling this is being unloaded.
300		524
301	=cut	525	=cut
302		526
303	sub coro(&) {	527	sub async_ext(&) {
304	my $cb = shift;	528	my $cb = shift;
305		529
306	my $coro; $coro = async {	530	my $coro = &Coro::async ($cb);
307	eval {
308	$cb->();
309	};
310	warn $@ if $@;
311	};
312		531
313	$coro->on_destroy (sub {	532	$coro->on_destroy (sub {
314	delete $EXT_CORO{$coro+0};	533	delete $EXT_CORO{$coro+0};
315	});	534	});
316	$EXT_CORO{$coro+0} = $coro;	535	$EXT_CORO{$coro+0} = $coro;
317		536
318	$coro	537	$coro
319	}	538	}
320		539
321	sub write_runtime {	540	=item fork_call { }, $args
322	my $runtime = cf::localdir . "/runtime";
323		541
324	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	542	Executes the given code block with the given arguments in a seperate
325	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.
326		546
327	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	547	=cut
328	(aio_write $fh, 0, (length $value), $value, 0) <= 0
329	and return;
330		548
331	aio_fsync $fh	549	sub fork_call(&@) {
332	and return;	550	my ($cb, @args) = @_;
333		551
334	close $fh	552	# we seemingly have to make a local copy of the whole thing,
335	or return;	553	# otherwise perl prematurely frees the stuff :/
		554	# TODO: investigate and fix (likely this will be rather laborious)
336		555
337	aio_rename "$runtime~", $runtime	556	my @res = Coro::Util::fork_eval {
338	and return;	557	reset_signals;
		558	&$cb
		559	}, @args;
339		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
340	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 });
341	}	727	}
342		728
343	=back	729	=back
344		730
345	=cut	731	=cut
346		732
347	#############################################################################	733	#############################################################################
348		734
349	package cf::path;
350
351	sub new {
352	my ($class, $path, $base) = @_;
353
354	$path = $path->as_string if ref $path;
355
356	my $self = bless { }, $class;
357
358	# {... are special paths that are not touched
359	# ?xxx/... are special absolute paths
360	# ?random/... random maps
361	# /! non-realised random map exit
362	# /... normal maps
363	# ~/... per-player maps without a specific player (DO NOT USE)
364	# ~user/... per-player map of a specific user
365
366	if ($path =~ /^{/) {
367	# fine as it is
368	} elsif ($path =~ s{^\?random/}{}) {
369	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
370	$self->{random} = cf::from_json $data;
371	} else {
372	if ($path =~ s{^~([^/]+)?}{}) {
373	$self->{user_rel} = 1;
374
375	if (defined $1) {
376	$self->{user} = $1;
377	} elsif ($base =~ m{^~([^/]+)/}) {
378	$self->{user} = $1;
379	} else {
380	warn "cannot resolve user-relative path without user <$path,$base>\n";
381	}
382	} elsif ($path =~ /^\//) {
383	# already absolute
384	} else {
385	$base =~ s{[^/]+/?$}{};
386	return $class->new ("$base/$path");
387	}
388
389	for ($path) {
390	redo if s{/\.?/}{/};
391	redo if s{/[^/]+/\.\./}{/};
392	}
393	}
394
395	$self->{path} = $path;
396
397	$self
398	}
399
400	# the name / primary key / in-game path
401	sub as_string {
402	my ($self) = @_;
403
404	$self->{user_rel} ? "~$self->{user}$self->{path}"
405	: $self->{random} ? "?random/$self->{path}"
406	: $self->{path}
407	}
408
409	# the displayed name, this is a one way mapping
410	sub visible_name {
411	my ($self) = @_;
412
413	# if (my $rmp = $self->{random}) {
414	# # todo: be more intelligent about this
415	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
416	# } else {
417	$self->as_string
418	# }
419	}
420
421	# escape the /'s in the path
422	sub _escaped_path {
423	# ∕ is U+2215
424	(my $path = $_[0]{path}) =~ s/\//∕/g;
425	$path
426	}
427
428	# the original (read-only) location
429	sub load_path {
430	my ($self) = @_;
431
432	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
433	}
434
435	# the temporary/swap location
436	sub save_path {
437	my ($self) = @_;
438
439	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
440	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
441	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
442	}
443
444	# the unique path, might be eq to save_path
445	sub uniq_path {
446	my ($self) = @_;
447
448	$self->{user_rel} || $self->{random}
449	? undef
450	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
451	}
452
453	# return random map parameters, or undef
454	sub random_map_params {
455	my ($self) = @_;
456
457	$self->{random}
458	}
459
460	# this is somewhat ugly, but style maps do need special treatment
461	sub is_style_map {
462	$_[0]{path} =~ m{^/styles/}
463	}
464
465	package cf;
466
467	#############################################################################
468
469	=head2 ATTACHABLE OBJECTS	735	=head2 ATTACHABLE OBJECTS
470		736
471	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
472	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")
473	to it. All such attachable objects support the following methods.	739	to it. All such attachable objects support the following methods.
474		740
475	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>
476	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
477	crossfire+).	743	Deliantra).
478		744
479	=over 4	745	=over 4
480		746
481	=item $attachable->attach ($attachment, key => $value...)	747	=item $attachable->attach ($attachment, key => $value...)
482		748
…		…
526	=item cf::CLASS::attachment $name, ...	792	=item cf::CLASS::attachment $name, ...
527		793
528	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
529	given CLASS can refer to this attachment.	795	given CLASS can refer to this attachment.
530		796
531	Some classes such as crossfire maps and objects can specify attachments	797	Some classes such as deliantra maps and objects can specify attachments
532	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.
533		799
534	These calls expect any number of the following handler/hook descriptions:	800	These calls expect any number of the following handler/hook descriptions:
535		801
536	=over 4	802	=over 4
…		…
596	our @CB_TYPE = (); # registry for type (cf-object class) based events	862	our @CB_TYPE = (); # registry for type (cf-object class) based events
597	our @CB_MAP = ();	863	our @CB_MAP = ();
598		864
599	my %attachment;	865	my %attachment;
600		866
		867	sub cf::attachable::thawer_merge {
		868	# simply override everything except _meta
		869	local $_[0]{_meta};
		870	%{$_[0]} = %{$_[1]};
		871	}
		872
601	sub _attach_cb($$$$) {	873	sub _attach_cb($$$$) {
602	my ($registry, $event, $prio, $cb) = @_;	874	my ($registry, $event, $prio, $cb) = @_;
603		875
604	use sort 'stable';	876	use sort 'stable';
605		877
…		…
639	$registry = $CB_TYPE[$object_type] ||= [];	911	$registry = $CB_TYPE[$object_type] ||= [];
640		912
641	} elsif ($type eq "subtype") {	913	} elsif ($type eq "subtype") {
642	defined $object_type or Carp::croak "subtype specified without type";	914	defined $object_type or Carp::croak "subtype specified without type";
643	my $object_subtype = shift @arg;	915	my $object_subtype = shift @arg;
644	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	916	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
645		917
646	} elsif ($type eq "package") {	918	} elsif ($type eq "package") {
647	my $pkg = shift @arg;	919	my $pkg = shift @arg;
648		920
649	while (my ($name, $id) = each %cb_id) {	921	while (my ($name, $id) = each %cb_id) {
…		…
678	_attach $registry, $klass, @attach;	950	_attach $registry, $klass, @attach;
679	}	951	}
680		952
681	$obj->{$name} = \%arg;	953	$obj->{$name} = \%arg;
682	} else {	954	} else {
683	warn "object uses attachment '$name' that is not available, postponing.\n";	955	warn "object uses attachment '$name' which is not available, postponing.\n";
684	}	956	}
685		957
686	$obj->{_attachment}{$name} = undef;	958	$obj->{_attachment}{$name} = undef;
687	}	959	}
688		960
…		…
690	if (ref $_[0]) {	962	if (ref $_[0]) {
691	_object_attach @_;	963	_object_attach @_;
692	} else {	964	} else {
693	_attach shift->_attach_registry, @_;	965	_attach shift->_attach_registry, @_;
694	}	966	}
		967	_recalc_want;
695	};	968	};
696		969
697	# all those should be optimised	970	# all those should be optimised
698	sub cf::attachable::detach {	971	sub cf::attachable::detach {
699	my ($obj, $name) = @_;	972	my ($obj, $name) = @_;
…		…
702	delete $obj->{_attachment}{$name};	975	delete $obj->{_attachment}{$name};
703	reattach ($obj);	976	reattach ($obj);
704	} else {	977	} else {
705	Carp::croak "cannot, currently, detach class attachments";	978	Carp::croak "cannot, currently, detach class attachments";
706	}	979	}
		980	_recalc_want;
707	};	981	};
708		982
709	sub cf::attachable::attached {	983	sub cf::attachable::attached {
710	my ($obj, $name) = @_;	984	my ($obj, $name) = @_;
711		985
…		…
726	";	1000	";
727	die if $@;	1001	die if $@;
728	}	1002	}
729		1003
730	our $override;	1004	our $override;
731	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?
732		1006
733	sub override {	1007	sub override {
734	$override = 1;	1008	$override = 1;
735	@invoke_results = ();	1009	@INVOKE_RESULTS = (@_);
736	}	1010	}
737		1011
738	sub do_invoke {	1012	sub do_invoke {
739	my $event = shift;	1013	my $event = shift;
740	my $callbacks = shift;	1014	my $callbacks = shift;
741		1015
742	@invoke_results = ();	1016	@INVOKE_RESULTS = ();
743		1017
744	local $override;	1018	local $override;
745		1019
746	for (@$callbacks) {	1020	for (@$callbacks) {
747	eval { &{$_->[1]} };	1021	eval { &{$_->[1]} };
…		…
756	}	1030	}
757		1031
758	0	1032	0
759	}	1033	}
760		1034
761	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1035	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
762		1036
763	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1037	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
764		1038
765	Generate an object-specific event with the given arguments.	1039	Generate an object-specific event with the given arguments.
766		1040
767	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
768	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
769	results (if you must, access C<@cf::invoke_results> directly).	1043	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
770		1044
771	=back	1045	=back
772		1046
773	=cut	1047	=cut
774		1048
775	#############################################################################	1049	#############################################################################
776	# 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	}
777		1093
778	sub reattach {	1094	sub reattach {
779	# basically do the same as instantiate, without calling instantiate	1095	# basically do the same as instantiate, without calling instantiate
780	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
781		1100
782	my $registry = $obj->registry;	1101	my $registry = $obj->registry;
783		1102
784	@$registry = ();	1103	@$registry = ();
785		1104
…		…
800	cf::attachable->attach (	1119	cf::attachable->attach (
801	prio => -1000000,	1120	prio => -1000000,
802	on_instantiate => sub {	1121	on_instantiate => sub {
803	my ($obj, $data) = @_;	1122	my ($obj, $data) = @_;
804		1123
805	$data = from_json $data;	1124	$data = decode_json $data;
806		1125
807	for (@$data) {	1126	for (@$data) {
808	my ($name, $args) = @$_;	1127	my ($name, $args) = @$_;
809		1128
810	$obj->attach ($name, %{$args || {} });	1129	$obj->attach ($name, %{$args || {} });
…		…
826	sub object_freezer_save {	1145	sub object_freezer_save {
827	my ($filename, $rdata, $objs) = @_;	1146	my ($filename, $rdata, $objs) = @_;
828		1147
829	sync_job {	1148	sync_job {
830	if (length $$rdata) {	1149	if (length $$rdata) {
		1150	utf8::decode (my $decname = $filename);
831	warn sprintf "saving %s (%d,%d)\n",	1151	warn sprintf "saving %s (%d,%d)\n",
832	$filename, length $$rdata, scalar @$objs;	1152	$decname, length $$rdata, scalar @$objs;
833		1153
834	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1154	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
835	chmod SAVE_MODE, $fh;	1155	aio_chmod $fh, SAVE_MODE;
836	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;
837	aio_fsync $fh;	1159	aio_fsync $fh;
		1160	}
838	close $fh;	1161	aio_close $fh;
839		1162
840	if (@$objs) {	1163	if (@$objs) {
841	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) {
842	chmod SAVE_MODE, $fh;	1165	aio_chmod $fh, SAVE_MODE;
843	my $data = Storable::nfreeze { version => 1, objs => $objs };	1166	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
844	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;
845	aio_fsync $fh;	1170	aio_fsync $fh;
		1171	}
846	close $fh;	1172	aio_close $fh;
847	aio_rename "$filename.pst~", "$filename.pst";	1173	aio_rename "$filename.pst~", "$filename.pst";
848	}	1174	}
849	} else {	1175	} else {
850	aio_unlink "$filename.pst";	1176	aio_unlink "$filename.pst";
851	}	1177	}
852		1178
853	aio_rename "$filename~", $filename;	1179	aio_rename "$filename~", $filename;
		1180
		1181	$filename =~ s%/[^/]+$%%;
		1182	aio_pathsync $filename if $cf::USE_FSYNC;
854	} else {	1183	} else {
855	warn "FATAL: $filename~: $!\n";	1184	warn "unable to save objects: $filename~: $!\n";
856	}	1185	}
857	} else {	1186	} else {
858	aio_unlink $filename;	1187	aio_unlink $filename;
859	aio_unlink "$filename.pst";	1188	aio_unlink "$filename.pst";
860	}	1189	}
861	}	1190	};
862	}	1191	}
863		1192
864	sub object_freezer_as_string {	1193	sub object_freezer_as_string {
865	my ($rdata, $objs) = @_;	1194	my ($rdata, $objs) = @_;
866		1195
…		…
878	or return;	1207	or return;
879		1208
880	unless (aio_stat "$filename.pst") {	1209	unless (aio_stat "$filename.pst") {
881	(aio_load "$filename.pst", $av) >= 0	1210	(aio_load "$filename.pst", $av) >= 0
882	or return;	1211	or return;
		1212
883	$av = eval { (Storable::thaw $av)->{objs} };	1213	my $st = eval { Coro::Storable::thaw $av };
		1214	$av = $st->{objs};
884	}	1215	}
885		1216
		1217	utf8::decode (my $decname = $filename);
886	warn sprintf "loading %s (%d)\n",	1218	warn sprintf "loading %s (%d,%d)\n",
887	$filename, length $data, scalar @{$av || []};#d#	1219	$decname, length $data, scalar @{$av || []};
		1220
888	return ($data, $av);	1221	($data, $av)
889	}	1222	}
		1223
		1224	=head2 COMMAND CALLBACKS
		1225
		1226	=over 4
		1227
		1228	=cut
890		1229
891	#############################################################################	1230	#############################################################################
892	# command handling &c	1231	# command handling &c
893		1232
894	=item cf::register_command $name => \&callback($ob,$args);	1233	=item cf::register_command $name => \&callback($ob,$args);
…		…
907	push @{ $COMMAND{$name} }, [$caller, $cb];	1246	push @{ $COMMAND{$name} }, [$caller, $cb];
908	}	1247	}
909		1248
910	=item cf::register_extcmd $name => \&callback($pl,$packet);	1249	=item cf::register_extcmd $name => \&callback($pl,$packet);
911		1250
912	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.
913		1256
914	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
915	called.	1258	called.
916		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
917	=cut	1271	=cut
918		1272
919	sub register_extcmd {	1273	sub register_extcmd {
920	my ($name, $cb) = @_;	1274	my ($name, $cb) = @_;
921		1275
922	my $caller = caller;
923	#warn "registering extcmd '$name' to '$caller'";
924
925	$EXTCMD{$name} = [$cb, $caller];	1276	$EXTCMD{$name} = $cb;
926	}	1277	}
		1278
		1279	sub register_exticmd {
		1280	my ($name, $cb) = @_;
		1281
		1282	$EXTICMD{$name} = $cb;
		1283	}
		1284
		1285	use File::Glob ();
927		1286
928	cf::player->attach (	1287	cf::player->attach (
929	on_command => sub {	1288	on_command => sub {
930	my ($pl, $name, $params) = @_;	1289	my ($pl, $name, $params) = @_;
931		1290
…		…
939	cf::override;	1298	cf::override;
940	},	1299	},
941	on_extcmd => sub {	1300	on_extcmd => sub {
942	my ($pl, $buf) = @_;	1301	my ($pl, $buf) = @_;
943		1302
944	my $msg = eval { from_json $buf };	1303	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
945		1304
946	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
947	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1313	if (my $cb = $EXTCMD{$type}) {
948	if (my %reply = $cb->[0]->($pl, $msg)) {	1314	@reply = $cb->($pl, @payload);
949	$pl->ext_reply ($msg->{msgid}, %reply);
950	}
951	}	1315	}
		1316
		1317	$pl->ext_reply ($reply, @reply)
		1318	if $reply;
		1319
952	} else {	1320	} else {
953	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1321	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
954	}	1322	}
955		1323
956	cf::override;	1324	cf::override;
957	},	1325	},
958	);	1326	);
959		1327
960	sub register {	1328	# "readahead" all extensions
961	my ($base, $pkg) = @_;	1329	sub cache_extensions {
		1330	my $grp = IO::AIO::aio_group;
962		1331
963	#TODO	1332	add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
964	}	1333	for (grep /\.ext$/, @{$_[0]}) {
		1334	add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
		1335	}
		1336	};
965		1337
		1338	$grp
		1339	}
		1340
966	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($) {
967	my ($path) = @_;	1696	my ($path) = @_;
968		1697
969	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1698	my ($match, $specificity);
970	my $base = $1;
971	my $pkg = $1;
972	$pkg =~ s/[^[:word:]]/_/g;
973	$pkg = "ext::$pkg";
974		1699
975	warn "loading '$path' into '$pkg'\n";	1700	for my $region (list) {
976		1701	if ($region->{match} && $path =~ $region->{match}) {
977	open my $fh, "<:utf8", $path	1702	($match, $specificity) = ($region, $region->specificity)
978	or die "$path: $!";	1703	if $region->specificity > $specificity;
979		1704	}
980	my $source =
981	"package $pkg; use strict; use utf8;\n"
982	. "#line 1 \"$path\"\n{\n"
983	. (do { local $/; <$fh> })
984	. "\n};\n1";
985
986	eval $source
987	or die $@ ? "$path: $@\n"
988	: "extension disabled.\n";
989
990	push @exts, $pkg;
991	$ext_pkg{$base} = $pkg;
992
993	# no strict 'refs';
994	# @{"$pkg\::ISA"} = ext::;
995
996	register $base, $pkg;
997	}
998
999	sub unload_extension {
1000	my ($pkg) = @_;
1001
1002	warn "removing extension $pkg\n";
1003
1004	# remove hooks
1005	#TODO
1006	# for my $idx (0 .. $#PLUGIN_EVENT) {
1007	# delete $hook[$idx]{$pkg};
1008	# }	1705	}
1009		1706
1010	# remove commands	1707	$match
1011	for my $name (keys %COMMAND) {
1012	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1013
1014	if (@cb) {
1015	$COMMAND{$name} = \@cb;
1016	} else {
1017	delete $COMMAND{$name};
1018	}
1019	}
1020
1021	# remove extcmds
1022	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1023	delete $EXTCMD{$name};
1024	}
1025
1026	if (my $cb = $pkg->can ("unload")) {
1027	eval {
1028	$cb->($pkg);
1029	1
1030	} or warn "$pkg unloaded, but with errors: $@";
1031	}
1032
1033	Symbol::delete_package $pkg;
1034	}
1035
1036	sub load_extensions {
1037	for my $ext (<$LIBDIR/*.ext>) {
1038	next unless -r $ext;
1039	eval {
1040	load_extension $ext;
1041	1
1042	} or warn "$ext not loaded: $@";
1043	}
1044	}
1045
1046	#############################################################################
1047	# load/save/clean perl data associated with a map
1048
1049	*cf::mapsupport::on_clean = sub {
1050	my ($map) = @_;
1051
1052	my $path = $map->tmpname;
1053	defined $path or return;
1054
1055	unlink "$path.pst";
1056	};
1057
1058	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1059
1060	#############################################################################
1061	# load/save perl data associated with player->ob objects
1062
1063	sub all_objects(@) {
1064	@_, map all_objects ($_->inv), @_
1065	}
1066
1067	# TODO: compatibility cruft, remove when no longer needed
1068	cf::player->attach (
1069	on_load => sub {
1070	my ($pl, $path) = @_;
1071
1072	for my $o (all_objects $pl->ob) {
1073	if (my $value = $o->get_ob_key_value ("_perl_data")) {
1074	$o->set_ob_key_value ("_perl_data");
1075
1076	%$o = %{ Storable::thaw pack "H*", $value };
1077	}
1078	}
1079	},
1080	);
1081
1082	#############################################################################
1083
1084	=head2 CORE EXTENSIONS
1085
1086	Functions and methods that extend core crossfire objects.
1087
1088	=head3 cf::player
1089
1090	=over 4
1091
1092	=item cf::player::exists $login
1093
1094	Returns true when the given account exists.
1095
1096	=cut
1097
1098	sub cf::player::exists($) {
1099	cf::player::find $_[0]
1100	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1101	}
1102
1103	=item $player->ext_reply ($msgid, $msgtype, %msg)
1104
1105	Sends an ext reply to the player.
1106
1107	=cut
1108
1109	sub cf::player::ext_reply($$$%) {
1110	my ($self, $id, %msg) = @_;
1111
1112	$msg{msgid} = $id;
1113
1114	$self->send ("ext " . to_json \%msg);
1115	}	1708	}
1116		1709
1117	=back	1710	=back
1118
1119		1711
1120	=head3 cf::map	1712	=head3 cf::map
1121		1713
1122	=over 4	1714	=over 4
1123		1715
…		…
1126	package cf::map;	1718	package cf::map;
1127		1719
1128	use Fcntl;	1720	use Fcntl;
1129	use Coro::AIO;	1721	use Coro::AIO;
1130		1722
		1723	use overload
		1724	'""' => \&as_string,
		1725	fallback => 1;
		1726
1131	our $MAX_RESET = 7200;	1727	our $MAX_RESET = 3600;
1132	our $DEFAULT_RESET = 3600;	1728	our $DEFAULT_RESET = 3000;
1133		1729
1134	sub generate_random_map {	1730	sub generate_random_map {
1135	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
1136		1734
1137	# mit "rum" bekleckern, nicht	1735	# mit "rum" bekleckern, nicht
1138	cf::map::_create_random_map	1736	$self->_create_random_map (
1139	$path,
1140	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1737	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1141	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1738	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1142	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1739	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1143	$rmp->{exit_on_final_map},	1740	$rmp->{exit_on_final_map},
1144	$rmp->{xsize}, $rmp->{ysize},	1741	$rmp->{xsize}, $rmp->{ysize},
1145	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1742	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1146	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1743	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1147	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1744	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1148	$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},
1149	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1746	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1150	(cf::region::find $rmp->{region})	1747	(cf::region::find $rmp->{region}), $rmp->{custom}
		1748	)
1151	}	1749	}
1152		1750
1153	# and all this just because we cannot iterate over	1751	=item cf::map->register ($regex, $prio)
1154	# all maps in C++...
1155	sub change_all_map_light {
1156	my ($change) = @_;
1157		1752
1158	$_->change_map_light ($change) for values %cf::MAP;	1753	Register a handler for the map path matching the given regex at the
1159	}	1754	givne priority (higher is better, built-in handlers have priority 0, the
		1755	default).
1160		1756
1161	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 {
1162	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) = @_;
1163		1896
1164	utf8::encode $path;	1897	utf8::encode $path;
1165	aio_open $path, O_RDONLY, 0	1898	my $f = new_from_file cf::object::thawer $path
1166	or return;	1899	or return;
1167		1900
1168	my $map = cf::map::new	1901	$self->_load_header ($f)
1169	or return;	1902	or return;
1170		1903
1171	$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
1172	or return;	1950	or return;
		1951	$self->prepare_orig;
		1952	}
1173		1953
1174	$map->{load_path} = $path;	1954	$self->{deny_reset} = 1
		1955	if $self->no_reset;
1175		1956
1176	$map	1957	$self->default_region (cf::region::find_by_path $self->{path})
1177	}	1958	unless $self->default_region;
1178		1959
		1960	1
		1961	}
		1962
		1963	sub find;
1179	sub find_map {	1964	sub find {
1180	my ($path, $origin) = @_;	1965	my ($path, $origin) = @_;
1181		1966
1182	#warn "find_map<$path,$origin>\n";#d#
1183
1184	$path = new cf::path $path, $origin && $origin->path;	1967	$path = normalise $path, $origin && $origin->path;
1185	my $key = $path->as_string;
1186		1968
1187	cf::lock_wait "map_find:$key";	1969	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1188
1189	$cf::MAP{$key} || do {
1190	my $guard = cf::lock_acquire "map_find:$key";	1970	my $guard2 = cf::lock_acquire "map_find:$path";
1191		1971
1192	# do it the slow way	1972	$cf::MAP{$path} || do {
1193	my $map = try_load_header $path->save_path;	1973	my $map = new_from_path cf::map $path
1194
1195	if ($map) {
1196	# safety
1197	$map->{instantiate_time} = $cf::RUNTIME
1198	if $map->{instantiate_time} > $cf::RUNTIME;
1199	} else {
1200	if (my $rmp = $path->random_map_params) {
1201	$map = generate_random_map $key, $rmp;
1202	} else {
1203	$map = try_load_header $path->load_path;
1204	}
1205
1206	$map or return;	1974	or return;
1207		1975
1208	$map->{load_original} = 1;
1209	$map->{instantiate_time} = $cf::RUNTIME;
1210	$map->instantiate;
1211
1212	# per-player maps become, after loading, normal maps
1213	$map->per_player (0) if $path->{user_rel};
1214	}
1215	#Coro::Timer::sleep 1;#d#
1216
1217	$map->path ($key);
1218	$map->{path} = $path;
1219	$map->{last_save} = $cf::RUNTIME;	1976	$map->{last_save} = $cf::RUNTIME;
1220	$map->last_access ($cf::RUNTIME);
1221		1977
1222	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;
1223	$map->reset;	1986	$map->reset;
1224	$map = find_map $path;	1987	return find $path;
1225	}	1988	}
1226		1989
1227	$cf::MAP{$key} = $map	1990	$cf::MAP{$path} = $map
1228	}	1991	}
1229	}	1992	}
		1993
		1994	sub pre_load { }
		1995	sub post_load { }
1230		1996
1231	sub load {	1997	sub load {
1232	my ($self) = @_;	1998	my ($self) = @_;
1233		1999
		2000	local $self->{deny_reset} = 1; # loading can take a long time
		2001
1234	my $path = $self->{path};	2002	my $path = $self->{path};
		2003
		2004	{
1235	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	2005	my $guard = cf::lock_acquire "map_data:$path";
1236		2006
		2007	return unless $self->valid;
1237	return if $self->in_memory != cf::MAP_SWAPPED;	2008	return unless $self->in_memory == cf::MAP_SWAPPED;
1238		2009
1239	$self->in_memory (cf::MAP_LOADING);	2010	$self->in_memory (cf::MAP_LOADING);
1240		2011
1241	$self->alloc;	2012	$self->alloc;
1242	$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)
1243	or return;	2020	or return;
1244		2021
1245	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2022	$self->post_load_original
1246	if delete $self->{load_original};	2023	if delete $self->{load_original};
1247		2024
1248	if (my $uniq = $path->uniq_path) {	2025	if (my $uniq = $self->uniq_path) {
1249	utf8::encode $uniq;	2026	utf8::encode $uniq;
1250	if (aio_open $uniq, O_RDONLY, 0) {	2027	unless (aio_stat $uniq) {
		2028	if (my $f = new_from_file cf::object::thawer $uniq) {
1251	$self->clear_unique_items;	2029	$self->clear_unique_items;
1252	$self->load_objects ($uniq, 0);	2030	$self->_load_objects ($f);
		2031	$f->resolve_delayed_derefs;
		2032	}
1253	}	2033	}
1254	}	2034	}
1255		2035
		2036	$f->resolve_delayed_derefs;
		2037
		2038	cf::cede_to_tick;
1256	# now do the right thing for maps	2039	# now do the right thing for maps
1257	$self->link_multipart_objects;	2040	$self->link_multipart_objects;
1258
1259	if ($self->{path}->is_style_map) {
1260	$self->{deny_save} = 1;
1261	$self->{deny_reset} = 1;
1262	} else {
1263	$self->fix_auto_apply;
1264	$self->decay_objects;
1265	$self->update_buttons;
1266	$self->set_darkness_map;
1267	$self->difficulty ($self->estimate_difficulty)	2041	$self->difficulty ($self->estimate_difficulty)
1268	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;
1269	$self->activate;	2050	$self->activate;
1270	}	2051	}
1271		2052
		2053	$self->{last_save} = $cf::RUNTIME;
		2054	$self->last_access ($cf::RUNTIME);
		2055
1272	$self->in_memory (cf::MAP_IN_MEMORY);	2056	$self->in_memory (cf::MAP_ACTIVE);
1273	}	2057	}
1274		2058
1275	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 {
1276	my ($path, $origin) = @_;	2101	my ($path, $origin) = @_;
1277		2102
1278	#warn "load_map_sync<$path, $origin>\n";#d#	2103	cf::sync_job { find $path, $origin }
		2104	}
1279		2105
1280	cf::sync_job {	2106	sub do_load_sync {
1281	my $map = cf::map::find_map $path, $origin	2107	my ($map) = @_;
1282	or return;	2108
1283	$map->load;	2109	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1284	$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;
1285	}	2142	};
		2143	$MAP_PREFETCHER->prio (6);
		2144
		2145	()
1286	}	2146	}
1287		2147
1288	sub save {	2148	sub save {
1289	my ($self) = @_;	2149	my ($self) = @_;
1290		2150
		2151	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2152
1291	$self->{last_save} = $cf::RUNTIME;	2153	$self->{last_save} = $cf::RUNTIME;
1292		2154
1293	return unless $self->dirty;	2155	return unless $self->dirty;
1294		2156
1295	my $save = $self->{path}->save_path; utf8::encode $save;	2157	my $save = $self->save_path; utf8::encode $save;
1296	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	2158	my $uniq = $self->uniq_path; utf8::encode $uniq;
1297		2159
1298	$self->{load_path} = $save;	2160	$self->{load_path} = $save;
1299		2161
1300	return if $self->{deny_save};	2162	return if $self->{deny_save};
1301		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
1302	if ($uniq) {	2173	if ($uniq) {
1303	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2174	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1304	$self->save_objects ($uniq, cf::IO_UNIQUES);	2175	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1305	} else {	2176	} else {
1306	$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);
1307	}	2178	}
1308	}	2179	}
1309		2180
1310	sub swap_out {	2181	sub swap_out {
1311	my ($self) = @_;	2182	my ($self) = @_;
1312		2183
		2184	# save first because save cedes
		2185	$self->save;
		2186
		2187	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2188
1313	return if $self->players;	2189	return if $self->players;
1314	return if $self->in_memory != cf::MAP_IN_MEMORY;	2190	return if $self->in_memory != cf::MAP_ACTIVE;
1315	return if $self->{deny_save};	2191	return if $self->{deny_save};
1316		2192
		2193	$self->in_memory (cf::MAP_SWAPPED);
		2194
1317	$self->save;	2195	$self->deactivate;
		2196	$_->clear_links_to ($self) for values %cf::MAP;
1318	$self->clear;	2197	$self->clear;
1319	$self->in_memory (cf::MAP_SWAPPED);
1320	}	2198	}
1321		2199
1322	sub reset_at {	2200	sub reset_at {
1323	my ($self) = @_;	2201	my ($self) = @_;
1324		2202
1325	# TODO: safety, remove and allow resettable per-player maps	2203	# TODO: safety, remove and allow resettable per-player maps
1326	return 1e99 if $self->{path}{user_rel};
1327	return 1e99 if $self->{deny_reset};	2204	return 1e99 if $self->{deny_reset};
1328		2205
1329	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2206	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1330	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;
1331		2208
…		…
1336	my ($self) = @_;	2213	my ($self) = @_;
1337		2214
1338	$self->reset_at <= $cf::RUNTIME	2215	$self->reset_at <= $cf::RUNTIME
1339	}	2216	}
1340		2217
1341	sub unlink_save {
1342	my ($self) = @_;
1343
1344	utf8::encode (my $save = $self->{path}->save_path);
1345	aioreq_pri 3; IO::AIO::aio_unlink $save;
1346	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1347	}
1348
1349	sub rename {
1350	my ($self, $new_path) = @_;
1351
1352	$self->unlink_save;
1353
1354	delete $cf::MAP{$self->path};
1355	$self->{path} = new cf::path $new_path;
1356	$self->path ($self->{path}->as_string);
1357	$cf::MAP{$self->path} = $self;
1358
1359	$self->save;
1360	}
1361
1362	sub reset {	2218	sub reset {
1363	my ($self) = @_;	2219	my ($self) = @_;
1364		2220
		2221	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2222
1365	return if $self->players;	2223	return if $self->players;
1366	return if $self->{path}{user_rel};#d#
1367		2224
1368	warn "resetting map ", $self->path;#d#	2225	warn "resetting map ", $self->path, "\n";
		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	}
1369		2236
1370	delete $cf::MAP{$self->path};	2237	delete $cf::MAP{$self->path};
1371		2238
		2239	$self->deactivate;
1372	$_->clear_links_to ($self) for values %cf::MAP;	2240	$_->clear_links_to ($self) for values %cf::MAP;
		2241	$self->clear;
1373		2242
1374	$self->unlink_save;	2243	$self->unlink_save;
1375	$self->destroy;	2244	$self->destroy;
1376	}	2245	}
1377		2246
1378	my $nuke_counter = "aaaa";	2247	my $nuke_counter = "aaaa";
1379		2248
1380	sub nuke {	2249	sub nuke {
1381	my ($self) = @_;	2250	my ($self) = @_;
1382		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};
1383	$self->{deny_save} = 1;	2261	$self->{deny_save} = 1;
1384	$self->reset_timeout (1);	2262	$self->reset_timeout (1);
1385	$self->rename ("{nuke}/" . ($nuke_counter++));	2263	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2264
		2265	$cf::MAP{$self->path} = $self;
		2266	}
		2267
1386	$self->reset; # polite request, might not happen	2268	$self->reset; # polite request, might not happen
1387	}	2269	}
1388		2270
1389	sub customise_for {	2271	=item $maps = cf::map::tmp_maps
1390	my ($map, $ob) = @_;
1391		2272
1392	if ($map->per_player) {	2273	Returns an arrayref with all map paths of currently instantiated and saved
1393	return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path};	2274	maps. May block.
		2275
		2276	=cut
		2277
		2278	sub tmp_maps() {
1394	}	2279	[
1395		2280	map {
1396	$map	2281	utf8::decode $_;
		2282	/\.map$/
		2283	? normalise $_
		2284	: ()
		2285	} @{ aio_readdir $TMPDIR or [] }
		2286	]
1397	}	2287	}
1398		2288
1399	sub emergency_save {	2289	=item $maps = cf::map::random_maps
1400	local $cf::FREEZE = 1;
1401		2290
1402	warn "enter emergency map save\n";	2291	Returns an arrayref with all map paths of currently instantiated and saved
		2292	random maps. May block.
1403		2293
1404	cf::sync_job {	2294	=cut
1405	warn "begin emergency map save\n";	2295
1406	$_->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
1407	};	2377	}
1408
1409	warn "end emergency map save\n";
1410	}	2378	}
1411		2379
1412	package cf;	2380	package cf;
1413		2381
1414	=back	2382	=back
1415
1416		2383
1417	=head3 cf::object::player	2384	=head3 cf::object::player
1418		2385
1419	=over 4	2386	=over 4
1420		2387
…		…
1423	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>
1424	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
1425	dialogue with the given NPC character.	2392	dialogue with the given NPC character.
1426		2393
1427	=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	};
1428		2409
1429	# rough implementation of a future "reply" method that works	2410	# rough implementation of a future "reply" method that works
1430	# with dialog boxes.	2411	# with dialog boxes.
1431	#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
1432	sub cf::object::player::reply($$$;$) {	2413	sub cf::object::player::reply($$$;$) {
…		…
1434		2415
1435	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2416	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1436		2417
1437	if ($self->{record_replies}) {	2418	if ($self->{record_replies}) {
1438	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2419	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2420
1439	} 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 {
1440	$msg = $npc->name . " says: $msg" if $npc;	2429	$msg = $npc->name . " says: $msg" if $npc;
1441	$self->message ($msg, $flags);	2430	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2431	}
1442	}	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 (@_);
1443	}	2443	}
1444		2444
1445	=item $player_object->may ("access")	2445	=item $player_object->may ("access")
1446		2446
1447	Returns wether the given player is authorized to access resource "access"	2447	Returns wether the given player is authorized to access resource "access"
…		…
1460		2460
1461	=item $player_object->enter_link	2461	=item $player_object->enter_link
1462		2462
1463	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}>).
1464		2464
1465	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.
1466	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.
1467		2471
1468	=item $player_object->leave_link ($map, $x, $y)	2472	=item $player_object->leave_link ($map, $x, $y)
1469		2473
1470	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
1471	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
1472	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
1473	to the emergency map position.	2477	fails, to the emergency map position.
1474		2478
1475	Might block.	2479	Might block.
1476		2480
1477	=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	}
1478		2492
1479	sub cf::object::player::enter_link {	2493	sub cf::object::player::enter_link {
1480	my ($self) = @_;	2494	my ($self) = @_;
1481		2495
1482	$self->deactivate_recursive;	2496	$self->deactivate_recursive;
1483		2497
1484	return if $self->map == $LINK_MAP;	2498	return if UNIVERSAL::isa $self->map, "ext::map_link";
1485		2499
1486	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2500	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1487	if $self->map;	2501	if $self->map && $self->map->{path} ne "{link}";
1488		2502
1489	$self->enter_map ($LINK_MAP, 20, 20);	2503	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1490	}	2504	}
1491		2505
1492	sub cf::object::player::leave_link {	2506	sub cf::object::player::leave_link {
1493	my ($self, $map, $x, $y) = @_;	2507	my ($self, $map, $x, $y) = @_;
		2508
		2509	return unless $self->contr->active;
1494		2510
1495	my $link_pos = delete $self->{_link_pos};	2511	my $link_pos = delete $self->{_link_pos};
1496		2512
1497	unless ($map) {	2513	unless ($map) {
1498	# restore original map position	2514	# restore original map position
1499	($map, $x, $y) = @{ $link_pos || [] };	2515	($map, $x, $y) = @{ $link_pos || [] };
1500	$map = cf::map::find_map $map;	2516	$map = cf::map::find $map;
1501		2517
1502	unless ($map) {	2518	unless ($map) {
1503	($map, $x, $y) = @$EMERGENCY_POSITION;	2519	($map, $x, $y) = @$EMERGENCY_POSITION;
1504	$map = cf::map::find_map $map	2520	$map = cf::map::find $map
1505	or die "FATAL: cannot load emergency map\n";	2521	or die "FATAL: cannot load emergency map\n";
1506	}	2522	}
1507	}	2523	}
1508		2524
1509	($x, $y) = (-1, -1)	2525	($x, $y) = (-1, -1)
…		…
1512	# use -1 or undef as default coordinates, not 0, 0	2528	# use -1 or undef as default coordinates, not 0, 0
1513	($x, $y) = ($map->enter_x, $map->enter_y)	2529	($x, $y) = ($map->enter_x, $map->enter_y)
1514	if $x <=0 && $y <= 0;	2530	if $x <=0 && $y <= 0;
1515		2531
1516	$map->load;	2532	$map->load;
		2533	$map->load_neighbours;
1517		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
1518	$self->activate_recursive;	2541	$self->activate_recursive;
1519	$self->enter_map ($map, $x, $y);
1520	}	2542	}
1521		2543
1522	cf::player->attach (	2544	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1523	on_logout => sub {
1524	my ($pl) = @_;
1525		2545
1526	# abort map switching before logout	2546	Moves the player to the given map-path and coordinates by first freezing
1527	if ($pl->ob->{_link_pos}) {	2547	her, loading and preparing them map, calling the provided $check callback
1528	cf::sync_job {	2548	that has to return the map if sucecssful, and then unfreezes the player on
1529	$pl->ob->leave_link	2549	the new (success) or old (failed) map position. In either case, $done will
1530	};	2550	be called at the end of this process.
1531	}
1532	},
1533	on_login => sub {
1534	my ($pl) = @_;
1535		2551
1536	# try to abort aborted map switching on player login :)	2552	Note that $check will be called with a potentially non-loaded map, so if
1537	# should happen only on crashes	2553	it needs a loaded map it has to call C<< ->load >>.
1538	if ($pl->ob->{_link_pos}) {
1539	$pl->ob->enter_link;
1540	Coro::async {
1541	# we need this sleep as the login has a concurrent enter_exit running
1542	# and this sleep increases chances of the player not ending up in scorn
1543	Coro::Timer::sleep 1;
1544	$pl->ob->leave_link;
1545	};
1546	}
1547	},
1548	);
1549		2554
1550	=item $player_object->goto_map ($path, $x, $y)
1551
1552	=cut	2555	=cut
1553		2556
		2557	our $GOTOGEN;
		2558
1554	sub cf::object::player::goto_map {	2559	sub cf::object::player::goto {
1555	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;
1556		2564
1557	$self->enter_link;	2565	$self->enter_link;
1558		2566
1559	(Coro::async {	2567	(async {
1560	$path = new cf::path $path;	2568	$Coro::current->{desc} = "player::goto $path $x $y";
1561		2569
1562	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) {
1563	$map = $map->customise_for ($self) if $map;	2593	$map = $map->customise_for ($self);
1564		2594	$map = $check->($map) if $check && $map;
1565	# warn "entering ", $map->path, " at ($x, $y)\n"	2595	} else {
1566	# if $map;
1567
1568	$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	}
1569		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};
1570	$self->leave_link ($map, $x, $y);	2609	$self->leave_link ($map, $x, $y);
		2610	}
		2611
		2612	$done->() if $done;
1571	})->prio (1);	2613	})->prio (1);
1572	}	2614	}
1573		2615
1574	=item $player_object->enter_exit ($exit_object)	2616	=item $player_object->enter_exit ($exit_object)
1575		2617
…		…
1577		2619
1578	sub parse_random_map_params {	2620	sub parse_random_map_params {
1579	my ($spec) = @_;	2621	my ($spec) = @_;
1580		2622
1581	my $rmp = { # defaults	2623	my $rmp = { # defaults
1582	xsize => 10,	2624	xsize => (cf::rndm 15, 40),
1583	ysize => 10,	2625	ysize => (cf::rndm 15, 40),
		2626	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2627	#layout => string,
1584	};	2628	};
1585		2629
1586	for (split /\n/, $spec) {	2630	for (split /\n/, $spec) {
1587	my ($k, $v) = split /\s+/, $_, 2;	2631	my ($k, $v) = split /\s+/, $_, 2;
1588		2632
…		…
1600	# that depends on the exit object	2644	# that depends on the exit object
1601		2645
1602	my $rmp = parse_random_map_params $exit->msg;	2646	my $rmp = parse_random_map_params $exit->msg;
1603		2647
1604	if ($exit->map) {	2648	if ($exit->map) {
1605	$rmp->{region} = $exit->map->region_name;	2649	$rmp->{region} = $exit->region->name;
1606	$rmp->{origin_map} = $exit->map->path;	2650	$rmp->{origin_map} = $exit->map->path;
1607	$rmp->{origin_x} = $exit->x;	2651	$rmp->{origin_x} = $exit->x;
1608	$rmp->{origin_y} = $exit->y;	2652	$rmp->{origin_y} = $exit->y;
		2653
		2654	$exit->map->touch;
1609	}	2655	}
1610		2656
1611	$rmp->{random_seed} ||= $exit->random_seed;	2657	$rmp->{random_seed} ||= $exit->random_seed;
1612		2658
1613	my $data = cf::to_json $rmp;	2659	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1614	my $md5 = Digest::MD5::md5_hex $data;	2660	my $md5 = Digest::MD5::md5_hex $data;
		2661	my $meta = "$RANDOMDIR/$md5.meta";
1615		2662
1616	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) {
1617	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;
1618		2667
		2668	my $slaying = "?random/$md5";
		2669
		2670	if ($exit->valid) {
1619	$exit->slaying ("?random/$md5");	2671	$exit->slaying ("?random/$md5");
1620	$exit->msg (undef);	2672	$exit->msg (undef);
		2673	}
1621	}	2674	}
1622	}	2675	}
1623		2676
1624	sub cf::object::player::enter_exit {	2677	sub cf::object::player::enter_exit {
1625	my ($self, $exit) = @_;	2678	my ($self, $exit) = @_;
1626		2679
1627	return unless $self->type == cf::PLAYER;	2680	return unless $self->type == cf::PLAYER;
1628		2681
1629	$self->enter_link;	2682	$self->enter_link;
1630		2683
1631	(Coro::async {	2684	(async {
		2685	$Coro::current->{desc} = "enter_exit";
		2686
1632	unless (eval {	2687	unless (eval {
		2688	$self->deactivate_recursive; # just to be sure
1633		2689
		2690	# random map handling
		2691	{
		2692	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2693
1634	prepare_random_map $exit	2694	prepare_random_map $exit
1635	if $exit->slaying eq "/!";	2695	if $exit->slaying eq "/!";
		2696	}
1636		2697
1637	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;
1638	$self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);	2699	my $x = $exit->stats->hp;
		2700	my $y = $exit->stats->sp;
1639		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
1640	1;	2708	1
1641	}) {	2709	}) {
1642	$self->message ("Something went wrong deep within the crossfire server. "	2710	$self->message ("Something went wrong deep within the deliantra server. "
1643	. "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. "
1644	. "Please report this to the dungeon master",	2712	. "Please report this to the dungeon master!",
1645	cf::NDI_UNIQUE | cf::NDI_RED);	2713	cf::NDI_UNIQUE | cf::NDI_RED);
1646		2714
1647	warn "ERROR in enter_exit: $@";	2715	warn "ERROR in enter_exit: $@";
1648	$self->leave_link;	2716	$self->leave_link;
1649	}	2717	}
1650	})->prio (1);	2718	})->prio (1);
…		…
1663		2731
1664	sub cf::client::send_drawinfo {	2732	sub cf::client::send_drawinfo {
1665	my ($self, $text, $flags) = @_;	2733	my ($self, $text, $flags) = @_;
1666		2734
1667	utf8::encode $text;	2735	utf8::encode $text;
1668	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2736	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1669	}	2737	}
1670		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	}
1671		2933
1672	=item $success = $client->query ($flags, "text", \&cb)	2934	=item $success = $client->query ($flags, "text", \&cb)
1673		2935
1674	Queues a query to the client, calling the given callback with	2936	Queues a query to the client, calling the given callback with
1675	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>,
1676	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>.
1677		2939
1678	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
1679	reliable at some point in the future.	2941	become reliable at some point in the future.
1680		2942
1681	=cut	2943	=cut
1682		2944
1683	sub cf::client::query {	2945	sub cf::client::query {
1684	my ($self, $flags, $text, $cb) = @_;	2946	my ($self, $flags, $text, $cb) = @_;
…		…
1692	utf8::encode $text;	2954	utf8::encode $text;
1693	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2955	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1694		2956
1695	$self->send_packet ($self->{query_queue}[0][0])	2957	$self->send_packet ($self->{query_queue}[0][0])
1696	if @{ $self->{query_queue} } == 1;	2958	if @{ $self->{query_queue} } == 1;
		2959
		2960	1
1697	}	2961	}
1698		2962
1699	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	},
1700	on_reply => sub {	2969	on_reply => sub {
1701	my ($ns, $msg) = @_;	2970	my ($ns, $msg) = @_;
1702		2971
1703	# this weird shuffling is so that direct followup queries	2972	# this weird shuffling is so that direct followup queries
1704	# get handled first	2973	# get handled first
1705	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
1706		2976
1707	(shift @$queue)->[1]->($msg);	2977	(shift @$queue)->[1]->($msg);
		2978	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1708		2979
1709	push @{ $ns->{query_queue} }, @$queue;	2980	push @{ $ns->{query_queue} }, @$queue;
1710		2981
1711	if (@{ $ns->{query_queue} } == @$queue) {	2982	if (@{ $ns->{query_queue} } == @$queue) {
1712	if (@$queue) {	2983	if (@$queue) {
…		…
1714	} else {	2985	} else {
1715	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2986	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1716	}	2987	}
1717	}	2988	}
1718	},	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	},
1719	);	3016	);
1720		3017
1721	=item $client->coro (\&cb)	3018	=item $client->async (\&cb)
1722		3019
1723	Create a new coroutine, running the specified callback. The coroutine will	3020	Create a new coroutine, running the specified callback. The coroutine will
1724	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,
1725	or loss of connection).	3022	or loss of connection).
1726		3023
1727	=cut	3024	=cut
1728		3025
1729	sub cf::client::coro {	3026	sub cf::client::async {
1730	my ($self, $cb) = @_;	3027	my ($self, $cb) = @_;
1731		3028
1732	my $coro; $coro = async {	3029	my $coro = &Coro::async ($cb);
1733	eval {
1734	$cb->();
1735	};
1736	warn $@ if $@;
1737	};
1738		3030
1739	$coro->on_destroy (sub {	3031	$coro->on_destroy (sub {
1740	delete $self->{_coro}{$coro+0};	3032	delete $self->{_coro}{$coro+0};
1741	});	3033	});
1742		3034
…		…
1769	our $safe = new Safe "safe";	3061	our $safe = new Safe "safe";
1770	our $safe_hole = new Safe::Hole;	3062	our $safe_hole = new Safe::Hole;
1771		3063
1772	$SIG{FPE} = 'IGNORE';	3064	$SIG{FPE} = 'IGNORE';
1773		3065
1774	$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	));
1775		3071
1776	# here we export the classes and methods available to script code	3072	# here we export the classes and methods available to script code
1777		3073
1778	=pod	3074	=pod
1779		3075
1780	The following fucntions and emthods are available within a safe environment:	3076	The following functions and methods are available within a safe environment:
1781		3077
1782	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
1783	cf::object::player player	3083	cf::object::player
1784	cf::player peaceful	3084	player
1785	cf::map trigger	3085
		3086	cf::player
		3087	peaceful
		3088
		3089	cf::map
		3090	trigger
1786		3091
1787	=cut	3092	=cut
1788		3093
1789	for (	3094	for (
1790	["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)],
1791	["cf::object::player" => qw(player)],	3098	["cf::object::player" => qw(player)],
1792	["cf::player" => qw(peaceful)],	3099	["cf::player" => qw(peaceful send_msg)],
1793	["cf::map" => qw(trigger)],	3100	["cf::map" => qw(trigger)],
1794	) {	3101	) {
1795	no strict 'refs';	3102	no strict 'refs';
1796	my ($pkg, @funs) = @$_;	3103	my ($pkg, @funs) = @$_;
1797	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3104	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
…		…
1814	my ($code, %vars) = @_;	3121	my ($code, %vars) = @_;
1815		3122
1816	my $qcode = $code;	3123	my $qcode = $code;
1817	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3124	$qcode =~ s/"/‟/g; # not allowed in #line filenames
1818	$qcode =~ s/\n/\\n/g;	3125	$qcode =~ s/\n/\\n/g;
		3126
		3127	%vars = (_dummy => 0) unless %vars;
1819		3128
1820	local $_;	3129	local $_;
1821	local @safe::cf::_safe_eval_args = values %vars;	3130	local @safe::cf::_safe_eval_args = values %vars;
1822		3131
1823	my $eval =	3132	my $eval =
…		…
1866	=back	3175	=back
1867		3176
1868	=cut	3177	=cut
1869		3178
1870	#############################################################################	3179	#############################################################################
		3180	# the server's init and main functions
1871		3181
1872	=head2 EXTENSION DATABASE SUPPORT	3182	sub load_facedata($) {
		3183	my ($path) = @_;
1873		3184
1874	Crossfire maintains a very simple database for extension use. It can	3185	# HACK to clear player env face cache, we need some signal framework
1875	currently store anything that can be serialised using Storable, which	3186	# for this (global event?)
1876	excludes objects.	3187	%ext::player_env::MUSIC_FACE_CACHE = ();
1877		3188
1878	The parameter C<$family> should best start with the name of the extension	3189	my $enc = JSON::XS->new->utf8->canonical->relaxed;
1879	using it, it should be unique.
1880		3190
1881	=over 4	3191	warn "loading facedata from $path\n";
1882		3192
1883	=item $hashref = cf::db_get $family	3193	my $facedata;
		3194	0 < aio_load $path, $facedata
		3195	or die "$path: $!";
1884		3196
1885	Return a hashref for use by the extension C<$family>, which can be	3197	$facedata = Coro::Storable::thaw $facedata;
1886	modified. After modifications, you have to call C<cf::db_dirty> or
1887	C<cf::db_sync>.
1888		3198
1889	=item $value = cf::db_get $family => $key	3199	$facedata->{version} == 2
		3200	or cf::cleanup "$path: version mismatch, cannot proceed.";
1890		3201
1891	Returns a single value from the database	3202	# patch in the exptable
1892		3203	$facedata->{resource}{"res/exp_table"} = {
1893	=item cf::db_put $family => $hashref	3204	type => FT_RSRC,
1894		3205	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1895	Stores the given family hashref into the database. Updates are delayed, if
1896	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1897
1898	=item cf::db_put $family => $key => $value
1899
1900	Stores the given C<$value> in the family hash. Updates are delayed, if you
1901	want the data to be synced to disk immediately, use C<cf::db_sync>.
1902
1903	=item cf::db_dirty
1904
1905	Marks the database as dirty, to be updated at a later time.
1906
1907	=item cf::db_sync
1908
1909	Immediately write the database to disk I<if it is dirty>.
1910
1911	=cut
1912
1913	our $DB;
1914
1915	{
1916	my $path = cf::localdir . "/database.pst";
1917
1918	sub db_load() {
1919	warn "loading database $path\n";#d# remove later
1920	$DB = stat $path ? Storable::retrieve $path : { };
1921	}
1922
1923	my $pid;
1924
1925	sub db_save() {
1926	warn "saving database $path\n";#d# remove later
1927	waitpid $pid, 0 if $pid;
1928	if (0 == ($pid = fork)) {
1929	$DB->{_meta}{version} = 1;
1930	Storable::nstore $DB, "$path~";
1931	rename "$path~", $path;
1932	cf::_exit 0 if defined $pid;
1933	}
1934	}
1935
1936	my $dirty;
1937
1938	sub db_sync() {
1939	db_save if $dirty;
1940	undef $dirty;
1941	}
1942
1943	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1944	db_sync;
1945	});	3206	};
		3207	cf::cede_to_tick;
1946		3208
1947	sub db_dirty() {
1948	$dirty = 1;
1949	$idle->start;
1950	}	3209	{
		3210	my $faces = $facedata->{faceinfo};
1951		3211
1952	sub db_get($;$) {	3212	while (my ($face, $info) = each %$faces) {
1953	@_ >= 2	3213	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1954	? $DB->{$_[0]}{$_[1]}
1955	: ($DB->{$_[0]} ||= { })
1956	}
1957		3214
1958	sub db_put($$;$) {	3215	cf::face::set_visibility $idx, $info->{visibility};
1959	if (@_ >= 3) {	3216	cf::face::set_magicmap $idx, $info->{magicmap};
1960	$DB->{$_[0]}{$_[1]} = $_[2];	3217	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
1961	} else {	3218	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1962	$DB->{$_[0]} = $_[1];
1963	}
1964	db_dirty;
1965	}
1966		3219
1967	cf::global->attach (	3220	cf::cede_to_tick;
1968	prio => 10000,
1969	on_cleanup => sub {
1970	db_sync;
1971	},	3221	}
1972	);
1973	}
1974		3222
1975	#############################################################################	3223	while (my ($face, $info) = each %$faces) {
1976	# the server's main()	3224	next unless $info->{smooth};
1977		3225
1978	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 {
1979	open my $fh, "<:utf8", cf::confdir . "/config"	3368	open my $fh, "<:utf8", "$CONFDIR/config"
1980	or return;	3369	or return;
1981		3370
1982	local $/;	3371	local $/;
1983	*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;
1984	}	3414	}
1985		3415
1986	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
1987	# we must not ever block the main coroutine	3431	# we must not ever block the main coroutine
1988	local $Coro::idle = sub {	3432	local $Coro::idle = sub {
1989	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#
1990	(Coro::unblock_sub {	3434	(async {
1991	Event::one_event;	3435	$Coro::current->{desc} = "IDLE BUG HANDLER";
1992	})->();	3436	EV::loop EV::LOOP_ONESHOT;
		3437	})->prio (Coro::PRIO_MAX);
1993	};	3438	};
1994		3439
1995	cfg_load;	3440	evthread_start IO::AIO::poll_fileno;
1996	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
1997	load_extensions;	3458	load_extensions;
1998	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;
1999	}	3470	}
2000		3471
2001	#############################################################################	3472	#############################################################################
2002	# initialisation	3473	# initialisation and cleanup
2003		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
2004	sub reload() {	3655	sub do_reload_perl() {
2005	# can/must only be called in main	3656	# can/must only be called in main
2006	if ($Coro::current != $Coro::main) {	3657	if ($Coro::current != $Coro::main) {
2007	warn "can only reload from main coroutine\n";	3658	warn "can only reload from main coroutine";
2008	return;	3659	return;
2009	}	3660	}
2010		3661
		3662	return if $RELOAD++;
		3663
		3664	my $t1 = EV::time;
		3665
		3666	while ($RELOAD) {
2011	warn "reloading...";	3667	warn "reloading...";
2012		3668
2013	local $FREEZE = 1;	3669	warn "entering sync_job";
		3670
		3671	cf::sync_job {
		3672	cf::write_runtime_sync; # external watchdog should not bark
2014	cf::emergency_save;	3673	cf::emergency_save;
		3674	cf::write_runtime_sync; # external watchdog should not bark
2015		3675
2016	eval {	3676	warn "syncing database to disk";
		3677	BDB::db_env_txn_checkpoint $DB_ENV;
		3678
2017	# 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
2018		3680
2019	# cancel all watchers	3681	warn "flushing outstanding aio requests";
2020	for (Event::all_watchers) {	3682	while (IO::AIO::nreqs || BDB::nreqs) {
2021	$_->cancel if $_->data & WF_AUTOCANCEL;	3683	Coro::EV::timer_once 0.01; # let the sync_job do it's thing
2022	}
2023
2024	# cancel all extension coros
2025	$_->cancel for values %EXT_CORO;
2026	%EXT_CORO = ();
2027
2028	# unload all extensions
2029	for (@exts) {
2030	warn "unloading <$_>";
2031	unload_extension $_;
2032	}
2033
2034	# unload all modules loaded from $LIBDIR
2035	while (my ($k, $v) = each %INC) {
2036	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2037
2038	warn "removing <$k>";
2039	delete $INC{$k};
2040
2041	$k =~ s/\.pm$//;
2042	$k =~ s/\//::/g;
2043
2044	if (my $cb = $k->can ("unload_module")) {
2045	$cb->();
2046	}	3684	}
2047		3685
2048	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;
2049	}	3710	}
2050		3711
2051	# sync database to disk	3712	warn "unloading all perl modules loaded from $LIBDIR";
2052	cf::db_sync;	3713	while (my ($k, $v) = each %INC) {
2053	IO::AIO::flush;	3714	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2054		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
2055	# get rid of safe::, as good as possible	3729	warn "getting rid of safe::, as good as possible";
2056	Symbol::delete_package "safe::$_"	3730	clear_package "safe::$_"
2057	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);
2058		3732
2059	# remove register_script_function callbacks	3733	warn "unloading cf.pm \"a bit\"";
2060	# TODO
2061
2062	# unload cf.pm "a bit"
2063	delete $INC{"cf.pm"};	3734	delete $INC{"cf.pm"};
		3735	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2064		3736
2065	# don't, removes xs symbols, too,	3737	# don't, removes xs symbols, too,
2066	# and global variables created in xs	3738	# and global variables created in xs
2067	#Symbol::delete_package __PACKAGE__;	3739	#clear_package __PACKAGE__;
2068		3740
2069	# reload cf.pm	3741	warn "unload completed, starting to reload now";
		3742
2070	warn "reloading cf.pm";	3743	warn "reloading cf.pm";
2071	require cf;	3744	require cf;
2072	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3745	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2073		3746
2074	# load config and database again	3747	warn "loading config and database again";
2075	cf::cfg_load;	3748	cf::reload_config;
2076	cf::db_load;
2077		3749
2078	# load extensions
2079	warn "load extensions";	3750	warn "loading extensions";
2080	cf::load_extensions;	3751	cf::load_extensions;
2081		3752
2082	# 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
2083	warn "reattach";	3773	warn "reloaded";
2084	_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	};
2085	};	3794	};
2086
2087	if ($@) {
2088	warn $@;
2089	warn "error while reloading, exiting.";
2090	exit 1;
2091	}
2092
2093	warn "reloaded successfully";
2094	};
2095
2096	#############################################################################
2097
2098	unless ($LINK_MAP) {
2099	$LINK_MAP = cf::map::new;
2100
2101	$LINK_MAP->width (41);
2102	$LINK_MAP->height (41);
2103	$LINK_MAP->alloc;
2104	$LINK_MAP->path ("{link}");
2105	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2106	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2107
2108	# dirty hack because... archetypes are not yet loaded
2109	Event->timer (
2110	after => 2,
2111	cb => sub {
2112	$_[0]->w->cancel;
2113
2114	# provide some exits "home"
2115	my $exit = cf::object::new "exit";
2116
2117	$exit->slaying ($EMERGENCY_POSITION->[0]);
2118	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2119	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2120
2121	$LINK_MAP->insert ($exit->clone, 19, 19);
2122	$LINK_MAP->insert ($exit->clone, 19, 20);
2123	$LINK_MAP->insert ($exit->clone, 19, 21);
2124	$LINK_MAP->insert ($exit->clone, 20, 19);
2125	$LINK_MAP->insert ($exit->clone, 20, 21);
2126	$LINK_MAP->insert ($exit->clone, 21, 19);
2127	$LINK_MAP->insert ($exit->clone, 21, 20);
2128	$LINK_MAP->insert ($exit->clone, 21, 21);
2129
2130	$exit->destroy;
2131	});
2132
2133	$LINK_MAP->{deny_save} = 1;
2134	$LINK_MAP->{deny_reset} = 1;
2135
2136	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2137	}	3795	}
2138
2139	register "<global>", __PACKAGE__;
2140		3796
2141	register_command "reload" => sub {	3797	register_command "reload" => sub {
2142	my ($who, $arg) = @_;	3798	my ($who, $arg) = @_;
2143		3799
2144	if ($who->flag (FLAG_WIZ)) {	3800	if ($who->flag (FLAG_WIZ)) {
2145	$who->message ("start of reload.");
2146	reload;
2147	$who->message ("end of reload.");	3801	$who->message ("reloading server.");
		3802	async {
		3803	$Coro::current->{desc} = "perl_reload";
		3804	reload_perl;
		3805	};
2148	}	3806	}
2149	};	3807	};
2150		3808
2151	unshift @INC, $LIBDIR;	3809	unshift @INC, $LIBDIR;
2152		3810
2153	$TICK_WATCHER = Event->timer (	3811	my $bug_warning = 0;
2154	reentrant => 0,	3812
2155	prio => 0,	3813	our @WAIT_FOR_TICK;
2156	at => $NEXT_TICK || $TICK,	3814	our @WAIT_FOR_TICK_BEGIN;
2157	data => WF_AUTOCANCEL,	3815
2158	cb => sub {	3816	sub wait_for_tick {
2159	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
2160	cf::server_tick; # one server iteration	3839	cf::server_tick; # one server iteration
2161	$RUNTIME += $TICK;
2162	}
2163		3840
2164	$NEXT_TICK += $TICK;	3841	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2165		3842	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2166	# if we are delayed by four ticks or more, skip them all	3843	Coro::async_pool {
2167	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3844	$Coro::current->{desc} = "runtime saver";
2168
2169	$TICK_WATCHER->at ($NEXT_TICK);
2170	$TICK_WATCHER->start;
2171	},
2172	);
2173
2174	IO::AIO::max_poll_time $TICK * 0.2;
2175
2176	Event->io (
2177	fd => IO::AIO::poll_fileno,
2178	poll => 'r',
2179	prio => 5,
2180	data => WF_AUTOCANCEL,
2181	cb => \&IO::AIO::poll_cb,
2182	);
2183
2184	Event->timer (
2185	data => WF_AUTOCANCEL,
2186	after => 0,
2187	interval => 10,
2188	cb => sub {
2189	(Coro::unblock_sub {
2190	write_runtime	3845	write_runtime_sync
2191	or warn "ERROR: unable to write runtime file: $!";	3846	or warn "ERROR: unable to write runtime file: $!";
2192	})->();	3847	};
2193	},	3848	}
2194	);	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 }
2195		3965
2196	1	3966	1
2197		3967

Diff Legend

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