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

Diff Legend

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