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.202 by root, Mon Jan 29 20:16:28 2007 UTC vs.
Revision 1.411 by root, Fri Feb 1 15:54:07 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	cf::cleanup "mandatory extension failed to load, exiting.";
		1322	}
		1323
		1324	warn $msg;
		1325	}
		1326
		1327	$done{$k} = delete $todo{$k};
		1328	push @EXTS, $v->{pkg};
		1329	$progress = 1;
925	1	1330	}
926	} or warn "$ext not loaded: $@";	1331
		1332	skip:
		1333	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1334	unless $progress;
		1335	}
927	}	1336	};
928	}	1337	}
929		1338
930	#############################################################################	1339	#############################################################################
931		1340
		1341	=back
		1342
932	=head2 CORE EXTENSIONS	1343	=head2 CORE EXTENSIONS
933		1344
934	Functions and methods that extend core crossfire objects.	1345	Functions and methods that extend core crossfire objects.
935		1346
936	=cut	1347	=cut
…		…
941		1352
942	=head3 cf::player	1353	=head3 cf::player
943		1354
944	=over 4	1355	=over 4
945		1356
		1357	=item cf::player::num_playing
		1358
		1359	Returns the official number of playing players, as per the Crossfire metaserver rules.
		1360
		1361	=cut
		1362
		1363	sub num_playing {
		1364	scalar grep
		1365	$_->ob->map
		1366	&& !$_->hidden
		1367	&& !$_->ob->flag (cf::FLAG_WIZ),
		1368	cf::player::list
		1369	}
		1370
946	=item cf::player::find $login	1371	=item cf::player::find $login
947		1372
948	Returns the given player object, loading it if necessary (might block).	1373	Returns the given player object, loading it if necessary (might block).
949		1374
950	=cut	1375	=cut
951		1376
952	sub playerdir($) {	1377	sub playerdir($) {
953	cf::localdir	1378	"$PLAYERDIR/"
954	. "/"
955	. cf::playerdir
956	. "/"
957	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1379	. (ref $_[0] ? $_[0]->ob->name : $_[0])
958	}	1380	}
959		1381
960	sub path($) {	1382	sub path($) {
961	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1383	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
962		1384
963	(playerdir $login) . "/$login.pl"	1385	(playerdir $login) . "/playerdata"
964	}	1386	}
965		1387
966	sub find_active($) {	1388	sub find_active($) {
967	$cf::PLAYER{$_[0]}	1389	$cf::PLAYER{$_[0]}
968	and $cf::PLAYER{$_[0]}->active	1390	and $cf::PLAYER{$_[0]}->active
…		…
981	my $login = $_[0];	1403	my $login = $_[0];
982		1404
983	my $guard = cf::lock_acquire "user_find:$login";	1405	my $guard = cf::lock_acquire "user_find:$login";
984		1406
985	$cf::PLAYER{$_[0]} || do {	1407	$cf::PLAYER{$_[0]} || do {
986	my $pl = load_pl path $login	1408	# rename old playerfiles to new ones
		1409	#TODO: remove when no longer required
		1410	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1411	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1412	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1413	aio_unlink +(playerdir $login) . "/$login.pl";
		1414
		1415	my $f = new_from_file cf::object::thawer path $login
987	or return;	1416	or return;
		1417
		1418	my $pl = cf::player::load_pl $f
		1419	or return;
		1420	local $cf::PLAYER_LOADING{$login} = $pl;
		1421	$f->resolve_delayed_derefs;
988	$cf::PLAYER{$login} = $pl	1422	$cf::PLAYER{$login} = $pl
989	}	1423	}
990	}	1424	}
991	}	1425	}
992		1426
…		…
1002		1436
1003	aio_mkdir playerdir $pl, 0770;	1437	aio_mkdir playerdir $pl, 0770;
1004	$pl->{last_save} = $cf::RUNTIME;	1438	$pl->{last_save} = $cf::RUNTIME;
1005		1439
1006	$pl->save_pl ($path);	1440	$pl->save_pl ($path);
1007	Coro::cede;	1441	cf::cede_to_tick;
1008	}	1442	}
1009		1443
1010	sub new($) {	1444	sub new($) {
1011	my ($login) = @_;	1445	my ($login) = @_;
1012		1446
…		…
1018	$cf::PLAYER{$login} = $self;	1452	$cf::PLAYER{$login} = $self;
1019		1453
1020	$self	1454	$self
1021	}	1455	}
1022		1456
		1457	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1458
		1459	=cut
		1460
		1461	sub send_msg {
		1462	my $ns = shift->ns
		1463	or return;
		1464	$ns->send_msg (@_);
		1465	}
		1466
1023	=item $pl->quit_character	1467	=item $pl->quit_character
1024		1468
1025	Nukes the player without looking back. If logged in, the connection will	1469	Nukes the player without looking back. If logged in, the connection will
1026	be destroyed. May block for a long time.	1470	be destroyed. May block for a long time.
1027		1471
1028	=cut	1472	=cut
1029		1473
1030	sub quit_character {	1474	sub quit_character {
1031	my ($pl) = @_;	1475	my ($pl) = @_;
		1476
		1477	my $name = $pl->ob->name;
1032		1478
1033	$pl->{deny_save} = 1;	1479	$pl->{deny_save} = 1;
1034	$pl->password ("*"); # this should lock out the player until we nuked the dir	1480	$pl->password ("*"); # this should lock out the player until we nuked the dir
1035		1481
1036	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1482	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1041	my $path = playerdir $pl;	1487	my $path = playerdir $pl;
1042	my $temp = "$path~$cf::RUNTIME~deleting~";	1488	my $temp = "$path~$cf::RUNTIME~deleting~";
1043	aio_rename $path, $temp;	1489	aio_rename $path, $temp;
1044	delete $cf::PLAYER{$pl->ob->name};	1490	delete $cf::PLAYER{$pl->ob->name};
1045	$pl->destroy;	1491	$pl->destroy;
		1492
		1493	my $prefix = qr<^~\Q$name\E/>;
		1494
		1495	# nuke player maps
		1496	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1497
1046	IO::AIO::aio_rmtree $temp;	1498	IO::AIO::aio_rmtree $temp;
		1499	}
		1500
		1501	=item $pl->kick
		1502
		1503	Kicks a player out of the game. This destroys the connection.
		1504
		1505	=cut
		1506
		1507	sub kick {
		1508	my ($pl, $kicker) = @_;
		1509
		1510	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1511	$pl->killer ("kicked");
		1512	$pl->ns->destroy;
1047	}	1513	}
1048		1514
1049	=item cf::player::list_logins	1515	=item cf::player::list_logins
1050		1516
1051	Returns am arrayref of all valid playernames in the system, can take a	1517	Returns am arrayref of all valid playernames in the system, can take a
1052	while and may block, so not sync_job-capable, ever.	1518	while and may block, so not sync_job-capable, ever.
1053		1519
1054	=cut	1520	=cut
1055		1521
1056	sub list_logins {	1522	sub list_logins {
1057	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1523	my $dirs = aio_readdir $PLAYERDIR
1058	or return [];	1524	or return [];
1059		1525
1060	my @logins;	1526	my @logins;
1061		1527
1062	for my $login (@$dirs) {	1528	for my $login (@$dirs) {
		1529	my $path = path $login;
		1530
		1531	# a .pst is a dead give-away for a valid player
		1532	unless (-e "$path.pst") {
1063	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1533	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1064	aio_read $fh, 0, 512, my $buf, 0 or next;	1534	aio_read $fh, 0, 512, my $buf, 0 or next;
1065	$buf !~ /^password -------------$/m or next; # official not-valid tag	1535	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1536	}
1066		1537
1067	utf8::decode $login;	1538	utf8::decode $login;
1068	push @logins, $login;	1539	push @logins, $login;
1069	}	1540	}
1070		1541
…		…
1097	}	1568	}
1098		1569
1099	\@paths	1570	\@paths
1100	}	1571	}
1101		1572
		1573	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1574
		1575	Expand crossfire pod fragments into protocol xml.
		1576
		1577	=cut
		1578
		1579	use re 'eval';
		1580
		1581	my $group;
		1582	my $interior; $interior = qr{
		1583	# match a pod interior sequence sans C<< >>
		1584	(?:
		1585	\ (.*?)\ (?{ $group = $^N })
		1586	| < (??{$interior}) >
		1587	)
		1588	}x;
		1589
		1590	sub expand_cfpod {
		1591	my ($self, $pod) = @_;
		1592
		1593	my $xml;
		1594
		1595	while () {
		1596	if ($pod =~ /\G( (?: [^BCGHITU]+ | .(?!<) )+ )/xgcs) {
		1597	$group = $1;
		1598
		1599	$group =~ s/&/&amp;/g;
		1600	$group =~ s/</&lt;/g;
		1601
		1602	$xml .= $group;
		1603	} elsif ($pod =~ m%\G
		1604	([BCGHITU])
		1605	<
		1606	(?:
		1607	([^<>]*) (?{ $group = $^N })
		1608	| < $interior >
		1609	)
		1610	>
		1611	%gcsx
		1612	) {
		1613	my ($code, $data) = ($1, $group);
		1614
		1615	if ($code eq "B") {
		1616	$xml .= "<b>" . expand_cfpod ($self, $data) . "</b>";
		1617	} elsif ($code eq "I") {
		1618	$xml .= "<i>" . expand_cfpod ($self, $data) . "</i>";
		1619	} elsif ($code eq "U") {
		1620	$xml .= "<u>" . expand_cfpod ($self, $data) . "</u>";
		1621	} elsif ($code eq "C") {
		1622	$xml .= "<tt>" . expand_cfpod ($self, $data) . "</tt>";
		1623	} elsif ($code eq "T") {
		1624	$xml .= "<big><b>" . expand_cfpod ($self, $data) . "</b></big>";
		1625	} elsif ($code eq "G") {
		1626	my ($male, $female) = split /\|/, $data;
		1627	$data = $self->gender ? $female : $male;
		1628	$xml .= expand_cfpod ($self, $data);
		1629	} elsif ($code eq "H") {
		1630	$xml .= ("<fg name=\"lightblue\">[" . expand_cfpod ($self, $data) . " (Use hintmode to suppress hints)]</fg>",
		1631	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1632	"")
		1633	[$self->{hintmode}];
		1634	} else {
		1635	$xml .= "error processing '$code($data)' directive";
		1636	}
		1637	} else {
		1638	if ($pod =~ /\G(.+)/) {
		1639	warn "parse error while expanding $pod (at $1)";
		1640	}
		1641	last;
		1642	}
		1643	}
		1644
		1645	for ($xml) {
		1646	# create single paragraphs (very hackish)
		1647	s/(?<=\S)\n(?=\w)/ /g;
		1648
		1649	# compress some whitespace
		1650	s/\s+\n/\n/g; # ws line-ends
		1651	s/\n\n+/\n/g; # double lines
		1652	s/^\n+//; # beginning lines
		1653	s/\n+$//; # ending lines
		1654	}
		1655
		1656	$xml
		1657	}
		1658
		1659	no re 'eval';
		1660
		1661	sub hintmode {
		1662	$_[0]{hintmode} = $_[1] if @_ > 1;
		1663	$_[0]{hintmode}
		1664	}
		1665
