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.201 by root, Mon Jan 29 18:15:23 2007 UTC vs.
Revision 1.405 by root, Mon Dec 17 08:03:22 2007 UTC

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

Diff Legend

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