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.205 by root, Mon Feb 5 18:29:20 2007 UTC vs.
Revision 1.501 by root, Sat Jan 16 23:27:21 2010 UTC

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

Diff Legend

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