1102	=item $player->ext_reply ($msgid, $msgtype, %msg)	1666	=item $player->ext_reply ($msgid, @msg)
1103		1667
1104	Sends an ext reply to the player.	1668	Sends an ext reply to the player.
1105		1669
1106	=cut	1670	=cut
1107		1671
1108	sub ext_reply($$$%) {	1672	sub ext_reply($$@) {
1109	my ($self, $id, %msg) = @_;	1673	my ($self, $id, @msg) = @_;
1110		1674
1111	$msg{msgid} = $id;	1675	$self->ns->ext_reply ($id, @msg)
1112
1113	$self->send ("ext " . cf::to_json \%msg);
1114	}	1676	}
1115		1677
1116	package cf;	1678	=item $player->ext_msg ($type, @msg)
		1679
		1680	Sends an ext event to the client.
		1681
		1682	=cut
		1683
		1684	sub ext_msg($$@) {
		1685	my ($self, $type, @msg) = @_;
		1686
		1687	$self->ns->ext_msg ($type, @msg);
		1688	}
		1689
		1690	=head3 cf::region
		1691
		1692	=over 4
		1693
		1694	=cut
		1695
		1696	package cf::region;
		1697
		1698	=item cf::region::find_by_path $path
		1699
		1700	Tries to decuce the likely region for a map knowing only its path.
		1701
		1702	=cut
		1703
		1704	sub find_by_path($) {
		1705	my ($path) = @_;
		1706
		1707	my ($match, $specificity);
		1708
		1709	for my $region (list) {
		1710	if ($region->{match} && $path =~ $region->{match}) {
		1711	($match, $specificity) = ($region, $region->specificity)
		1712	if $region->specificity > $specificity;
		1713	}
		1714	}
		1715
		1716	$match
		1717	}
1117		1718
1118	=back	1719	=back
1119
1120		1720
1121	=head3 cf::map	1721	=head3 cf::map
1122		1722
1123	=over 4	1723	=over 4
1124		1724
…		…
1179	my ($self, $merge) = @_;	1779	my ($self, $merge) = @_;
1180		1780
1181	# we have to keep some variables in memory intact	1781	# we have to keep some variables in memory intact
1182	local $self->{path};	1782	local $self->{path};
1183	local $self->{load_path};	1783	local $self->{load_path};
1184	local $self->{deny_save};
1185	local $self->{deny_reset};
1186		1784
1187	$self->SUPER::thawer_merge ($merge);	1785	$self->SUPER::thawer_merge ($merge);
1188	}	1786	}
1189		1787
1190	sub normalise {	1788	sub normalise {
…		…
1237	$self->init; # pass $1 etc.	1835	$self->init; # pass $1 etc.
1238	return $self;	1836	return $self;
1239	}	1837	}
1240	}	1838	}
1241		1839
1242	Carp::carp "unable to resolve path '$path' (base '$base').";	1840	Carp::cluck "unable to resolve path '$path' (base '$base').";
1243	()	1841	()
1244	}	1842	}
1245		1843
1246	sub init {	1844	sub init {
1247	my ($self) = @_;	1845	my ($self) = @_;
…		…
1262		1860
1263	# the original (read-only) location	1861	# the original (read-only) location
1264	sub load_path {	1862	sub load_path {
1265	my ($self) = @_;	1863	my ($self) = @_;
1266		1864
1267	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1865	"$MAPDIR/$self->{path}.map"
1268	}	1866	}
1269		1867
1270	# the temporary/swap location	1868	# the temporary/swap location
1271	sub save_path {	1869	sub save_path {
1272	my ($self) = @_;	1870	my ($self) = @_;
1273		1871
1274	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1872	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1275	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1873	"$TMPDIR/$path.map"
1276	}	1874	}
1277		1875
1278	# the unique path, undef == no special unique path	1876	# the unique path, undef == no special unique path
1279	sub uniq_path {	1877	sub uniq_path {
1280	my ($self) = @_;	1878	my ($self) = @_;
1281		1879
1282	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1880	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1283	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1881	"$UNIQUEDIR/$path"
1284	}	1882	}
1285		1883
1286	# and all this just because we cannot iterate over	1884	# and all this just because we cannot iterate over
1287	# all maps in C++...	1885	# all maps in C++...
1288	sub change_all_map_light {	1886	sub change_all_map_light {
…		…
1290		1888
1291	$_->change_map_light ($change)	1889	$_->change_map_light ($change)
1292	for grep $_->outdoor, values %cf::MAP;	1890	for grep $_->outdoor, values %cf::MAP;
1293	}	1891	}
1294		1892
		1893	sub decay_objects {
		1894	my ($self) = @_;
		1895
		1896	return if $self->{deny_reset};
		1897
		1898	$self->do_decay_objects;
		1899	}
		1900
1295	sub unlink_save {	1901	sub unlink_save {
1296	my ($self) = @_;	1902	my ($self) = @_;
1297		1903
1298	utf8::encode (my $save = $self->save_path);	1904	utf8::encode (my $save = $self->save_path);
1299	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1905	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1300	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";	1906	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	}	1907	}
1307		1908
1308	sub load_header_from($) {	1909	sub load_header_from($) {
1309	my ($self, $path) = @_;	1910	my ($self, $path) = @_;
1310		1911
1311	utf8::encode $path;	1912	utf8::encode $path;
1312	#aio_open $path, O_RDONLY, 0	1913	my $f = new_from_file cf::object::thawer $path
1313	# or return;
1314
1315	$self->_load_header ($path)
1316	or return;	1914	or return;
		1915
		1916	$self->_load_header ($f)
		1917	or return;
		1918
		1919	local $MAP_LOADING{$self->{path}} = $self;
		1920	$f->resolve_delayed_derefs;
1317		1921
1318	$self->{load_path} = $path;	1922	$self->{load_path} = $path;
1319		1923
1320	1	1924	1
1321	}	1925	}
…		…
1360	$self->load_header_orig	1964	$self->load_header_orig
1361	or return;	1965	or return;
1362	$self->prepare_orig;	1966	$self->prepare_orig;
1363	}	1967	}
1364		1968
		1969	$self->{deny_reset} = 1
		1970	if $self->no_reset;
		1971
		1972	$self->default_region (cf::region::find_by_path $self->{path})
		1973	unless $self->default_region;
		1974
1365	1	1975	1
1366	}	1976	}
1367		1977
1368	sub find;	1978	sub find;
1369	sub find {	1979	sub find {
1370	my ($path, $origin) = @_;	1980	my ($path, $origin) = @_;
1371		1981
1372	$path = normalise $path, $origin && $origin->path;	1982	$path = normalise $path, $origin && $origin->path;
1373		1983
		1984	cf::lock_wait "map_data:$path";#d#remove
1374	cf::lock_wait "map_find:$path";	1985	cf::lock_wait "map_find:$path";
1375		1986
1376	$cf::MAP{$path} || do {	1987	$cf::MAP{$path} || do {
1377	my $guard = cf::lock_acquire "map_find:$path";	1988	my $guard1 = cf::lock_acquire "map_find:$path";
		1989	my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
		1990
1378	my $map = new_from_path cf::map $path	1991	my $map = new_from_path cf::map $path
1379	or return;	1992	or return;
1380		1993
1381	$map->{last_save} = $cf::RUNTIME;	1994	$map->{last_save} = $cf::RUNTIME;
1382		1995
1383	$map->load_header	1996	$map->load_header
1384	or return;	1997	or return;
1385		1998
1386	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1999	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1387	# doing this can freeze the server in a sync job, obviously	2000	# doing this can freeze the server in a sync job, obviously
1388	#$cf::WAIT_FOR_TICK->wait;	2001	#$cf::WAIT_FOR_TICK->wait;
		2002	undef $guard1;
		2003	undef $guard2;
1389	$map->reset;	2004	$map->reset;
1390	undef $guard;
1391	return find $path;	2005	return find $path;
1392	}	2006	}
1393		2007
1394	$cf::MAP{$path} = $map	2008	$cf::MAP{$path} = $map
1395	}	2009	}
…		…
1402	my ($self) = @_;	2016	my ($self) = @_;
1403		2017
1404	local $self->{deny_reset} = 1; # loading can take a long time	2018	local $self->{deny_reset} = 1; # loading can take a long time
1405		2019
1406	my $path = $self->{path};	2020	my $path = $self->{path};
		2021
		2022	{
1407	my $guard = cf::lock_acquire "map_load:$path";	2023	my $guard = cf::lock_acquire "map_data:$path";
1408		2024
		2025	return unless $self->valid;
1409	return if $self->in_memory != cf::MAP_SWAPPED;	2026	return unless $self->in_memory == cf::MAP_SWAPPED;
1410		2027
1411	$self->in_memory (cf::MAP_LOADING);	2028	$self->in_memory (cf::MAP_LOADING);
1412		2029
1413	$self->alloc;	2030	$self->alloc;
1414		2031
1415	$self->pre_load;	2032	$self->pre_load;
		2033	cf::cede_to_tick;
1416		2034
1417	$self->_load_objects ($self->{load_path}, 1)	2035	my $f = new_from_file cf::object::thawer $self->{load_path};
		2036	$f->skip_block;
		2037	$self->_load_objects ($f)
1418	or return;	2038	or return;
1419		2039
1420	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2040	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1421	if delete $self->{load_original};	2041	if delete $self->{load_original};
1422		2042
1423	if (my $uniq = $self->uniq_path) {	2043	if (my $uniq = $self->uniq_path) {
1424	utf8::encode $uniq;	2044	utf8::encode $uniq;
1425	if (aio_open $uniq, O_RDONLY, 0) {	2045	unless (aio_stat $uniq) {
		2046	if (my $f = new_from_file cf::object::thawer $uniq) {
1426	$self->clear_unique_items;	2047	$self->clear_unique_items;
1427	$self->_load_objects ($uniq, 0);	2048	$self->_load_objects ($f);
		2049	$f->resolve_delayed_derefs;
		2050	}
1428	}	2051	}
1429	}	2052	}
1430		2053
1431	Coro::cede;	2054	$f->resolve_delayed_derefs;
1432		2055
		2056	cf::cede_to_tick;
1433	# now do the right thing for maps	2057	# now do the right thing for maps
1434	$self->link_multipart_objects;	2058	$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)	2059	$self->difficulty ($self->estimate_difficulty)
1443	unless $self->difficulty;	2060	unless $self->difficulty;
1444	Coro::cede;	2061	cf::cede_to_tick;
		2062
		2063	unless ($self->{deny_activate}) {
		2064	$self->decay_objects;
		2065	$self->fix_auto_apply;
		2066	$self->update_buttons;
		2067	cf::cede_to_tick;
		2068	$self->set_darkness_map;
		2069	cf::cede_to_tick;
1445	$self->activate;	2070	$self->activate;
		2071	}
		2072
		2073	$self->{last_save} = $cf::RUNTIME;
		2074	$self->last_access ($cf::RUNTIME);
		2075
		2076	$self->in_memory (cf::MAP_IN_MEMORY);
