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

Diff Legend

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