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

Diff Legend

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