ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.207 by root, Sun Feb 11 22:42:09 2007 UTC vs.
Revision 1.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 ();
20	use BDB ();	28	use BDB ();
21	use Data::Dumper;	29	use Data::Dumper;
22	use Digest::MD5;	30	use Digest::MD5;
23	use Fcntl;	31	use Fcntl;
		32	use YAML ();
24	use IO::AIO 2.32 ();	33	use IO::AIO 2.51 ();
25	use YAML::Syck ();
26	use Time::HiRes;	34	use Time::HiRes;
		35	use Compress::LZF;
		36	use Digest::MD5 ();
27		37
28	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
29		45
30	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	46	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
31
32	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
33	$YAML::Syck::ImplicitUnicode = 1;
34
35	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
36		47
37	our %COMMAND = ();	48	our %COMMAND = ();
38	our %COMMAND_TIME = ();	49	our %COMMAND_TIME = ();
39		50
40	our @EXTS = (); # list of extension package names	51	our @EXTS = (); # list of extension package names
41	our %EXTCMD = ();	52	our %EXTCMD = ();
		53	our %EXTICMD = ();
42	our %EXT_CORO = (); # coroutines bound to extensions	54	our %EXT_CORO = (); # coroutines bound to extensions
43	our %EXT_MAP = (); # pluggable maps	55	our %EXT_MAP = (); # pluggable maps
44		56
		57	our $RELOAD; # number of reloads so far
45	our @EVENT;	58	our @EVENT;
46	our $LIBDIR = datadir . "/ext";
47		59
48	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(!)
49	our $TICK_WATCHER;	74	our $TICK_WATCHER;
50	our $AIO_POLL_WATCHER;	75	our $AIO_POLL_WATCHER;
51	our $WRITE_RUNTIME_WATCHER;	76	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
52	our $NEXT_TICK;	77	our $NEXT_TICK;
53	our $NOW;
54	our $USE_FSYNC = 1; # use fsync to write maps - default off	78	our $USE_FSYNC = 1; # use fsync to write maps - default off
55		79
56	our $BDB_POLL_WATCHER;	80	our $BDB_POLL_WATCHER;
		81	our $BDB_DEADLOCK_WATCHER;
		82	our $BDB_CHECKPOINT_WATCHER;
		83	our $BDB_TRICKLE_WATCHER;
57	our $DB_ENV;	84	our $DB_ENV;
58		85
59	our %CFG;	86	our %CFG;
60		87
61	our $UPTIME; $UPTIME ||= time;	88	our $UPTIME; $UPTIME ||= time;
62	our $RUNTIME;	89	our $RUNTIME;
		90	our $NOW;
63		91
64	our %PLAYER; # all users	92	our (%PLAYER, %PLAYER_LOADING); # all users
65	our %MAP; # all maps	93	our (%MAP, %MAP_LOADING ); # all maps
66	our $LINK_MAP; # the special {link} map, which is always available	94	our $LINK_MAP; # the special {link} map, which is always available
67	our $RANDOM_MAPS = cf::localdir . "/random";
68	our $BDB_ENV_DIR = cf::localdir . "/db";
69
70	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
71	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
72		95
73	# 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 ∕
74	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	97	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
75		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
76	binmode STDOUT;	103	binmode STDOUT;
77	binmode STDERR;	104	binmode STDERR;
78		105
79	# read virtual server time, if available	106	# read virtual server time, if available
80	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	107	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
81	open my $fh, "<", cf::localdir . "/runtime"	108	open my $fh, "<", "$LOCALDIR/runtime"
82	or die "unable to read runtime file: $!";	109	or die "unable to read runtime file: $!";
83	$RUNTIME = <$fh> + 0.;	110	$RUNTIME = <$fh> + 0.;
84	}	111	}
85		112
86	mkdir cf::localdir;	113	mkdir $_
87	mkdir cf::localdir . "/" . cf::playerdir;	114	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
88	mkdir cf::localdir . "/" . cf::tmpdir;
89	mkdir cf::localdir . "/" . cf::uniquedir;
90	mkdir $RANDOM_MAPS;
91	mkdir $BDB_ENV_DIR;
92		115
93	our $EMERGENCY_POSITION;	116	our $EMERGENCY_POSITION;
94		117
95	sub cf::map::normalise;	118	sub cf::map::normalise;
96		119
…		…
107	=item $cf::RUNTIME	130	=item $cf::RUNTIME
108		131
109	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
110	every server tick.	133	every server tick.
111		134
112	=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
113		138
114	The perl library directory, where extensions and cf-specific modules can	139	Various directories - "/etc", read-only install directory, perl-library
115	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.
116		143
117	=item $cf::NOW	144	=item $cf::NOW
118		145
119	The time of the last (current) server tick.	146	The time of the last (current) server tick.
120		147
121	=item $cf::TICK	148	=item $cf::TICK
122		149
123	The interval between server ticks, in seconds.	150	The interval between server ticks, in seconds.
124		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
125	=item %cf::CFG	162	=item %cf::CFG
126		163
127	Configuration for the server, loaded from C</etc/crossfire/config>, or	164	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
128	from wherever your confdir points to.	165	from wherever your confdir points to.
129		166
130	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	167	=item cf::wait_for_tick, cf::wait_for_tick_begin
131		168
132	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
133	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
134	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.
135	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.
136		178
137	=back	179	=back
138		180
139	=cut	181	=cut
140		182
141	BEGIN {	183	BEGIN {
142	*CORE::GLOBAL::warn = sub {	184	*CORE::GLOBAL::warn = sub {
143	my $msg = join "", @_;	185	my $msg = join "", @_;
144	utf8::encode $msg;
145		186
146	$msg .= "\n"	187	$msg .= "\n"
147	unless $msg =~ /\n$/;	188	unless $msg =~ /\n$/;
148		189
		190	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		191
149	LOG llevError, $msg;	192	LOG llevError, $msg;
150	};	193	};
151	}	194	}
		195
		196	$Coro::State::DIEHOOK = sub {
		197	warn Carp::longmess $_[0];
		198	Coro::terminate;
		199	};
152		200
153	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	201	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
154	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	202	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
155	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	203	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
156	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	204	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
157	@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';
158	@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)
159		208
160	# 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
161	# within the Safe compartment.	210	# within the Safe compartment.
162	for my $pkg (qw(	211	for my $pkg (qw(
163	cf::global cf::attachable	212	cf::global cf::attachable
…		…
168	)) {	217	)) {
169	no strict 'refs';	218	no strict 'refs';
170	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	219	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
171	}	220	}
172		221
173	$Event::DIED = sub {	222	$EV::DIED = sub {
174	warn "error in event callback: @_";	223	warn "error in event callback: @_";
175	};	224	};
		225
		226	#############################################################################
176		227
177	=head2 UTILITY FUNCTIONS	228	=head2 UTILITY FUNCTIONS
178		229
179	=over 4	230	=over 4
180		231
…		…
199	$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;
200	$d	251	$d
201	} || "[unable to dump $_[0]: '$@']";	252	} || "[unable to dump $_[0]: '$@']";
202	}	253	}
203		254
204	use JSON::Syck (); # TODO# replace by JSON::PC once working
205
206	=item $ref = cf::from_json $json	255	=item $ref = cf::decode_json $json
207		256
208	Converts a JSON string into the corresponding perl data structure.	257	Converts a JSON string into the corresponding perl data structure.
209		258
210	=cut
211
212	sub from_json($) {
213	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
214	JSON::Syck::Load $_[0]
215	}
216
217	=item $json = cf::to_json $ref	259	=item $json = cf::encode_json $ref
218		260
219	Converts a perl data structure into its JSON representation.	261	Converts a perl data structure into its JSON representation.
220		262
221	=cut	263	=cut
222		264
223	sub to_json($) {	265	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
224	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	266
225	JSON::Syck::Dump $_[0]	267	sub encode_json($) { $json_coder->encode ($_[0]) }
226	}	268	sub decode_json($) { $json_coder->decode ($_[0]) }
227		269
228	=item cf::lock_wait $string	270	=item cf::lock_wait $string
229		271
230	Wait until the given lock is available. See cf::lock_acquire.	272	Wait until the given lock is available. See cf::lock_acquire.
231		273
…		…
234	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
235	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,
236	for example when the coroutine gets canceled), the lock is automatically	278	for example when the coroutine gets canceled), the lock is automatically
237	returned.	279	returned.
238		280
		281	Locks are *not* recursive, locking from the same coro twice results in a
		282	deadlocked coro.
		283
239	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
240	uses map_find and cf::map::load uses map_load).	285	uses map_find and cf::map::load uses map_load).
241		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
242	=cut	291	=cut
243		292
244	our %LOCK;	293	our %LOCK;
		294	our %LOCKER;#d#
