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.199 by root, Mon Jan 29 14:46:01 2007 UTC vs.
Revision 1.408 by root, Mon Jan 14 10:12:12 2008 UTC

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

Diff Legend

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