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

Diff Legend

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