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.178 by root, Thu Jan 18 00:06:55 2007 UTC vs.
Revision 1.484 by root, Mon Oct 12 14:00:58 2009 UTC

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

Diff Legend

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