1446	}	2077	}
1447		2078
1448	$self->post_load;	2079	$self->post_load;
1449
1450	$self->in_memory (cf::MAP_IN_MEMORY);
1451	}	2080	}
1452		2081
1453	sub customise_for {	2082	sub customise_for {
1454	my ($self, $ob) = @_;	2083	my ($self, $ob) = @_;
1455		2084
1456	return find "~" . $ob->name . "/" . $self->{path}	2085	return find "~" . $ob->name . "/" . $self->{path}
1457	if $self->per_player;	2086	if $self->per_player;
1458		2087
		2088	# return find "?party/" . $ob->name . "/" . $self->{path}
		2089	# if $self->per_party;
		2090
1459	$self	2091	$self
1460	}	2092	}
1461		2093
1462	# find and load all maps in the 3x3 area around a map	2094	# find and load all maps in the 3x3 area around a map
1463	sub load_diag {	2095	sub load_neighbours {
1464	my ($map) = @_;	2096	my ($map) = @_;
1465		2097
1466	my @diag; # diagonal neighbours	2098	my @neigh; # diagonal neighbours
1467		2099
1468	for (0 .. 3) {	2100	for (0 .. 3) {
1469	my $neigh = $map->tile_path ($_)	2101	my $neigh = $map->tile_path ($_)
1470	or next;	2102	or next;
1471	$neigh = find $neigh, $map	2103	$neigh = find $neigh, $map
1472	or next;	2104	or next;
1473	$neigh->load;	2105	$neigh->load;
1474		2106
		2107	push @neigh,
1475	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2108	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1476	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2109	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1477	}	2110	}
1478		2111
1479	for (@diag) {	2112	for (grep defined $_->[0], @neigh) {
		2113	my ($path, $origin) = @$_;
1480	my $neigh = find @$_	2114	my $neigh = find $path, $origin
1481	or next;	2115	or next;
1482	$neigh->load;	2116	$neigh->load;
1483	}	2117	}
1484	}	2118	}
1485		2119
…		…
1490	}	2124	}
1491		2125
1492	sub do_load_sync {	2126	sub do_load_sync {
1493	my ($map) = @_;	2127	my ($map) = @_;
1494		2128
		2129	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2130	if $Coro::current == $Coro::main;
		2131
1495	cf::sync_job { $map->load };	2132	cf::sync_job { $map->load };
1496	}	2133	}
1497		2134
1498	our %MAP_PREFETCH;	2135	our %MAP_PREFETCH;
1499	our $MAP_PREFETCHER = undef;	2136	our $MAP_PREFETCHER = undef;
1500		2137
1501	sub find_async {	2138	sub find_async {
1502	my ($path, $origin) = @_;	2139	my ($path, $origin, $load) = @_;
1503		2140
1504	$path = normalise $path, $origin && $origin->{path};	2141	$path = normalise $path, $origin && $origin->{path};
1505		2142
1506	if (my $map = $cf::MAP{$path}) {	2143	if (my $map = $cf::MAP{$path}) {
1507	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2144	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1508	}	2145	}
1509		2146
1510	undef $MAP_PREFETCH{$path};	2147	$MAP_PREFETCH{$path} |= $load;
		2148
1511	$MAP_PREFETCHER ||= cf::async {	2149	$MAP_PREFETCHER ||= cf::async {
		2150	$Coro::current->{desc} = "map prefetcher";
		2151
1512	while (%MAP_PREFETCH) {	2152	while (%MAP_PREFETCH) {
1513	for my $path (keys %MAP_PREFETCH) {	2153	while (my ($k, $v) = each %MAP_PREFETCH) {
1514	my $map = find $path	2154	if (my $map = find $k) {
1515	or next;
1516	$map->load;	2155	$map->load if $v;
		2156	}
1517		2157
1518	delete $MAP_PREFETCH{$path};	2158	delete $MAP_PREFETCH{$k};
1519	}	2159	}
1520	}	2160	}
1521	undef $MAP_PREFETCHER;	2161	undef $MAP_PREFETCHER;
1522	};	2162	};
1523	$MAP_PREFETCHER->prio (6);	2163	$MAP_PREFETCHER->prio (6);
…		…
1526	}	2166	}
1527		2167
1528	sub save {	2168	sub save {
1529	my ($self) = @_;	2169	my ($self) = @_;
1530		2170
1531	my $lock = cf::lock_acquire "map_data:" . $self->path;	2171	my $lock = cf::lock_acquire "map_data:$self->{path}";
1532		2172
1533	$self->{last_save} = $cf::RUNTIME;	2173	$self->{last_save} = $cf::RUNTIME;
1534		2174
1535	return unless $self->dirty;	2175	return unless $self->dirty;
1536		2176
…		…
1542	return if $self->{deny_save};	2182	return if $self->{deny_save};
1543		2183
1544	local $self->{last_access} = $self->last_access;#d#	2184	local $self->{last_access} = $self->last_access;#d#
1545		2185
1546	cf::async {	2186	cf::async {
		2187	$Coro::current->{desc} = "map player save";
1547	$_->contr->save for $self->players;	2188	$_->contr->save for $self->players;
1548	};	2189	};
1549		2190
1550	if ($uniq) {	2191	if ($uniq) {
1551	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2192	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
…		…
1559	my ($self) = @_;	2200	my ($self) = @_;
1560		2201
1561	# save first because save cedes	2202	# save first because save cedes
1562	$self->save;	2203	$self->save;
1563		2204
1564	my $lock = cf::lock_acquire "map_data:" . $self->path;	2205	my $lock = cf::lock_acquire "map_data:$self->{path}";
1565		2206
1566	return if $self->players;	2207	return if $self->players;
1567	return if $self->in_memory != cf::MAP_IN_MEMORY;	2208	return if $self->in_memory != cf::MAP_IN_MEMORY;
1568	return if $self->{deny_save};	2209	return if $self->{deny_save};
1569		2210
		2211	$self->in_memory (cf::MAP_SWAPPED);
		2212
		2213	$self->deactivate;
		2214	$_->clear_links_to ($self) for values %cf::MAP;
1570	$self->clear;	2215	$self->clear;
1571	$self->in_memory (cf::MAP_SWAPPED);
1572	}	2216	}
1573		2217
1574	sub reset_at {	2218	sub reset_at {
1575	my ($self) = @_;	2219	my ($self) = @_;
1576		2220
1577	# TODO: safety, remove and allow resettable per-player maps	2221	# 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};	2222	return 1e99 if $self->{deny_reset};
1580		2223
1581	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2224	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1582	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2225	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1583		2226
…		…
1594	my ($self) = @_;	2237	my ($self) = @_;
1595		2238
1596	my $lock = cf::lock_acquire "map_data:$self->{path}";	2239	my $lock = cf::lock_acquire "map_data:$self->{path}";
1597		2240
1598	return if $self->players;	2241	return if $self->players;
1599	return if $self->isa ("ext::map_per_player");#d#
1600		2242
1601	warn "resetting map ", $self->path;#d#	2243	warn "resetting map ", $self->path;
		2244
		2245	$self->in_memory (cf::MAP_SWAPPED);
		2246
		2247	# need to save uniques path
		2248	unless ($self->{deny_save}) {
		2249	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2250
		2251	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2252	if $uniq;
		2253	}
1602		2254
1603	delete $cf::MAP{$self->path};	2255	delete $cf::MAP{$self->path};
1604		2256
1605	$self->in_memory (cf::MAP_SWAPPED);	2257	$self->deactivate;
		2258	$_->clear_links_to ($self) for values %cf::MAP;
1606	$self->clear;	2259	$self->clear;
1607
1608	$_->clear_links_to ($self) for values %cf::MAP;
1609		2260
1610	$self->unlink_save;	2261	$self->unlink_save;
1611	$self->destroy;	2262	$self->destroy;
1612	}	2263	}
1613		2264
1614	my $nuke_counter = "aaaa";	2265	my $nuke_counter = "aaaa";
1615		2266
1616	sub nuke {	2267	sub nuke {
1617	my ($self) = @_;	2268	my ($self) = @_;
1618		2269
		2270	{
		2271	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2272
1619	delete $cf::MAP{$self->path};	2273	delete $cf::MAP{$self->path};
1620		2274
1621	$self->unlink_save;	2275	$self->unlink_save;
1622		2276
1623	bless $self, "cf::map";	2277	bless $self, "cf::map";
1624	delete $self->{deny_reset};	2278	delete $self->{deny_reset};
1625	$self->{deny_save} = 1;	2279	$self->{deny_save} = 1;
1626	$self->reset_timeout (1);	2280	$self->reset_timeout (1);
1627	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2281	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1628		2282
1629	$cf::MAP{$self->path} = $self;	2283	$cf::MAP{$self->path} = $self;
		2284	}
1630		2285
1631	$self->reset; # polite request, might not happen	2286	$self->reset; # polite request, might not happen
		2287	}
		2288
		2289	=item $maps = cf::map::tmp_maps
		2290
		2291	Returns an arrayref with all map paths of currently instantiated and saved
		2292	maps. May block.
		2293
		2294	=cut
		2295
		2296	sub tmp_maps() {
		2297	[
		2298	map {
		2299	utf8::decode $_;
		2300	/\.map$/
		2301	? normalise $_
		2302	: ()
		2303	} @{ aio_readdir $TMPDIR or [] }
		2304	]
		2305	}
		2306
		2307	=item $maps = cf::map::random_maps
		2308
		2309	Returns an arrayref with all map paths of currently instantiated and saved
		2310	random maps. May block.
		2311
		2312	=cut
		2313
		2314	sub random_maps() {
		2315	[
		2316	map {
		2317	utf8::decode $_;
		2318	/\.map$/
		2319	? normalise "?random/$_"
		2320	: ()
		2321	} @{ aio_readdir $RANDOMDIR or [] }
		2322	]
1632	}	2323	}
1633		2324
1634	=item cf::map::unique_maps	2325	=item cf::map::unique_maps
1635		2326
1636	Returns an arrayref of paths of all shared maps that have	2327	Returns an arrayref of paths of all shared maps that have
1637	instantiated unique items. May block.	2328	instantiated unique items. May block.
1638		2329
1639	=cut	2330	=cut
1640		2331
1641	sub unique_maps() {	2332	sub unique_maps() {
1642	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2333	[
1643	or return;	2334	map {
1644
1645	my @paths;
1646
1647	for (@$files) {
1648	utf8::decode $_;	2335	utf8::decode $_;
1649	next if /\.pst$/;	2336	/\.map$/
1650	next unless /^$PATH_SEP/o;	2337	? normalise $_
1651		2338	: ()
1652	push @paths, cf::map::normalise $_;	2339	} @{ aio_readdir $UNIQUEDIR or [] }
1653	}	2340	]
1654
1655	\@paths
1656	}	2341	}
1657		2342
1658	package cf;	2343	package cf;
1659		2344
1660	=back	2345	=back
…		…
1678	map { $_, inv_recursive_ $_->inv } @_	2363	map { $_, inv_recursive_ $_->inv } @_
1679	}	2364	}
1680		2365
1681	sub inv_recursive {	2366	sub inv_recursive {
1682	inv_recursive_ inv $_[0]	2367	inv_recursive_ inv $_[0]
		2368	}
		2369
		2370	=item $ref = $ob->ref
		2371
		2372	creates and returns a persistent reference to an objetc that can be stored as a string.
		2373
		2374	=item $ob = cf::object::deref ($refstring)
		2375
		2376	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2377	even if the object actually exists. May block.
		2378
		2379	=cut
		2380
		2381	sub deref {
		2382	my ($ref) = @_;
		2383
		2384	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2385	my ($uuid, $name) = ($1, $2);
		2386	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2387	or return;
		2388	$pl->ob->uuid eq $uuid
		2389	or return;
		2390
		2391	$pl->ob
		2392	} else {
		2393	warn "$ref: cannot resolve object reference\n";
		2394	undef
		2395	}
1683	}	2396	}
1684		2397
1685	package cf;	2398	package cf;
1686		2399
1687	=back	2400	=back
…		…
1706		2419
1707	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2420	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1708		2421
1709	if ($self->{record_replies}) {	2422	if ($self->{record_replies}) {
1710	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2423	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2424
1711	} else {	2425	} else {
		2426	my $pl = $self->contr;
		2427
		2428	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2429	my $dialog = $pl->{npc_dialog};
		2430	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2431
		2432	} else {
1712	$msg = $npc->name . " says: $msg" if $npc;	2433	$msg = $npc->name . " says: $msg" if $npc;
1713	$self->message ($msg, $flags);	2434	$self->message ($msg, $flags);
		2435	}
1714	}	2436	}
		2437	}
		2438
		2439	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2440
		2441	=cut
		2442
		2443	sub cf::object::send_msg {
		2444	my $pl = shift->contr
		2445	or return;
		2446	$pl->send_msg (@_);
1715	}	2447	}
1716		2448
1717	=item $player_object->may ("access")	2449	=item $player_object->may ("access")
1718		2450
1719	Returns wether the given player is authorized to access resource "access"	2451	Returns wether the given player is authorized to access resource "access"
…		…
1766	$self->deactivate_recursive;	2498	$self->deactivate_recursive;
1767		2499
1768	return if UNIVERSAL::isa $self->map, "ext::map_link";	2500	return if UNIVERSAL::isa $self->map, "ext::map_link";
1769		2501
1770	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2502	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1771	if $self->map;	2503	if $self->map && $self->map->{path} ne "{link}";
1772		2504
1773	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2505	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1774	}	2506	}
1775		2507
1776	sub cf::object::player::leave_link {	2508	sub cf::object::player::leave_link {
1777	my ($self, $map, $x, $y) = @_;	2509	my ($self, $map, $x, $y) = @_;
		2510
		2511	return unless $self->contr->active;
1778		2512
1779	my $link_pos = delete $self->{_link_pos};	2513	my $link_pos = delete $self->{_link_pos};
1780		2514
1781	unless ($map) {	2515	unless ($map) {
1782	# restore original map position	2516	# restore original map position
…		…
1796	# use -1 or undef as default coordinates, not 0, 0	2530	# use -1 or undef as default coordinates, not 0, 0
1797	($x, $y) = ($map->enter_x, $map->enter_y)	2531	($x, $y) = ($map->enter_x, $map->enter_y)
1798	if $x <=0 && $y <= 0;	2532	if $x <=0 && $y <= 0;
1799		2533
1800	$map->load;	2534	$map->load;
1801	$map->load_diag;	2535	$map->load_neighbours;
1802		2536
1803	return unless $self->contr->active;	2537	return unless $self->contr->active;
1804	$self->activate_recursive;	2538	$self->activate_recursive;
		2539
		2540	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1805	$self->enter_map ($map, $x, $y);	2541	$self->enter_map ($map, $x, $y);
1806	}	2542	}
1807		2543
1808	cf::player->attach (	2544	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1809	on_logout => sub {
1810	my ($pl) = @_;
1811		2545
1812	# abort map switching before logout	2546	Moves the player to the given map-path and coordinates by first freezing
1813	if ($pl->ob->{_link_pos}) {	2547	her, loading and preparing them map, calling the provided $check callback
1814	cf::sync_job {	2548	that has to return the map if sucecssful, and then unfreezes the player on
1815	$pl->ob->leave_link	2549	the new (success) or old (failed) map position. In either case, $done will
1816	};	2550	be called at the end of this process.
1817	}
1818	},
1819	on_login => sub {
1820	my ($pl) = @_;
1821		2551
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	2552	=cut
		2553
		2554	our $GOTOGEN;
1843		2555
1844	sub cf::object::player::goto {	2556	sub cf::object::player::goto {
1845	my ($self, $path, $x, $y) = @_;	2557	my ($self, $path, $x, $y, $check, $done) = @_;
		2558
		2559	# do generation counting so two concurrent goto's will be executed in-order
		2560	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1846		2561
1847	$self->enter_link;	2562	$self->enter_link;
1848		2563
1849	(async {	2564	(async {
		2565	$Coro::current->{desc} = "player::goto $path $x $y";
		2566
		2567	# *tag paths override both path and x|y
		2568	if ($path =~ /^\*(.*)$/) {
		2569	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2570	my $ob = $obs[rand @obs];
		2571
		2572	# see if we actually can go there
		2573	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2574	$ob = $obs[rand @obs];
		2575	} else {
		2576	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2577	}
		2578	# else put us there anyways for now #d#
		2579
		2580	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2581	} else {
		2582	($path, $x, $y) = (undef, undef, undef);
		2583	}
		2584	}
		2585
1850	my $map = eval {	2586	my $map = eval {
1851	my $map = cf::map::find $path;	2587	my $map = defined $path ? cf::map::find $path : undef;
		2588
		2589	if ($map) {
1852	$map = $map->customise_for ($self) if $map;	2590	$map = $map->customise_for ($self);
		2591	$map = $check->($map) if $check && $map;
		2592	} else {
		2593	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2594	}
		2595
1853	$map	2596	$map
		2597	};
		2598
		2599	if ($@) {
		2600	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2601	LOG llevError | logBacktrace, Carp::longmess $@;
1854	} or	2602	}
1855	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1856		2603
		2604	if ($gen == $self->{_goto_generation}) {
		2605	delete $self->{_goto_generation};
1857	$self->leave_link ($map, $x, $y);	2606	$self->leave_link ($map, $x, $y);
		2607	}
		2608
		2609	$done->() if $done;
1858	})->prio (1);	2610	})->prio (1);
1859	}	2611	}
1860		2612
1861	=item $player_object->enter_exit ($exit_object)	2613	=item $player_object->enter_exit ($exit_object)
1862		2614
…		…
1899	$rmp->{origin_y} = $exit->y;	2651	$rmp->{origin_y} = $exit->y;
1900	}	2652	}
1901		2653
1902	$rmp->{random_seed} ||= $exit->random_seed;	2654	$rmp->{random_seed} ||= $exit->random_seed;
1903		2655
1904	my $data = cf::to_json $rmp;	2656	my $data = cf::encode_json $rmp;
1905	my $md5 = Digest::MD5::md5_hex $data;	2657	my $md5 = Digest::MD5::md5_hex $data;
1906	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2658	my $meta = "$RANDOMDIR/$md5.meta";
1907		2659
1908	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2660	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1909	aio_write $fh, 0, (length $data), $data, 0;	2661	aio_write $fh, 0, (length $data), $data, 0;
1910	undef $fh;	2662	undef $fh;
1911	aio_rename "$meta~", $meta;	2663	aio_rename "$meta~", $meta;
…		…
1920		2672
1921	return unless $self->type == cf::PLAYER;	2673	return unless $self->type == cf::PLAYER;
1922		2674
1923	if ($exit->slaying eq "/!") {	2675	if ($exit->slaying eq "/!") {
1924	#TODO: this should de-fi-ni-te-ly not be a sync-job	2676	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2677	# the problem is that $exit might not survive long enough
		2678	# so it needs to be done right now, right here
1925	cf::sync_job { prepare_random_map $exit };	2679	cf::sync_job { prepare_random_map $exit };
1926	}	2680	}
1927		2681
1928	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2682	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1929	my $hp = $exit->stats->hp;	2683	my $hp = $exit->stats->hp;
1930	my $sp = $exit->stats->sp;	2684	my $sp = $exit->stats->sp;
1931		2685
1932	$self->enter_link;	2686	$self->enter_link;
1933		2687
		2688	# if exit is damned, update players death & WoR home-position
		2689	$self->contr->savebed ($slaying, $hp, $sp)
		2690	if $exit->flag (FLAG_DAMNED);
		2691
