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.245 by root, Tue Apr 17 10:06:33 2007 UTC vs.
Revision 1.495 by root, Tue Nov 10 04:38:45 2009 UTC

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

Diff Legend

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