245		295
246	sub lock_wait($) {	296	sub lock_wait($) {
247	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#
248		303
249	# wait for lock, if any	304	# wait for lock, if any
250	while ($LOCK{$key}) {	305	while ($LOCK{$key}) {
251	push @{ $LOCK{$key} }, $Coro::current;	306	push @{ $LOCK{$key} }, $Coro::current;
252	Coro::schedule;	307	Coro::schedule;
…		…
258		313
259	# wait, to be sure we are not locked	314	# wait, to be sure we are not locked
260	lock_wait $key;	315	lock_wait $key;
261		316
262	$LOCK{$key} = [];	317	$LOCK{$key} = [];
		318	$LOCKER{$key} = $Coro::current;#d#
263		319
264	Coro::guard {	320	Coro::guard {
		321	delete $LOCKER{$key};#d#
265	# wake up all waiters, to be on the safe side	322	# wake up all waiters, to be on the safe side
266	$_->ready for @{ delete $LOCK{$key} };	323	$_->ready for @{ delete $LOCK{$key} };
267	}	324	}
268	}	325	}
269		326
		327	sub lock_active($) {
		328	my ($key) = @_;
		329
		330	! ! $LOCK{$key}
		331	}
		332
270	sub freeze_mainloop {	333	sub freeze_mainloop {
271	return unless $TICK_WATCHER->is_active;	334	return unless $TICK_WATCHER->is_active;
272		335
273	my $guard = Coro::guard {	336	my $guard = Coro::guard {
274	$TICK_WATCHER->start;	337	$TICK_WATCHER->start;
275	$WRITE_RUNTIME_WATCHER->start;
276	};	338	};
277	$WRITE_RUNTIME_WATCHER->stop;
278	$TICK_WATCHER->stop;	339	$TICK_WATCHER->stop;
279	$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;
280	}	414	}
281		415
282	=item cf::async { BLOCK }	416	=item cf::async { BLOCK }
283		417
284	Currently the same as Coro::async_pool, meaning you cannot use	418	Currently the same as Coro::async_pool, meaning you cannot use
…		…
289		423
290	BEGIN { *async = \&Coro::async_pool }	424	BEGIN { *async = \&Coro::async_pool }
291		425
292	=item cf::sync_job { BLOCK }	426	=item cf::sync_job { BLOCK }
293		427
294	The design of crossfire+ requires that the main coro ($Coro::main) is	428	The design of Deliantra requires that the main coroutine ($Coro::main)
295	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
296	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.
297		432
298	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
299	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
300	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
301	fast or be very important.	436	fast or be very important.
…		…
304		439
305	sub sync_job(&) {	440	sub sync_job(&) {
306	my ($job) = @_;	441	my ($job) = @_;
307		442
308	if ($Coro::current == $Coro::main) {	443	if ($Coro::current == $Coro::main) {
		444	my $time = EV::time;
		445
309	# this is the main coro, too bad, we have to block	446	# this is the main coro, too bad, we have to block
310	# till the operation succeeds, freezing the server :/	447	# till the operation succeeds, freezing the server :/
311		448
		449	LOG llevError, Carp::longmess "sync job";#d#
		450
312	# TODO: use suspend/resume instead	451	# TODO: use suspend/resume instead
313	# (but this is cancel-safe)	452	# (but this is cancel-safe)
314	my $freeze_guard = freeze_mainloop;	453	my $freeze_guard = freeze_mainloop;
315		454
316	my $busy = 1;	455	my $busy = 1;
317	my @res;	456	my @res;
318		457
319	(async {	458	(async {
		459	$Coro::current->desc ("sync job coro");
320	@res = eval { $job->() };	460	@res = eval { $job->() };
321	warn $@ if $@;	461	warn $@ if $@;
322	undef $busy;	462	undef $busy;
323	})->prio (Coro::PRIO_MAX);	463	})->prio (Coro::PRIO_MAX);
324		464
325	while ($busy) {	465	while ($busy) {
326	Coro::cede or Event::one_event;	466	if (Coro::nready) {
		467	Coro::cede_notself;
		468	} else {
		469	EV::loop EV::LOOP_ONESHOT;
327	}	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
328		479
329	wantarray ? @res : $res[0]	480	wantarray ? @res : $res[0]
330	} else {	481	} else {
331	# we are in another coroutine, how wonderful, everything just works	482	# we are in another coroutine, how wonderful, everything just works
332		483
…		…
352	$EXT_CORO{$coro+0} = $coro;	503	$EXT_CORO{$coro+0} = $coro;
353		504
354	$coro	505	$coro
355	}	506	}
356		507
357	sub write_runtime {	508	=item fork_call { }, $args
358	my $runtime = cf::localdir . "/runtime";
359		509
360	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	510	Executes the given code block with the given arguments in a seperate
361	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.
362		514
363	my $value = $cf::RUNTIME + 90 + 10;	515	=cut
364	# 10 is the runtime save interval, for a monotonic clock
365	# 60 allows for the watchdog to kill the server.
366		516
367	(aio_write $fh, 0, (length $value), $value, 0) <= 0	517	sub fork_call(&@) {
368	and return;	518	my ($cb, @args) = @_;
369		519
370	# always fsync - this file is important	520	# we seemingly have to make a local copy of the whole thing,
371	aio_fsync $fh	521	# otherwise perl prematurely frees the stuff :/
372	and return;	522	# TODO: investigate and fix (likely this will be rather laborious)
373		523
374	close $fh	524	my @res = Coro::Util::fork_eval {
375	or return;	525	reset_signals;
		526	&$cb
		527	}, @args;
376		528
377	aio_rename "$runtime~", $runtime	529	wantarray ? @res : $res[-1]
378	and return;	530	}
379		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
380	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 });
381	}	668	}
382		669
383	=back	670	=back
384		671
385	=cut	672	=cut
…		…
392	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")
393	to it. All such attachable objects support the following methods.	680	to it. All such attachable objects support the following methods.
394		681
395	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>
396	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
397	crossfire+).	684	Deliantra).
398		685
399	=over 4	686	=over 4
400		687
401	=item $attachable->attach ($attachment, key => $value...)	688	=item $attachable->attach ($attachment, key => $value...)
402		689
…		…
565	$registry = $CB_TYPE[$object_type] ||= [];	852	$registry = $CB_TYPE[$object_type] ||= [];
566		853
567	} elsif ($type eq "subtype") {	854	} elsif ($type eq "subtype") {
568	defined $object_type or Carp::croak "subtype specified without type";	855	defined $object_type or Carp::croak "subtype specified without type";
569	my $object_subtype = shift @arg;	856	my $object_subtype = shift @arg;
570	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	857	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
571		858
572	} elsif ($type eq "package") {	859	} elsif ($type eq "package") {
573	my $pkg = shift @arg;	860	my $pkg = shift @arg;
574		861
575	while (my ($name, $id) = each %cb_id) {	862	while (my ($name, $id) = each %cb_id) {
…		…
604	_attach $registry, $klass, @attach;	891	_attach $registry, $klass, @attach;
605	}	892	}
606		893
607	$obj->{$name} = \%arg;	894	$obj->{$name} = \%arg;
608	} else {	895	} else {
609	warn "object uses attachment '$name' that is not available, postponing.\n";	896	warn "object uses attachment '$name' which is not available, postponing.\n";
610	}	897	}
611		898
612	$obj->{_attachment}{$name} = undef;	899	$obj->{_attachment}{$name} = undef;
613	}	900	}
614		901
…		…
616	if (ref $_[0]) {	903	if (ref $_[0]) {
617	_object_attach @_;	904	_object_attach @_;
618	} else {	905	} else {
619	_attach shift->_attach_registry, @_;	906	_attach shift->_attach_registry, @_;
620	}	907	}
		908	_recalc_want;
621	};	909	};
622		910
623	# all those should be optimised	911	# all those should be optimised
624	sub cf::attachable::detach {	912	sub cf::attachable::detach {
625	my ($obj, $name) = @_;	913	my ($obj, $name) = @_;
…		…
628	delete $obj->{_attachment}{$name};	916	delete $obj->{_attachment}{$name};
629	reattach ($obj);	917	reattach ($obj);
630	} else {	918	} else {
631	Carp::croak "cannot, currently, detach class attachments";	919	Carp::croak "cannot, currently, detach class attachments";
632	}	920	}
		921	_recalc_want;
