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

Diff Legend

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