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.202 by root, Mon Jan 29 20:16:28 2007 UTC vs.
Revision 1.407 by root, Sun Jan 13 09:53:53 2008 UTC

…		…
3	use utf8;	3	use utf8;
4	use strict;	4	use strict;
5		5
6	use Symbol;	6	use Symbol;
7	use List::Util;	7	use List::Util;
8	use Storable;	8	use Socket;
		9	use EV 1.86;
9	use Opcode;	10	use Opcode;
10	use Safe;	11	use Safe;
11	use Safe::Hole;	12	use Safe::Hole;
		13	use Storable ();
12		14
13	use Coro 3.5 ();	15	use Coro 4.32 ();
		16	use Coro::State;
		17	use Coro::Handle;
14	use Coro::Event;	18	use Coro::EV;
15	use Coro::Timer;	19	use Coro::Timer;
16	use Coro::Signal;	20	use Coro::Signal;
17	use Coro::Semaphore;	21	use Coro::Semaphore;
18	use Coro::AIO;	22	use Coro::AIO;
		23	use Coro::BDB;
		24	use Coro::Storable;
		25	use Coro::Util ();
19		26
		27	use JSON::XS 2.01 ();
		28	use BDB ();
20	use Data::Dumper;	29	use Data::Dumper;
21	use Digest::MD5;	30	use Digest::MD5;
22	use Fcntl;	31	use Fcntl;
23	use IO::AIO 2.32 ();
24	use YAML::Syck ();	32	use YAML::Syck ();
		33	use IO::AIO 2.51 ();
25	use Time::HiRes;	34	use Time::HiRes;
		35	use Compress::LZF;
		36	use Digest::MD5 ();
26		37
27	use Event; $Event::Eval = 1; # no idea why this is required, but it is	38	# configure various modules to our taste
28		39	#
29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	40	$Storable::canonical = 1; # reduce rsync transfers
		41	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		42	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
30		43
31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	44	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32	$YAML::Syck::ImplicitUnicode = 1;	45	$YAML::Syck::ImplicitUnicode = 1;
33		46
34	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority	47	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
35		48
		49	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		50
36	our %COMMAND = ();	51	our %COMMAND = ();
37	our %COMMAND_TIME = ();	52	our %COMMAND_TIME = ();
38		53
39	our @EXTS = (); # list of extension package names	54	our @EXTS = (); # list of extension package names
40	our %EXTCMD = ();	55	our %EXTCMD = ();
		56	our %EXTICMD = ();
41	our %EXT_CORO = (); # coroutines bound to extensions	57	our %EXT_CORO = (); # coroutines bound to extensions
42	our %EXT_MAP = (); # pluggable maps	58	our %EXT_MAP = (); # pluggable maps
43		59
		60	our $RELOAD; # number of reloads so far
44	our @EVENT;	61	our @EVENT;
45	our $LIBDIR = datadir . "/ext";
46		62
47	our $TICK = MAX_TIME * 1e-6;	63	our $CONFDIR = confdir;
		64	our $DATADIR = datadir;
		65	our $LIBDIR = "$DATADIR/ext";
		66	our $PODDIR = "$DATADIR/pod";
		67	our $MAPDIR = "$DATADIR/" . mapdir;
		68	our $LOCALDIR = localdir;
		69	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		70	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		71	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		72	our $RANDOMDIR = "$LOCALDIR/random";
		73	our $BDBDIR = "$LOCALDIR/db";
		74	our %RESOURCE;
		75
		76	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
48	our $TICK_WATCHER;	77	our $TICK_WATCHER;
49	our $AIO_POLL_WATCHER;	78	our $AIO_POLL_WATCHER;
50	our $WRITE_RUNTIME_WATCHER;	79	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
51	our $NEXT_TICK;	80	our $NEXT_TICK;
52	our $NOW;	81	our $USE_FSYNC = 1; # use fsync to write maps - default off
		82
		83	our $BDB_POLL_WATCHER;
		84	our $BDB_DEADLOCK_WATCHER;
		85	our $BDB_CHECKPOINT_WATCHER;
		86	our $BDB_TRICKLE_WATCHER;
		87	our $DB_ENV;
53		88
54	our %CFG;	89	our %CFG;
55		90
56	our $UPTIME; $UPTIME ||= time;	91	our $UPTIME; $UPTIME ||= time;
57	our $RUNTIME;	92	our $RUNTIME;
		93	our $NOW;
58		94
59	our %PLAYER; # all users	95	our (%PLAYER, %PLAYER_LOADING); # all users
60	our %MAP; # all maps	96	our (%MAP, %MAP_LOADING ); # all maps
61	our $LINK_MAP; # the special {link} map, which is always available	97	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		98
67	# used to convert map paths into valid unix filenames by replacing / by ∕	99	# used to convert map paths into valid unix filenames by replacing / by ∕
68	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	100	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69		101
		102	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		103	our $LOADAVG; # same thing, but with alpha-smoothing
		104	our $tick_start; # for load detecting purposes
		105
70	binmode STDOUT;	106	binmode STDOUT;
71	binmode STDERR;	107	binmode STDERR;
72		108
73	# read virtual server time, if available	109	# read virtual server time, if available
74	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	110	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
75	open my $fh, "<", cf::localdir . "/runtime"	111	open my $fh, "<", "$LOCALDIR/runtime"
76	or die "unable to read runtime file: $!";	112	or die "unable to read runtime file: $!";
77	$RUNTIME = <$fh> + 0.;	113	$RUNTIME = <$fh> + 0.;
78	}	114	}
79		115
80	mkdir cf::localdir;	116	mkdir $_
81	mkdir cf::localdir . "/" . cf::playerdir;	117	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
82	mkdir cf::localdir . "/" . cf::tmpdir;
83	mkdir cf::localdir . "/" . cf::uniquedir;
84	mkdir $RANDOM_MAPS;
85		118
86	our $EMERGENCY_POSITION;	119	our $EMERGENCY_POSITION;
87		120
88	sub cf::map::normalise;	121	sub cf::map::normalise;
89		122
…		…
100	=item $cf::RUNTIME	133	=item $cf::RUNTIME
101		134
102	The time this server has run, starts at 0 and is increased by $cf::TICK on	135	The time this server has run, starts at 0 and is increased by $cf::TICK on
103	every server tick.	136	every server tick.
104		137
105	=item $cf::LIBDIR	138	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		139	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		140	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
106		141
107	The perl library directory, where extensions and cf-specific modules can	142	Various directories - "/etc", read-only install directory, perl-library
108	be found. It will be added to C<@INC> automatically.	143	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		144	unique-items directory, player file directory, random maps directory and
		145	database environment.
109		146
110	=item $cf::NOW	147	=item $cf::NOW
111		148
112	The time of the last (current) server tick.	149	The time of the last (current) server tick.
113		150
114	=item $cf::TICK	151	=item $cf::TICK
115		152
116	The interval between server ticks, in seconds.	153	The interval between server ticks, in seconds.
117		154
		155	=item $cf::LOADAVG
		156
		157	The current CPU load on the server (alpha-smoothed), as a value between 0
		158	(none) and 1 (overloaded), indicating how much time is spent on processing
		159	objects per tick. Healthy values are < 0.5.
		160
		161	=item $cf::LOAD
		162
		163	The raw value load value from the last tick.
		164
118	=item %cf::CFG	165	=item %cf::CFG
119		166
120	Configuration for the server, loaded from C</etc/crossfire/config>, or	167	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
121	from wherever your confdir points to.	168	from wherever your confdir points to.
122		169
123	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	170	=item cf::wait_for_tick, cf::wait_for_tick_begin
124		171
125	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	172	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
126	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick	173	returns directly I<after> the tick processing (and consequently, can only wake one process
127	processing has been done. Call C<< ->wait >> on them to maximise the	174	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
128	window of cpu time available, or simply to synchronise to the server tick.	175
		176	=item @cf::INVOKE_RESULTS
		177
		178	This array contains the results of the last C<invoke ()> call. When
		179	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		180	that call.
129		181
130	=back	182	=back
131		183
132	=cut	184	=cut
133		185
134	BEGIN {	186	BEGIN {
135	*CORE::GLOBAL::warn = sub {	187	*CORE::GLOBAL::warn = sub {
136	my $msg = join "", @_;	188	my $msg = join "", @_;
137	utf8::encode $msg;
138		189
139	$msg .= "\n"	190	$msg .= "\n"
140	unless $msg =~ /\n$/;	191	unless $msg =~ /\n$/;
141		192
		193	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		194
142	LOG llevError, $msg;	195	LOG llevError, $msg;
143	};	196	};
144	}	197	}
		198
		199	$Coro::State::DIEHOOK = sub {
		200	warn Carp::longmess $_[0];
		201	Coro::terminate;
		202	};
145		203
146	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	204	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
147	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	205	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
148	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	206	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
149	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	207	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
150	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	208	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		209	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
151	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	210	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
152		211
153	# we bless all objects into (empty) derived classes to force a method lookup	212	# we bless all objects into (empty) derived classes to force a method lookup
154	# within the Safe compartment.	213	# within the Safe compartment.
155	for my $pkg (qw(	214	for my $pkg (qw(
156	cf::global cf::attachable	215	cf::global cf::attachable
…		…
161	)) {	220	)) {
162	no strict 'refs';	221	no strict 'refs';
163	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	222	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
164	}	223	}
165		224
166	$Event::DIED = sub {	225	$EV::DIED = sub {
167	warn "error in event callback: @_";	226	warn "error in event callback: @_";
168	};	227	};
		228
		229	#############################################################################
169		230
170	=head2 UTILITY FUNCTIONS	231	=head2 UTILITY FUNCTIONS
171		232
172	=over 4	233	=over 4
173		234
…		…
192	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	253	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
193	$d	254	$d
194	} || "[unable to dump $_[0]: '$@']";	255	} || "[unable to dump $_[0]: '$@']";
195	}	256	}
196		257
197	use JSON::Syck (); # TODO# replace by JSON::PC once working
198
199	=item $ref = cf::from_json $json	258	=item $ref = cf::decode_json $json
200		259
201	Converts a JSON string into the corresponding perl data structure.	260	Converts a JSON string into the corresponding perl data structure.
202		261
203	=cut
204
205	sub from_json($) {
206	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
207	JSON::Syck::Load $_[0]
208	}
209
210	=item $json = cf::to_json $ref	262	=item $json = cf::encode_json $ref
211		263
212	Converts a perl data structure into its JSON representation.	264	Converts a perl data structure into its JSON representation.
213		265
214	=cut	266	=cut
215		267
216	sub to_json($) {	268	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
217	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	269
218	JSON::Syck::Dump $_[0]	270	sub encode_json($) { $json_coder->encode ($_[0]) }
219	}	271	sub decode_json($) { $json_coder->decode ($_[0]) }
220		272
221	=item cf::lock_wait $string	273	=item cf::lock_wait $string
222		274
223	Wait until the given lock is available. See cf::lock_acquire.	275	Wait until the given lock is available. See cf::lock_acquire.
224		276
…		…
227	Wait until the given lock is available and then acquires it and returns	279	Wait until the given lock is available and then acquires it and returns
228	a Coro::guard object. If the guard object gets destroyed (goes out of scope,	280	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
229	for example when the coroutine gets canceled), the lock is automatically	281	for example when the coroutine gets canceled), the lock is automatically
230	returned.	282	returned.
231		283
		284	Locks are *not* recursive, locking from the same coro twice results in a
		285	deadlocked coro.
		286
232	Lock names should begin with a unique identifier (for example, cf::map::find	287	Lock names should begin with a unique identifier (for example, cf::map::find
233	uses map_find and cf::map::load uses map_load).	288	uses map_find and cf::map::load uses map_load).
234		289
		290	=item $locked = cf::lock_active $string
		291
		292	Return true if the lock is currently active, i.e. somebody has locked it.
		293
235	=cut	294	=cut
236		295
237	our %LOCK;	296	our %LOCK;
		297	our %LOCKER;#d#