1934	(async {	2692	(async {
		2693	$Coro::current->{desc} = "enter_exit $slaying $hp $sp";
		2694
1935	$self->deactivate_recursive; # just to be sure	2695	$self->deactivate_recursive; # just to be sure
1936	unless (eval {	2696	unless (eval {
1937	$self->goto ($slaying, $hp, $sp);	2697	$self->goto ($slaying, $hp, $sp);
1938		2698
1939	1;	2699	1;
1940	}) {	2700	}) {
1941	$self->message ("Something went wrong deep within the crossfire server. "	2701	$self->message ("Something went wrong deep within the crossfire server. "
1942	. "I'll try to bring you back to the map you were before. "	2702	. "I'll try to bring you back to the map you were before. "
1943	. "Please report this to the dungeon master!",	2703	. "Please report this to the dungeon master!",
1944	cf::NDI_UNIQUE | cf::NDI_RED);	2704	cf::NDI_UNIQUE | cf::NDI_RED);
1945		2705
1946	warn "ERROR in enter_exit: $@";	2706	warn "ERROR in enter_exit: $@";
1947	$self->leave_link;	2707	$self->leave_link;
1948	}	2708	}
1949	})->prio (1);	2709	})->prio (1);
…		…
1962		2722
1963	sub cf::client::send_drawinfo {	2723	sub cf::client::send_drawinfo {
1964	my ($self, $text, $flags) = @_;	2724	my ($self, $text, $flags) = @_;
1965		2725
1966	utf8::encode $text;	2726	utf8::encode $text;
1967	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2727	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1968	}	2728	}
1969		2729
		2730	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2731
		2732	Send a drawinfo or msg packet to the client, formatting the msg for the
		2733	client if neccessary. C<$type> should be a string identifying the type of
		2734	the message, with C<log> being the default. If C<$color> is negative, suppress
		2735	the message unless the client supports the msg packet.
		2736
		2737	=cut
		2738
		2739	# non-persistent channels (usually the info channel)
		2740	our %CHANNEL = (
		2741	"c/identify" => {
		2742	id => "infobox",
		2743	title => "Identify",
		2744	reply => undef,
		2745	tooltip => "Items recently identified",
		2746	},
		2747	"c/examine" => {
		2748	id => "infobox",
		2749	title => "Examine",
		2750	reply => undef,
		2751	tooltip => "Signs and other items you examined",
		2752	},
		2753	"c/book" => {
		2754	id => "infobox",
		2755	title => "Book",
		2756	reply => undef,
		2757	tooltip => "The contents of a note or book",
		2758	},
		2759	"c/lookat" => {
		2760	id => "infobox",
		2761	title => "Look",
		2762	reply => undef,
		2763	tooltip => "What you saw there",
		2764	},
		2765	"c/who" => {
		2766	id => "infobox",
		2767	title => "Players",
		2768	reply => undef,
		2769	tooltip => "Shows players who are currently online",
		2770	},
		2771	"c/body" => {
		2772	id => "infobox",
		2773	title => "Body Parts",
		2774	reply => undef,
		2775	tooltip => "Shows which body parts you posess and are available",
		2776	},
		2777	"c/uptime" => {
		2778	id => "infobox",
		2779	title => "Uptime",
		2780	reply => undef,
		2781	tooltip => "How long the server has been running since last restart",
		2782	},
		2783	"c/mapinfo" => {
		2784	id => "infobox",
		2785	title => "Map Info",
		2786	reply => undef,
		2787	tooltip => "Information related to the maps",
		2788	},
		2789	);
		2790
		2791	sub cf::client::send_msg {
		2792	my ($self, $channel, $msg, $color, @extra) = @_;
		2793
		2794	$msg = $self->pl->expand_cfpod ($msg);
		2795
		2796	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2797
		2798	# check predefined channels, for the benefit of C
		2799	if ($CHANNEL{$channel}) {
		2800	$channel = $CHANNEL{$channel};
		2801
		2802	$self->ext_msg (channel_info => $channel)
		2803	if $self->can_msg;
		2804
		2805	$channel = $channel->{id};
		2806
		2807	} elsif (ref $channel) {
		2808	# send meta info to client, if not yet sent
		2809	unless (exists $self->{channel}{$channel->{id}}) {
		2810	$self->{channel}{$channel->{id}} = $channel;
		2811	$self->ext_msg (channel_info => $channel)
		2812	if $self->can_msg;
		2813	}
		2814
		2815	$channel = $channel->{id};
		2816	}
		2817
		2818	return unless @extra || length $msg;
		2819
		2820	if ($self->can_msg) {
		2821	# default colour, mask it out
		2822	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2823	if $color & cf::NDI_DEF;
		2824
		2825	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2826	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2827	} else {
		2828	if ($color >= 0) {
		2829	# replace some tags by gcfclient-compatible ones
		2830	for ($msg) {
		2831	1 while
		2832	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2833	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2834	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2835	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2836	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2837	}
		2838
		2839	$color &= cf::NDI_COLOR_MASK;
		2840
		2841	utf8::encode $msg;
		2842
		2843	if (0 && $msg =~ /\[/) {
		2844	# COMMAND/INFO
		2845	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2846	} else {
		2847	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2848	$self->send_packet ("drawinfo $color $msg")
		2849	}
		2850	}
		2851	}
		2852	}
		2853
		2854	=item $client->ext_msg ($type, @msg)
		2855
		2856	Sends an ext event to the client.
		2857
		2858	=cut
		2859
		2860	sub cf::client::ext_msg($$@) {
		2861	my ($self, $type, @msg) = @_;
		2862
		2863	if ($self->extcmd == 2) {
		2864	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2865	} elsif ($self->extcmd == 1) { # TODO: remove
		2866	push @msg, msgtype => "event_$type";
		2867	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2868	}
		2869	}
		2870
		2871	=item $client->ext_reply ($msgid, @msg)
		2872
		2873	Sends an ext reply to the client.
		2874
		2875	=cut
		2876
		2877	sub cf::client::ext_reply($$@) {
		2878	my ($self, $id, @msg) = @_;
		2879
		2880	if ($self->extcmd == 2) {
		2881	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2882	} elsif ($self->extcmd == 1) {
		2883	#TODO: version 1, remove
		2884	unshift @msg, msgtype => "reply", msgid => $id;
		2885	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2886	}
		2887	}
1970		2888
1971	=item $success = $client->query ($flags, "text", \&cb)	2889	=item $success = $client->query ($flags, "text", \&cb)
1972		2890
1973	Queues a query to the client, calling the given callback with	2891	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>,	2892	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>.	2893	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1976		2894
1977	Queries can fail, so check the return code. Or don't, as queries will become	2895	Queries can fail, so check the return code. Or don't, as queries will
1978	reliable at some point in the future.	2896	become reliable at some point in the future.
1979		2897
1980	=cut	2898	=cut
1981		2899
1982	sub cf::client::query {	2900	sub cf::client::query {
1983	my ($self, $flags, $text, $cb) = @_;	2901	my ($self, $flags, $text, $cb) = @_;
…		…
1991	utf8::encode $text;	2909	utf8::encode $text;
1992	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2910	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1993		2911
1994	$self->send_packet ($self->{query_queue}[0][0])	2912	$self->send_packet ($self->{query_queue}[0][0])
1995	if @{ $self->{query_queue} } == 1;	2913	if @{ $self->{query_queue} } == 1;
		2914
		2915	1
1996	}	2916	}
1997		2917
1998	cf::client->attach (	2918	cf::client->attach (
		2919	on_connect => sub {
		2920	my ($ns) = @_;
		2921
		2922	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2923	},
1999	on_reply => sub {	2924	on_reply => sub {
2000	my ($ns, $msg) = @_;	2925	my ($ns, $msg) = @_;
2001		2926
2002	# this weird shuffling is so that direct followup queries	2927	# this weird shuffling is so that direct followup queries
2003	# get handled first	2928	# get handled first
…		…
2015	} else {	2940	} else {
2016	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2941	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2017	}	2942	}
2018	}	2943	}
2019	},	2944	},
		2945	on_exticmd => sub {
		2946	my ($ns, $buf) = @_;
		2947
		2948	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2949
		2950	if (ref $msg) {
		2951	my ($type, $reply, @payload) =
		2952	"ARRAY" eq ref $msg
		2953	? @$msg
		2954	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2955
		2956	my @reply;
		2957
		2958	if (my $cb = $EXTICMD{$type}) {
		2959	@reply = $cb->($ns, @payload);
		2960	}
		2961
		2962	$ns->ext_reply ($reply, @reply)
		2963	if $reply;
		2964
		2965	} else {
		2966	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2967	}
		2968
		2969	cf::override;
		2970	},
