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.143 by root, Sun Jan 7 02:39:14 2007 UTC vs.
Revision 1.331 by root, Mon Aug 13 13:10:01 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 ();
		27	use Data::Dumper;
20	use Digest::MD5;	28	use Digest::MD5;
21	use Fcntl;	29	use Fcntl;
22	use IO::AIO 2.31 ();
23	use YAML::Syck ();	30	use YAML::Syck ();
		31	use IO::AIO 2.32 ();
24	use Time::HiRes;	32	use Time::HiRes;
		33	use Compress::LZF;
		34	use Digest::MD5 ();
25		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
26	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
27		43
28	# 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?
29	$YAML::Syck::ImplicitUnicode = 1;	45	$YAML::Syck::ImplicitUnicode = 1;
30		46
31	$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
32		48
33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	49	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34		50
35	our %COMMAND = ();	51	our %COMMAND = ();
36	our %COMMAND_TIME = ();	52	our %COMMAND_TIME = ();
		53
		54	our @EXTS = (); # list of extension package names
37	our %EXTCMD = ();	55	our %EXTCMD = ();
		56	our %EXTICMD = ();
		57	our %EXT_CORO = (); # coroutines bound to extensions
		58	our %EXT_MAP = (); # pluggable maps
38		59
		60	our $RELOAD; # number of reloads so far
39	our @EVENT;	61	our @EVENT;
40	our $LIBDIR = datadir . "/ext";
41		62
42	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(!)
43	our $TICK_WATCHER;	76	our $TICK_WATCHER;
		77	our $AIO_POLL_WATCHER;
		78	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44	our $NEXT_TICK;	79	our $NEXT_TICK;
45	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;
46		85
47	our %CFG;	86	our %CFG;
48		87
49	our $UPTIME; $UPTIME ||= time;	88	our $UPTIME; $UPTIME ||= time;
50	our $RUNTIME;	89	our $RUNTIME;
51		90
52	our %PLAYER; # all users	91	our %PLAYER; # all users
53	our %MAP; # all maps	92	our %MAP; # all maps
54	our $LINK_MAP; # the special {link} map	93	our $LINK_MAP; # the special {link} map, which is always available
55	our $RANDOM_MAPS = cf::localdir . "/random";	94
56	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
57		101
58	binmode STDOUT;	102	binmode STDOUT;
59	binmode STDERR;	103	binmode STDERR;
60		104
61	# read virtual server time, if available	105	# read virtual server time, if available
62	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	106	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
63	open my $fh, "<", cf::localdir . "/runtime"	107	open my $fh, "<", "$LOCALDIR/runtime"
64	or die "unable to read runtime file: $!";	108	or die "unable to read runtime file: $!";
65	$RUNTIME = <$fh> + 0.;	109	$RUNTIME = <$fh> + 0.;
66	}	110	}
67		111
68	mkdir cf::localdir;	112	mkdir $_
69	mkdir cf::localdir . "/" . cf::playerdir;	113	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
70	mkdir cf::localdir . "/" . cf::tmpdir;
71	mkdir cf::localdir . "/" . cf::uniquedir;
72	mkdir $RANDOM_MAPS;
73		114
74	# a special map that is always available
75	our $LINK_MAP;
76	our $EMERGENCY_POSITION;	115	our $EMERGENCY_POSITION;
		116
		117	sub cf::map::normalise;
77		118
78	#############################################################################	119	#############################################################################
79		120
80	=head2 GLOBAL VARIABLES	121	=head2 GLOBAL VARIABLES
81		122
…		…
88	=item $cf::RUNTIME	129	=item $cf::RUNTIME
89		130
90	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
91	every server tick.	132	every server tick.
92		133
93	=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
94		137
95	The perl library directory, where extensions and cf-specific modules can	138	Various directories - "/etc", read-only install directory, perl-library
96	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.
97		142
98	=item $cf::NOW	143	=item $cf::NOW
99		144
100	The time of the last (current) server tick.	145	The time of the last (current) server tick.
101		146
102	=item $cf::TICK	147	=item $cf::TICK
103		148
104	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.
105		160
106	=item %cf::CFG	161	=item %cf::CFG
107		162
108	Configuration for the server, loaded from C</etc/crossfire/config>, or	163	Configuration for the server, loaded from C</etc/crossfire/config>, or
109	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.
110		177
111	=back	178	=back
112		179
113	=cut	180	=cut
114		181
115	BEGIN {	182	BEGIN {
116	*CORE::GLOBAL::warn = sub {	183	*CORE::GLOBAL::warn = sub {
117	my $msg = join "", @_;	184	my $msg = join "", @_;
118	utf8::encode $msg;
119		185
120	$msg .= "\n"	186	$msg .= "\n"
121	unless $msg =~ /\n$/;	187	unless $msg =~ /\n$/;
122		188
		189	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		190
		191	utf8::encode $msg;
123	LOG llevError, "cfperl: $msg";	192	LOG llevError, $msg;
124	};	193	};
125	}	194	}
126		195
127	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	196	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
128	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	197	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
129	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	198	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
130	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	199	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
131	@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';
132	@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)
133		203
134	# 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
135	# within the Safe compartment.	205	# within the Safe compartment.
136	for my $pkg (qw(	206	for my $pkg (qw(
137	cf::global cf::attachable	207	cf::global cf::attachable
…		…
146		216
147	$Event::DIED = sub {	217	$Event::DIED = sub {
148	warn "error in event callback: @_";	218	warn "error in event callback: @_";
149	};	219	};
150		220
151	my %ext_pkg;	221	#############################################################################
152	my @exts;
153	my @hook;
154		222
155	=head2 UTILITY FUNCTIONS	223	=head2 UTILITY FUNCTIONS
156		224
157	=over 4	225	=over 4
158		226
159	=cut	227	=item dumpval $ref
160		228
161	use JSON::Syck (); # TODO# replace by JSON::PC once working	229	=cut
		230
		231	sub dumpval {
		232	eval {
		233	local $SIG{__DIE__};
		234	my $d;
		235	if (1) {
		236	$d = new Data::Dumper([$_[0]], ["*var"]);
		237	$d->Terse(1);
		238	$d->Indent(2);
		239	$d->Quotekeys(0);
		240	$d->Useqq(1);
		241	#$d->Bless(...);
		242	$d->Seen($_[1]) if @_ > 1;
		243	$d = $d->Dump();
		244	}
		245	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		246	$d
		247	} || "[unable to dump $_[0]: '$@']";
		248	}
162		249
163	=item $ref = cf::from_json $json	250	=item $ref = cf::from_json $json
164		251
165	Converts a JSON string into the corresponding perl data structure.	252	Converts a JSON string into the corresponding perl data structure.
166		253
167	=cut
168
169	sub from_json($) {
170	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
171	JSON::Syck::Load $_[0]
172	}
173
174	=item $json = cf::to_json $ref	254	=item $json = cf::to_json $ref
175		255
176	Converts a perl data structure into its JSON representation.	256	Converts a perl data structure into its JSON representation.
177		257
178	=cut	258	=cut
179		259
180	sub to_json($) {	260	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
181	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	261
182	JSON::Syck::Dump $_[0]	262	sub to_json ($) { $json_coder->encode ($_[0]) }
183	}	263	sub from_json ($) { $json_coder->decode ($_[0]) }
184		264
185	=item cf::lock_wait $string	265	=item cf::lock_wait $string
186		266
187	Wait until the given lock is available. See cf::lock_acquire.	267	Wait until the given lock is available. See cf::lock_acquire.
188		268
…		…
194	returned.	274	returned.
195		275
196	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
197	uses map_find and cf::map::load uses map_load).	277	uses map_find and cf::map::load uses map_load).
198		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
199	=cut	283	=cut
200		284
201	our %LOCK;	285	our %LOCK;
202		286
203	sub lock_wait($) {	287	sub lock_wait($) {
…		…
222	# wake up all waiters, to be on the safe side	306	# wake up all waiters, to be on the safe side
223	$_->ready for @{ delete $LOCK{$key} };	307	$_->ready for @{ delete $LOCK{$key} };
224	}	308	}
225	}	309	}
226		310
		311	sub lock_active($) {
		312	my ($key) = @_;
		313
		314	! ! $LOCK{$key}
		315	}
		316