238		298
239	sub lock_wait($) {	299	sub lock_wait($) {
240	my ($key) = @_;	300	my ($key) = @_;
		301
		302	if ($LOCKER{$key} == $Coro::current) {#d#
		303	Carp::cluck "lock_wait($key) for already-acquired lock";#d#
		304	return;#d#
		305	}#d#
241		306
242	# wait for lock, if any	307	# wait for lock, if any
243	while ($LOCK{$key}) {	308	while ($LOCK{$key}) {
244	push @{ $LOCK{$key} }, $Coro::current;	309	push @{ $LOCK{$key} }, $Coro::current;
245	Coro::schedule;	310	Coro::schedule;
…		…
251		316
252	# wait, to be sure we are not locked	317	# wait, to be sure we are not locked
253	lock_wait $key;	318	lock_wait $key;
254		319
255	$LOCK{$key} = [];	320	$LOCK{$key} = [];
		321	$LOCKER{$key} = $Coro::current;#d#
256		322
257	Coro::guard {	323	Coro::guard {
		324	delete $LOCKER{$key};#d#
258	# wake up all waiters, to be on the safe side	325	# wake up all waiters, to be on the safe side
259	$_->ready for @{ delete $LOCK{$key} };	326	$_->ready for @{ delete $LOCK{$key} };
260	}	327	}
261	}	328	}
262		329
		330	sub lock_active($) {
		331	my ($key) = @_;
		332
		333	! ! $LOCK{$key}
		334	}
		335
263	sub freeze_mainloop {	336	sub freeze_mainloop {
264	return unless $TICK_WATCHER->is_active;	337	return unless $TICK_WATCHER->is_active;
265		338
266	my $guard = Coro::guard {	339	my $guard = Coro::guard {
267	$TICK_WATCHER->start;	340	$TICK_WATCHER->start;
268	$WRITE_RUNTIME_WATCHER->start;
269	};	341	};
270	$WRITE_RUNTIME_WATCHER->stop;
271	$TICK_WATCHER->stop;	342	$TICK_WATCHER->stop;
272	$guard	343	$guard
		344	}
		345
		346	=item cf::periodic $interval, $cb
		347
		348	Like EV::periodic, but randomly selects a starting point so that the actions
		349	get spread over timer.
		350
		351	=cut
		352
		353	sub periodic($$) {
		354	my ($interval, $cb) = @_;
		355
		356	my $start = rand List::Util::min 180, $interval;
		357
		358	EV::periodic $start, $interval, 0, $cb
		359	}
		360
		361	=item cf::get_slot $time[, $priority[, $name]]
		362
		363	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		364	This call blocks and returns only when you have at least C<$time> seconds
		365	of cpu time till the next tick. The slot is only valid till the next cede.
		366
		367	The optional C<$name> can be used to identify the job to run. It might be
		368	used for statistical purposes and should identify the same time-class.
		369
		370	Useful for short background jobs.
		371
		372	=cut
		373
		374	our @SLOT_QUEUE;
		375	our $SLOT_QUEUE;
		376
		377	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		378	$SLOT_QUEUE = Coro::async {
		379	$Coro::current->desc ("timeslot manager");
		380
		381	my $signal = new Coro::Signal;
		382
		383	while () {
		384	next_job:
		385	my $avail = cf::till_tick;
		386	if ($avail > 0.01) {
		387	for (0 .. $#SLOT_QUEUE) {
		388	if ($SLOT_QUEUE[$_][0] < $avail) {
		389	my $job = splice @SLOT_QUEUE, $_, 1, ();
		390	$job->[2]->send;
		391	Coro::cede;
		392	goto next_job;
		393	}
		394	}
		395	}
		396
		397	if (@SLOT_QUEUE) {
		398	# we do not use wait_for_tick() as it returns immediately when tick is inactive
		399	push @cf::WAIT_FOR_TICK, $signal;
		400	$signal->wait;
		401	} else {
		402	Coro::schedule;
		403	}
		404	}
		405	};
		406
		407	sub get_slot($;$$) {
		408	my ($time, $pri, $name) = @_;
		409
		410	$time = $TICK * .6 if $time > $TICK * .6;
		411	my $sig = new Coro::Signal;
		412
		413	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		414	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		415	$SLOT_QUEUE->ready;
		416	$sig->wait;
273	}	417	}
274		418
275	=item cf::async { BLOCK }	419	=item cf::async { BLOCK }
276		420
277	Currently the same as Coro::async_pool, meaning you cannot use	421	Currently the same as Coro::async_pool, meaning you cannot use
…		…
282		426
283	BEGIN { *async = \&Coro::async_pool }	427	BEGIN { *async = \&Coro::async_pool }
284		428
285	=item cf::sync_job { BLOCK }	429	=item cf::sync_job { BLOCK }
286		430
287	The design of crossfire+ requires that the main coro ($Coro::main) is	431	The design of Deliantra requires that the main coroutine ($Coro::main)
288	always able to handle events or runnable, as crossfire+ is only partly	432	is always able to handle events or runnable, as Deliantra is only
289	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	433	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		434	acceptable.
290		435
291	If it must be done, put the blocking parts into C<sync_job>. This will run	436	If it must be done, put the blocking parts into C<sync_job>. This will run
292	the given BLOCK in another coroutine while waiting for the result. The	437	the given BLOCK in another coroutine while waiting for the result. The
293	server will be frozen during this time, so the block should either finish	438	server will be frozen during this time, so the block should either finish
294	fast or be very important.	439	fast or be very important.
…		…
297		442
298	sub sync_job(&) {	443	sub sync_job(&) {
299	my ($job) = @_;	444	my ($job) = @_;
300		445
301	if ($Coro::current == $Coro::main) {	446	if ($Coro::current == $Coro::main) {
		447	my $time = EV::time;
		448
302	# this is the main coro, too bad, we have to block	449	# this is the main coro, too bad, we have to block
303	# till the operation succeeds, freezing the server :/	450	# till the operation succeeds, freezing the server :/
304		451
		452	LOG llevError, Carp::longmess "sync job";#d#
		453
305	# TODO: use suspend/resume instead	454	# TODO: use suspend/resume instead
306	# (but this is cancel-safe)	455	# (but this is cancel-safe)
307	my $freeze_guard = freeze_mainloop;	456	my $freeze_guard = freeze_mainloop;
308		457
309	my $busy = 1;	458	my $busy = 1;
310	my @res;	459	my @res;
311		460
312	(async {	461	(async {
		462	$Coro::current->desc ("sync job coro");
313	@res = eval { $job->() };	463	@res = eval { $job->() };
314	warn $@ if $@;	464	warn $@ if $@;
315	undef $busy;	465	undef $busy;
316	})->prio (Coro::PRIO_MAX);	466	})->prio (Coro::PRIO_MAX);
317		467
318	while ($busy) {	468	while ($busy) {
319	Coro::cede or Event::one_event;	469	if (Coro::nready) {
		470	Coro::cede_notself;
		471	} else {
		472	EV::loop EV::LOOP_ONESHOT;
320	}	473	}
		474	}
		475
		476	$time = EV::time - $time;
		477
		478	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		479	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		480
		481	$tick_start += $time; # do not account sync jobs to server load
321		482
322	wantarray ? @res : $res[0]	483	wantarray ? @res : $res[0]
323	} else {	484	} else {
324	# we are in another coroutine, how wonderful, everything just works	485	# we are in another coroutine, how wonderful, everything just works
325		486
…		…
345	$EXT_CORO{$coro+0} = $coro;	506	$EXT_CORO{$coro+0} = $coro;
346		507
347	$coro	508	$coro
348	}	509	}
349		510
350	sub write_runtime {	511	=item fork_call { }, $args
351	my $runtime = cf::localdir . "/runtime";
352		512
353	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	513	Executes the given code block with the given arguments in a seperate
354	or return;	514	process, returning the results. Everything must be serialisable with
		515	Coro::Storable. May, of course, block. Note that the executed sub may
		516	never block itself or use any form of event handling.
355		517
356	my $value = $cf::RUNTIME + 90 + 10;	518	=cut
357	# 10 is the runtime save interval, for a monotonic clock
358	# 60 allows for the watchdog to kill the server.
359		519
360	(aio_write $fh, 0, (length $value), $value, 0) <= 0	520	sub fork_call(&@) {
361	and return;	521	my ($cb, @args) = @_;
362		522
363	aio_fsync $fh	523	# we seemingly have to make a local copy of the whole thing,
364	and return;	524	# otherwise perl prematurely frees the stuff :/
		525	# TODO: investigate and fix (likely this will be rather laborious)
365		526
366	close $fh	527	my @res = Coro::Util::fork_eval {
367	or return;	528	reset_signals;
		529	&$cb
		530	}, @args;
368		531
369	aio_rename "$runtime~", $runtime	532	wantarray ? @res : $res[-1]
370	and return;	533	}
371		534
		535	=item $value = cf::db_get $family => $key
		536
		537	Returns a single value from the environment database.
		538
		539	=item cf::db_put $family => $key => $value
		540
		541	Stores the given C<$value> in the family. It can currently store binary
		542	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		543
		544	=item $db = cf::db_table "name"
		545
		546	Create and/or open a new database table. The string must not be "db" and must be unique
		547	within each server.
		548
		549	=cut
		550
		551	sub db_table($) {
		552	my ($name) = @_;
		553	my $db = BDB::db_create $DB_ENV;
		554
		555	eval {
		556	$db->set_flags (BDB::CHKSUM);
		557
		558	utf8::encode $name;
		559	BDB::db_open $db, undef, $name, undef, BDB::BTREE,
		560	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		561	cf::cleanup "db_open(db): $!" if $!;
		562	};
		563	cf::cleanup "db_open(db): $@" if $@;
		564
		565	$db
		566	}
		567
		568	our $DB;
		569
		570	sub db_init {
		571	cf::sync_job {
		572	$DB ||= db_table "db";
		573	};
		574	}
		575
		576	sub db_get($$) {
		577	my $key = "$_[0]/$_[1]";
		578
		579	cf::sync_job {
		580	BDB::db_get $DB, undef, $key, my $data;
		581
		582	$! ? ()
		583	: $data
372	1	584	}
		585	}
		586
		587	sub db_put($$$) {
		588	BDB::dbreq_pri 4;
		589	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		590	}
		591
		592	=item cf::cache $id => [$paths...], $processversion => $process
		593
		594	Generic caching function that returns the value of the resource $id,
		595	caching and regenerating as required.
		596
		597	This function can block.
		598
		599	=cut
		600
		601	sub cache {
		602	my ($id, $src, $processversion, $process) = @_;
		603
		604	my $meta =
		605	join "\x00",
		606	$processversion,
		607	map {
		608	aio_stat $_
		609	and Carp::croak "$_: $!";
		610
		611	($_, (stat _)[7,9])
		612	} @$src;
		613
		614	my $dbmeta = db_get cache => "$id/meta";
		615	if ($dbmeta ne $meta) {
		616	# changed, we may need to process
		617
		618	my @data;
		619	my $md5;
		620
		621	for (0 .. $#$src) {
		622	0 <= aio_load $src->[$_], $data[$_]
		623	or Carp::croak "$src->[$_]: $!";
		624	}
		625
		626	# if processing is expensive, check
		627	# checksum first
		628	if (1) {
		629	$md5 =
		630	join "\x00",
		631	$processversion,
		632	map {
		633	cf::cede_to_tick;
		634	($src->[$_], Digest::MD5::md5_hex $data[$_])
		635	} 0.. $#$src;
		636
		637
		638	my $dbmd5 = db_get cache => "$id/md5";
		639	if ($dbmd5 eq $md5) {
		640	db_put cache => "$id/meta", $meta;
		641
		642	return db_get cache => "$id/data";
		643	}
		644	}
		645
		646	my $t1 = Time::HiRes::time;
		647	my $data = $process->(\@data);
		648	my $t2 = Time::HiRes::time;
		649
		650	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		651
		652	db_put cache => "$id/data", $data;
		653	db_put cache => "$id/md5" , $md5;
		654	db_put cache => "$id/meta", $meta;
		655
		656	return $data;
		657	}
		658
		659	db_get cache => "$id/data"
		660	}
		661
		662	=item cf::datalog type => key => value, ...
		663
		664	Log a datalog packet of the given type with the given key-value pairs.
		665
		666	=cut
		667
		668	sub datalog($@) {
		669	my ($type, %kv) = @_;
		670	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
373	}	671	}
374		672
375	=back	673	=back
376		674
377	=cut	675	=cut
…		…
384	attach callbacks/event handlers (a collection of which is called an "attachment")	682	attach callbacks/event handlers (a collection of which is called an "attachment")
385	to it. All such attachable objects support the following methods.	683	to it. All such attachable objects support the following methods.
386		684
387	In the following description, CLASS can be any of C<global>, C<object>	685	In the following description, CLASS can be any of C<global>, C<object>
388	C<player>, C<client> or C<map> (i.e. the attachable objects in	686	C<player>, C<client> or C<map> (i.e. the attachable objects in
389	crossfire+).	687	Deliantra).
390		688
391	=over 4	689	=over 4
392		690
393	=item $attachable->attach ($attachment, key => $value...)	691	=item $attachable->attach ($attachment, key => $value...)
394		692
…		…
557	$registry = $CB_TYPE[$object_type] ||= [];	855	$registry = $CB_TYPE[$object_type] ||= [];
558		856
559	} elsif ($type eq "subtype") {	857	} elsif ($type eq "subtype") {
560	defined $object_type or Carp::croak "subtype specified without type";	858	defined $object_type or Carp::croak "subtype specified without type";
561	my $object_subtype = shift @arg;	859	my $object_subtype = shift @arg;
562	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	860	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
563		861
564	} elsif ($type eq "package") {	862	} elsif ($type eq "package") {
565	my $pkg = shift @arg;	863	my $pkg = shift @arg;
566		864
567	while (my ($name, $id) = each %cb_id) {	865	while (my ($name, $id) = each %cb_id) {
…		…
596	_attach $registry, $klass, @attach;	894	_attach $registry, $klass, @attach;
597	}	895	}
598		896
599	$obj->{$name} = \%arg;	897	$obj->{$name} = \%arg;
600	} else {	898	} else {
601	warn "object uses attachment '$name' that is not available, postponing.\n";	899	warn "object uses attachment '$name' which is not available, postponing.\n";
602	}	900	}
603		901
604	$obj->{_attachment}{$name} = undef;	902	$obj->{_attachment}{$name} = undef;
605	}	903	}
606		904
…		…
608	if (ref $_[0]) {	906	if (ref $_[0]) {
609	_object_attach @_;	907	_object_attach @_;
610	} else {	908	} else {
611	_attach shift->_attach_registry, @_;	909	_attach shift->_attach_registry, @_;
612	}	910	}
		911	_recalc_want;
613	};	912	};
614		913
615	# all those should be optimised	914	# all those should be optimised
616	sub cf::attachable::detach {	915	sub cf::attachable::detach {
617	my ($obj, $name) = @_;	916	my ($obj, $name) = @_;
…		…
620	delete $obj->{_attachment}{$name};	919	delete $obj->{_attachment}{$name};
621	reattach ($obj);	920	reattach ($obj);
622	} else {	921	} else {
623	Carp::croak "cannot, currently, detach class attachments";	922	Carp::croak "cannot, currently, detach class attachments";
624	}	923	}
		924	_recalc_want;
625	};	925	};
626		926
627	sub cf::attachable::attached {	927	sub cf::attachable::attached {
628	my ($obj, $name) = @_;	928	my ($obj, $name) = @_;
629		929
…		…
644	";	944	";
645	die if $@;	945	die if $@;
646	}	946	}
647		947
648	our $override;	948	our $override;
649	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	949	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
650		950
651	sub override {	951	sub override {
652	$override = 1;	952	$override = 1;
653	@invoke_results = ();	953	@INVOKE_RESULTS = (@_);
654	}	954	}
655		955
656	sub do_invoke {	956	sub do_invoke {
657	my $event = shift;	957	my $event = shift;
658	my $callbacks = shift;	958	my $callbacks = shift;
659		959
660	@invoke_results = ();	960	@INVOKE_RESULTS = ();
661		961
662	local $override;	962	local $override;
663		963
664	for (@$callbacks) {	964	for (@$callbacks) {
665	eval { &{$_->[1]} };	965	eval { &{$_->[1]} };
…		…
674	}	974	}
675		975
676	0	976	0
677	}	977	}
678		978
679	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	979	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
680		980
681	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	981	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
682		982
683	Generate an object-specific event with the given arguments.	983	Generate an object-specific event with the given arguments.
684		984
685	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	985	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
686	removed in future versions), and there is no public API to access override	986	removed in future versions), and there is no public API to access override
687	results (if you must, access C<@cf::invoke_results> directly).	987	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
688		988
689	=back	989	=back
690		990
691	=cut	991	=cut
692		992
693	#############################################################################	993	#############################################################################
694	# object support	994	# object support
		995
		996	sub _object_equal($$);
		997	sub _object_equal($$) {
		998	my ($a, $b) = @_;
		999
		1000	return 0 unless (ref $a) eq (ref $b);
		1001
		1002	if ("HASH" eq ref $a) {
		1003	my @ka = keys %$a;
		1004	my @kb = keys %$b;
		1005
		1006	return 0 if @ka != @kb;
		1007
		1008	for (0 .. $#ka) {
		1009	return 0 unless $ka[$_] eq $kb[$_];
		1010	return 0 unless _object_equal $a->{$ka[$_]}, $b->{$kb[$_]};
		1011	}
		1012
		1013	} elsif ("ARRAY" eq ref $a) {
		1014
		1015	return 0 if @$a != @$b;
		1016
		1017	for (0 .. $#$a) {
		1018	return 0 unless _object_equal $a->[$_], $b->[$_];
		1019	}
		1020
		1021	} elsif ($a ne $b) {
		1022	return 0;
		1023	}
		1024
		1025	1
		1026	}
		1027
		1028	our $SLOW_MERGES;#d#
		1029	sub _can_merge {
		1030	my ($ob1, $ob2) = @_;
		1031
		1032	++$SLOW_MERGES;#d#
		1033
		1034	# we do the slow way here
		1035	return _object_equal $ob1, $ob2
		1036	}
