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.187 by root, Sat Jan 20 21:06:52 2007 UTC vs.
Revision 1.460 by root, Mon Dec 15 17:04:53 2008 UTC

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

Diff Legend

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