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.408 by root, Mon Jan 14 10:12:12 2008 UTC

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

Diff Legend

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