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.186 by root, Sat Jan 20 01:12:39 2007 UTC vs.
Revision 1.366 by root, Tue Sep 11 16:05:35 2007 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 Socket;
8	use Storable;	9	use Storable;
		10	use Event;
9	use Opcode;	11	use Opcode;
10	use Safe;	12	use Safe;
11	use Safe::Hole;	13	use Safe::Hole;
12		14
13	use Coro 3.4 ();	15	use Coro 3.64 ();
		16	use Coro::State;
		17	use Coro::Handle;
14	use Coro::Event;	18	use Coro::Event;
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::Storable;
		24	use Coro::Util ();
19		25
		26	use JSON::XS ();
		27	use BDB ();
20	use Data::Dumper;	28	use Data::Dumper;
21	use Digest::MD5;	29	use Digest::MD5;
22	use Fcntl;	30	use Fcntl;
		31	use YAML::Syck ();
23	use IO::AIO 2.32 ();	32	use IO::AIO 2.32 ();
24	use YAML::Syck ();
25	use Time::HiRes;	33	use Time::HiRes;
		34	use Compress::LZF;
		35	use Digest::MD5 ();
26		36
		37	# configure various modules to our taste
		38	#
		39	$Storable::canonical = 1; # reduce rsync transfers
		40	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		41	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		42
27	use Event; $Event::Eval = 1; # no idea why this is required, but it is	43	$Event::Eval = 1; # no idea why this is required, but it is
28
29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30		44
31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	45	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32	$YAML::Syck::ImplicitUnicode = 1;	46	$YAML::Syck::ImplicitUnicode = 1;
33		47
34	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority	48	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
35		49
		50	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		51
36	our %COMMAND = ();	52	our %COMMAND = ();
37	our %COMMAND_TIME = ();	53	our %COMMAND_TIME = ();
38		54
39	our @EXTS = (); # list of extension package names	55	our @EXTS = (); # list of extension package names
40	our %EXTCMD = ();	56	our %EXTCMD = ();
		57	our %EXTICMD = ();
41	our %EXT_CORO = (); # coroutines bound to extensions	58	our %EXT_CORO = (); # coroutines bound to extensions
42	our %EXT_MAP = (); # pluggable maps	59	our %EXT_MAP = (); # pluggable maps
43		60
		61	our $RELOAD; # number of reloads so far
44	our @EVENT;	62	our @EVENT;
45	our $LIBDIR = datadir . "/ext";
46		63
47	our $TICK = MAX_TIME * 1e-6;	64	our $CONFDIR = confdir;
		65	our $DATADIR = datadir;
		66	our $LIBDIR = "$DATADIR/ext";
		67	our $PODDIR = "$DATADIR/pod";
		68	our $MAPDIR = "$DATADIR/" . mapdir;
		69	our $LOCALDIR = localdir;
		70	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		71	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		72	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		73	our $RANDOMDIR = "$LOCALDIR/random";
		74	our $BDBDIR = "$LOCALDIR/db";
		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 $NOW;
		82	our $USE_FSYNC = 1; # use fsync to write maps - default off
		83
		84	our $BDB_POLL_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;
58		93
59	our %PLAYER; # all users	94	our (%PLAYER, %PLAYER_LOADING); # all users
60	our %MAP; # all maps	95	our (%MAP, %MAP_LOADING ); # all maps
61	our $LINK_MAP; # the special {link} map, which is always available	96	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		97
67	# used to convert map paths into valid unix filenames by replacing / by ∕	98	# used to convert map paths into valid unix filenames by replacing / by ∕
68	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	99	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69		100
		101	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		102	our $LOADAVG; # same thing, but with alpha-smoothing
		103	our $tick_start; # for load detecting purposes
		104
70	binmode STDOUT;	105	binmode STDOUT;
71	binmode STDERR;	106	binmode STDERR;
72		107
73	# read virtual server time, if available	108	# read virtual server time, if available
74	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	109	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
75	open my $fh, "<", cf::localdir . "/runtime"	110	open my $fh, "<", "$LOCALDIR/runtime"
76	or die "unable to read runtime file: $!";	111	or die "unable to read runtime file: $!";
77	$RUNTIME = <$fh> + 0.;	112	$RUNTIME = <$fh> + 0.;
78	}	113	}
79		114
80	mkdir cf::localdir;	115	mkdir $_
81	mkdir cf::localdir . "/" . cf::playerdir;	116	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
82	mkdir cf::localdir . "/" . cf::tmpdir;
83	mkdir cf::localdir . "/" . cf::uniquedir;
84	mkdir $RANDOM_MAPS;
85		117
86	our $EMERGENCY_POSITION;	118	our $EMERGENCY_POSITION;
		119
		120	sub cf::map::normalise;
87		121
88	#############################################################################	122	#############################################################################
89		123
90	=head2 GLOBAL VARIABLES	124	=head2 GLOBAL VARIABLES
91		125
…		…
98	=item $cf::RUNTIME	132	=item $cf::RUNTIME
99		133
100	The time this server has run, starts at 0 and is increased by $cf::TICK on	134	The time this server has run, starts at 0 and is increased by $cf::TICK on
101	every server tick.	135	every server tick.
102		136
103	=item $cf::LIBDIR	137	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		138	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		139	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
104		140
105	The perl library directory, where extensions and cf-specific modules can	141	Various directories - "/etc", read-only install directory, perl-library
106	be found. It will be added to C<@INC> automatically.	142	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		143	unique-items directory, player file directory, random maps directory and
		144	database environment.
107		145
108	=item $cf::NOW	146	=item $cf::NOW
109		147
110	The time of the last (current) server tick.	148	The time of the last (current) server tick.
111		149
112	=item $cf::TICK	150	=item $cf::TICK
113		151
114	The interval between server ticks, in seconds.	152	The interval between server ticks, in seconds.
		153
		154	=item $cf::LOADAVG
		155
		156	The current CPU load on the server (alpha-smoothed), as a value between 0
		157	(none) and 1 (overloaded), indicating how much time is spent on processing
		158	objects per tick. Healthy values are < 0.5.
		159
		160	=item $cf::LOAD
		161
		162	The raw value load value from the last tick.
115		163
116	=item %cf::CFG	164	=item %cf::CFG
117		165
118	Configuration for the server, loaded from C</etc/crossfire/config>, or	166	Configuration for the server, loaded from C</etc/crossfire/config>, or
119	from wherever your confdir points to.	167	from wherever your confdir points to.
120		168
121	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	169	=item cf::wait_for_tick, cf::wait_for_tick_begin
122		170
123	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	171	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
124	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick	172	returns directly I<after> the tick processing (and consequently, can only wake one process
125	processing has been done. Call C<< ->wait >> on them to maximise the	173	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
126	window of cpu time available, or simply to synchronise to the server tick.	174
		175	=item @cf::INVOKE_RESULTS
		176
		177	This array contains the results of the last C<invoke ()> call. When
		178	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		179	that call.
127		180
128	=back	181	=back
129		182
130	=cut	183	=cut
131		184
132	BEGIN {	185	BEGIN {
133	*CORE::GLOBAL::warn = sub {	186	*CORE::GLOBAL::warn = sub {
134	my $msg = join "", @_;	187	my $msg = join "", @_;
135	utf8::encode $msg;
136		188
137	$msg .= "\n"	189	$msg .= "\n"
138	unless $msg =~ /\n$/;	190	unless $msg =~ /\n$/;
		191
		192	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
139		193
140	LOG llevError, $msg;	194	LOG llevError, $msg;
141	};	195	};
142	}	196	}
143		197
144	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	198	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
145	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	199	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
146	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	200	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
147	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	201	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
148	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	202	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		203	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
149	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	204	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
150		205
151	# we bless all objects into (empty) derived classes to force a method lookup	206	# we bless all objects into (empty) derived classes to force a method lookup
152	# within the Safe compartment.	207	# within the Safe compartment.
153	for my $pkg (qw(	208	for my $pkg (qw(
154	cf::global cf::attachable	209	cf::global cf::attachable
…		…
162	}	217	}
163		218
164	$Event::DIED = sub {	219	$Event::DIED = sub {
165	warn "error in event callback: @_";	220	warn "error in event callback: @_";
166	};	221	};
		222
		223	#############################################################################
167		224
168	=head2 UTILITY FUNCTIONS	225	=head2 UTILITY FUNCTIONS
169		226
170	=over 4	227	=over 4
171		228
…		…
190	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	247	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
191	$d	248	$d
192	} || "[unable to dump $_[0]: '$@']";	249	} || "[unable to dump $_[0]: '$@']";
193	}	250	}
194		251
195	use JSON::Syck (); # TODO# replace by JSON::PC once working
196
197	=item $ref = cf::from_json $json	252	=item $ref = cf::from_json $json
198		253
199	Converts a JSON string into the corresponding perl data structure.	254	Converts a JSON string into the corresponding perl data structure.
200		255
201	=cut
202
203	sub from_json($) {
204	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
205	JSON::Syck::Load $_[0]
206	}
207
208	=item $json = cf::to_json $ref	256	=item $json = cf::to_json $ref
209		257
210	Converts a perl data structure into its JSON representation.	258	Converts a perl data structure into its JSON representation.
211		259
212	=cut	260	=cut
213		261
214	sub to_json($) {	262	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
215	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	263
216	JSON::Syck::Dump $_[0]	264	sub to_json ($) { $json_coder->encode ($_[0]) }
217	}	265	sub from_json ($) { $json_coder->decode ($_[0]) }
218		266
219	=item cf::lock_wait $string	267	=item cf::lock_wait $string
220		268
221	Wait until the given lock is available. See cf::lock_acquire.	269	Wait until the given lock is available. See cf::lock_acquire.
222		270
…		…
225	Wait until the given lock is available and then acquires it and returns	273	Wait until the given lock is available and then acquires it and returns
226	a Coro::guard object. If the guard object gets destroyed (goes out of scope,	274	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
227	for example when the coroutine gets canceled), the lock is automatically	275	for example when the coroutine gets canceled), the lock is automatically
228	returned.	276	returned.
229		277
		278	Locks are *not* recursive, locking from the same coro twice results in a
		279	deadlocked coro.
		280
230	Lock names should begin with a unique identifier (for example, cf::map::find	281	Lock names should begin with a unique identifier (for example, cf::map::find
231	uses map_find and cf::map::load uses map_load).	282	uses map_find and cf::map::load uses map_load).
232		283
		284	=item $locked = cf::lock_active $string
		285
		286	Return true if the lock is currently active, i.e. somebody has locked it.
		287
233	=cut	288	=cut
234		289
235	our %LOCK;	290	our %LOCK;
		291	our %LOCKER;#d#
