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.203 by root, Thu Feb 1 19:40:42 2007 UTC vs.
Revision 1.480 by root, Thu Oct 8 05:09:43 2009 UTC

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

Diff Legend

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