695		1037
696	sub reattach {	1038	sub reattach {
697	# basically do the same as instantiate, without calling instantiate	1039	# basically do the same as instantiate, without calling instantiate
698	my ($obj) = @_;	1040	my ($obj) = @_;
699		1041
…		…
720	cf::attachable->attach (	1062	cf::attachable->attach (
721	prio => -1000000,	1063	prio => -1000000,
722	on_instantiate => sub {	1064	on_instantiate => sub {
723	my ($obj, $data) = @_;	1065	my ($obj, $data) = @_;
724		1066
725	$data = from_json $data;	1067	$data = decode_json $data;
726		1068
727	for (@$data) {	1069	for (@$data) {
728	my ($name, $args) = @$_;	1070	my ($name, $args) = @$_;
729		1071
730	$obj->attach ($name, %{$args || {} });	1072	$obj->attach ($name, %{$args || {} });
…		…
746	sub object_freezer_save {	1088	sub object_freezer_save {
747	my ($filename, $rdata, $objs) = @_;	1089	my ($filename, $rdata, $objs) = @_;
748		1090
749	sync_job {	1091	sync_job {
750	if (length $$rdata) {	1092	if (length $$rdata) {
		1093	utf8::decode (my $decname = $filename);
751	warn sprintf "saving %s (%d,%d)\n",	1094	warn sprintf "saving %s (%d,%d)\n",
752	$filename, length $$rdata, scalar @$objs;	1095	$decname, length $$rdata, scalar @$objs;
753		1096
754	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1097	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
755	chmod SAVE_MODE, $fh;	1098	chmod SAVE_MODE, $fh;
756	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1099	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
757	aio_fsync $fh;	1100	aio_fsync $fh if $cf::USE_FSYNC;
758	close $fh;	1101	close $fh;
759		1102
760	if (@$objs) {	1103	if (@$objs) {
761	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	1104	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
762	chmod SAVE_MODE, $fh;	1105	chmod SAVE_MODE, $fh;
763	my $data = Storable::nfreeze { version => 1, objs => $objs };	1106	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
764	aio_write $fh, 0, (length $data), $data, 0;	1107	aio_write $fh, 0, (length $data), $data, 0;
765	aio_fsync $fh;	1108	aio_fsync $fh if $cf::USE_FSYNC;
766	close $fh;	1109	close $fh;
767	aio_rename "$filename.pst~", "$filename.pst";	1110	aio_rename "$filename.pst~", "$filename.pst";
768	}	1111	}
769	} else {	1112	} else {
770	aio_unlink "$filename.pst";	1113	aio_unlink "$filename.pst";
…		…
776	}	1119	}
777	} else {	1120	} else {
778	aio_unlink $filename;	1121	aio_unlink $filename;
779	aio_unlink "$filename.pst";	1122	aio_unlink "$filename.pst";
780	}	1123	}
781
782	#d##TODO# nuke non .map-files if exist
783	if ($filename =~ s/\.map$//) {
784	aio_unlink $filename;
785	aio_unlink "$filename.pst";
786	}
787	}	1124	};
788	}	1125	}
789		1126
790	sub object_freezer_as_string {	1127	sub object_freezer_as_string {
791	my ($rdata, $objs) = @_;	1128	my ($rdata, $objs) = @_;
792		1129
…		…
797		1134
798	sub object_thawer_load {	1135	sub object_thawer_load {
799	my ($filename) = @_;	1136	my ($filename) = @_;
800		1137
801	my ($data, $av);	1138	my ($data, $av);
802
803	#d#TODO remove .map if file does not exist
804	aio_stat $filename and $filename =~ s/\.map$//;
805		1139
806	(aio_load $filename, $data) >= 0	1140	(aio_load $filename, $data) >= 0
807	or return;	1141	or return;
808		1142
809	unless (aio_stat "$filename.pst") {	1143	unless (aio_stat "$filename.pst") {
810	(aio_load "$filename.pst", $av) >= 0	1144	(aio_load "$filename.pst", $av) >= 0
811	or return;	1145	or return;
		1146
812	$av = eval { (Storable::thaw $av)->{objs} };	1147	my $st = eval { Coro::Storable::thaw $av };
		1148	$av = $st->{objs};
813	}	1149	}
814		1150
		1151	utf8::decode (my $decname = $filename);
815	warn sprintf "loading %s (%d)\n",	1152	warn sprintf "loading %s (%d,%d)\n",
816	$filename, length $data, scalar @{$av || []};#d#	1153	$decname, length $data, scalar @{$av || []};
		1154
817	return ($data, $av);	1155	($data, $av)
818	}	1156	}
		1157
		1158	=head2 COMMAND CALLBACKS
		1159
		1160	=over 4
		1161
		1162	=cut
819		1163
820	#############################################################################	1164	#############################################################################
821	# command handling &c	1165	# command handling &c
822		1166
823	=item cf::register_command $name => \&callback($ob,$args);	1167	=item cf::register_command $name => \&callback($ob,$args);
…		…
836	push @{ $COMMAND{$name} }, [$caller, $cb];	1180	push @{ $COMMAND{$name} }, [$caller, $cb];
837	}	1181	}
838		1182
839	=item cf::register_extcmd $name => \&callback($pl,$packet);	1183	=item cf::register_extcmd $name => \&callback($pl,$packet);
840		1184
841	Register a callbackf ro execution when the client sends an extcmd packet.	1185	Register a callback for execution when the client sends an (synchronous)
		1186	extcmd packet. Ext commands will be processed in the order they are
		1187	received by the server, like other user commands. The first argument is
		1188	the logged-in player. Ext commands can only be processed after a player
		1189	has logged in successfully.
842		1190
843	If the callback returns something, it is sent back as if reply was being	1191	If the callback returns something, it is sent back as if reply was being
844	called.	1192	called.
845		1193
		1194	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1195
		1196	Register a callback for execution when the client sends an (asynchronous)
		1197	exticmd packet. Exti commands are processed by the server as soon as they
		1198	are received, i.e. out of order w.r.t. other commands. The first argument
		1199	is a client socket. Exti commands can be received anytime, even before
		1200	log-in.
		1201
		1202	If the callback returns something, it is sent back as if reply was being
		1203	called.
		1204
846	=cut	1205	=cut
847		1206
848	sub register_extcmd {	1207	sub register_extcmd {
849	my ($name, $cb) = @_;	1208	my ($name, $cb) = @_;
850		1209
851	$EXTCMD{$name} = $cb;	1210	$EXTCMD{$name} = $cb;
		1211	}
		1212
		1213	sub register_exticmd {
		1214	my ($name, $cb) = @_;
		1215
		1216	$EXTICMD{$name} = $cb;
852	}	1217	}
853		1218
854	cf::player->attach (	1219	cf::player->attach (
855	on_command => sub {	1220	on_command => sub {
856	my ($pl, $name, $params) = @_;	1221	my ($pl, $name, $params) = @_;
…		…
865	cf::override;	1230	cf::override;
866	},	1231	},
867	on_extcmd => sub {	1232	on_extcmd => sub {
868	my ($pl, $buf) = @_;	1233	my ($pl, $buf) = @_;
869		1234
870	my $msg = eval { from_json $buf };	1235	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
871		1236
872	if (ref $msg) {	1237	if (ref $msg) {
		1238	my ($type, $reply, @payload) =
		1239	"ARRAY" eq ref $msg
		1240	? @$msg
		1241	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1242
		1243	my @reply;
		1244
873	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1245	if (my $cb = $EXTCMD{$type}) {
874	if (my %reply = $cb->($pl, $msg)) {	1246	@reply = $cb->($pl, @payload);
875	$pl->ext_reply ($msg->{msgid}, %reply);
876	}
877	}	1247	}
		1248
		1249	$pl->ext_reply ($reply, @reply)
		1250	if $reply;
		1251
878	} else {	1252	} else {
879	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1253	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
880	}	1254	}
881		1255
882	cf::override;	1256	cf::override;
883	},	1257	},
884	);	1258	);
885		1259
886	sub load_extension {
887	my ($path) = @_;
888
889	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
890	my $base = $1;
891	my $pkg = $1;
892	$pkg =~ s/[^[:word:]]/_/g;
893	$pkg = "ext::$pkg";
894
895	warn "... loading '$path' into '$pkg'\n";
896
897	open my $fh, "<:utf8", $path
898	or die "$path: $!";
899
900	my $source =
901	"package $pkg; use strict; use utf8;\n"
902	. "#line 1 \"$path\"\n{\n"
903	. (do { local $/; <$fh> })
904	. "\n};\n1";
905
906	unless (eval $source) {
907	my $msg = $@ ? "$path: $@\n"
908	: "extension disabled.\n";
909	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
910	warn $@;
911	warn "mandatory extension failed to load, exiting.\n";
912	exit 1;
913	}
914	die $@;
915	}
916
917	push @EXTS, $pkg;
918	}
919
920	sub load_extensions {	1260	sub load_extensions {
		1261	cf::sync_job {
		1262	my %todo;
		1263
921	for my $ext (<$LIBDIR/*.ext>) {	1264	for my $path (<$LIBDIR/*.ext>) {
922	next unless -r $ext;	1265	next unless -r $path;
923	eval {	1266
924	load_extension $ext;	1267	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1268	my $base = $1;
		1269	my $pkg = $1;
		1270	$pkg =~ s/[^[:word:]]/_/g;
		1271	$pkg = "ext::$pkg";
		1272
		1273	open my $fh, "<:utf8", $path
		1274	or die "$path: $!";
		1275
		1276	my $source = do { local $/; <$fh> };
		1277
		1278	my %ext = (
		1279	path => $path,
		1280	base => $base,
		1281	pkg => $pkg,
		1282	);
		1283
		1284	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1285	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1286
		1287	$ext{source} =
		1288	"package $pkg; use strict; use utf8;\n"
		1289	. "#line 1 \"$path\"\n{\n"
		1290	. $source
		1291	. "\n};\n1";
		1292
		1293	$todo{$base} = \%ext;
		1294	}
		1295
		1296	my %done;
		1297	while (%todo) {
		1298	my $progress;
		1299
		1300	while (my ($k, $v) = each %todo) {
		1301	for (split /,\s*/, $v->{meta}{depends}) {
		1302	goto skip
		1303	unless exists $done{$_};
		1304	}
		1305
		1306	warn "... loading '$k' into '$v->{pkg}'\n";
		1307
		1308	unless (eval $v->{source}) {
		1309	my $msg = $@ ? "$v->{path}: $@\n"
		1310	: "$v->{base}: extension inactive.\n";
		1311
		1312	if (exists $v->{meta}{mandatory}) {
		1313	warn $msg;
		1314	warn "mandatory extension failed to load, exiting.\n";
		1315	exit 1;
		1316	}
		1317
		1318	warn $msg;
		1319	}
		1320
		1321	$done{$k} = delete $todo{$k};
		1322	push @EXTS, $v->{pkg};
		1323	$progress = 1;
925	1	1324	}
926	} or warn "$ext not loaded: $@";	1325
		1326	skip:
		1327	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1328	unless $progress;
		1329	}
927	}	1330	};
928	}	1331	}
929		1332
930	#############################################################################	1333	#############################################################################
931		1334
		1335	=back
		1336
932	=head2 CORE EXTENSIONS	1337	=head2 CORE EXTENSIONS
933		1338
934	Functions and methods that extend core crossfire objects.	1339	Functions and methods that extend core crossfire objects.
935		1340
936	=cut	1341	=cut
…		…
941		1346
942	=head3 cf::player	1347	=head3 cf::player
943		1348
944	=over 4	1349	=over 4
945		1350
		1351	=item cf::player::num_playing
		1352
		1353	Returns the official number of playing players, as per the Crossfire metaserver rules.
		1354
		1355	=cut
		1356
		1357	sub num_playing {
		1358	scalar grep
		1359	$_->ob->map
		1360	&& !$_->hidden
		1361	&& !$_->ob->flag (cf::FLAG_WIZ),
		1362	cf::player::list
		1363	}
		1364
946	=item cf::player::find $login	1365	=item cf::player::find $login
947		1366
948	Returns the given player object, loading it if necessary (might block).	1367	Returns the given player object, loading it if necessary (might block).
949		1368
950	=cut	1369	=cut
951		1370
952	sub playerdir($) {	1371	sub playerdir($) {
953	cf::localdir	1372	"$PLAYERDIR/"
954	. "/"
955	. cf::playerdir
956	. "/"
957	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1373	. (ref $_[0] ? $_[0]->ob->name : $_[0])
958	}	1374	}
959		1375
960	sub path($) {	1376	sub path($) {
961	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1377	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
962		1378
963	(playerdir $login) . "/$login.pl"	1379	(playerdir $login) . "/playerdata"
964	}	1380	}
965		1381
966	sub find_active($) {	1382	sub find_active($) {
967	$cf::PLAYER{$_[0]}	1383	$cf::PLAYER{$_[0]}
968	and $cf::PLAYER{$_[0]}->active	1384	and $cf::PLAYER{$_[0]}->active
…		…
981	my $login = $_[0];	1397	my $login = $_[0];
982		1398
983	my $guard = cf::lock_acquire "user_find:$login";	1399	my $guard = cf::lock_acquire "user_find:$login";
984		1400
985	$cf::PLAYER{$_[0]} || do {	1401	$cf::PLAYER{$_[0]} || do {
986	my $pl = load_pl path $login	1402	# rename old playerfiles to new ones
		1403	#TODO: remove when no longer required
		1404	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1405	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1406	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1407	aio_unlink +(playerdir $login) . "/$login.pl";
		1408
		1409	my $f = new_from_file cf::object::thawer path $login
987	or return;	1410	or return;
		1411
		1412	my $pl = cf::player::load_pl $f
		1413	or return;
		1414	local $cf::PLAYER_LOADING{$login} = $pl;
		1415	$f->resolve_delayed_derefs;
988	$cf::PLAYER{$login} = $pl	1416	$cf::PLAYER{$login} = $pl
989	}	1417	}
990	}	1418	}
991	}	1419	}
992		1420
…		…
1002		1430
1003	aio_mkdir playerdir $pl, 0770;	1431	aio_mkdir playerdir $pl, 0770;
1004	$pl->{last_save} = $cf::RUNTIME;	1432	$pl->{last_save} = $cf::RUNTIME;
1005		1433
1006	$pl->save_pl ($path);	1434	$pl->save_pl ($path);
1007	Coro::cede;	1435	cf::cede_to_tick;
1008	}	1436	}
1009		1437
1010	sub new($) {	1438	sub new($) {
1011	my ($login) = @_;	1439	my ($login) = @_;
1012		1440
…		…
1018	$cf::PLAYER{$login} = $self;	1446	$cf::PLAYER{$login} = $self;
1019		1447
1020	$self	1448	$self
1021	}	1449	}
1022		1450
		1451	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1452
		1453	=cut
		1454
		1455	sub send_msg {
		1456	my $ns = shift->ns
		1457	or return;
		1458	$ns->send_msg (@_);
		1459	}
		1460
