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.172 by root, Sun Jan 14 13:32:48 2007 UTC vs.
Revision 1.464 by root, Thu Jan 1 18:35:48 2009 UTC

		1	#
		2	# This file is part of Deliantra, the Roguelike Realtime MMORPG.
		3	#
		4	# Copyright (©) 2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
		5	#
		6	# Deliantra is free software: you can redistribute it and/or modify
		7	# it under the terms of the GNU General Public License as published by
		8	# the Free Software Foundation, either version 3 of the License, or
		9	# (at your option) any later version.
		10	#
		11	# This program is distributed in the hope that it will be useful,
		12	# but WITHOUT ANY WARRANTY; without even the implied warranty of
		13	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
		14	# GNU General Public License for more details.
		15	#
		16	# You should have received a copy of the GNU General Public License
		17	# along with this program. If not, see <http://www.gnu.org/licenses/>.
		18	#
		19	# The authors can be reached via e-mail to <support@deliantra.net>
		20	#
		21
1	package cf;	22	package cf;
2		23
		24	use 5.10.0;
3	use utf8;	25	use utf8;
4	use strict;	26	use strict "vars", "subs";
5		27
6	use Symbol;	28	use Symbol;
7	use List::Util;	29	use List::Util;
8	use Storable;	30	use Socket;
		31	use EV;
9	use Opcode;	32	use Opcode;
10	use Safe;	33	use Safe;
11	use Safe::Hole;	34	use Safe::Hole;
		35	use Storable ();
12		36
		37	use Guard ();
13	use Coro 3.3 ();	38	use Coro ();
		39	use Coro::State;
		40	use Coro::Handle;
		41	use Coro::EV;
14	use Coro::Event;	42	use Coro::AnyEvent;
15	use Coro::Timer;	43	use Coro::Timer;
16	use Coro::Signal;	44	use Coro::Signal;
17	use Coro::Semaphore;	45	use Coro::Semaphore;
		46	use Coro::SemaphoreSet;
		47	use Coro::AnyEvent;
18	use Coro::AIO;	48	use Coro::AIO;
		49	use Coro::BDB 1.6;
		50	use Coro::Storable;
		51	use Coro::Util ();
19		52
		53	use JSON::XS 2.01 ();
		54	use BDB ();
20	use Data::Dumper;	55	use Data::Dumper;
21	use Digest::MD5;	56	use Digest::MD5;
22	use Fcntl;	57	use Fcntl;
		58	use YAML ();
23	use IO::AIO 2.32 ();	59	use IO::AIO ();
24	use YAML::Syck ();
25	use Time::HiRes;	60	use Time::HiRes;
		61	use Compress::LZF;
		62	use Digest::MD5 ();
26		63
27	use Event; $Event::Eval = 1; # no idea why this is required, but it is	64	AnyEvent::detect;
		65
		66	# configure various modules to our taste
		67	#
		68	$Storable::canonical = 1; # reduce rsync transfers
		69	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		70
		71	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
		72
		73	# make sure c-lzf reinitialises itself
		74	Compress::LZF::set_serializer "Storable", "Storable::net_mstore", "Storable::mretrieve";
		75	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
28		76
29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	77	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30
31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32	$YAML::Syck::ImplicitUnicode = 1;
33
34	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
35		78
36	our %COMMAND = ();	79	our %COMMAND = ();
37	our %COMMAND_TIME = ();	80	our %COMMAND_TIME = ();
38		81
39	our @EXTS = (); # list of extension package names	82	our @EXTS = (); # list of extension package names
40	our %EXTCMD = ();	83	our %EXTCMD = ();
		84	our %EXTICMD = ();
41	our %EXT_CORO = (); # coroutines bound to extensions	85	our %EXT_CORO = (); # coroutines bound to extensions
42	our %EXT_MAP = (); # pluggable maps	86	our %EXT_MAP = (); # pluggable maps
43		87
		88	our $RELOAD; # number of reloads so far, non-zero while in reload
44	our @EVENT;	89	our @EVENT;
45	our $LIBDIR = datadir . "/ext";
46		90
47	our $TICK = MAX_TIME * 1e-6;	91	our $CONFDIR = confdir;
48	our $TICK_WATCHER;	92	our $DATADIR = datadir;
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 + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	542	=cut
355	(aio_write $fh, 0, (length $value), $value, 0) <= 0
356	and return;
357		543
358	aio_fsync $fh	544	sub fork_call(&@) {
359	and return;	545	my ($cb, @args) = @_;
360		546
361	close $fh	547	# we seemingly have to make a local copy of the whole thing,
362	or return;	548	# otherwise perl prematurely frees the stuff :/
		549	# TODO: investigate and fix (likely this will be rather laborious)
363		550
364	aio_rename "$runtime~", $runtime	551	my @res = Coro::Util::fork_eval {
365	and return;	552	reset_signals;
		553	&$cb
		554	}, @args;
366		555
		556	wantarray ? @res : $res[-1]
		557	}
		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
367	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 });
368	}	722	}
369		723
370	=back	724	=back
371		725
372	=cut	726	=cut
373		727
374	#############################################################################	728	#############################################################################
375		729
376	=head2 ATTACHABLE OBJECTS	730	=head2 ATTACHABLE OBJECTS
377		731
378	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
379	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")
380	to it. All such attachable objects support the following methods.	734	to it. All such attachable objects support the following methods.
381		735
382	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>
383	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
384	crossfire+).	738	Deliantra).
385		739
386	=over 4	740	=over 4
387		741
388	=item $attachable->attach ($attachment, key => $value...)	742	=item $attachable->attach ($attachment, key => $value...)
389		743
…		…
433	=item cf::CLASS::attachment $name, ...	787	=item cf::CLASS::attachment $name, ...
434		788
435	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
436	given CLASS can refer to this attachment.	790	given CLASS can refer to this attachment.
437		791
438	Some classes such as crossfire maps and objects can specify attachments	792	Some classes such as deliantra maps and objects can specify attachments
439	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.
440		794
441	These calls expect any number of the following handler/hook descriptions:	795	These calls expect any number of the following handler/hook descriptions:
442		796
443	=over 4	797	=over 4
…		…
552	$registry = $CB_TYPE[$object_type] ||= [];	906	$registry = $CB_TYPE[$object_type] ||= [];
553		907
554	} elsif ($type eq "subtype") {	908	} elsif ($type eq "subtype") {
555	defined $object_type or Carp::croak "subtype specified without type";	909	defined $object_type or Carp::croak "subtype specified without type";
556	my $object_subtype = shift @arg;	910	my $object_subtype = shift @arg;
557	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	911	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
558		912
559	} elsif ($type eq "package") {	913	} elsif ($type eq "package") {
560	my $pkg = shift @arg;	914	my $pkg = shift @arg;
561		915
562	while (my ($name, $id) = each %cb_id) {	916	while (my ($name, $id) = each %cb_id) {
…		…
591	_attach $registry, $klass, @attach;	945	_attach $registry, $klass, @attach;
592	}	946	}
593		947
594	$obj->{$name} = \%arg;	948	$obj->{$name} = \%arg;
595	} else {	949	} else {
596	warn "object uses attachment '$name' that is not available, postponing.\n";	950	warn "object uses attachment '$name' which is not available, postponing.\n";
597	}	951	}
598		952
599	$obj->{_attachment}{$name} = undef;	953	$obj->{_attachment}{$name} = undef;
600	}	954	}
601		955
…		…
603	if (ref $_[0]) {	957	if (ref $_[0]) {
604	_object_attach @_;	958	_object_attach @_;
605	} else {	959	} else {
606	_attach shift->_attach_registry, @_;	960	_attach shift->_attach_registry, @_;
607	}	961	}
		962	_recalc_want;
608	};	963	};
609		964
610	# all those should be optimised	965	# all those should be optimised
611	sub cf::attachable::detach {	966	sub cf::attachable::detach {
612	my ($obj, $name) = @_;	967	my ($obj, $name) = @_;
…		…
615	delete $obj->{_attachment}{$name};	970	delete $obj->{_attachment}{$name};
616	reattach ($obj);	971	reattach ($obj);
617	} else {	972	} else {
618	Carp::croak "cannot, currently, detach class attachments";	973	Carp::croak "cannot, currently, detach class attachments";
619	}	974	}
		975	_recalc_want;
620	};	976	};
621		977
622	sub cf::attachable::attached {	978	sub cf::attachable::attached {
623	my ($obj, $name) = @_;	979	my ($obj, $name) = @_;
624		980
…		…
639	";	995	";
640	die if $@;	996	die if $@;
641	}	997	}
642		998
643	our $override;	999	our $override;
644	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?
645		1001
646	sub override {	1002	sub override {
647	$override = 1;	1003	$override = 1;
648	@invoke_results = ();	1004	@INVOKE_RESULTS = (@_);
649	}	1005	}
650		1006
651	sub do_invoke {	1007	sub do_invoke {
652	my $event = shift;	1008	my $event = shift;
653	my $callbacks = shift;	1009	my $callbacks = shift;
654		1010
655	@invoke_results = ();	1011	@INVOKE_RESULTS = ();
656		1012
657	local $override;	1013	local $override;
658		1014
659	for (@$callbacks) {	1015	for (@$callbacks) {
660	eval { &{$_->[1]} };	1016	eval { &{$_->[1]} };
…		…
669	}	1025	}
670		1026
671	0	1027	0
672	}	1028	}
673		1029
674	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1030	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
675		1031
676	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1032	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
677		1033
678	Generate an object-specific event with the given arguments.	1034	Generate an object-specific event with the given arguments.
679		1035
680	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
681	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
682	results (if you must, access C<@cf::invoke_results> directly).	1038	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
683		1039
684	=back	1040	=back
685		1041
686	=cut	1042	=cut
687		1043
688	#############################################################################	1044	#############################################################################
689	# 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	}
690		1088
691	sub reattach {	1089	sub reattach {
692	# basically do the same as instantiate, without calling instantiate	1090	# basically do the same as instantiate, without calling instantiate
693	my ($obj) = @_;	1091	my ($obj) = @_;
694		1092
		1093	# no longer needed after getting rid of delete_package?
695	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
696		1095
697	my $registry = $obj->registry;	1096	my $registry = $obj->registry;
698		1097
699	@$registry = ();	1098	@$registry = ();
700		1099
…		…
715	cf::attachable->attach (	1114	cf::attachable->attach (
716	prio => -1000000,	1115	prio => -1000000,
717	on_instantiate => sub {	1116	on_instantiate => sub {
718	my ($obj, $data) = @_;	1117	my ($obj, $data) = @_;
719		1118
720	$data = from_json $data;	1119	$data = decode_json $data;
721		1120
722	for (@$data) {	1121	for (@$data) {
723	my ($name, $args) = @$_;	1122	my ($name, $args) = @$_;
724		1123
725	$obj->attach ($name, %{$args || {} });	1124	$obj->attach ($name, %{$args || {} });
…		…
741	sub object_freezer_save {	1140	sub object_freezer_save {
742	my ($filename, $rdata, $objs) = @_;	1141	my ($filename, $rdata, $objs) = @_;
743		1142
744	sync_job {	1143	sync_job {
745	if (length $$rdata) {	1144	if (length $$rdata) {
		1145	utf8::decode (my $decname = $filename);
746	warn sprintf "saving %s (%d,%d)\n",	1146	warn sprintf "saving %s (%d,%d)\n",
747	$filename, length $$rdata, scalar @$objs;	1147	$decname, length $$rdata, scalar @$objs;
748		1148
749	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1149	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
750	chmod SAVE_MODE, $fh;	1150	aio_chmod $fh, SAVE_MODE;
751	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1151	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
752	aio_fsync $fh;	1152	aio_fsync $fh if $cf::USE_FSYNC;
753	close $fh;	1153	aio_close $fh;
754		1154
755	if (@$objs) {	1155	if (@$objs) {
756	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) {
757	chmod SAVE_MODE, $fh;	1157	aio_chmod $fh, SAVE_MODE;
758	my $data = Storable::nfreeze { version => 1, objs => $objs };	1158	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
759	aio_write $fh, 0, (length $data), $data, 0;	1159	aio_write $fh, 0, (length $data), $data, 0;
760	aio_fsync $fh;	1160	aio_fsync $fh if $cf::USE_FSYNC;
761	close $fh;	1161	aio_close $fh;
762	aio_rename "$filename.pst~", "$filename.pst";	1162	aio_rename "$filename.pst~", "$filename.pst";
763	}	1163	}
764	} else {	1164	} else {
765	aio_unlink "$filename.pst";	1165	aio_unlink "$filename.pst";
766	}	1166	}
767		1167
768	aio_rename "$filename~", $filename;	1168	aio_rename "$filename~", $filename;
		1169
		1170	$filename =~ s%/[^/]+$%%;
		1171	aio_pathsync $filename if $cf::USE_FSYNC;
769	} else {	1172	} else {
770	warn "FATAL: $filename~: $!\n";	1173	warn "unable to save objects: $filename~: $!\n";
771	}	1174	}
772	} else {	1175	} else {
773	aio_unlink $filename;	1176	aio_unlink $filename;
774	aio_unlink "$filename.pst";	1177	aio_unlink "$filename.pst";
775	}	1178	}
776	}	1179	};
777	}	1180	}
778		1181
779	sub object_freezer_as_string {	1182	sub object_freezer_as_string {
780	my ($rdata, $objs) = @_;	1183	my ($rdata, $objs) = @_;
781		1184
…		…
793	or return;	1196	or return;
794		1197
795	unless (aio_stat "$filename.pst") {	1198	unless (aio_stat "$filename.pst") {
796	(aio_load "$filename.pst", $av) >= 0	1199	(aio_load "$filename.pst", $av) >= 0
797	or return;	1200	or return;
		1201
798	$av = eval { (Storable::thaw $av)->{objs} };	1202	my $st = eval { Coro::Storable::thaw $av };
		1203	$av = $st->{objs};
799	}	1204	}
800		1205
		1206	utf8::decode (my $decname = $filename);
801	warn sprintf "loading %s (%d)\n",	1207	warn sprintf "loading %s (%d,%d)\n",
802	$filename, length $data, scalar @{$av || []};#d#	1208	$decname, length $data, scalar @{$av || []};
		1209
803	return ($data, $av);	1210	($data, $av)
804	}	1211	}
		1212
		1213	=head2 COMMAND CALLBACKS
		1214
		1215	=over 4
		1216
		1217	=cut
805		1218
806	#############################################################################	1219	#############################################################################
807	# command handling &c	1220	# command handling &c
808		1221
809	=item cf::register_command $name => \&callback($ob,$args);	1222	=item cf::register_command $name => \&callback($ob,$args);
…		…
822	push @{ $COMMAND{$name} }, [$caller, $cb];	1235	push @{ $COMMAND{$name} }, [$caller, $cb];
823	}	1236	}
824		1237
825	=item cf::register_extcmd $name => \&callback($pl,$packet);	1238	=item cf::register_extcmd $name => \&callback($pl,$packet);
826		1239
827	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.
828		1245
829	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
830	called.	1247	called.
831		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
832	=cut	1260	=cut
833		1261
834	sub register_extcmd {	1262	sub register_extcmd {
835	my ($name, $cb) = @_;	1263	my ($name, $cb) = @_;
836		1264
837	$EXTCMD{$name} = $cb;	1265	$EXTCMD{$name} = $cb;
838	}	1266	}
		1267
		1268	sub register_exticmd {
		1269	my ($name, $cb) = @_;
		1270
		1271	$EXTICMD{$name} = $cb;
		1272	}
		1273
		1274	use File::Glob ();
839		1275
840	cf::player->attach (	1276	cf::player->attach (
841	on_command => sub {	1277	on_command => sub {
842	my ($pl, $name, $params) = @_;	1278	my ($pl, $name, $params) = @_;
843		1279
…		…
851	cf::override;	1287	cf::override;
852	},	1288	},
853	on_extcmd => sub {	1289	on_extcmd => sub {
854	my ($pl, $buf) = @_;	1290	my ($pl, $buf) = @_;
855		1291
856	my $msg = eval { from_json $buf };	1292	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
857		1293
858	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
859	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1302	if (my $cb = $EXTCMD{$type}) {
860	if (my %reply = $cb->($pl, $msg)) {	1303	@reply = $cb->($pl, @payload);
861	$pl->ext_reply ($msg->{msgid}, %reply);
862	}
863	}	1304	}
		1305
		1306	$pl->ext_reply ($reply, @reply)
		1307	if $reply;
		1308
864	} else {	1309	} else {
865	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1310	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
866	}	1311	}
867		1312
868	cf::override;	1313	cf::override;
869	},	1314	},
870	);	1315	);
871		1316
		1317	# "readahead" all extensions