236		292
237	sub lock_wait($) {	293	sub lock_wait($) {
238	my ($key) = @_;	294	my ($key) = @_;
		295
		296	if ($LOCKER{$key} == $Coro::current) {#d#
		297	Carp::cluck "lock_wait($key) for already-acquired lock";#d#
		298	return;#d#
		299	}#d#
239		300
240	# wait for lock, if any	301	# wait for lock, if any
241	while ($LOCK{$key}) {	302	while ($LOCK{$key}) {
242	push @{ $LOCK{$key} }, $Coro::current;	303	push @{ $LOCK{$key} }, $Coro::current;
243	Coro::schedule;	304	Coro::schedule;
…		…
249		310
250	# wait, to be sure we are not locked	311	# wait, to be sure we are not locked
251	lock_wait $key;	312	lock_wait $key;
252		313
253	$LOCK{$key} = [];	314	$LOCK{$key} = [];
		315	$LOCKER{$key} = $Coro::current;#d#
254		316
255	Coro::guard {	317	Coro::guard {
		318	delete $LOCKER{$key};#d#
256	# wake up all waiters, to be on the safe side	319	# wake up all waiters, to be on the safe side
257	$_->ready for @{ delete $LOCK{$key} };	320	$_->ready for @{ delete $LOCK{$key} };
258	}	321	}
259	}	322	}
260		323
		324	sub lock_active($) {
		325	my ($key) = @_;
		326
		327	! ! $LOCK{$key}
		328	}
		329
261	sub freeze_mainloop {	330	sub freeze_mainloop {
262	return unless $TICK_WATCHER->is_active;	331	return unless $TICK_WATCHER->is_active;
263		332
264	my $guard = Coro::guard {	333	my $guard = Coro::guard {
265	$TICK_WATCHER->start;	334	$TICK_WATCHER->start;
266	$WRITE_RUNTIME_WATCHER->start;
267	};	335	};
268	$WRITE_RUNTIME_WATCHER->stop;
269	$TICK_WATCHER->stop;	336	$TICK_WATCHER->stop;
270	$guard	337	$guard
		338	}
		339
		340	=item cf::get_slot $time[, $priority[, $name]]
		341
		342	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		343	This call blocks and returns only when you have at least C<$time> seconds
		344	of cpu time till the next tick. The slot is only valid till the next cede.
		345
		346	The optional C<$name> can be used to identify the job to run. It might be
		347	used for statistical purposes and should identify the same time-class.
		348
		349	Useful for short background jobs.
		350
		351	=cut
		352
		353	our @SLOT_QUEUE;
		354	our $SLOT_QUEUE;
		355
		356	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		357	$SLOT_QUEUE = Coro::async {
		358	my $signal = new Coro::Signal;
		359
		360	while () {
		361	next_job:
		362	my $avail = cf::till_tick;
		363	if ($avail > 0.01) {
		364	for (0 .. $#SLOT_QUEUE) {
		365	if ($SLOT_QUEUE[$_][0] < $avail) {
		366	my $job = splice @SLOT_QUEUE, $_, 1, ();
		367	$job->[2]->send;
		368	Coro::cede;
		369	goto next_job;
		370	}
		371	}
		372	}
		373
		374	if (@SLOT_QUEUE) {
		375	# we do not use wait_For_tick() as it returns immediately when tick is inactive
		376	push @cf::WAIT_FOR_TICK, $signal;
		377	$signal->wait;
		378	} else {
		379	Coro::schedule;
		380	}
		381	}
		382	};
		383
		384	sub get_slot($;$$) {
		385	my ($time, $pri, $name) = @_;
		386
		387	$time = $TICK * .6 if $time > $TICK * .6;
		388	my $sig = new Coro::Signal;
		389
		390	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		391	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		392	$SLOT_QUEUE->ready;
		393	$sig->wait;
271	}	394	}
272		395
273	=item cf::async { BLOCK }	396	=item cf::async { BLOCK }
274		397
275	Currently the same as Coro::async_pool, meaning you cannot use	398	Currently the same as Coro::async_pool, meaning you cannot use
…		…
280		403
281	BEGIN { *async = \&Coro::async_pool }	404	BEGIN { *async = \&Coro::async_pool }
282		405
283	=item cf::sync_job { BLOCK }	406	=item cf::sync_job { BLOCK }
284		407
285	The design of crossfire+ requires that the main coro ($Coro::main) is	408	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
286	always able to handle events or runnable, as crossfire+ is only partly	409	is always able to handle events or runnable, as Crossfire TRT is only
287	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	410	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		411	acceptable.
288		412
289	If it must be done, put the blocking parts into C<sync_job>. This will run	413	If it must be done, put the blocking parts into C<sync_job>. This will run
290	the given BLOCK in another coroutine while waiting for the result. The	414	the given BLOCK in another coroutine while waiting for the result. The
291	server will be frozen during this time, so the block should either finish	415	server will be frozen during this time, so the block should either finish
292	fast or be very important.	416	fast or be very important.
…		…
295		419
296	sub sync_job(&) {	420	sub sync_job(&) {
297	my ($job) = @_;	421	my ($job) = @_;
298		422
299	if ($Coro::current == $Coro::main) {	423	if ($Coro::current == $Coro::main) {
		424	my $time = Event::time;
		425
300	# this is the main coro, too bad, we have to block	426	# this is the main coro, too bad, we have to block
301	# till the operation succeeds, freezing the server :/	427	# till the operation succeeds, freezing the server :/
302		428
303	# TODO: use suspend/resume instead	429	# TODO: use suspend/resume instead
304	# (but this is cancel-safe)	430	# (but this is cancel-safe)
…		…
315		441
316	while ($busy) {	442	while ($busy) {
317	Coro::cede or Event::one_event;	443	Coro::cede or Event::one_event;
318	}	444	}
319		445
		446	$time = Event::time - $time;
		447
		448	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		449	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		450
		451	$tick_start += $time; # do not account sync jobs to server load
		452
320	wantarray ? @res : $res[0]	453	wantarray ? @res : $res[0]
321	} else {	454	} else {
322	# we are in another coroutine, how wonderful, everything just works	455	# we are in another coroutine, how wonderful, everything just works
323		456
324	$job->()	457	$job->()
…		…
343	$EXT_CORO{$coro+0} = $coro;	476	$EXT_CORO{$coro+0} = $coro;
344		477
345	$coro	478	$coro
346	}	479	}
347		480
348	sub write_runtime {	481	=item fork_call { }, $args
349	my $runtime = cf::localdir . "/runtime";
350		482
351	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	483	Executes the given code block with the given arguments in a seperate
352	or return;	484	process, returning the results. Everything must be serialisable with
		485	Coro::Storable. May, of course, block. Note that the executed sub may
		486	never block itself or use any form of Event handling.
353		487
354	my $value = $cf::RUNTIME + 90 + 10;	488	=cut
355	# 10 is the runtime save interval, for a monotonic clock
356	# 60 allows for the watchdog to kill the server.
357		489
358	(aio_write $fh, 0, (length $value), $value, 0) <= 0	490	sub fork_call(&@) {
359	and return;	491	my ($cb, @args) = @_;
360		492
361	aio_fsync $fh	493	# we seemingly have to make a local copy of the whole thing,
362	and return;	494	# otherwise perl prematurely frees the stuff :/
		495	# TODO: investigate and fix (likely this will be rather laborious)
363		496
364	close $fh	497	my @res = Coro::Util::fork_eval {
365	or return;	498	reset_signals;
		499	&$cb
		500	}, @args;
366		501
367	aio_rename "$runtime~", $runtime	502	wantarray ? @res : $res[-1]
368	and return;	503	}
369		504
		505	=item $value = cf::db_get $family => $key
		506
		507	Returns a single value from the environment database.
		508
		509	=item cf::db_put $family => $key => $value
		510
		511	Stores the given C<$value> in the family. It can currently store binary
		512	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		513
		514	=item $db = cf::db_table "name"
		515
		516	Create and/or open a new database table. The string must not be "db" and must be unique
		517	within each server.
		518
		519	=cut
		520
		521	sub db_table($) {
		522	my ($name) = @_;
		523	my $db = BDB::db_create $DB_ENV;
		524
		525	eval {
		526	$db->set_flags (BDB::CHKSUM);
		527
		528	utf8::encode $name;
		529	BDB::db_open $db, undef, $name, undef, BDB::BTREE,
		530	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		531	cf::cleanup "db_open(db): $!" if $!;
		532	};
		533	cf::cleanup "db_open(db): $@" if $@;
		534
		535	$db
		536	}
		537
		538	our $DB;
		539
		540	sub db_init {
		541	cf::sync_job {
		542	$DB ||= db_table "db";
		543	};
		544	}
		545
		546	sub db_get($$) {
		547	my $key = "$_[0]/$_[1]";
		548
		549	cf::sync_job {
		550	BDB::db_get $DB, undef, $key, my $data;
		551
		552	$! ? ()
		553	: $data
370	1	554	}
		555	}
		556
		557	sub db_put($$$) {
		558	BDB::dbreq_pri 4;
		559	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		560	}
		561
		562	=item cf::cache $id => [$paths...], $processversion => $process
		563
		564	Generic caching function that returns the value of the resource $id,
		565	caching and regenerating as required.
		566
		567	This function can block.
		568
		569	=cut
		570
		571	sub cache {
		572	my ($id, $src, $processversion, $process) = @_;
		573
		574	my $meta =
		575	join "\x00",
		576	$processversion,
		577	map {
		578	aio_stat $_
		579	and Carp::croak "$_: $!";
		580
		581	($_, (stat _)[7,9])
		582	} @$src;
		583
		584	my $dbmeta = db_get cache => "$id/meta";
		585	if ($dbmeta ne $meta) {
		586	# changed, we may need to process
		587
		588	my @data;
		589	my $md5;
		590
		591	for (0 .. $#$src) {
		592	0 <= aio_load $src->[$_], $data[$_]
		593	or Carp::croak "$src->[$_]: $!";
		594	}
		595
		596	# if processing is expensive, check
		597	# checksum first
		598	if (1) {
		599	$md5 =
		600	join "\x00",
		601	$processversion,
		602	map {
		603	cf::cede_to_tick;
		604	($src->[$_], Digest::MD5::md5_hex $data[$_])
		605	} 0.. $#$src;
		606
		607
		608	my $dbmd5 = db_get cache => "$id/md5";
		609	if ($dbmd5 eq $md5) {
		610	db_put cache => "$id/meta", $meta;
		611
		612	return db_get cache => "$id/data";
		613	}
		614	}
		615
		616	my $t1 = Time::HiRes::time;
		617	my $data = $process->(\@data);
		618	my $t2 = Time::HiRes::time;
		619
		620	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		621
		622	db_put cache => "$id/data", $data;
		623	db_put cache => "$id/md5" , $md5;
		624	db_put cache => "$id/meta", $meta;
		625
		626	return $data;
		627	}
		628
		629	db_get cache => "$id/data"
		630	}
		631
		632	=item cf::datalog type => key => value, ...
		633
		634	Log a datalog packet of the given type with the given key-value pairs.
		635
		636	=cut
		637
		638	sub datalog($@) {
		639	my ($type, %kv) = @_;
		640	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
371	}	641	}
372		642
373	=back	643	=back
374		644
375	=cut	645	=cut
…		…
382	attach callbacks/event handlers (a collection of which is called an "attachment")	652	attach callbacks/event handlers (a collection of which is called an "attachment")
383	to it. All such attachable objects support the following methods.	653	to it. All such attachable objects support the following methods.
384		654
385	In the following description, CLASS can be any of C<global>, C<object>	655	In the following description, CLASS can be any of C<global>, C<object>
386	C<player>, C<client> or C<map> (i.e. the attachable objects in	656	C<player>, C<client> or C<map> (i.e. the attachable objects in
387	crossfire+).	657	Crossfire TRT).
388		658
389	=over 4	659	=over 4
390		660
391	=item $attachable->attach ($attachment, key => $value...)	661	=item $attachable->attach ($attachment, key => $value...)
392		662
…		…
555	$registry = $CB_TYPE[$object_type] ||= [];	825	$registry = $CB_TYPE[$object_type] ||= [];
556		826
557	} elsif ($type eq "subtype") {	827	} elsif ($type eq "subtype") {
558	defined $object_type or Carp::croak "subtype specified without type";	828	defined $object_type or Carp::croak "subtype specified without type";
559	my $object_subtype = shift @arg;	829	my $object_subtype = shift @arg;
560	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	830	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
561		831
562	} elsif ($type eq "package") {	832	} elsif ($type eq "package") {
563	my $pkg = shift @arg;	833	my $pkg = shift @arg;
564		834
565	while (my ($name, $id) = each %cb_id) {	835	while (my ($name, $id) = each %cb_id) {
…		…
594	_attach $registry, $klass, @attach;	864	_attach $registry, $klass, @attach;
595	}	865	}
596		866
597	$obj->{$name} = \%arg;	867	$obj->{$name} = \%arg;
598	} else {	868	} else {
599	warn "object uses attachment '$name' that is not available, postponing.\n";	869	warn "object uses attachment '$name' which is not available, postponing.\n";
600	}	870	}
601		871
602	$obj->{_attachment}{$name} = undef;	872	$obj->{_attachment}{$name} = undef;
603	}	873	}
604		874
…		…
606	if (ref $_[0]) {	876	if (ref $_[0]) {
607	_object_attach @_;	877	_object_attach @_;
608	} else {	878	} else {
609	_attach shift->_attach_registry, @_;	879	_attach shift->_attach_registry, @_;
610	}	880	}
		881	_recalc_want;
611	};	882	};
612		883
613	# all those should be optimised	884	# all those should be optimised
614	sub cf::attachable::detach {	885	sub cf::attachable::detach {
615	my ($obj, $name) = @_;	886	my ($obj, $name) = @_;
…		…
618	delete $obj->{_attachment}{$name};	889	delete $obj->{_attachment}{$name};
619	reattach ($obj);	890	reattach ($obj);
620	} else {	891	} else {
621	Carp::croak "cannot, currently, detach class attachments";	892	Carp::croak "cannot, currently, detach class attachments";
622	}	893	}
		894	_recalc_want;
623	};	895	};
624		896
625	sub cf::attachable::attached {	897	sub cf::attachable::attached {
626	my ($obj, $name) = @_;	898	my ($obj, $name) = @_;
627		899
…		…
642	";	914	";
643	die if $@;	915	die if $@;
644	}	916	}
645		917
646	our $override;	918	our $override;
647	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	919	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
648		920
649	sub override {	921	sub override {
650	$override = 1;	922	$override = 1;
651	@invoke_results = ();	923	@INVOKE_RESULTS = (@_);
652	}	924	}
653		925
654	sub do_invoke {	926	sub do_invoke {
655	my $event = shift;	927	my $event = shift;
656	my $callbacks = shift;	928	my $callbacks = shift;
657		929
658	@invoke_results = ();	930	@INVOKE_RESULTS = ();
659		931
660	local $override;	932	local $override;
661		933
662	for (@$callbacks) {	934	for (@$callbacks) {
663	eval { &{$_->[1]} };	935	eval { &{$_->[1]} };
…		…
680		952
681	Generate an object-specific event with the given arguments.	953	Generate an object-specific event with the given arguments.
682		954
683	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	955	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
684	removed in future versions), and there is no public API to access override	956	removed in future versions), and there is no public API to access override
685	results (if you must, access C<@cf::invoke_results> directly).	957	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
686		958
687	=back	959	=back
688		960
689	=cut	961	=cut
690		962
691	#############################################################################	963	#############################################################################
692	# object support	964	# object support
		965	#
		966
		967	sub _can_merge {
		968	my ($ob1, $ob2) = @_;
		969
		970	local $Storable::canonical = 1;
		971	my $fob1 = Storable::freeze $ob1;
		972	my $fob2 = Storable::freeze $ob2;
		973
		974	$fob1 eq $fob2
		975	}
693		976
694	sub reattach {	977	sub reattach {
695	# basically do the same as instantiate, without calling instantiate	978	# basically do the same as instantiate, without calling instantiate
696	my ($obj) = @_;	979	my ($obj) = @_;
697		980
…		…
742	);	1025	);
743		1026
744	sub object_freezer_save {	1027	sub object_freezer_save {
745	my ($filename, $rdata, $objs) = @_;	1028	my ($filename, $rdata, $objs) = @_;
746		1029
		1030	my $guard = cf::lock_acquire "io";
		1031
747	sync_job {	1032	sync_job {
748	if (length $$rdata) {	1033	if (length $$rdata) {
		1034	utf8::decode (my $decname = $filename);
749	warn sprintf "saving %s (%d,%d)\n",	1035	warn sprintf "saving %s (%d,%d)\n",
750	$filename, length $$rdata, scalar @$objs;	1036	$decname, length $$rdata, scalar @$objs;
751		1037
752	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1038	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
753	chmod SAVE_MODE, $fh;	1039	chmod SAVE_MODE, $fh;
754	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1040	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
755	aio_fsync $fh;	1041	aio_fsync $fh if $cf::USE_FSYNC;
756	close $fh;	1042	close $fh;
757		1043
758	if (@$objs) {	1044	if (@$objs) {
759	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	1045	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
760	chmod SAVE_MODE, $fh;	1046	chmod SAVE_MODE, $fh;
761	my $data = Storable::nfreeze { version => 1, objs => $objs };	1047	my $data = Storable::nfreeze { version => 1, objs => $objs };
762	aio_write $fh, 0, (length $data), $data, 0;	1048	aio_write $fh, 0, (length $data), $data, 0;
763	aio_fsync $fh;	1049	aio_fsync $fh if $cf::USE_FSYNC;
764	close $fh;	1050	close $fh;
765	aio_rename "$filename.pst~", "$filename.pst";	1051	aio_rename "$filename.pst~", "$filename.pst";
766	}	1052	}
767	} else {	1053	} else {
768	aio_unlink "$filename.pst";	1054	aio_unlink "$filename.pst";
…		…
774	}	1060	}
775	} else {	1061	} else {
776	aio_unlink $filename;	1062	aio_unlink $filename;
777	aio_unlink "$filename.pst";	1063	aio_unlink "$filename.pst";
778	}	1064	}
779	}	1065	};
		1066
		1067	undef $guard;
780	}	1068	}
781		1069
782	sub object_freezer_as_string {	1070	sub object_freezer_as_string {
783	my ($rdata, $objs) = @_;	1071	my ($rdata, $objs) = @_;
784		1072
…		…
789		1077
790	sub object_thawer_load {	1078	sub object_thawer_load {
791	my ($filename) = @_;	1079	my ($filename) = @_;
792		1080
793	my ($data, $av);	1081	my ($data, $av);
		1082
		1083	my $guard = cf::lock_acquire "io";
794		1084
795	(aio_load $filename, $data) >= 0	1085	(aio_load $filename, $data) >= 0
796	or return;	1086	or return;
797		1087
798	unless (aio_stat "$filename.pst") {	1088	unless (aio_stat "$filename.pst") {
799	(aio_load "$filename.pst", $av) >= 0	1089	(aio_load "$filename.pst", $av) >= 0
800	or return;	1090	or return;
		1091
		1092	undef $guard;
801	$av = eval { (Storable::thaw $av)->{objs} };	1093	$av = eval { (Storable::thaw $av)->{objs} };
802	}	1094	}
803		1095
		1096	utf8::decode (my $decname = $filename);
804	warn sprintf "loading %s (%d)\n",	1097	warn sprintf "loading %s (%d,%d)\n",
805	$filename, length $data, scalar @{$av || []};#d#	1098	$decname, length $data, scalar @{$av || []};
		1099
806	return ($data, $av);	1100	($data, $av)
807	}	1101	}
		1102
		1103	=head2 COMMAND CALLBACKS
		1104
		1105	=over 4
		1106
		1107	=cut
808		1108
809	#############################################################################	1109	#############################################################################
810	# command handling &c	1110	# command handling &c
811		1111
812	=item cf::register_command $name => \&callback($ob,$args);	1112	=item cf::register_command $name => \&callback($ob,$args);
…		…
825	push @{ $COMMAND{$name} }, [$caller, $cb];	1125	push @{ $COMMAND{$name} }, [$caller, $cb];
826	}	1126	}
827		1127
828	=item cf::register_extcmd $name => \&callback($pl,$packet);	1128	=item cf::register_extcmd $name => \&callback($pl,$packet);
829		1129
830	Register a callbackf ro execution when the client sends an extcmd packet.	1130	Register a callback for execution when the client sends an (synchronous)
		1131	extcmd packet. Ext commands will be processed in the order they are
		1132	received by the server, like other user commands. The first argument is
		1133	the logged-in player. Ext commands can only be processed after a player
		1134	has logged in successfully.