1023	=item $pl->quit_character	1461	=item $pl->quit_character
1024		1462
1025	Nukes the player without looking back. If logged in, the connection will	1463	Nukes the player without looking back. If logged in, the connection will
1026	be destroyed. May block for a long time.	1464	be destroyed. May block for a long time.
1027		1465
1028	=cut	1466	=cut
1029		1467
1030	sub quit_character {	1468	sub quit_character {
1031	my ($pl) = @_;	1469	my ($pl) = @_;
		1470
		1471	my $name = $pl->ob->name;
1032		1472
1033	$pl->{deny_save} = 1;	1473	$pl->{deny_save} = 1;
1034	$pl->password ("*"); # this should lock out the player until we nuked the dir	1474	$pl->password ("*"); # this should lock out the player until we nuked the dir
1035		1475
1036	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1476	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1041	my $path = playerdir $pl;	1481	my $path = playerdir $pl;
1042	my $temp = "$path~$cf::RUNTIME~deleting~";	1482	my $temp = "$path~$cf::RUNTIME~deleting~";
1043	aio_rename $path, $temp;	1483	aio_rename $path, $temp;
1044	delete $cf::PLAYER{$pl->ob->name};	1484	delete $cf::PLAYER{$pl->ob->name};
1045	$pl->destroy;	1485	$pl->destroy;
		1486
		1487	my $prefix = qr<^~\Q$name\E/>;
		1488
		1489	# nuke player maps
		1490	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1491
1046	IO::AIO::aio_rmtree $temp;	1492	IO::AIO::aio_rmtree $temp;
		1493	}
		1494
		1495	=item $pl->kick
		1496
		1497	Kicks a player out of the game. This destroys the connection.
		1498
		1499	=cut
		1500
		1501	sub kick {
		1502	my ($pl, $kicker) = @_;
		1503
		1504	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1505	$pl->killer ("kicked");
		1506	$pl->ns->destroy;
1047	}	1507	}
1048		1508
1049	=item cf::player::list_logins	1509	=item cf::player::list_logins
1050		1510
1051	Returns am arrayref of all valid playernames in the system, can take a	1511	Returns am arrayref of all valid playernames in the system, can take a
1052	while and may block, so not sync_job-capable, ever.	1512	while and may block, so not sync_job-capable, ever.
1053		1513
1054	=cut	1514	=cut
1055		1515
1056	sub list_logins {	1516	sub list_logins {
1057	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1517	my $dirs = aio_readdir $PLAYERDIR
1058	or return [];	1518	or return [];
1059		1519
1060	my @logins;	1520	my @logins;
1061		1521
1062	for my $login (@$dirs) {	1522	for my $login (@$dirs) {
		1523	my $path = path $login;
		1524
		1525	# a .pst is a dead give-away for a valid player
		1526	unless (-e "$path.pst") {
1063	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1527	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1064	aio_read $fh, 0, 512, my $buf, 0 or next;	1528	aio_read $fh, 0, 512, my $buf, 0 or next;
1065	$buf !~ /^password -------------$/m or next; # official not-valid tag	1529	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1530	}
1066		1531
1067	utf8::decode $login;	1532	utf8::decode $login;
1068	push @logins, $login;	1533	push @logins, $login;
1069	}	1534	}
1070		1535
…		…
1097	}	1562	}
1098		1563
1099	\@paths	1564	\@paths
1100	}	1565	}
1101		1566
		1567	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1568
		1569	Expand crossfire pod fragments into protocol xml.
		1570
		1571	=cut
		1572
		1573	use re 'eval';
		1574
		1575	my $group;
		1576	my $interior; $interior = qr{
		1577	# match a pod interior sequence sans C<< >>
		1578	(?:
		1579	\ (.*?)\ (?{ $group = $^N })
		1580	| < (??{$interior}) >
		1581	)
		1582	}x;
		1583
		1584	sub expand_cfpod {
		1585	my ($self, $pod) = @_;
		1586
		1587	my $xml;
		1588
		1589	while () {
		1590	if ($pod =~ /\G( (?: [^BCGHITU]+ | .(?!<) )+ )/xgcs) {
		1591	$group = $1;
		1592
		1593	$group =~ s/&/&amp;/g;
		1594	$group =~ s/</&lt;/g;
		1595
		1596	$xml .= $group;
		1597	} elsif ($pod =~ m%\G
		1598	([BCGHITU])
		1599	<
		1600	(?:
		1601	([^<>]*) (?{ $group = $^N })
		1602	| < $interior >
		1603	)
		1604	>
		1605	%gcsx
		1606	) {
		1607	my ($code, $data) = ($1, $group);
		1608
		1609	if ($code eq "B") {
		1610	$xml .= "<b>" . expand_cfpod ($self, $data) . "</b>";
		1611	} elsif ($code eq "I") {
		1612	$xml .= "<i>" . expand_cfpod ($self, $data) . "</i>";
		1613	} elsif ($code eq "U") {
		1614	$xml .= "<u>" . expand_cfpod ($self, $data) . "</u>";
		1615	} elsif ($code eq "C") {
		1616	$xml .= "<tt>" . expand_cfpod ($self, $data) . "</tt>";
		1617	} elsif ($code eq "T") {
		1618	$xml .= "<big><b>" . expand_cfpod ($self, $data) . "</b></big>";
		1619	} elsif ($code eq "G") {
		1620	my ($male, $female) = split /\|/, $data;
		1621	$data = $self->gender ? $female : $male;
		1622	$xml .= expand_cfpod ($self, $data);
		1623	} elsif ($code eq "H") {
		1624	$xml .= ("<fg name=\"lightblue\">[" . expand_cfpod ($self, $data) . " (Use hintmode to suppress hints)]</fg>",
		1625	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1626	"")
		1627	[$self->{hintmode}];
		1628	} else {
		1629	$xml .= "error processing '$code($data)' directive";
		1630	}
		1631	} else {
		1632	if ($pod =~ /\G(.+)/) {
		1633	warn "parse error while expanding $pod (at $1)";
		1634	}
		1635	last;
		1636	}
		1637	}
		1638
		1639	for ($xml) {
		1640	# create single paragraphs (very hackish)
		1641	s/(?<=\S)\n(?=\w)/ /g;
		1642
		1643	# compress some whitespace
		1644	s/\s+\n/\n/g; # ws line-ends
		1645	s/\n\n+/\n/g; # double lines
		1646	s/^\n+//; # beginning lines
		1647	s/\n+$//; # ending lines
		1648	}
		1649
		1650	$xml
		1651	}
		1652
		1653	no re 'eval';
		1654
		1655	sub hintmode {
		1656	$_[0]{hintmode} = $_[1] if @_ > 1;
		1657	$_[0]{hintmode}
		1658	}
		1659
1102	=item $player->ext_reply ($msgid, $msgtype, %msg)	1660	=item $player->ext_reply ($msgid, @msg)
1103		1661
1104	Sends an ext reply to the player.	1662	Sends an ext reply to the player.
1105		1663
1106	=cut	1664	=cut
1107		1665
1108	sub ext_reply($$$%) {	1666	sub ext_reply($$@) {
1109	my ($self, $id, %msg) = @_;	1667	my ($self, $id, @msg) = @_;
1110		1668
1111	$msg{msgid} = $id;	1669	$self->ns->ext_reply ($id, @msg)
1112
1113	$self->send ("ext " . cf::to_json \%msg);
1114	}	1670	}
1115		1671
1116	package cf;	1672	=item $player->ext_msg ($type, @msg)
		1673
		1674	Sends an ext event to the client.
		1675
		1676	=cut
		1677
		1678	sub ext_msg($$@) {
		1679	my ($self, $type, @msg) = @_;
		1680
		1681	$self->ns->ext_msg ($type, @msg);
		1682	}
		1683
		1684	=head3 cf::region
		1685
		1686	=over 4
		1687
		1688	=cut
		1689
		1690	package cf::region;
		1691
		1692	=item cf::region::find_by_path $path
		1693
		1694	Tries to decuce the likely region for a map knowing only its path.
		1695
		1696	=cut
		1697
		1698	sub find_by_path($) {
		1699	my ($path) = @_;
		1700
		1701	my ($match, $specificity);
		1702
		1703	for my $region (list) {
		1704	if ($region->{match} && $path =~ $region->{match}) {
		1705	($match, $specificity) = ($region, $region->specificity)
		1706	if $region->specificity > $specificity;
		1707	}
		1708	}
		1709
		1710	$match
		1711	}
1117		1712
1118	=back	1713	=back
1119
1120		1714
1121	=head3 cf::map	1715	=head3 cf::map
1122		1716
1123	=over 4	1717	=over 4
1124		1718
…		…
1179	my ($self, $merge) = @_;	1773	my ($self, $merge) = @_;
1180		1774
1181	# we have to keep some variables in memory intact	1775	# we have to keep some variables in memory intact
1182	local $self->{path};	1776	local $self->{path};
1183	local $self->{load_path};	1777	local $self->{load_path};
1184	local $self->{deny_save};
1185	local $self->{deny_reset};
1186		1778
1187	$self->SUPER::thawer_merge ($merge);	1779	$self->SUPER::thawer_merge ($merge);
1188	}	1780	}
1189		1781
1190	sub normalise {	1782	sub normalise {
…		…
1237	$self->init; # pass $1 etc.	1829	$self->init; # pass $1 etc.
1238	return $self;	1830	return $self;
1239	}	1831	}
1240	}	1832	}
1241		1833
1242	Carp::carp "unable to resolve path '$path' (base '$base').";	1834	Carp::cluck "unable to resolve path '$path' (base '$base').";
1243	()	1835	()
1244	}	1836	}
1245		1837
1246	sub init {	1838	sub init {
1247	my ($self) = @_;	1839	my ($self) = @_;
…		…
1262		1854
1263	# the original (read-only) location	1855	# the original (read-only) location
1264	sub load_path {	1856	sub load_path {
1265	my ($self) = @_;	1857	my ($self) = @_;
1266		1858
1267	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1859	"$MAPDIR/$self->{path}.map"
1268	}	1860	}
1269		1861
1270	# the temporary/swap location	1862	# the temporary/swap location
1271	sub save_path {	1863	sub save_path {
1272	my ($self) = @_;	1864	my ($self) = @_;
1273		1865
1274	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1866	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1275	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1867	"$TMPDIR/$path.map"
1276	}	1868	}
1277		1869
1278	# the unique path, undef == no special unique path	1870	# the unique path, undef == no special unique path
1279	sub uniq_path {	1871	sub uniq_path {
1280	my ($self) = @_;	1872	my ($self) = @_;
1281		1873
1282	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1874	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1283	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1875	"$UNIQUEDIR/$path"
1284	}	1876	}
1285		1877
1286	# and all this just because we cannot iterate over	1878	# and all this just because we cannot iterate over
1287	# all maps in C++...	1879	# all maps in C++...
1288	sub change_all_map_light {	1880	sub change_all_map_light {
…		…
1290		1882
1291	$_->change_map_light ($change)	1883	$_->change_map_light ($change)
1292	for grep $_->outdoor, values %cf::MAP;	1884	for grep $_->outdoor, values %cf::MAP;
1293	}	1885	}
1294		1886
		1887	sub decay_objects {
		1888	my ($self) = @_;
		1889
		1890	return if $self->{deny_reset};
		1891
		1892	$self->do_decay_objects;
		1893	}
		1894
1295	sub unlink_save {	1895	sub unlink_save {
1296	my ($self) = @_;	1896	my ($self) = @_;
1297		1897
1298	utf8::encode (my $save = $self->save_path);	1898	utf8::encode (my $save = $self->save_path);
1299	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1899	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1300	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";	1900	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1301
1302	#d#TODO remove .map and also nuke
1303	$save =~ s/\.map// or return;#d#
1304	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1305	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1306	}	1901	}
1307		1902
1308	sub load_header_from($) {	1903	sub load_header_from($) {
1309	my ($self, $path) = @_;	1904	my ($self, $path) = @_;
1310		1905
1311	utf8::encode $path;	1906	utf8::encode $path;
1312	#aio_open $path, O_RDONLY, 0	1907	my $f = new_from_file cf::object::thawer $path
1313	# or return;
1314
1315	$self->_load_header ($path)
1316	or return;	1908	or return;
		1909
		1910	$self->_load_header ($f)
		1911	or return;
		1912
		1913	local $MAP_LOADING{$self->{path}} = $self;
		1914	$f->resolve_delayed_derefs;
1317		1915
1318	$self->{load_path} = $path;	1916	$self->{load_path} = $path;
1319		1917
1320	1	1918	1
1321	}	1919	}
…		…
1360	$self->load_header_orig	1958	$self->load_header_orig
1361	or return;	1959	or return;
1362	$self->prepare_orig;	1960	$self->prepare_orig;
1363	}	1961	}
1364		1962
		1963	$self->{deny_reset} = 1
		1964	if $self->no_reset;
		1965
		1966	$self->default_region (cf::region::find_by_path $self->{path})
		1967	unless $self->default_region;
		1968