872	sub load_extension {	1318	sub cache_extensions {
873	my ($path) = @_;	1319	my $grp = IO::AIO::aio_group;
874		1320
875	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1321	add $grp IO::AIO::aio_readdir $LIBDIR, sub {
876	my $base = $1;	1322	for (grep /\.ext$/, @{$_[0]}) {
877	my $pkg = $1;	1323	add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
878	$pkg =~ s/[^[:word:]]/_/g;
879	$pkg = "ext::$pkg";
880
881	warn "... loading '$path' into '$pkg'\n";
882
883	open my $fh, "<:utf8", $path
884	or die "$path: $!";
885
886	my $source =
887	"package $pkg; use strict; use utf8;\n"
888	. "#line 1 \"$path\"\n{\n"
889	. (do { local $/; <$fh> })
890	. "\n};\n1";
891
892	unless (eval $source) {
893	my $msg = $@ ? "$path: $@\n"
894	: "extension disabled.\n";
895	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
896	warn $@;
897	warn "mandatory extension failed to load, exiting.\n";
898	exit 1;
899	}	1324	}
900	die $@;
901	}	1325	};
902		1326
903	push @EXTS, $pkg;	1327	$grp
904	}	1328	}
905		1329
906	sub load_extensions {	1330	sub load_extensions {
		1331	cf::sync_job {
		1332	my %todo;
		1333
907	for my $ext (<$LIBDIR/*.ext>) {	1334	for my $path (<$LIBDIR/*.ext>) {
908	next unless -r $ext;	1335	next unless -r $path;
909	eval {	1336
910	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;
911	1	1393	}
912	} or warn "$ext not loaded: $@";	1394
		1395	skip:
		1396	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1397	unless $progress;
		1398	}
913	}	1399	};
914	}	1400	}
915		1401
916	#############################################################################	1402	#############################################################################
917		1403
		1404	=back
		1405
918	=head2 CORE EXTENSIONS	1406	=head2 CORE EXTENSIONS
919		1407
920	Functions and methods that extend core crossfire objects.	1408	Functions and methods that extend core deliantra objects.
921		1409
922	=cut	1410	=cut
923		1411
924	package cf::player;	1412	package cf::player;
925		1413
…		…
927		1415
928	=head3 cf::player	1416	=head3 cf::player
929		1417
930	=over 4	1418	=over 4
931		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
932	=item cf::player::find $login	1434	=item cf::player::find $login
933		1435
934	Returns the given player object, loading it if necessary (might block).	1436	Returns the given player object, loading it if necessary (might block).
935		1437
936	=cut	1438	=cut
937		1439
938	sub playerdir($) {	1440	sub playerdir($) {
939	cf::localdir	1441	"$PLAYERDIR/"
940	. "/"
941	. cf::playerdir
942	. "/"
943	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1442	. (ref $_[0] ? $_[0]->ob->name : $_[0])
944	}	1443	}
945		1444
946	sub path($) {	1445	sub path($) {
947	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1446	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
948		1447
949	(playerdir $login) . "/$login.pl"	1448	(playerdir $login) . "/playerdata"
950	}	1449	}
951		1450
952	sub find_active($) {	1451	sub find_active($) {
953	$cf::PLAYER{$_[0]}	1452	$cf::PLAYER{$_[0]}
954	and $cf::PLAYER{$_[0]}->active	1453	and $cf::PLAYER{$_[0]}->active
…		…
957		1456
958	sub exists($) {	1457	sub exists($) {
959	my ($login) = @_;	1458	my ($login) = @_;
960		1459
961	$cf::PLAYER{$login}	1460	$cf::PLAYER{$login}
962	or cf::sync_job { !aio_stat $login }	1461	or !aio_stat path $login
963	}	1462	}
964		1463
965	sub find($) {	1464	sub find($) {
966	return $cf::PLAYER{$_[0]} || do {	1465	return $cf::PLAYER{$_[0]} || do {
967	my $login = $_[0];	1466	my $login = $_[0];
968		1467
969	my $guard = cf::lock_acquire "user_find:$login";	1468	my $guard = cf::lock_acquire "user_find:$login";
970		1469
971	$cf::PLAYER{$_[0]} || do {	1470	$cf::PLAYER{$_[0]} || do {
972	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
973	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;
974	$cf::PLAYER{$login} = $pl	1486	$cf::PLAYER{$login} = $pl
975	}	1487	}
976	}	1488	}
977	}	1489	}
978		1490
…		…
987	return if $pl->{deny_save};	1499	return if $pl->{deny_save};
988		1500
989	aio_mkdir playerdir $pl, 0770;	1501	aio_mkdir playerdir $pl, 0770;
990	$pl->{last_save} = $cf::RUNTIME;	1502	$pl->{last_save} = $cf::RUNTIME;
991		1503
		1504	cf::get_slot 0.01;
		1505
992	$pl->save_pl ($path);	1506	$pl->save_pl ($path);
993	Coro::cede;	1507	cf::cede_to_tick;
994	}	1508	}
995		1509
996	sub new($) {	1510	sub new($) {
997	my ($login) = @_;	1511	my ($login) = @_;
998		1512
…		…
1004	$cf::PLAYER{$login} = $self;	1518	$cf::PLAYER{$login} = $self;
1005		1519
1006	$self	1520	$self
1007	}	1521	}
1008		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
1009	=item $pl->quit_character	1533	=item $pl->quit_character
1010		1534
1011	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
1012	be destroyed. May block for a long time.	1536	be destroyed. May block for a long time.
1013		1537
1014	=cut	1538	=cut
1015		1539
1016	sub quit_character {	1540	sub quit_character {
1017	my ($pl) = @_;	1541	my ($pl) = @_;
1018		1542
		1543	my $name = $pl->ob->name;
		1544
1019	$pl->{deny_save} = 1;	1545	$pl->{deny_save} = 1;
1020	$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
1021		1547
1022	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1548	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1023	$pl->deactivate;	1549	$pl->deactivate;
		1550	my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
		1551	$pl->ob->check_score;
1024	$pl->invoke (cf::EVENT_PLAYER_QUIT);	1552	$pl->invoke (cf::EVENT_PLAYER_QUIT);
1025	$pl->ns->destroy if $pl->ns;	1553	$pl->ns->destroy if $pl->ns;
1026		1554
1027	my $path = playerdir $pl;	1555	my $path = playerdir $pl;
1028	my $temp = "$path~$cf::RUNTIME~deleting~";	1556	my $temp = "$path~$cf::RUNTIME~deleting~";
1029	aio_rename $path, $temp;	1557	aio_rename $path, $temp;
1030	delete $cf::PLAYER{$pl->ob->name};	1558	delete $cf::PLAYER{$pl->ob->name};
1031	$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
1032	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;
1033	}	1581	}
1034		1582
1035	=item cf::player::list_logins	1583	=item cf::player::list_logins
1036		1584
1037	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
1038	while and may block, so not sync_job-capable, ever.	1586	while and may block, so not sync_job-capable, ever.
1039		1587
1040	=cut	1588	=cut
1041		1589
1042	sub list_logins {	1590	sub list_logins {
1043	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1591	my $dirs = aio_readdir $PLAYERDIR
1044	or return [];	1592	or return [];
1045		1593
1046	my @logins;	1594	my @logins;
1047		1595
1048	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") {
1049	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1602	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1050	aio_read $fh, 0, 512, my $buf, 0 or next;	1603	aio_read $fh, 0, 512, my $buf, 0 or next;
1051	$buf !~ /^password -------------$/m or next; # official not-valid tag	1604	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1605	}
1052		1606
1053	utf8::decode $login;	1607	utf8::decode $login;
1054	push @logins, $login;	1608	push @logins, $login;
1055	}	1609	}
1056		1610
…		…
1064		1618
1065	=cut	1619	=cut
1066		1620
1067	sub maps($) {	1621	sub maps($) {
1068	my ($pl) = @_;	1622	my ($pl) = @_;
		1623
		1624	$pl = ref $pl ? $pl->ob->name : $pl;
1069		1625
1070	my $files = aio_readdir playerdir $pl	1626	my $files = aio_readdir playerdir $pl
1071	or return;	1627	or return;
1072		1628
1073	my @paths;	1629	my @paths;
…		…
1075	for (@$files) {	1631	for (@$files) {
1076	utf8::decode $_;	1632	utf8::decode $_;
1077	next if /\.(?:pl|pst)$/;	1633	next if /\.(?:pl|pst)$/;
1078	next unless /^$PATH_SEP/o;	1634	next unless /^$PATH_SEP/o;
1079		1635
1080	s/\.map$//;	1636	push @paths, cf::map::normalise "~$pl/$_";
1081	push @paths, "~" . $pl->ob->name . "/" . $_;
1082	}	1637	}
1083		1638
1084	\@paths	1639	\@paths
1085	}	1640	}
1086		1641
		1642	=item $protocol_xml = $player->expand_cfpod ($cfpod)
		1643
		1644	Expand deliantra pod fragments into protocol xml.
		1645
1087	=item $player->ext_reply ($msgid, $msgtype, %msg)	1646	=item $player->ext_reply ($msgid, @msg)
1088		1647
1089	Sends an ext reply to the player.	1648	Sends an ext reply to the player.
1090		1649
1091	=cut	1650	=cut
1092		1651
1093	sub ext_reply($$$%) {	1652	sub ext_reply($$@) {
1094	my ($self, $id, %msg) = @_;	1653	my ($self, $id, @msg) = @_;
1095		1654
1096	$msg{msgid} = $id;	1655	$self->ns->ext_reply ($id, @msg)
1097
1098	$self->send ("ext " . cf::to_json \%msg);
1099	}	1656	}
1100		1657
1101	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	}
1102		1698
1103	=back	1699	=back
1104
1105		1700
1106	=head3 cf::map	1701	=head3 cf::map
1107		1702
1108	=over 4	1703	=over 4
1109		1704
…		…
1113		1708
1114	use Fcntl;	1709	use Fcntl;
1115	use Coro::AIO;	1710	use Coro::AIO;
1116		1711
1117	use overload	1712	use overload
1118	'""' => \&as_string;	1713	'""' => \&as_string,
		1714	fallback => 1;
1119		1715
1120	our $MAX_RESET = 3600;	1716	our $MAX_RESET = 3600;
1121	our $DEFAULT_RESET = 3000;	1717	our $DEFAULT_RESET = 3000;
1122		1718
1123	sub generate_random_map {	1719	sub generate_random_map {
1124	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
1125		1723
1126	# mit "rum" bekleckern, nicht	1724	# mit "rum" bekleckern, nicht
1127	$self->_create_random_map (	1725	$self->_create_random_map (
1128	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1726	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1129	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1727	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
…		…
1137	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1735	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1138	(cf::region::find $rmp->{region}), $rmp->{custom}	1736	(cf::region::find $rmp->{region}), $rmp->{custom}
1139	)	1737	)
1140	}	1738	}
1141		1739
		1740	=item cf::map->register ($regex, $prio)
		1741
		1742	Register a handler for the map path matching the given regex at the
		1743	givne priority (higher is better, built-in handlers have priority 0, the
		1744	default).
		1745
		1746	=cut
		1747
1142	sub register {	1748	sub register {
1143	my (undef, $regex) = @_;	1749	my (undef, $regex, $prio) = @_;
1144	my $pkg = caller;	1750	my $pkg = caller;
1145		1751
1146	no strict;	1752	no strict;
1147	push @{"$pkg\::ISA"}, __PACKAGE__;	1753	push @{"$pkg\::ISA"}, __PACKAGE__;
1148		1754
1149	$EXT_MAP{$pkg} = qr<$regex>;	1755	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
1150	}	1756	}
1151		1757
1152	# also paths starting with '/'	1758	# also paths starting with '/'
1153	$EXT_MAP{"cf::map"} = qr{^(?=/)};	1759	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1154		1760
1155	sub thawer_merge {	1761	sub thawer_merge {
1156	my ($self, $merge) = @_;	1762	my ($self, $merge) = @_;
1157		1763
1158	# we have to keep some variables in memory intact	1764	# we have to keep some variables in memory intact
1159	local $self->{path};	1765	local $self->{path};
1160	local $self->{load_path};	1766	local $self->{load_path};
1161	local $self->{deny_save};
1162	local $self->{deny_reset};
1163		1767
1164	$self->SUPER::thawer_merge ($merge);	1768	$self->SUPER::thawer_merge ($merge);
1165	}	1769	}
1166		1770
1167	sub normalise {	1771	sub normalise {
1168	my ($path, $base) = @_;	1772	my ($path, $base) = @_;
		1773
		1774	$path = "$path"; # make sure its a string
		1775
		1776	$path =~ s/\.map$//;
1169		1777
1170	# map plan:	1778	# map plan:
1171	#	1779	#
1172	# /! non-realised random map exit (special hack!)	1780	# /! non-realised random map exit (special hack!)
1173	# {... are special paths that are not being touched	1781	# {... are special paths that are not being touched
…		…
1201		1809
1202	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object	1810	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1203		1811
1204	$path = normalise $path, $base;	1812	$path = normalise $path, $base;
1205		1813
1206	for my $pkg (keys %EXT_MAP) {	1814	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1207	if ($path =~ $EXT_MAP{$pkg}) {	1815	if ($path =~ $EXT_MAP{$pkg}[1]) {
1208	my $self = bless cf::map::new, $pkg;	1816	my $self = bless cf::map::new, $pkg;
1209	$self->{path} = $path; $self->path ($path);	1817	$self->{path} = $path; $self->path ($path);
1210	$self->init; # pass $1 etc.	1818	$self->init; # pass $1 etc.
1211	return $self;	1819	return $self;
1212	}	1820	}
1213	}	1821	}
1214		1822
1215	Carp::carp "unable to resolve path '$path'.";	1823	Carp::cluck "unable to resolve path '$path' (base '$base').";
1216	()	1824	()
1217	}	1825	}
1218		1826
1219	sub init {	1827	sub init {
1220	my ($self) = @_;	1828	my ($self) = @_;
…		…
1235		1843
1236	# the original (read-only) location	1844	# the original (read-only) location
1237	sub load_path {	1845	sub load_path {
1238	my ($self) = @_;	1846	my ($self) = @_;
1239		1847
1240	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1848	"$MAPDIR/$self->{path}.map"
1241	}	1849	}
1242		1850
1243	# the temporary/swap location	1851	# the temporary/swap location
1244	sub save_path {	1852	sub save_path {
1245	my ($self) = @_;	1853	my ($self) = @_;
1246		1854
1247	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1855	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1248	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	1856	"$TMPDIR/$path.map"
1249	}	1857	}
1250		1858
1251	# the unique path, undef == no special unique path	1859	# the unique path, undef == no special unique path
1252	sub uniq_path {	1860	sub uniq_path {
1253	my ($self) = @_;	1861	my ($self) = @_;
1254		1862
1255	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1863	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1256	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1864	"$UNIQUEDIR/$path"
1257	}	1865	}
1258		1866
1259	# and all this just because we cannot iterate over	1867	sub decay_objects {
1260	# all maps in C++...
1261	sub change_all_map_light {
1262	my ($change) = @_;	1868	my ($self) = @_;
1263		1869
1264	$_->change_map_light ($change)	1870	return if $self->{deny_reset};
1265	for grep $_->outdoor, values %cf::MAP;	1871
		1872	$self->do_decay_objects;
1266	}	1873	}
1267		1874
1268	sub unlink_save {	1875	sub unlink_save {
1269	my ($self) = @_;	1876	my ($self) = @_;
1270		1877
…		…
1275		1882
1276	sub load_header_from($) {	1883	sub load_header_from($) {
1277	my ($self, $path) = @_;	1884	my ($self, $path) = @_;
1278		1885
1279	utf8::encode $path;	1886	utf8::encode $path;
1280	aio_open $path, O_RDONLY, 0	1887	my $f = new_from_file cf::object::thawer $path
1281	or return;	1888	or return;
1282		1889
1283	$self->_load_header ($path)	1890	$self->_load_header ($f)
1284	or return;	1891	or return;
1285		1892
		1893	local $MAP_LOADING{$self->{path}} = $self;
		1894	$f->resolve_delayed_derefs;
		1895
1286	$self->{load_path} = $path;	1896	$self->{load_path} = $path;
1287		1897
1288	1	1898	1
1289	}	1899	}
1290		1900
1291	sub load_orig {	1901	sub load_header_orig {
1292	my ($self) = @_;	1902	my ($self) = @_;
1293		1903
1294	$self->load_header_from ($self->load_path)	1904	$self->load_header_from ($self->load_path)
1295	}	1905	}
1296		1906
1297	sub load_temp {	1907	sub load_header_temp {
1298	my ($self) = @_;	1908	my ($self) = @_;
1299		1909
1300	$self->load_header_from ($self->save_path)	1910	$self->load_header_from ($self->save_path)
		1911	}
		1912
		1913	sub prepare_temp {
		1914	my ($self) = @_;
		1915
		1916	$self->last_access ((delete $self->{last_access})
		1917	|| $cf::RUNTIME); #d#
		1918	# safety
		1919	$self->{instantiate_time} = $cf::RUNTIME
		1920	if $self->{instantiate_time} > $cf::RUNTIME;
		1921	}
		1922
		1923	sub prepare_orig {
		1924	my ($self) = @_;
		1925
		1926	$self->{load_original} = 1;
		1927	$self->{instantiate_time} = $cf::RUNTIME;
		1928	$self->last_access ($cf::RUNTIME);
		1929	$self->instantiate;
1301	}	1930	}
1302		1931
1303	sub load_header {	1932	sub load_header {
1304	my ($self) = @_;	1933	my ($self) = @_;
1305		1934
1306	if ($self->load_temp) {	1935	if ($self->load_header_temp) {
1307	$self->last_access ((delete $self->{last_access})	1936	$self->prepare_temp;
1308	|| $cf::RUNTIME); #d#
1309	# safety
1310	$self->{instantiate_time} = $cf::RUNTIME
1311	if $self->{instantiate_time} > $cf::RUNTIME;
1312	} else {	1937	} else {
1313	$self->load_orig	1938	$self->load_header_orig
1314	or return;	1939	or return;
1315		1940	$self->prepare_orig;
1316	$self->{load_original} = 1;
1317	$self->{instantiate_time} = $cf::RUNTIME;
1318	$self->last_access ($cf::RUNTIME);
1319	$self->instantiate;
1320	}	1941	}
		1942
		1943	$self->{deny_reset} = 1
		1944	if $self->no_reset;
		1945
		1946	$self->default_region (cf::region::find_by_path $self->{path})
		1947	unless $self->default_region;
1321		1948
1322	1	1949	1
1323	}	1950	}
1324		1951
1325	sub find;	1952	sub find;
1326	sub find {	1953	sub find {
1327	my ($path, $origin) = @_;	1954	my ($path, $origin) = @_;
1328		1955
1329	$path = normalise $path, $origin && $origin->path;	1956	$path = normalise $path, $origin && $origin->path;
1330		1957
		1958	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1331	cf::lock_wait "map_find:$path";	1959	my $guard2 = cf::lock_acquire "map_find:$path";
1332		1960
1333	$cf::MAP{$path} || do {	1961	$cf::MAP{$path} || do {
1334	my $guard = cf::lock_acquire "map_find:$path";
1335	my $map = new_from_path cf::map $path	1962	my $map = new_from_path cf::map $path
1336	or return;	1963	or return;
1337		1964
1338	$map->{last_save} = $cf::RUNTIME;	1965	$map->{last_save} = $cf::RUNTIME;
1339		1966
1340	$map->load_header	1967	$map->load_header
1341	or return;	1968	or return;
1342		1969
1343	if ($map->should_reset) {	1970	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1971	# doing this can freeze the server in a sync job, obviously
1344	$cf::WAIT_FOR_TICK->wait;	1972	#$cf::WAIT_FOR_TICK->wait;
		1973	undef $guard2;
		1974	undef $guard1;
1345	$map->reset;	1975	$map->reset;
1346	undef $guard;
1347	$map = find $path	1976	return find $path;
1348	or return;
1349	}	1977	}
1350		1978
1351	$cf::MAP{$path} = $map	1979	$cf::MAP{$path} = $map
1352	}	1980	}
1353	}	1981	}
		1982
		1983	sub pre_load { }
		1984	sub post_load { }
1354		1985
1355	sub load {	1986	sub load {
1356	my ($self) = @_;	1987	my ($self) = @_;
1357		1988
		1989	local $self->{deny_reset} = 1; # loading can take a long time
		1990
1358	my $path = $self->{path};	1991	my $path = $self->{path};
		1992
		1993	{
1359	my $guard = cf::lock_acquire "map_load:$path";	1994	my $guard = cf::lock_acquire "map_data:$path";
1360		1995
		1996	return unless $self->valid;
1361	return if $self->in_memory != cf::MAP_SWAPPED;	1997	return unless $self->in_memory == cf::MAP_SWAPPED;
1362		1998
1363	$self->in_memory (cf::MAP_LOADING);	1999	$self->in_memory (cf::MAP_LOADING);
1364		2000
1365	$self->alloc;	2001	$self->alloc;
1366	$self->_load_objects ($self->{load_path}, 1)	2002
		2003	$self->pre_load;
		2004	cf::cede_to_tick;
		2005
		2006	my $f = new_from_file cf::object::thawer $self->{load_path};
		2007	$f->skip_block;
		2008	$self->_load_objects ($f)
1367	or return;	2009	or return;
1368		2010
1369	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2011	$self->post_load_original
1370	if delete $self->{load_original};	2012	if delete $self->{load_original};
1371		2013
1372	if (my $uniq = $self->uniq_path) {	2014	if (my $uniq = $self->uniq_path) {
1373	utf8::encode $uniq;	2015	utf8::encode $uniq;
1374	if (aio_open $uniq, O_RDONLY, 0) {	2016	unless (aio_stat $uniq) {
		2017	if (my $f = new_from_file cf::object::thawer $uniq) {
1375	$self->clear_unique_items;	2018	$self->clear_unique_items;
1376	$self->_load_objects ($uniq, 0);	2019	$self->_load_objects ($f);
		2020	$f->resolve_delayed_derefs;
		2021	}
1377	}	2022	}
1378	}	2023	}
1379		2024
1380	Coro::cede;	2025	$f->resolve_delayed_derefs;
1381		2026
		2027	cf::cede_to_tick;
1382	# now do the right thing for maps	2028	# now do the right thing for maps
1383	$self->link_multipart_objects;	2029	$self->link_multipart_objects;
1384
1385	unless ($self->{deny_activate}) {
1386	$self->decay_objects;
1387	$self->fix_auto_apply;
1388	$self->update_buttons;
1389	Coro::cede;
1390	$self->set_darkness_map;
1391	$self->difficulty ($self->estimate_difficulty)	2030	$self->difficulty ($self->estimate_difficulty)
1392	unless $self->difficulty;	2031	unless $self->difficulty;
1393	Coro::cede;	2032	cf::cede_to_tick;
		2033
		2034	unless ($self->{deny_activate}) {
		2035	$self->decay_objects;
		2036	$self->fix_auto_apply;
		2037	$self->update_buttons;
		2038	cf::cede_to_tick;
1394	$self->activate;	2039	$self->activate;
1395	}	2040	}
1396		2041
		2042	$self->{last_save} = $cf::RUNTIME;
		2043	$self->last_access ($cf::RUNTIME);
		2044
1397	$self->in_memory (cf::MAP_IN_MEMORY);	2045	$self->in_memory (cf::MAP_ACTIVE);
		2046	}
		2047
		2048	$self->post_load;
1398	}	2049	}
1399		2050
1400	sub customise_for {	2051	sub customise_for {
1401	my ($self, $ob) = @_;	2052	my ($self, $ob) = @_;
1402		2053
1403	return find "~" . $ob->name . "/" . $self->{path}	2054	return find "~" . $ob->name . "/" . $self->{path}
1404	if $self->per_player;	2055	if $self->per_player;
1405		2056
		2057	# return find "?party/" . $ob->name . "/" . $self->{path}
		2058	# if $self->per_party;
		2059
1406	$self	2060	$self
1407	}	2061	}
1408		2062
1409	# find and load all maps in the 3x3 area around a map	2063	# find and load all maps in the 3x3 area around a map
1410	sub load_diag {	2064	sub load_neighbours {
1411	my ($map) = @_;	2065	my ($map) = @_;
1412		2066
1413	my @diag; # diagonal neighbours	2067	my @neigh; # diagonal neighbours
1414		2068
1415	for (0 .. 3) {	2069	for (0 .. 3) {
1416	my $neigh = $map->tile_path ($_)	2070	my $neigh = $map->tile_path ($_)
1417	or next;	2071	or next;
1418	$neigh = find $neigh, $map	2072	$neigh = find $neigh, $map
1419	or next;	2073	or next;
1420	$neigh->load;	2074	$neigh->load;
1421		2075
		2076	push @neigh,
1422	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2077	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1423	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2078	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1424	}	2079	}
1425		2080
1426	for (@diag) {	2081	for (grep defined $_->[0], @neigh) {
		2082	my ($path, $origin) = @$_;
1427	my $neigh = find @$_	2083	my $neigh = find $path, $origin
1428	or next;	2084	or next;
1429	$neigh->load;	2085	$neigh->load;
1430	}	2086	}
1431	}	2087	}
1432		2088
…		…
1437	}	2093	}
1438		2094
1439	sub do_load_sync {	2095	sub do_load_sync {
1440	my ($map) = @_;	2096	my ($map) = @_;
1441		2097
		2098	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2099	if $Coro::current == $Coro::main;
		2100
1442	cf::sync_job { $map->load };	2101	cf::sync_job { $map->load };
1443	}	2102	}
1444		2103
1445	our %MAP_PREFETCH;	2104	our %MAP_PREFETCH;
1446	our $MAP_PREFETCHER = Coro::async {	2105	our $MAP_PREFETCHER = undef;
1447	while () {
1448	for my $path (keys %MAP_PREFETCH) {
1449	my $map = find $path
1450	or next;
1451	$map->load;
1452
1453	delete $MAP_PREFETCH{$path};
1454	}
1455	Coro::schedule;
1456	}
1457	};
1458		2106
1459	sub find_async {	2107	sub find_async {
1460	my ($path, $origin) = @_;	2108	my ($path, $origin, $load) = @_;
1461		2109
1462	$path = normalise $path, $origin && $origin->{path};	2110	$path = normalise $path, $origin && $origin->{path};
1463		2111
1464	if (my $map = $cf::MAP{$path}) {	2112	if (my $map = $cf::MAP{$path}) {
1465	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2113	return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
		2114	}
		2115
		2116	$MAP_PREFETCH{$path} |= $load;
		2117
		2118	$MAP_PREFETCHER ||= cf::async {
		2119	$Coro::current->{desc} = "map prefetcher";
		2120
		2121	while (%MAP_PREFETCH) {
		2122	while (my ($k, $v) = each %MAP_PREFETCH) {
		2123	if (my $map = find $k) {
		2124	$map->load if $v;
		2125	}
		2126
		2127	delete $MAP_PREFETCH{$k};
		2128	}
		2129	}
		2130	undef $MAP_PREFETCHER;
1466	}	2131	};
1467
1468	$MAP_PREFETCH{$path} = 0;
1469	$MAP_PREFETCHER->ready;	2132	$MAP_PREFETCHER->prio (6);
1470		2133
1471	()	2134	()
1472	}	2135	}
1473		2136
1474	sub save {	2137	sub save {
1475	my ($self) = @_;	2138	my ($self) = @_;
1476		2139
1477	my $lock = cf::lock_acquire "map_data:" . $self->path;	2140	my $lock = cf::lock_acquire "map_data:$self->{path}";
1478		2141
1479	$self->{last_save} = $cf::RUNTIME;	2142	$self->{last_save} = $cf::RUNTIME;
1480		2143
1481	return unless $self->dirty;	2144	return unless $self->dirty;
1482		2145
…		…
1488	return if $self->{deny_save};	2151	return if $self->{deny_save};
1489		2152
1490	local $self->{last_access} = $self->last_access;#d#	2153	local $self->{last_access} = $self->last_access;#d#
1491		2154
1492	cf::async {	2155	cf::async {
		2156	$Coro::current->{desc} = "map player save";
1493	$_->contr->save for $self->players;	2157	$_->contr->save for $self->players;
1494	};	2158	};
		2159
		2160	cf::get_slot 0.02;
1495		2161
1496	if ($uniq) {	2162	if ($uniq) {
1497	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2163	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1498	$self->_save_objects ($uniq, cf::IO_UNIQUES);	2164	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1499	} else {	2165	} else {
…		…
1505	my ($self) = @_;	2171	my ($self) = @_;
1506		2172
1507	# save first because save cedes	2173	# save first because save cedes
1508	$self->save;	2174	$self->save;
1509		2175
1510	my $lock = cf::lock_acquire "map_data:" . $self->path;	2176	my $lock = cf::lock_acquire "map_data:$self->{path}";
1511		2177
1512	return if $self->players;	2178	return if $self->players;
1513	return if $self->in_memory != cf::MAP_IN_MEMORY;	2179	return if $self->in_memory != cf::MAP_ACTIVE;
1514	return if $self->{deny_save};	2180	return if $self->{deny_save};
1515		2181
		2182	$self->in_memory (cf::MAP_SWAPPED);
		2183
		2184	$self->deactivate;
		2185	$_->clear_links_to ($self) for values %cf::MAP;
1516	$self->clear;	2186	$self->clear;
1517	$self->in_memory (cf::MAP_SWAPPED);
1518	}	2187	}
1519		2188
1520	sub reset_at {	2189	sub reset_at {
1521	my ($self) = @_;	2190	my ($self) = @_;
1522		2191
1523	# TODO: safety, remove and allow resettable per-player maps	2192	# TODO: safety, remove and allow resettable per-player maps
1524	return 1e99 if $self->isa ("ext::map_per_player");#d#
1525	return 1e99 if $self->{deny_reset};	2193	return 1e99 if $self->{deny_reset};
1526		2194
1527	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2195	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1528	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2196	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1529		2197
…		…
1534	my ($self) = @_;	2202	my ($self) = @_;
1535		2203
1536	$self->reset_at <= $cf::RUNTIME	2204	$self->reset_at <= $cf::RUNTIME
1537	}	2205	}
1538		2206
1539	sub rename {
1540	my ($self, $new_path) = @_;
1541
1542	normalise $new_path;
1543
1544	$self->unlink_save;
1545
1546	delete $cf::MAP{$self->path};
1547	$self->{path} = $new_path; $self->path ($self->{path});
1548	$cf::MAP{$self->path} = $self;
1549
1550	$self->save;
1551	}
1552
1553	sub reset {	2207	sub reset {
1554	my ($self) = @_;	2208	my ($self) = @_;
1555		2209
1556	my $lock = cf::lock_acquire "map_data:$self->{path}";	2210	my $lock = cf::lock_acquire "map_data:$self->{path}";
1557		2211
1558	return if $self->players;	2212	return if $self->players;
1559	return if $self->isa ("ext::map_per_player");#d#
1560		2213
1561	warn "resetting map ", $self->path;#d#	2214	warn "resetting map ", $self->path;
		2215
		2216	$self->in_memory (cf::MAP_SWAPPED);
		2217
		2218	# need to save uniques path
		2219	unless ($self->{deny_save}) {
		2220	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2221
		2222	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2223	if $uniq;
		2224	}
1562		2225
1563	delete $cf::MAP{$self->path};	2226	delete $cf::MAP{$self->path};
1564		2227
1565	$self->in_memory (cf::MAP_SWAPPED);	2228	$self->deactivate;
		2229	$_->clear_links_to ($self) for values %cf::MAP;
1566	$self->clear;	2230	$self->clear;
1567
1568	$_->clear_links_to ($self) for values %cf::MAP;
1569		2231
1570	$self->unlink_save;	2232	$self->unlink_save;
1571	$self->destroy;	2233	$self->destroy;
1572	}	2234	}
1573		2235
1574	my $nuke_counter = "aaaa";	2236	my $nuke_counter = "aaaa";
1575		2237
1576	sub nuke {	2238	sub nuke {
1577	my ($self) = @_;	2239	my ($self) = @_;
1578		2240
		2241	{
		2242	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2243
		2244	delete $cf::MAP{$self->path};
		2245
		2246	$self->unlink_save;
		2247
		2248	bless $self, "cf::map";
		2249	delete $self->{deny_reset};
1579	$self->{deny_save} = 1;	2250	$self->{deny_save} = 1;
1580	$self->reset_timeout (1);	2251	$self->reset_timeout (1);
1581	$self->rename ("{nuke}/" . ($nuke_counter++));	2252	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2253
		2254	$cf::MAP{$self->path} = $self;
		2255	}
		2256
1582	$self->reset; # polite request, might not happen	2257	$self->reset; # polite request, might not happen
		2258	}
		2259
		2260	=item $maps = cf::map::tmp_maps
		2261
		2262	Returns an arrayref with all map paths of currently instantiated and saved
		2263	maps. May block.
		2264
		2265	=cut
		2266
		2267	sub tmp_maps() {
		2268	[
		2269	map {
		2270	utf8::decode $_;
		2271	/\.map$/
		2272	? normalise $_
		2273	: ()
		2274	} @{ aio_readdir $TMPDIR or [] }
		2275	]
		2276	}
		2277
		2278	=item $maps = cf::map::random_maps
		2279
		2280	Returns an arrayref with all map paths of currently instantiated and saved
		2281	random maps. May block.
		2282
		2283	=cut
		2284
		2285	sub random_maps() {
		2286	[
		2287	map {
		2288	utf8::decode $_;
		2289	/\.map$/
		2290	? normalise "?random/$_"
		2291	: ()
		2292	} @{ aio_readdir $RANDOMDIR or [] }
		2293	]
1583	}	2294	}
1584		2295
1585	=item cf::map::unique_maps	2296	=item cf::map::unique_maps
1586		2297
1587	Returns an arrayref of paths of all shared maps that have	2298	Returns an arrayref of paths of all shared maps that have
1588	instantiated unique items. May block.	2299	instantiated unique items. May block.
1589		2300
1590	=cut	2301	=cut
1591		2302
1592	sub unique_maps() {	2303	sub unique_maps() {
1593	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2304	[
1594	or return;	2305	map {
1595
1596	my @paths;
1597
1598	for (@$files) {
1599	utf8::decode $_;	2306	utf8::decode $_;
1600	next if /\.pst$/;	2307	s/\.map$//; # TODO future compatibility hack
1601	next unless /^$PATH_SEP/o;	2308	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
1602		2309	? ()
1603	s/\.map$//;	2310	: normalise $_
1604	push @paths, $_;	2311	} @{ aio_readdir $UNIQUEDIR or [] }
1605	}	2312	]
1606
1607	\@paths
1608	}	2313	}
1609
1610	package cf;
1611		2314
1612	=back	2315	=back
1613		2316
1614	=head3 cf::object	2317	=head3 cf::object
1615		2318
…		…
1619		2322
1620	=over 4	2323	=over 4
1621		2324
1622	=item $ob->inv_recursive	2325	=item $ob->inv_recursive
1623		2326
1624	Returns the inventory of the object _and_ their inventories, recursively.	2327	Returns the inventory of the object I<and> their inventories, recursively,
		2328	but I<not> the object itself.
1625		2329
1626	=cut	2330	=cut
1627		2331
1628	sub inv_recursive_;	2332	sub inv_recursive_;
1629	sub inv_recursive_ {	2333	sub inv_recursive_ {
…		…
1632		2336
1633	sub inv_recursive {	2337	sub inv_recursive {
1634	inv_recursive_ inv $_[0]	2338	inv_recursive_ inv $_[0]
1635	}	2339	}
1636		2340
		2341	=item $ref = $ob->ref
		2342
		2343	Creates and returns a persistent reference to an object that can be stored as a string.
		2344
		2345	=item $ob = cf::object::deref ($refstring)
		2346
		2347	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2348	even if the object actually exists. May block.
		2349
		2350	=cut
		2351
		2352	sub deref {
		2353	my ($ref) = @_;
		2354
		2355	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2356	my ($uuid, $name) = ($1, $2);
		2357	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2358	or return;
		2359	$pl->ob->uuid eq $uuid
		2360	or return;
		2361
		2362	$pl->ob
		2363	} else {
		2364	warn "$ref: cannot resolve object reference\n";
		2365	undef
		2366	}
		2367	}
		2368
1637	package cf;	2369	package cf;
1638		2370
1639	=back	2371	=back
1640		2372
1641	=head3 cf::object::player	2373	=head3 cf::object::player
…		…
1647	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	2379	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
1648	can be C<undef>. Does the right thing when the player is currently in a	2380	can be C<undef>. Does the right thing when the player is currently in a
1649	dialogue with the given NPC character.	2381	dialogue with the given NPC character.
1650		2382
1651	=cut	2383	=cut
		2384
		2385	our $SAY_CHANNEL = {
		2386	id => "say",
		2387	title => "Map",
		2388	reply => "say ",
		2389	tooltip => "Things said to and replied from npcs near you and other players on the same map only.",
		2390	};
		2391
		2392	our $CHAT_CHANNEL = {
		2393	id => "chat",
		2394	title => "Chat",
		2395	reply => "chat ",
		2396	tooltip => "Player chat and shouts, global to the server.",
		2397	};
1652		2398
1653	# rough implementation of a future "reply" method that works	2399	# rough implementation of a future "reply" method that works
1654	# with dialog boxes.	2400	# with dialog boxes.
1655	#TODO: the first argument must go, split into a $npc->reply_to ( method	2401	#TODO: the first argument must go, split into a $npc->reply_to ( method
1656	sub cf::object::player::reply($$$;$) {	2402	sub cf::object::player::reply($$$;$) {
…		…
1658		2404
1659	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2405	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1660		2406
1661	if ($self->{record_replies}) {	2407	if ($self->{record_replies}) {
1662	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2408	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2409
1663	} else {	2410	} else {
		2411	my $pl = $self->contr;
		2412
		2413	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2414	my $dialog = $pl->{npc_dialog};
		2415	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2416
		2417	} else {
1664	$msg = $npc->name . " says: $msg" if $npc;	2418	$msg = $npc->name . " says: $msg" if $npc;
1665	$self->message ($msg, $flags);	2419	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2420	}
1666	}	2421	}
		2422	}
		2423
		2424	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2425
		2426	=cut
		2427
		2428	sub cf::object::send_msg {
		2429	my $pl = shift->contr
		2430	or return;
		2431	$pl->send_msg (@_);
1667	}	2432	}
1668		2433
1669	=item $player_object->may ("access")	2434	=item $player_object->may ("access")
1670		2435
1671	Returns wether the given player is authorized to access resource "access"	2436	Returns wether the given player is authorized to access resource "access"
…		…
1684		2449
1685	=item $player_object->enter_link	2450	=item $player_object->enter_link
1686		2451
1687	Freezes the player and moves him/her to a special map (C<{link}>).	2452	Freezes the player and moves him/her to a special map (C<{link}>).
1688		2453
1689	The player should be reasonably safe there for short amounts of time. You	2454	The player should be reasonably safe there for short amounts of time (e.g.
1690	I<MUST> call C<leave_link> as soon as possible, though.	2455	for loading a map). You I<MUST> call C<leave_link> as soon as possible,
		2456	though, as the palyer cannot control the character while it is on the link
		2457	map.
1691		2458
1692	Will never block.	2459	Will never block.
1693		2460
1694	=item $player_object->leave_link ($map, $x, $y)	2461	=item $player_object->leave_link ($map, $x, $y)
1695		2462
…		…
1703	=cut	2470	=cut
1704		2471
1705	sub link_map {	2472	sub link_map {
1706	unless ($LINK_MAP) {	2473	unless ($LINK_MAP) {
1707	$LINK_MAP = cf::map::find "{link}"	2474	$LINK_MAP = cf::map::find "{link}"
1708	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };	2475	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1709	$LINK_MAP->load;	2476	$LINK_MAP->load;
1710	}	2477	}
1711		2478
1712	$LINK_MAP	2479	$LINK_MAP
1713	}	2480	}
…		…
1718	$self->deactivate_recursive;	2485	$self->deactivate_recursive;
1719		2486
1720	return if UNIVERSAL::isa $self->map, "ext::map_link";	2487	return if UNIVERSAL::isa $self->map, "ext::map_link";
1721		2488
1722	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2489	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1723	if $self->map;	2490	if $self->map && $self->map->{path} ne "{link}";
1724		2491
1725	$self->enter_map ($LINK_MAP || link_map, 20, 20);	2492	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1726	}	2493	}
1727		2494
1728	sub cf::object::player::leave_link {	2495	sub cf::object::player::leave_link {
1729	my ($self, $map, $x, $y) = @_;	2496	my ($self, $map, $x, $y) = @_;
		2497
		2498	return unless $self->contr->active;
1730		2499
1731	my $link_pos = delete $self->{_link_pos};	2500	my $link_pos = delete $self->{_link_pos};
1732		2501
1733	unless ($map) {	2502	unless ($map) {
1734	# restore original map position	2503	# restore original map position
…		…
1748	# use -1 or undef as default coordinates, not 0, 0	2517	# use -1 or undef as default coordinates, not 0, 0
1749	($x, $y) = ($map->enter_x, $map->enter_y)	2518	($x, $y) = ($map->enter_x, $map->enter_y)
1750	if $x <=0 && $y <= 0;	2519	if $x <=0 && $y <= 0;
1751		2520
1752	$map->load;	2521	$map->load;
1753	$map->load_diag;	2522	$map->load_neighbours;
1754		2523
1755	return unless $self->contr->active;	2524	return unless $self->contr->active;
		2525	$self->flag (cf::FLAG_DEBUG, 0);#d# temp
1756	$self->activate_recursive;	2526	$self->activate_recursive;
		2527
		2528	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1757	$self->enter_map ($map, $x, $y);	2529	$self->enter_map ($map, $x, $y);
1758	}	2530	}
1759		2531
1760	cf::player->attach (	2532	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1761	on_logout => sub {
1762	my ($pl) = @_;
1763		2533
1764	# abort map switching before logout	2534	Moves the player to the given map-path and coordinates by first freezing
1765	if ($pl->ob->{_link_pos}) {	2535	her, loading and preparing them map, calling the provided $check callback
1766	cf::sync_job {	2536	that has to return the map if sucecssful, and then unfreezes the player on
1767	$pl->ob->leave_link	2537	the new (success) or old (failed) map position. In either case, $done will
1768	};	2538	be called at the end of this process.
1769	}
1770	},
1771	on_login => sub {
1772	my ($pl) = @_;
1773		2539
1774	# try to abort aborted map switching on player login :)	2540	Note that $check will be called with a potentially non-loaded map, so if
1775	# should happen only on crashes	2541	it needs a loaded map it has to call C<< ->load >>.
1776	if ($pl->ob->{_link_pos}) {
1777	$pl->ob->enter_link;
1778	(async {
1779	# we need this sleep as the login has a concurrent enter_exit running
1780	# and this sleep increases chances of the player not ending up in scorn
1781	$pl->ob->reply (undef,
1782	"There was an internal problem at your last logout, "
1783	. "the server will try to bring you to your intended destination in a second.",
1784	cf::NDI_RED);
1785	Coro::Timer::sleep 1;
1786	$pl->ob->leave_link;
1787	})->prio (2);
1788	}
1789	},
1790	);
1791		2542
1792	=item $player_object->goto ($path, $x, $y)
1793
1794	=cut	2543	=cut
		2544
		2545	our $GOTOGEN;
1795		2546
1796	sub cf::object::player::goto {	2547	sub cf::object::player::goto {
1797	my ($self, $path, $x, $y) = @_;	2548	my ($self, $path, $x, $y, $check, $done) = @_;
		2549
		2550	# do generation counting so two concurrent goto's will be executed in-order
		2551	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1798		2552
1799	$self->enter_link;	2553	$self->enter_link;
1800		2554
1801	(async {	2555	(async {
1802	my $map = cf::map::find $path;	2556	$Coro::current->{desc} = "player::goto $path $x $y";
		2557
		2558	# *tag paths override both path and x|y
		2559	if ($path =~ /^\*(.*)$/) {
		2560	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2561	my $ob = $obs[rand @obs];
		2562
		2563	# see if we actually can go there
		2564	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2565	$ob = $obs[rand @obs];
		2566	} else {
		2567	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2568	}
		2569	# else put us there anyways for now #d#
		2570
		2571	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2572	} else {
		2573	($path, $x, $y) = (undef, undef, undef);
		2574	}
		2575	}
		2576
		2577	my $map = eval {
		2578	my $map = defined $path ? cf::map::find $path : undef;
		2579
		2580	if ($map) {
1803	$map = $map->customise_for ($self) if $map;	2581	$map = $map->customise_for ($self);
1804		2582	$map = $check->($map) if $check && $map;
1805	# warn "entering ", $map->path, " at ($x, $y)\n"	2583	} else {
1806	# if $map;
1807
1808	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2584	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2585	}
1809		2586
		2587	$map
		2588	};
		2589
		2590	if ($@) {
		2591	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2592	LOG llevError | logBacktrace, Carp::longmess $@;
		2593	}
		2594
		2595	if ($gen == $self->{_goto_generation}) {
		2596	delete $self->{_goto_generation};
1810	$self->leave_link ($map, $x, $y);	2597	$self->leave_link ($map, $x, $y);
		2598	}
		2599
		2600	$done->() if $done;
1811	})->prio (1);	2601	})->prio (1);
1812	}	2602	}
1813		2603
1814	=item $player_object->enter_exit ($exit_object)	2604	=item $player_object->enter_exit ($exit_object)
1815		2605
…		…
1817		2607
1818	sub parse_random_map_params {	2608	sub parse_random_map_params {
1819	my ($spec) = @_;	2609	my ($spec) = @_;
1820		2610
1821	my $rmp = { # defaults	2611	my $rmp = { # defaults
1822	xsize => 10,	2612	xsize => (cf::rndm 15, 40),
1823	ysize => 10,	2613	ysize => (cf::rndm 15, 40),
		2614	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2615	#layout => string,
1824	};	2616	};
1825		2617
1826	for (split /\n/, $spec) {	2618	for (split /\n/, $spec) {
1827	my ($k, $v) = split /\s+/, $_, 2;	2619	my ($k, $v) = split /\s+/, $_, 2;
1828		2620
…		…
1840	# that depends on the exit object	2632	# that depends on the exit object
1841		2633
1842	my $rmp = parse_random_map_params $exit->msg;	2634	my $rmp = parse_random_map_params $exit->msg;
1843		2635
1844	if ($exit->map) {	2636	if ($exit->map) {
1845	$rmp->{region} = $exit->map->region_name;	2637	$rmp->{region} = $exit->region->name;
1846	$rmp->{origin_map} = $exit->map->path;	2638	$rmp->{origin_map} = $exit->map->path;
1847	$rmp->{origin_x} = $exit->x;	2639	$rmp->{origin_x} = $exit->x;
1848	$rmp->{origin_y} = $exit->y;	2640	$rmp->{origin_y} = $exit->y;
		2641
		2642	$exit->map->touch;
1849	}	2643	}
1850		2644
1851	$rmp->{random_seed} ||= $exit->random_seed;	2645	$rmp->{random_seed} ||= $exit->random_seed;
1852		2646
1853	my $data = cf::to_json $rmp;	2647	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1854	my $md5 = Digest::MD5::md5_hex $data;	2648	my $md5 = Digest::MD5::md5_hex $data;
		2649	my $meta = "$RANDOMDIR/$md5.meta";
1855		2650
1856	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2651	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1857	aio_write $fh, 0, (length $data), $data, 0;	2652	aio_write $fh, 0, (length $data), $data, 0;
		2653	undef $fh;
		2654	aio_rename "$meta~", $meta;
1858		2655
		2656	my $slaying = "?random/$md5";
		2657
		2658	if ($exit->valid) {
1859	$exit->slaying ("?random/$md5");	2659	$exit->slaying ("?random/$md5");
1860	$exit->msg (undef);	2660	$exit->msg (undef);
		2661	}
1861	}	2662	}
1862	}	2663	}
1863		2664
1864	sub cf::object::player::enter_exit {	2665	sub cf::object::player::enter_exit {
1865	my ($self, $exit) = @_;	2666	my ($self, $exit) = @_;
…		…
1867	return unless $self->type == cf::PLAYER;	2668	return unless $self->type == cf::PLAYER;
1868		2669
1869	$self->enter_link;	2670	$self->enter_link;
1870		2671
1871	(async {	2672	(async {
1872	$self->deactivate_recursive; # just to be sure	2673	$Coro::current->{desc} = "enter_exit";
		2674
1873	unless (eval {	2675	unless (eval {
		2676	$self->deactivate_recursive; # just to be sure
		2677
		2678	# random map handling
		2679	{
		2680	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2681
1874	prepare_random_map $exit	2682	prepare_random_map $exit
1875	if $exit->slaying eq "/!";	2683	if $exit->slaying eq "/!";
		2684	}
1876		2685
1877	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;	2686	my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1878	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);	2687	my $x = $exit->stats->hp;
		2688	my $y = $exit->stats->sp;
1879		2689
		2690	$self->goto ($map, $x, $y);
		2691
		2692	# if exit is damned, update players death & WoR home-position
		2693	$self->contr->savebed ($map, $x, $y)
		2694	if $exit->flag (cf::FLAG_DAMNED);
		2695
1880	1;	2696	1
1881	}) {	2697	}) {
1882	$self->message ("Something went wrong deep within the crossfire server. "	2698	$self->message ("Something went wrong deep within the deliantra server. "
1883	. "I'll try to bring you back to the map you were before. "	2699	. "I'll try to bring you back to the map you were before. "
1884	. "Please report this to the dungeon master!",	2700	. "Please report this to the dungeon master!",
1885	cf::NDI_UNIQUE | cf::NDI_RED);	2701	cf::NDI_UNIQUE | cf::NDI_RED);
1886		2702
1887	warn "ERROR in enter_exit: $@";	2703	warn "ERROR in enter_exit: $@";
1888	$self->leave_link;	2704	$self->leave_link;
1889	}	2705	}
1890	})->prio (1);	2706	})->prio (1);
…		…
1903		2719
1904	sub cf::client::send_drawinfo {	2720	sub cf::client::send_drawinfo {
1905	my ($self, $text, $flags) = @_;	2721	my ($self, $text, $flags) = @_;
1906		2722
1907	utf8::encode $text;	2723	utf8::encode $text;
1908	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2724	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1909	}	2725	}
1910		2726
		2727	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2728
		2729	Send a drawinfo or msg packet to the client, formatting the msg for the
		2730	client if neccessary. C<$type> should be a string identifying the type of
		2731	the message, with C<log> being the default. If C<$color> is negative, suppress
		2732	the message unless the client supports the msg packet.
		2733
		2734	=cut
		2735
		2736	# non-persistent channels (usually the info channel)
		2737	our %CHANNEL = (
		2738	"c/identify" => {
		2739	id => "infobox",
		2740	title => "Identify",
		2741	reply => undef,
		2742	tooltip => "Items recently identified",
		2743	},
		2744	"c/examine" => {
		2745	id => "infobox",
		2746	title => "Examine",
		2747	reply => undef,
		2748	tooltip => "Signs and other items you examined",
		2749	},
		2750	"c/book" => {
		2751	id => "infobox",
		2752	title => "Book",
		2753	reply => undef,
		2754	tooltip => "The contents of a note or book",
		2755	},
		2756	"c/lookat" => {
		2757	id => "infobox",
		2758	title => "Look",
		2759	reply => undef,
		2760	tooltip => "What you saw there",
		2761	},
		2762	"c/who" => {
		2763	id => "infobox",
		2764	title => "Players",
		2765	reply => undef,
		2766	tooltip => "Shows players who are currently online",
		2767	},
		2768	"c/body" => {
		2769	id => "infobox",
		2770	title => "Body Parts",
		2771	reply => undef,
		2772	tooltip => "Shows which body parts you posess and are available",
		2773	},
		2774	"c/skills" => {
		2775	id => "infobox",
		2776	title => "Skills",
		2777	reply => undef,
		2778	tooltip => "Shows your experience per skill and item power",
		2779	},
		2780	"c/uptime" => {
		2781	id => "infobox",
		2782	title => "Uptime",
		2783	reply => undef,
		2784	tooltip => "How long the server has been running since last restart",
		2785	},
		2786	"c/mapinfo" => {
		2787	id => "infobox",
		2788	title => "Map Info",
		2789	reply => undef,
		2790	tooltip => "Information related to the maps",
		2791	},
		2792	"c/party" => {
		2793	id => "party",
		2794	title => "Party",
		2795	reply => "gsay ",
		2796	tooltip => "Messages and chat related to your party",
		2797	},
		2798	"c/death" => {
		2799	id => "death",
		2800	title => "Death",
		2801	reply => undef,
		2802	tooltip => "Reason for and more info about your most recent death",
		2803	},
		2804	"c/say" => $SAY_CHANNEL,
		2805	"c/chat" => $CHAT_CHANNEL,
		2806	);
		2807
		2808	sub cf::client::send_msg {
		2809	my ($self, $channel, $msg, $color, @extra) = @_;
		2810
		2811	$msg = $self->pl->expand_cfpod ($msg)
		2812	unless $color & cf::NDI_VERBATIM;
		2813
		2814	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2815
		2816	# check predefined channels, for the benefit of C
		2817	if ($CHANNEL{$channel}) {
		2818	$channel = $CHANNEL{$channel};
		2819
		2820	$self->ext_msg (channel_info => $channel);
		2821	$channel = $channel->{id};
		2822
		2823	} elsif (ref $channel) {
		2824	# send meta info to client, if not yet sent
		2825	unless (exists $self->{channel}{$channel->{id}}) {
		2826	$self->{channel}{$channel->{id}} = $channel;
		2827	$self->ext_msg (channel_info => $channel);
		2828	}
		2829
		2830	$channel = $channel->{id};
		2831	}
		2832
		2833	return unless @extra || length $msg;
		2834
		2835	# default colour, mask it out
		2836	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2837	if $color & cf::NDI_DEF;
		2838
		2839	my $pkt = "msg "
		2840	. $self->{json_coder}->encode (
		2841	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
		2842	);
		2843
		2844	# try lzf for large packets
		2845	$pkt = "lzf " . Compress::LZF::compress $pkt
		2846	if 1024 <= length $pkt and $self->{can_lzf};
		2847
		2848	# split very large packets
		2849	if (8192 < length $pkt and $self->{can_lzf}) {
		2850	$self->send_packet ("frag $_") for unpack "(a8192)*", $pkt;
		2851	$pkt = "frag";
		2852	}
		2853
		2854	$self->send_packet ($pkt);
		2855	}
		2856
		2857	=item $client->ext_msg ($type, @msg)
		2858
		2859	Sends an ext event to the client.
		2860
		2861	=cut
		2862
		2863	sub cf::client::ext_msg($$@) {
		2864	my ($self, $type, @msg) = @_;
		2865
		2866	if ($self->extcmd == 2) {
		2867	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2868	} elsif ($self->extcmd == 1) { # TODO: remove
		2869	push @msg, msgtype => "event_$type";
		2870	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2871	}
		2872	}
		2873
		2874	=item $client->ext_reply ($msgid, @msg)
		2875
		2876	Sends an ext reply to the client.
		2877
		2878	=cut
		2879
		2880	sub cf::client::ext_reply($$@) {
		2881	my ($self, $id, @msg) = @_;
		2882
		2883	if ($self->extcmd == 2) {
		2884	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2885	} elsif ($self->extcmd == 1) {
		2886	#TODO: version 1, remove
		2887	unshift @msg, msgtype => "reply", msgid => $id;
		2888	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2889	}
		2890	}
1911		2891
1912	=item $success = $client->query ($flags, "text", \&cb)	2892	=item $success = $client->query ($flags, "text", \&cb)
1913		2893
1914	Queues a query to the client, calling the given callback with	2894	Queues a query to the client, calling the given callback with
1915	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2895	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1916	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2896	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1917		2897
1918	Queries can fail, so check the return code. Or don't, as queries will become	2898	Queries can fail, so check the return code. Or don't, as queries will
1919	reliable at some point in the future.	2899	become reliable at some point in the future.
1920		2900
1921	=cut	2901	=cut
1922		2902
1923	sub cf::client::query {	2903	sub cf::client::query {
1924	my ($self, $flags, $text, $cb) = @_;	2904	my ($self, $flags, $text, $cb) = @_;
…		…
1932	utf8::encode $text;	2912	utf8::encode $text;
1933	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2913	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1934		2914
1935	$self->send_packet ($self->{query_queue}[0][0])	2915	$self->send_packet ($self->{query_queue}[0][0])
1936	if @{ $self->{query_queue} } == 1;	2916	if @{ $self->{query_queue} } == 1;
		2917
		2918	1
1937	}	2919	}
1938		2920
1939	cf::client->attach (	2921	cf::client->attach (
		2922	on_connect => sub {
		2923	my ($ns) = @_;
		2924
		2925	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2926	},
1940	on_reply => sub {	2927	on_reply => sub {
1941	my ($ns, $msg) = @_;	2928	my ($ns, $msg) = @_;
1942		2929
1943	# this weird shuffling is so that direct followup queries	2930	# this weird shuffling is so that direct followup queries
1944	# get handled first	2931	# get handled first
1945	my $queue = delete $ns->{query_queue}	2932	my $queue = delete $ns->{query_queue}
1946	or return; # be conservative, not sure how that can happen, but we saw a crash here	2933	or return; # be conservative, not sure how that can happen, but we saw a crash here
1947		2934
1948	(shift @$queue)->[1]->($msg);	2935	(shift @$queue)->[1]->($msg);
		2936	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1949		2937
1950	push @{ $ns->{query_queue} }, @$queue;	2938	push @{ $ns->{query_queue} }, @$queue;
1951		2939
1952	if (@{ $ns->{query_queue} } == @$queue) {	2940	if (@{ $ns->{query_queue} } == @$queue) {
1953	if (@$queue) {	2941	if (@$queue) {
…		…
1955	} else {	2943	} else {
1956	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2944	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1957	}	2945	}
1958	}	2946	}
1959	},	2947	},
		2948	on_exticmd => sub {
		2949	my ($ns, $buf) = @_;
		2950
		2951	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2952
		2953	if (ref $msg) {
		2954	my ($type, $reply, @payload) =
		2955	"ARRAY" eq ref $msg
		2956	? @$msg
		2957	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2958
		2959	my @reply;
		2960
		2961	if (my $cb = $EXTICMD{$type}) {
		2962	@reply = $cb->($ns, @payload);
		2963	}
		2964
		2965	$ns->ext_reply ($reply, @reply)
		2966	if $reply;
		2967
		2968	} else {
		2969	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2970	}
		2971
		2972	cf::override;
		2973	},
1960	);	2974	);
1961		2975
1962	=item $client->async (\&cb)	2976	=item $client->async (\&cb)
1963		2977
1964	Create a new coroutine, running the specified callback. The coroutine will	2978	Create a new coroutine, running the specified callback. The coroutine will
…		…
2005	our $safe = new Safe "safe";	3019	our $safe = new Safe "safe";
2006	our $safe_hole = new Safe::Hole;	3020	our $safe_hole = new Safe::Hole;
2007		3021
2008	$SIG{FPE} = 'IGNORE';	3022	$SIG{FPE} = 'IGNORE';
2009		3023
2010	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3024	$safe->permit_only (Opcode::opset qw(
		3025	:base_core :base_mem :base_orig :base_math
		3026	grepstart grepwhile mapstart mapwhile
		3027	sort time
		3028	));
2011		3029
2012	# here we export the classes and methods available to script code	3030	# here we export the classes and methods available to script code
2013		3031
2014	=pod	3032	=pod
2015		3033
2016	The following fucntions and emthods are available within a safe environment:	3034	The following functions and methods are available within a safe environment:
2017		3035
2018	cf::object contr pay_amount pay_player map	3036	cf::object
		3037	contr pay_amount pay_player map x y force_find force_add destroy
		3038	insert remove name archname title slaying race decrease split
		3039
2019	cf::object::player player	3040	cf::object::player
2020	cf::player peaceful	3041	player
2021	cf::map trigger	3042
		3043	cf::player
		3044	peaceful
		3045
		3046	cf::map
		3047	trigger
2022		3048
2023	=cut	3049	=cut
2024		3050
2025	for (	3051	for (
2026	["cf::object" => qw(contr pay_amount pay_player map)],	3052	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3053	insert remove inv nrof name archname title slaying race
		3054	decrease split destroy change_exp)],
2027	["cf::object::player" => qw(player)],	3055	["cf::object::player" => qw(player)],
2028	["cf::player" => qw(peaceful)],	3056	["cf::player" => qw(peaceful)],
2029	["cf::map" => qw(trigger)],	3057	["cf::map" => qw(trigger)],
2030	) {	3058	) {
2031	no strict 'refs';	3059	no strict 'refs';
…		…
2102	=back	3130	=back
2103		3131
2104	=cut	3132	=cut
2105		3133
2106	#############################################################################	3134	#############################################################################
		3135	# the server's init and main functions
2107		3136
2108	=head2 EXTENSION DATABASE SUPPORT	3137	sub load_facedata($) {
		3138	my ($path) = @_;
2109		3139
2110	Crossfire maintains a very simple database for extension use. It can	3140	# HACK to clear player env face cache, we need some signal framework
2111	currently store anything that can be serialised using Storable, which	3141	# for this (global event?)
2112	excludes objects.	3142	%ext::player_env::MUSIC_FACE_CACHE = ();
2113		3143
2114	The parameter C<$family> should best start with the name of the extension	3144	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2115	using it, it should be unique.
2116		3145
2117	=over 4	3146	warn "loading facedata from $path\n";
2118		3147
2119	=item $hashref = cf::db_get $family	3148	my $facedata;
		3149	0 < aio_load $path, $facedata
		3150	or die "$path: $!";
2120		3151
2121	Return a hashref for use by the extension C<$family>, which can be	3152	$facedata = Coro::Storable::thaw $facedata;
2122	modified. After modifications, you have to call C<cf::db_dirty> or
2123	C<cf::db_sync>.
2124		3153
2125	=item $value = cf::db_get $family => $key	3154	$facedata->{version} == 2
		3155	or cf::cleanup "$path: version mismatch, cannot proceed.";
2126		3156
2127	Returns a single value from the database	3157	# patch in the exptable
2128		3158	$facedata->{resource}{"res/exp_table"} = {
2129	=item cf::db_put $family => $hashref	3159	type => FT_RSRC,
2130		3160	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2131	Stores the given family hashref into the database. Updates are delayed, if
2132	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2133
2134	=item cf::db_put $family => $key => $value
2135
2136	Stores the given C<$value> in the family hash. Updates are delayed, if you
2137	want the data to be synced to disk immediately, use C<cf::db_sync>.
2138
2139	=item cf::db_dirty
2140
2141	Marks the database as dirty, to be updated at a later time.
2142
2143	=item cf::db_sync
2144
2145	Immediately write the database to disk I<if it is dirty>.
2146
2147	=cut
2148
2149	our $DB;
2150
2151	{
2152	my $path = cf::localdir . "/database.pst";
2153
2154	sub db_load() {
2155	$DB = stat $path ? Storable::retrieve $path : { };
2156	}
2157
2158	my $pid;
2159
2160	sub db_save() {
2161	waitpid $pid, 0 if $pid;
2162	if (0 == ($pid = fork)) {
2163	$DB->{_meta}{version} = 1;
2164	Storable::nstore $DB, "$path~";
2165	rename "$path~", $path;
2166	cf::_exit 0 if defined $pid;
2167	}
2168	}
2169
2170	my $dirty;
2171
2172	sub db_sync() {
2173	db_save if $dirty;
2174	undef $dirty;
2175	}
2176
2177	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2178	db_sync;
2179	});	3161	};
		3162	cf::cede_to_tick;
2180		3163
2181	sub db_dirty() {
2182	$dirty = 1;
2183	$idle->start;
2184	}	3164	{
		3165	my $faces = $facedata->{faceinfo};
2185		3166
2186	sub db_get($;$) {	3167	while (my ($face, $info) = each %$faces) {
2187	@_ >= 2	3168	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2188	? $DB->{$_[0]}{$_[1]}
2189	: ($DB->{$_[0]} ||= { })
2190	}
2191		3169
2192	sub db_put($$;$) {	3170	cf::face::set_visibility $idx, $info->{visibility};
2193	if (@_ >= 3) {	3171	cf::face::set_magicmap $idx, $info->{magicmap};
2194	$DB->{$_[0]}{$_[1]} = $_[2];	3172	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2195	} else {	3173	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2196	$DB->{$_[0]} = $_[1];
2197	}
2198	db_dirty;
2199	}
2200		3174
2201	cf::global->attach (	3175	cf::cede_to_tick;
2202	prio => 10000,
2203	on_cleanup => sub {
2204	db_sync;
2205	},	3176	}
2206	);
2207	}
2208		3177
2209	#############################################################################	3178	while (my ($face, $info) = each %$faces) {
2210	# the server's main()	3179	next unless $info->{smooth};
2211		3180
2212	sub cfg_load {	3181	my $idx = cf::face::find $face
		3182	or next;
		3183
		3184	if (my $smooth = cf::face::find $info->{smooth}) {
		3185	cf::face::set_smooth $idx, $smooth;
		3186	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3187	} else {
		3188	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3189	}
		3190
		3191	cf::cede_to_tick;
		3192	}
		3193	}
		3194
		3195	{
		3196	my $anims = $facedata->{animinfo};
		3197
		3198	while (my ($anim, $info) = each %$anims) {
		3199	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3200	cf::cede_to_tick;
		3201	}
		3202
		3203	cf::anim::invalidate_all; # d'oh
		3204	}
		3205
		3206	{
		3207	# TODO: for gcfclient pleasure, we should give resources
		3208	# that gcfclient doesn't grok a >10000 face index.
		3209	my $res = $facedata->{resource};
		3210
		3211	while (my ($name, $info) = each %$res) {
		3212	if (defined $info->{type}) {
		3213	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3214	my $data;
		3215
		3216	if ($info->{type} & 1) {
		3217	# prepend meta info
		3218
		3219	my $meta = $enc->encode ({
		3220	name => $name,
		3221	%{ $info->{meta} || {} },
		3222	});
		3223
		3224	$data = pack "(w/a*)*", $meta, $info->{data};
		3225	} else {
		3226	$data = $info->{data};
		3227	}
		3228
		3229	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3230	cf::face::set_type $idx, $info->{type};
		3231	} else {
		3232	$RESOURCE{$name} = $info;
		3233	}
		3234
		3235	cf::cede_to_tick;
		3236	}
		3237	}
		3238
		3239	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3240
		3241	1
		3242	}
		3243
		3244	cf::global->attach (on_resource_update => sub {
		3245	if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
		3246	$soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
		3247
		3248	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3249	my $sound = $soundconf->{compat}[$_]
		3250	or next;
		3251
		3252	my $face = cf::face::find "sound/$sound->[1]";
		3253	cf::sound::set $sound->[0] => $face;
		3254	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3255	}
		3256
		3257	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3258	my $face = cf::face::find "sound/$v";
		3259	cf::sound::set $k => $face;
		3260	}
		3261	}
		3262	});
		3263
		3264	register_exticmd fx_want => sub {
		3265	my ($ns, $want) = @_;
		3266
		3267	while (my ($k, $v) = each %$want) {
		3268	$ns->fx_want ($k, $v);
		3269	}
		3270	};
		3271
		3272	sub load_resource_file($) {
		3273	my $guard = lock_acquire "load_resource_file";
		3274
		3275	my $status = load_resource_file_ $_[0];
		3276	get_slot 0.1, 100;
		3277	cf::arch::commit_load;
		3278
		3279	$status
		3280	}
		3281
		3282	sub reload_regions {
		3283	# HACK to clear player env face cache, we need some signal framework
		3284	# for this (global event?)
		3285	%ext::player_env::MUSIC_FACE_CACHE = ();
		3286
		3287	load_resource_file "$MAPDIR/regions"
		3288	or die "unable to load regions file\n";
		3289
		3290	for (cf::region::list) {
		3291	$_->{match} = qr/$_->{match}/
		3292	if exists $_->{match};
		3293	}
		3294	}
		3295
		3296	sub reload_facedata {
		3297	load_facedata "$DATADIR/facedata"
		3298	or die "unable to load facedata\n";
		3299	}
		3300
		3301	sub reload_archetypes {
		3302	load_resource_file "$DATADIR/archetypes"
		3303	or die "unable to load archetypes\n";
		3304	}
		3305
		3306	sub reload_treasures {
		3307	load_resource_file "$DATADIR/treasures"
		3308	or die "unable to load treasurelists\n";
		3309	}
		3310
		3311	sub reload_resources {
		3312	warn "reloading resource files...\n";
		3313
		3314	reload_facedata;
		3315	reload_archetypes;
		3316	reload_regions;
		3317	reload_treasures;
		3318
		3319	warn "finished reloading resource files\n";
		3320	}
		3321
		3322	sub reload_config {
2213	open my $fh, "<:utf8", cf::confdir . "/config"	3323	open my $fh, "<:utf8", "$CONFDIR/config"
2214	or return;	3324	or return;
2215		3325
2216	local $/;	3326	local $/;
2217	*CFG = YAML::Syck::Load <$fh>;	3327	*CFG = YAML::Load <$fh>;
2218		3328
2219	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3329	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2220		3330
2221	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	3331	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2222	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};	3332	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
…		…
2228	};	3338	};
2229	warn $@ if $@;	3339	warn $@ if $@;
2230	}	3340	}
2231	}	3341	}
2232		3342
		3343	sub pidfile() {
		3344	sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
		3345	or die "$PIDFILE: $!";
		3346	flock $fh, &Fcntl::LOCK_EX
		3347	or die "$PIDFILE: flock: $!";
		3348	$fh
		3349	}
		3350
		3351	# make sure only one server instance is running at any one time
		3352	sub atomic {
		3353	my $fh = pidfile;
		3354
		3355	my $pid = <$fh>;
		3356	kill 9, $pid if $pid > 0;
		3357
		3358	seek $fh, 0, 0;
		3359	print $fh $$;
		3360	}
		3361
2233	sub main {	3362	sub main {
		3363	cf::init_globals; # initialise logging
		3364
		3365	LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
		3366	LOG llevInfo, "Copyright (C) 2005-2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
		3367	LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
		3368	LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
		3369
		3370	cf::init_experience;
		3371	cf::init_anim;
		3372	cf::init_attackmess;
		3373	cf::init_dynamic;
		3374
		3375	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3376
2234	# we must not ever block the main coroutine	3377	# we must not ever block the main coroutine
2235	local $Coro::idle = sub {	3378	local $Coro::idle = sub {
2236	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3379	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2237	async { Event::one_event };	3380	(async {
		3381	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3382	EV::loop EV::LOOP_ONESHOT;
		3383	})->prio (Coro::PRIO_MAX);
2238	};	3384	};
2239		3385
2240	cfg_load;	3386	evthread_start IO::AIO::poll_fileno;
2241	db_load;	3387
		3388	cf::sync_job {
		3389	reload_resources;
		3390	reload_config;
		3391	db_init;
		3392
		3393	cf::load_settings;
		3394	cf::load_materials;
		3395	cf::init_uuid;
		3396	cf::init_signals;
		3397	cf::init_commands;
		3398	cf::init_skills;
		3399
		3400	cf::init_beforeplay;
		3401
		3402	atomic;
		3403
2242	load_extensions;	3404	load_extensions;
		3405
		3406	utime time, time, $RUNTIMEFILE;
		3407
		3408	# no (long-running) fork's whatsoever before this point(!)
		3409	POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
		3410
		3411	(pop @POST_INIT)->(0) while @POST_INIT;
		3412	};
		3413
2243	Event::loop;	3414	EV::loop;
2244	}	3415	}
2245		3416
2246	#############################################################################	3417	#############################################################################
2247	# initialisation and cleanup	3418	# initialisation and cleanup
2248		3419
2249	# install some emergency cleanup handlers	3420	# install some emergency cleanup handlers
2250	BEGIN {	3421	BEGIN {
		3422	our %SIGWATCHER = ();
2251	for my $signal (qw(INT HUP TERM)) {	3423	for my $signal (qw(INT HUP TERM)) {
2252	Event->signal (	3424	$SIGWATCHER{$signal} = EV::signal $signal, sub {
2253	data => WF_AUTOCANCEL,
2254	signal => $signal,
2255	cb => sub {
2256	cf::cleanup "SIG$signal";	3425	cf::cleanup "SIG$signal";
2257	},
2258	);	3426	};
		3427	}
		3428	}
		3429
		3430	sub write_runtime_sync {
		3431	# first touch the runtime file to show we are still running:
		3432	# the fsync below can take a very very long time.
		3433
		3434	IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
		3435
		3436	my $guard = cf::lock_acquire "write_runtime";
		3437
		3438	my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT, 0644
		3439	or return;
		3440
		3441	my $value = $cf::RUNTIME + 90 + 10;
		3442	# 10 is the runtime save interval, for a monotonic clock
		3443	# 60 allows for the watchdog to kill the server.
		3444
		3445	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3446	and return;
		3447
		3448	# always fsync - this file is important
		3449	aio_fsync $fh
		3450	and return;
		3451
		3452	# touch it again to show we are up-to-date
		3453	aio_utime $fh, undef, undef;
		3454
		3455	close $fh
		3456	or return;
		3457
		3458	aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
		3459	and return;
		3460
		3461	warn "runtime file written.\n";
		3462
2259	}	3463	1
		3464	}
		3465
		3466	our $uuid_lock;
		3467	our $uuid_skip;
		3468
		3469	sub write_uuid_sync($) {
		3470	$uuid_skip ||= $_[0];
		3471
		3472	return if $uuid_lock;
		3473	local $uuid_lock = 1;
		3474
		3475	my $uuid = "$LOCALDIR/uuid";
		3476
		3477	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3478	or return;
		3479
		3480	my $value = uuid_seq uuid_cur;
		3481
		3482	unless ($value) {
		3483	warn "cowardly refusing to write zero uuid value!\n";
		3484	return;
		3485	}
		3486
		3487	my $value = uuid_str $value + $uuid_skip;
		3488	$uuid_skip = 0;
		3489
		3490	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3491	and return;
		3492
		3493	# always fsync - this file is important
		3494	aio_fsync $fh
		3495	and return;
		3496
		3497	close $fh
		3498	or return;
		3499
		3500	aio_rename "$uuid~", $uuid
		3501	and return;
		3502
		3503	warn "uuid file written ($value).\n";
		3504
		3505	1
		3506
		3507	}
		3508
		3509	sub write_uuid($$) {
		3510	my ($skip, $sync) = @_;
		3511
		3512	$sync ? write_uuid_sync $skip
		3513	: async { write_uuid_sync $skip };
2260	}	3514	}
2261		3515
2262	sub emergency_save() {	3516	sub emergency_save() {
2263	my $freeze_guard = cf::freeze_mainloop;	3517	my $freeze_guard = cf::freeze_mainloop;
2264		3518
2265	warn "enter emergency perl save\n";	3519	warn "emergency_perl_save: enter\n";
2266		3520
2267	cf::sync_job {	3521	cf::sync_job {
		3522	# this is a trade-off: we want to be very quick here, so
		3523	# save all maps without fsync, and later call a global sync
		3524	# (which in turn might be very very slow)
		3525	local $USE_FSYNC = 0;
		3526
2268	# use a peculiar iteration method to avoid tripping on perl	3527	# use a peculiar iteration method to avoid tripping on perl
2269	# refcount bugs in for. also avoids problems with players	3528	# refcount bugs in for. also avoids problems with players
2270	# and maps saved/destroyed asynchronously.	3529	# and maps saved/destroyed asynchronously.
2271	warn "begin emergency player save\n";	3530	warn "emergency_perl_save: begin player save\n";
2272	for my $login (keys %cf::PLAYER) {	3531	for my $login (keys %cf::PLAYER) {
2273	my $pl = $cf::PLAYER{$login} or next;	3532	my $pl = $cf::PLAYER{$login} or next;
2274	$pl->valid or next;	3533	$pl->valid or next;
		3534	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2275	$pl->save;	3535	$pl->save;
2276	}	3536	}
2277	warn "end emergency player save\n";	3537	warn "emergency_perl_save: end player save\n";
2278		3538
2279	warn "begin emergency map save\n";	3539	warn "emergency_perl_save: begin map save\n";
2280	for my $path (keys %cf::MAP) {	3540	for my $path (keys %cf::MAP) {
2281	my $map = $cf::MAP{$path} or next;	3541	my $map = $cf::MAP{$path} or next;
2282	$map->valid or next;	3542	$map->valid or next;
2283	$map->save;	3543	$map->save;
2284	}	3544	}
2285	warn "end emergency map save\n";	3545	warn "emergency_perl_save: end map save\n";
		3546
		3547	warn "emergency_perl_save: begin database checkpoint\n";
		3548	BDB::db_env_txn_checkpoint $DB_ENV;
		3549	warn "emergency_perl_save: end database checkpoint\n";
		3550
		3551	warn "emergency_perl_save: begin write uuid\n";
		3552	write_uuid_sync 1;
		3553	warn "emergency_perl_save: end write uuid\n";
2286	};	3554	};
2287		3555
		3556	warn "emergency_perl_save: starting sync()\n";
		3557	IO::AIO::aio_sync sub {
		3558	warn "emergency_perl_save: finished sync()\n";
		3559	};
		3560
2288	warn "leave emergency perl save\n";	3561	warn "emergency_perl_save: leave\n";
2289	}	3562	}
2290		3563
		3564	sub post_cleanup {
		3565	my ($make_core) = @_;
		3566
		3567	warn Carp::longmess "post_cleanup backtrace"
		3568	if $make_core;
		3569
		3570	my $fh = pidfile;
		3571	unlink $PIDFILE if <$fh> == $$;
		3572	}
		3573
		3574	# a safer delete_package, copied from Symbol
		3575	sub clear_package($) {
		3576	my $pkg = shift;
		3577
		3578	# expand to full symbol table name if needed
		3579	unless ($pkg =~ /^main::.*::$/) {
		3580	$pkg = "main$pkg" if $pkg =~ /^::/;
		3581	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		3582	$pkg .= '::' unless $pkg =~ /::$/;
		3583	}
		3584
		3585	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		3586	my $stem_symtab = *{$stem}{HASH};
		3587
		3588	defined $stem_symtab and exists $stem_symtab->{$leaf}
		3589	or return;
		3590
		3591	# clear all symbols
		3592	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		3593	for my $name (keys %$leaf_symtab) {
		3594	_gv_clear *{"$pkg$name"};
		3595	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		3596	}
		3597	warn "cleared package $pkg\n";#d#
		3598	}
		3599
2291	sub reload() {	3600	sub do_reload_perl() {
2292	# can/must only be called in main	3601	# can/must only be called in main
2293	if ($Coro::current != $Coro::main) {	3602	if ($Coro::current != $Coro::main) {
2294	warn "can only reload from main coroutine\n";	3603	warn "can only reload from main coroutine";
2295	return;	3604	return;
2296	}	3605	}
2297		3606
		3607	return if $RELOAD++;
		3608
		3609	my $t1 = EV::time;
		3610
		3611	while ($RELOAD) {
2298	warn "reloading...";	3612	warn "reloading...";
2299		3613
2300	warn "freezing server";	3614	warn "entering sync_job";
2301	my $guard = freeze_mainloop;	3615
		3616	cf::sync_job {
		3617	cf::write_runtime_sync; # external watchdog should not bark
2302	cf::emergency_save;	3618	cf::emergency_save;
		3619	cf::write_runtime_sync; # external watchdog should not bark
2303		3620
2304	warn "sync database to disk";	3621	warn "syncing database to disk";
2305	cf::db_sync;	3622	BDB::db_env_txn_checkpoint $DB_ENV;
2306	IO::AIO::flush;
2307		3623
2308	eval {
2309	# if anything goes wrong in here, we should simply crash as we already saved	3624	# if anything goes wrong in here, we should simply crash as we already saved
2310		3625
2311	warn "cancel all watchers";	3626	warn "flushing outstanding aio requests";
2312	for (Event::all_watchers) {	3627	while (IO::AIO::nreqs || BDB::nreqs) {
2313	$_->cancel if $_->data & WF_AUTOCANCEL;	3628	Coro::EV::timer_once 0.01; # let the sync_job do it's thing
2314	}
2315
2316	warn "cancel all extension coros";
2317	$_->cancel for values %EXT_CORO;
2318	%EXT_CORO = ();
2319
2320	warn "remove commands";
2321	%COMMAND = ();
2322
2323	warn "remove ext commands";
2324	%EXTCMD = ();
2325
2326	warn "unload/nuke all extensions";
2327	for my $pkg (@EXTS) {
2328	warn "... unloading $pkg";
2329
2330	if (my $cb = $pkg->can ("unload")) {
2331	eval {
2332	$cb->($pkg);
2333	1
2334	} or warn "$pkg unloaded, but with errors: $@";
2335	}	3629	}
2336		3630
		3631	warn "cancelling all extension coros";
		3632	$_->cancel for values %EXT_CORO;
		3633	%EXT_CORO = ();
		3634
		3635	warn "removing commands";
		3636	%COMMAND = ();
		3637
		3638	warn "removing ext/exti commands";
		3639	%EXTCMD = ();
		3640	%EXTICMD = ();
		3641
		3642	warn "unloading/nuking all extensions";
		3643	for my $pkg (@EXTS) {
2337	warn "... nuking $pkg";	3644	warn "... unloading $pkg";
2338	Symbol::delete_package $pkg;
2339	}
2340		3645
2341	warn "unload all perl modules loaded from $LIBDIR";
2342	while (my ($k, $v) = each %INC) {
2343	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2344
2345	warn "removing <$k>";
2346	delete $INC{$k};
2347
2348	$k =~ s/\.pm$//;
2349	$k =~ s/\//::/g;
2350
2351	if (my $cb = $k->can ("unload_module")) {	3646	if (my $cb = $pkg->can ("unload")) {
		3647	eval {
2352	$cb->();	3648	$cb->($pkg);
		3649	1
		3650	} or warn "$pkg unloaded, but with errors: $@";
		3651	}
		3652
		3653	warn "... clearing $pkg";
		3654	clear_package $pkg;
2353	}	3655	}
2354		3656
2355	Symbol::delete_package $k;	3657	warn "unloading all perl modules loaded from $LIBDIR";
		3658	while (my ($k, $v) = each %INC) {
		3659	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		3660
		3661	warn "... unloading $k";
		3662	delete $INC{$k};
		3663
		3664	$k =~ s/\.pm$//;
		3665	$k =~ s/\//::/g;
		3666
		3667	if (my $cb = $k->can ("unload_module")) {
		3668	$cb->();
		3669	}
		3670
		3671	clear_package $k;
2356	}	3672	}
2357		3673
2358	warn "get rid of safe::, as good as possible";	3674	warn "getting rid of safe::, as good as possible";
2359	Symbol::delete_package "safe::$_"	3675	clear_package "safe::$_"
2360	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3676	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2361		3677
2362	warn "unload cf.pm \"a bit\"";	3678	warn "unloading cf.pm \"a bit\"";
2363	delete $INC{"cf.pm"};	3679	delete $INC{"cf.pm"};
		3680	delete $INC{"cf/pod.pm"};
2364		3681
2365	# don't, removes xs symbols, too,	3682	# don't, removes xs symbols, too,
2366	# and global variables created in xs	3683	# and global variables created in xs
2367	#Symbol::delete_package __PACKAGE__;	3684	#clear_package __PACKAGE__;
2368		3685
		3686	warn "unload completed, starting to reload now";
		3687
2369	warn "reloading cf.pm";	3688	warn "reloading cf.pm";
2370	require cf;	3689	require cf;
2371	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3690	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2372		3691
2373	warn "load config and database again";	3692	warn "loading config and database again";
2374	cf::cfg_load;	3693	cf::reload_config;
2375	cf::db_load;
2376		3694
2377	warn "load extensions";	3695	warn "loading extensions";
2378	cf::load_extensions;	3696	cf::load_extensions;
2379		3697
		3698	if ($REATTACH_ON_RELOAD) {
2380	warn "reattach attachments to objects/players";	3699	warn "reattaching attachments to objects/players";
2381	_global_reattach;	3700	_global_reattach; # objects, sockets
2382	warn "reattach attachments to maps";	3701	warn "reattaching attachments to maps";
2383	reattach $_ for values %MAP;	3702	reattach $_ for values %MAP;
		3703	warn "reattaching attachments to players";
		3704	reattach $_ for values %PLAYER;
		3705	}
		3706
		3707	warn "running post_init jobs";
		3708	(pop @POST_INIT)->(1) while @POST_INIT;
		3709
		3710	warn "leaving sync_job";
		3711
		3712	1
		3713	} or do {
		3714	warn $@;
		3715	cf::cleanup "error while reloading, exiting.";
		3716	};
		3717
		3718	warn "reloaded";
		3719	--$RELOAD;
		3720	}
		3721
		3722	$t1 = EV::time - $t1;
		3723	warn "reload completed in ${t1}s\n";
		3724	};
		3725
		3726	our $RELOAD_WATCHER; # used only during reload
		3727
		3728	sub reload_perl() {
		3729	# doing reload synchronously and two reloads happen back-to-back,
		3730	# coro crashes during coro_state_free->destroy here.
		3731
		3732	$RELOAD_WATCHER ||= cf::async {
		3733	Coro::AIO::aio_wait cache_extensions;
		3734
		3735	$RELOAD_WATCHER = EV::timer $TICK * 1.5, 0, sub {
		3736	do_reload_perl;
		3737	undef $RELOAD_WATCHER;
		3738	};
2384	};	3739	};
2385		3740	}
2386	if ($@) {
2387	warn $@;
2388	warn "error while reloading, exiting.";
2389	exit 1;
2390	}
2391
2392	warn "reloaded";
2393	};
2394		3741
2395	register_command "reload" => sub {	3742	register_command "reload" => sub {
2396	my ($who, $arg) = @_;	3743	my ($who, $arg) = @_;
2397		3744
2398	if ($who->flag (FLAG_WIZ)) {	3745	if ($who->flag (FLAG_WIZ)) {
2399	$who->message ("start of reload.");
2400	reload;
2401	$who->message ("end of reload.");	3746	$who->message ("reloading server.");
		3747	async {
		3748	$Coro::current->{desc} = "perl_reload";
		3749	reload_perl;
		3750	};
2402	}	3751	}
2403	};	3752	};
2404		3753
2405	unshift @INC, $LIBDIR;	3754	unshift @INC, $LIBDIR;
2406		3755
2407	$TICK_WATCHER = Event->timer (	3756	my $bug_warning = 0;
2408	reentrant => 0,
2409	prio => 0,
2410	at => $NEXT_TICK || $TICK,
2411	data => WF_AUTOCANCEL,
2412	cb => sub {
2413	$NOW = Event::time;
2414		3757
		3758	our @WAIT_FOR_TICK;
		3759	our @WAIT_FOR_TICK_BEGIN;
		3760
		3761	sub wait_for_tick {
		3762	return if tick_inhibit || $Coro::current == $Coro::main;
		3763
		3764	my $signal = new Coro::Signal;
		3765	push @WAIT_FOR_TICK, $signal;
		3766	$signal->wait;
		3767	}
		3768
		3769	sub wait_for_tick_begin {
		3770	return if tick_inhibit || $Coro::current == $Coro::main;
		3771
		3772	my $signal = new Coro::Signal;
		3773	push @WAIT_FOR_TICK_BEGIN, $signal;
		3774	$signal->wait;
		3775	}
		3776
		3777	sub tick {
		3778	if ($Coro::current != $Coro::main) {
		3779	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3780	unless ++$bug_warning > 10;
		3781	return;
		3782	}
		3783
2415	cf::server_tick; # one server iteration	3784	cf::server_tick; # one server iteration
2416	$RUNTIME += $TICK;
2417	$NEXT_TICK += $TICK;
2418		3785
2419	$WAIT_FOR_TICK->broadcast;	3786	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2420	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3787	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2421		3788	Coro::async_pool {
2422	# if we are delayed by four ticks or more, skip them all	3789	$Coro::current->{desc} = "runtime saver";
2423	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2424
2425	$TICK_WATCHER->at ($NEXT_TICK);
2426	$TICK_WATCHER->start;
2427	},
2428	);
2429
2430	IO::AIO::max_poll_time $TICK * 0.2;
2431
2432	$AIO_POLL_WATCHER = Event->io (
2433	fd => IO::AIO::poll_fileno,
2434	poll => 'r',
2435	prio => 5,
2436	data => WF_AUTOCANCEL,
2437	cb => \&IO::AIO::poll_cb,
2438	);
2439
2440	$WRITE_RUNTIME_WATCHER = Event->timer (
2441	data => WF_AUTOCANCEL,
2442	after => 0,
2443	interval => 10,
2444	cb => sub {
2445	(Coro::unblock_sub {
2446	write_runtime	3790	write_runtime_sync
2447	or warn "ERROR: unable to write runtime file: $!";	3791	or warn "ERROR: unable to write runtime file: $!";
2448	})->();	3792	};
2449	},	3793	}
2450	);	3794
		3795	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3796	$sig->send;
		3797	}
		3798	while (my $sig = shift @WAIT_FOR_TICK) {
		3799	$sig->send;
		3800	}
		3801
		3802	$LOAD = ($NOW - $TICK_START) / $TICK;
		3803	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3804
		3805	if (0) {
		3806	if ($NEXT_TICK) {
		3807	my $jitter = $TICK_START - $NEXT_TICK;
		3808	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		3809	warn "jitter $JITTER\n";#d#
		3810	}
		3811	}
		3812	}
		3813
		3814	{
		3815	# configure BDB
		3816
		3817	BDB::min_parallel 8;
		3818	BDB::max_poll_reqs $TICK * 0.1;
		3819	$AnyEvent::BDB::WATCHER->priority (1);
		3820
		3821	unless ($DB_ENV) {
		3822	$DB_ENV = BDB::db_env_create;
		3823	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		3824	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		3825	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		3826	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3827	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3828
		3829	cf::sync_job {
		3830	eval {
		3831	BDB::db_env_open
		3832	$DB_ENV,
		3833	$BDBDIR,
		3834	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3835	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3836	0666;
		3837
		3838	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3839	};
		3840
		3841	cf::cleanup "db_env_open(db): $@" if $@;
		3842	};
		3843	}
		3844
		3845	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3846	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3847	};
		3848	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		3849	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3850	};
		3851	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3852	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3853	};
		3854	}
		3855
		3856	{
		3857	# configure IO::AIO
		3858
		3859	IO::AIO::min_parallel 8;
		3860	IO::AIO::max_poll_time $TICK * 0.1;
		3861	undef $AnyEvent::AIO::WATCHER;
		3862	}
		3863
		3864	my $_log_backtrace;
		3865
		3866	sub _log_backtrace {
		3867	my ($msg, @addr) = @_;
		3868
		3869	$msg =~ s/\n//;
		3870
		3871	# limit the # of concurrent backtraces
		3872	if ($_log_backtrace < 2) {
		3873	++$_log_backtrace;
		3874	my $perl_bt = Carp::longmess $msg;
		3875	async {
		3876	$Coro::current->{desc} = "abt $msg";
		3877
		3878	my @bt = fork_call {
		3879	@addr = map { sprintf "%x", $_ } @addr;
		3880	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3881	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3882	or die "addr2line: $!";
		3883
		3884	my @funcs;
		3885	my @res = <$fh>;
		3886	chomp for @res;
		3887	while (@res) {
		3888	my ($func, $line) = splice @res, 0, 2, ();
		3889	push @funcs, "[$func] $line";
		3890	}
		3891
		3892	@funcs
		3893	};
		3894
		3895	LOG llevInfo, "[ABT] $perl_bt\n";
		3896	LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
		3897	LOG llevInfo, "[ABT] $_\n" for @bt;
		3898	--$_log_backtrace;
		3899	};
		3900	} else {
		3901	LOG llevInfo, "[ABT] $msg\n";
		3902	LOG llevInfo, "[ABT] [suppressed]\n";
		3903	}
		3904	}
		3905
		3906	# load additional modules
		3907	use cf::pod;
2451		3908
2452	END { cf::emergency_save }	3909	END { cf::emergency_save }
2453		3910
2454	1	3911	1
2455		3912

Diff Legend

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