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.113 by root, Mon Jan 1 15:32:40 2007 UTC vs.
Revision 1.480 by root, Thu Oct 8 05:09:43 2009 UTC

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

Diff Legend

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