1365	1	1969	1
1366	}	1970	}
1367		1971
1368	sub find;	1972	sub find;
1369	sub find {	1973	sub find {
1370	my ($path, $origin) = @_;	1974	my ($path, $origin) = @_;
1371		1975
1372	$path = normalise $path, $origin && $origin->path;	1976	$path = normalise $path, $origin && $origin->path;
1373		1977
		1978	cf::lock_wait "map_data:$path";#d#remove
1374	cf::lock_wait "map_find:$path";	1979	cf::lock_wait "map_find:$path";
1375		1980
1376	$cf::MAP{$path} || do {	1981	$cf::MAP{$path} || do {
1377	my $guard = cf::lock_acquire "map_find:$path";	1982	my $guard1 = cf::lock_acquire "map_find:$path";
		1983	my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
		1984
1378	my $map = new_from_path cf::map $path	1985	my $map = new_from_path cf::map $path
1379	or return;	1986	or return;
1380		1987
1381	$map->{last_save} = $cf::RUNTIME;	1988	$map->{last_save} = $cf::RUNTIME;
1382		1989
1383	$map->load_header	1990	$map->load_header
1384	or return;	1991	or return;
1385		1992
1386	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1993	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1387	# doing this can freeze the server in a sync job, obviously	1994	# doing this can freeze the server in a sync job, obviously
1388	#$cf::WAIT_FOR_TICK->wait;	1995	#$cf::WAIT_FOR_TICK->wait;
		1996	undef $guard1;
		1997	undef $guard2;
1389	$map->reset;	1998	$map->reset;
1390	undef $guard;
1391	return find $path;	1999	return find $path;
1392	}	2000	}
1393		2001
1394	$cf::MAP{$path} = $map	2002	$cf::MAP{$path} = $map
1395	}	2003	}
…		…
1402	my ($self) = @_;	2010	my ($self) = @_;
1403		2011
1404	local $self->{deny_reset} = 1; # loading can take a long time	2012	local $self->{deny_reset} = 1; # loading can take a long time
1405		2013
1406	my $path = $self->{path};	2014	my $path = $self->{path};
		2015
		2016	{
1407	my $guard = cf::lock_acquire "map_load:$path";	2017	my $guard = cf::lock_acquire "map_data:$path";
1408		2018
		2019	return unless $self->valid;
1409	return if $self->in_memory != cf::MAP_SWAPPED;	2020	return unless $self->in_memory == cf::MAP_SWAPPED;
1410		2021
1411	$self->in_memory (cf::MAP_LOADING);	2022	$self->in_memory (cf::MAP_LOADING);
1412		2023
1413	$self->alloc;	2024	$self->alloc;
1414		2025
1415	$self->pre_load;	2026	$self->pre_load;
		2027	cf::cede_to_tick;
1416		2028
1417	$self->_load_objects ($self->{load_path}, 1)	2029	my $f = new_from_file cf::object::thawer $self->{load_path};
		2030	$f->skip_block;
		2031	$self->_load_objects ($f)
1418	or return;	2032	or return;
1419		2033
1420	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2034	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1421	if delete $self->{load_original};	2035	if delete $self->{load_original};
1422		2036
1423	if (my $uniq = $self->uniq_path) {	2037	if (my $uniq = $self->uniq_path) {
1424	utf8::encode $uniq;	2038	utf8::encode $uniq;
1425	if (aio_open $uniq, O_RDONLY, 0) {	2039	unless (aio_stat $uniq) {
		2040	if (my $f = new_from_file cf::object::thawer $uniq) {
1426	$self->clear_unique_items;	2041	$self->clear_unique_items;
1427	$self->_load_objects ($uniq, 0);	2042	$self->_load_objects ($f);
		2043	$f->resolve_delayed_derefs;
		2044	}
1428	}	2045	}
1429	}	2046	}
1430		2047
1431	Coro::cede;	2048	$f->resolve_delayed_derefs;
1432		2049
		2050	cf::cede_to_tick;
1433	# now do the right thing for maps	2051	# now do the right thing for maps
1434	$self->link_multipart_objects;	2052	$self->link_multipart_objects;
1435
1436	unless ($self->{deny_activate}) {
1437	$self->decay_objects;
1438	$self->fix_auto_apply;
1439	$self->update_buttons;
1440	Coro::cede;
1441	$self->set_darkness_map;
1442	$self->difficulty ($self->estimate_difficulty)	2053	$self->difficulty ($self->estimate_difficulty)
1443	unless $self->difficulty;	2054	unless $self->difficulty;
1444	Coro::cede;	2055	cf::cede_to_tick;
		2056
		2057	unless ($self->{deny_activate}) {
		2058	$self->decay_objects;
		2059	$self->fix_auto_apply;
		2060	$self->update_buttons;
		2061	cf::cede_to_tick;
		2062	$self->set_darkness_map;
		2063	cf::cede_to_tick;
1445	$self->activate;	2064	$self->activate;
		2065	}
		2066
		2067	$self->{last_save} = $cf::RUNTIME;
		2068	$self->last_access ($cf::RUNTIME);
		2069
		2070	$self->in_memory (cf::MAP_IN_MEMORY);
1446	}	2071	}
1447		2072
1448	$self->post_load;	2073	$self->post_load;
1449
1450	$self->in_memory (cf::MAP_IN_MEMORY);
1451	}	2074	}
1452		2075
1453	sub customise_for {	2076	sub customise_for {
1454	my ($self, $ob) = @_;	2077	my ($self, $ob) = @_;
1455		2078
1456	return find "~" . $ob->name . "/" . $self->{path}	2079	return find "~" . $ob->name . "/" . $self->{path}
1457	if $self->per_player;	2080	if $self->per_player;
1458		2081
		2082	# return find "?party/" . $ob->name . "/" . $self->{path}
		2083	# if $self->per_party;
		2084
1459	$self	2085	$self
1460	}	2086	}
1461		2087
1462	# find and load all maps in the 3x3 area around a map	2088	# find and load all maps in the 3x3 area around a map
1463	sub load_diag {	2089	sub load_neighbours {
1464	my ($map) = @_;	2090	my ($map) = @_;
1465		2091
1466	my @diag; # diagonal neighbours	2092	my @neigh; # diagonal neighbours
1467		2093
1468	for (0 .. 3) {	2094	for (0 .. 3) {
1469	my $neigh = $map->tile_path ($_)	2095	my $neigh = $map->tile_path ($_)
1470	or next;	2096	or next;
1471	$neigh = find $neigh, $map	2097	$neigh = find $neigh, $map
1472	or next;	2098	or next;
1473	$neigh->load;	2099	$neigh->load;
1474		2100
		2101	push @neigh,
1475	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2102	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1476	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2103	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1477	}	2104	}
1478		2105
1479	for (@diag) {	2106	for (grep defined $_->[0], @neigh) {
		2107	my ($path, $origin) = @$_;
1480	my $neigh = find @$_	2108	my $neigh = find $path, $origin
1481	or next;	2109	or next;
1482	$neigh->load;	2110	$neigh->load;
1483	}	2111	}
1484	}	2112	}
1485		2113
…		…
1490	}	2118	}
1491		2119
1492	sub do_load_sync {	2120	sub do_load_sync {
1493	my ($map) = @_;	2121	my ($map) = @_;
1494		2122
		2123	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2124	if $Coro::current == $Coro::main;
		2125
1495	cf::sync_job { $map->load };	2126	cf::sync_job { $map->load };
1496	}	2127	}
1497		2128
1498	our %MAP_PREFETCH;	2129	our %MAP_PREFETCH;
1499	our $MAP_PREFETCHER = undef;	2130	our $MAP_PREFETCHER = undef;
1500		2131
1501	sub find_async {	2132	sub find_async {
1502	my ($path, $origin) = @_;	2133	my ($path, $origin, $load) = @_;
1503		2134
1504	$path = normalise $path, $origin && $origin->{path};	2135	$path = normalise $path, $origin && $origin->{path};
1505		2136
1506	if (my $map = $cf::MAP{$path}) {	2137	if (my $map = $cf::MAP{$path}) {
1507	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2138	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1508	}	2139	}
1509		2140
1510	undef $MAP_PREFETCH{$path};	2141	$MAP_PREFETCH{$path} |= $load;
		2142
1511	$MAP_PREFETCHER ||= cf::async {	2143	$MAP_PREFETCHER ||= cf::async {
		2144	$Coro::current->{desc} = "map prefetcher";
		2145
1512	while (%MAP_PREFETCH) {	2146	while (%MAP_PREFETCH) {
1513	for my $path (keys %MAP_PREFETCH) {	2147	while (my ($k, $v) = each %MAP_PREFETCH) {
1514	my $map = find $path	2148	if (my $map = find $k) {
1515	or next;
1516	$map->load;	2149	$map->load if $v;
		2150	}
1517		2151
1518	delete $MAP_PREFETCH{$path};	2152	delete $MAP_PREFETCH{$k};
1519	}	2153	}
1520	}	2154	}
1521	undef $MAP_PREFETCHER;	2155	undef $MAP_PREFETCHER;
1522	};	2156	};
1523	$MAP_PREFETCHER->prio (6);	2157	$MAP_PREFETCHER->prio (6);
…		…
1526	}	2160	}
1527		2161
1528	sub save {	2162	sub save {
1529	my ($self) = @_;	2163	my ($self) = @_;
1530		2164
1531	my $lock = cf::lock_acquire "map_data:" . $self->path;	2165	my $lock = cf::lock_acquire "map_data:$self->{path}";
1532		2166
1533	$self->{last_save} = $cf::RUNTIME;	2167	$self->{last_save} = $cf::RUNTIME;
1534		2168
1535	return unless $self->dirty;	2169	return unless $self->dirty;
1536		2170
…		…
1542	return if $self->{deny_save};	2176	return if $self->{deny_save};
1543		2177
1544	local $self->{last_access} = $self->last_access;#d#	2178	local $self->{last_access} = $self->last_access;#d#
1545		2179
1546	cf::async {	2180	cf::async {
		2181	$Coro::current->{desc} = "map player save";
1547	$_->contr->save for $self->players;	2182	$_->contr->save for $self->players;
1548	};	2183	};
1549		2184
1550	if ($uniq) {	2185	if ($uniq) {
1551	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2186	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
…		…
1559	my ($self) = @_;	2194	my ($self) = @_;
1560		2195
1561	# save first because save cedes	2196	# save first because save cedes
1562	$self->save;	2197	$self->save;
1563		2198
1564	my $lock = cf::lock_acquire "map_data:" . $self->path;	2199	my $lock = cf::lock_acquire "map_data:$self->{path}";
1565		2200
1566	return if $self->players;	2201	return if $self->players;
1567	return if $self->in_memory != cf::MAP_IN_MEMORY;	2202	return if $self->in_memory != cf::MAP_IN_MEMORY;
1568	return if $self->{deny_save};	2203	return if $self->{deny_save};
1569		2204
		2205	$self->in_memory (cf::MAP_SWAPPED);
		2206
		2207	$self->deactivate;
		2208	$_->clear_links_to ($self) for values %cf::MAP;
1570	$self->clear;	2209	$self->clear;
1571	$self->in_memory (cf::MAP_SWAPPED);
1572	}	2210	}
1573		2211
1574	sub reset_at {	2212	sub reset_at {
1575	my ($self) = @_;	2213	my ($self) = @_;
1576		2214
1577	# TODO: safety, remove and allow resettable per-player maps	2215	# TODO: safety, remove and allow resettable per-player maps
1578	return 1e99 if $self->isa ("ext::map_per_player");#d#
1579	return 1e99 if $self->{deny_reset};	2216	return 1e99 if $self->{deny_reset};
1580		2217
1581	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2218	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1582	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2219	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1583		2220
…		…
1594	my ($self) = @_;	2231	my ($self) = @_;
1595		2232
1596	my $lock = cf::lock_acquire "map_data:$self->{path}";	2233	my $lock = cf::lock_acquire "map_data:$self->{path}";
1597		2234
1598	return if $self->players;	2235	return if $self->players;
1599	return if $self->isa ("ext::map_per_player");#d#
1600		2236
1601	warn "resetting map ", $self->path;#d#	2237	warn "resetting map ", $self->path;
		2238
		2239	$self->in_memory (cf::MAP_SWAPPED);
		2240
		2241	# need to save uniques path
		2242	unless ($self->{deny_save}) {
		2243	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2244
		2245	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2246	if $uniq;
		2247	}
1602		2248
1603	delete $cf::MAP{$self->path};	2249	delete $cf::MAP{$self->path};
1604		2250
1605	$self->in_memory (cf::MAP_SWAPPED);	2251	$self->deactivate;
		2252	$_->clear_links_to ($self) for values %cf::MAP;
1606	$self->clear;	2253	$self->clear;
1607
1608	$_->clear_links_to ($self) for values %cf::MAP;
1609		2254
1610	$self->unlink_save;	2255	$self->unlink_save;
1611	$self->destroy;	2256	$self->destroy;
1612	}	2257	}
1613		2258
1614	my $nuke_counter = "aaaa";	2259	my $nuke_counter = "aaaa";
1615		2260
1616	sub nuke {	2261	sub nuke {
1617	my ($self) = @_;	2262	my ($self) = @_;
1618		2263
		2264	{
		2265	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2266
1619	delete $cf::MAP{$self->path};	2267	delete $cf::MAP{$self->path};
1620		2268
1621	$self->unlink_save;	2269	$self->unlink_save;
1622		2270
1623	bless $self, "cf::map";	2271	bless $self, "cf::map";
1624	delete $self->{deny_reset};	2272	delete $self->{deny_reset};
1625	$self->{deny_save} = 1;	2273	$self->{deny_save} = 1;
1626	$self->reset_timeout (1);	2274	$self->reset_timeout (1);
1627	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2275	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1628		2276
1629	$cf::MAP{$self->path} = $self;	2277	$cf::MAP{$self->path} = $self;
		2278	}
1630		2279
1631	$self->reset; # polite request, might not happen	2280	$self->reset; # polite request, might not happen
		2281	}
		2282
		2283	=item $maps = cf::map::tmp_maps
		2284
		2285	Returns an arrayref with all map paths of currently instantiated and saved
		2286	maps. May block.
		2287
		2288	=cut
		2289
		2290	sub tmp_maps() {
		2291	[
		2292	map {
		2293	utf8::decode $_;
		2294	/\.map$/
		2295	? normalise $_
		2296	: ()
		2297	} @{ aio_readdir $TMPDIR or [] }
		2298	]
		2299	}
		2300
		2301	=item $maps = cf::map::random_maps
		2302
		2303	Returns an arrayref with all map paths of currently instantiated and saved
		2304	random maps. May block.
		2305
		2306	=cut
		2307
		2308	sub random_maps() {
		2309	[
		2310	map {
		2311	utf8::decode $_;
		2312	/\.map$/
		2313	? normalise "?random/$_"
		2314	: ()
		2315	} @{ aio_readdir $RANDOMDIR or [] }
		2316	]
1632	}	2317	}
1633		2318
1634	=item cf::map::unique_maps	2319	=item cf::map::unique_maps
1635		2320
1636	Returns an arrayref of paths of all shared maps that have	2321	Returns an arrayref of paths of all shared maps that have
1637	instantiated unique items. May block.	2322	instantiated unique items. May block.
1638		2323
1639	=cut	2324	=cut
1640		2325
1641	sub unique_maps() {	2326	sub unique_maps() {
1642	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2327	[
1643	or return;	2328	map {
1644
1645	my @paths;
1646
1647	for (@$files) {
1648	utf8::decode $_;	2329	utf8::decode $_;
1649	next if /\.pst$/;	2330	/\.map$/
1650	next unless /^$PATH_SEP/o;	2331	? normalise $_
1651		2332	: ()
1652	push @paths, cf::map::normalise $_;	2333	} @{ aio_readdir $UNIQUEDIR or [] }
1653	}	2334	]
1654
1655	\@paths
1656	}	2335	}
1657		2336
1658	package cf;	2337	package cf;
1659		2338
1660	=back	2339	=back
…		…
1678	map { $_, inv_recursive_ $_->inv } @_	2357	map { $_, inv_recursive_ $_->inv } @_
1679	}	2358	}
1680		2359
1681	sub inv_recursive {	2360	sub inv_recursive {
1682	inv_recursive_ inv $_[0]	2361	inv_recursive_ inv $_[0]
		2362	}
		2363
		2364	=item $ref = $ob->ref
		2365
		2366	creates and returns a persistent reference to an objetc that can be stored as a string.
		2367
		2368	=item $ob = cf::object::deref ($refstring)
		2369
		2370	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2371	even if the object actually exists. May block.
		2372
		2373	=cut
		2374
		2375	sub deref {
		2376	my ($ref) = @_;
		2377
		2378	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2379	my ($uuid, $name) = ($1, $2);
		2380	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2381	or return;
		2382	$pl->ob->uuid eq $uuid
		2383	or return;
		2384
		2385	$pl->ob
		2386	} else {
		2387	warn "$ref: cannot resolve object reference\n";
		2388	undef
		2389	}
1683	}	2390	}
1684		2391
1685	package cf;	2392	package cf;
1686		2393
1687	=back	2394	=back
…		…
1706		2413
1707	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2414	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1708		2415
1709	if ($self->{record_replies}) {	2416	if ($self->{record_replies}) {
1710	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2417	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2418
1711	} else {	2419	} else {
		2420	my $pl = $self->contr;
		2421
		2422	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2423	my $dialog = $pl->{npc_dialog};
		2424	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2425
		2426	} else {
1712	$msg = $npc->name . " says: $msg" if $npc;	2427	$msg = $npc->name . " says: $msg" if $npc;
1713	$self->message ($msg, $flags);	2428	$self->message ($msg, $flags);
		2429	}
1714	}	2430	}
		2431	}
		2432
		2433	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2434
		2435	=cut
		2436
		2437	sub cf::object::send_msg {
		2438	my $pl = shift->contr
		2439	or return;
		2440	$pl->send_msg (@_);
1715	}	2441	}
1716		2442
1717	=item $player_object->may ("access")	2443	=item $player_object->may ("access")
1718		2444
1719	Returns wether the given player is authorized to access resource "access"	2445	Returns wether the given player is authorized to access resource "access"
…		…
1766	$self->deactivate_recursive;	2492	$self->deactivate_recursive;
1767		2493
1768	return if UNIVERSAL::isa $self->map, "ext::map_link";	2494	return if UNIVERSAL::isa $self->map, "ext::map_link";
1769		2495
1770	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2496	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1771	if $self->map;	2497	if $self->map && $self->map->{path} ne "{link}";
1772		2498
1773	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2499	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1774	}	2500	}
1775		2501
1776	sub cf::object::player::leave_link {	2502	sub cf::object::player::leave_link {
1777	my ($self, $map, $x, $y) = @_;	2503	my ($self, $map, $x, $y) = @_;
		2504
		2505	return unless $self->contr->active;
1778		2506
1779	my $link_pos = delete $self->{_link_pos};	2507	my $link_pos = delete $self->{_link_pos};
1780		2508
1781	unless ($map) {	2509	unless ($map) {
1782	# restore original map position	2510	# restore original map position
…		…
1796	# use -1 or undef as default coordinates, not 0, 0	2524	# use -1 or undef as default coordinates, not 0, 0
1797	($x, $y) = ($map->enter_x, $map->enter_y)	2525	($x, $y) = ($map->enter_x, $map->enter_y)
1798	if $x <=0 && $y <= 0;	2526	if $x <=0 && $y <= 0;
1799		2527
1800	$map->load;	2528	$map->load;
1801	$map->load_diag;	2529	$map->load_neighbours;
1802		2530
1803	return unless $self->contr->active;	2531	return unless $self->contr->active;
1804	$self->activate_recursive;	2532	$self->activate_recursive;
		2533
		2534	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1805	$self->enter_map ($map, $x, $y);	2535	$self->enter_map ($map, $x, $y);
1806	}	2536	}
1807		2537
1808	cf::player->attach (	2538	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1809	on_logout => sub {
1810	my ($pl) = @_;
1811		2539
1812	# abort map switching before logout	2540	Moves the player to the given map-path and coordinates by first freezing
1813	if ($pl->ob->{_link_pos}) {	2541	her, loading and preparing them map, calling the provided $check callback
1814	cf::sync_job {	2542	that has to return the map if sucecssful, and then unfreezes the player on
1815	$pl->ob->leave_link	2543	the new (success) or old (failed) map position. In either case, $done will
1816	};	2544	be called at the end of this process.
1817	}
1818	},
1819	on_login => sub {
1820	my ($pl) = @_;
1821		2545
1822	# try to abort aborted map switching on player login :)
1823	# should happen only on crashes
1824	if ($pl->ob->{_link_pos}) {
1825	$pl->ob->enter_link;
1826	(async {
1827	# we need this sleep as the login has a concurrent enter_exit running
1828	# and this sleep increases chances of the player not ending up in scorn
1829	$pl->ob->reply (undef,
1830	"There was an internal problem at your last logout, "
1831	. "the server will try to bring you to your intended destination in a second.",
1832	cf::NDI_RED);
1833	Coro::Timer::sleep 1;
1834	$pl->ob->leave_link;
1835	})->prio (2);
1836	}
1837	},
1838	);
1839
1840	=item $player_object->goto ($path, $x, $y)
1841
1842	=cut	2546	=cut
		2547
		2548	our $GOTOGEN;
1843		2549
1844	sub cf::object::player::goto {	2550	sub cf::object::player::goto {
1845	my ($self, $path, $x, $y) = @_;	2551	my ($self, $path, $x, $y, $check, $done) = @_;
		2552
		2553	# do generation counting so two concurrent goto's will be executed in-order
		2554	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1846		2555
1847	$self->enter_link;	2556	$self->enter_link;
1848		2557
1849	(async {	2558	(async {
		2559	$Coro::current->{desc} = "player::goto $path $x $y";
		2560
		2561	# *tag paths override both path and x|y
		2562	if ($path =~ /^\*(.*)$/) {
		2563	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2564	my $ob = $obs[rand @obs];
		2565
		2566	# see if we actually can go there
		2567	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2568	$ob = $obs[rand @obs];
		2569	} else {
		2570	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2571	}
		2572	# else put us there anyways for now #d#
		2573
		2574	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2575	} else {
		2576	($path, $x, $y) = (undef, undef, undef);
		2577	}
		2578	}
		2579
1850	my $map = eval {	2580	my $map = eval {
1851	my $map = cf::map::find $path;	2581	my $map = defined $path ? cf::map::find $path : undef;
		2582
		2583	if ($map) {
1852	$map = $map->customise_for ($self) if $map;	2584	$map = $map->customise_for ($self);
		2585	$map = $check->($map) if $check && $map;
		2586	} else {
		2587	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2588	}
		2589
1853	$map	2590	$map
		2591	};
		2592
		2593	if ($@) {
		2594	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2595	LOG llevError | logBacktrace, Carp::longmess $@;
1854	} or	2596	}
1855	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1856		2597
		2598	if ($gen == $self->{_goto_generation}) {
		2599	delete $self->{_goto_generation};
1857	$self->leave_link ($map, $x, $y);	2600	$self->leave_link ($map, $x, $y);
		2601	}
		2602
		2603	$done->() if $done;
1858	})->prio (1);	2604	})->prio (1);
1859	}	2605	}
1860		2606
1861	=item $player_object->enter_exit ($exit_object)	2607	=item $player_object->enter_exit ($exit_object)
1862		2608
…		…
1899	$rmp->{origin_y} = $exit->y;	2645	$rmp->{origin_y} = $exit->y;
1900	}	2646	}
1901		2647
1902	$rmp->{random_seed} ||= $exit->random_seed;	2648	$rmp->{random_seed} ||= $exit->random_seed;
1903		2649
1904	my $data = cf::to_json $rmp;	2650	my $data = cf::encode_json $rmp;
1905	my $md5 = Digest::MD5::md5_hex $data;	2651	my $md5 = Digest::MD5::md5_hex $data;
1906	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2652	my $meta = "$RANDOMDIR/$md5.meta";
1907		2653
1908	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2654	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1909	aio_write $fh, 0, (length $data), $data, 0;	2655	aio_write $fh, 0, (length $data), $data, 0;
1910	undef $fh;	2656	undef $fh;
1911	aio_rename "$meta~", $meta;	2657	aio_rename "$meta~", $meta;
…		…
1920		2666
1921	return unless $self->type == cf::PLAYER;	2667	return unless $self->type == cf::PLAYER;
1922		2668
1923	if ($exit->slaying eq "/!") {	2669	if ($exit->slaying eq "/!") {
1924	#TODO: this should de-fi-ni-te-ly not be a sync-job	2670	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2671	# the problem is that $exit might not survive long enough
		2672	# so it needs to be done right now, right here
1925	cf::sync_job { prepare_random_map $exit };	2673	cf::sync_job { prepare_random_map $exit };
1926	}	2674	}
1927		2675
1928	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2676	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1929	my $hp = $exit->stats->hp;	2677	my $hp = $exit->stats->hp;
1930	my $sp = $exit->stats->sp;	2678	my $sp = $exit->stats->sp;
1931		2679
1932	$self->enter_link;	2680	$self->enter_link;
1933		2681
		2682	# if exit is damned, update players death & WoR home-position
		2683	$self->contr->savebed ($slaying, $hp, $sp)
		2684	if $exit->flag (FLAG_DAMNED);
		2685