831		1135
832	If the callback returns something, it is sent back as if reply was being	1136	If the callback returns something, it is sent back as if reply was being
833	called.	1137	called.
834		1138
		1139	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1140
		1141	Register a callback for execution when the client sends an (asynchronous)
		1142	exticmd packet. Exti commands are processed by the server as soon as they
		1143	are received, i.e. out of order w.r.t. other commands. The first argument
		1144	is a client socket. Exti commands can be received anytime, even before
		1145	log-in.
		1146
		1147	If the callback returns something, it is sent back as if reply was being
		1148	called.
		1149
835	=cut	1150	=cut
836		1151
837	sub register_extcmd {	1152	sub register_extcmd {
838	my ($name, $cb) = @_;	1153	my ($name, $cb) = @_;
839		1154
840	$EXTCMD{$name} = $cb;	1155	$EXTCMD{$name} = $cb;
		1156	}
		1157
		1158	sub register_exticmd {
		1159	my ($name, $cb) = @_;
		1160
		1161	$EXTICMD{$name} = $cb;
841	}	1162	}
842		1163
843	cf::player->attach (	1164	cf::player->attach (
844	on_command => sub {	1165	on_command => sub {
845	my ($pl, $name, $params) = @_;	1166	my ($pl, $name, $params) = @_;
…		…
854	cf::override;	1175	cf::override;
855	},	1176	},
856	on_extcmd => sub {	1177	on_extcmd => sub {
857	my ($pl, $buf) = @_;	1178	my ($pl, $buf) = @_;
858		1179
859	my $msg = eval { from_json $buf };	1180	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
860		1181
861	if (ref $msg) {	1182	if (ref $msg) {
		1183	my ($type, $reply, @payload) =
		1184	"ARRAY" eq ref $msg
		1185	? @$msg
		1186	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1187
		1188	my @reply;
		1189
862	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1190	if (my $cb = $EXTCMD{$type}) {
863	if (my %reply = $cb->($pl, $msg)) {	1191	@reply = $cb->($pl, @payload);
864	$pl->ext_reply ($msg->{msgid}, %reply);
865	}
866	}	1192	}
		1193
		1194	$pl->ext_reply ($reply, @reply)
		1195	if $reply;
		1196
867	} else {	1197	} else {
868	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1198	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
869	}	1199	}
870		1200
871	cf::override;	1201	cf::override;
872	},	1202	},
873	);	1203	);
874		1204
875	sub load_extension {
876	my ($path) = @_;
877
878	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
879	my $base = $1;
880	my $pkg = $1;
881	$pkg =~ s/[^[:word:]]/_/g;
882	$pkg = "ext::$pkg";
883
884	warn "... loading '$path' into '$pkg'\n";
885
886	open my $fh, "<:utf8", $path
887	or die "$path: $!";
888
889	my $source =
890	"package $pkg; use strict; use utf8;\n"
891	. "#line 1 \"$path\"\n{\n"
892	. (do { local $/; <$fh> })
893	. "\n};\n1";
894
895	unless (eval $source) {
896	my $msg = $@ ? "$path: $@\n"
897	: "extension disabled.\n";
898	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
899	warn $@;
900	warn "mandatory extension failed to load, exiting.\n";
901	exit 1;
902	}
903	die $@;
904	}
905
906	push @EXTS, $pkg;
907	}
908
909	sub load_extensions {	1205	sub load_extensions {
		1206	cf::sync_job {
		1207	my %todo;
		1208
910	for my $ext (<$LIBDIR/*.ext>) {	1209	for my $path (<$LIBDIR/*.ext>) {
911	next unless -r $ext;	1210	next unless -r $path;
912	eval {	1211
913	load_extension $ext;	1212	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1213	my $base = $1;
		1214	my $pkg = $1;
		1215	$pkg =~ s/[^[:word:]]/_/g;
		1216	$pkg = "ext::$pkg";
		1217
		1218	open my $fh, "<:utf8", $path
		1219	or die "$path: $!";
		1220
		1221	my $source = do { local $/; <$fh> };
		1222
		1223	my %ext = (
		1224	path => $path,
		1225	base => $base,
		1226	pkg => $pkg,
		1227	);
		1228
		1229	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1230	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1231
		1232	$ext{source} =
		1233	"package $pkg; use strict; use utf8;\n"
		1234	. "#line 1 \"$path\"\n{\n"
		1235	. $source
		1236	. "\n};\n1";
		1237
		1238	$todo{$base} = \%ext;
		1239	}
		1240
		1241	my %done;
		1242	while (%todo) {
		1243	my $progress;
		1244
		1245	while (my ($k, $v) = each %todo) {
		1246	for (split /,\s*/, $v->{meta}{depends}) {
		1247	goto skip
		1248	unless exists $done{$_};
		1249	}
		1250
		1251	warn "... loading '$k' into '$v->{pkg}'\n";
		1252
		1253	unless (eval $v->{source}) {
		1254	my $msg = $@ ? "$v->{path}: $@\n"
		1255	: "$v->{base}: extension inactive.\n";
		1256
		1257	if (exists $v->{meta}{mandatory}) {
		1258	warn $msg;
		1259	warn "mandatory extension failed to load, exiting.\n";
		1260	exit 1;
		1261	}
		1262
		1263	warn $msg;
		1264	}
		1265
		1266	$done{$k} = delete $todo{$k};
		1267	push @EXTS, $v->{pkg};
		1268	$progress = 1;
914	1	1269	}
915	} or warn "$ext not loaded: $@";	1270
		1271	skip:
		1272	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1273	unless $progress;
		1274	}
916	}	1275	};
917	}	1276	}
918		1277
919	#############################################################################	1278	#############################################################################
920		1279
		1280	=back
		1281
921	=head2 CORE EXTENSIONS	1282	=head2 CORE EXTENSIONS
922		1283
923	Functions and methods that extend core crossfire objects.	1284	Functions and methods that extend core crossfire objects.
924		1285
925	=cut	1286	=cut
…		…
930		1291
931	=head3 cf::player	1292	=head3 cf::player
932		1293
933	=over 4	1294	=over 4
934		1295
		1296	=item cf::player::num_playing
		1297
		1298	Returns the official number of playing players, as per the Crossfire metaserver rules.
		1299
		1300	=cut
		1301
		1302	sub num_playing {
		1303	scalar grep
		1304	$_->ob->map
		1305	&& !$_->hidden
		1306	&& !$_->ob->flag (cf::FLAG_WIZ),
		1307	cf::player::list
		1308	}
		1309
935	=item cf::player::find $login	1310	=item cf::player::find $login
936		1311
937	Returns the given player object, loading it if necessary (might block).	1312	Returns the given player object, loading it if necessary (might block).
938		1313
939	=cut	1314	=cut
940		1315
941	sub playerdir($) {	1316	sub playerdir($) {
942	cf::localdir	1317	"$PLAYERDIR/"
943	. "/"
944	. cf::playerdir
945	. "/"
946	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1318	. (ref $_[0] ? $_[0]->ob->name : $_[0])
947	}	1319	}
948		1320
949	sub path($) {	1321	sub path($) {
950	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1322	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
951		1323
952	(playerdir $login) . "/$login.pl"	1324	(playerdir $login) . "/playerdata"
953	}	1325	}
954		1326
955	sub find_active($) {	1327	sub find_active($) {
956	$cf::PLAYER{$_[0]}	1328	$cf::PLAYER{$_[0]}
957	and $cf::PLAYER{$_[0]}->active	1329	and $cf::PLAYER{$_[0]}->active
…		…
970	my $login = $_[0];	1342	my $login = $_[0];
971		1343
972	my $guard = cf::lock_acquire "user_find:$login";	1344	my $guard = cf::lock_acquire "user_find:$login";
973		1345
974	$cf::PLAYER{$_[0]} || do {	1346	$cf::PLAYER{$_[0]} || do {
975	my $pl = load_pl path $login	1347	# rename old playerfiles to new ones
		1348	#TODO: remove when no longer required
		1349	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1350	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1351	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1352	aio_unlink +(playerdir $login) . "/$login.pl";
		1353
		1354	my $f = new_from_file cf::object::thawer path $login
976	or return;	1355	or return;
		1356
		1357	$f->next;
		1358	my $pl = cf::player::load_pl $f
		1359	or return;
		1360	local $cf::PLAYER_LOADING{$login} = $pl;
		1361	$f->resolve_delayed_derefs;
977	$cf::PLAYER{$login} = $pl	1362	$cf::PLAYER{$login} = $pl
978	}	1363	}
979	}	1364	}
980	}	1365	}
981		1366
…		…
991		1376
992	aio_mkdir playerdir $pl, 0770;	1377	aio_mkdir playerdir $pl, 0770;
993	$pl->{last_save} = $cf::RUNTIME;	1378	$pl->{last_save} = $cf::RUNTIME;
994		1379
995	$pl->save_pl ($path);	1380	$pl->save_pl ($path);
996	Coro::cede;	1381	cf::cede_to_tick;
997	}	1382	}
998		1383
999	sub new($) {	1384	sub new($) {
1000	my ($login) = @_;	1385	my ($login) = @_;
1001		1386
…		…
1007	$cf::PLAYER{$login} = $self;	1392	$cf::PLAYER{$login} = $self;
1008		1393
1009	$self	1394	$self
1010	}	1395	}
1011		1396
		1397	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1398
		1399	=cut
		1400
		1401	sub send_msg {
		1402	my $ns = shift->ns
		1403	or return;
		1404	$ns->send_msg (@_);
		1405	}
		1406
1012	=item $pl->quit_character	1407	=item $pl->quit_character
1013		1408
1014	Nukes the player without looking back. If logged in, the connection will	1409	Nukes the player without looking back. If logged in, the connection will
1015	be destroyed. May block for a long time.	1410	be destroyed. May block for a long time.
1016		1411
1017	=cut	1412	=cut
1018		1413
1019	sub quit_character {	1414	sub quit_character {
1020	my ($pl) = @_;	1415	my ($pl) = @_;
		1416
		1417	my $name = $pl->ob->name;
1021		1418
1022	$pl->{deny_save} = 1;	1419	$pl->{deny_save} = 1;
1023	$pl->password ("*"); # this should lock out the player until we nuked the dir	1420	$pl->password ("*"); # this should lock out the player until we nuked the dir
1024		1421
1025	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1422	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1030	my $path = playerdir $pl;	1427	my $path = playerdir $pl;
1031	my $temp = "$path~$cf::RUNTIME~deleting~";	1428	my $temp = "$path~$cf::RUNTIME~deleting~";
1032	aio_rename $path, $temp;	1429	aio_rename $path, $temp;
1033	delete $cf::PLAYER{$pl->ob->name};	1430	delete $cf::PLAYER{$pl->ob->name};
1034	$pl->destroy;	1431	$pl->destroy;
		1432
		1433	my $prefix = qr<^~\Q$name\E/>;
		1434
		1435	# nuke player maps
		1436	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1437
1035	IO::AIO::aio_rmtree $temp;	1438	IO::AIO::aio_rmtree $temp;
		1439	}
		1440
		1441	=item $pl->kick
		1442
		1443	Kicks a player out of the game. This destroys the connection.
		1444
		1445	=cut
		1446
		1447	sub kick {
		1448	my ($pl, $kicker) = @_;
		1449
		1450	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1451	$pl->killer ("kicked");
		1452	$pl->ns->destroy;
1036	}	1453	}
1037		1454
1038	=item cf::player::list_logins	1455	=item cf::player::list_logins
1039		1456
1040	Returns am arrayref of all valid playernames in the system, can take a	1457	Returns am arrayref of all valid playernames in the system, can take a
1041	while and may block, so not sync_job-capable, ever.	1458	while and may block, so not sync_job-capable, ever.
1042		1459
1043	=cut	1460	=cut
1044		1461
1045	sub list_logins {	1462	sub list_logins {
1046	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1463	my $dirs = aio_readdir $PLAYERDIR
1047	or return [];	1464	or return [];
1048		1465
1049	my @logins;	1466	my @logins;
1050		1467
1051	for my $login (@$dirs) {	1468	for my $login (@$dirs) {
		1469	my $path = path $login;
		1470
		1471	# a .pst is a dead give-away for a valid player
		1472	unless (-e "$path.pst") {
1052	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1473	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1053	aio_read $fh, 0, 512, my $buf, 0 or next;	1474	aio_read $fh, 0, 512, my $buf, 0 or next;
1054	$buf !~ /^password -------------$/m or next; # official not-valid tag	1475	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1476	}
1055		1477
1056	utf8::decode $login;	1478	utf8::decode $login;
1057	push @logins, $login;	1479	push @logins, $login;
1058	}	1480	}
1059		1481
…		…
1067		1489
1068	=cut	1490	=cut
1069		1491
1070	sub maps($) {	1492	sub maps($) {
1071	my ($pl) = @_;	1493	my ($pl) = @_;
		1494
		1495	$pl = ref $pl ? $pl->ob->name : $pl;
1072		1496
1073	my $files = aio_readdir playerdir $pl	1497	my $files = aio_readdir playerdir $pl
1074	or return;	1498	or return;
1075		1499
1076	my @paths;	1500	my @paths;
…		…
1078	for (@$files) {	1502	for (@$files) {
1079	utf8::decode $_;	1503	utf8::decode $_;
1080	next if /\.(?:pl|pst)$/;	1504	next if /\.(?:pl|pst)$/;
1081	next unless /^$PATH_SEP/o;	1505	next unless /^$PATH_SEP/o;
1082		1506
1083	s/\.map$//;	1507	push @paths, cf::map::normalise "~$pl/$_";
1084	push @paths, "~" . $pl->ob->name . "/" . $_;
1085	}	1508	}
1086		1509
1087	\@paths	1510	\@paths
1088	}	1511	}
1089		1512
		1513	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1514
		1515	Expand crossfire pod fragments into protocol xml.
		1516
		1517	=cut
		1518
		1519	sub expand_cfpod {
		1520	((my $self), (local $_)) = @_;
		1521
		1522	# escape & and <
		1523	s/&/&amp;/g;
		1524	s/(?<![BIUGHT])</&lt;/g;
		1525
		1526	# this is buggy, it needs to properly take care of nested <'s
		1527
		1528	1 while
		1529	# replace B<>, I<>, U<> etc.
		1530	s/B<([^\>]*)>/<b>$1<\/b>/
		1531	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1532	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1533	|| s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
		1534	# replace G<male|female> tags
		1535	|| s{G<([^>|]*)\|([^>]*)>}{
		1536	$self->gender ? $2 : $1
		1537	}ge
		1538	# replace H<hint text>
		1539	|| s{H<([^\>]*)>}
		1540	{
		1541	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1542	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1543	"")
		1544	[$self->{hintmode}]
		1545	}ge;
		1546
		1547	# create single paragraphs (very hackish)
		1548	s/(?<=\S)\n(?=\w)/ /g;
		1549
		1550	# compress some whitespace
		1551	s/\s+\n/\n/g; # ws line-ends
		1552	s/\n\n+/\n/g; # double lines
		1553	s/^\n+//; # beginning lines
		1554	s/\n+$//; # ending lines
		1555
		1556	$_
		1557	}
		1558
		1559	sub hintmode {
		1560	$_[0]{hintmode} = $_[1] if @_ > 1;
		1561	$_[0]{hintmode}
		1562	}
		1563
1090	=item $player->ext_reply ($msgid, $msgtype, %msg)	1564	=item $player->ext_reply ($msgid, @msg)
1091		1565
1092	Sends an ext reply to the player.	1566	Sends an ext reply to the player.
1093		1567
1094	=cut	1568	=cut
1095		1569
1096	sub ext_reply($$$%) {	1570	sub ext_reply($$@) {
1097	my ($self, $id, %msg) = @_;	1571	my ($self, $id, @msg) = @_;
1098		1572
1099	$msg{msgid} = $id;	1573	$self->ns->ext_reply ($id, @msg)
1100
1101	$self->send ("ext " . cf::to_json \%msg);
1102	}	1574	}
1103		1575
1104	package cf;	1576	=item $player->ext_msg ($type, @msg)
		1577
		1578	Sends an ext event to the client.
		1579
		1580	=cut
		1581
		1582	sub ext_msg($$@) {
		1583	my ($self, $type, @msg) = @_;
		1584
		1585	$self->ns->ext_msg ($type, @msg);
		1586	}
		1587
		1588	=head3 cf::region
		1589
		1590	=over 4
		1591
		1592	=cut
		1593
		1594	package cf::region;
		1595
		1596	=item cf::region::find_by_path $path
		1597
		1598	Tries to decuce the likely region for a map knowing only its path.
		1599
		1600	=cut
		1601
		1602	sub find_by_path($) {
		1603	my ($path) = @_;
		1604
		1605	my ($match, $specificity);
		1606
		1607	for my $region (list) {
		1608	if ($region->{match} && $path =~ $region->{match}) {
		1609	($match, $specificity) = ($region, $region->specificity)
		1610	if $region->specificity > $specificity;
		1611	}
		1612	}
		1613
		1614	$match
		1615	}
1105		1616
1106	=back	1617	=back
1107
1108		1618
1109	=head3 cf::map	1619	=head3 cf::map
1110		1620
1111	=over 4	1621	=over 4
1112		1622
…		…
1140	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1650	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1141	(cf::region::find $rmp->{region}), $rmp->{custom}	1651	(cf::region::find $rmp->{region}), $rmp->{custom}
1142	)	1652	)
1143	}	1653	}
1144		1654
		1655	=item cf::map->register ($regex, $prio)
		1656
		1657	Register a handler for the map path matching the given regex at the
		1658	givne priority (higher is better, built-in handlers have priority 0, the
		1659	default).
		1660
		1661	=cut
		1662