227	sub freeze_mainloop {	317	sub freeze_mainloop {
228	return unless $TICK_WATCHER->is_active;	318	return unless $TICK_WATCHER->is_active;
229		319
230	my $guard = Coro::guard { $TICK_WATCHER->start };	320	my $guard = Coro::guard {
		321	$TICK_WATCHER->start;
		322	};
231	$TICK_WATCHER->stop;	323	$TICK_WATCHER->stop;
232	$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;
233	}	381	}
234		382
235	=item cf::async { BLOCK }	383	=item cf::async { BLOCK }
236		384
237	Currently the same as Coro::async_pool, meaning you cannot use	385	Currently the same as Coro::async_pool, meaning you cannot use
…		…
242		390
243	BEGIN { *async = \&Coro::async_pool }	391	BEGIN { *async = \&Coro::async_pool }
244		392
245	=item cf::sync_job { BLOCK }	393	=item cf::sync_job { BLOCK }
246		394
247	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)
248	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
249	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.
250		399
251	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
252	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
253	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
254	fast or be very important.	403	fast or be very important.
…		…
257		406
258	sub sync_job(&) {	407	sub sync_job(&) {
259	my ($job) = @_;	408	my ($job) = @_;
260		409
261	if ($Coro::current == $Coro::main) {	410	if ($Coro::current == $Coro::main) {
		411	my $time = Event::time;
		412
262	# this is the main coro, too bad, we have to block	413	# this is the main coro, too bad, we have to block
263	# till the operation succeeds, freezing the server :/	414	# till the operation succeeds, freezing the server :/
264		415
265	# TODO: use suspend/resume instead	416	# TODO: use suspend/resume instead
266	# (but this is cancel-safe)	417	# (but this is cancel-safe)
…		…
277		428
278	while ($busy) {	429	while ($busy) {
279	Coro::cede or Event::one_event;	430	Coro::cede or Event::one_event;
280	}	431	}
281		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
282	wantarray ? @res : $res[0]	440	wantarray ? @res : $res[0]
283	} else {	441	} else {
284	# we are in another coroutine, how wonderful, everything just works	442	# we are in another coroutine, how wonderful, everything just works
285		443
286	$job->()	444	$job->()
287	}	445	}
288	}	446	}
289		447
290	=item $coro = cf::async_ext { BLOCK }	448	=item $coro = cf::async_ext { BLOCK }
291		449
292	Like async, but this coro is automcatially being canceled when the	450	Like async, but this coro is automatically being canceled when the
293	extension calling this is being unloaded.	451	extension calling this is being unloaded.
294		452
295	=cut	453	=cut
296		454
297	sub async_ext(&) {	455	sub async_ext(&) {
…		…
305	$EXT_CORO{$coro+0} = $coro;	463	$EXT_CORO{$coro+0} = $coro;
306		464
307	$coro	465	$coro
308	}	466	}
309		467
310	sub write_runtime {	468	=item fork_call { }, $args
311	my $runtime = cf::localdir . "/runtime";
312		469
313	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	470	Executes the given code block with the given arguments in a seperate
314	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.
315		474
316	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	475	=cut
317	(aio_write $fh, 0, (length $value), $value, 0) <= 0
318	and return;
319		476
320	aio_fsync $fh	477	sub _store_scalar {
321	and return;	478	open my $fh, ">", \my $buf
322		479	or die "fork_call: cannot open fh-to-buf in child : $!";
		480	Storable::store_fd $_[0], $fh;
323	close $fh	481	close $fh;
324	or return;
325		482
326	aio_rename "$runtime~", $runtime	483	$buf
327	and return;	484	}
328		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;
329	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 });
330	}	655	}
331		656
332	=back	657	=back
333		658
334	=cut	659	=cut
335
336	#############################################################################
337
338	package cf::path;
339
340	sub new {
341	my ($class, $path, $base) = @_;
342
343	$path = $path->as_string if ref $path;
344
345	my $self = bless { }, $class;
346
347	# {... are special paths that are not touched
348	# ?xxx/... are special absolute paths
349	# ?random/... random maps
350	# /! non-realised random map exit
351	# /... normal maps
352	# ~/... per-player maps without a specific player (DO NOT USE)
353	# ~user/... per-player map of a specific user
354
355	if ($path =~ /^{/) {
356	# fine as it is
357	} elsif ($path =~ s{^\?random/}{}) {
358	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
359	$self->{random} = cf::from_json $data;
360	} else {
361	if ($path =~ s{^~([^/]+)?}{}) {
362	$self->{user_rel} = 1;
363
364	if (defined $1) {
365	$self->{user} = $1;
366	} elsif ($base =~ m{^~([^/]+)/}) {
367	$self->{user} = $1;
368	} else {
369	warn "cannot resolve user-relative path without user <$path,$base>\n";
370	}
371	} elsif ($path =~ /^\//) {
372	# already absolute
373	} else {
374	$base =~ s{[^/]+/?$}{};
375	return $class->new ("$base/$path");
376	}
377
378	for ($path) {
379	redo if s{/\.?/}{/};
380	redo if s{/[^/]+/\.\./}{/};
381	}
382	}
383
384	$self->{path} = $path;
385
386	$self
387	}
388
389	# the name / primary key / in-game path
390	sub as_string {
391	my ($self) = @_;
392
393	$self->{user_rel} ? "~$self->{user}$self->{path}"
394	: $self->{random} ? "?random/$self->{path}"
395	: $self->{path}
396	}
397
398	# the displayed name, this is a one way mapping
399	sub visible_name {
400	my ($self) = @_;
401
402	# if (my $rmp = $self->{random}) {
403	# # todo: be more intelligent about this
404	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
405	# } else {
406	$self->as_string
407	# }
408	}
409
410	# escape the /'s in the path
411	sub _escaped_path {
412	# ∕ is U+2215
413	(my $path = $_[0]{path}) =~ s/\//∕/g;
414	$path
415	}
416
417	# the original (read-only) location
418	sub load_path {
419	my ($self) = @_;
420
421	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
422	}
423
424	# the temporary/swap location
425	sub save_path {
426	my ($self) = @_;
427
428	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
429	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
430	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
431	}
432
433	# the unique path, might be eq to save_path
434	sub uniq_path {
435	my ($self) = @_;
436
437	$self->{user_rel} || $self->{random}
438	? undef
439	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
440	}
441
442	# return random map parameters, or undef
443	sub random_map_params {
444	my ($self) = @_;
445
446	$self->{random}
447	}
448
449	# this is somewhat ugly, but style maps do need special treatment
450	sub is_style_map {
451	$_[0]{path} =~ m{^/styles/}
452	}
453
454	package cf;
455		660
456	#############################################################################	661	#############################################################################
457		662
458	=head2 ATTACHABLE OBJECTS	663	=head2 ATTACHABLE OBJECTS
459		664
…		…
461	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")
462	to it. All such attachable objects support the following methods.	667	to it. All such attachable objects support the following methods.
463		668
464	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>
465	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
466	crossfire+).	671	Crossfire TRT).
467		672
468	=over 4	673	=over 4
469		674
470	=item $attachable->attach ($attachment, key => $value...)	675	=item $attachable->attach ($attachment, key => $value...)
471		676
…		…
585	our @CB_TYPE = (); # registry for type (cf-object class) based events	790	our @CB_TYPE = (); # registry for type (cf-object class) based events
586	our @CB_MAP = ();	791	our @CB_MAP = ();
587		792
588	my %attachment;	793	my %attachment;
589		794
		795	sub cf::attachable::thawer_merge {
		796	# simply override everything except _meta
		797	local $_[0]{_meta};
		798	%{$_[0]} = %{$_[1]};
		799	}
		800
590	sub _attach_cb($$$$) {	801	sub _attach_cb($$$$) {
591	my ($registry, $event, $prio, $cb) = @_;	802	my ($registry, $event, $prio, $cb) = @_;
592		803
593	use sort 'stable';	804	use sort 'stable';
594		805
…		…
628	$registry = $CB_TYPE[$object_type] ||= [];	839	$registry = $CB_TYPE[$object_type] ||= [];
629		840
630	} elsif ($type eq "subtype") {	841	} elsif ($type eq "subtype") {
631	defined $object_type or Carp::croak "subtype specified without type";	842	defined $object_type or Carp::croak "subtype specified without type";
632	my $object_subtype = shift @arg;	843	my $object_subtype = shift @arg;
633	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	844	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
634		845
635	} elsif ($type eq "package") {	846	} elsif ($type eq "package") {
636	my $pkg = shift @arg;	847	my $pkg = shift @arg;
637		848
638	while (my ($name, $id) = each %cb_id) {	849	while (my ($name, $id) = each %cb_id) {
…		…
667	_attach $registry, $klass, @attach;	878	_attach $registry, $klass, @attach;
668	}	879	}
669		880
670	$obj->{$name} = \%arg;	881	$obj->{$name} = \%arg;
671	} else {	882	} else {
672	warn "object uses attachment '$name' that is not available, postponing.\n";	883	warn "object uses attachment '$name' which is not available, postponing.\n";
673	}	884	}
674		885
675	$obj->{_attachment}{$name} = undef;	886	$obj->{_attachment}{$name} = undef;
676	}	887	}
677		888
…		…
679	if (ref $_[0]) {	890	if (ref $_[0]) {
680	_object_attach @_;	891	_object_attach @_;
681	} else {	892	} else {
682	_attach shift->_attach_registry, @_;	893	_attach shift->_attach_registry, @_;
683	}	894	}
		895	_recalc_want;
684	};	896	};
685		897
686	# all those should be optimised	898	# all those should be optimised
687	sub cf::attachable::detach {	899	sub cf::attachable::detach {
688	my ($obj, $name) = @_;	900	my ($obj, $name) = @_;
…		…
691	delete $obj->{_attachment}{$name};	903	delete $obj->{_attachment}{$name};
692	reattach ($obj);	904	reattach ($obj);
693	} else {	905	} else {
694	Carp::croak "cannot, currently, detach class attachments";	906	Carp::croak "cannot, currently, detach class attachments";
695	}	907	}
		908	_recalc_want;