1934	(async {	2686	(async {
		2687	$Coro::current->{desc} = "enter_exit $slaying $hp $sp";
		2688
1935	$self->deactivate_recursive; # just to be sure	2689	$self->deactivate_recursive; # just to be sure
1936	unless (eval {	2690	unless (eval {
1937	$self->goto ($slaying, $hp, $sp);	2691	$self->goto ($slaying, $hp, $sp);
1938		2692
1939	1;	2693	1;
1940	}) {	2694	}) {
1941	$self->message ("Something went wrong deep within the crossfire server. "	2695	$self->message ("Something went wrong deep within the crossfire server. "
1942	. "I'll try to bring you back to the map you were before. "	2696	. "I'll try to bring you back to the map you were before. "
1943	. "Please report this to the dungeon master!",	2697	. "Please report this to the dungeon master!",
1944	cf::NDI_UNIQUE | cf::NDI_RED);	2698	cf::NDI_UNIQUE | cf::NDI_RED);
1945		2699
1946	warn "ERROR in enter_exit: $@";	2700	warn "ERROR in enter_exit: $@";
1947	$self->leave_link;	2701	$self->leave_link;
1948	}	2702	}
1949	})->prio (1);	2703	})->prio (1);
…		…
1962		2716
1963	sub cf::client::send_drawinfo {	2717	sub cf::client::send_drawinfo {
1964	my ($self, $text, $flags) = @_;	2718	my ($self, $text, $flags) = @_;
1965		2719
1966	utf8::encode $text;	2720	utf8::encode $text;
1967	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2721	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1968	}	2722	}
1969		2723
		2724	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2725
		2726	Send a drawinfo or msg packet to the client, formatting the msg for the
		2727	client if neccessary. C<$type> should be a string identifying the type of
		2728	the message, with C<log> being the default. If C<$color> is negative, suppress
		2729	the message unless the client supports the msg packet.
		2730
		2731	=cut
		2732
		2733	# non-persistent channels (usually the info channel)
		2734	our %CHANNEL = (
		2735	"c/identify" => {
		2736	id => "infobox",
		2737	title => "Identify",
		2738	reply => undef,
		2739	tooltip => "Items recently identified",
		2740	},
		2741	"c/examine" => {
		2742	id => "infobox",
		2743	title => "Examine",
		2744	reply => undef,
		2745	tooltip => "Signs and other items you examined",
		2746	},
		2747	"c/book" => {
		2748	id => "infobox",
		2749	title => "Book",
		2750	reply => undef,
		2751	tooltip => "The contents of a note or book",
		2752	},
		2753	"c/lookat" => {
		2754	id => "infobox",
		2755	title => "Look",
		2756	reply => undef,
		2757	tooltip => "What you saw there",
		2758	},
		2759	"c/who" => {
		2760	id => "infobox",
		2761	title => "Players",
		2762	reply => undef,
		2763	tooltip => "Shows players who are currently online",
		2764	},
		2765	"c/body" => {
		2766	id => "infobox",
		2767	title => "Body Parts",
		2768	reply => undef,
		2769	tooltip => "Shows which body parts you posess and are available",
		2770	},
		2771	"c/uptime" => {
		2772	id => "infobox",
		2773	title => "Uptime",
		2774	reply => undef,
		2775	tooltip => "How long the server has been running since last restart",
		2776	},
		2777	"c/mapinfo" => {
		2778	id => "infobox",
		2779	title => "Map Info",
		2780	reply => undef,
		2781	tooltip => "Information related to the maps",
		2782	},
		2783	);
		2784
		2785	sub cf::client::send_msg {
		2786	my ($self, $channel, $msg, $color, @extra) = @_;
		2787
		2788	$msg = $self->pl->expand_cfpod ($msg);
		2789
		2790	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2791
		2792	# check predefined channels, for the benefit of C
		2793	if ($CHANNEL{$channel}) {
		2794	$channel = $CHANNEL{$channel};
		2795
		2796	$self->ext_msg (channel_info => $channel)
		2797	if $self->can_msg;
		2798
		2799	$channel = $channel->{id};
		2800
		2801	} elsif (ref $channel) {
		2802	# send meta info to client, if not yet sent
		2803	unless (exists $self->{channel}{$channel->{id}}) {
		2804	$self->{channel}{$channel->{id}} = $channel;
		2805	$self->ext_msg (channel_info => $channel)
		2806	if $self->can_msg;
		2807	}
		2808
		2809	$channel = $channel->{id};
		2810	}
		2811
		2812	return unless @extra || length $msg;
		2813
		2814	if ($self->can_msg) {
		2815	# default colour, mask it out
		2816	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2817	if $color & cf::NDI_DEF;
		2818
		2819	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2820	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2821	} else {
		2822	if ($color >= 0) {
		2823	# replace some tags by gcfclient-compatible ones
		2824	for ($msg) {
		2825	1 while
		2826	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2827	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2828	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2829	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2830	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2831	}
		2832
		2833	$color &= cf::NDI_COLOR_MASK;
		2834
		2835	utf8::encode $msg;
		2836
		2837	if (0 && $msg =~ /\[/) {
		2838	# COMMAND/INFO
		2839	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2840	} else {
		2841	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2842	$self->send_packet ("drawinfo $color $msg")
		2843	}
		2844	}
		2845	}
		2846	}
		2847
		2848	=item $client->ext_msg ($type, @msg)
		2849
		2850	Sends an ext event to the client.
		2851
		2852	=cut
		2853
		2854	sub cf::client::ext_msg($$@) {
		2855	my ($self, $type, @msg) = @_;
		2856
		2857	if ($self->extcmd == 2) {
		2858	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2859	} elsif ($self->extcmd == 1) { # TODO: remove
		2860	push @msg, msgtype => "event_$type";
		2861	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2862	}
		2863	}
		2864
		2865	=item $client->ext_reply ($msgid, @msg)
		2866
		2867	Sends an ext reply to the client.
		2868
		2869	=cut
		2870
		2871	sub cf::client::ext_reply($$@) {
		2872	my ($self, $id, @msg) = @_;
		2873
		2874	if ($self->extcmd == 2) {
		2875	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2876	} elsif ($self->extcmd == 1) {
		2877	#TODO: version 1, remove
		2878	unshift @msg, msgtype => "reply", msgid => $id;
		2879	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2880	}
		2881	}
1970		2882
1971	=item $success = $client->query ($flags, "text", \&cb)	2883	=item $success = $client->query ($flags, "text", \&cb)
1972		2884
1973	Queues a query to the client, calling the given callback with	2885	Queues a query to the client, calling the given callback with
1974	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2886	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1975	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2887	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1976		2888
1977	Queries can fail, so check the return code. Or don't, as queries will become	2889	Queries can fail, so check the return code. Or don't, as queries will
1978	reliable at some point in the future.	2890	become reliable at some point in the future.
1979		2891
1980	=cut	2892	=cut
1981		2893
1982	sub cf::client::query {	2894	sub cf::client::query {
1983	my ($self, $flags, $text, $cb) = @_;	2895	my ($self, $flags, $text, $cb) = @_;
…		…
1991	utf8::encode $text;	2903	utf8::encode $text;
1992	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2904	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1993		2905
1994	$self->send_packet ($self->{query_queue}[0][0])	2906	$self->send_packet ($self->{query_queue}[0][0])
1995	if @{ $self->{query_queue} } == 1;	2907	if @{ $self->{query_queue} } == 1;
		2908
		2909	1
1996	}	2910	}
1997		2911
1998	cf::client->attach (	2912	cf::client->attach (
		2913	on_connect => sub {
		2914	my ($ns) = @_;
		2915
		2916	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2917	},
1999	on_reply => sub {	2918	on_reply => sub {
2000	my ($ns, $msg) = @_;	2919	my ($ns, $msg) = @_;
2001		2920
2002	# this weird shuffling is so that direct followup queries	2921	# this weird shuffling is so that direct followup queries
2003	# get handled first	2922	# get handled first
…		…
2015	} else {	2934	} else {
2016	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2935	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2017	}	2936	}
2018	}	2937	}
2019	},	2938	},
		2939	on_exticmd => sub {
		2940	my ($ns, $buf) = @_;
		2941
		2942	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2943
		2944	if (ref $msg) {
		2945	my ($type, $reply, @payload) =
		2946	"ARRAY" eq ref $msg
		2947	? @$msg
		2948	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2949
		2950	my @reply;
		2951
		2952	if (my $cb = $EXTICMD{$type}) {
		2953	@reply = $cb->($ns, @payload);
		2954	}
		2955
		2956	$ns->ext_reply ($reply, @reply)
		2957	if $reply;
		2958
		2959	} else {
		2960	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2961	}
		2962
		2963	cf::override;
		2964	},