1145	sub register {	1663	sub register {
1146	my (undef, $regex) = @_;	1664	my (undef, $regex, $prio) = @_;
1147	my $pkg = caller;	1665	my $pkg = caller;
1148		1666
1149	no strict;	1667	no strict;
1150	push @{"$pkg\::ISA"}, __PACKAGE__;	1668	push @{"$pkg\::ISA"}, __PACKAGE__;
1151		1669
1152	$EXT_MAP{$pkg} = qr<$regex>;	1670	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
1153	}	1671	}
1154		1672
1155	# also paths starting with '/'	1673	# also paths starting with '/'
1156	$EXT_MAP{"cf::map"} = qr{^(?=/)};	1674	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1157		1675
1158	sub thawer_merge {	1676	sub thawer_merge {
1159	my ($self, $merge) = @_;	1677	my ($self, $merge) = @_;
1160		1678
1161	# we have to keep some variables in memory intact	1679	# we have to keep some variables in memory intact
1162	local $self->{path};	1680	local $self->{path};
1163	local $self->{load_path};	1681	local $self->{load_path};
1164	local $self->{deny_save};
1165	local $self->{deny_reset};
1166		1682
1167	$self->SUPER::thawer_merge ($merge);	1683	$self->SUPER::thawer_merge ($merge);
1168	}	1684	}
1169		1685
1170	sub normalise {	1686	sub normalise {
1171	my ($path, $base) = @_;	1687	my ($path, $base) = @_;
		1688
		1689	$path = "$path"; # make sure its a string
		1690
		1691	$path =~ s/\.map$//;
1172		1692
1173	# map plan:	1693	# map plan:
1174	#	1694	#
1175	# /! non-realised random map exit (special hack!)	1695	# /! non-realised random map exit (special hack!)
1176	# {... are special paths that are not being touched	1696	# {... are special paths that are not being touched
…		…
1204		1724
1205	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object	1725	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1206		1726
1207	$path = normalise $path, $base;	1727	$path = normalise $path, $base;
1208		1728
1209	for my $pkg (keys %EXT_MAP) {	1729	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1210	if ($path =~ $EXT_MAP{$pkg}) {	1730	if ($path =~ $EXT_MAP{$pkg}[1]) {
1211	my $self = bless cf::map::new, $pkg;	1731	my $self = bless cf::map::new, $pkg;
1212	$self->{path} = $path; $self->path ($path);	1732	$self->{path} = $path; $self->path ($path);
1213	$self->init; # pass $1 etc.	1733	$self->init; # pass $1 etc.
1214	return $self;	1734	return $self;
1215	}	1735	}
1216	}	1736	}
1217		1737
1218	Carp::carp "unable to resolve path '$path'.";	1738	Carp::cluck "unable to resolve path '$path' (base '$base').";
1219	()	1739	()
1220	}	1740	}
1221		1741
1222	sub init {	1742	sub init {
1223	my ($self) = @_;	1743	my ($self) = @_;
…		…
1238		1758
1239	# the original (read-only) location	1759	# the original (read-only) location
1240	sub load_path {	1760	sub load_path {
1241	my ($self) = @_;	1761	my ($self) = @_;
1242		1762
1243	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1763	"$MAPDIR/$self->{path}.map"
1244	}	1764	}
1245		1765
1246	# the temporary/swap location	1766	# the temporary/swap location
1247	sub save_path {	1767	sub save_path {
1248	my ($self) = @_;	1768	my ($self) = @_;
1249		1769
1250	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1770	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1251	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	1771	"$TMPDIR/$path.map"
1252	}	1772	}
1253		1773
1254	# the unique path, undef == no special unique path	1774	# the unique path, undef == no special unique path
1255	sub uniq_path {	1775	sub uniq_path {
1256	my ($self) = @_;	1776	my ($self) = @_;
1257		1777
1258	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1778	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1259	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1779	"$UNIQUEDIR/$path"
1260	}	1780	}
1261		1781
1262	# and all this just because we cannot iterate over	1782	# and all this just because we cannot iterate over
1263	# all maps in C++...	1783	# all maps in C++...
1264	sub change_all_map_light {	1784	sub change_all_map_light {
…		…
1266		1786
1267	$_->change_map_light ($change)	1787	$_->change_map_light ($change)
1268	for grep $_->outdoor, values %cf::MAP;	1788	for grep $_->outdoor, values %cf::MAP;
1269	}	1789	}
1270		1790
		1791	sub decay_objects {
		1792	my ($self) = @_;
		1793
		1794	return if $self->{deny_reset};
		1795
		1796	$self->do_decay_objects;
		1797	}
		1798
1271	sub unlink_save {	1799	sub unlink_save {
1272	my ($self) = @_;	1800	my ($self) = @_;
1273		1801
1274	utf8::encode (my $save = $self->save_path);	1802	utf8::encode (my $save = $self->save_path);
1275	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1803	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
…		…
1278		1806
1279	sub load_header_from($) {	1807	sub load_header_from($) {
1280	my ($self, $path) = @_;	1808	my ($self, $path) = @_;
1281		1809
1282	utf8::encode $path;	1810	utf8::encode $path;
1283	aio_open $path, O_RDONLY, 0	1811	my $f = new_from_file cf::object::thawer $path
1284	or return;	1812	or return;
1285		1813
1286	$self->_load_header ($path)	1814	$self->_load_header ($f)
1287	or return;	1815	or return;
1288		1816
		1817	local $MAP_LOADING{$self->{path}} = $self;
		1818	$f->resolve_delayed_derefs;
		1819
1289	$self->{load_path} = $path;	1820	$self->{load_path} = $path;
1290		1821
1291	1	1822	1
1292	}	1823	}
1293		1824
1294	sub load_orig {	1825	sub load_header_orig {
1295	my ($self) = @_;	1826	my ($self) = @_;
1296		1827
1297	$self->load_header_from ($self->load_path)	1828	$self->load_header_from ($self->load_path)
1298	}	1829	}
1299		1830
1300	sub load_temp {	1831	sub load_header_temp {
1301	my ($self) = @_;	1832	my ($self) = @_;
1302		1833
1303	$self->load_header_from ($self->save_path)	1834	$self->load_header_from ($self->save_path)
		1835	}
		1836
		1837	sub prepare_temp {
		1838	my ($self) = @_;
		1839
		1840	$self->last_access ((delete $self->{last_access})
		1841	|| $cf::RUNTIME); #d#
		1842	# safety
		1843	$self->{instantiate_time} = $cf::RUNTIME
		1844	if $self->{instantiate_time} > $cf::RUNTIME;
		1845	}
		1846
		1847	sub prepare_orig {
		1848	my ($self) = @_;
		1849
		1850	$self->{load_original} = 1;
		1851	$self->{instantiate_time} = $cf::RUNTIME;
		1852	$self->last_access ($cf::RUNTIME);
		1853	$self->instantiate;
1304	}	1854	}
1305		1855
1306	sub load_header {	1856	sub load_header {
1307	my ($self) = @_;	1857	my ($self) = @_;
1308		1858
1309	if ($self->load_temp) {	1859	if ($self->load_header_temp) {
1310	$self->last_access ((delete $self->{last_access})	1860	$self->prepare_temp;
1311	|| $cf::RUNTIME); #d#
1312	# safety
1313	$self->{instantiate_time} = $cf::RUNTIME
1314	if $self->{instantiate_time} > $cf::RUNTIME;
1315	} else {	1861	} else {
1316	$self->load_orig	1862	$self->load_header_orig
1317	or return;	1863	or return;
1318		1864	$self->prepare_orig;
1319	$self->{load_original} = 1;
1320	$self->{instantiate_time} = $cf::RUNTIME;
1321	$self->last_access ($cf::RUNTIME);
1322	$self->instantiate;
1323	}	1865	}
		1866
		1867	$self->{deny_reset} = 1
		1868	if $self->no_reset;
		1869
		1870	$self->default_region (cf::region::find_by_path $self->{path})
		1871	unless $self->default_region;
1324		1872
1325	1	1873	1
1326	}	1874	}
1327		1875
1328	sub find;	1876	sub find;
1329	sub find {	1877	sub find {
1330	my ($path, $origin) = @_;	1878	my ($path, $origin) = @_;
1331		1879
1332	$path = normalise $path, $origin && $origin->path;	1880	$path = normalise $path, $origin && $origin->path;
1333		1881
		1882	cf::lock_wait "map_data:$path";#d#remove
1334	cf::lock_wait "map_find:$path";	1883	cf::lock_wait "map_find:$path";
1335		1884
1336	$cf::MAP{$path} || do {	1885	$cf::MAP{$path} || do {
1337	my $guard = cf::lock_acquire "map_find:$path";	1886	my $guard1 = cf::lock_acquire "map_find:$path";
		1887	my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
		1888
1338	my $map = new_from_path cf::map $path	1889	my $map = new_from_path cf::map $path
1339	or return;	1890	or return;
1340		1891
1341	$map->{last_save} = $cf::RUNTIME;	1892	$map->{last_save} = $cf::RUNTIME;
1342		1893
1343	$map->load_header	1894	$map->load_header
1344	or return;	1895	or return;
1345		1896
1346	if ($map->should_reset) {	1897	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1347	# doing this can freeze the server in a sync job, obviously	1898	# doing this can freeze the server in a sync job, obviously
1348	#$cf::WAIT_FOR_TICK->wait;	1899	#$cf::WAIT_FOR_TICK->wait;
		1900	undef $guard1;
		1901	undef $guard2;
1349	$map->reset;	1902	$map->reset;
1350	undef $guard;
1351	$map = find $path	1903	return find $path;
1352	or return;
1353	}	1904	}
1354		1905
1355	$cf::MAP{$path} = $map	1906	$cf::MAP{$path} = $map
1356	}	1907	}
1357	}	1908	}
		1909
		1910	sub pre_load { }
		1911	sub post_load { }
1358		1912
1359	sub load {	1913	sub load {
1360	my ($self) = @_;	1914	my ($self) = @_;
1361		1915
		1916	local $self->{deny_reset} = 1; # loading can take a long time
		1917
1362	my $path = $self->{path};	1918	my $path = $self->{path};
		1919
		1920	{
1363	my $guard = cf::lock_acquire "map_load:$path";	1921	my $guard = cf::lock_acquire "map_data:$path";
1364		1922
		1923	return unless $self->valid;
1365	return if $self->in_memory != cf::MAP_SWAPPED;	1924	return unless $self->in_memory == cf::MAP_SWAPPED;
1366		1925
1367	$self->in_memory (cf::MAP_LOADING);	1926	$self->in_memory (cf::MAP_LOADING);
1368		1927
1369	$self->alloc;	1928	$self->alloc;
1370	$self->_load_objects ($self->{load_path}, 1)	1929
		1930	$self->pre_load;
		1931	cf::cede_to_tick;
		1932
		1933	my $f = new_from_file cf::object::thawer $self->{load_path};
		1934	$f->skip_block;
		1935	$self->_load_objects ($f)
1371	or return;	1936	or return;
1372		1937
1373	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1938	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1374	if delete $self->{load_original};	1939	if delete $self->{load_original};
1375		1940
1376	if (my $uniq = $self->uniq_path) {	1941	if (my $uniq = $self->uniq_path) {
1377	utf8::encode $uniq;	1942	utf8::encode $uniq;
1378	if (aio_open $uniq, O_RDONLY, 0) {	1943	unless (aio_stat $uniq) {
		1944	if (my $f = new_from_file cf::object::thawer $uniq) {
1379	$self->clear_unique_items;	1945	$self->clear_unique_items;
1380	$self->_load_objects ($uniq, 0);	1946	$self->_load_objects ($f);
		1947	$f->resolve_delayed_derefs;
		1948	}
1381	}	1949	}
1382	}	1950	}
1383		1951
1384	Coro::cede;	1952	$f->resolve_delayed_derefs;
1385		1953
		1954	cf::cede_to_tick;
1386	# now do the right thing for maps	1955	# now do the right thing for maps
1387	$self->link_multipart_objects;	1956	$self->link_multipart_objects;
1388
1389	unless ($self->{deny_activate}) {
1390	$self->decay_objects;
1391	$self->fix_auto_apply;
1392	$self->update_buttons;
1393	Coro::cede;
1394	$self->set_darkness_map;
1395	$self->difficulty ($self->estimate_difficulty)	1957	$self->difficulty ($self->estimate_difficulty)
1396	unless $self->difficulty;	1958	unless $self->difficulty;
1397	Coro::cede;	1959	cf::cede_to_tick;
		1960
		1961	unless ($self->{deny_activate}) {
		1962	$self->decay_objects;
		1963	$self->fix_auto_apply;
		1964	$self->update_buttons;
		1965	cf::cede_to_tick;
		1966	$self->set_darkness_map;
		1967	cf::cede_to_tick;
1398	$self->activate;	1968	$self->activate;
1399	}	1969	}
1400		1970
		1971	$self->{last_save} = $cf::RUNTIME;
		1972	$self->last_access ($cf::RUNTIME);
		1973
1401	$self->in_memory (cf::MAP_IN_MEMORY);	1974	$self->in_memory (cf::MAP_IN_MEMORY);
		1975	}
		1976
		1977	$self->post_load;
1402	}	1978	}
1403		1979
1404	sub customise_for {	1980	sub customise_for {
1405	my ($self, $ob) = @_;	1981	my ($self, $ob) = @_;
1406		1982
1407	return find "~" . $ob->name . "/" . $self->{path}	1983	return find "~" . $ob->name . "/" . $self->{path}
1408	if $self->per_player;	1984	if $self->per_player;
1409		1985
		1986	# return find "?party/" . $ob->name . "/" . $self->{path}
		1987	# if $self->per_party;
		1988
1410	$self	1989	$self
1411	}	1990	}
1412		1991
1413	# find and load all maps in the 3x3 area around a map	1992	# find and load all maps in the 3x3 area around a map
1414	sub load_diag {	1993	sub load_neighbours {
1415	my ($map) = @_;	1994	my ($map) = @_;
1416		1995
1417	my @diag; # diagonal neighbours	1996	my @neigh; # diagonal neighbours
1418		1997
1419	for (0 .. 3) {	1998	for (0 .. 3) {
1420	my $neigh = $map->tile_path ($_)	1999	my $neigh = $map->tile_path ($_)
1421	or next;	2000	or next;
1422	$neigh = find $neigh, $map	2001	$neigh = find $neigh, $map
1423	or next;	2002	or next;
1424	$neigh->load;	2003	$neigh->load;
1425		2004
		2005	push @neigh,
1426	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2006	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1427	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2007	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1428	}	2008	}
1429		2009
1430	for (@diag) {	2010	for (grep defined $_->[0], @neigh) {
		2011	my ($path, $origin) = @$_;
1431	my $neigh = find @$_	2012	my $neigh = find $path, $origin
1432	or next;	2013	or next;
1433	$neigh->load;	2014	$neigh->load;
1434	}	2015	}
1435	}	2016	}
1436		2017
…		…
1441	}	2022	}
1442		2023
1443	sub do_load_sync {	2024	sub do_load_sync {
1444	my ($map) = @_;	2025	my ($map) = @_;
1445		2026
		2027	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2028	if $Coro::current == $Coro::main;
		2029
1446	cf::sync_job { $map->load };	2030	cf::sync_job { $map->load };
1447	}	2031	}
1448		2032
1449	our %MAP_PREFETCH;	2033	our %MAP_PREFETCH;
1450	our $MAP_PREFETCHER = undef;	2034	our $MAP_PREFETCHER = undef;
1451		2035
1452	sub find_async {	2036	sub find_async {
1453	my ($path, $origin) = @_;	2037	my ($path, $origin, $load) = @_;
1454		2038
1455	$path = normalise $path, $origin && $origin->{path};	2039	$path = normalise $path, $origin && $origin->{path};
1456		2040
1457	if (my $map = $cf::MAP{$path}) {	2041	if (my $map = $cf::MAP{$path}) {
1458	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2042	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1459	}	2043	}
1460		2044
1461	undef $MAP_PREFETCH{$path};	2045	$MAP_PREFETCH{$path} |= $load;
		2046
1462	$MAP_PREFETCHER ||= cf::async {	2047	$MAP_PREFETCHER ||= cf::async {
1463	while (%MAP_PREFETCH) {	2048	while (%MAP_PREFETCH) {
1464	for my $path (keys %MAP_PREFETCH) {	2049	while (my ($k, $v) = each %MAP_PREFETCH) {
1465	my $map = find $path	2050	if (my $map = find $k) {
1466	or next;
1467	$map->load;	2051	$map->load if $v;
		2052	}
1468		2053
1469	delete $MAP_PREFETCH{$path};	2054	delete $MAP_PREFETCH{$k};
1470	}	2055	}
1471	}	2056	}
1472	undef $MAP_PREFETCHER;	2057	undef $MAP_PREFETCHER;
1473	};	2058	};
		2059	$MAP_PREFETCHER->prio (6);
1474		2060
1475	()	2061	()
1476	}	2062	}
1477		2063
1478	sub save {	2064	sub save {
1479	my ($self) = @_;	2065	my ($self) = @_;
1480		2066
1481	my $lock = cf::lock_acquire "map_data:" . $self->path;	2067	my $lock = cf::lock_acquire "map_data:$self->{path}";
1482		2068
1483	$self->{last_save} = $cf::RUNTIME;	2069	$self->{last_save} = $cf::RUNTIME;
1484		2070
1485	return unless $self->dirty;	2071	return unless $self->dirty;
1486		2072
…		…
1509	my ($self) = @_;	2095	my ($self) = @_;
1510		2096
1511	# save first because save cedes	2097	# save first because save cedes
1512	$self->save;	2098	$self->save;
1513		2099
1514	my $lock = cf::lock_acquire "map_data:" . $self->path;	2100	my $lock = cf::lock_acquire "map_data:$self->{path}";
1515		2101
1516	return if $self->players;	2102	return if $self->players;
1517	return if $self->in_memory != cf::MAP_IN_MEMORY;	2103	return if $self->in_memory != cf::MAP_IN_MEMORY;
1518	return if $self->{deny_save};	2104	return if $self->{deny_save};
1519		2105
		2106	$self->in_memory (cf::MAP_SWAPPED);
		2107
		2108	$self->deactivate;
		2109	$_->clear_links_to ($self) for values %cf::MAP;
1520	$self->clear;	2110	$self->clear;
1521	$self->in_memory (cf::MAP_SWAPPED);
1522	}	2111	}
1523		2112
1524	sub reset_at {	2113	sub reset_at {
1525	my ($self) = @_;	2114	my ($self) = @_;
1526		2115
1527	# TODO: safety, remove and allow resettable per-player maps	2116	# TODO: safety, remove and allow resettable per-player maps
1528	return 1e99 if $self->isa ("ext::map_per_player");#d#
1529	return 1e99 if $self->{deny_reset};	2117	return 1e99 if $self->{deny_reset};
1530		2118
1531	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2119	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1532	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2120	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1533		2121
…		…
1544	my ($self) = @_;	2132	my ($self) = @_;
1545		2133
1546	my $lock = cf::lock_acquire "map_data:$self->{path}";	2134	my $lock = cf::lock_acquire "map_data:$self->{path}";
1547		2135
1548	return if $self->players;	2136	return if $self->players;
1549	return if $self->isa ("ext::map_per_player");#d#
1550		2137
1551	warn "resetting map ", $self->path;#d#	2138	warn "resetting map ", $self->path;
		2139
		2140	$self->in_memory (cf::MAP_SWAPPED);
		2141
		2142	# need to save uniques path
		2143	unless ($self->{deny_save}) {
		2144	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2145
		2146	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2147	if $uniq;
		2148	}
1552		2149
1553	delete $cf::MAP{$self->path};	2150	delete $cf::MAP{$self->path};
1554		2151
1555	$self->in_memory (cf::MAP_SWAPPED);	2152	$self->deactivate;
		2153	$_->clear_links_to ($self) for values %cf::MAP;
1556	$self->clear;	2154	$self->clear;
1557
1558	$_->clear_links_to ($self) for values %cf::MAP;
1559		2155
1560	$self->unlink_save;	2156	$self->unlink_save;
1561	$self->destroy;	2157	$self->destroy;
1562	}	2158	}
1563		2159
1564	my $nuke_counter = "aaaa";	2160	my $nuke_counter = "aaaa";
1565		2161
1566	sub nuke {	2162	sub nuke {
1567	my ($self) = @_;	2163	my ($self) = @_;
1568		2164
		2165	{
		2166	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2167
1569	delete $cf::MAP{$self->path};	2168	delete $cf::MAP{$self->path};
1570		2169
1571	$self->unlink_save;	2170	$self->unlink_save;
1572		2171
1573	bless $self, "cf::map";	2172	bless $self, "cf::map";
1574	delete $self->{deny_reset};	2173	delete $self->{deny_reset};
1575	$self->{deny_save} = 1;	2174	$self->{deny_save} = 1;
1576	$self->reset_timeout (1);	2175	$self->reset_timeout (1);
1577	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2176	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1578		2177
1579	$cf::MAP{$self->path} = $self;	2178	$cf::MAP{$self->path} = $self;
		2179	}
1580		2180
1581	$self->reset; # polite request, might not happen	2181	$self->reset; # polite request, might not happen
		2182	}
		2183
		2184	=item $maps = cf::map::tmp_maps
		2185
		2186	Returns an arrayref with all map paths of currently instantiated and saved
		2187	maps. May block.
		2188
		2189	=cut
		2190
		2191	sub tmp_maps() {
		2192	[
		2193	map {
		2194	utf8::decode $_;
		2195	/\.map$/
		2196	? normalise $_
		2197	: ()
		2198	} @{ aio_readdir $TMPDIR or [] }
		2199	]
		2200	}
		2201
		2202	=item $maps = cf::map::random_maps
		2203
		2204	Returns an arrayref with all map paths of currently instantiated and saved
		2205	random maps. May block.
		2206
		2207	=cut
		2208
		2209	sub random_maps() {
		2210	[
		2211	map {
		2212	utf8::decode $_;
		2213	/\.map$/
		2214	? normalise "?random/$_"
		2215	: ()
		2216	} @{ aio_readdir $RANDOMDIR or [] }
		2217	]
1582	}	2218	}
1583		2219
1584	=item cf::map::unique_maps	2220	=item cf::map::unique_maps
1585		2221
1586	Returns an arrayref of paths of all shared maps that have	2222	Returns an arrayref of paths of all shared maps that have
1587	instantiated unique items. May block.	2223	instantiated unique items. May block.
1588		2224
1589	=cut	2225	=cut
1590		2226
1591	sub unique_maps() {	2227	sub unique_maps() {
1592	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2228	[
1593	or return;	2229	map {
1594
1595	my @paths;
1596
1597	for (@$files) {
1598	utf8::decode $_;	2230	utf8::decode $_;
1599	next if /\.pst$/;
1600	next unless /^$PATH_SEP/o;
1601
1602	s/\.map$//;	2231	/\.map$/
1603	push @paths, $_;	2232	? normalise $_
		2233	: ()
		2234	} @{ aio_readdir $UNIQUEDIR or [] }
1604	}	2235	]
1605
1606	\@paths
1607	}	2236	}
1608		2237
1609	package cf;	2238	package cf;
1610		2239
1611	=back	2240	=back
…		…
1629	map { $_, inv_recursive_ $_->inv } @_	2258	map { $_, inv_recursive_ $_->inv } @_
1630	}	2259	}
1631		2260
1632	sub inv_recursive {	2261	sub inv_recursive {
1633	inv_recursive_ inv $_[0]	2262	inv_recursive_ inv $_[0]
		2263	}
		2264
		2265	=item $ref = $ob->ref
		2266
		2267	creates and returns a persistent reference to an objetc that can be stored as a string.
		2268
		2269	=item $ob = cf::object::deref ($refstring)
		2270
		2271	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2272	even if the object actually exists. May block.
		2273
		2274	=cut
		2275
		2276	sub deref {
		2277	my ($ref) = @_;
		2278
		2279	# temporary compatibility#TODO#remove
		2280	$ref =~ s{^<}{player/<};
		2281
		2282	if ($ref =~ m{^player\/(<1\.\d+>)/(.*)$}) {
		2283	my ($uuid, $name) = ($1, $2);
		2284	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2285	or return;
		2286	$pl->ob->uuid eq $uuid
		2287	or return;
		2288
		2289	$pl->ob
		2290	} else {
		2291	warn "$ref: cannot resolve object reference\n";
		2292	undef
		2293	}
1634	}	2294	}
1635		2295
1636	package cf;	2296	package cf;
1637		2297
1638	=back	2298	=back
…		…
1657		2317
1658	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2318	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1659		2319
1660	if ($self->{record_replies}) {	2320	if ($self->{record_replies}) {
1661	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2321	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2322
1662	} else {	2323	} else {
		2324	my $pl = $self->contr;
		2325
		2326	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2327	my $dialog = $pl->{npc_dialog};
		2328	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2329
		2330	} else {
1663	$msg = $npc->name . " says: $msg" if $npc;	2331	$msg = $npc->name . " says: $msg" if $npc;
1664	$self->message ($msg, $flags);	2332	$self->message ($msg, $flags);
		2333	}
1665	}	2334	}
		2335	}
		2336
		2337	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2338
		2339	=cut
		2340
		2341	sub cf::object::send_msg {
		2342	my $pl = shift->contr
		2343	or return;
		2344	$pl->send_msg (@_);
1666	}	2345	}
1667		2346
1668	=item $player_object->may ("access")	2347	=item $player_object->may ("access")
1669		2348
1670	Returns wether the given player is authorized to access resource "access"	2349	Returns wether the given player is authorized to access resource "access"
…		…
1702	=cut	2381	=cut
1703		2382
1704	sub link_map {	2383	sub link_map {
1705	unless ($LINK_MAP) {	2384	unless ($LINK_MAP) {
1706	$LINK_MAP = cf::map::find "{link}"	2385	$LINK_MAP = cf::map::find "{link}"
1707	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };	2386	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1708	$LINK_MAP->load;	2387	$LINK_MAP->load;
1709	}	2388	}
1710		2389
1711	$LINK_MAP	2390	$LINK_MAP
1712	}	2391	}
…		…
1717	$self->deactivate_recursive;	2396	$self->deactivate_recursive;
1718		2397
1719	return if UNIVERSAL::isa $self->map, "ext::map_link";	2398	return if UNIVERSAL::isa $self->map, "ext::map_link";
1720		2399
1721	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2400	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1722	if $self->map;	2401	if $self->map && $self->map->{path} ne "{link}";
1723		2402
1724	$self->enter_map ($LINK_MAP || link_map, 20, 20);	2403	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1725	}	2404	}
1726		2405
1727	sub cf::object::player::leave_link {	2406	sub cf::object::player::leave_link {
1728	my ($self, $map, $x, $y) = @_;	2407	my ($self, $map, $x, $y) = @_;
		2408
		2409	return unless $self->contr->active;
1729		2410
1730	my $link_pos = delete $self->{_link_pos};	2411	my $link_pos = delete $self->{_link_pos};
1731		2412
1732	unless ($map) {	2413	unless ($map) {
1733	# restore original map position	2414	# restore original map position
…		…
1747	# use -1 or undef as default coordinates, not 0, 0	2428	# use -1 or undef as default coordinates, not 0, 0
1748	($x, $y) = ($map->enter_x, $map->enter_y)	2429	($x, $y) = ($map->enter_x, $map->enter_y)
1749	if $x <=0 && $y <= 0;	2430	if $x <=0 && $y <= 0;
1750		2431
1751	$map->load;	2432	$map->load;
1752	$map->load_diag;	2433	$map->load_neighbours;
1753		2434
1754	return unless $self->contr->active;	2435	return unless $self->contr->active;
1755	$self->activate_recursive;	2436	$self->activate_recursive;
		2437
		2438	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1756	$self->enter_map ($map, $x, $y);	2439	$self->enter_map ($map, $x, $y);
1757	}	2440	}
1758		2441
1759	cf::player->attach (	2442	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1760	on_logout => sub {
1761	my ($pl) = @_;
1762		2443
1763	# abort map switching before logout	2444	Moves the player to the given map-path and coordinates by first freezing
1764	if ($pl->ob->{_link_pos}) {	2445	her, loading and preparing them map, calling the provided $check callback
1765	cf::sync_job {	2446	that has to return the map if sucecssful, and then unfreezes the player on
1766	$pl->ob->leave_link	2447	the new (success) or old (failed) map position. In either case, $done will
1767	};	2448	be called at the end of this process.
1768	}
1769	},
1770	on_login => sub {
1771	my ($pl) = @_;
1772		2449
1773	# try to abort aborted map switching on player login :)
1774	# should happen only on crashes
1775	if ($pl->ob->{_link_pos}) {
1776	$pl->ob->enter_link;
1777	(async {
1778	# we need this sleep as the login has a concurrent enter_exit running
1779	# and this sleep increases chances of the player not ending up in scorn
1780	$pl->ob->reply (undef,
1781	"There was an internal problem at your last logout, "
1782	. "the server will try to bring you to your intended destination in a second.",
1783	cf::NDI_RED);
1784	Coro::Timer::sleep 1;
1785	$pl->ob->leave_link;
1786	})->prio (2);
1787	}
1788	},
1789	);
1790
1791	=item $player_object->goto ($path, $x, $y)
1792
1793	=cut	2450	=cut
		2451
		2452	our $GOTOGEN;
1794		2453
1795	sub cf::object::player::goto {	2454	sub cf::object::player::goto {
1796	my ($self, $path, $x, $y) = @_;	2455	my ($self, $path, $x, $y, $check, $done) = @_;
		2456
		2457	# do generation counting so two concurrent goto's will be executed in-order
		2458	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1797		2459
1798	$self->enter_link;	2460	$self->enter_link;
1799		2461
1800	(async {	2462	(async {
		2463	# *tag paths override both path and x|y
		2464	if ($path =~ /^\*(.*)$/) {
		2465	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2466	my $ob = $obs[rand @obs];
		2467
		2468	# todo: use ob_blocked to check all tiles of the destination "object"
		2469	# for suitability.
		2470
		2471	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2472	}
		2473	}
		2474
		2475	my $map = eval {
1801	my $map = cf::map::find $path;	2476	my $map = cf::map::find $path;
		2477
		2478	if ($map) {
1802	$map = $map->customise_for ($self) if $map;	2479	$map = $map->customise_for ($self);
1803		2480	$map = $check->($map) if $check && $map;
1804	# warn "entering ", $map->path, " at ($x, $y)\n"	2481	} else {
1805	# if $map;
1806
1807	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2482	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2483	}
1808		2484
		2485	$map
		2486	};
		2487
		2488	if ($@) {
		2489	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2490	LOG llevError | logBacktrace, Carp::longmess $@;
		2491	}
		2492
		2493	if ($gen == $self->{_goto_generation}) {
		2494	delete $self->{_goto_generation};
1809	$self->leave_link ($map, $x, $y);	2495	$self->leave_link ($map, $x, $y);
		2496	}
		2497
		2498	$done->() if $done;
1810	})->prio (1);	2499	})->prio (1);
1811	}	2500	}
1812		2501
1813	=item $player_object->enter_exit ($exit_object)	2502	=item $player_object->enter_exit ($exit_object)
1814		2503
…		…
1843	# that depends on the exit object	2532	# that depends on the exit object
1844		2533
1845	my $rmp = parse_random_map_params $exit->msg;	2534	my $rmp = parse_random_map_params $exit->msg;
1846		2535
1847	if ($exit->map) {	2536	if ($exit->map) {
1848	$rmp->{region} = $exit->map->region_name;	2537	$rmp->{region} = $exit->region->name;
1849	$rmp->{origin_map} = $exit->map->path;	2538	$rmp->{origin_map} = $exit->map->path;
1850	$rmp->{origin_x} = $exit->x;	2539	$rmp->{origin_x} = $exit->x;
1851	$rmp->{origin_y} = $exit->y;	2540	$rmp->{origin_y} = $exit->y;
1852	}	2541	}
1853		2542
1854	$rmp->{random_seed} ||= $exit->random_seed;	2543	$rmp->{random_seed} ||= $exit->random_seed;
1855		2544
1856	my $data = cf::to_json $rmp;	2545	my $data = cf::to_json $rmp;
1857	my $md5 = Digest::MD5::md5_hex $data;	2546	my $md5 = Digest::MD5::md5_hex $data;
1858	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2547	my $meta = "$RANDOMDIR/$md5.meta";
1859		2548
1860	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2549	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1861	aio_write $fh, 0, (length $data), $data, 0;	2550	aio_write $fh, 0, (length $data), $data, 0;
1862	undef $fh;	2551	undef $fh;
1863	aio_rename "$meta~", $meta;	2552	aio_rename "$meta~", $meta;
…		…
1870	sub cf::object::player::enter_exit {	2559	sub cf::object::player::enter_exit {
1871	my ($self, $exit) = @_;	2560	my ($self, $exit) = @_;
1872		2561
1873	return unless $self->type == cf::PLAYER;	2562	return unless $self->type == cf::PLAYER;
1874		2563
		2564	if ($exit->slaying eq "/!") {
		2565	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2566	# the problem is that $exit might not survive long enough
		2567	# so it needs to be done right now, right here
		2568	cf::sync_job { prepare_random_map $exit };
		2569	}
		2570
		2571	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2572	my $hp = $exit->stats->hp;
		2573	my $sp = $exit->stats->sp;
		2574
1875	$self->enter_link;	2575	$self->enter_link;
		2576
		2577	# if exit is damned, update players death & WoR home-position
		2578	$self->contr->savebed ($slaying, $hp, $sp)
		2579	if $exit->flag (FLAG_DAMNED);
1876		2580
1877	(async {	2581	(async {
1878	$self->deactivate_recursive; # just to be sure	2582	$self->deactivate_recursive; # just to be sure
1879	unless (eval {	2583	unless (eval {
1880	prepare_random_map $exit	2584	$self->goto ($slaying, $hp, $sp);
1881	if $exit->slaying eq "/!";
1882
1883	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1884	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1885		2585
1886	1;	2586	1;
1887	}) {	2587	}) {
1888	$self->message ("Something went wrong deep within the crossfire server. "	2588	$self->message ("Something went wrong deep within the crossfire server. "
1889	. "I'll try to bring you back to the map you were before. "	2589	. "I'll try to bring you back to the map you were before. "
1890	. "Please report this to the dungeon master!",	2590	. "Please report this to the dungeon master!",
1891	cf::NDI_UNIQUE | cf::NDI_RED);	2591	cf::NDI_UNIQUE | cf::NDI_RED);
1892		2592
1893	warn "ERROR in enter_exit: $@";	2593	warn "ERROR in enter_exit: $@";
1894	$self->leave_link;	2594	$self->leave_link;
1895	}	2595	}
1896	})->prio (1);	2596	})->prio (1);
…		…
1909		2609
1910	sub cf::client::send_drawinfo {	2610	sub cf::client::send_drawinfo {
1911	my ($self, $text, $flags) = @_;	2611	my ($self, $text, $flags) = @_;
1912		2612
1913	utf8::encode $text;	2613	utf8::encode $text;
1914	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2614	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1915	}	2615	}
1916		2616
		2617	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2618
		2619	Send a drawinfo or msg packet to the client, formatting the msg for the
		2620	client if neccessary. C<$type> should be a string identifying the type of
		2621	the message, with C<log> being the default. If C<$color> is negative, suppress
		2622	the message unless the client supports the msg packet.
		2623
		2624	=cut
		2625
		2626	our %CHANNEL = (
		2627	"c/identify" => {
		2628	id => "identify",
		2629	title => "Identify",
		2630	reply => undef,
		2631	tooltip => "Items recently identified",
		2632	},
		2633	"c/examine" => {
		2634	id => "examine",
		2635	title => "Examine",
		2636	reply => undef,
		2637	tooltip => "Signs and other items you examined",
		2638	},
		2639	);
		2640
		2641	sub cf::client::send_msg {
		2642	my ($self, $channel, $msg, $color, @extra) = @_;
		2643
		2644	$msg = $self->pl->expand_cfpod ($msg);
		2645
		2646	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2647
		2648	# check predefined channels, for the benefit of C
		2649	$channel = $CHANNEL{$channel} if $CHANNEL{$channel};
		2650
		2651	if (ref $channel) {
		2652	# send meta info to client, if not yet sent
		2653	unless (exists $self->{channel}{$channel->{id}}) {
		2654	$self->{channel}{$channel->{id}} = $channel;
		2655	$self->ext_msg (channel_info => $channel)
		2656	if $self->can_msg;
		2657	}
		2658
		2659	$channel = $channel->{id};
		2660	}
		2661
		2662	return unless @extra || length $msg;
		2663
		2664	if ($self->can_msg) {
		2665	# default colour, mask it out
		2666	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2667	if $color & cf::NDI_DEF;
		2668
		2669	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2670	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2671	} else {
		2672	if ($color >= 0) {
		2673	# replace some tags by gcfclient-compatible ones
		2674	for ($msg) {
		2675	1 while
		2676	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2677	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2678	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2679	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2680	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2681	}
		2682
		2683	$color &= cf::NDI_COLOR_MASK;
		2684
		2685	utf8::encode $msg;
		2686
		2687	if (0 && $msg =~ /\[/) {
		2688	# COMMAND/INFO
		2689	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2690	} else {
		2691	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2692	$self->send_packet ("drawinfo $color $msg")
		2693	}
		2694	}
		2695	}
		2696	}
		2697
		2698	=item $client->ext_msg ($type, @msg)
		2699
		2700	Sends an ext event to the client.
		2701
		2702	=cut
		2703
		2704	sub cf::client::ext_msg($$@) {
		2705	my ($self, $type, @msg) = @_;
		2706
		2707	if ($self->extcmd == 2) {
		2708	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2709	} elsif ($self->extcmd == 1) { # TODO: remove
		2710	push @msg, msgtype => "event_$type";
		2711	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2712	}
		2713	}
		2714
		2715	=item $client->ext_reply ($msgid, @msg)
		2716
		2717	Sends an ext reply to the client.
		2718
		2719	=cut
		2720
		2721	sub cf::client::ext_reply($$@) {
		2722	my ($self, $id, @msg) = @_;
		2723
		2724	if ($self->extcmd == 2) {
		2725	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2726	} elsif ($self->extcmd == 1) {
		2727	#TODO: version 1, remove
		2728	unshift @msg, msgtype => "reply", msgid => $id;
		2729	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2730	}
		2731	}
1917		2732
1918	=item $success = $client->query ($flags, "text", \&cb)	2733	=item $success = $client->query ($flags, "text", \&cb)
1919		2734
1920	Queues a query to the client, calling the given callback with	2735	Queues a query to the client, calling the given callback with
1921	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2736	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1922	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2737	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1923		2738
1924	Queries can fail, so check the return code. Or don't, as queries will become	2739	Queries can fail, so check the return code. Or don't, as queries will
1925	reliable at some point in the future.	2740	become reliable at some point in the future.
1926		2741
1927	=cut	2742	=cut
1928		2743
1929	sub cf::client::query {	2744	sub cf::client::query {
1930	my ($self, $flags, $text, $cb) = @_;	2745	my ($self, $flags, $text, $cb) = @_;
…		…
1938	utf8::encode $text;	2753	utf8::encode $text;
1939	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2754	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1940		2755
1941	$self->send_packet ($self->{query_queue}[0][0])	2756	$self->send_packet ($self->{query_queue}[0][0])
1942	if @{ $self->{query_queue} } == 1;	2757	if @{ $self->{query_queue} } == 1;
		2758
		2759	1
1943	}	2760	}
1944		2761
1945	cf::client->attach (	2762	cf::client->attach (
		2763	on_connect => sub {
		2764	my ($ns) = @_;
		2765
		2766	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2767	},
1946	on_reply => sub {	2768	on_reply => sub {
1947	my ($ns, $msg) = @_;	2769	my ($ns, $msg) = @_;
1948		2770
1949	# this weird shuffling is so that direct followup queries	2771	# this weird shuffling is so that direct followup queries
1950	# get handled first	2772	# get handled first
1951	my $queue = delete $ns->{query_queue}	2773	my $queue = delete $ns->{query_queue}
1952	or return; # be conservative, not sure how that can happen, but we saw a crash here	2774	or return; # be conservative, not sure how that can happen, but we saw a crash here
1953		2775
1954	(shift @$queue)->[1]->($msg);	2776	(shift @$queue)->[1]->($msg);
		2777	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1955		2778
1956	push @{ $ns->{query_queue} }, @$queue;	2779	push @{ $ns->{query_queue} }, @$queue;
1957		2780
1958	if (@{ $ns->{query_queue} } == @$queue) {	2781	if (@{ $ns->{query_queue} } == @$queue) {
1959	if (@$queue) {	2782	if (@$queue) {
…		…
1961	} else {	2784	} else {
1962	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2785	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1963	}	2786	}
1964	}	2787	}
1965	},	2788	},
		2789	on_exticmd => sub {
		2790	my ($ns, $buf) = @_;
		2791
		2792	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2793
		2794	if (ref $msg) {
		2795	my ($type, $reply, @payload) =
		2796	"ARRAY" eq ref $msg
		2797	? @$msg
		2798	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2799
		2800	my @reply;
		2801
		2802	if (my $cb = $EXTICMD{$type}) {
		2803	@reply = $cb->($ns, @payload);
		2804	}
		2805
		2806	$ns->ext_reply ($reply, @reply)
		2807	if $reply;
		2808
		2809	} else {
		2810	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2811	}
		2812
		2813	cf::override;
		2814	},
1966	);	2815	);
1967		2816
1968	=item $client->async (\&cb)	2817	=item $client->async (\&cb)
1969		2818
1970	Create a new coroutine, running the specified callback. The coroutine will	2819	Create a new coroutine, running the specified callback. The coroutine will
…		…
2011	our $safe = new Safe "safe";	2860	our $safe = new Safe "safe";
2012	our $safe_hole = new Safe::Hole;	2861	our $safe_hole = new Safe::Hole;
2013		2862
2014	$SIG{FPE} = 'IGNORE';	2863	$SIG{FPE} = 'IGNORE';
2015		2864
2016	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2865	$safe->permit_only (Opcode::opset qw(
		2866	:base_core :base_mem :base_orig :base_math
		2867	grepstart grepwhile mapstart mapwhile
		2868	sort time
		2869	));
2017		2870
2018	# here we export the classes and methods available to script code	2871	# here we export the classes and methods available to script code
2019		2872
2020	=pod	2873	=pod
2021		2874
2022	The following fucntions and emthods are available within a safe environment:	2875	The following functions and methods are available within a safe environment:
2023		2876
2024	cf::object contr pay_amount pay_player map	2877	cf::object
		2878	contr pay_amount pay_player map x y force_find force_add
		2879	insert remove name archname title slaying race decrease_ob_nr
		2880
2025	cf::object::player player	2881	cf::object::player
2026	cf::player peaceful	2882	player
2027	cf::map trigger	2883
		2884	cf::player
		2885	peaceful
		2886
		2887	cf::map
		2888	trigger
2028		2889
2029	=cut	2890	=cut
2030		2891
2031	for (	2892	for (
2032	["cf::object" => qw(contr pay_amount pay_player map)],	2893	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2894	insert remove inv name archname title slaying race
		2895	decrease_ob_nr)],
2033	["cf::object::player" => qw(player)],	2896	["cf::object::player" => qw(player)],
2034	["cf::player" => qw(peaceful)],	2897	["cf::player" => qw(peaceful)],
2035	["cf::map" => qw(trigger)],	2898	["cf::map" => qw(trigger)],
2036	) {	2899	) {
2037	no strict 'refs';	2900	no strict 'refs';
…		…
2108	=back	2971	=back
2109		2972
2110	=cut	2973	=cut
2111		2974
2112	#############################################################################	2975	#############################################################################
		2976	# the server's init and main functions
2113		2977
2114	=head2 EXTENSION DATABASE SUPPORT	2978	sub load_facedata($) {
		2979	my ($path) = @_;
2115		2980
2116	Crossfire maintains a very simple database for extension use. It can	2981	# HACK to clear player env face cache, we need some signal framework
2117	currently store anything that can be serialised using Storable, which	2982	# for this (global event?)
2118	excludes objects.	2983	%ext::player_env::MUSIC_FACE_CACHE = ();
2119		2984
2120	The parameter C<$family> should best start with the name of the extension	2985	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2121	using it, it should be unique.
2122		2986
2123	=over 4	2987	warn "loading facedata from $path\n";
2124		2988
2125	=item $hashref = cf::db_get $family	2989	my $facedata;
		2990	0 < aio_load $path, $facedata
		2991	or die "$path: $!";
2126		2992
2127	Return a hashref for use by the extension C<$family>, which can be	2993	$facedata = Coro::Storable::thaw $facedata;
2128	modified. After modifications, you have to call C<cf::db_dirty> or
2129	C<cf::db_sync>.
2130		2994
2131	=item $value = cf::db_get $family => $key	2995	$facedata->{version} == 2
		2996	or cf::cleanup "$path: version mismatch, cannot proceed.";
2132		2997
2133	Returns a single value from the database	2998	# patch in the exptable
2134		2999	$facedata->{resource}{"res/exp_table"} = {
2135	=item cf::db_put $family => $hashref	3000	type => FT_RSRC,
2136		3001	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2137	Stores the given family hashref into the database. Updates are delayed, if
2138	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2139
2140	=item cf::db_put $family => $key => $value
2141
2142	Stores the given C<$value> in the family hash. Updates are delayed, if you
2143	want the data to be synced to disk immediately, use C<cf::db_sync>.
2144
2145	=item cf::db_dirty
2146
2147	Marks the database as dirty, to be updated at a later time.
2148
2149	=item cf::db_sync
2150
2151	Immediately write the database to disk I<if it is dirty>.
2152
2153	=cut
2154
2155	our $DB;
2156
2157	{
2158	my $path = cf::localdir . "/database.pst";
2159
2160	sub db_load() {
2161	$DB = stat $path ? Storable::retrieve $path : { };
2162	}
2163
2164	my $pid;
2165
2166	sub db_save() {
2167	waitpid $pid, 0 if $pid;
2168	if (0 == ($pid = fork)) {
2169	$DB->{_meta}{version} = 1;
2170	Storable::nstore $DB, "$path~";
2171	rename "$path~", $path;
2172	cf::_exit 0 if defined $pid;
2173	}
2174	}
2175
2176	my $dirty;
2177
2178	sub db_sync() {
2179	db_save if $dirty;
2180	undef $dirty;
2181	}
2182
2183	my $idle = Event->idle (min => 10, max => 20, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2184	db_sync;
2185	});	3002	};
		3003	cf::cede_to_tick;
2186		3004
2187	sub db_dirty() {
2188	$dirty = 1;
2189	$idle->start;
2190	}	3005	{
		3006	my $faces = $facedata->{faceinfo};
2191		3007
2192	sub db_get($;$) {	3008	while (my ($face, $info) = each %$faces) {
2193	@_ >= 2	3009	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2194	? $DB->{$_[0]}{$_[1]}	3010	cf::face::set_visibility $idx, $info->{visibility};
2195	: ($DB->{$_[0]} ||= { })	3011	cf::face::set_magicmap $idx, $info->{magicmap};
2196	}	3012	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
		3013	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2197		3014
2198	sub db_put($$;$) {	3015	cf::cede_to_tick;
2199	if (@_ >= 3) {
2200	$DB->{$_[0]}{$_[1]} = $_[2];
2201	} else {
2202	$DB->{$_[0]} = $_[1];
2203	}
2204	db_dirty;
2205	}
2206
2207	cf::global->attach (
2208	prio => 10000,
2209	on_cleanup => sub {
2210	db_sync;
2211	},	3016	}
2212	);
2213	}
2214		3017
2215	#############################################################################	3018	while (my ($face, $info) = each %$faces) {
2216	# the server's main()	3019	next unless $info->{smooth};
		3020	my $idx = cf::face::find $face
		3021	or next;
		3022	if (my $smooth = cf::face::find $info->{smooth}) {
		3023	cf::face::set_smooth $idx, $smooth;
		3024	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3025	} else {
		3026	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3027	}
2217		3028
2218	sub cfg_load {	3029	cf::cede_to_tick;
		3030	}
		3031	}
		3032
		3033	{
		3034	my $anims = $facedata->{animinfo};
		3035
		3036	while (my ($anim, $info) = each %$anims) {
		3037	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3038	cf::cede_to_tick;
		3039	}
		3040
		3041	cf::anim::invalidate_all; # d'oh
		3042	}
		3043
		3044	{
		3045	# TODO: for gcfclient pleasure, we should give resources
		3046	# that gcfclient doesn't grok a >10000 face index.
		3047	my $res = $facedata->{resource};
		3048
		3049	my $soundconf = delete $res->{"res/sound.conf"};
		3050
		3051	while (my ($name, $info) = each %$res) {
		3052	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3053	my $data;
		3054
		3055	if ($info->{type} & 1) {
		3056	# prepend meta info
		3057
		3058	my $meta = $enc->encode ({
		3059	name => $name,
		3060	%{ $info->{meta} || {} },
		3061	});
		3062
		3063	$data = pack "(w/a*)*", $meta, $info->{data};
		3064	} else {
		3065	$data = $info->{data};
		3066	}
		3067
		3068	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3069	cf::face::set_type $idx, $info->{type};
		3070
		3071	cf::cede_to_tick;
		3072	}
		3073
		3074	if ($soundconf) {
		3075	$soundconf = $enc->decode (delete $soundconf->{data});
		3076
		3077	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3078	my $sound = $soundconf->{compat}[$_]
		3079	or next;
		3080
		3081	my $face = cf::face::find "sound/$sound->[1]";
		3082	cf::sound::set $sound->[0] => $face;
		3083	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3084	}
		3085
		3086	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3087	my $face = cf::face::find "sound/$v";
		3088	cf::sound::set $k => $face;
		3089	}
		3090	}
		3091	}
		3092
		3093	1
		3094	}
		3095
		3096	register_exticmd fx_want => sub {
		3097	my ($ns, $want) = @_;
		3098
		3099	while (my ($k, $v) = each %$want) {
		3100	$ns->fx_want ($k, $v);
		3101	}
		3102	};
		3103
		3104	sub reload_regions {
		3105	# HACK to clear player env face cache, we need some signal framework
		3106	# for this (global event?)
		3107	%ext::player_env::MUSIC_FACE_CACHE = ();
		3108
		3109	load_resource_file "$MAPDIR/regions"
		3110	or die "unable to load regions file\n";
		3111
		3112	for (cf::region::list) {
		3113	$_->{match} = qr/$_->{match}/
		3114	if exists $_->{match};
		3115	}
		3116	}
		3117
		3118	sub reload_facedata {
		3119	load_facedata "$DATADIR/facedata"
		3120	or die "unable to load facedata\n";
		3121	}
		3122
		3123	sub reload_archetypes {
		3124	load_resource_file "$DATADIR/archetypes"
		3125	or die "unable to load archetypes\n";
		3126	#d# NEED to laod twice to resolve forward references
		3127	# this really needs to be done in an extra post-pass
		3128	# (which needs to be synchronous, so solve it differently)
		3129	load_resource_file "$DATADIR/archetypes"
		3130	or die "unable to load archetypes\n";
		3131	}
		3132
		3133	sub reload_treasures {
		3134	load_resource_file "$DATADIR/treasures"
		3135	or die "unable to load treasurelists\n";
		3136	}
		3137
		3138	sub reload_resources {
		3139	warn "reloading resource files...\n";
		3140
		3141	reload_regions;
		3142	reload_facedata;
		3143	#reload_archetypes;#d#
		3144	reload_archetypes;
		3145	reload_treasures;
		3146
		3147	warn "finished reloading resource files\n";
		3148	}
		3149
		3150	sub init {
		3151	reload_resources;
		3152	}
		3153
		3154	sub reload_config {
2219	open my $fh, "<:utf8", cf::confdir . "/config"	3155	open my $fh, "<:utf8", "$CONFDIR/config"
2220	or return;	3156	or return;
2221		3157
2222	local $/;	3158	local $/;
2223	*CFG = YAML::Syck::Load <$fh>;	3159	*CFG = YAML::Syck::Load <$fh>;
2224		3160
…		…
2243	(async {	3179	(async {
2244	Event::one_event;	3180	Event::one_event;
2245	})->prio (Coro::PRIO_MAX);	3181	})->prio (Coro::PRIO_MAX);
2246	};	3182	};
2247		3183
2248	cfg_load;	3184	reload_config;
2249	db_load;	3185	db_init;
2250	load_extensions;	3186	load_extensions;
2251		3187
2252	$TICK_WATCHER->start;	3188	$TICK_WATCHER->start;
2253	Event::loop;	3189	Event::loop;
2254	}	3190	}
…		…
2258		3194
2259	# install some emergency cleanup handlers	3195	# install some emergency cleanup handlers
2260	BEGIN {	3196	BEGIN {
2261	for my $signal (qw(INT HUP TERM)) {	3197	for my $signal (qw(INT HUP TERM)) {
2262	Event->signal (	3198	Event->signal (
		3199	reentrant => 0,
2263	data => WF_AUTOCANCEL,	3200	data => WF_AUTOCANCEL,
2264	signal => $signal,	3201	signal => $signal,
		3202	prio => 0,
2265	cb => sub {	3203	cb => sub {
2266	cf::cleanup "SIG$signal";	3204	cf::cleanup "SIG$signal";
2267	},	3205	},
2268	);	3206	);
2269	}	3207	}
		3208	}
		3209
		3210	sub write_runtime {
		3211	my $runtime = "$LOCALDIR/runtime";
		3212
		3213	# first touch the runtime file to show we are still running:
		3214	# the fsync below can take a very very long time.
		3215
		3216	IO::AIO::aio_utime $runtime, undef, undef;
		3217
		3218	my $guard = cf::lock_acquire "write_runtime";
		3219
		3220	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3221	or return;
		3222
		3223	my $value = $cf::RUNTIME + 90 + 10;
		3224	# 10 is the runtime save interval, for a monotonic clock
		3225	# 60 allows for the watchdog to kill the server.
		3226
		3227	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3228	and return;
		3229
		3230	# always fsync - this file is important
		3231	aio_fsync $fh
		3232	and return;
		3233
		3234	# touch it again to show we are up-to-date
		3235	aio_utime $fh, undef, undef;
		3236
		3237	close $fh
		3238	or return;
		3239
		3240	aio_rename "$runtime~", $runtime
		3241	and return;
		3242
		3243	warn "runtime file written.\n";
		3244
		3245	1
2270	}	3246	}
2271		3247
2272	sub emergency_save() {	3248	sub emergency_save() {
2273	my $freeze_guard = cf::freeze_mainloop;	3249	my $freeze_guard = cf::freeze_mainloop;
2274		3250
…		…
2291	my $map = $cf::MAP{$path} or next;	3267	my $map = $cf::MAP{$path} or next;
2292	$map->valid or next;	3268	$map->valid or next;
2293	$map->save;	3269	$map->save;
2294	}	3270	}
2295	warn "end emergency map save\n";	3271	warn "end emergency map save\n";
		3272
		3273	warn "begin emergency database checkpoint\n";
		3274	BDB::db_env_txn_checkpoint $DB_ENV;
		3275	warn "end emergency database checkpoint\n";
