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.207 by root, Sun Feb 11 22:42:09 2007 UTC vs.
Revision 1.473 by root, Fri Jun 26 16:32:10 2009 UTC

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

Diff Legend

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