2020	);	2965	);
2021		2966
2022	=item $client->async (\&cb)	2967	=item $client->async (\&cb)
2023		2968
2024	Create a new coroutine, running the specified callback. The coroutine will	2969	Create a new coroutine, running the specified callback. The coroutine will
…		…
2065	our $safe = new Safe "safe";	3010	our $safe = new Safe "safe";
2066	our $safe_hole = new Safe::Hole;	3011	our $safe_hole = new Safe::Hole;
2067		3012
2068	$SIG{FPE} = 'IGNORE';	3013	$SIG{FPE} = 'IGNORE';
2069		3014
2070	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3015	$safe->permit_only (Opcode::opset qw(
		3016	:base_core :base_mem :base_orig :base_math
		3017	grepstart grepwhile mapstart mapwhile
		3018	sort time
		3019	));
2071		3020
2072	# here we export the classes and methods available to script code	3021	# here we export the classes and methods available to script code
2073		3022
2074	=pod	3023	=pod
2075		3024
2076	The following fucntions and emthods are available within a safe environment:	3025	The following functions and methods are available within a safe environment:
2077		3026
2078	cf::object contr pay_amount pay_player map	3027	cf::object
		3028	contr pay_amount pay_player map x y force_find force_add destroy
		3029	insert remove name archname title slaying race decrease_ob_nr
		3030
2079	cf::object::player player	3031	cf::object::player
2080	cf::player peaceful	3032	player
2081	cf::map trigger	3033
		3034	cf::player
		3035	peaceful
		3036
		3037	cf::map
		3038	trigger
2082		3039
2083	=cut	3040	=cut
2084		3041
2085	for (	3042	for (
2086	["cf::object" => qw(contr pay_amount pay_player map)],	3043	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3044	insert remove inv name archname title slaying race
		3045	decrease_ob_nr destroy)],
2087	["cf::object::player" => qw(player)],	3046	["cf::object::player" => qw(player)],
2088	["cf::player" => qw(peaceful)],	3047	["cf::player" => qw(peaceful)],
2089	["cf::map" => qw(trigger)],	3048	["cf::map" => qw(trigger)],
2090	) {	3049	) {
2091	no strict 'refs';	3050	no strict 'refs';
…		…
2162	=back	3121	=back
2163		3122
2164	=cut	3123	=cut
2165		3124
2166	#############################################################################	3125	#############################################################################
		3126	# the server's init and main functions
2167		3127
2168	=head2 EXTENSION DATABASE SUPPORT	3128	sub load_facedata($) {
		3129	my ($path) = @_;
2169		3130
2170	Crossfire maintains a very simple database for extension use. It can	3131	# HACK to clear player env face cache, we need some signal framework
2171	currently store anything that can be serialised using Storable, which	3132	# for this (global event?)
2172	excludes objects.	3133	%ext::player_env::MUSIC_FACE_CACHE = ();
2173		3134
2174	The parameter C<$family> should best start with the name of the extension	3135	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2175	using it, it should be unique.
2176		3136
2177	=over 4	3137	warn "loading facedata from $path\n";
2178		3138
2179	=item $hashref = cf::db_get $family	3139	my $facedata;
		3140	0 < aio_load $path, $facedata
		3141	or die "$path: $!";
2180		3142
2181	Return a hashref for use by the extension C<$family>, which can be	3143	$facedata = Coro::Storable::thaw $facedata;
2182	modified. After modifications, you have to call C<cf::db_dirty> or
2183	C<cf::db_sync>.
2184		3144
2185	=item $value = cf::db_get $family => $key	3145	$facedata->{version} == 2
		3146	or cf::cleanup "$path: version mismatch, cannot proceed.";
2186		3147
2187	Returns a single value from the database	3148	# patch in the exptable
2188		3149	$facedata->{resource}{"res/exp_table"} = {
2189	=item cf::db_put $family => $hashref	3150	type => FT_RSRC,
2190		3151	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2191	Stores the given family hashref into the database. Updates are delayed, if
2192	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2193
2194	=item cf::db_put $family => $key => $value
2195
2196	Stores the given C<$value> in the family hash. Updates are delayed, if you
2197	want the data to be synced to disk immediately, use C<cf::db_sync>.
2198
2199	=item cf::db_dirty
2200
2201	Marks the database as dirty, to be updated at a later time.
2202
2203	=item cf::db_sync
2204
2205	Immediately write the database to disk I<if it is dirty>.
2206
2207	=cut
2208
2209	our $DB;
2210
2211	{
2212	my $path = cf::localdir . "/database.pst";
2213
2214	sub db_load() {
2215	$DB = stat $path ? Storable::retrieve $path : { };
2216	}	3152	};
		3153	cf::cede_to_tick;
2217		3154
2218	my $pid;
2219
2220	sub db_save() {
2221	waitpid $pid, 0 if $pid;
2222	if (0 == ($pid = fork)) {
2223	$DB->{_meta}{version} = 1;
2224	Storable::nstore $DB, "$path~";
2225	rename "$path~", $path;
2226	cf::_exit 0 if defined $pid;
2227	}
2228	}	3155	{
		3156	my $faces = $facedata->{faceinfo};
2229		3157
2230	my $dirty;	3158	while (my ($face, $info) = each %$faces) {
		3159	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2231		3160
2232	sub db_sync() {	3161	cf::face::set_visibility $idx, $info->{visibility};
2233	db_save if $dirty;	3162	cf::face::set_magicmap $idx, $info->{magicmap};
2234	undef $dirty;	3163	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2235	}	3164	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2236		3165
2237	my $idle = Event->idle (	3166	cf::cede_to_tick;
2238	reentrant => 0,
2239	min => 10,
2240	max => 20,
2241	repeat => 0,
2242	data => WF_AUTOCANCEL,
2243	cb => \&db_sync,
2244	);
2245
2246	sub db_dirty() {
2247	$dirty = 1;
2248	$idle->start;
2249	}
2250
2251	sub db_get($;$) {
2252	@_ >= 2
2253	? $DB->{$_[0]}{$_[1]}
2254	: ($DB->{$_[0]} ||= { })
2255	}
2256
2257	sub db_put($$;$) {
2258	if (@_ >= 3) {
2259	$DB->{$_[0]}{$_[1]} = $_[2];
2260	} else {
2261	$DB->{$_[0]} = $_[1];
2262	}
2263	db_dirty;
2264	}
2265
2266	cf::global->attach (
2267	prio => 10000,
2268	on_cleanup => sub {
2269	db_sync;
2270	},	3167	}
2271	);
2272	}
2273		3168
2274	#############################################################################	3169	while (my ($face, $info) = each %$faces) {
2275	# the server's main()	3170	next unless $info->{smooth};
2276		3171
2277	sub cfg_load {	3172	my $idx = cf::face::find $face
		3173	or next;
		3174
		3175	if (my $smooth = cf::face::find $info->{smooth}) {
		3176	cf::face::set_smooth $idx, $smooth;
		3177	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3178	} else {
		3179	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3180	}
		3181
		3182	cf::cede_to_tick;
		3183	}
		3184	}
		3185
		3186	{
		3187	my $anims = $facedata->{animinfo};
		3188
		3189	while (my ($anim, $info) = each %$anims) {
		3190	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3191	cf::cede_to_tick;
		3192	}
		3193
		3194	cf::anim::invalidate_all; # d'oh
		3195	}
		3196
		3197	{
		3198	# TODO: for gcfclient pleasure, we should give resources
		3199	# that gcfclient doesn't grok a >10000 face index.
		3200	my $res = $facedata->{resource};
		3201
		3202	while (my ($name, $info) = each %$res) {
		3203	if (defined $info->{type}) {
		3204	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3205	my $data;
		3206
		3207	if ($info->{type} & 1) {
		3208	# prepend meta info
		3209
		3210	my $meta = $enc->encode ({
		3211	name => $name,
		3212	%{ $info->{meta} || {} },
		3213	});
		3214
		3215	$data = pack "(w/a*)*", $meta, $info->{data};
		3216	} else {
		3217	$data = $info->{data};
		3218	}
		3219
		3220	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3221	cf::face::set_type $idx, $info->{type};
		3222	} else {
		3223	$RESOURCE{$name} = $info;
		3224	}
		3225
		3226	cf::cede_to_tick;
		3227	}
		3228	}
		3229
		3230	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3231
		3232	1
		3233	}
		3234
		3235	cf::global->attach (on_resource_update => sub {
		3236	if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
		3237	$soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
		3238
		3239	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3240	my $sound = $soundconf->{compat}[$_]
		3241	or next;
		3242
		3243	my $face = cf::face::find "sound/$sound->[1]";
		3244	cf::sound::set $sound->[0] => $face;
		3245	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3246	}
		3247
		3248	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3249	my $face = cf::face::find "sound/$v";
		3250	cf::sound::set $k => $face;
		3251	}
		3252	}
		3253	});
		3254
		3255	register_exticmd fx_want => sub {
		3256	my ($ns, $want) = @_;
		3257
		3258	while (my ($k, $v) = each %$want) {
		3259	$ns->fx_want ($k, $v);
		3260	}
		3261	};
		3262
		3263	sub reload_regions {
		3264	# HACK to clear player env face cache, we need some signal framework
		3265	# for this (global event?)
		3266	%ext::player_env::MUSIC_FACE_CACHE = ();
		3267
		3268	load_resource_file "$MAPDIR/regions"
		3269	or die "unable to load regions file\n";
		3270
		3271	for (cf::region::list) {
		3272	$_->{match} = qr/$_->{match}/
		3273	if exists $_->{match};
		3274	}
		3275	}
		3276
		3277	sub reload_facedata {
		3278	load_facedata "$DATADIR/facedata"
		3279	or die "unable to load facedata\n";
		3280	}
		3281
		3282	sub reload_archetypes {
		3283	load_resource_file "$DATADIR/archetypes"
		3284	or die "unable to load archetypes\n";
		3285	#d# NEED to laod twice to resolve forward references
		3286	# this really needs to be done in an extra post-pass
		3287	# (which needs to be synchronous, so solve it differently)
		3288	load_resource_file "$DATADIR/archetypes"
		3289	or die "unable to load archetypes\n";
		3290	}
		3291
		3292	sub reload_treasures {
		3293	load_resource_file "$DATADIR/treasures"
		3294	or die "unable to load treasurelists\n";
		3295	}
		3296
		3297	sub reload_resources {
		3298	warn "reloading resource files...\n";
		3299
		3300	reload_regions;
		3301	reload_facedata;
		3302	#reload_archetypes;#d#
		3303	reload_archetypes;
		3304	reload_treasures;
		3305
		3306	warn "finished reloading resource files\n";
		3307	}
		3308
		3309	sub init {
		3310	reload_resources;
		3311	}
		3312
		3313	sub reload_config {
2278	open my $fh, "<:utf8", cf::confdir . "/config"	3314	open my $fh, "<:utf8", "$CONFDIR/config"
2279	or return;	3315	or return;
2280		3316
2281	local $/;	3317	local $/;
2282	*CFG = YAML::Syck::Load <$fh>;	3318	*CFG = YAML::Syck::Load <$fh>;
2283		3319
…		…
2298	sub main {	3334	sub main {
2299	# we must not ever block the main coroutine	3335	# we must not ever block the main coroutine
2300	local $Coro::idle = sub {	3336	local $Coro::idle = sub {
2301	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3337	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2302	(async {	3338	(async {
2303	Event::one_event;	3339	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3340	EV::loop EV::LOOP_ONESHOT;
2304	})->prio (Coro::PRIO_MAX);	3341	})->prio (Coro::PRIO_MAX);
2305	};	3342	};
2306		3343
2307	cfg_load;	3344	reload_config;
2308	db_load;	3345	db_init;
2309	load_extensions;	3346	load_extensions;
2310		3347
2311	$TICK_WATCHER->start;	3348	$TICK_WATCHER->start;
		3349	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
2312	Event::loop;	3350	EV::loop;
2313	}	3351	}
2314		3352
2315	#############################################################################	3353	#############################################################################
2316	# initialisation and cleanup	3354	# initialisation and cleanup
2317		3355
2318	# install some emergency cleanup handlers	3356	# install some emergency cleanup handlers
2319	BEGIN {	3357	BEGIN {
		3358	our %SIGWATCHER = ();
2320	for my $signal (qw(INT HUP TERM)) {	3359	for my $signal (qw(INT HUP TERM)) {
2321	Event->signal (	3360	$SIGWATCHER{$signal} = EV::signal $signal, sub {
2322	reentrant => 0,
2323	data => WF_AUTOCANCEL,
2324	signal => $signal,
2325	prio => 0,
2326	cb => sub {
2327	cf::cleanup "SIG$signal";	3361	cf::cleanup "SIG$signal";
2328	},
2329	);	3362	};
		3363	}
		3364	}
		3365
		3366	sub write_runtime {
		3367	my $runtime = "$LOCALDIR/runtime";
		3368
		3369	# first touch the runtime file to show we are still running:
		3370	# the fsync below can take a very very long time.
		3371
		3372	IO::AIO::aio_utime $runtime, undef, undef;
		3373
		3374	my $guard = cf::lock_acquire "write_runtime";
		3375
		3376	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3377	or return;
		3378
		3379	my $value = $cf::RUNTIME + 90 + 10;
		3380	# 10 is the runtime save interval, for a monotonic clock
		3381	# 60 allows for the watchdog to kill the server.
		3382
		3383	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3384	and return;
		3385
		3386	# always fsync - this file is important
		3387	aio_fsync $fh
		3388	and return;
		3389
		3390	# touch it again to show we are up-to-date
		3391	aio_utime $fh, undef, undef;
		3392
		3393	close $fh
		3394	or return;
		3395
		3396	aio_rename "$runtime~", $runtime
		3397	and return;
		3398
		3399	warn "runtime file written.\n";
		3400
2330	}	3401	1
2331	}	3402	}
2332		3403
2333	sub emergency_save() {	3404	sub emergency_save() {
2334	my $freeze_guard = cf::freeze_mainloop;	3405	my $freeze_guard = cf::freeze_mainloop;
2335		3406
…		…
2341	# and maps saved/destroyed asynchronously.	3412	# and maps saved/destroyed asynchronously.
2342	warn "begin emergency player save\n";	3413	warn "begin emergency player save\n";
2343	for my $login (keys %cf::PLAYER) {	3414	for my $login (keys %cf::PLAYER) {
2344	my $pl = $cf::PLAYER{$login} or next;	3415	my $pl = $cf::PLAYER{$login} or next;
2345	$pl->valid or next;	3416	$pl->valid or next;
		3417	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2346	$pl->save;	3418	$pl->save;
2347	}	3419	}
2348	warn "end emergency player save\n";	3420	warn "end emergency player save\n";
2349		3421
2350	warn "begin emergency map save\n";	3422	warn "begin emergency map save\n";
…		…
2352	my $map = $cf::MAP{$path} or next;	3424	my $map = $cf::MAP{$path} or next;
2353	$map->valid or next;	3425	$map->valid or next;
2354	$map->save;	3426	$map->save;
2355	}	3427	}
2356	warn "end emergency map save\n";	3428	warn "end emergency map save\n";
		3429
		3430	warn "begin emergency database checkpoint\n";
		3431	BDB::db_env_txn_checkpoint $DB_ENV;
		3432	warn "end emergency database checkpoint\n";
2357	};	3433	};
2358		3434
2359	warn "leave emergency perl save\n";	3435	warn "leave emergency perl save\n";
2360	}	3436	}
2361		3437
		3438	sub post_cleanup {
		3439	my ($make_core) = @_;
		3440
		3441	warn Carp::longmess "post_cleanup backtrace"
		3442	if $make_core;
		3443	}
		3444
