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.203 by root, Thu Feb 1 19:40:42 2007 UTC vs.
Revision 1.410 by root, Tue Jan 15 12:02:24 2008 UTC

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

Diff Legend

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