2296	};	3276	};
2297		3277
2298	warn "leave emergency perl save\n";	3278	warn "leave emergency perl save\n";
2299	}	3279	}
2300		3280
		3281	sub post_cleanup {
		3282	my ($make_core) = @_;
		3283
		3284	warn Carp::longmess "post_cleanup backtrace"
		3285	if $make_core;
		3286	}
		3287
2301	sub reload() {	3288	sub do_reload_perl() {
2302	# can/must only be called in main	3289	# can/must only be called in main
2303	if ($Coro::current != $Coro::main) {	3290	if ($Coro::current != $Coro::main) {
2304	warn "can only reload from main coroutine";	3291	warn "can only reload from main coroutine";
2305	return;	3292	return;
2306	}	3293	}
2307		3294
2308	warn "reloading...";	3295	warn "reloading...";
2309		3296
2310	warn "cancelling server ticker";	3297	warn "entering sync_job";
2311	$TICK_WATCHER->cancel;
2312		3298
		3299	cf::sync_job {
		3300	cf::write_runtime; # external watchdog should not bark
2313	cf::emergency_save;	3301	cf::emergency_save;
		3302	cf::write_runtime; # external watchdog should not bark
2314		3303
2315	eval {	3304	warn "syncing database to disk";
		3305	BDB::db_env_txn_checkpoint $DB_ENV;
		3306
2316	# if anything goes wrong in here, we should simply crash as we already saved	3307	# if anything goes wrong in here, we should simply crash as we already saved
2317
2318	warn "syncing database to disk";
2319	cf::db_sync;
2320		3308
2321	warn "cancelling all WF_AUTOCANCEL watchers";	3309	warn "cancelling all WF_AUTOCANCEL watchers";
2322	for (Event::all_watchers) {	3310	for (Event::all_watchers) {
2323	$_->cancel if $_->data & WF_AUTOCANCEL;	3311	$_->cancel if $_->data & WF_AUTOCANCEL;
2324	}	3312	}
2325		3313
2326	warn "flushing outstanding aio requests";	3314	warn "flushing outstanding aio requests";
2327	for (;;) {	3315	for (;;) {
		3316	BDB::flush;
2328	IO::AIO::flush;	3317	IO::AIO::flush;
2329	Coro::cede;	3318	Coro::cede;
2330	last unless IO::AIO::nreqs;	3319	last unless IO::AIO::nreqs || BDB::nreqs;
2331	warn "iterate...";	3320	warn "iterate...";
2332	}	3321	}
		3322
		3323	++$RELOAD;
2333		3324
2334	warn "cancelling all extension coros";	3325	warn "cancelling all extension coros";
2335	$_->cancel for values %EXT_CORO;	3326	$_->cancel for values %EXT_CORO;
2336	%EXT_CORO = ();	3327	%EXT_CORO = ();
2337		3328
2338	warn "removing commands";	3329	warn "removing commands";
2339	%COMMAND = ();	3330	%COMMAND = ();
2340		3331
2341	warn "removing ext commands";	3332	warn "removing ext/exti commands";
2342	%EXTCMD = ();	3333	%EXTCMD = ();
		3334	%EXTICMD = ();
2343		3335
2344	warn "unloading/nuking all extensions";	3336	warn "unloading/nuking all extensions";
2345	for my $pkg (@EXTS) {	3337	for my $pkg (@EXTS) {
2346	warn "... unloading $pkg";	3338	warn "... unloading $pkg";
2347		3339
…		…
2377	Symbol::delete_package "safe::$_"	3369	Symbol::delete_package "safe::$_"
2378	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3370	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2379		3371
2380	warn "unloading cf.pm \"a bit\"";	3372	warn "unloading cf.pm \"a bit\"";
2381	delete $INC{"cf.pm"};	3373	delete $INC{"cf.pm"};
		3374	delete $INC{"cf/pod.pm"};
2382		3375
2383	# don't, removes xs symbols, too,	3376	# don't, removes xs symbols, too,
2384	# and global variables created in xs	3377	# and global variables created in xs
2385	#Symbol::delete_package __PACKAGE__;	3378	#Symbol::delete_package __PACKAGE__;
2386		3379
…		…
2389	warn "reloading cf.pm";	3382	warn "reloading cf.pm";
2390	require cf;	3383	require cf;
2391	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3384	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2392		3385
2393	warn "loading config and database again";	3386	warn "loading config and database again";
2394	cf::cfg_load;	3387	cf::reload_config;
2395	cf::db_load;
2396		3388
2397	warn "loading extensions";	3389	warn "loading extensions";
2398	cf::load_extensions;	3390	cf::load_extensions;
2399		3391
2400	warn "reattaching attachments to objects/players";	3392	warn "reattaching attachments to objects/players";
2401	_global_reattach;	3393	_global_reattach; # objects, sockets
2402	warn "reattaching attachments to maps";	3394	warn "reattaching attachments to maps";
2403	reattach $_ for values %MAP;	3395	reattach $_ for values %MAP;
		3396	warn "reattaching attachments to players";
		3397	reattach $_ for values %PLAYER;
2404		3398
2405	warn "restarting server ticker";	3399	warn "leaving sync_job";
2406		3400
2407	$TICK_WATCHER->start;	3401	1
2408	};	3402	} or do {
2409
2410	if ($@) {
2411	warn $@;	3403	warn $@;
2412	warn "error while reloading, exiting.";	3404	warn "error while reloading, exiting.";
2413	exit 1;	3405	exit 1;
2414	}	3406	};
2415		3407
2416	warn "reloaded";	3408	warn "reloaded";
2417	};	3409	};
2418		3410
2419	our $RELOAD_WATCHER; # used only during reload	3411	our $RELOAD_WATCHER; # used only during reload
2420		3412
		3413	sub reload_perl() {
		3414	# doing reload synchronously and two reloads happen back-to-back,
		3415	# coro crashes during coro_state_free->destroy here.
		3416
		3417	$RELOAD_WATCHER ||= Event->timer (
		3418	reentrant => 0,
		3419	after => 0,
		3420	data => WF_AUTOCANCEL,
		3421	cb => sub {
		3422	do_reload_perl;
		3423	undef $RELOAD_WATCHER;
		3424	},
		3425	);
		3426	}
		3427
2421	register_command "reload" => sub {	3428	register_command "reload" => sub {
2422	my ($who, $arg) = @_;	3429	my ($who, $arg) = @_;
2423		3430
2424	if ($who->flag (FLAG_WIZ)) {	3431	if ($who->flag (FLAG_WIZ)) {
2425	$who->message ("reloading server.");	3432	$who->message ("reloading server.");
2426		3433	async { reload_perl };
2427	# doing reload synchronously and two reloads happen back-to-back,
2428	# coro crashes during coro_state_free->destroy here.
2429
2430	$RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub {
2431	reload;
2432	undef $RELOAD_WATCHER;
2433	});
2434	}	3434	}
2435	};	3435	};
2436		3436
2437	unshift @INC, $LIBDIR;	3437	unshift @INC, $LIBDIR;
2438		3438
2439	my $bug_warning = 0;	3439	my $bug_warning = 0;
		3440
		3441	our @WAIT_FOR_TICK;
		3442	our @WAIT_FOR_TICK_BEGIN;
		3443
		3444	sub wait_for_tick {
		3445	return unless $TICK_WATCHER->is_active;
		3446	return if $Coro::current == $Coro::main;
		3447
		3448	my $signal = new Coro::Signal;
		3449	push @WAIT_FOR_TICK, $signal;
		3450	$signal->wait;
		3451	}
		3452
		3453	sub wait_for_tick_begin {
		3454	return unless $TICK_WATCHER->is_active;
		3455	return if $Coro::current == $Coro::main;
		3456
		3457	my $signal = new Coro::Signal;
		3458	push @WAIT_FOR_TICK_BEGIN, $signal;
		3459	$signal->wait;
		3460	}
		3461
		3462	our $stat_fh;
		3463	sysopen $stat_fh, "/tmp/cfstats", Fcntl::O_APPEND | Fcntl::O_CREAT | Fcntl::O_WRONLY, 0600;#d#
2440		3464
2441	$TICK_WATCHER = Event->timer (	3465	$TICK_WATCHER = Event->timer (
2442	reentrant => 0,	3466	reentrant => 0,
2443	parked => 1,	3467	parked => 1,
2444	prio => 0,	3468	prio => 0,
…		…
2449	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3473	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2450	unless ++$bug_warning > 10;	3474	unless ++$bug_warning > 10;
2451	return;	3475	return;
2452	}	3476	}
2453		3477
		3478	my @pl = cf::player::list; my $stats = sprintf "%.2f %d %d %d", $RUNTIME, (scalar @pl), cf::object::actives_size, cf::object::objects_size; #d#
		3479
2454	$NOW = Event::time;	3480	$NOW = $tick_start = Event::time;
2455		3481
2456	cf::server_tick; # one server iteration	3482	cf::server_tick; # one server iteration
		3483
2457	$RUNTIME += $TICK;	3484	$RUNTIME += $TICK;
2458	$NEXT_TICK += $TICK;	3485	$NEXT_TICK += $TICK;
2459		3486
2460	$WAIT_FOR_TICK->broadcast;	3487	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2461	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3488	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3489	Coro::async_pool {
		3490	write_runtime
		3491	or warn "ERROR: unable to write runtime file: $!";
		3492	};
		3493	}
		3494
		3495	# my $AFTER = Event::time;
		3496	# warn $AFTER - $NOW;#d#
		3497
		3498	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3499	$sig->send;
		3500	}
		3501	while (my $sig = shift @WAIT_FOR_TICK) {
		3502	$sig->send;
		3503	}
		3504
		3505	$NOW = Event::time;