696	};	909	};
697		910
698	sub cf::attachable::attached {	911	sub cf::attachable::attached {
699	my ($obj, $name) = @_;	912	my ($obj, $name) = @_;
700		913
…		…
715	";	928	";
716	die if $@;	929	die if $@;
717	}	930	}
718		931
719	our $override;	932	our $override;
720	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?
721		934
722	sub override {	935	sub override {
723	$override = 1;	936	$override = 1;
724	@invoke_results = ();	937	@INVOKE_RESULTS = (@_);
725	}	938	}
726		939
727	sub do_invoke {	940	sub do_invoke {
728	my $event = shift;	941	my $event = shift;
729	my $callbacks = shift;	942	my $callbacks = shift;
730		943
731	@invoke_results = ();	944	@INVOKE_RESULTS = ();
732		945
733	local $override;	946	local $override;
734		947
735	for (@$callbacks) {	948	for (@$callbacks) {
736	eval { &{$_->[1]} };	949	eval { &{$_->[1]} };
…		…
753		966
754	Generate an object-specific event with the given arguments.	967	Generate an object-specific event with the given arguments.
755		968
756	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
757	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
758	results (if you must, access C<@cf::invoke_results> directly).	971	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
759		972
760	=back	973	=back
761		974
762	=cut	975	=cut
763		976
764	#############################################################################	977	#############################################################################
765	# 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	}
766		990
767	sub reattach {	991	sub reattach {
768	# basically do the same as instantiate, without calling instantiate	992	# basically do the same as instantiate, without calling instantiate
769	my ($obj) = @_;	993	my ($obj) = @_;
		994
		995	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
770		996
771	my $registry = $obj->registry;	997	my $registry = $obj->registry;
772		998
773	@$registry = ();	999	@$registry = ();
774		1000
…		…
821	$filename, length $$rdata, scalar @$objs;	1047	$filename, length $$rdata, scalar @$objs;
822		1048
823	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1049	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
824	chmod SAVE_MODE, $fh;	1050	chmod SAVE_MODE, $fh;
825	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1051	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
826	aio_fsync $fh;	1052	aio_fsync $fh if $cf::USE_FSYNC;
827	close $fh;	1053	close $fh;
828		1054
829	if (@$objs) {	1055	if (@$objs) {
830	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) {
831	chmod SAVE_MODE, $fh;	1057	chmod SAVE_MODE, $fh;
832	my $data = Storable::nfreeze { version => 1, objs => $objs };	1058	my $data = Storable::nfreeze { version => 1, objs => $objs };
833	aio_write $fh, 0, (length $data), $data, 0;	1059	aio_write $fh, 0, (length $data), $data, 0;
834	aio_fsync $fh;	1060	aio_fsync $fh if $cf::USE_FSYNC;
835	close $fh;	1061	close $fh;
836	aio_rename "$filename.pst~", "$filename.pst";	1062	aio_rename "$filename.pst~", "$filename.pst";
837	}	1063	}
838	} else {	1064	} else {
839	aio_unlink "$filename.pst";	1065	aio_unlink "$filename.pst";
…		…
871	or return;	1097	or return;
872	$av = eval { (Storable::thaw $av)->{objs} };	1098	$av = eval { (Storable::thaw $av)->{objs} };
873	}	1099	}
874		1100
875	warn sprintf "loading %s (%d)\n",	1101	warn sprintf "loading %s (%d)\n",
876	$filename, length $data, scalar @{$av || []};#d#	1102	$filename, length $data, scalar @{$av || []};
877	return ($data, $av);	1103	return ($data, $av);
878	}	1104	}
		1105
		1106	=head2 COMMAND CALLBACKS
		1107
		1108	=over 4
		1109
		1110	=cut
879		1111
880	#############################################################################	1112	#############################################################################
881	# command handling &c	1113	# command handling &c
882		1114
883	=item cf::register_command $name => \&callback($ob,$args);	1115	=item cf::register_command $name => \&callback($ob,$args);
…		…
896	push @{ $COMMAND{$name} }, [$caller, $cb];	1128	push @{ $COMMAND{$name} }, [$caller, $cb];
897	}	1129	}
898		1130
899	=item cf::register_extcmd $name => \&callback($pl,$packet);	1131	=item cf::register_extcmd $name => \&callback($pl,$packet);
900		1132
901	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.
902		1138
903	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
904	called.	1140	called.
905		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
906	=cut	1153	=cut
907		1154
908	sub register_extcmd {	1155	sub register_extcmd {
909	my ($name, $cb) = @_;	1156	my ($name, $cb) = @_;
910		1157
911	my $caller = caller;
912	#warn "registering extcmd '$name' to '$caller'";
913
914	$EXTCMD{$name} = [$cb, $caller];	1158	$EXTCMD{$name} = $cb;
		1159	}
		1160
		1161	sub register_exticmd {
		1162	my ($name, $cb) = @_;
		1163
		1164	$EXTICMD{$name} = $cb;
915	}	1165	}
916		1166
917	cf::player->attach (	1167	cf::player->attach (
918	on_command => sub {	1168	on_command => sub {
919	my ($pl, $name, $params) = @_;	1169	my ($pl, $name, $params) = @_;
…		…
928	cf::override;	1178	cf::override;
929	},	1179	},
930	on_extcmd => sub {	1180	on_extcmd => sub {
931	my ($pl, $buf) = @_;	1181	my ($pl, $buf) = @_;
932		1182
933	my $msg = eval { from_json $buf };	1183	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
934		1184
935	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
936	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1191	if (my $cb = $EXTCMD{$type}) {
937	if (my %reply = $cb->[0]->($pl, $msg)) {	1192	my @reply = $cb->($pl, @payload);
		1193
938	$pl->ext_reply ($msg->{msgid}, %reply);	1194	$pl->ext_reply ($reply, @reply)
939	}	1195	if $reply;
940	}	1196	}
941	} else {	1197	} else {
942	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1198	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
943	}	1199	}
944		1200
945	cf::override;	1201	cf::override;
946	},	1202	},
947	);	1203	);
948		1204
949	sub register {
950	my ($base, $pkg) = @_;
951
952	#TODO
953	}
954
955	sub load_extension {
956	my ($path) = @_;
957
958	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
959	my $base = $1;
960	my $pkg = $1;
961	$pkg =~ s/[^[:word:]]/_/g;
962	$pkg = "ext::$pkg";
963
964	warn "loading '$path' into '$pkg'\n";
965
966	open my $fh, "<:utf8", $path
967	or die "$path: $!";
968
969	my $source =
970	"package $pkg; use strict; use utf8;\n"
971	. "#line 1 \"$path\"\n{\n"
972	. (do { local $/; <$fh> })
973	. "\n};\n1";
974
975	eval $source
976	or die $@ ? "$path: $@\n"
977	: "extension disabled.\n";
978
979	push @exts, $pkg;
980	$ext_pkg{$base} = $pkg;
981
982	# no strict 'refs';
983	# @{"$pkg\::ISA"} = ext::;
984
985	register $base, $pkg;
986	}
987
988	sub unload_extension {
989	my ($pkg) = @_;
990
991	warn "removing extension $pkg\n";
992
993	# remove hooks
994	#TODO
995	# for my $idx (0 .. $#PLUGIN_EVENT) {
996	# delete $hook[$idx]{$pkg};
997	# }
998
999	# remove commands
1000	for my $name (keys %COMMAND) {
1001	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1002
1003	if (@cb) {
1004	$COMMAND{$name} = \@cb;
1005	} else {
1006	delete $COMMAND{$name};
1007	}
1008	}
1009
1010	# remove extcmds
1011	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1012	delete $EXTCMD{$name};
1013	}
1014
1015	if (my $cb = $pkg->can ("unload")) {
1016	eval {
1017	$cb->($pkg);
1018	1
1019	} or warn "$pkg unloaded, but with errors: $@";
1020	}
1021
1022	Symbol::delete_package $pkg;
1023	}
1024
1025	sub load_extensions {	1205	sub load_extensions {
		1206	cf::sync_job {
		1207	my %todo;
		1208
1026	for my $ext (<$LIBDIR/*.ext>) {	1209	for my $path (<$LIBDIR/*.ext>) {
1027	next unless -r $ext;	1210	next unless -r $path;
1028	eval {	1211
1029	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;
1030	1	1269	}
1031	} or warn "$ext not loaded: $@";	1270
		1271	skip:
		1272	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1273	unless $progress;
		1274	}
1032	}	1275	};
1033	}	1276	}
1034		1277
1035	#############################################################################	1278	#############################################################################
1036	# load/save/clean perl data associated with a map
1037		1279
1038	*cf::mapsupport::on_clean = sub {	1280	=back
1039	my ($map) = @_;
1040
1041	my $path = $map->tmpname;
1042	defined $path or return;
1043
1044	unlink "$path.pst";
1045	};
1046
1047	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1048
1049	#############################################################################
1050	# load/save perl data associated with player->ob objects
1051
1052	sub all_objects(@) {
1053	@_, map all_objects ($_->inv), @_
1054	}
1055
1056	# TODO: compatibility cruft, remove when no longer needed
1057	cf::player->attach (
1058	on_load => sub {
1059	my ($pl, $path) = @_;
1060
1061	for my $o (all_objects $pl->ob) {
1062	if (my $value = $o->get_ob_key_value ("_perl_data")) {
1063	$o->set_ob_key_value ("_perl_data");
1064
1065	%$o = %{ Storable::thaw pack "H*", $value };
1066	}
1067	}
1068	},
1069	);
1070
1071	#############################################################################
1072		1281
1073	=head2 CORE EXTENSIONS	1282	=head2 CORE EXTENSIONS
1074		1283
1075	Functions and methods that extend core crossfire objects.	1284	Functions and methods that extend core crossfire objects.
1076		1285
1077	=cut	1286	=cut
1078		1287
1079	package cf::player;	1288	package cf::player;
1080		1289
		1290	use Coro::AIO;
		1291
1081	=head3 cf::player	1292	=head3 cf::player
1082		1293
1083	=over 4	1294	=over 4
1084		1295
1085	=item cf::player::find $login	1296	=item cf::player::find $login
1086		1297
1087	Returns the given player object, loading it if necessary (might block).	1298	Returns the given player object, loading it if necessary (might block).
1088		1299
1089	=cut	1300	=cut
1090		1301
		1302	sub playerdir($) {
		1303	"$PLAYERDIR/"
		1304	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		1305	}
		1306
1091	sub path($) {	1307	sub path($) {
1092	sprintf "%s/%s/%s/%s.pl",	1308	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1093	cf::localdir, cf::playerdir,	1309
1094	(ref $_[0] ? $_[0]->ob->name : $_[0]) x 2	1310	(playerdir $login) . "/playerdata"
1095	}	1311	}
1096		1312
1097	sub find_active($) {	1313	sub find_active($) {
1098	$cf::PLAYER{$_[0]}	1314	$cf::PLAYER{$_[0]}
1099	and $cf::PLAYER{$_[0]}->active	1315	and $cf::PLAYER{$_[0]}->active
…		…
1102		1318
1103	sub exists($) {	1319	sub exists($) {
1104	my ($login) = @_;	1320	my ($login) = @_;
1105		1321
1106	$cf::PLAYER{$login}	1322	$cf::PLAYER{$login}
1107	or cf::sync_job { !aio_stat $login }	1323	or cf::sync_job { !aio_stat path $login }
1108	}	1324	}
1109		1325
1110	sub find($) {	1326	sub find($) {
1111	return $cf::PLAYER{$_[0]} || do {	1327	return $cf::PLAYER{$_[0]} || do {
1112	my $login = $_[0];	1328	my $login = $_[0];
1113		1329
1114	my $guard = cf::lock_acquire "user_find:$login";	1330	my $guard = cf::lock_acquire "user_find:$login";
1115		1331
1116	$cf::PLAYER{$login} ||= (load_pl path $login or return);	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
		1340	my $pl = load_pl path $login
		1341	or return;
		1342	$cf::PLAYER{$login} = $pl
		1343	}
1117	};	1344	}
1118	}	1345	}
1119		1346
1120	sub save($) {	1347	sub save($) {
1121	my ($pl) = @_;	1348	my ($pl) = @_;
1122		1349
…		…
1124		1351
1125	my $path = path $pl;	1352	my $path = path $pl;
1126	my $guard = cf::lock_acquire "user_save:$path";	1353	my $guard = cf::lock_acquire "user_save:$path";
1127		1354
1128	return if $pl->{deny_save};	1355	return if $pl->{deny_save};
		1356
		1357	aio_mkdir playerdir $pl, 0770;
1129	$pl->{last_save} = $cf::RUNTIME;	1358	$pl->{last_save} = $cf::RUNTIME;
1130		1359
1131	Coro::cede;
1132	$pl->save_pl ($path);	1360	$pl->save_pl ($path);
1133	Coro::cede;	1361	Coro::cede;
1134	}	1362	}
1135		1363
1136	sub new($) {	1364	sub new($) {
…		…
1144	$cf::PLAYER{$login} = $self;	1372	$cf::PLAYER{$login} = $self;
1145		1373
1146	$self	1374	$self
1147	}	1375	}
1148		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
		1387	=item $pl->quit_character
		1388
		1389	Nukes the player without looking back. If logged in, the connection will
		1390	be destroyed. May block for a long time.
		1391
		1392	=cut
		1393
		1394	sub quit_character {
		1395	my ($pl) = @_;
		1396
		1397	my $name = $pl->ob->name;
		1398
		1399	$pl->{deny_save} = 1;
		1400	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1401
		1402	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1403	$pl->deactivate;
		1404	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1405	$pl->ns->destroy if $pl->ns;
		1406
		1407	my $path = playerdir $pl;
		1408	my $temp = "$path~$cf::RUNTIME~deleting~";
		1409	aio_rename $path, $temp;
		1410	delete $cf::PLAYER{$pl->ob->name};
		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
		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;
		1433	}
		1434
		1435	=item cf::player::list_logins
		1436
		1437	Returns am arrayref of all valid playernames in the system, can take a
		1438	while and may block, so not sync_job-capable, ever.
		1439
		1440	=cut
		1441
		1442	sub list_logins {
		1443	my $dirs = aio_readdir $PLAYERDIR
		1444	or return [];
		1445
		1446	my @logins;
		1447
		1448	for my $login (@$dirs) {
		1449	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1450	aio_read $fh, 0, 512, my $buf, 0 or next;
		1451	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1452
		1453	utf8::decode $login;
		1454	push @logins, $login;
		1455	}
		1456
		1457	\@logins
		1458	}
		1459
		1460	=item $player->maps
		1461
		1462	Returns an arrayref of map paths that are private for this
		1463	player. May block.
		1464
		1465	=cut
		1466
		1467	sub maps($) {
		1468	my ($pl) = @_;
		1469
		1470	$pl = ref $pl ? $pl->ob->name : $pl;
		1471
		1472	my $files = aio_readdir playerdir $pl
		1473	or return;
		1474
		1475	my @paths;
		1476
		1477	for (@$files) {
		1478	utf8::decode $_;
		1479	next if /\.(?:pl|pst)$/;
		1480	next unless /^$PATH_SEP/o;
		1481
		1482	push @paths, cf::map::normalise "~$pl/$_";
		1483	}
		1484
		1485	\@paths
		1486	}
		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
1149	=item $player->ext_reply ($msgid, $msgtype, %msg)	1538	=item $player->ext_reply ($msgid, @msg)
1150		1539
1151	Sends an ext reply to the player.	1540	Sends an ext reply to the player.
1152		1541
1153	=cut	1542	=cut
1154		1543
1155	sub ext_reply($$$%) {	1544	sub ext_reply($$@) {
1156	my ($self, $id, %msg) = @_;	1545	my ($self, $id, @msg) = @_;
1157		1546
1158	$msg{msgid} = $id;	1547	if ($self->ns->extcmd == 2) {
1159		1548	$self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1160	$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	}
1161	}	1554	}
1162		1555
1163	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	}
1164		1596
1165	=back	1597	=back
1166
1167		1598
1168	=head3 cf::map	1599	=head3 cf::map
1169		1600
1170	=over 4	1601	=over 4
1171		1602
…		…
1174	package cf::map;	1605	package cf::map;
1175		1606
1176	use Fcntl;	1607	use Fcntl;
1177	use Coro::AIO;	1608	use Coro::AIO;
1178		1609
		1610	use overload
		1611	'""' => \&as_string,
		1612	fallback => 1;
		1613
1179	our $MAX_RESET = 3600;	1614	our $MAX_RESET = 3600;
1180	our $DEFAULT_RESET = 3000;	1615	our $DEFAULT_RESET = 3000;
1181		1616
1182	sub generate_random_map {	1617	sub generate_random_map {
1183	my ($path, $rmp) = @_;	1618	my ($self, $rmp) = @_;
1184
1185	# mit "rum" bekleckern, nicht	1619	# mit "rum" bekleckern, nicht
1186	cf::map::_create_random_map	1620	$self->_create_random_map (
1187	$path,
1188	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1621	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1189	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1622	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1190	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1623	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1191	$rmp->{exit_on_final_map},	1624	$rmp->{exit_on_final_map},
1192	$rmp->{xsize}, $rmp->{ysize},	1625	$rmp->{xsize}, $rmp->{ysize},
1193	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1626	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1194	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1627	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1195	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1628	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1196	$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},
1197	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1630	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1198	(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"
1199	}	1760	}
1200		1761
1201	# and all this just because we cannot iterate over	1762	# and all this just because we cannot iterate over
1202	# all maps in C++...	1763	# all maps in C++...
1203	sub change_all_map_light {	1764	sub change_all_map_light {
…		…
1205		1766
1206	$_->change_map_light ($change)	1767	$_->change_map_light ($change)
1207	for grep $_->outdoor, values %cf::MAP;	1768	for grep $_->outdoor, values %cf::MAP;
1208	}	1769	}
1209		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
1210	sub try_load_header($) {	1787	sub load_header_from($) {
1211	my ($path) = @_;	1788	my ($self, $path) = @_;
1212		1789
1213	utf8::encode $path;	1790	utf8::encode $path;
1214	aio_open $path, O_RDONLY, 0	1791	#aio_open $path, O_RDONLY, 0
		1792	# or return;
		1793
		1794	$self->_load_header ($path)
1215	or return;	1795	or return;
1216		1796
1217	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
1218	or return;	1840	or return;
		1841	$self->prepare_orig;
		1842	}
1219		1843
1220	# for better error messages only, will be overwritten	1844	$self->{deny_reset} = 1
1221	$map->path ($path);	1845	if $self->no_reset;
1222		1846
1223	$map->load_header ($path)	1847	$self->default_region (cf::region::find_by_path $self->{path})
1224	or return;	1848	unless $self->default_region;
1225		1849
1226	$map->{load_path} = $path;	1850	1
1227
1228	$map
1229	}	1851	}
1230		1852
1231	sub find;	1853	sub find;
1232	sub find {	1854	sub find {
1233	my ($path, $origin) = @_;	1855	my ($path, $origin) = @_;
1234		1856
1235	#warn "find<$path,$origin>\n";#d#
1236
1237	$path = new cf::path $path, $origin && $origin->path;	1857	$path = normalise $path, $origin && $origin->path;
1238	my $key = $path->as_string;
1239		1858
1240	cf::lock_wait "map_find:$key";	1859	cf::lock_wait "map_find:$path";
1241		1860
1242	$cf::MAP{$key} || do {	1861	$cf::MAP{$path} || do {
1243	my $guard = cf::lock_acquire "map_find:$key";	1862	my $guard = cf::lock_acquire "map_find:$path";
1244		1863	my $map = new_from_path cf::map $path
1245	# do it the slow way
1246	my $map = try_load_header $path->save_path;
1247
1248	Coro::cede;
1249
1250	if ($map) {
1251	$map->last_access ((delete $map->{last_access})
1252	|| $cf::RUNTIME); #d#
1253	# safety
1254	$map->{instantiate_time} = $cf::RUNTIME
1255	if $map->{instantiate_time} > $cf::RUNTIME;
1256	} else {
1257	if (my $rmp = $path->random_map_params) {
1258	$map = generate_random_map $key, $rmp;
1259	} else {
1260	$map = try_load_header $path->load_path;
1261	}
1262
1263	$map or return;	1864	or return;
1264		1865
1265	$map->{load_original} = 1;
1266	$map->{instantiate_time} = $cf::RUNTIME;
1267	$map->last_access ($cf::RUNTIME);
1268	$map->instantiate;
1269
1270	# per-player maps become, after loading, normal maps
1271	$map->per_player (0) if $path->{user_rel};
1272	}
1273
1274	$map->path ($key);
1275	$map->{path} = $path;
1276	$map->{last_save} = $cf::RUNTIME;	1866	$map->{last_save} = $cf::RUNTIME;
1277		1867
1278	Coro::cede;	1868	$map->load_header
		1869	or return;
1279		1870
1280	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;
1281	$map->reset;	1874	$map->reset;
1282	undef $guard;	1875	undef $guard;
1283	$map = find $path	1876	return find $path;
1284	or return;
1285	}	1877	}
1286		1878
1287	$cf::MAP{$key} = $map	1879	$cf::MAP{$path} = $map
1288	}	1880	}
1289	}	1881	}
		1882
		1883	sub pre_load { }
		1884	sub post_load { }
1290		1885
1291	sub load {	1886	sub load {
1292	my ($self) = @_;	1887	my ($self) = @_;
1293		1888
		1889	local $self->{deny_reset} = 1; # loading can take a long time
		1890
1294	my $path = $self->{path};	1891	my $path = $self->{path};
		1892
		1893	{
1295	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	1894	my $guard = cf::lock_acquire "map_load:$path";
1296		1895
1297	return if $self->in_memory != cf::MAP_SWAPPED;	1896	return if $self->in_memory != cf::MAP_SWAPPED;
1298		1897
1299	$self->in_memory (cf::MAP_LOADING);	1898	$self->in_memory (cf::MAP_LOADING);
1300		1899
1301	$self->alloc;	1900	$self->alloc;
		1901
		1902	$self->pre_load;
		1903	Coro::cede;
		1904
1302	$self->load_objects ($self->{load_path}, 1)	1905	$self->_load_objects ($self->{load_path}, 1)
1303	or return;	1906	or return;
1304		1907
1305	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1908	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1306	if delete $self->{load_original};	1909	if delete $self->{load_original};
1307		1910
1308	if (my $uniq = $path->uniq_path) {	1911	if (my $uniq = $self->uniq_path) {
1309	utf8::encode $uniq;	1912	utf8::encode $uniq;
1310	if (aio_open $uniq, O_RDONLY, 0) {	1913	if (aio_open $uniq, O_RDONLY, 0) {
1311	$self->clear_unique_items;	1914	$self->clear_unique_items;
1312	$self->load_objects ($uniq, 0);	1915	$self->_load_objects ($uniq, 0);
1313	}	1916	}
1314	}	1917	}
1315		1918
1316	Coro::cede;	1919	Coro::cede;
1317
1318	# now do the right thing for maps	1920	# now do the right thing for maps
1319	$self->link_multipart_objects;	1921	$self->link_multipart_objects;
1320
1321	if ($self->{path}->is_style_map) {
1322	$self->{deny_save} = 1;
1323	$self->{deny_reset} = 1;
1324	} else {
1325	$self->fix_auto_apply;
1326	$self->decay_objects;
1327	$self->update_buttons;
1328	$self->set_darkness_map;
1329	$self->difficulty ($self->estimate_difficulty)	1922	$self->difficulty ($self->estimate_difficulty)
1330	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;
1331	$self->activate;	1933	$self->activate;
1332	}	1934	}
1333		1935
1334	Coro::cede;	1936	$self->{last_save} = $cf::RUNTIME;
		1937	$self->last_access ($cf::RUNTIME);
1335		1938
1336	$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	}
1337	}	1979	}
1338		1980
1339	sub find_sync {	1981	sub find_sync {
1340	my ($path, $origin) = @_;	1982	my ($path, $origin) = @_;
1341		1983
1342	cf::sync_job { cf::map::find $path, $origin }	1984	cf::sync_job { find $path, $origin }
1343	}	1985	}
1344		1986
1345	sub do_load_sync {	1987	sub do_load_sync {
1346	my ($map) = @_;	1988	my ($map) = @_;
1347		1989
1348	cf::sync_job { $map->load };	1990	cf::sync_job { $map->load };
1349	}	1991	}
1350		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
1351	sub save {	2023	sub save {
1352	my ($self) = @_;	2024	my ($self) = @_;
1353		2025
1354	my $lock = cf::lock_acquire "map_data:" . $self->path;	2026	my $lock = cf::lock_acquire "map_data:" . $self->path;
1355		2027
1356	$self->{last_save} = $cf::RUNTIME;	2028	$self->{last_save} = $cf::RUNTIME;
1357		2029
1358	return unless $self->dirty;	2030	return unless $self->dirty;
1359		2031
1360	my $save = $self->{path}->save_path; utf8::encode $save;	2032	my $save = $self->save_path; utf8::encode $save;
1361	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	2033	my $uniq = $self->uniq_path; utf8::encode $uniq;
1362		2034
1363	$self->{load_path} = $save;	2035	$self->{load_path} = $save;
1364		2036
1365	return if $self->{deny_save};	2037	return if $self->{deny_save};
1366		2038
…		…
1369	cf::async {	2041	cf::async {
1370	$_->contr->save for $self->players;	2042	$_->contr->save for $self->players;
1371	};	2043	};
1372		2044
1373	if ($uniq) {	2045	if ($uniq) {
1374	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2046	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1375	$self->save_objects ($uniq, cf::IO_UNIQUES);	2047	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1376	} else {	2048	} else {
1377	$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);
1378	}	2050	}
1379	}	2051	}
1380		2052
1381	sub swap_out {	2053	sub swap_out {
1382	my ($self) = @_;	2054	my ($self) = @_;
…		…
1396		2068
1397	sub reset_at {	2069	sub reset_at {
1398	my ($self) = @_;	2070	my ($self) = @_;
1399		2071
1400	# TODO: safety, remove and allow resettable per-player maps	2072	# TODO: safety, remove and allow resettable per-player maps
1401	return 1e99 if $self->{path}{user_rel};
1402	return 1e99 if $self->{deny_reset};	2073	return 1e99 if $self->{deny_reset};
1403		2074
1404	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2075	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1405	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;
1406		2077
…		…
1411	my ($self) = @_;	2082	my ($self) = @_;
1412		2083
1413	$self->reset_at <= $cf::RUNTIME	2084	$self->reset_at <= $cf::RUNTIME
1414	}	2085	}
1415		2086
1416	sub unlink_save {
1417	my ($self) = @_;
1418
1419	utf8::encode (my $save = $self->{path}->save_path);
1420	aioreq_pri 3; IO::AIO::aio_unlink $save;
1421	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1422	}
1423
1424	sub rename {
1425	my ($self, $new_path) = @_;
1426
1427	$self->unlink_save;
1428
1429	delete $cf::MAP{$self->path};
1430	$self->{path} = new cf::path $new_path;
1431	$self->path ($self->{path}->as_string);
1432	$cf::MAP{$self->path} = $self;
1433
1434	$self->save;
1435	}
1436
1437	sub reset {	2087	sub reset {
1438	my ($self) = @_;	2088	my ($self) = @_;
1439		2089
1440	my $lock = cf::lock_acquire "map_data:" . $self->path;	2090	my $lock = cf::lock_acquire "map_data:$self->{path}";
1441		2091
1442	return if $self->players;	2092	return if $self->players;
1443	return if $self->{path}{user_rel};#d#
1444		2093
1445	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	}
1446		2105
1447	delete $cf::MAP{$self->path};	2106	delete $cf::MAP{$self->path};
		2107
		2108	$self->clear;
1448		2109
1449	$_->clear_links_to ($self) for values %cf::MAP;	2110	$_->clear_links_to ($self) for values %cf::MAP;
1450		2111
1451	$self->unlink_save;	2112	$self->unlink_save;
1452	$self->destroy;	2113	$self->destroy;
…		…
1455	my $nuke_counter = "aaaa";	2116	my $nuke_counter = "aaaa";
1456		2117
1457	sub nuke {	2118	sub nuke {
1458	my ($self) = @_;	2119	my ($self) = @_;
1459		2120
		2121	delete $cf::MAP{$self->path};
		2122
		2123	$self->unlink_save;
		2124
		2125	bless $self, "cf::map";
		2126	delete $self->{deny_reset};
1460	$self->{deny_save} = 1;	2127	$self->{deny_save} = 1;
1461	$self->reset_timeout (1);	2128	$self->reset_timeout (1);
1462	$self->rename ("{nuke}/" . ($nuke_counter++));	2129	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2130
		2131	$cf::MAP{$self->path} = $self;
		2132
1463	$self->reset; # polite request, might not happen	2133	$self->reset; # polite request, might not happen
1464	}	2134	}
1465		2135
1466	sub customise_for {	2136	=item $maps = cf::map::tmp_maps
1467	my ($map, $ob) = @_;
1468		2137
1469	if ($map->per_player) {	2138	Returns an arrayref with all map paths of currently instantiated and saved
1470	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	2139	maps. May block.
		2140
		2141	=cut
		2142
		2143	sub tmp_maps() {
1471	}	2144	[
1472		2145	map {
1473	$map	2146	utf8::decode $_;
		2147	/\.map$/
		2148	? normalise $_
		2149	: ()
		2150	} @{ aio_readdir $TMPDIR or [] }
		2151	]
1474	}	2152	}
1475		2153
1476	sub emergency_save {	2154	=item $maps = cf::map::random_maps
1477	my $freeze_guard = cf::freeze_mainloop;
1478		2155
1479	warn "enter emergency map save\n";	2156	Returns an arrayref with all map paths of currently instantiated and saved
		2157	random maps. May block.
1480		2158
1481	cf::sync_job {	2159	=cut
1482	warn "begin emergency map save\n";
1483	$_->save for values %cf::MAP;
1484	};
1485		2160
1486	warn "end emergency map save\n";	2161	sub random_maps() {
		2162	[
		2163	map {
		2164	utf8::decode $_;
		2165	/\.map$/
		2166	? normalise "?random/$_"
		2167	: ()
		2168	} @{ aio_readdir $RANDOMDIR or [] }
		2169	]
		2170	}
		2171
		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	]
1487	}	2188	}
1488		2189
1489	package cf;	2190	package cf;
1490		2191
1491	=back	2192	=back
1492		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
1493		2220
1494	=head3 cf::object::player	2221	=head3 cf::object::player
1495		2222
1496	=over 4	2223	=over 4
1497		2224
…		…
1511		2238
1512	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2239	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1513		2240
1514	if ($self->{record_replies}) {	2241	if ($self->{record_replies}) {
1515	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2242	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2243
1516	} 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 {
1517	$msg = $npc->name . " says: $msg" if $npc;	2252	$msg = $npc->name . " says: $msg" if $npc;
1518	$self->message ($msg, $flags);	2253	$self->message ($msg, $flags);
		2254	}
1519	}	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 (@_);
1520	}	2266	}
1521		2267
1522	=item $player_object->may ("access")	2268	=item $player_object->may ("access")
1523		2269
1524	Returns wether the given player is authorized to access resource "access"	2270	Returns wether the given player is authorized to access resource "access"
…		…
1537		2283
1538	=item $player_object->enter_link	2284	=item $player_object->enter_link
1539		2285
1540	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}>).
1541		2287
1542	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
1543	I<MUST> call C<leave_link> as soon as possible, though.	2289	I<MUST> call C<leave_link> as soon as possible, though.
1544		2290
		2291	Will never block.
		2292
1545	=item $player_object->leave_link ($map, $x, $y)	2293	=item $player_object->leave_link ($map, $x, $y)
1546		2294
1547	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
1548	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
1549	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
1550	to the emergency map position.	2298	fails, to the emergency map position.
1551		2299
1552	Might block.	2300	Might block.
1553		2301
1554	=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	}
1555		2313
1556	sub cf::object::player::enter_link {	2314	sub cf::object::player::enter_link {
1557	my ($self) = @_;	2315	my ($self) = @_;
1558		2316
1559	$self->deactivate_recursive;	2317	$self->deactivate_recursive;
1560		2318
1561	return if $self->map == $LINK_MAP;	2319	return if UNIVERSAL::isa $self->map, "ext::map_link";
1562		2320
1563	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2321	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1564	if $self->map;	2322	if $self->map && $self->map->{path} ne "{link}";
1565		2323
1566	$self->enter_map ($LINK_MAP, 20, 20);	2324	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1567	}	2325	}
1568		2326
1569	sub cf::object::player::leave_link {	2327	sub cf::object::player::leave_link {
1570	my ($self, $map, $x, $y) = @_;	2328	my ($self, $map, $x, $y) = @_;
		2329
		2330	return unless $self->contr->active;
1571		2331
1572	my $link_pos = delete $self->{_link_pos};	2332	my $link_pos = delete $self->{_link_pos};
1573		2333
1574	unless ($map) {	2334	unless ($map) {
1575	# restore original map position	2335	# restore original map position
…		…
1589	# use -1 or undef as default coordinates, not 0, 0	2349	# use -1 or undef as default coordinates, not 0, 0
1590	($x, $y) = ($map->enter_x, $map->enter_y)	2350	($x, $y) = ($map->enter_x, $map->enter_y)
1591	if $x <=0 && $y <= 0;	2351	if $x <=0 && $y <= 0;
1592		2352
1593	$map->load;	2353	$map->load;
		2354	$map->load_diag;
1594		2355
1595	return unless $self->contr->active;	2356	return unless $self->contr->active;
1596	$self->activate_recursive;	2357	$self->activate_recursive;
		2358
		2359	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1597	$self->enter_map ($map, $x, $y);	2360	$self->enter_map ($map, $x, $y);
1598	}	2361	}
1599		2362
1600	cf::player->attach (	2363	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1601	on_logout => sub {
1602	my ($pl) = @_;
1603		2364
1604	# abort map switching before logout	2365	Moves the player to the given map-path and coordinates by first freezing
1605	if ($pl->ob->{_link_pos}) {	2366	her, loading and preparing them map, calling the provided $check callback
1606	cf::sync_job {	2367	that has to return the map if sucecssful, and then unfreezes the player on
1607	$pl->ob->leave_link	2368	the new (success) or old (failed) map position. In either case, $done will
1608	};	2369	be called at the end of this process.
1609	}
1610	},
1611	on_login => sub {
1612	my ($pl) = @_;
1613		2370
1614	# try to abort aborted map switching on player login :)
1615	# should happen only on crashes
1616	if ($pl->ob->{_link_pos}) {
1617	$pl->ob->enter_link;
1618	(async {
1619	# we need this sleep as the login has a concurrent enter_exit running
1620	# and this sleep increases chances of the player not ending up in scorn
1621	$pl->ob->reply (undef,
1622	"There was an internal problem at your last logout, "
1623	. "the server will try to bring you to your intended destination in a second.",
1624	cf::NDI_RED);
1625	Coro::Timer::sleep 1;
1626	$pl->ob->leave_link;
1627	})->prio (2);
1628	}
1629	},
1630	);
1631
1632	=item $player_object->goto ($path, $x, $y)
1633
1634	=cut	2371	=cut
		2372
		2373	our $GOTOGEN;
1635		2374
1636	sub cf::object::player::goto {	2375	sub cf::object::player::goto {
1637	my ($self, $path, $x, $y) = @_;	2376	my ($self, $path, $x, $y, $check, $done) = @_;
		2377
		2378	# do generation counting so two concurrent goto's will be executed in-order
		2379	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1638		2380
1639	$self->enter_link;	2381	$self->enter_link;
1640		2382
1641	(async {	2383	(async {
1642	$path = new cf::path $path;	2384	my $map = eval {
1643
1644	my $map = cf::map::find $path->as_string;	2385	my $map = cf::map::find $path;
		2386
		2387	if ($map) {
1645	$map = $map->customise_for ($self) if $map;	2388	$map = $map->customise_for ($self);
1646		2389	$map = $check->($map) if $check && $map;
1647	# warn "entering ", $map->path, " at ($x, $y)\n"	2390	} else {
1648	# if $map;
1649
1650	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2391	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2392	}
1651		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};
1652	$self->leave_link ($map, $x, $y);	2404	$self->leave_link ($map, $x, $y);
		2405	}
		2406
		2407	$done->() if $done;
1653	})->prio (1);	2408	})->prio (1);
1654	}	2409	}
1655		2410
1656	=item $player_object->enter_exit ($exit_object)	2411	=item $player_object->enter_exit ($exit_object)
1657		2412
…		…
1659		2414
1660	sub parse_random_map_params {	2415	sub parse_random_map_params {
1661	my ($spec) = @_;	2416	my ($spec) = @_;
1662		2417
1663	my $rmp = { # defaults	2418	my $rmp = { # defaults
1664	xsize => 10,	2419	xsize => (cf::rndm 15, 40),
1665	ysize => 10,	2420	ysize => (cf::rndm 15, 40),
		2421	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2422	#layout => string,
1666	};	2423	};
1667		2424
1668	for (split /\n/, $spec) {	2425	for (split /\n/, $spec) {
1669	my ($k, $v) = split /\s+/, $_, 2;	2426	my ($k, $v) = split /\s+/, $_, 2;
1670		2427
…		…
1674	$rmp	2431	$rmp
1675	}	2432	}
1676		2433
1677	sub prepare_random_map {	2434	sub prepare_random_map {
1678	my ($exit) = @_;	2435	my ($exit) = @_;
		2436
		2437	my $guard = cf::lock_acquire "exit_prepare:$exit";
1679		2438
1680	# all this does is basically replace the /! path by	2439	# all this does is basically replace the /! path by
1681	# a new random map path (?random/...) with a seed	2440	# a new random map path (?random/...) with a seed
1682	# that depends on the exit object	2441	# that depends on the exit object
1683		2442
1684	my $rmp = parse_random_map_params $exit->msg;	2443	my $rmp = parse_random_map_params $exit->msg;
1685		2444
1686	if ($exit->map) {	2445	if ($exit->map) {
1687	$rmp->{region} = $exit->map->region_name;	2446	$rmp->{region} = $exit->region->name;
1688	$rmp->{origin_map} = $exit->map->path;	2447	$rmp->{origin_map} = $exit->map->path;
1689	$rmp->{origin_x} = $exit->x;	2448	$rmp->{origin_x} = $exit->x;
1690	$rmp->{origin_y} = $exit->y;	2449	$rmp->{origin_y} = $exit->y;
1691	}	2450	}
1692		2451
1693	$rmp->{random_seed} ||= $exit->random_seed;	2452	$rmp->{random_seed} ||= $exit->random_seed;
1694		2453
1695	my $data = cf::to_json $rmp;	2454	my $data = cf::to_json $rmp;
1696	my $md5 = Digest::MD5::md5_hex $data;	2455	my $md5 = Digest::MD5::md5_hex $data;
		2456	my $meta = "$RANDOMDIR/$md5.meta";
1697		2457
1698	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) {
1699	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;
1700		2462
1701	$exit->slaying ("?random/$md5");	2463	$exit->slaying ("?random/$md5");
1702	$exit->msg (undef);	2464	$exit->msg (undef);
1703	}	2465	}
1704	}	2466	}
…		…
1706	sub cf::object::player::enter_exit {	2468	sub cf::object::player::enter_exit {
1707	my ($self, $exit) = @_;	2469	my ($self, $exit) = @_;
1708		2470
1709	return unless $self->type == cf::PLAYER;	2471	return unless $self->type == cf::PLAYER;
1710		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
1711	$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);
1712		2489
1713	(async {	2490	(async {
1714	$self->deactivate_recursive; # just to be sure	2491	$self->deactivate_recursive; # just to be sure
1715	unless (eval {	2492	unless (eval {
1716	prepare_random_map $exit	2493	$self->goto ($slaying, $hp, $sp);
1717	if $exit->slaying eq "/!";
1718
1719	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1720	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1721		2494
1722	1;	2495	1;
1723	}) {	2496	}) {
1724	$self->message ("Something went wrong deep within the crossfire server. "	2497	$self->message ("Something went wrong deep within the crossfire server. "
1725	. "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. "
1726	. "Please report this to the dungeon master",	2499	. "Please report this to the dungeon master!",
1727	cf::NDI_UNIQUE | cf::NDI_RED);	2500	cf::NDI_UNIQUE | cf::NDI_RED);
1728		2501
1729	warn "ERROR in enter_exit: $@";	2502	warn "ERROR in enter_exit: $@";
1730	$self->leave_link;	2503	$self->leave_link;
1731	}	2504	}
1732	})->prio (1);	2505	})->prio (1);
…		…
1745		2518
1746	sub cf::client::send_drawinfo {	2519	sub cf::client::send_drawinfo {
1747	my ($self, $text, $flags) = @_;	2520	my ($self, $text, $flags) = @_;
1748		2521
1749	utf8::encode $text;	2522	utf8::encode $text;
1750	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2523	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1751	}	2524	}
1752		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	# COMMAND/INFO
		2579	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2580	} else {
		2581	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2582	$self->send_packet ("drawinfo $color $msg")
		2583	}
		2584	}
		2585	}
		2586	}
		2587
		2588	=item $client->ext_msg ($type, @msg)
		2589
		2590	Sends an ext event to the client.
		2591
		2592	=cut
		2593
		2594	sub cf::client::ext_msg($$@) {
		2595	my ($self, $type, @msg) = @_;
		2596
		2597	my $extcmd = $self->extcmd;
		2598
		2599	if ($extcmd == 2) {
		2600	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2601	} elsif ($extcmd == 1) { # TODO: remove
		2602	push @msg, msgtype => "event_$type";
		2603	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2604	}
		2605	}
1753		2606
1754	=item $success = $client->query ($flags, "text", \&cb)	2607	=item $success = $client->query ($flags, "text", \&cb)
1755		2608
1756	Queues a query to the client, calling the given callback with	2609	Queues a query to the client, calling the given callback with
1757	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2610	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1758	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2611	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1759		2612
1760	Queries can fail, so check the return code. Or don't, as queries will become	2613	Queries can fail, so check the return code. Or don't, as queries will
1761	reliable at some point in the future.	2614	become reliable at some point in the future.
1762		2615
1763	=cut	2616	=cut
1764		2617
1765	sub cf::client::query {	2618	sub cf::client::query {
1766	my ($self, $flags, $text, $cb) = @_;	2619	my ($self, $flags, $text, $cb) = @_;
…		…
1774	utf8::encode $text;	2627	utf8::encode $text;
1775	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2628	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1776		2629
1777	$self->send_packet ($self->{query_queue}[0][0])	2630	$self->send_packet ($self->{query_queue}[0][0])
1778	if @{ $self->{query_queue} } == 1;	2631	if @{ $self->{query_queue} } == 1;
		2632
		2633	1
1779	}	2634	}
1780		2635
1781	cf::client->attach (	2636	cf::client->attach (
		2637	on_connect => sub {
		2638	my ($ns) = @_;
		2639
		2640	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2641	},
1782	on_reply => sub {	2642	on_reply => sub {
1783	my ($ns, $msg) = @_;	2643	my ($ns, $msg) = @_;
1784		2644
1785	# this weird shuffling is so that direct followup queries	2645	# this weird shuffling is so that direct followup queries
1786	# get handled first	2646	# get handled first
1787	my $queue = delete $ns->{query_queue}	2647	my $queue = delete $ns->{query_queue}
1788	or return; # be conservative, not sure how that can happen, but we saw a crash here	2648	or return; # be conservative, not sure how that can happen, but we saw a crash here
1789		2649
1790	(shift @$queue)->[1]->($msg);	2650	(shift @$queue)->[1]->($msg);
		2651	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1791		2652
1792	push @{ $ns->{query_queue} }, @$queue;	2653	push @{ $ns->{query_queue} }, @$queue;
1793		2654
1794	if (@{ $ns->{query_queue} } == @$queue) {	2655	if (@{ $ns->{query_queue} } == @$queue) {
1795	if (@$queue) {	2656	if (@$queue) {
…		…
1797	} else {	2658	} else {
1798	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2659	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1799	}	2660	}
1800	}	2661	}
1801	},	2662	},
		2663	on_exticmd => sub {
		2664	my ($ns, $buf) = @_;
		2665
		2666	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2667
		2668	if (ref $msg) {
		2669	my ($type, $reply, @payload) =
		2670	"ARRAY" eq ref $msg
		2671	? @$msg
		2672	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2673
		2674	if (my $cb = $EXTICMD{$type}) {
		2675	my @reply = $cb->($ns, @payload);
		2676
		2677	$ns->ext_reply ($reply, @reply)
		2678	if $reply;
		2679	}
		2680	} else {
		2681	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2682	}
		2683
		2684	cf::override;
		2685	},
1802	);	2686	);
1803		2687
1804	=item $client->async (\&cb)	2688	=item $client->async (\&cb)
1805		2689
1806	Create a new coroutine, running the specified callback. The coroutine will	2690	Create a new coroutine, running the specified callback. The coroutine will
…		…
1847	our $safe = new Safe "safe";	2731	our $safe = new Safe "safe";
1848	our $safe_hole = new Safe::Hole;	2732	our $safe_hole = new Safe::Hole;
1849		2733
1850	$SIG{FPE} = 'IGNORE';	2734	$SIG{FPE} = 'IGNORE';
1851		2735
1852	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2736	$safe->permit_only (Opcode::opset qw(
		2737	:base_core :base_mem :base_orig :base_math
		2738	grepstart grepwhile mapstart mapwhile
		2739	sort time
		2740	));
1853		2741
1854	# here we export the classes and methods available to script code	2742	# here we export the classes and methods available to script code
1855		2743
1856	=pod	2744	=pod
1857		2745
1858	The following fucntions and emthods are available within a safe environment:	2746	The following functions and methods are available within a safe environment:
1859		2747
1860	cf::object contr pay_amount pay_player map	2748	cf::object
		2749	contr pay_amount pay_player map x y force_find force_add
		2750	insert remove name archname title slaying race
		2751
1861	cf::object::player player	2752	cf::object::player
1862	cf::player peaceful	2753	player
1863	cf::map trigger	2754
		2755	cf::player
		2756	peaceful
		2757
		2758	cf::map
		2759	trigger
1864		2760
1865	=cut	2761	=cut
1866		2762
1867	for (	2763	for (
1868	["cf::object" => qw(contr pay_amount pay_player map)],	2764	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2765	insert remove inv name archname title slaying race)],
1869	["cf::object::player" => qw(player)],	2766	["cf::object::player" => qw(player)],
1870	["cf::player" => qw(peaceful)],	2767	["cf::player" => qw(peaceful)],
1871	["cf::map" => qw(trigger)],	2768	["cf::map" => qw(trigger)],
1872	) {	2769	) {
1873	no strict 'refs';	2770	no strict 'refs';
…		…
1944	=back	2841	=back
1945		2842
1946	=cut	2843	=cut
1947		2844
1948	#############################################################################	2845	#############################################################################
		2846	# the server's init and main functions
1949		2847
1950	=head2 EXTENSION DATABASE SUPPORT	2848	sub load_facedata($) {
		2849	my ($path) = @_;
1951		2850
1952	Crossfire maintains a very simple database for extension use. It can	2851	warn "loading facedata from $path\n";
1953	currently store anything that can be serialised using Storable, which
1954	excludes objects.
1955		2852
1956	The parameter C<$family> should best start with the name of the extension	2853	my $facedata;
1957	using it, it should be unique.	2854	0 < aio_load $path, $facedata
		2855	or die "$path: $!";
1958		2856
1959	=over 4	2857	$facedata = Coro::Storable::thaw $facedata;
1960		2858
1961	=item $hashref = cf::db_get $family	2859	$facedata->{version} == 2
		2860	or cf::cleanup "$path: version mismatch, cannot proceed.";
1962		2861
1963	Return a hashref for use by the extension C<$family>, which can be
1964	modified. After modifications, you have to call C<cf::db_dirty> or
1965	C<cf::db_sync>.
1966
1967	=item $value = cf::db_get $family => $key
1968
1969	Returns a single value from the database
1970
1971	=item cf::db_put $family => $hashref
1972
1973	Stores the given family hashref into the database. Updates are delayed, if
1974	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1975
1976	=item cf::db_put $family => $key => $value
1977
1978	Stores the given C<$value> in the family hash. Updates are delayed, if you
1979	want the data to be synced to disk immediately, use C<cf::db_sync>.
1980
1981	=item cf::db_dirty
1982
1983	Marks the database as dirty, to be updated at a later time.
1984
1985	=item cf::db_sync
1986
1987	Immediately write the database to disk I<if it is dirty>.
1988
1989	=cut
1990
1991	our $DB;
1992
1993	{
1994	my $path = cf::localdir . "/database.pst";
1995
1996	sub db_load() {
1997	$DB = stat $path ? Storable::retrieve $path : { };
1998	}	2862	{
		2863	my $faces = $facedata->{faceinfo};
1999		2864
2000	my $pid;	2865	while (my ($face, $info) = each %$faces) {
		2866	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2867	cf::face::set_visibility $idx, $info->{visibility};
		2868	cf::face::set_magicmap $idx, $info->{magicmap};
		2869	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2870	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2001		2871
2002	sub db_save() {	2872	cf::cede_to_tick;
2003	waitpid $pid, 0 if $pid;
2004	if (0 == ($pid = fork)) {
2005	$DB->{_meta}{version} = 1;
2006	Storable::nstore $DB, "$path~";
2007	rename "$path~", $path;
2008	cf::_exit 0 if defined $pid;
2009	}
2010	}
2011
2012	my $dirty;
2013
2014	sub db_sync() {
2015	db_save if $dirty;
2016	undef $dirty;
2017	}
2018
2019	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2020	db_sync;
2021	});
2022
2023	sub db_dirty() {
2024	$dirty = 1;
2025	$idle->start;
2026	}
2027
2028	sub db_get($;$) {
2029	@_ >= 2
2030	? $DB->{$_[0]}{$_[1]}
2031	: ($DB->{$_[0]} ||= { })
2032	}
2033
2034	sub db_put($$;$) {
2035	if (@_ >= 3) {
2036	$DB->{$_[0]}{$_[1]} = $_[2];
2037	} else {
2038	$DB->{$_[0]} = $_[1];
2039	}
2040	db_dirty;
2041	}
2042
2043	cf::global->attach (
2044	prio => 10000,
2045	on_cleanup => sub {
2046	db_sync;
2047	},	2873	}
2048	);
2049	}
2050		2874
2051	#############################################################################	2875	while (my ($face, $info) = each %$faces) {
2052	# the server's main()	2876	next unless $info->{smooth};
		2877	my $idx = cf::face::find $face
		2878	or next;
		2879	if (my $smooth = cf::face::find $info->{smooth}) {
		2880	cf::face::set_smooth $idx, $smooth;
		2881	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2882	} else {
		2883	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2884	}
		2885
		2886	cf::cede_to_tick;
		2887	}
		2888	}
		2889
		2890	{
		2891	my $anims = $facedata->{animinfo};
		2892
		2893	while (my ($anim, $info) = each %$anims) {
		2894	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2895	cf::cede_to_tick;
		2896	}
		2897
		2898	cf::anim::invalidate_all; # d'oh
		2899	}
		2900
		2901	{
		2902	# TODO: for gcfclient pleasure, we should give resources
		2903	# that gcfclient doesn't grok a >10000 face index.
		2904	my $res = $facedata->{resource};
		2905	my $enc = JSON::XS->new->utf8->canonical;
		2906
		2907	my $soundconf = delete $res->{"res/sound.conf"};
		2908
		2909	while (my ($name, $info) = each %$res) {
		2910	my $meta = $enc->encode ({
		2911	name => $name,
		2912	%{ $info->{meta} || {} },
		2913	});
		2914
		2915	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2916
		2917	if ($info->{type} & 1) {
		2918	# prepend meta info
		2919
		2920	my $data = pack "(w/a*)*", $meta, $info->{data};
		2921	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2922
		2923	cf::face::set_data $idx, 0, $data, $chk;
		2924	} else {
		2925	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
		2926	}
		2927
		2928	cf::face::set_type $idx, $info->{type};
		2929
		2930	cf::cede_to_tick;
		2931	}
		2932
		2933	if ($soundconf) {
		2934	$soundconf = $enc->decode (delete $soundconf->{data});
		2935
		2936	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2937	my $sound = $soundconf->{compat}[$_]
		2938	or next;
		2939
		2940	my $face = cf::face::find "sound/$sound->[1]";
		2941	cf::sound::set $sound->[0] => $face;
		2942	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2943	}
		2944
		2945	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2946	my $face = cf::face::find "sound/$v";
		2947	cf::sound::set $k => $face;
		2948	}
		2949	}
		2950	}
		2951
		2952	1
		2953	}
		2954
		2955	register_exticmd fx_want => sub {
		2956	my ($ns, $want) = @_;
		2957
		2958	while (my ($k, $v) = each %$want) {
		2959	$ns->fx_want ($k, $v);
		2960	}
		2961	};
		2962
		2963	sub reload_regions {
		2964	load_resource_file "$MAPDIR/regions"
		2965	or die "unable to load regions file\n";
		2966
		2967	for (cf::region::list) {
		2968	$_->{match} = qr/$_->{match}/
		2969	if exists $_->{match};
		2970	}
		2971	}
		2972
		2973	sub reload_facedata {
		2974	load_facedata "$DATADIR/facedata"
		2975	or die "unable to load facedata\n";
		2976	}
		2977
		2978	sub reload_archetypes {
		2979	load_resource_file "$DATADIR/archetypes"
		2980	or die "unable to load archetypes\n";
		2981	#d# NEED to laod twice to resolve forward references
		2982	# this really needs to be done in an extra post-pass
		2983	# (which needs to be synchronous, so solve it differently)
		2984	load_resource_file "$DATADIR/archetypes"
		2985	or die "unable to load archetypes\n";
		2986	}
		2987
		2988	sub reload_treasures {
		2989	load_resource_file "$DATADIR/treasures"
		2990	or die "unable to load treasurelists\n";
		2991	}
		2992
		2993	sub reload_resources {
		2994	warn "reloading resource files...\n";
		2995
		2996	reload_regions;
		2997	reload_facedata;
		2998	#reload_archetypes;#d#
		2999	reload_archetypes;
		3000	reload_treasures;
		3001
		3002	warn "finished reloading resource files\n";
		3003	}
		3004
		3005	sub init {
		3006	reload_resources;
		3007	}
2053		3008
2054	sub cfg_load {	3009	sub cfg_load {
2055	open my $fh, "<:utf8", cf::confdir . "/config"	3010	open my $fh, "<:utf8", "$CONFDIR/config"
2056	or return;	3011	or return;
2057		3012
2058	local $/;	3013	local $/;
2059	*CFG = YAML::Syck::Load <$fh>;	3014	*CFG = YAML::Syck::Load <$fh>;
2060		3015
…		…
2063	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	3018	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2064	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};	3019	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2065		3020
2066	if (exists $CFG{mlockall}) {	3021	if (exists $CFG{mlockall}) {
2067	eval {	3022	eval {
2068	$CFG{mlockall} ? &mlockall : &munlockall	3023	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2069	and die "WARNING: m(un)lockall failed: $!\n";	3024	and die "WARNING: m(un)lockall failed: $!\n";
2070	};	3025	};
2071	warn $@ if $@;	3026	warn $@ if $@;
2072	}	3027	}
2073	}	3028	}
2074		3029
2075	sub main {	3030	sub main {
2076	# we must not ever block the main coroutine	3031	# we must not ever block the main coroutine
2077	local $Coro::idle = sub {	3032	local $Coro::idle = sub {
2078	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3033	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		3034	(async {
2079	async { Event::one_event };	3035	Event::one_event;
		3036	})->prio (Coro::PRIO_MAX);
2080	};	3037	};
2081		3038
2082	cfg_load;	3039	cfg_load;
2083	db_load;	3040	db_init;
2084	load_extensions;	3041	load_extensions;
		3042
		3043	$TICK_WATCHER->start;
2085	Event::loop;	3044	Event::loop;
2086	}	3045	}
2087		3046
2088	#############################################################################	3047	#############################################################################
2089	# initialisation	3048	# initialisation and cleanup
2090		3049
		3050	# install some emergency cleanup handlers
		3051	BEGIN {
		3052	for my $signal (qw(INT HUP TERM)) {
		3053	Event->signal (
		3054	reentrant => 0,
		3055	data => WF_AUTOCANCEL,
		3056	signal => $signal,
		3057	prio => 0,
		3058	cb => sub {
		3059	cf::cleanup "SIG$signal";
		3060	},
		3061	);
		3062	}
		3063	}
		3064
		3065	sub write_runtime {
		3066	my $runtime = "$LOCALDIR/runtime";
		3067
		3068	# first touch the runtime file to show we are still running:
		3069	# the fsync below can take a very very long time.
		3070
		3071	IO::AIO::aio_utime $runtime, undef, undef;
		3072
		3073	my $guard = cf::lock_acquire "write_runtime";
		3074
		3075	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3076	or return;
		3077
		3078	my $value = $cf::RUNTIME + 90 + 10;
		3079	# 10 is the runtime save interval, for a monotonic clock
		3080	# 60 allows for the watchdog to kill the server.
		3081
		3082	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3083	and return;
		3084
		3085	# always fsync - this file is important
		3086	aio_fsync $fh
		3087	and return;
		3088
		3089	# touch it again to show we are up-to-date
		3090	aio_utime $fh, undef, undef;
		3091
		3092	close $fh
		3093	or return;
		3094
		3095	aio_rename "$runtime~", $runtime
		3096	and return;
		3097
		3098	warn "runtime file written.\n";
		3099
		3100	1
		3101	}
		3102
		3103	sub emergency_save() {
		3104	my $freeze_guard = cf::freeze_mainloop;
		3105
		3106	warn "enter emergency perl save\n";
		3107
		3108	cf::sync_job {
		3109	# use a peculiar iteration method to avoid tripping on perl
		3110	# refcount bugs in for. also avoids problems with players
		3111	# and maps saved/destroyed asynchronously.
		3112	warn "begin emergency player save\n";
		3113	for my $login (keys %cf::PLAYER) {
		3114	my $pl = $cf::PLAYER{$login} or next;
		3115	$pl->valid or next;
		3116	$pl->save;
		3117	}
		3118	warn "end emergency player save\n";
		3119
		3120	warn "begin emergency map save\n";
		3121	for my $path (keys %cf::MAP) {
		3122	my $map = $cf::MAP{$path} or next;
		3123	$map->valid or next;
		3124	$map->save;
		3125	}
		3126	warn "end emergency map save\n";
		3127
		3128	warn "begin emergency database checkpoint\n";
		3129	BDB::db_env_txn_checkpoint $DB_ENV;
		3130	warn "end emergency database checkpoint\n";
		3131	};
		3132
		3133	warn "leave emergency perl save\n";
		3134	}
		3135
		3136	sub post_cleanup {
		3137	my ($make_core) = @_;
		3138
		3139	warn Carp::longmess "post_cleanup backtrace"
		3140	if $make_core;
		3141	}
		3142
2091	sub reload() {	3143	sub do_reload_perl() {
2092	# can/must only be called in main	3144	# can/must only be called in main
2093	if ($Coro::current != $Coro::main) {	3145	if ($Coro::current != $Coro::main) {
2094	warn "can only reload from main coroutine\n";	3146	warn "can only reload from main coroutine";
2095	return;	3147	return;
2096	}	3148	}
2097		3149
2098	warn "reloading...";	3150	warn "reloading...";
2099		3151
2100	my $guard = freeze_mainloop;	3152	warn "entering sync_job";
		3153
		3154	cf::sync_job {
		3155	cf::write_runtime; # external watchdog should not bark
2101	cf::emergency_save;	3156	cf::emergency_save;
		3157	cf::write_runtime; # external watchdog should not bark
2102		3158
2103	eval {	3159	warn "syncing database to disk";
		3160	BDB::db_env_txn_checkpoint $DB_ENV;
		3161
2104	# if anything goes wrong in here, we should simply crash as we already saved	3162	# if anything goes wrong in here, we should simply crash as we already saved
2105		3163
2106	# cancel all watchers	3164	warn "cancelling all WF_AUTOCANCEL watchers";
2107	for (Event::all_watchers) {	3165	for (Event::all_watchers) {
2108	$_->cancel if $_->data & WF_AUTOCANCEL;	3166	$_->cancel if $_->data & WF_AUTOCANCEL;
2109	}	3167	}
2110		3168
		3169	warn "flushing outstanding aio requests";
		3170	for (;;) {
		3171	BDB::flush;
		3172	IO::AIO::flush;
		3173	Coro::cede;
		3174	last unless IO::AIO::nreqs || BDB::nreqs;
		3175	warn "iterate...";
		3176	}
		3177
		3178	++$RELOAD;
		3179
2111	# cancel all extension coros	3180	warn "cancelling all extension coros";
2112	$_->cancel for values %EXT_CORO;	3181	$_->cancel for values %EXT_CORO;
2113	%EXT_CORO = ();	3182	%EXT_CORO = ();
2114		3183
2115	# unload all extensions	3184	warn "removing commands";
2116	for (@exts) {	3185	%COMMAND = ();
		3186
		3187	warn "removing ext/exti commands";
		3188	%EXTCMD = ();
		3189	%EXTICMD = ();
		3190
		3191	warn "unloading/nuking all extensions";
		3192	for my $pkg (@EXTS) {
2117	warn "unloading <$_>";	3193	warn "... unloading $pkg";
2118	unload_extension $_;	3194
		3195	if (my $cb = $pkg->can ("unload")) {
		3196	eval {
		3197	$cb->($pkg);
		3198	1
		3199	} or warn "$pkg unloaded, but with errors: $@";
2119	}	3200	}
2120		3201
		3202	warn "... nuking $pkg";
		3203	Symbol::delete_package $pkg;
		3204	}
		3205
2121	# unload all modules loaded from $LIBDIR	3206	warn "unloading all perl modules loaded from $LIBDIR";
2122	while (my ($k, $v) = each %INC) {	3207	while (my ($k, $v) = each %INC) {
2123	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3208	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2124		3209
2125	warn "removing <$k>";	3210	warn "... unloading $k";
2126	delete $INC{$k};	3211	delete $INC{$k};
2127		3212
2128	$k =~ s/\.pm$//;	3213	$k =~ s/\.pm$//;
2129	$k =~ s/\//::/g;	3214	$k =~ s/\//::/g;
2130		3215
…		…
2133	}	3218	}
2134		3219
2135	Symbol::delete_package $k;	3220	Symbol::delete_package $k;
2136	}	3221	}
2137		3222
2138	# sync database to disk
2139	cf::db_sync;
2140	IO::AIO::flush;
2141
2142	# get rid of safe::, as good as possible	3223	warn "getting rid of safe::, as good as possible";
2143	Symbol::delete_package "safe::$_"	3224	Symbol::delete_package "safe::$_"
2144	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3225	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2145		3226
2146	# remove register_script_function callbacks
2147	# TODO
2148
2149	# unload cf.pm "a bit"	3227	warn "unloading cf.pm \"a bit\"";
2150	delete $INC{"cf.pm"};	3228	delete $INC{"cf.pm"};
		3229	delete $INC{"cf/pod.pm"};
2151		3230
2152	# don't, removes xs symbols, too,	3231	# don't, removes xs symbols, too,
2153	# and global variables created in xs	3232	# and global variables created in xs
2154	#Symbol::delete_package __PACKAGE__;	3233	#Symbol::delete_package __PACKAGE__;
2155		3234
2156	# reload cf.pm	3235	warn "unload completed, starting to reload now";
		3236
2157	warn "reloading cf.pm";	3237	warn "reloading cf.pm";
2158	require cf;	3238	require cf;
2159	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3239	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2160		3240
2161	# load config and database again	3241	warn "loading config and database again";
2162	cf::cfg_load;	3242	cf::cfg_load;
2163	cf::db_load;
2164		3243
2165	# load extensions
2166	warn "load extensions";	3244	warn "loading extensions";
2167	cf::load_extensions;	3245	cf::load_extensions;
2168		3246
2169	# reattach attachments to objects	3247	warn "reattaching attachments to objects/players";
2170	warn "reattach";	3248	_global_reattach; # objects, sockets
2171	_global_reattach;	3249	warn "reattaching attachments to maps";
2172	};	3250	reattach $_ for values %MAP;
		3251	warn "reattaching attachments to players";
		3252	reattach $_ for values %PLAYER;
2173		3253
2174	if ($@) {	3254	warn "leaving sync_job";
		3255
		3256	1
		3257	} or do {
2175	warn $@;	3258	warn $@;
2176	warn "error while reloading, exiting.";	3259	warn "error while reloading, exiting.";
2177	exit 1;	3260	exit 1;
2178	}	3261	};
2179		3262
2180	warn "reloaded successfully";	3263	warn "reloaded";
2181	};	3264	};
2182		3265
2183	#############################################################################	3266	our $RELOAD_WATCHER; # used only during reload
2184		3267
2185	unless ($LINK_MAP) {	3268	sub reload_perl() {
2186	$LINK_MAP = cf::map::new;	3269	# doing reload synchronously and two reloads happen back-to-back,
		3270	# coro crashes during coro_state_free->destroy here.
2187		3271
2188	$LINK_MAP->width (41);	3272	$RELOAD_WATCHER ||= Event->timer (
2189	$LINK_MAP->height (41);	3273	reentrant => 0,
2190	$LINK_MAP->alloc;
2191	$LINK_MAP->path ("{link}");
2192	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2193	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2194
2195	# dirty hack because... archetypes are not yet loaded
2196	Event->timer (
2197	after => 10,	3274	after => 0,
		3275	data => WF_AUTOCANCEL,
2198	cb => sub {	3276	cb => sub {
2199	$_[0]->w->cancel;	3277	do_reload_perl;
2200		3278	undef $RELOAD_WATCHER;
2201	# provide some exits "home"
2202	my $exit = cf::object::new "exit";
2203
2204	$exit->slaying ($EMERGENCY_POSITION->[0]);
2205	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2206	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2207
2208	$LINK_MAP->insert ($exit->clone, 19, 19);
2209	$LINK_MAP->insert ($exit->clone, 19, 20);
2210	$LINK_MAP->insert ($exit->clone, 19, 21);
2211	$LINK_MAP->insert ($exit->clone, 20, 19);
2212	$LINK_MAP->insert ($exit->clone, 20, 21);
2213	$LINK_MAP->insert ($exit->clone, 21, 19);
2214	$LINK_MAP->insert ($exit->clone, 21, 20);
2215	$LINK_MAP->insert ($exit->clone, 21, 21);
2216
2217	$exit->destroy;
2218	});	3279	},
2219		3280	);
2220	$LINK_MAP->{deny_save} = 1;
2221	$LINK_MAP->{deny_reset} = 1;
2222
2223	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2224	}	3281	}
2225
2226	register "<global>", __PACKAGE__;
2227		3282
2228	register_command "reload" => sub {	3283	register_command "reload" => sub {
2229	my ($who, $arg) = @_;	3284	my ($who, $arg) = @_;
2230		3285
2231	if ($who->flag (FLAG_WIZ)) {	3286	if ($who->flag (FLAG_WIZ)) {
2232	$who->message ("start of reload.");
2233	reload;
2234	$who->message ("end of reload.");	3287	$who->message ("reloading server.");
		3288	async { reload_perl };
2235	}	3289	}
2236	};	3290	};
2237		3291
2238	unshift @INC, $LIBDIR;	3292	unshift @INC, $LIBDIR;
2239		3293
		3294	my $bug_warning = 0;
		3295
		3296	our @WAIT_FOR_TICK;
		3297	our @WAIT_FOR_TICK_BEGIN;
		3298
		3299	sub wait_for_tick {
		3300	return unless $TICK_WATCHER->is_active;
		3301	return if $Coro::current == $Coro::main;
		3302
		3303	my $signal = new Coro::Signal;
		3304	push @WAIT_FOR_TICK, $signal;
		3305	$signal->wait;
		3306	}
		3307
		3308	sub wait_for_tick_begin {
		3309	return unless $TICK_WATCHER->is_active;
		3310	return if $Coro::current == $Coro::main;
		3311
		3312	my $signal = new Coro::Signal;
		3313	push @WAIT_FOR_TICK_BEGIN, $signal;
		3314	$signal->wait;
		3315	}
		3316
		3317	my $min = 1e6;#d#
		3318	my $avg = 10;
2240	$TICK_WATCHER = Event->timer (	3319	$TICK_WATCHER = Event->timer (
2241	reentrant => 0,	3320	reentrant => 0,
		3321	parked => 1,
2242	prio => 0,	3322	prio => 0,
2243	at => $NEXT_TICK || $TICK,	3323	at => $NEXT_TICK || $TICK,
2244	data => WF_AUTOCANCEL,	3324	data => WF_AUTOCANCEL,
2245	cb => sub {	3325	cb => sub {
		3326	if ($Coro::current != $Coro::main) {
		3327	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3328	unless ++$bug_warning > 10;
		3329	return;
		3330	}
		3331
		3332	$NOW = $tick_start = Event::time;
		3333
2246	cf::server_tick; # one server iteration	3334	cf::server_tick; # one server iteration
		3335
		3336	0 && sync_job {#d#
		3337	for(1..10) {
		3338	my $t = Event::time;
		3339	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3340	or die;
		3341
		3342	$map->width (50);
		3343	$map->height (50);
		3344	$map->alloc;
		3345	$map->_load_objects ("/tmp/x.map", 1);
		3346	my $t = Event::time - $t;
		3347
		3348	#next unless $t < 0.0013;#d#
		3349	if ($t < $min) {
		3350	$min = $t;
		3351	}
		3352	$avg = $avg * 0.99 + $t * 0.01;
		3353	}
		3354	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3355	exit 0;
		3356	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3357	};
		3358
2247	$RUNTIME += $TICK;	3359	$RUNTIME += $TICK;
2248	$NEXT_TICK += $TICK;	3360	$NEXT_TICK += $TICK;
2249		3361
		3362	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		3363	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3364	Coro::async_pool {
		3365	write_runtime
		3366	or warn "ERROR: unable to write runtime file: $!";
		3367	};
		3368	}
		3369
		3370	# my $AFTER = Event::time;
		3371	# warn $AFTER - $NOW;#d#
		3372
		3373	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3374	$sig->send;
		3375	}
		3376	while (my $sig = shift @WAIT_FOR_TICK) {
		3377	$sig->send;
		3378	}
		3379
		3380	$NOW = Event::time;
		3381
2250	# if we are delayed by four ticks or more, skip them all	3382	# if we are delayed by four ticks or more, skip them all
2251	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3383	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2252		3384
2253	$TICK_WATCHER->at ($NEXT_TICK);	3385	$TICK_WATCHER->at ($NEXT_TICK);
2254	$TICK_WATCHER->start;	3386	$TICK_WATCHER->start;
		3387
		3388	$LOAD = ($NOW - $tick_start) / $TICK;
		3389	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3390
		3391	_post_tick;
		3392
		3393
2255	},	3394	},
2256	);	3395	);
2257		3396
		3397	{
2258	IO::AIO::max_poll_time $TICK * 0.2;	3398	BDB::max_poll_time $TICK * 0.1;
2259		3399	$BDB_POLL_WATCHER = Event->io (
2260	Event->io (	3400	reentrant => 0,
2261	fd => IO::AIO::poll_fileno,	3401	fd => BDB::poll_fileno,
2262	poll => 'r',	3402	poll => 'r',
2263	prio => 5,	3403	prio => 0,
2264	data => WF_AUTOCANCEL,
2265	cb => \&IO::AIO::poll_cb,
2266	);
2267
2268	Event->timer (
2269	data => WF_AUTOCANCEL,	3404	data => WF_AUTOCANCEL,
2270	after => 0,	3405	cb => \&BDB::poll_cb,
2271	interval => 10,	3406	);
2272	cb => sub {	3407	BDB::min_parallel 8;
2273	(Coro::unblock_sub {	3408
2274	write_runtime	3409	BDB::set_sync_prepare {
2275	or warn "ERROR: unable to write runtime file: $!";	3410	my $status;
		3411	my $current = $Coro::current;
		3412	(
		3413	sub {
		3414	$status = $!;
		3415	$current->ready; undef $current;
		3416	},
		3417	sub {
		3418	Coro::schedule while defined $current;
		3419	$! = $status;
		3420	},
		3421	)
		3422	};
		3423
		3424	unless ($DB_ENV) {
		3425	$DB_ENV = BDB::db_env_create;
		3426
		3427	cf::sync_job {
		3428	eval {
		3429	BDB::db_env_open
		3430	$DB_ENV,
		3431	$BDBDIR,
		3432	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3433	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3434	0666;
		3435
		3436	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3437
		3438	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3439	$DB_ENV->set_lk_detect;
		3440	};
		3441
		3442	cf::cleanup "db_env_open(db): $@" if $@;
2276	})->();	3443	};
2277	},	3444	}
2278	);	3445	}
		3446
		3447	{
		3448	IO::AIO::min_parallel 8;
		3449
		3450	undef $Coro::AIO::WATCHER;
		3451	IO::AIO::max_poll_time $TICK * 0.1;
		3452	$AIO_POLL_WATCHER = Event->io (
		3453	reentrant => 0,
		3454	data => WF_AUTOCANCEL,
		3455	fd => IO::AIO::poll_fileno,
		3456	poll => 'r',
		3457	prio => 6,
		3458	cb => \&IO::AIO::poll_cb,
		3459	);
		3460	}
		3461
		3462	my $_log_backtrace;
		3463
		3464	sub _log_backtrace {
		3465	my ($msg, @addr) = @_;
		3466
		3467	$msg =~ s/\n//;
		3468
		3469	# limit the # of concurrent backtraces
		3470	if ($_log_backtrace < 2) {
		3471	++$_log_backtrace;
		3472	async {
		3473	my @bt = fork_call {
		3474	@addr = map { sprintf "%x", $_ } @addr;
		3475	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3476	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3477	or die "addr2line: $!";
		3478
		3479	my @funcs;
		3480	my @res = <$fh>;
		3481	chomp for @res;
		3482	while (@res) {
		3483	my ($func, $line) = splice @res, 0, 2, ();
		3484	push @funcs, "[$func] $line";
		3485	}
		3486
		3487	@funcs
		3488	};
		3489
		3490	LOG llevInfo, "[ABT] $msg\n";
		3491	LOG llevInfo, "[ABT] $_\n" for @bt;
		3492	--$_log_backtrace;
		3493	};
		3494	} else {
		3495	LOG llevInfo, "[ABT] $msg\n";
		3496	LOG llevInfo, "[ABT] [suppressed]\n";
		3497	}
		3498	}
		3499
		3500	# load additional modules
		3501	use cf::pod;
2279		3502
2280	END { cf::emergency_save }	3503	END { cf::emergency_save }
2281		3504
2282	1	3505	1
2283		3506

Diff Legend

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