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.203 by root, Thu Feb 1 19:40:42 2007 UTC vs.
Revision 1.523 by root, Sat Apr 17 02:39:46 2010 UTC

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

Diff Legend

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