2462		3506
2463	# if we are delayed by four ticks or more, skip them all	3507	# if we are delayed by four ticks or more, skip them all
2464	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3508	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2465		3509
2466	$TICK_WATCHER->at ($NEXT_TICK);	3510	$TICK_WATCHER->at ($NEXT_TICK);
2467	$TICK_WATCHER->start;	3511	$TICK_WATCHER->start;
		3512
		3513	$LOAD = ($NOW - $tick_start) / $TICK;
		3514	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3515
		3516	_post_tick;
		3517
		3518	# gather some statistics#d#
		3519	$stats .= sprintf " %d\n", 10000 * ($NOW - $tick_start);#d#
		3520	IO::AIO::aio_write $stat_fh, undef, undef, $stats, 0;#d#
2468	},	3521	},
2469	);	3522	);
2470		3523
		3524	{
		3525	BDB::min_parallel 8;
		3526	BDB::max_poll_time $TICK * 0.1;
		3527	$BDB_POLL_WATCHER = Event->io (
		3528	reentrant => 0,
		3529	fd => BDB::poll_fileno,
		3530	poll => 'r',
		3531	prio => 0,
		3532	data => WF_AUTOCANCEL,
		3533	cb => \&BDB::poll_cb,
		3534	);
		3535
		3536	BDB::set_sync_prepare {
		3537	my $status;
		3538	my $current = $Coro::current;
		3539	(
		3540	sub {
		3541	$status = $!;
		3542	$current->ready; undef $current;
		3543	},
		3544	sub {
		3545	Coro::schedule while defined $current;
		3546	$! = $status;
		3547	},
		3548	)
		3549	};
		3550
		3551	unless ($DB_ENV) {
		3552	$DB_ENV = BDB::db_env_create;
		3553
		3554	cf::sync_job {
		3555	eval {
		3556	BDB::db_env_open
		3557	$DB_ENV,
		3558	$BDBDIR,
		3559	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3560	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3561	0666;
		3562
		3563	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3564
		3565	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
		3566	| BDB::LOG_AUTOREMOVE, 1);
		3567	$DB_ENV->set_lk_detect;
		3568	};
		3569
		3570	cf::cleanup "db_env_open(db): $@" if $@;
		3571	};
		3572	}
		3573
		3574	$BDB_CHECKPOINT_WATCHER = Event->timer (
		3575	after => 11,
		3576	interval => 60,
		3577	hard => 1,
		3578	prio => 0,
		3579	data => WF_AUTOCANCEL,
		3580	cb => sub {
		3581	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3582	},
		3583	);
		3584	$BDB_TRICKLE_WATCHER = Event->timer (
		3585	after => 5,
		3586	interval => 10,
		3587	hard => 1,
		3588	prio => 0,
		3589	data => WF_AUTOCANCEL,
		3590	cb => sub {
		3591	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3592	},
		3593	);
		3594	}
		3595
		3596	{
		3597	IO::AIO::min_parallel 8;
		3598
		3599	undef $Coro::AIO::WATCHER;
2471	IO::AIO::max_poll_time $TICK * 0.2;	3600	IO::AIO::max_poll_time $TICK * 0.1;
2472
2473	$AIO_POLL_WATCHER = Event->io (	3601	$AIO_POLL_WATCHER = Event->io (
2474	fd => IO::AIO::poll_fileno,	3602	reentrant => 0,
2475	poll => 'r',
2476	prio => 5,
2477	data => WF_AUTOCANCEL,
2478	cb => \&IO::AIO::poll_cb,
2479	);
2480
2481	$WRITE_RUNTIME_WATCHER = Event->timer (
2482	data => WF_AUTOCANCEL,	3603	data => WF_AUTOCANCEL,
2483	after => 1,	3604	fd => IO::AIO::poll_fileno,
2484	interval => 10,	3605	poll => 'r',
2485	prio => 6, # keep it lowest so it acts like a watchdog	3606	prio => 6,
2486	cb => Coro::unblock_sub {	3607	cb => \&IO::AIO::poll_cb,
2487	write_runtime	3608	);
2488	or warn "ERROR: unable to write runtime file: $!";	3609	}
		3610
		3611	my $_log_backtrace;
		3612
		3613	sub _log_backtrace {
		3614	my ($msg, @addr) = @_;
		3615
		3616	$msg =~ s/\n//;
		3617
		3618	# limit the # of concurrent backtraces
		3619	if ($_log_backtrace < 2) {
		3620	++$_log_backtrace;
		3621	async {
		3622	my @bt = fork_call {
		3623	@addr = map { sprintf "%x", $_ } @addr;
		3624	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3625	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3626	or die "addr2line: $!";
		3627
		3628	my @funcs;
		3629	my @res = <$fh>;
		3630	chomp for @res;
		3631	while (@res) {
		3632	my ($func, $line) = splice @res, 0, 2, ();
		3633	push @funcs, "[$func] $line";
		3634	}
		3635
		3636	@funcs
		3637	};
		3638
		3639	LOG llevInfo, "[ABT] $msg\n";
		3640	LOG llevInfo, "[ABT] $_\n" for @bt;
		3641	--$_log_backtrace;
		3642	};
		3643	} else {
		3644	LOG llevInfo, "[ABT] $msg\n";
		3645	LOG llevInfo, "[ABT] [suppressed]\n";
2489	},	3646	}
2490	);	3647	}
		3648
		3649	# load additional modules
		3650	use cf::pod;
2491		3651
2492	END { cf::emergency_save }	3652	END { cf::emergency_save }
2493		3653
2494	1	3654	1
2495		3655

Diff Legend

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