2020	);	2971	);
2021		2972
2022	=item $client->async (\&cb)	2973	=item $client->async (\&cb)
2023		2974
2024	Create a new coroutine, running the specified callback. The coroutine will	2975	Create a new coroutine, running the specified callback. The coroutine will
…		…
2065	our $safe = new Safe "safe";	3016	our $safe = new Safe "safe";
2066	our $safe_hole = new Safe::Hole;	3017	our $safe_hole = new Safe::Hole;
2067		3018
2068	$SIG{FPE} = 'IGNORE';	3019	$SIG{FPE} = 'IGNORE';
2069		3020
2070	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3021	$safe->permit_only (Opcode::opset qw(
		3022	:base_core :base_mem :base_orig :base_math
		3023	grepstart grepwhile mapstart mapwhile
		3024	sort time
		3025	));
2071		3026
2072	# here we export the classes and methods available to script code	3027	# here we export the classes and methods available to script code
2073		3028
2074	=pod	3029	=pod
2075		3030
2076	The following fucntions and emthods are available within a safe environment:	3031	The following functions and methods are available within a safe environment:
2077		3032
2078	cf::object contr pay_amount pay_player map	3033	cf::object
		3034	contr pay_amount pay_player map x y force_find force_add destroy
		3035	insert remove name archname title slaying race decrease_ob_nr
		3036
