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

Diff Legend

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