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

Diff Legend

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