2362	sub reload() {	3445	sub do_reload_perl() {
2363	# can/must only be called in main	3446	# can/must only be called in main
2364	if ($Coro::current != $Coro::main) {	3447	if ($Coro::current != $Coro::main) {
2365	warn "can only reload from main coroutine";	3448	warn "can only reload from main coroutine";
2366	return;	3449	return;
2367	}	3450	}
2368		3451
2369	warn "reloading...";	3452	warn "reloading...";
2370		3453
2371	warn "cancelling server ticker";	3454	warn "entering sync_job";
2372	$TICK_WATCHER->cancel;
2373		3455
		3456	cf::sync_job {
		3457	cf::write_runtime; # external watchdog should not bark
2374	cf::emergency_save;	3458	cf::emergency_save;
		3459	cf::write_runtime; # external watchdog should not bark
2375		3460
2376	eval {	3461	warn "syncing database to disk";
		3462	BDB::db_env_txn_checkpoint $DB_ENV;
		3463
2377	# if anything goes wrong in here, we should simply crash as we already saved	3464	# if anything goes wrong in here, we should simply crash as we already saved
2378
2379	warn "syncing database to disk";
2380	cf::db_sync;
2381
2382	warn "cancelling all WF_AUTOCANCEL watchers";
2383	for (Event::all_watchers) {
2384	$_->cancel if $_->data & WF_AUTOCANCEL;
2385	}
2386		3465
2387	warn "flushing outstanding aio requests";	3466	warn "flushing outstanding aio requests";
2388	for (;;) {	3467	for (;;) {
		3468	BDB::flush;
2389	IO::AIO::flush;	3469	IO::AIO::flush;
2390	Coro::cede;	3470	Coro::cede_notself;
2391	last unless IO::AIO::nreqs;	3471	last unless IO::AIO::nreqs || BDB::nreqs;
2392	warn "iterate...";	3472	warn "iterate...";
2393	}	3473	}
		3474
		3475	++$RELOAD;
2394		3476
2395	warn "cancelling all extension coros";	3477	warn "cancelling all extension coros";
2396	$_->cancel for values %EXT_CORO;	3478	$_->cancel for values %EXT_CORO;
2397	%EXT_CORO = ();	3479	%EXT_CORO = ();
2398		3480
2399	warn "removing commands";	3481	warn "removing commands";
2400	%COMMAND = ();	3482	%COMMAND = ();
2401		3483
2402	warn "removing ext commands";	3484	warn "removing ext/exti commands";
2403	%EXTCMD = ();	3485	%EXTCMD = ();
		3486	%EXTICMD = ();
2404		3487
2405	warn "unloading/nuking all extensions";	3488	warn "unloading/nuking all extensions";
2406	for my $pkg (@EXTS) {	3489	for my $pkg (@EXTS) {
2407	warn "... unloading $pkg";	3490	warn "... unloading $pkg";
2408		3491
…		…
2438	Symbol::delete_package "safe::$_"	3521	Symbol::delete_package "safe::$_"
2439	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3522	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2440		3523
2441	warn "unloading cf.pm \"a bit\"";	3524	warn "unloading cf.pm \"a bit\"";
2442	delete $INC{"cf.pm"};	3525	delete $INC{"cf.pm"};
		3526	delete $INC{"cf/pod.pm"};
2443		3527
2444	# don't, removes xs symbols, too,	3528	# don't, removes xs symbols, too,
2445	# and global variables created in xs	3529	# and global variables created in xs
2446	#Symbol::delete_package __PACKAGE__;	3530	#Symbol::delete_package __PACKAGE__;
2447		3531
…		…
2450	warn "reloading cf.pm";	3534	warn "reloading cf.pm";
2451	require cf;	3535	require cf;
2452	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3536	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2453		3537
2454	warn "loading config and database again";	3538	warn "loading config and database again";
2455	cf::cfg_load;	3539	cf::reload_config;
2456	cf::db_load;
2457		3540
2458	warn "loading extensions";	3541	warn "loading extensions";
2459	cf::load_extensions;	3542	cf::load_extensions;
2460		3543
2461	warn "reattaching attachments to objects/players";	3544	warn "reattaching attachments to objects/players";
2462	_global_reattach;	3545	_global_reattach; # objects, sockets
2463	warn "reattaching attachments to maps";	3546	warn "reattaching attachments to maps";
2464	reattach $_ for values %MAP;	3547	reattach $_ for values %MAP;
		3548	warn "reattaching attachments to players";
		3549	reattach $_ for values %PLAYER;
2465		3550
2466	warn "restarting server ticker";	3551	warn "leaving sync_job";
2467		3552
2468	$TICK_WATCHER->start;	3553	1
2469	};	3554	} or do {
2470
2471	if ($@) {
2472	warn $@;	3555	warn $@;
2473	warn "error while reloading, exiting.";	3556	warn "error while reloading, exiting.";
2474	exit 1;	3557	exit 1;
2475	}	3558	};
2476		3559
2477	warn "reloaded";	3560	warn "reloaded";
2478	};	3561	};
2479		3562
2480	our $RELOAD_WATCHER; # used only during reload	3563	our $RELOAD_WATCHER; # used only during reload
2481		3564
		3565	sub reload_perl() {
		3566	# doing reload synchronously and two reloads happen back-to-back,
		3567	# coro crashes during coro_state_free->destroy here.
		3568
		3569	$RELOAD_WATCHER ||= EV::timer 0, 0, sub {
		3570	undef $RELOAD_WATCHER;
		3571	do_reload_perl;
		3572	};
		3573	}
		3574
2482	register_command "reload" => sub {	3575	register_command "reload" => sub {
2483	my ($who, $arg) = @_;	3576	my ($who, $arg) = @_;
2484		3577
2485	if ($who->flag (FLAG_WIZ)) {	3578	if ($who->flag (FLAG_WIZ)) {
2486	$who->message ("reloading server.");	3579	$who->message ("reloading server.");
2487		3580	async {
2488	# doing reload synchronously and two reloads happen back-to-back,	3581	$Coro::current->{desc} = "perl_reload";
2489	# coro crashes during coro_state_free->destroy here.
2490
2491	$RELOAD_WATCHER ||= Event->timer (
2492	reentrant => 0,
2493	after => 0,
2494	data => WF_AUTOCANCEL,
2495	cb => sub {
2496	reload;	3582	reload_perl;
2497	undef $RELOAD_WATCHER;
2498	},
2499	);	3583	};
2500	}	3584	}
2501	};	3585	};
2502		3586
2503	unshift @INC, $LIBDIR;	3587	unshift @INC, $LIBDIR;
2504		3588
2505	my $bug_warning = 0;	3589	my $bug_warning = 0;
2506		3590
2507	$TICK_WATCHER = Event->timer (	3591	our @WAIT_FOR_TICK;
2508	reentrant => 0,	3592	our @WAIT_FOR_TICK_BEGIN;
2509	parked => 1,	3593
2510	prio => 0,	3594	sub wait_for_tick {
2511	at => $NEXT_TICK || $TICK,	3595	return unless $TICK_WATCHER->is_active;
2512	data => WF_AUTOCANCEL,	3596	return if $Coro::current == $Coro::main;
2513	cb => sub {	3597
		3598	my $signal = new Coro::Signal;
		3599	push @WAIT_FOR_TICK, $signal;
		3600	$signal->wait;
		3601	}
		3602
		3603	sub wait_for_tick_begin {
		3604	return unless $TICK_WATCHER->is_active;
		3605	return if $Coro::current == $Coro::main;
		3606
		3607	my $signal = new Coro::Signal;
		3608	push @WAIT_FOR_TICK_BEGIN, $signal;
		3609	$signal->wait;
		3610	}
		3611
		3612	$TICK_WATCHER = EV::periodic_ns 0, $TICK, 0, sub {
2514	if ($Coro::current != $Coro::main) {	3613	if ($Coro::current != $Coro::main) {
2515	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3614	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2516	unless ++$bug_warning > 10;	3615	unless ++$bug_warning > 10;
2517	return;	3616	return;
2518	}	3617	}
2519		3618
2520	$NOW = Event::time;	3619	$NOW = $tick_start = EV::now;
2521		3620
2522	cf::server_tick; # one server iteration	3621	cf::server_tick; # one server iteration
		3622
2523	$RUNTIME += $TICK;	3623	$RUNTIME += $TICK;
2524	$NEXT_TICK += $TICK;	3624	$NEXT_TICK = $_[0]->at;
2525		3625
2526	$WAIT_FOR_TICK->broadcast;	3626	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2527	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3627	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2528		3628	Coro::async_pool {
2529	Event::sweep;	3629	$Coro::current->{desc} = "runtime saver";
2530	Coro::cede_notself;
2531
2532	# my $AFTER = Event::time;
2533	# warn $AFTER - $NOW;#d#
2534
2535	# if we are delayed by four ticks or more, skip them all
2536	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2537
2538	$TICK_WATCHER->at ($NEXT_TICK);
2539	$TICK_WATCHER->start;
2540	},
2541	);
2542
2543	IO::AIO::max_poll_time $TICK * 0.1;
2544
2545	undef $Coro::AIO::WATCHER;
2546	$AIO_POLL_WATCHER = Event->io (
2547	reentrant => 0,
2548	fd => IO::AIO::poll_fileno,
2549	poll => 'r',
2550	prio => 6,
2551	data => WF_AUTOCANCEL,
2552	cb => \&IO::AIO::poll_cb,
2553	);
2554
2555	$WRITE_RUNTIME_WATCHER = Event->timer (
2556	reentrant => 0,
2557	data => WF_AUTOCANCEL,
2558	after => 1,
2559	interval => 10,
2560	prio => 6, # keep it lowest so it acts like a watchdog
2561	cb => Coro::unblock_sub {
2562	write_runtime	3630	write_runtime
2563	or warn "ERROR: unable to write runtime file: $!";	3631	or warn "ERROR: unable to write runtime file: $!";
		3632	};
2564	},	3633	}
2565	);	3634
		3635	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3636	$sig->send;
		3637	}
		3638	while (my $sig = shift @WAIT_FOR_TICK) {
		3639	$sig->send;
		3640	}
		3641
		3642	$LOAD = ($NOW - $tick_start) / $TICK;
		3643	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3644
		3645	_post_tick;
		3646	};
		3647	$TICK_WATCHER->priority (EV::MAXPRI);
		3648
		3649	{
		3650	# configure BDB
		3651
		3652	BDB::min_parallel 8;
		3653	BDB::max_poll_reqs $TICK * 0.1;
		3654	$Coro::BDB::WATCHER->priority (1);
		3655
		3656	unless ($DB_ENV) {
		3657	$DB_ENV = BDB::db_env_create;
		3658	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
		3659	| BDB::LOG_AUTOREMOVE, 1);
		3660	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3661	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3662
		3663	cf::sync_job {
		3664	eval {
		3665	BDB::db_env_open
		3666	$DB_ENV,
		3667	$BDBDIR,
		3668	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3669	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3670	0666;
		3671
		3672	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3673	};
		3674
		3675	cf::cleanup "db_env_open(db): $@" if $@;
		3676	};
		3677	}
		3678
		3679	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3680	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3681	};
		3682	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		3683	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3684	};
		3685	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3686	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3687	};
		3688	}
		3689
		3690	{
		3691	# configure IO::AIO
		3692
		3693	IO::AIO::min_parallel 8;
		3694	IO::AIO::max_poll_time $TICK * 0.1;
		3695	$Coro::AIO::WATCHER->priority (1);
		3696	}
		3697
		3698	my $_log_backtrace;
		3699
		3700	sub _log_backtrace {
		3701	my ($msg, @addr) = @_;
		3702
		3703	$msg =~ s/\n//;
		3704
		3705	# limit the # of concurrent backtraces
		3706	if ($_log_backtrace < 2) {
		3707	++$_log_backtrace;
		3708	async {
		3709	$Coro::current->{desc} = "abt $msg";
		3710
		3711	my @bt = fork_call {
		3712	@addr = map { sprintf "%x", $_ } @addr;
		3713	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3714	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3715	or die "addr2line: $!";
		3716
		3717	my @funcs;
		3718	my @res = <$fh>;
		3719	chomp for @res;
		3720	while (@res) {
		3721	my ($func, $line) = splice @res, 0, 2, ();
		3722	push @funcs, "[$func] $line";
		3723	}
		3724
		3725	@funcs
		3726	};
		3727
		3728	LOG llevInfo, "[ABT] $msg\n";
		3729	LOG llevInfo, "[ABT] $_\n" for @bt;
		3730	--$_log_backtrace;
		3731	};
		3732	} else {
		3733	LOG llevInfo, "[ABT] $msg\n";
		3734	LOG llevInfo, "[ABT] [suppressed]\n";
		3735	}
		3736	}
		3737
		3738	# load additional modules
		3739	use cf::pod;
2566		3740
2567	END { cf::emergency_save }	3741	END { cf::emergency_save }
2568		3742
2569	1	3743	1
2570		3744

Diff Legend

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