633	};	922	};
634		923
635	sub cf::attachable::attached {	924	sub cf::attachable::attached {
636	my ($obj, $name) = @_;	925	my ($obj, $name) = @_;
637		926
…		…
652	";	941	";
653	die if $@;	942	die if $@;
654	}	943	}
655		944
656	our $override;	945	our $override;
657	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?
658		947
659	sub override {	948	sub override {
660	$override = 1;	949	$override = 1;
661	@invoke_results = ();	950	@INVOKE_RESULTS = (@_);
662	}	951	}
663		952
664	sub do_invoke {	953	sub do_invoke {
665	my $event = shift;	954	my $event = shift;
666	my $callbacks = shift;	955	my $callbacks = shift;
667		956
668	@invoke_results = ();	957	@INVOKE_RESULTS = ();
669		958
670	local $override;	959	local $override;
671		960
672	for (@$callbacks) {	961	for (@$callbacks) {
673	eval { &{$_->[1]} };	962	eval { &{$_->[1]} };
…		…
682	}	971	}
683		972
684	0	973	0
685	}	974	}
686		975
687	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	976	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
688		977
689	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	978	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
690		979
691	Generate an object-specific event with the given arguments.	980	Generate an object-specific event with the given arguments.
692		981
693	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
694	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
695	results (if you must, access C<@cf::invoke_results> directly).	984	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
696		985
697	=back	986	=back
698		987
699	=cut	988	=cut
700		989
701	#############################################################################	990	#############################################################################
702	# 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	}
703		1034
704	sub reattach {	1035	sub reattach {
705	# basically do the same as instantiate, without calling instantiate	1036	# basically do the same as instantiate, without calling instantiate
706	my ($obj) = @_;	1037	my ($obj) = @_;
707		1038
…		…
728	cf::attachable->attach (	1059	cf::attachable->attach (
729	prio => -1000000,	1060	prio => -1000000,
730	on_instantiate => sub {	1061	on_instantiate => sub {
731	my ($obj, $data) = @_;	1062	my ($obj, $data) = @_;
732		1063
733	$data = from_json $data;	1064	$data = decode_json $data;
734		1065
735	for (@$data) {	1066	for (@$data) {
736	my ($name, $args) = @$_;	1067	my ($name, $args) = @$_;
737		1068
738	$obj->attach ($name, %{$args || {} });	1069	$obj->attach ($name, %{$args || {} });
…		…
754	sub object_freezer_save {	1085	sub object_freezer_save {
755	my ($filename, $rdata, $objs) = @_;	1086	my ($filename, $rdata, $objs) = @_;
756		1087
757	sync_job {	1088	sync_job {
758	if (length $$rdata) {	1089	if (length $$rdata) {
		1090	utf8::decode (my $decname = $filename);
759	warn sprintf "saving %s (%d,%d)\n",	1091	warn sprintf "saving %s (%d,%d)\n",
760	$filename, length $$rdata, scalar @$objs;	1092	$decname, length $$rdata, scalar @$objs;
761		1093
762	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1094	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
763	chmod SAVE_MODE, $fh;	1095	chmod SAVE_MODE, $fh;
764	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1096	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
765	aio_fsync $fh if $cf::USE_FSYNC;	1097	aio_fsync $fh if $cf::USE_FSYNC;
766	close $fh;	1098	close $fh;
767		1099
768	if (@$objs) {	1100	if (@$objs) {
769	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) {
770	chmod SAVE_MODE, $fh;	1102	chmod SAVE_MODE, $fh;
771	my $data = Storable::nfreeze { version => 1, objs => $objs };	1103	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
772	aio_write $fh, 0, (length $data), $data, 0;	1104	aio_write $fh, 0, (length $data), $data, 0;
773	aio_fsync $fh if $cf::USE_FSYNC;	1105	aio_fsync $fh if $cf::USE_FSYNC;
774	close $fh;	1106	close $fh;
775	aio_rename "$filename.pst~", "$filename.pst";	1107	aio_rename "$filename.pst~", "$filename.pst";
776	}	1108	}
…		…
784	}	1116	}
785	} else {	1117	} else {
786	aio_unlink $filename;	1118	aio_unlink $filename;
787	aio_unlink "$filename.pst";	1119	aio_unlink "$filename.pst";
788	}	1120	}
789
790	#d##TODO# nuke non .map-files if exist
791	if ($filename =~ s/\.map$//) {
792	aio_unlink $filename;
793	aio_unlink "$filename.pst";
794	}
795	}	1121	};
796	}	1122	}
797		1123
798	sub object_freezer_as_string {	1124	sub object_freezer_as_string {
799	my ($rdata, $objs) = @_;	1125	my ($rdata, $objs) = @_;
800		1126
…		…
805		1131
806	sub object_thawer_load {	1132	sub object_thawer_load {
807	my ($filename) = @_;	1133	my ($filename) = @_;
808		1134
809	my ($data, $av);	1135	my ($data, $av);
810
811	#d#TODO remove .map if file does not exist
812	aio_stat $filename and $filename =~ s/\.map$//;
813		1136
814	(aio_load $filename, $data) >= 0	1137	(aio_load $filename, $data) >= 0
815	or return;	1138	or return;
816		1139
817	unless (aio_stat "$filename.pst") {	1140	unless (aio_stat "$filename.pst") {
818	(aio_load "$filename.pst", $av) >= 0	1141	(aio_load "$filename.pst", $av) >= 0
819	or return;	1142	or return;
		1143
820	$av = eval { (Storable::thaw $av)->{objs} };	1144	my $st = eval { Coro::Storable::thaw $av };
		1145	$av = $st->{objs};
821	}	1146	}
822		1147
		1148	utf8::decode (my $decname = $filename);
823	warn sprintf "loading %s (%d)\n",	1149	warn sprintf "loading %s (%d,%d)\n",
824	$filename, length $data, scalar @{$av || []};#d#	1150	$decname, length $data, scalar @{$av || []};
		1151
825	return ($data, $av);	1152	($data, $av)
826	}	1153	}
		1154
		1155	=head2 COMMAND CALLBACKS
		1156
		1157	=over 4
		1158
		1159	=cut
827		1160
828	#############################################################################	1161	#############################################################################
829	# command handling &c	1162	# command handling &c
830		1163
831	=item cf::register_command $name => \&callback($ob,$args);	1164	=item cf::register_command $name => \&callback($ob,$args);
…		…
844	push @{ $COMMAND{$name} }, [$caller, $cb];	1177	push @{ $COMMAND{$name} }, [$caller, $cb];
845	}	1178	}
846		1179
847	=item cf::register_extcmd $name => \&callback($pl,$packet);	1180	=item cf::register_extcmd $name => \&callback($pl,$packet);
848		1181
849	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.
850		1187
851	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
852	called.	1189	called.
853		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
854	=cut	1202	=cut
855		1203
856	sub register_extcmd {	1204	sub register_extcmd {
857	my ($name, $cb) = @_;	1205	my ($name, $cb) = @_;
858		1206
859	$EXTCMD{$name} = $cb;	1207	$EXTCMD{$name} = $cb;
		1208	}
		1209
		1210	sub register_exticmd {
		1211	my ($name, $cb) = @_;
		1212
		1213	$EXTICMD{$name} = $cb;
860	}	1214	}
861		1215
862	cf::player->attach (	1216	cf::player->attach (
863	on_command => sub {	1217	on_command => sub {
864	my ($pl, $name, $params) = @_;	1218	my ($pl, $name, $params) = @_;
…		…
873	cf::override;	1227	cf::override;
874	},	1228	},
875	on_extcmd => sub {	1229	on_extcmd => sub {
876	my ($pl, $buf) = @_;	1230	my ($pl, $buf) = @_;
877		1231
878	my $msg = eval { from_json $buf };	1232	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
879		1233
880	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
881	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1242	if (my $cb = $EXTCMD{$type}) {
882	if (my %reply = $cb->($pl, $msg)) {	1243	@reply = $cb->($pl, @payload);
883	$pl->ext_reply ($msg->{msgid}, %reply);
884	}
885	}	1244	}
		1245
		1246	$pl->ext_reply ($reply, @reply)
		1247	if $reply;
		1248
886	} else {	1249	} else {
887	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1250	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
888	}	1251	}
889		1252
890	cf::override;	1253	cf::override;
891	},	1254	},
892	);	1255	);
893		1256
894	sub load_extension {
895	my ($path) = @_;
896
897	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
898	my $base = $1;
899	my $pkg = $1;
900	$pkg =~ s/[^[:word:]]/_/g;
901	$pkg = "ext::$pkg";
902
903	warn "... loading '$path' into '$pkg'\n";
904
905	open my $fh, "<:utf8", $path
906	or die "$path: $!";
907
908	my $source =
909	"package $pkg; use strict; use utf8;\n"
910	. "#line 1 \"$path\"\n{\n"
911	. (do { local $/; <$fh> })
912	. "\n};\n1";
913
914	unless (eval $source) {
915	my $msg = $@ ? "$path: $@\n"
916	: "extension disabled.\n";
917	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
918	warn $@;
919	warn "mandatory extension failed to load, exiting.\n";
920	exit 1;
921	}
922	die $@;
923	}
924
925	push @EXTS, $pkg;
926	}
927
928	sub load_extensions {	1257	sub load_extensions {
		1258	cf::sync_job {
		1259	my %todo;
		1260
929	for my $ext (<$LIBDIR/*.ext>) {	1261	for my $path (<$LIBDIR/*.ext>) {
930	next unless -r $ext;	1262	next unless -r $path;
931	eval {	1263
932	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;
933	1	1321	}
934	} or warn "$ext not loaded: $@";	1322
		1323	skip:
		1324	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1325	unless $progress;
		1326	}
935	}	1327	};
936	}	1328	}
937		1329
938	#############################################################################	1330	#############################################################################
939		1331
		1332	=back
		1333
940	=head2 CORE EXTENSIONS	1334	=head2 CORE EXTENSIONS
941		1335
942	Functions and methods that extend core crossfire objects.	1336	Functions and methods that extend core crossfire objects.
943		1337
944	=cut	1338	=cut
…		…
949		1343
950	=head3 cf::player	1344	=head3 cf::player
951		1345
952	=over 4	1346	=over 4
953		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
954	=item cf::player::find $login	1362	=item cf::player::find $login
955		1363
956	Returns the given player object, loading it if necessary (might block).	1364	Returns the given player object, loading it if necessary (might block).
957		1365
958	=cut	1366	=cut
959		1367
960	sub playerdir($) {	1368	sub playerdir($) {
961	cf::localdir	1369	"$PLAYERDIR/"
962	. "/"
963	. cf::playerdir
964	. "/"
965	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1370	. (ref $_[0] ? $_[0]->ob->name : $_[0])
966	}	1371	}
967		1372
968	sub path($) {	1373	sub path($) {
969	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1374	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
970		1375
971	(playerdir $login) . "/$login.pl"	1376	(playerdir $login) . "/playerdata"
972	}	1377	}
973		1378
974	sub find_active($) {	1379	sub find_active($) {
975	$cf::PLAYER{$_[0]}	1380	$cf::PLAYER{$_[0]}
976	and $cf::PLAYER{$_[0]}->active	1381	and $cf::PLAYER{$_[0]}->active
…		…
989	my $login = $_[0];	1394	my $login = $_[0];
990		1395
991	my $guard = cf::lock_acquire "user_find:$login";	1396	my $guard = cf::lock_acquire "user_find:$login";
992		1397
993	$cf::PLAYER{$_[0]} || do {	1398	$cf::PLAYER{$_[0]} || do {
994	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
995	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;
996	$cf::PLAYER{$login} = $pl	1413	$cf::PLAYER{$login} = $pl
997	}	1414	}
998	}	1415	}
999	}	1416	}
1000		1417
…		…
1010		1427
1011	aio_mkdir playerdir $pl, 0770;	1428	aio_mkdir playerdir $pl, 0770;
1012	$pl->{last_save} = $cf::RUNTIME;	1429	$pl->{last_save} = $cf::RUNTIME;
1013		1430
1014	$pl->save_pl ($path);	1431	$pl->save_pl ($path);
1015	Coro::cede;	1432	cf::cede_to_tick;
1016	}	1433	}
1017		1434
1018	sub new($) {	1435	sub new($) {
1019	my ($login) = @_;	1436	my ($login) = @_;
1020		1437
…		…
1026	$cf::PLAYER{$login} = $self;	1443	$cf::PLAYER{$login} = $self;
1027		1444
1028	$self	1445	$self
1029	}	1446	}
1030		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
1031	=item $pl->quit_character	1458	=item $pl->quit_character
1032		1459
1033	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
1034	be destroyed. May block for a long time.	1461	be destroyed. May block for a long time.
1035		1462
1036	=cut	1463	=cut
1037		1464
1038	sub quit_character {	1465	sub quit_character {
1039	my ($pl) = @_;	1466	my ($pl) = @_;
		1467
		1468	my $name = $pl->ob->name;
1040		1469
1041	$pl->{deny_save} = 1;	1470	$pl->{deny_save} = 1;
1042	$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
1043		1472
1044	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1473	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1049	my $path = playerdir $pl;	1478	my $path = playerdir $pl;
1050	my $temp = "$path~$cf::RUNTIME~deleting~";	1479	my $temp = "$path~$cf::RUNTIME~deleting~";
1051	aio_rename $path, $temp;	1480	aio_rename $path, $temp;
1052	delete $cf::PLAYER{$pl->ob->name};	1481	delete $cf::PLAYER{$pl->ob->name};
1053	$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
1054	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;
1055	}	1504	}
1056		1505
1057	=item cf::player::list_logins	1506	=item cf::player::list_logins
1058		1507
1059	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
1060	while and may block, so not sync_job-capable, ever.	1509	while and may block, so not sync_job-capable, ever.
1061		1510
1062	=cut	1511	=cut
1063		1512
1064	sub list_logins {	1513	sub list_logins {
1065	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1514	my $dirs = aio_readdir $PLAYERDIR
1066	or return [];	1515	or return [];
1067		1516
1068	my @logins;	1517	my @logins;
1069		1518
1070	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") {
1071	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1524	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1072	aio_read $fh, 0, 512, my $buf, 0 or next;	1525	aio_read $fh, 0, 512, my $buf, 0 or next;
1073	$buf !~ /^password -------------$/m or next; # official not-valid tag	1526	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1527	}
1074		1528
1075	utf8::decode $login;	1529	utf8::decode $login;
1076	push @logins, $login;	1530	push @logins, $login;
1077	}	1531	}
1078		1532
…		…
1105	}	1559	}
1106		1560
1107	\@paths	1561	\@paths
1108	}	1562	}
1109		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
1110	=item $player->ext_reply ($msgid, $msgtype, %msg)	1657	=item $player->ext_reply ($msgid, @msg)
1111		1658
1112	Sends an ext reply to the player.	1659	Sends an ext reply to the player.
1113		1660
1114	=cut	1661	=cut
1115		1662
1116	sub ext_reply($$$%) {	1663	sub ext_reply($$@) {
1117	my ($self, $id, %msg) = @_;	1664	my ($self, $id, @msg) = @_;
1118		1665
1119	$msg{msgid} = $id;	1666	$self->ns->ext_reply ($id, @msg)
1120
1121	$self->send ("ext " . cf::to_json \%msg);
1122	}	1667	}
1123		1668
1124	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	}
1125		1709
1126	=back	1710	=back
1127
1128		1711
1129	=head3 cf::map	1712	=head3 cf::map
1130		1713
1131	=over 4	1714	=over 4
1132		1715
…		…
1187	my ($self, $merge) = @_;	1770	my ($self, $merge) = @_;
1188		1771
1189	# we have to keep some variables in memory intact	1772	# we have to keep some variables in memory intact
1190	local $self->{path};	1773	local $self->{path};
1191	local $self->{load_path};	1774	local $self->{load_path};
1192	local $self->{deny_save};
1193	local $self->{deny_reset};
1194		1775
1195	$self->SUPER::thawer_merge ($merge);	1776	$self->SUPER::thawer_merge ($merge);
1196	}	1777	}
1197		1778
1198	sub normalise {	1779	sub normalise {
…		…
1245	$self->init; # pass $1 etc.	1826	$self->init; # pass $1 etc.
1246	return $self;	1827	return $self;
1247	}	1828	}
1248	}	1829	}
1249		1830
1250	Carp::carp "unable to resolve path '$path' (base '$base').";	1831	Carp::cluck "unable to resolve path '$path' (base '$base').";
1251	()	1832	()
1252	}	1833	}
1253		1834
1254	sub init {	1835	sub init {
1255	my ($self) = @_;	1836	my ($self) = @_;
…		…
1270		1851
1271	# the original (read-only) location	1852	# the original (read-only) location
1272	sub load_path {	1853	sub load_path {
1273	my ($self) = @_;	1854	my ($self) = @_;
1274		1855
1275	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1856	"$MAPDIR/$self->{path}.map"
1276	}	1857	}
1277		1858
1278	# the temporary/swap location	1859	# the temporary/swap location
1279	sub save_path {	1860	sub save_path {
1280	my ($self) = @_;	1861	my ($self) = @_;
1281		1862
1282	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1863	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1283	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1864	"$TMPDIR/$path.map"
1284	}	1865	}
1285		1866
1286	# the unique path, undef == no special unique path	1867	# the unique path, undef == no special unique path
1287	sub uniq_path {	1868	sub uniq_path {
1288	my ($self) = @_;	1869	my ($self) = @_;
1289		1870
1290	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1871	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1291	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1872	"$UNIQUEDIR/$path"
1292	}	1873	}
1293		1874
1294	# and all this just because we cannot iterate over	1875	# and all this just because we cannot iterate over
1295	# all maps in C++...	1876	# all maps in C++...
1296	sub change_all_map_light {	1877	sub change_all_map_light {
…		…
1298		1879
1299	$_->change_map_light ($change)	1880	$_->change_map_light ($change)
1300	for grep $_->outdoor, values %cf::MAP;	1881	for grep $_->outdoor, values %cf::MAP;
1301	}	1882	}
1302		1883
		1884	sub decay_objects {
		1885	my ($self) = @_;
		1886
		1887	return if $self->{deny_reset};
		1888
		1889	$self->do_decay_objects;
		1890	}
		1891
1303	sub unlink_save {	1892	sub unlink_save {
1304	my ($self) = @_;	1893	my ($self) = @_;
1305		1894
1306	utf8::encode (my $save = $self->save_path);	1895	utf8::encode (my $save = $self->save_path);
1307	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1896	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1308	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";	1897	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1309
1310	#d#TODO remove .map and also nuke
1311	$save =~ s/\.map// or return;#d#
1312	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1313	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1314	}	1898	}
1315		1899
1316	sub load_header_from($) {	1900	sub load_header_from($) {
1317	my ($self, $path) = @_;	1901	my ($self, $path) = @_;
1318		1902
1319	utf8::encode $path;	1903	utf8::encode $path;
1320	#aio_open $path, O_RDONLY, 0	1904	my $f = new_from_file cf::object::thawer $path
1321	# or return;
1322
1323	$self->_load_header ($path)
1324	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;
1325		1912
1326	$self->{load_path} = $path;	1913	$self->{load_path} = $path;
1327		1914
1328	1	1915	1
1329	}	1916	}
…		…
1368	$self->load_header_orig	1955	$self->load_header_orig
1369	or return;	1956	or return;
1370	$self->prepare_orig;	1957	$self->prepare_orig;
1371	}	1958	}
1372		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
1373	1	1966	1
1374	}	1967	}
1375		1968
1376	sub find;	1969	sub find;
1377	sub find {	1970	sub find {
1378	my ($path, $origin) = @_;	1971	my ($path, $origin) = @_;
1379		1972
1380	$path = normalise $path, $origin && $origin->path;	1973	$path = normalise $path, $origin && $origin->path;
1381		1974
		1975	cf::lock_wait "map_data:$path";#d#remove
1382	cf::lock_wait "map_find:$path";	1976	cf::lock_wait "map_find:$path";
1383		1977
1384	$cf::MAP{$path} || do {	1978	$cf::MAP{$path} || do {
1385	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
1386	my $map = new_from_path cf::map $path	1982	my $map = new_from_path cf::map $path
1387	or return;	1983	or return;
1388		1984
1389	$map->{last_save} = $cf::RUNTIME;	1985	$map->{last_save} = $cf::RUNTIME;
1390		1986
1391	$map->load_header	1987	$map->load_header
1392	or return;	1988	or return;
1393		1989
1394	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1990	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1395	# doing this can freeze the server in a sync job, obviously	1991	# doing this can freeze the server in a sync job, obviously
1396	#$cf::WAIT_FOR_TICK->wait;	1992	#$cf::WAIT_FOR_TICK->wait;
		1993	undef $guard1;
		1994	undef $guard2;
1397	$map->reset;	1995	$map->reset;
1398	undef $guard;
1399	return find $path;	1996	return find $path;
1400	}	1997	}
1401		1998
1402	$cf::MAP{$path} = $map	1999	$cf::MAP{$path} = $map
1403	}	2000	}
…		…
1410	my ($self) = @_;	2007	my ($self) = @_;
1411		2008
1412	local $self->{deny_reset} = 1; # loading can take a long time	2009	local $self->{deny_reset} = 1; # loading can take a long time
1413		2010
1414	my $path = $self->{path};	2011	my $path = $self->{path};
		2012
		2013	{
1415	my $guard = cf::lock_acquire "map_load:$path";	2014	my $guard = cf::lock_acquire "map_data:$path";
1416		2015
		2016	return unless $self->valid;
1417	return if $self->in_memory != cf::MAP_SWAPPED;	2017	return unless $self->in_memory == cf::MAP_SWAPPED;
1418		2018
1419	$self->in_memory (cf::MAP_LOADING);	2019	$self->in_memory (cf::MAP_LOADING);
1420		2020
1421	$self->alloc;	2021	$self->alloc;
1422		2022
1423	$self->pre_load;	2023	$self->pre_load;
		2024	cf::cede_to_tick;
1424		2025
1425	$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)
1426	or return;	2029	or return;
1427		2030
1428	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2031	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1429	if delete $self->{load_original};	2032	if delete $self->{load_original};
1430		2033
1431	if (my $uniq = $self->uniq_path) {	2034	if (my $uniq = $self->uniq_path) {
1432	utf8::encode $uniq;	2035	utf8::encode $uniq;
1433	if (aio_open $uniq, O_RDONLY, 0) {	2036	unless (aio_stat $uniq) {
		2037	if (my $f = new_from_file cf::object::thawer $uniq) {
1434	$self->clear_unique_items;	2038	$self->clear_unique_items;
1435	$self->_load_objects ($uniq, 0);	2039	$self->_load_objects ($f);
		2040	$f->resolve_delayed_derefs;
		2041	}
1436	}	2042	}
1437	}	2043	}
1438		2044
1439	Coro::cede;	2045	$f->resolve_delayed_derefs;
1440		2046
		2047	cf::cede_to_tick;
1441	# now do the right thing for maps	2048	# now do the right thing for maps
1442	$self->link_multipart_objects;	2049	$self->link_multipart_objects;
1443
1444	unless ($self->{deny_activate}) {
1445	$self->decay_objects;
1446	$self->fix_auto_apply;
1447	$self->update_buttons;
1448	Coro::cede;
1449	$self->set_darkness_map;
1450	$self->difficulty ($self->estimate_difficulty)	2050	$self->difficulty ($self->estimate_difficulty)
1451	unless $self->difficulty;	2051	unless $self->difficulty;
1452	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;
1453	$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);
1454	}	2068	}
1455		2069
1456	$self->post_load;	2070	$self->post_load;
1457
1458	$self->in_memory (cf::MAP_IN_MEMORY);
1459	}	2071	}
1460		2072
1461	sub customise_for {	2073	sub customise_for {
1462	my ($self, $ob) = @_;	2074	my ($self, $ob) = @_;
1463		2075
1464	return find "~" . $ob->name . "/" . $self->{path}	2076	return find "~" . $ob->name . "/" . $self->{path}
1465	if $self->per_player;	2077	if $self->per_player;
1466		2078
		2079	# return find "?party/" . $ob->name . "/" . $self->{path}
		2080	# if $self->per_party;
		2081
1467	$self	2082	$self
1468	}	2083	}
1469		2084
1470	# 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
1471	sub load_diag {	2086	sub load_neighbours {
1472	my ($map) = @_;	2087	my ($map) = @_;
1473		2088
1474	my @diag; # diagonal neighbours	2089	my @neigh; # diagonal neighbours
1475		2090
1476	for (0 .. 3) {	2091	for (0 .. 3) {
1477	my $neigh = $map->tile_path ($_)	2092	my $neigh = $map->tile_path ($_)
1478	or next;	2093	or next;
1479	$neigh = find $neigh, $map	2094	$neigh = find $neigh, $map
1480	or next;	2095	or next;
1481	$neigh->load;	2096	$neigh->load;
1482		2097
		2098	push @neigh,
1483	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2099	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1484	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2100	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1485	}	2101	}
1486		2102
1487	for (@diag) {	2103	for (grep defined $_->[0], @neigh) {
		2104	my ($path, $origin) = @$_;
1488	my $neigh = find @$_	2105	my $neigh = find $path, $origin
1489	or next;	2106	or next;
1490	$neigh->load;	2107	$neigh->load;
1491	}	2108	}
1492	}	2109	}
1493		2110
…		…
1498	}	2115	}
1499		2116
1500	sub do_load_sync {	2117	sub do_load_sync {
1501	my ($map) = @_;	2118	my ($map) = @_;
1502		2119
		2120	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2121	if $Coro::current == $Coro::main;
		2122
1503	cf::sync_job { $map->load };	2123	cf::sync_job { $map->load };
1504	}	2124	}
1505		2125
1506	our %MAP_PREFETCH;	2126	our %MAP_PREFETCH;
1507	our $MAP_PREFETCHER = undef;	2127	our $MAP_PREFETCHER = undef;
1508		2128
1509	sub find_async {	2129	sub find_async {
1510	my ($path, $origin) = @_;	2130	my ($path, $origin, $load) = @_;
1511		2131
1512	$path = normalise $path, $origin && $origin->{path};	2132	$path = normalise $path, $origin && $origin->{path};
1513		2133
1514	if (my $map = $cf::MAP{$path}) {	2134	if (my $map = $cf::MAP{$path}) {
1515	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2135	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1516	}	2136	}
1517		2137
1518	undef $MAP_PREFETCH{$path};	2138	$MAP_PREFETCH{$path} |= $load;
		2139
1519	$MAP_PREFETCHER ||= cf::async {	2140	$MAP_PREFETCHER ||= cf::async {
		2141	$Coro::current->{desc} = "map prefetcher";
		2142
1520	while (%MAP_PREFETCH) {	2143	while (%MAP_PREFETCH) {
1521	for my $path (keys %MAP_PREFETCH) {	2144	while (my ($k, $v) = each %MAP_PREFETCH) {
1522	my $map = find $path	2145	if (my $map = find $k) {
1523	or next;
1524	$map->load;	2146	$map->load if $v;
		2147	}
1525		2148
1526	delete $MAP_PREFETCH{$path};	2149	delete $MAP_PREFETCH{$k};
1527	}	2150	}
1528	}	2151	}
1529	undef $MAP_PREFETCHER;	2152	undef $MAP_PREFETCHER;
1530	};	2153	};
1531	$MAP_PREFETCHER->prio (6);	2154	$MAP_PREFETCHER->prio (6);
…		…
1534	}	2157	}
1535		2158
1536	sub save {	2159	sub save {
1537	my ($self) = @_;	2160	my ($self) = @_;
1538		2161
1539	my $lock = cf::lock_acquire "map_data:" . $self->path;	2162	my $lock = cf::lock_acquire "map_data:$self->{path}";
1540		2163
1541	$self->{last_save} = $cf::RUNTIME;	2164	$self->{last_save} = $cf::RUNTIME;
1542		2165
1543	return unless $self->dirty;	2166	return unless $self->dirty;
1544		2167
…		…
1550	return if $self->{deny_save};	2173	return if $self->{deny_save};
1551		2174
1552	local $self->{last_access} = $self->last_access;#d#	2175	local $self->{last_access} = $self->last_access;#d#
1553		2176
1554	cf::async {	2177	cf::async {
		2178	$Coro::current->{desc} = "map player save";
1555	$_->contr->save for $self->players;	2179	$_->contr->save for $self->players;
1556	};	2180	};
1557		2181
1558	if ($uniq) {	2182	if ($uniq) {
1559	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2183	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
…		…
1567	my ($self) = @_;	2191	my ($self) = @_;
1568		2192
1569	# save first because save cedes	2193	# save first because save cedes
1570	$self->save;	2194	$self->save;
1571		2195
1572	my $lock = cf::lock_acquire "map_data:" . $self->path;	2196	my $lock = cf::lock_acquire "map_data:$self->{path}";
1573		2197
1574	return if $self->players;	2198	return if $self->players;
1575	return if $self->in_memory != cf::MAP_IN_MEMORY;	2199	return if $self->in_memory != cf::MAP_IN_MEMORY;
1576	return if $self->{deny_save};	2200	return if $self->{deny_save};
1577		2201
		2202	$self->in_memory (cf::MAP_SWAPPED);
		2203
		2204	$self->deactivate;
		2205	$_->clear_links_to ($self) for values %cf::MAP;
1578	$self->clear;	2206	$self->clear;
1579	$self->in_memory (cf::MAP_SWAPPED);
1580	}	2207	}
1581		2208
1582	sub reset_at {	2209	sub reset_at {
1583	my ($self) = @_;	2210	my ($self) = @_;
1584		2211
1585	# TODO: safety, remove and allow resettable per-player maps	2212	# TODO: safety, remove and allow resettable per-player maps
1586	return 1e99 if $self->isa ("ext::map_per_player");#d#
1587	return 1e99 if $self->{deny_reset};	2213	return 1e99 if $self->{deny_reset};
1588		2214
1589	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2215	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1590	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;
1591		2217
…		…
1602	my ($self) = @_;	2228	my ($self) = @_;
1603		2229
1604	my $lock = cf::lock_acquire "map_data:$self->{path}";	2230	my $lock = cf::lock_acquire "map_data:$self->{path}";
1605		2231
1606	return if $self->players;	2232	return if $self->players;
1607	return if $self->isa ("ext::map_per_player");#d#
1608		2233
1609	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	}
1610		2245
1611	delete $cf::MAP{$self->path};	2246	delete $cf::MAP{$self->path};
1612		2247
1613	$self->in_memory (cf::MAP_SWAPPED);	2248	$self->deactivate;
		2249	$_->clear_links_to ($self) for values %cf::MAP;
1614	$self->clear;	2250	$self->clear;
1615
1616	$_->clear_links_to ($self) for values %cf::MAP;
1617		2251
1618	$self->unlink_save;	2252	$self->unlink_save;
1619	$self->destroy;	2253	$self->destroy;
1620	}	2254	}
1621		2255
1622	my $nuke_counter = "aaaa";	2256	my $nuke_counter = "aaaa";
1623		2257
1624	sub nuke {	2258	sub nuke {
1625	my ($self) = @_;	2259	my ($self) = @_;
1626		2260
		2261	{
		2262	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2263
1627	delete $cf::MAP{$self->path};	2264	delete $cf::MAP{$self->path};
1628		2265
1629	$self->unlink_save;	2266	$self->unlink_save;
1630		2267
1631	bless $self, "cf::map";	2268	bless $self, "cf::map";
1632	delete $self->{deny_reset};	2269	delete $self->{deny_reset};
1633	$self->{deny_save} = 1;	2270	$self->{deny_save} = 1;
1634	$self->reset_timeout (1);	2271	$self->reset_timeout (1);
1635	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2272	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1636		2273
1637	$cf::MAP{$self->path} = $self;	2274	$cf::MAP{$self->path} = $self;
		2275	}
1638		2276
1639	$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	]
1640	}	2314	}
1641		2315
1642	=item cf::map::unique_maps	2316	=item cf::map::unique_maps
1643		2317
1644	Returns an arrayref of paths of all shared maps that have	2318	Returns an arrayref of paths of all shared maps that have
1645	instantiated unique items. May block.	2319	instantiated unique items. May block.
1646		2320
1647	=cut	2321	=cut
1648		2322
1649	sub unique_maps() {	2323	sub unique_maps() {
1650	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2324	[
1651	or return;	2325	map {
1652
1653	my @paths;
1654
1655	for (@$files) {
1656	utf8::decode $_;	2326	utf8::decode $_;
1657	next if /\.pst$/;	2327	/\.map$/
1658	next unless /^$PATH_SEP/o;	2328	? normalise $_
1659		2329	: ()
1660	push @paths, cf::map::normalise $_;	2330	} @{ aio_readdir $UNIQUEDIR or [] }
1661	}	2331	]
1662
1663	\@paths
1664	}	2332	}
1665		2333
1666	package cf;	2334	package cf;
1667		2335
1668	=back	2336	=back
…		…
1686	map { $_, inv_recursive_ $_->inv } @_	2354	map { $_, inv_recursive_ $_->inv } @_
1687	}	2355	}
1688		2356
1689	sub inv_recursive {	2357	sub inv_recursive {
1690	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	}
1691	}	2387	}
1692		2388
1693	package cf;	2389	package cf;
1694		2390
1695	=back	2391	=back
…		…
1714		2410
1715	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2411	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1716		2412
1717	if ($self->{record_replies}) {	2413	if ($self->{record_replies}) {
1718	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2414	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2415
1719	} 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 {
1720	$msg = $npc->name . " says: $msg" if $npc;	2424	$msg = $npc->name . " says: $msg" if $npc;
1721	$self->message ($msg, $flags);	2425	$self->message ($msg, $flags);
		2426	}
1722	}	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 (@_);
1723	}	2438	}
1724		2439
1725	=item $player_object->may ("access")	2440	=item $player_object->may ("access")
1726		2441
1727	Returns wether the given player is authorized to access resource "access"	2442	Returns wether the given player is authorized to access resource "access"
…		…
1774	$self->deactivate_recursive;	2489	$self->deactivate_recursive;
1775		2490
1776	return if UNIVERSAL::isa $self->map, "ext::map_link";	2491	return if UNIVERSAL::isa $self->map, "ext::map_link";
1777		2492
1778	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2493	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1779	if $self->map;	2494	if $self->map && $self->map->{path} ne "{link}";
1780		2495
1781	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2496	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1782	}	2497	}
1783		2498
1784	sub cf::object::player::leave_link {	2499	sub cf::object::player::leave_link {
1785	my ($self, $map, $x, $y) = @_;	2500	my ($self, $map, $x, $y) = @_;
		2501
		2502	return unless $self->contr->active;
1786		2503
1787	my $link_pos = delete $self->{_link_pos};	2504	my $link_pos = delete $self->{_link_pos};
1788		2505
1789	unless ($map) {	2506	unless ($map) {
1790	# restore original map position	2507	# restore original map position
…		…
1804	# use -1 or undef as default coordinates, not 0, 0	2521	# use -1 or undef as default coordinates, not 0, 0
1805	($x, $y) = ($map->enter_x, $map->enter_y)	2522	($x, $y) = ($map->enter_x, $map->enter_y)
1806	if $x <=0 && $y <= 0;	2523	if $x <=0 && $y <= 0;
1807		2524
1808	$map->load;	2525	$map->load;
1809	$map->load_diag;	2526	$map->load_neighbours;
1810		2527
1811	return unless $self->contr->active;	2528	return unless $self->contr->active;
1812	$self->activate_recursive;	2529	$self->activate_recursive;
		2530
		2531	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1813	$self->enter_map ($map, $x, $y);	2532	$self->enter_map ($map, $x, $y);
1814	}	2533	}
1815		2534
1816	cf::player->attach (	2535	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1817	on_logout => sub {
1818	my ($pl) = @_;
1819		2536
1820	# abort map switching before logout	2537	Moves the player to the given map-path and coordinates by first freezing
1821	if ($pl->ob->{_link_pos}) {	2538	her, loading and preparing them map, calling the provided $check callback
1822	cf::sync_job {	2539	that has to return the map if sucecssful, and then unfreezes the player on
1823	$pl->ob->leave_link	2540	the new (success) or old (failed) map position. In either case, $done will
1824	};	2541	be called at the end of this process.
1825	}
1826	},
1827	on_login => sub {
1828	my ($pl) = @_;
1829		2542
1830	# try to abort aborted map switching on player login :)
1831	# should happen only on crashes
1832	if ($pl->ob->{_link_pos}) {
1833	$pl->ob->enter_link;
1834	(async {
1835	# we need this sleep as the login has a concurrent enter_exit running
1836	# and this sleep increases chances of the player not ending up in scorn
1837	$pl->ob->reply (undef,
1838	"There was an internal problem at your last logout, "
1839	. "the server will try to bring you to your intended destination in a second.",
1840	cf::NDI_RED);
1841	Coro::Timer::sleep 1;
1842	$pl->ob->leave_link;
1843	})->prio (2);
1844	}
1845	},
1846	);
1847
1848	=item $player_object->goto ($path, $x, $y)
1849
1850	=cut	2543	=cut
		2544
		2545	our $GOTOGEN;
1851		2546
1852	sub cf::object::player::goto {	2547	sub cf::object::player::goto {
1853	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;
1854		2552
1855	$self->enter_link;	2553	$self->enter_link;
1856		2554
1857	(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
1858	my $map = eval {	2577	my $map = eval {
1859	my $map = cf::map::find $path;	2578	my $map = defined $path ? cf::map::find $path : undef;
		2579
		2580	if ($map) {
1860	$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
1861	$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 $@;
1862	} or	2593	}
1863	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1864		2594
		2595	if ($gen == $self->{_goto_generation}) {
		2596	delete $self->{_goto_generation};
1865	$self->leave_link ($map, $x, $y);	2597	$self->leave_link ($map, $x, $y);
		2598	}
		2599
		2600	$done->() if $done;
1866	})->prio (1);	2601	})->prio (1);
1867	}	2602	}
1868		2603
1869	=item $player_object->enter_exit ($exit_object)	2604	=item $player_object->enter_exit ($exit_object)
1870		2605
…		…
1907	$rmp->{origin_y} = $exit->y;	2642	$rmp->{origin_y} = $exit->y;
1908	}	2643	}
1909		2644
1910	$rmp->{random_seed} ||= $exit->random_seed;	2645	$rmp->{random_seed} ||= $exit->random_seed;
1911		2646
1912	my $data = cf::to_json $rmp;	2647	my $data = cf::encode_json $rmp;
1913	my $md5 = Digest::MD5::md5_hex $data;	2648	my $md5 = Digest::MD5::md5_hex $data;
1914	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2649	my $meta = "$RANDOMDIR/$md5.meta";
1915		2650
1916	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2651	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1917	aio_write $fh, 0, (length $data), $data, 0;	2652	aio_write $fh, 0, (length $data), $data, 0;
1918	undef $fh;	2653	undef $fh;
1919	aio_rename "$meta~", $meta;	2654	aio_rename "$meta~", $meta;
…		…
1928		2663
1929	return unless $self->type == cf::PLAYER;	2664	return unless $self->type == cf::PLAYER;
1930		2665
1931	if ($exit->slaying eq "/!") {	2666	if ($exit->slaying eq "/!") {
1932	#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
1933	cf::sync_job { prepare_random_map $exit };	2670	cf::sync_job { prepare_random_map $exit };
1934	}	2671	}
1935		2672
1936	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;
1937	my $hp = $exit->stats->hp;	2674	my $hp = $exit->stats->hp;
1938	my $sp = $exit->stats->sp;	2675	my $sp = $exit->stats->sp;
1939		2676
1940	$self->enter_link;	2677	$self->enter_link;
1941		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
1942	(async {	2683	(async {
		2684	$Coro::current->{desc} = "enter_exit $slaying $hp $sp";
		2685
1943	$self->deactivate_recursive; # just to be sure	2686	$self->deactivate_recursive; # just to be sure
1944	unless (eval {	2687	unless (eval {
1945	$self->goto ($slaying, $hp, $sp);	2688	$self->goto ($slaying, $hp, $sp);
1946		2689
1947	1;	2690	1;
1948	}) {	2691	}) {
1949	$self->message ("Something went wrong deep within the crossfire server. "	2692	$self->message ("Something went wrong deep within the crossfire server. "
1950	. "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. "
1951	. "Please report this to the dungeon master!",	2694	. "Please report this to the dungeon master!",
1952	cf::NDI_UNIQUE | cf::NDI_RED);	2695	cf::NDI_UNIQUE | cf::NDI_RED);
1953		2696
1954	warn "ERROR in enter_exit: $@";	2697	warn "ERROR in enter_exit: $@";
1955	$self->leave_link;	2698	$self->leave_link;
1956	}	2699	}
1957	})->prio (1);	2700	})->prio (1);
…		…
1970		2713
1971	sub cf::client::send_drawinfo {	2714	sub cf::client::send_drawinfo {
1972	my ($self, $text, $flags) = @_;	2715	my ($self, $text, $flags) = @_;
1973		2716
1974	utf8::encode $text;	2717	utf8::encode $text;
1975	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2718	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1976	}	2719	}
1977		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	}
1978		2879
1979	=item $success = $client->query ($flags, "text", \&cb)	2880	=item $success = $client->query ($flags, "text", \&cb)
1980		2881
1981	Queues a query to the client, calling the given callback with	2882	Queues a query to the client, calling the given callback with
1982	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2883	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1983	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2884	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1984		2885
1985	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
1986	reliable at some point in the future.	2887	become reliable at some point in the future.
1987		2888
1988	=cut	2889	=cut
1989		2890
1990	sub cf::client::query {	2891	sub cf::client::query {
1991	my ($self, $flags, $text, $cb) = @_;	2892	my ($self, $flags, $text, $cb) = @_;
…		…
1999	utf8::encode $text;	2900	utf8::encode $text;
2000	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2901	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2001		2902
2002	$self->send_packet ($self->{query_queue}[0][0])	2903	$self->send_packet ($self->{query_queue}[0][0])
2003	if @{ $self->{query_queue} } == 1;	2904	if @{ $self->{query_queue} } == 1;
		2905
		2906	1
2004	}	2907	}
2005		2908
2006	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	},
2007	on_reply => sub {	2915	on_reply => sub {
2008	my ($ns, $msg) = @_;	2916	my ($ns, $msg) = @_;
2009		2917
2010	# this weird shuffling is so that direct followup queries	2918	# this weird shuffling is so that direct followup queries
2011	# get handled first	2919	# get handled first
…		…
2023	} else {	2931	} else {
2024	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2932	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2025	}	2933	}
2026	}	2934	}
2027	},	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	},
2028	);	2962	);
2029		2963
2030	=item $client->async (\&cb)	2964	=item $client->async (\&cb)
2031		2965
2032	Create a new coroutine, running the specified callback. The coroutine will	2966	Create a new coroutine, running the specified callback. The coroutine will
…		…
2073	our $safe = new Safe "safe";	3007	our $safe = new Safe "safe";
2074	our $safe_hole = new Safe::Hole;	3008	our $safe_hole = new Safe::Hole;
2075		3009
2076	$SIG{FPE} = 'IGNORE';	3010	$SIG{FPE} = 'IGNORE';
2077		3011
2078	$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	));
2079		3017
2080	# here we export the classes and methods available to script code	3018	# here we export the classes and methods available to script code
2081		3019
2082	=pod	3020	=pod
2083		3021
2084	The following fucntions and emthods are available within a safe environment:	3022	The following functions and methods are available within a safe environment:
2085		3023
2086	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
2087	cf::object::player player	3028	cf::object::player
2088	cf::player peaceful	3029	player
2089	cf::map trigger	3030
		3031	cf::player
		3032	peaceful
		3033
		3034	cf::map
		3035	trigger
2090		3036
2091	=cut	3037	=cut
2092		3038
2093	for (	3039	for (
2094	["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)],
2095	["cf::object::player" => qw(player)],	3043	["cf::object::player" => qw(player)],
2096	["cf::player" => qw(peaceful)],	3044	["cf::player" => qw(peaceful)],
2097	["cf::map" => qw(trigger)],	3045	["cf::map" => qw(trigger)],
2098	) {	3046	) {
2099	no strict 'refs';	3047	no strict 'refs';
…		…
2170	=back	3118	=back
2171		3119
2172	=cut	3120	=cut
2173		3121
2174	#############################################################################	3122	#############################################################################
2175
2176	=head2 EXTENSION DATABASE SUPPORT
2177
2178	Crossfire maintains a very simple database for extension use. It can
2179	currently store anything that can be serialised using Storable, which
2180	excludes objects.
2181
2182	The parameter C<$family> should best start with the name of the extension
2183	using it, it should be unique.
2184
2185	=over 4
2186
2187	=item $hashref = cf::db_get $family
2188
2189	Return a hashref for use by the extension C<$family>, which can be
2190	modified. After modifications, you have to call C<cf::db_dirty> or
2191	C<cf::db_sync>.
2192
2193	=item $value = cf::db_get $family => $key
2194
2195	Returns a single value from the database
2196
2197	=item cf::db_put $family => $hashref
2198
2199	Stores the given family hashref into the database. Updates are delayed, if
2200	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2201
2202	=item cf::db_put $family => $key => $value
2203
2204	Stores the given C<$value> in the family hash. Updates are delayed, if you
2205	want the data to be synced to disk immediately, use C<cf::db_sync>.
2206
2207	=item cf::db_dirty
2208
2209	Marks the database as dirty, to be updated at a later time.
2210
2211	=item cf::db_sync
2212
2213	Immediately write the database to disk I<if it is dirty>.
2214
2215	=cut
2216
2217	our $DB;
2218
2219	{
2220	my $path = cf::localdir . "/database.pst";
2221
2222	sub db_load() {
2223	$DB = stat $path ? Storable::retrieve $path : { };
2224	}
2225
2226	my $pid;
2227
2228	sub db_save() {
2229	waitpid $pid, 0 if $pid;
2230	if (0 == ($pid = fork)) {
2231	$DB->{_meta}{version} = 1;
2232	Storable::nstore $DB, "$path~";
2233	rename "$path~", $path;
2234	cf::_exit 0 if defined $pid;
2235	}
2236	}
2237
2238	my $dirty;
2239
2240	sub db_sync() {
2241	db_save if $dirty;
2242	undef $dirty;
2243	}
2244
2245	my $idle = Event->idle (
2246	reentrant => 0,
2247	min => 10,
2248	max => 20,
2249	repeat => 0,
2250	data => WF_AUTOCANCEL,
2251	cb => \&db_sync,
2252	);
2253
2254	sub db_dirty() {
2255	$dirty = 1;
2256	$idle->start;
2257	}
2258
2259	sub db_get($;$) {
2260	@_ >= 2
2261	? $DB->{$_[0]}{$_[1]}
2262	: ($DB->{$_[0]} ||= { })
2263	}
2264
2265	sub db_put($$;$) {
2266	if (@_ >= 3) {
2267	$DB->{$_[0]}{$_[1]} = $_[2];
2268	} else {
2269	$DB->{$_[0]} = $_[1];
2270	}
2271	db_dirty;
2272	}
2273
2274	cf::global->attach (
2275	prio => 10000,
2276	on_cleanup => sub {
2277	db_sync;
2278	},
2279	);
2280	}
2281
2282	#############################################################################
2283	# the server's init and main functions	3123	# the server's init and main functions
2284		3124
2285	sub load_resources {	3125	sub load_facedata($) {
2286	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"
2287	or die "unable to load regions file\n";#d#	3266	or die "unable to load regions file\n";
2288	}
2289		3267
2290	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 {
2291	open my $fh, "<:utf8", cf::confdir . "/config"	3311	open my $fh, "<:utf8", "$CONFDIR/config"
2292	or return;	3312	or return;
2293		3313
2294	local $/;	3314	local $/;
2295	*CFG = YAML::Syck::Load <$fh>;	3315	*CFG = YAML::Load <$fh>;
2296		3316
2297	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3317	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2298		3318
2299	$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};
2300	$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};
…		…
2306	};	3326	};
2307	warn $@ if $@;	3327	warn $@ if $@;
2308	}	3328	}
2309	}	3329	}
2310		3330
2311	sub init {
2312	load_resources;
2313	}
2314
2315	sub main {	3331	sub main {
2316	# we must not ever block the main coroutine	3332	# we must not ever block the main coroutine
2317	local $Coro::idle = sub {	3333	local $Coro::idle = sub {
2318	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#
2319	(async {	3335	(async {
2320	Event::one_event;	3336	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3337	EV::loop EV::LOOP_ONESHOT;
2321	})->prio (Coro::PRIO_MAX);	3338	})->prio (Coro::PRIO_MAX);
2322	};	3339	};
2323		3340
2324	cfg_load;	3341	reload_config;
2325	db_load;	3342	db_init;
2326	load_extensions;	3343	load_extensions;
2327		3344
2328	$TICK_WATCHER->start;	3345	$TICK_WATCHER->start;
		3346	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
2329	Event::loop;	3347	EV::loop;
2330	}	3348	}
2331		3349
2332	#############################################################################	3350	#############################################################################
2333	# initialisation and cleanup	3351	# initialisation and cleanup
2334		3352
2335	# install some emergency cleanup handlers	3353	# install some emergency cleanup handlers
2336	BEGIN {	3354	BEGIN {
		3355	our %SIGWATCHER = ();
2337	for my $signal (qw(INT HUP TERM)) {	3356	for my $signal (qw(INT HUP TERM)) {
2338	Event->signal (	3357	$SIGWATCHER{$signal} = EV::signal $signal, sub {
2339	reentrant => 0,
2340	data => WF_AUTOCANCEL,
2341	signal => $signal,
2342	prio => 0,
2343	cb => sub {
2344	cf::cleanup "SIG$signal";	3358	cf::cleanup "SIG$signal";
2345	},
2346	);	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
2347	}	3398	1
2348	}	3399	}
2349		3400
2350	sub emergency_save() {	3401	sub emergency_save() {
2351	my $freeze_guard = cf::freeze_mainloop;	3402	my $freeze_guard = cf::freeze_mainloop;
2352		3403
…		…
2358	# and maps saved/destroyed asynchronously.	3409	# and maps saved/destroyed asynchronously.
2359	warn "begin emergency player save\n";	3410	warn "begin emergency player save\n";
2360	for my $login (keys %cf::PLAYER) {	3411	for my $login (keys %cf::PLAYER) {
2361	my $pl = $cf::PLAYER{$login} or next;	3412	my $pl = $cf::PLAYER{$login} or next;
2362	$pl->valid or next;	3413	$pl->valid or next;
		3414	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2363	$pl->save;	3415	$pl->save;
2364	}	3416	}
2365	warn "end emergency player save\n";	3417	warn "end emergency player save\n";
2366		3418
2367	warn "begin emergency map save\n";	3419	warn "begin emergency map save\n";
…		…
2369	my $map = $cf::MAP{$path} or next;	3421	my $map = $cf::MAP{$path} or next;
2370	$map->valid or next;	3422	$map->valid or next;
2371	$map->save;	3423	$map->save;
2372	}	3424	}
2373	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";
2374	};	3430	};
2375		3431
2376	warn "leave emergency perl save\n";	3432	warn "leave emergency perl save\n";
2377	}	3433	}
2378		3434
		3435	sub post_cleanup {
		3436	my ($make_core) = @_;
		3437
		3438	warn Carp::longmess "post_cleanup backtrace"
		3439	if $make_core;
		3440	}
		3441
2379	sub reload() {	3442	sub do_reload_perl() {
2380	# can/must only be called in main	3443	# can/must only be called in main
2381	if ($Coro::current != $Coro::main) {	3444	if ($Coro::current != $Coro::main) {
2382	warn "can only reload from main coroutine";	3445	warn "can only reload from main coroutine";
2383	return;	3446	return;
2384	}	3447	}
2385		3448
2386	warn "reloading...";	3449	warn "reloading...";
2387		3450
2388	warn "cancelling server ticker";	3451	warn "entering sync_job";
2389	$TICK_WATCHER->cancel;
2390		3452
		3453	cf::sync_job {
		3454	cf::write_runtime; # external watchdog should not bark
2391	cf::emergency_save;	3455	cf::emergency_save;
		3456	cf::write_runtime; # external watchdog should not bark
2392		3457
2393	eval {	3458	warn "syncing database to disk";
		3459	BDB::db_env_txn_checkpoint $DB_ENV;
		3460
2394	# 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
2395
2396	warn "syncing database to disk";
2397	cf::db_sync;
2398
2399	warn "cancelling all WF_AUTOCANCEL watchers";
2400	for (Event::all_watchers) {
2401	$_->cancel if $_->data & WF_AUTOCANCEL;
2402	}
2403		3462
2404	warn "flushing outstanding aio requests";	3463	warn "flushing outstanding aio requests";
2405	for (;;) {	3464	for (;;) {
		3465	BDB::flush;
2406	IO::AIO::flush;	3466	IO::AIO::flush;
2407	Coro::cede;	3467	Coro::cede_notself;
2408	last unless IO::AIO::nreqs;	3468	last unless IO::AIO::nreqs || BDB::nreqs;
2409	warn "iterate...";	3469	warn "iterate...";
2410	}	3470	}
		3471
		3472	++$RELOAD;
2411		3473
2412	warn "cancelling all extension coros";	3474	warn "cancelling all extension coros";
2413	$_->cancel for values %EXT_CORO;	3475	$_->cancel for values %EXT_CORO;
2414	%EXT_CORO = ();	3476	%EXT_CORO = ();
2415		3477
2416	warn "removing commands";	3478	warn "removing commands";
2417	%COMMAND = ();	3479	%COMMAND = ();
2418		3480
2419	warn "removing ext commands";	3481	warn "removing ext/exti commands";
2420	%EXTCMD = ();	3482	%EXTCMD = ();
		3483	%EXTICMD = ();
2421		3484
2422	warn "unloading/nuking all extensions";	3485	warn "unloading/nuking all extensions";
2423	for my $pkg (@EXTS) {	3486	for my $pkg (@EXTS) {
2424	warn "... unloading $pkg";	3487	warn "... unloading $pkg";
2425		3488
…		…
2455	Symbol::delete_package "safe::$_"	3518	Symbol::delete_package "safe::$_"
2456	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);
2457		3520
2458	warn "unloading cf.pm \"a bit\"";	3521	warn "unloading cf.pm \"a bit\"";
2459	delete $INC{"cf.pm"};	3522	delete $INC{"cf.pm"};
		3523	delete $INC{"cf/pod.pm"};
2460		3524
2461	# don't, removes xs symbols, too,	3525	# don't, removes xs symbols, too,
2462	# and global variables created in xs	3526	# and global variables created in xs
2463	#Symbol::delete_package __PACKAGE__;	3527	#Symbol::delete_package __PACKAGE__;
2464		3528
…		…
2467	warn "reloading cf.pm";	3531	warn "reloading cf.pm";
2468	require cf;	3532	require cf;
2469	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3533	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2470		3534
2471	warn "loading config and database again";	3535	warn "loading config and database again";
2472	cf::cfg_load;	3536	cf::reload_config;
2473	cf::db_load;
2474		3537
2475	warn "loading extensions";	3538	warn "loading extensions";
2476	cf::load_extensions;	3539	cf::load_extensions;
2477		3540
2478	warn "reattaching attachments to objects/players";	3541	warn "reattaching attachments to objects/players";
2479	_global_reattach;	3542	_global_reattach; # objects, sockets
2480	warn "reattaching attachments to maps";	3543	warn "reattaching attachments to maps";
2481	reattach $_ for values %MAP;	3544	reattach $_ for values %MAP;
		3545	warn "reattaching attachments to players";
		3546	reattach $_ for values %PLAYER;
2482		3547
2483	warn "loading reloadable resources";	3548	warn "leaving sync_job";
2484	load_resources;
2485		3549
2486	warn "restarting server ticker";	3550	1
2487		3551	} or do {
2488	$TICK_WATCHER->start;
2489	};
2490
2491	if ($@) {
2492	warn $@;	3552	warn $@;
2493	warn "error while reloading, exiting.";	3553	warn "error while reloading, exiting.";
2494	exit 1;	3554	exit 1;
2495	}	3555	};
2496		3556
2497	warn "reloaded";	3557	warn "reloaded";
2498	};	3558	};
2499		3559
2500	our $RELOAD_WATCHER; # used only during reload	3560	our $RELOAD_WATCHER; # used only during reload
2501		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
2502	register_command "reload" => sub {	3572	register_command "reload" => sub {
2503	my ($who, $arg) = @_;	3573	my ($who, $arg) = @_;
2504		3574
2505	if ($who->flag (FLAG_WIZ)) {	3575	if ($who->flag (FLAG_WIZ)) {
2506	$who->message ("reloading server.");	3576	$who->message ("reloading server.");
2507		3577	async {
2508	# doing reload synchronously and two reloads happen back-to-back,	3578	$Coro::current->{desc} = "perl_reload";
2509	# coro crashes during coro_state_free->destroy here.
2510
2511	$RELOAD_WATCHER ||= Event->timer (
2512	reentrant => 0,
2513	after => 0,
2514	data => WF_AUTOCANCEL,
2515	cb => sub {
2516	reload;	3579	reload_perl;
2517	undef $RELOAD_WATCHER;
2518	},
2519	);	3580	};
2520	}	3581	}
2521	};	3582	};
2522		3583
2523	unshift @INC, $LIBDIR;	3584	unshift @INC, $LIBDIR;
2524		3585
2525	my $bug_warning = 0;	3586	my $bug_warning = 0;
2526		3587
2527	$TICK_WATCHER = Event->timer (	3588	our @WAIT_FOR_TICK;
2528	reentrant => 0,	3589	our @WAIT_FOR_TICK_BEGIN;
2529	parked => 1,	3590
2530	prio => 0,	3591	sub wait_for_tick {
2531	at => $NEXT_TICK || $TICK,	3592	return unless $TICK_WATCHER->is_active;
2532	data => WF_AUTOCANCEL,	3593	return if $Coro::current == $Coro::main;
2533	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 {
2534	if ($Coro::current != $Coro::main) {	3610	if ($Coro::current != $Coro::main) {
2535	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"
2536	unless ++$bug_warning > 10;	3612	unless ++$bug_warning > 10;
2537	return;	3613	return;
2538	}	3614	}
2539		3615
2540	$NOW = Event::time;	3616	$NOW = $tick_start = EV::now;
2541		3617
2542	cf::server_tick; # one server iteration	3618	cf::server_tick; # one server iteration
		3619
2543	$RUNTIME += $TICK;	3620	$RUNTIME += $TICK;
2544	$NEXT_TICK += $TICK;	3621	$NEXT_TICK = $_[0]->at;
2545		3622
2546	$WAIT_FOR_TICK->broadcast;	3623	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2547	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3624	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2548		3625	Coro::async_pool {
2549	Event::sweep;	3626	$Coro::current->{desc} = "runtime saver";
2550	Coro::cede_notself;	3627	write_runtime
		3628	or warn "ERROR: unable to write runtime file: $!";
2551		3629	};
2552	# my $AFTER = Event::time;
2553	# warn $AFTER - $NOW;#d#
2554
2555	# if we are delayed by four ticks or more, skip them all
2556	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2557
2558	$TICK_WATCHER->at ($NEXT_TICK);
2559	$TICK_WATCHER->start;
2560	},	3630	}
2561	);	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);
2562		3645
2563	{	3646	{
2564	BDB::max_poll_time $TICK * 0.1;	3647	# configure BDB
2565	$BDB_POLL_WATCHER = Event->io (	3648
2566	reentrant => 0,
2567	fd => BDB::poll_fileno,
2568	poll => 'r',
2569	prio => 0,
2570	data => WF_AUTOCANCEL,
2571	cb => \&BDB::poll_cb,
2572	);
2573	BDB::min_parallel 8;	3649	BDB::min_parallel 8;
2574		3650	BDB::max_poll_reqs $TICK * 0.1;
2575	BDB::set_sync_prepare {	3651	$Coro::BDB::WATCHER->priority (1);
2576	my $status;
2577	my $current = $Coro::current;
2578	(
2579	sub {
2580	$status = $!;
2581	$current->ready; undef $current;
2582	},
2583	sub {
2584	Coro::schedule while defined $current;
2585	$! = $status;
2586	},
2587	)
2588	};
2589		3652
2590	unless ($DB_ENV) {	3653	unless ($DB_ENV) {
2591	$DB_ENV = BDB::db_env_create;	3654	$DB_ENV = BDB::db_env_create;
		3655	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
		3656	| BDB::LOG_AUTOREMOVE, 1);
		3657	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3658	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
2592		3659
2593	cf::sync_job {	3660	cf::sync_job {
		3661	eval {
2594	BDB::db_env_open	3662	BDB::db_env_open
2595	$DB_ENV,	3663	$DB_ENV,
2596	$BDB_ENV_DIR,	3664	$BDBDIR,
2597	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	3665	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2598	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3666	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2599	0666;	3667	0666;
2600		3668
2601	cf::cleanup "$!" if $!;	3669	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2602		3670	};
2603	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);	3671
2604	$DB_ENV->set_lk_detect;	3672	cf::cleanup "db_env_open(db): $@" if $@;
2605	};	3673	};
2606	}	3674	}
		3675
		3676	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3677	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3678	};
		3679	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		3680	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3681	};
		3682	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3683	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3684	};
2607	}	3685	}
2608		3686
2609	{	3687	{
		3688	# configure IO::AIO
		3689
2610	IO::AIO::min_parallel 8;	3690	IO::AIO::min_parallel 8;
2611
2612	undef $Coro::AIO::WATCHER;
2613	IO::AIO::max_poll_time $TICK * 0.1;	3691	IO::AIO::max_poll_time $TICK * 0.1;
2614	$AIO_POLL_WATCHER = Event->io (	3692	$Coro::AIO::WATCHER->priority (1);
2615	reentrant => 0,
2616	fd => IO::AIO::poll_fileno,
2617	poll => 'r',
2618	prio => 6,
2619	data => WF_AUTOCANCEL,
2620	cb => \&IO::AIO::poll_cb,
2621	);
2622	}	3693	}
2623		3694
2624	$WRITE_RUNTIME_WATCHER = Event->timer (	3695	my $_log_backtrace;
2625	reentrant => 0,	3696
2626	data => WF_AUTOCANCEL,	3697	sub _log_backtrace {
2627	after => 1,	3698	my ($msg, @addr) = @_;
2628	interval => 10,	3699
2629	prio => 6, # keep it lowest so it acts like a watchdog	3700	$msg =~ s/\n//;
2630	cb => Coro::unblock_sub {	3701
2631	write_runtime	3702	# limit the # of concurrent backtraces
2632	or warn "ERROR: unable to write runtime file: $!";	3703	if ($_log_backtrace < 2) {
		3704	++$_log_backtrace;
		3705	async {
		3706	$Coro::current->{desc} = "abt $msg";
		3707
		3708	my @bt = fork_call {
		3709	@addr = map { sprintf "%x", $_ } @addr;
		3710	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3711	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3712	or die "addr2line: $!";
		3713
		3714	my @funcs;
		3715	my @res = <$fh>;
		3716	chomp for @res;
		3717	while (@res) {
		3718	my ($func, $line) = splice @res, 0, 2, ();
		3719	push @funcs, "[$func] $line";
		3720	}
		3721
		3722	@funcs
		3723	};
		3724
		3725	LOG llevInfo, "[ABT] $msg\n";
		3726	LOG llevInfo, "[ABT] $_\n" for @bt;
		3727	--$_log_backtrace;
		3728	};
		3729	} else {
		3730	LOG llevInfo, "[ABT] $msg\n";
		3731	LOG llevInfo, "[ABT] [suppressed]\n";
2633	},	3732	}
2634	);	3733	}
		3734
		3735	# load additional modules
		3736	use cf::pod;
2635		3737
2636	END { cf::emergency_save }	3738	END { cf::emergency_save }
2637		3739
2638	1	3740	1
2639		3741

Diff Legend

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