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.205 by root, Mon Feb 5 18:29:20 2007 UTC vs.
Revision 1.522 by root, Sat Apr 17 02:22:14 2010 UTC

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

Diff Legend

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