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

Diff Legend

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