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

Diff Legend

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