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

Diff Legend

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