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.176 by root, Sun Jan 14 22:14:35 2007 UTC vs.
Revision 1.466 by root, Thu Jan 8 03:03:24 2009 UTC

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

Diff Legend

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