2079	cf::object::player player	3037	cf::object::player
2080	cf::player peaceful	3038	player
2081	cf::map trigger	3039
		3040	cf::player
		3041	peaceful
		3042
		3043	cf::map
		3044	trigger
2082		3045
2083	=cut	3046	=cut
2084		3047
2085	for (	3048	for (
2086	["cf::object" => qw(contr pay_amount pay_player map)],	3049	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3050	insert remove inv name archname title slaying race
		3051	decrease_ob_nr destroy)],
2087	["cf::object::player" => qw(player)],	3052	["cf::object::player" => qw(player)],
2088	["cf::player" => qw(peaceful)],	3053	["cf::player" => qw(peaceful)],
2089	["cf::map" => qw(trigger)],	3054	["cf::map" => qw(trigger)],
2090	) {	3055	) {
2091	no strict 'refs';	3056	no strict 'refs';
…		…
2162	=back	3127	=back
2163		3128
2164	=cut	3129	=cut
2165		3130
2166	#############################################################################	3131	#############################################################################
		3132	# the server's init and main functions
2167		3133
2168	=head2 EXTENSION DATABASE SUPPORT	3134	sub load_facedata($) {
		3135	my ($path) = @_;
2169		3136
2170	Crossfire maintains a very simple database for extension use. It can	3137	# HACK to clear player env face cache, we need some signal framework
2171	currently store anything that can be serialised using Storable, which	3138	# for this (global event?)
2172	excludes objects.	3139	%ext::player_env::MUSIC_FACE_CACHE = ();
2173		3140
2174	The parameter C<$family> should best start with the name of the extension	3141	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2175	using it, it should be unique.
2176		3142
2177	=over 4	3143	warn "loading facedata from $path\n";
2178		3144
2179	=item $hashref = cf::db_get $family	3145	my $facedata;
		3146	0 < aio_load $path, $facedata
		3147	or die "$path: $!";
2180		3148
2181	Return a hashref for use by the extension C<$family>, which can be	3149	$facedata = Coro::Storable::thaw $facedata;
2182	modified. After modifications, you have to call C<cf::db_dirty> or
2183	C<cf::db_sync>.
2184		3150
2185	=item $value = cf::db_get $family => $key	3151	$facedata->{version} == 2
		3152	or cf::cleanup "$path: version mismatch, cannot proceed.";
2186		3153
2187	Returns a single value from the database	3154	# patch in the exptable
2188		3155	$facedata->{resource}{"res/exp_table"} = {
2189	=item cf::db_put $family => $hashref	3156	type => FT_RSRC,
2190		3157	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
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	}	3158	};
		3159	cf::cede_to_tick;
2217		3160
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	}	3161	{
		3162	my $faces = $facedata->{faceinfo};
2229		3163
2230	my $dirty;	3164	while (my ($face, $info) = each %$faces) {
		3165	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2231		3166
2232	sub db_sync() {	3167	cf::face::set_visibility $idx, $info->{visibility};
2233	db_save if $dirty;	3168	cf::face::set_magicmap $idx, $info->{magicmap};
2234	undef $dirty;	3169	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2235	}	3170	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2236		3171
2237	my $idle = Event->idle (	3172	cf::cede_to_tick;
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	},	3173	}
2271	);
2272	}
2273		3174
2274	#############################################################################	3175	while (my ($face, $info) = each %$faces) {
2275	# the server's main()	3176	next unless $info->{smooth};
2276		3177
2277	sub cfg_load {	3178	my $idx = cf::face::find $face
		3179	or next;
		3180
		3181	if (my $smooth = cf::face::find $info->{smooth}) {
		3182	cf::face::set_smooth $idx, $smooth;
		3183	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3184	} else {
		3185	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3186	}
		3187
		3188	cf::cede_to_tick;
		3189	}
		3190	}
		3191
		3192	{
		3193	my $anims = $facedata->{animinfo};
		3194
		3195	while (my ($anim, $info) = each %$anims) {
		3196	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3197	cf::cede_to_tick;
		3198	}
		3199
		3200	cf::anim::invalidate_all; # d'oh
		3201	}
		3202
		3203	{
		3204	# TODO: for gcfclient pleasure, we should give resources
		3205	# that gcfclient doesn't grok a >10000 face index.
		3206	my $res = $facedata->{resource};
		3207
		3208	while (my ($name, $info) = each %$res) {
		3209	if (defined $info->{type}) {
		3210	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3211	my $data;
		3212
		3213	if ($info->{type} & 1) {
		3214	# prepend meta info
		3215
		3216	my $meta = $enc->encode ({
		3217	name => $name,
		3218	%{ $info->{meta} || {} },
		3219	});
		3220
		3221	$data = pack "(w/a*)*", $meta, $info->{data};
		3222	} else {
		3223	$data = $info->{data};
		3224	}
		3225
		3226	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3227	cf::face::set_type $idx, $info->{type};
		3228	} else {
		3229	$RESOURCE{$name} = $info;
		3230	}
		3231
		3232	cf::cede_to_tick;
		3233	}
		3234	}
		3235
		3236	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3237
		3238	1
		3239	}
		3240
		3241	cf::global->attach (on_resource_update => sub {
		3242	if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
		3243	$soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
		3244
		3245	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3246	my $sound = $soundconf->{compat}[$_]
		3247	or next;
		3248
		3249	my $face = cf::face::find "sound/$sound->[1]";
		3250	cf::sound::set $sound->[0] => $face;
		3251	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3252	}
		3253
		3254	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3255	my $face = cf::face::find "sound/$v";
		3256	cf::sound::set $k => $face;
		3257	}
		3258	}
		3259	});
		3260
		3261	register_exticmd fx_want => sub {
		3262	my ($ns, $want) = @_;
		3263
		3264	while (my ($k, $v) = each %$want) {
		3265	$ns->fx_want ($k, $v);
		3266	}
		3267	};
		3268
		3269	sub reload_regions {
		3270	# HACK to clear player env face cache, we need some signal framework
		3271	# for this (global event?)
		3272	%ext::player_env::MUSIC_FACE_CACHE = ();
		3273
		3274	load_resource_file "$MAPDIR/regions"
		3275	or die "unable to load regions file\n";
		3276
		3277	for (cf::region::list) {
		3278	$_->{match} = qr/$_->{match}/
		3279	if exists $_->{match};
		3280	}
		3281	}
		3282
		3283	sub reload_facedata {
		3284	load_facedata "$DATADIR/facedata"
		3285	or die "unable to load facedata\n";
		3286	}
		3287
		3288	sub reload_archetypes {
		3289	load_resource_file "$DATADIR/archetypes"
		3290	or die "unable to load archetypes\n";
		3291	#d# NEED to laod twice to resolve forward references
		3292	# this really needs to be done in an extra post-pass
		3293	# (which needs to be synchronous, so solve it differently)
		3294	load_resource_file "$DATADIR/archetypes"
		3295	or die "unable to load archetypes\n";
		3296	}
		3297
		3298	sub reload_treasures {
		3299	load_resource_file "$DATADIR/treasures"
		3300	or die "unable to load treasurelists\n";
		3301	}
		3302
		3303	sub reload_resources {
		3304	warn "reloading resource files...\n";
		3305
		3306	reload_regions;
		3307	reload_facedata;
		3308	#reload_archetypes;#d#
		3309	reload_archetypes;
		3310	reload_treasures;
		3311
		3312	warn "finished reloading resource files\n";
		3313	}
		3314
		3315	sub init {
		3316	reload_resources;
		3317	}
		3318
		3319	sub reload_config {
2278	open my $fh, "<:utf8", cf::confdir . "/config"	3320	open my $fh, "<:utf8", "$CONFDIR/config"
2279	or return;	3321	or return;
2280		3322
2281	local $/;	3323	local $/;
2282	*CFG = YAML::Syck::Load <$fh>;	3324	*CFG = YAML::Load <$fh>;
2283		3325
2284	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3326	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2285		3327
2286	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	3328	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2287	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};	3329	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
…		…
2298	sub main {	3340	sub main {
2299	# we must not ever block the main coroutine	3341	# we must not ever block the main coroutine
2300	local $Coro::idle = sub {	3342	local $Coro::idle = sub {
2301	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3343	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2302	(async {	3344	(async {
2303	Event::one_event;	3345	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3346	EV::loop EV::LOOP_ONESHOT;
2304	})->prio (Coro::PRIO_MAX);	3347	})->prio (Coro::PRIO_MAX);
2305	};	3348	};
2306		3349
2307	cfg_load;	3350	reload_config;
2308	db_load;	3351	db_init;
2309	load_extensions;	3352	load_extensions;
2310		3353
2311	$TICK_WATCHER->start;	3354	$TICK_WATCHER->start;
		3355	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
2312	Event::loop;	3356	EV::loop;
2313	}	3357	}
2314		3358
2315	#############################################################################	3359	#############################################################################
2316	# initialisation and cleanup	3360	# initialisation and cleanup
2317		3361
2318	# install some emergency cleanup handlers	3362	# install some emergency cleanup handlers
2319	BEGIN {	3363	BEGIN {
		3364	our %SIGWATCHER = ();
2320	for my $signal (qw(INT HUP TERM)) {	3365	for my $signal (qw(INT HUP TERM)) {
2321	Event->signal (	3366	$SIGWATCHER{$signal} = EV::signal $signal, sub {
2322	reentrant => 0,
2323	data => WF_AUTOCANCEL,
2324	signal => $signal,
2325	prio => 0,
2326	cb => sub {
2327	cf::cleanup "SIG$signal";	3367	cf::cleanup "SIG$signal";
2328	},
2329	);	3368	};
		3369	}
		3370	}
		3371
		3372	sub write_runtime {
		3373	my $runtime = "$LOCALDIR/runtime";
		3374
		3375	# first touch the runtime file to show we are still running:
		3376	# the fsync below can take a very very long time.
		3377
		3378	IO::AIO::aio_utime $runtime, undef, undef;
		3379
		3380	my $guard = cf::lock_acquire "write_runtime";
		3381
		3382	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3383	or return;
		3384
		3385	my $value = $cf::RUNTIME + 90 + 10;
		3386	# 10 is the runtime save interval, for a monotonic clock
		3387	# 60 allows for the watchdog to kill the server.
		3388
		3389	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3390	and return;
		3391
		3392	# always fsync - this file is important
		3393	aio_fsync $fh
		3394	and return;
		3395
		3396	# touch it again to show we are up-to-date
		3397	aio_utime $fh, undef, undef;
		3398
		3399	close $fh
		3400	or return;
		3401
		3402	aio_rename "$runtime~", $runtime
		3403	and return;
		3404
		3405	warn "runtime file written.\n";
		3406
2330	}	3407	1
2331	}	3408	}
2332		3409
2333	sub emergency_save() {	3410	sub emergency_save() {
2334	my $freeze_guard = cf::freeze_mainloop;	3411	my $freeze_guard = cf::freeze_mainloop;
2335		3412
…		…
2341	# and maps saved/destroyed asynchronously.	3418	# and maps saved/destroyed asynchronously.
2342	warn "begin emergency player save\n";	3419	warn "begin emergency player save\n";
2343	for my $login (keys %cf::PLAYER) {	3420	for my $login (keys %cf::PLAYER) {
2344	my $pl = $cf::PLAYER{$login} or next;	3421	my $pl = $cf::PLAYER{$login} or next;
2345	$pl->valid or next;	3422	$pl->valid or next;
		3423	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2346	$pl->save;	3424	$pl->save;
2347	}	3425	}
2348	warn "end emergency player save\n";	3426	warn "end emergency player save\n";
2349		3427
2350	warn "begin emergency map save\n";	3428	warn "begin emergency map save\n";
…		…
2352	my $map = $cf::MAP{$path} or next;	3430	my $map = $cf::MAP{$path} or next;
2353	$map->valid or next;	3431	$map->valid or next;
2354	$map->save;	3432	$map->save;
2355	}	3433	}
2356	warn "end emergency map save\n";	3434	warn "end emergency map save\n";
		3435
		3436	warn "begin emergency database checkpoint\n";
		3437	BDB::db_env_txn_checkpoint $DB_ENV;
		3438	warn "end emergency database checkpoint\n";
