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

Diff Legend

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