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.154 by root, Tue Jan 9 15:36:19 2007 UTC vs.
Revision 1.410 by root, Tue Jan 15 12:02:24 2008 UTC

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

Diff Legend

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