2357	};	3439	};
2358		3440
2359	warn "leave emergency perl save\n";	3441	warn "leave emergency perl save\n";
2360	}	3442	}
2361		3443
		3444	sub post_cleanup {
		3445	my ($make_core) = @_;
		3446
		3447	warn Carp::longmess "post_cleanup backtrace"
		3448	if $make_core;
		3449	}
		3450
2362	sub reload() {	3451	sub do_reload_perl() {
2363	# can/must only be called in main	3452	# can/must only be called in main
2364	if ($Coro::current != $Coro::main) {	3453	if ($Coro::current != $Coro::main) {
2365	warn "can only reload from main coroutine";	3454	warn "can only reload from main coroutine";
2366	return;	3455	return;
2367	}	3456	}
2368		3457
2369	warn "reloading...";	3458	warn "reloading...";
2370		3459
2371	warn "cancelling server ticker";	3460	warn "entering sync_job";
2372	$TICK_WATCHER->cancel;
2373		3461
		3462	cf::sync_job {
		3463	cf::write_runtime; # external watchdog should not bark
2374	cf::emergency_save;	3464	cf::emergency_save;
		3465	cf::write_runtime; # external watchdog should not bark
2375		3466
2376	eval {	3467	warn "syncing database to disk";
		3468	BDB::db_env_txn_checkpoint $DB_ENV;
		3469
2377	# if anything goes wrong in here, we should simply crash as we already saved	3470	# if anything goes wrong in here, we should simply crash as we already saved
2378
2379	warn "syncing database to disk";
2380	cf::db_sync;
2381
2382	warn "cancelling all WF_AUTOCANCEL watchers";
2383	for (Event::all_watchers) {
2384	$_->cancel if $_->data & WF_AUTOCANCEL;
2385	}
2386		3471
2387	warn "flushing outstanding aio requests";	3472	warn "flushing outstanding aio requests";
2388	for (;;) {	3473	for (;;) {
		3474	BDB::flush;
2389	IO::AIO::flush;	3475	IO::AIO::flush;
2390	Coro::cede;	3476	Coro::cede_notself;
2391	last unless IO::AIO::nreqs;	3477	last unless IO::AIO::nreqs || BDB::nreqs;
2392	warn "iterate...";	3478	warn "iterate...";
2393	}	3479	}
		3480
		3481	++$RELOAD;
2394		3482
2395	warn "cancelling all extension coros";	3483	warn "cancelling all extension coros";
2396	$_->cancel for values %EXT_CORO;	3484	$_->cancel for values %EXT_CORO;
2397	%EXT_CORO = ();	3485	%EXT_CORO = ();
2398		3486
2399	warn "removing commands";	3487	warn "removing commands";
2400	%COMMAND = ();	3488	%COMMAND = ();
2401		3489
2402	warn "removing ext commands";	3490	warn "removing ext/exti commands";
2403	%EXTCMD = ();	3491	%EXTCMD = ();
		3492	%EXTICMD = ();
2404		3493
2405	warn "unloading/nuking all extensions";	3494	warn "unloading/nuking all extensions";
2406	for my $pkg (@EXTS) {	3495	for my $pkg (@EXTS) {
2407	warn "... unloading $pkg";	3496	warn "... unloading $pkg";
2408		3497
…		…
2438	Symbol::delete_package "safe::$_"	3527	Symbol::delete_package "safe::$_"
2439	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3528	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2440		3529
2441	warn "unloading cf.pm \"a bit\"";	3530	warn "unloading cf.pm \"a bit\"";
2442	delete $INC{"cf.pm"};	3531	delete $INC{"cf.pm"};
		3532	delete $INC{"cf/pod.pm"};
2443		3533
2444	# don't, removes xs symbols, too,	3534	# don't, removes xs symbols, too,
2445	# and global variables created in xs	3535	# and global variables created in xs
2446	#Symbol::delete_package __PACKAGE__;	3536	#Symbol::delete_package __PACKAGE__;
2447		3537
…		…
2450	warn "reloading cf.pm";	3540	warn "reloading cf.pm";
2451	require cf;	3541	require cf;
2452	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3542	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2453		3543
2454	warn "loading config and database again";	3544	warn "loading config and database again";
2455	cf::cfg_load;	3545	cf::reload_config;
2456	cf::db_load;
2457		3546
2458	warn "loading extensions";	3547	warn "loading extensions";
2459	cf::load_extensions;	3548	cf::load_extensions;
2460		3549
2461	warn "reattaching attachments to objects/players";	3550	warn "reattaching attachments to objects/players";
2462	_global_reattach;	3551	_global_reattach; # objects, sockets
2463	warn "reattaching attachments to maps";	3552	warn "reattaching attachments to maps";
2464	reattach $_ for values %MAP;	3553	reattach $_ for values %MAP;
		3554	warn "reattaching attachments to players";
		3555	reattach $_ for values %PLAYER;
2465		3556
2466	warn "restarting server ticker";	3557	warn "leaving sync_job";
2467		3558
2468	$TICK_WATCHER->start;	3559	1
		3560	} or do {
		3561	warn $@;
		3562	cf::cleanup "error while reloading, exiting.";
2469	};	3563	};
2470
2471	if ($@) {
2472	warn $@;
2473	warn "error while reloading, exiting.";
2474	exit 1;
2475	}
2476		3564
2477	warn "reloaded";	3565	warn "reloaded";
2478	};	3566	};
2479		3567
2480	our $RELOAD_WATCHER; # used only during reload	3568	our $RELOAD_WATCHER; # used only during reload
2481		3569
		3570	sub reload_perl() {
		3571	# doing reload synchronously and two reloads happen back-to-back,
		3572	# coro crashes during coro_state_free->destroy here.
		3573
		3574	$RELOAD_WATCHER ||= EV::timer 0, 0, sub {
		3575	do_reload_perl;
		3576	undef $RELOAD_WATCHER;
		3577	};
		3578	}
		3579
2482	register_command "reload" => sub {	3580	register_command "reload" => sub {
2483	my ($who, $arg) = @_;	3581	my ($who, $arg) = @_;
2484		3582
2485	if ($who->flag (FLAG_WIZ)) {	3583	if ($who->flag (FLAG_WIZ)) {
2486	$who->message ("reloading server.");	3584	$who->message ("reloading server.");
2487		3585	async {
2488	# doing reload synchronously and two reloads happen back-to-back,	3586	$Coro::current->{desc} = "perl_reload";
2489	# coro crashes during coro_state_free->destroy here.
2490
2491	$RELOAD_WATCHER ||= Event->timer (
2492	reentrant => 0,
2493	after => 0,
2494	data => WF_AUTOCANCEL,
2495	cb => sub {
2496	reload;	3587	reload_perl;
2497	undef $RELOAD_WATCHER;
2498	},
2499	);	3588	};
2500	}	3589	}
2501	};	3590	};
2502		3591
2503	unshift @INC, $LIBDIR;	3592	unshift @INC, $LIBDIR;
2504		3593
2505	my $bug_warning = 0;	3594	my $bug_warning = 0;
2506		3595
2507	$TICK_WATCHER = Event->timer (	3596	our @WAIT_FOR_TICK;
2508	reentrant => 0,	3597	our @WAIT_FOR_TICK_BEGIN;
2509	parked => 1,	3598
2510	prio => 0,	3599	sub wait_for_tick {
2511	at => $NEXT_TICK || $TICK,	3600	return unless $TICK_WATCHER->is_active;
2512	data => WF_AUTOCANCEL,	3601	return if $Coro::current == $Coro::main;
2513	cb => sub {	3602
		3603	my $signal = new Coro::Signal;
		3604	push @WAIT_FOR_TICK, $signal;
		3605	$signal->wait;
		3606	}
		3607
		3608	sub wait_for_tick_begin {
		3609	return unless $TICK_WATCHER->is_active;
		3610	return if $Coro::current == $Coro::main;
		3611
		3612	my $signal = new Coro::Signal;
		3613	push @WAIT_FOR_TICK_BEGIN, $signal;
		3614	$signal->wait;
		3615	}
		3616
		3617	$TICK_WATCHER = EV::periodic_ns 0, $TICK, 0, sub {
2514	if ($Coro::current != $Coro::main) {	3618	if ($Coro::current != $Coro::main) {
2515	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3619	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2516	unless ++$bug_warning > 10;	3620	unless ++$bug_warning > 10;
2517	return;	3621	return;
2518	}	3622	}
2519		3623
2520	$NOW = Event::time;	3624	$NOW = $tick_start = EV::now;
2521		3625
2522	cf::server_tick; # one server iteration	3626	cf::server_tick; # one server iteration
		3627
2523	$RUNTIME += $TICK;	3628	$RUNTIME += $TICK;
2524	$NEXT_TICK += $TICK;	3629	$NEXT_TICK = $_[0]->at;
2525		3630
2526	$WAIT_FOR_TICK->broadcast;	3631	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2527	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3632	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2528		3633	Coro::async_pool {
2529	Event::sweep;	3634	$Coro::current->{desc} = "runtime saver";
2530	Coro::cede_notself;
2531
2532	# my $AFTER = Event::time;
2533	# warn $AFTER - $NOW;#d#
2534
2535	# if we are delayed by four ticks or more, skip them all
2536	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2537
2538	$TICK_WATCHER->at ($NEXT_TICK);
2539	$TICK_WATCHER->start;
2540	},
2541	);
2542
2543	IO::AIO::max_poll_time $TICK * 0.1;
2544
2545	undef $Coro::AIO::WATCHER;
2546	$AIO_POLL_WATCHER = Event->io (
2547	reentrant => 0,
2548	fd => IO::AIO::poll_fileno,
2549	poll => 'r',
2550	prio => 6,
2551	data => WF_AUTOCANCEL,
2552	cb => \&IO::AIO::poll_cb,
2553	);
2554
2555	$WRITE_RUNTIME_WATCHER = Event->timer (
2556	reentrant => 0,
2557	data => WF_AUTOCANCEL,
2558	after => 1,
2559	interval => 10,
2560	prio => 6, # keep it lowest so it acts like a watchdog
2561	cb => Coro::unblock_sub {
2562	write_runtime	3635	write_runtime
2563	or warn "ERROR: unable to write runtime file: $!";	3636	or warn "ERROR: unable to write runtime file: $!";
		3637	};
2564	},	3638	}
2565	);	3639
		3640	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3641	$sig->send;
		3642	}
		3643	while (my $sig = shift @WAIT_FOR_TICK) {
		3644	$sig->send;
		3645	}
		3646
		3647	$LOAD = ($NOW - $tick_start) / $TICK;
		3648	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3649
		3650	_post_tick;
		3651	};
		3652	$TICK_WATCHER->priority (EV::MAXPRI);
		3653
		3654	{
		3655	# configure BDB
		3656
		3657	BDB::min_parallel 8;
		3658	BDB::max_poll_reqs $TICK * 0.1;
		3659	$Coro::BDB::WATCHER->priority (1);
		3660
		3661	unless ($DB_ENV) {
		3662	$DB_ENV = BDB::db_env_create;
		3663	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
		3664	| BDB::LOG_AUTOREMOVE, 1);
		3665	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3666	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3667
		3668	cf::sync_job {
		3669	eval {
		3670	BDB::db_env_open
		3671	$DB_ENV,
		3672	$BDBDIR,
		3673	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3674	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3675	0666;
		3676
		3677	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3678	};
		3679
		3680	cf::cleanup "db_env_open(db): $@" if $@;
		3681	};
		3682	}
		3683
		3684	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3685	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3686	};
		3687	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		3688	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3689	};
		3690	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3691	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3692	};
		3693	}
		3694
		3695	{
		3696	# configure IO::AIO
		3697
		3698	IO::AIO::min_parallel 8;
		3699	IO::AIO::max_poll_time $TICK * 0.1;
		3700	$Coro::AIO::WATCHER->priority (1);
		3701	}
		3702
		3703	my $_log_backtrace;
		3704
		3705	sub _log_backtrace {
		3706	my ($msg, @addr) = @_;
		3707
		3708	$msg =~ s/\n//;
		3709
		3710	# limit the # of concurrent backtraces
		3711	if ($_log_backtrace < 2) {
		3712	++$_log_backtrace;
		3713	async {
		3714	$Coro::current->{desc} = "abt $msg";
		3715
		3716	my @bt = fork_call {
		3717	@addr = map { sprintf "%x", $_ } @addr;
		3718	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3719	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3720	or die "addr2line: $!";
		3721
		3722	my @funcs;
		3723	my @res = <$fh>;
		3724	chomp for @res;
		3725	while (@res) {
		3726	my ($func, $line) = splice @res, 0, 2, ();
		3727	push @funcs, "[$func] $line";
		3728	}
		3729
		3730	@funcs
		3731	};
		3732
		3733	LOG llevInfo, "[ABT] $msg\n";
		3734	LOG llevInfo, "[ABT] $_\n" for @bt;
		3735	--$_log_backtrace;
		3736	};
		3737	} else {
		3738	LOG llevInfo, "[ABT] $msg\n";
		3739	LOG llevInfo, "[ABT] [suppressed]\n";
		3740	}
		3741	}
		3742
		3743	# load additional modules
		3744	use cf::pod;
2566		3745
2567	END { cf::emergency_save }	3746	END { cf::emergency_save }
2568		3747
2569	1	3748	1
2570		3749

Diff Legend

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