ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.166 by root, Sat Jan 13 23:06:13 2007 UTC vs.
Revision 1.472 by root, Sat Jun 6 21:43:13 2009 UTC

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

Diff Legend

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