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.123 by root, Tue Jan 2 19:18:33 2007 UTC vs.
Revision 1.275 by root, Thu Jun 7 19:12:22 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 BDB ();
		26	use Data::Dumper;
20	use Digest::MD5;	27	use Digest::MD5;
21	use Fcntl;	28	use Fcntl;
22	use IO::AIO 2.31 ();
23	use YAML::Syck ();	29	use YAML::Syck ();
		30	use IO::AIO 2.32 ();
24	use Time::HiRes;	31	use Time::HiRes;
		32	use Compress::LZF;
25		33
		34	# configure various modules to our taste
		35	#
		36	$Storable::canonical = 1; # reduce rsync transfers
		37	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		38	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		39
26	use Event; $Event::Eval = 1; # no idea why this is required, but it is	40	$Event::Eval = 1; # no idea why this is required, but it is
27		41
28	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	42	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
29	$YAML::Syck::ImplicitUnicode = 1;	43	$YAML::Syck::ImplicitUnicode = 1;
30		44
31	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority	45	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
32		46
33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	47	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34		48
35	our %COMMAND = ();	49	our %COMMAND = ();
36	our %COMMAND_TIME = ();	50	our %COMMAND_TIME = ();
		51
		52	our @EXTS = (); # list of extension package names
37	our %EXTCMD = ();	53	our %EXTCMD = ();
		54	our %EXT_CORO = (); # coroutines bound to extensions
		55	our %EXT_MAP = (); # pluggable maps
38		56
		57	our $RELOAD; # number of reloads so far
39	our @EVENT;	58	our @EVENT;
40	our $LIBDIR = datadir . "/ext";
41		59
42	our $TICK = MAX_TIME * 1e-6;	60	our $CONFDIR = confdir;
		61	our $DATADIR = datadir;
		62	our $LIBDIR = "$DATADIR/ext";
		63	our $PODDIR = "$DATADIR/pod";
		64	our $MAPDIR = "$DATADIR/" . mapdir;
		65	our $LOCALDIR = localdir;
		66	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		67	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		68	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		69	our $RANDOMDIR = "$LOCALDIR/random";
		70	our $BDBDIR = "$LOCALDIR/db";
		71
		72	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
43	our $TICK_WATCHER;	73	our $TICK_WATCHER;
		74	our $AIO_POLL_WATCHER;
		75	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44	our $NEXT_TICK;	76	our $NEXT_TICK;
45	our $NOW;	77	our $NOW;
		78	our $USE_FSYNC = 1; # use fsync to write maps - default off
		79
		80	our $BDB_POLL_WATCHER;
		81	our $DB_ENV;
46		82
47	our %CFG;	83	our %CFG;
48		84
49	our $UPTIME; $UPTIME ||= time;	85	our $UPTIME; $UPTIME ||= time;
50	our $RUNTIME;	86	our $RUNTIME;
51		87
		88	our %PLAYER; # all users
52	our %MAP; # all maps	89	our %MAP; # all maps
53	our $LINK_MAP; # the special {link} map	90	our $LINK_MAP; # the special {link} map, which is always available
54	our $FREEZE;	91
55	our $RANDOM_MAPS = cf::localdir . "/random";	92	# used to convert map paths into valid unix filenames by replacing / by ∕
56	our %EXT_CORO;	93	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		94
		95	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		96	our $LOADAVG; # same thing, but with alpha-smoothing
		97	our $tick_start; # for load detecting purposes
57		98
58	binmode STDOUT;	99	binmode STDOUT;
59	binmode STDERR;	100	binmode STDERR;
60		101
61	# read virtual server time, if available	102	# read virtual server time, if available
62	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	103	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
63	open my $fh, "<", cf::localdir . "/runtime"	104	open my $fh, "<", "$LOCALDIR/runtime"
64	or die "unable to read runtime file: $!";	105	or die "unable to read runtime file: $!";
65	$RUNTIME = <$fh> + 0.;	106	$RUNTIME = <$fh> + 0.;
66	}	107	}
67		108
68	mkdir cf::localdir;	109	mkdir $_
69	mkdir cf::localdir . "/" . cf::playerdir;	110	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
70	mkdir cf::localdir . "/" . cf::tmpdir;
71	mkdir cf::localdir . "/" . cf::uniquedir;
72	mkdir $RANDOM_MAPS;
73		111
74	# a special map that is always available	112	our $EMERGENCY_POSITION;
75	our $LINK_MAP;
76		113
77	our $EMERGENCY_POSITION = $cf::CFG{emergency_position} || ["/world/world_105_115", 5, 37];	114	sub cf::map::normalise;
78		115
79	#############################################################################	116	#############################################################################
80		117
81	=head2 GLOBAL VARIABLES	118	=head2 GLOBAL VARIABLES
82		119
…		…
89	=item $cf::RUNTIME	126	=item $cf::RUNTIME
90		127
91	The time this server has run, starts at 0 and is increased by $cf::TICK on	128	The time this server has run, starts at 0 and is increased by $cf::TICK on
92	every server tick.	129	every server tick.
93		130
94	=item $cf::LIBDIR	131	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		132	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		133	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
95		134
96	The perl library directory, where extensions and cf-specific modules can	135	Various directories - "/etc", read-only install directory, perl-library
97	be found. It will be added to C<@INC> automatically.	136	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		137	unique-items directory, player file directory, random maps directory and
		138	database environment.
98		139
99	=item $cf::NOW	140	=item $cf::NOW
100		141
101	The time of the last (current) server tick.	142	The time of the last (current) server tick.
102		143
103	=item $cf::TICK	144	=item $cf::TICK
104		145
105	The interval between server ticks, in seconds.	146	The interval between server ticks, in seconds.
		147
		148	=item $cf::LOADAVG
		149
		150	The current CPU load on the server (alpha-smoothed), as a value between 0
		151	(none) and 1 (overloaded), indicating how much time is spent on processing
		152	objects per tick. Healthy values are < 0.5.
		153
		154	=item $cf::LOAD
		155
		156	The raw value load value from the last tick.
106		157
107	=item %cf::CFG	158	=item %cf::CFG
108		159
109	Configuration for the server, loaded from C</etc/crossfire/config>, or	160	Configuration for the server, loaded from C</etc/crossfire/config>, or
110	from wherever your confdir points to.	161	from wherever your confdir points to.
		162
		163	=item cf::wait_for_tick, cf::wait_for_tick_begin
		164
		165	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
		166	returns directly I<after> the tick processing (and consequently, can only wake one process
		167	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
111		168
112	=back	169	=back
113		170
114	=cut	171	=cut
115		172
116	BEGIN {	173	BEGIN {
117	*CORE::GLOBAL::warn = sub {	174	*CORE::GLOBAL::warn = sub {
118	my $msg = join "", @_;	175	my $msg = join "", @_;
119	utf8::encode $msg;
120		176
121	$msg .= "\n"	177	$msg .= "\n"
122	unless $msg =~ /\n$/;	178	unless $msg =~ /\n$/;
123		179
		180	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		181
		182	utf8::encode $msg;
124	LOG llevError, "cfperl: $msg";	183	LOG llevError, $msg;
125	};	184	};
126	}	185	}
127		186
128	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	187	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
129	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	188	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
130	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	189	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
131	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	190	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
132	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	191	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		192	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
133	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	193	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
134		194
135	# we bless all objects into (empty) derived classes to force a method lookup	195	# we bless all objects into (empty) derived classes to force a method lookup
136	# within the Safe compartment.	196	# within the Safe compartment.
137	for my $pkg (qw(	197	for my $pkg (qw(
138	cf::global cf::attachable	198	cf::global cf::attachable
…		…
147		207
148	$Event::DIED = sub {	208	$Event::DIED = sub {
149	warn "error in event callback: @_";	209	warn "error in event callback: @_";
150	};	210	};
151		211
152	my %ext_pkg;
153	my @exts;
154	my @hook;
155
156	=head2 UTILITY FUNCTIONS	212	=head2 UTILITY FUNCTIONS
157		213
158	=over 4	214	=over 4
159		215
160	=cut	216	=item dumpval $ref
161		217
		218	=cut
		219
		220	sub dumpval {
		221	eval {
		222	local $SIG{__DIE__};
		223	my $d;
		224	if (1) {
		225	$d = new Data::Dumper([$_[0]], ["*var"]);
		226	$d->Terse(1);
		227	$d->Indent(2);
		228	$d->Quotekeys(0);
		229	$d->Useqq(1);
		230	#$d->Bless(...);
		231	$d->Seen($_[1]) if @_ > 1;
		232	$d = $d->Dump();
		233	}
		234	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		235	$d
		236	} || "[unable to dump $_[0]: '$@']";
		237	}
		238
162	use JSON::Syck (); # TODO# replace by JSON::PC once working	239	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
163		240
164	=item $ref = cf::from_json $json	241	=item $ref = cf::from_json $json
165		242
166	Converts a JSON string into the corresponding perl data structure.	243	Converts a JSON string into the corresponding perl data structure.
167		244
168	=cut
169
170	sub from_json($) {
171	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
172	JSON::Syck::Load $_[0]
173	}
174
175	=item $json = cf::to_json $ref	245	=item $json = cf::to_json $ref
176		246
177	Converts a perl data structure into its JSON representation.	247	Converts a perl data structure into its JSON representation.
178		248
179	=cut
180
181	sub to_json($) {
182	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
183	JSON::Syck::Dump $_[0]
184	}
185
186	=item my $guard = cf::guard { BLOCK }
187
188	Run the given callback when the guard object gets destroyed (useful for
189	coroutine cancellations).
190
191	You can call C<< ->cancel >> on the guard object to stop the block from
192	being executed.
193
194	=cut
195
196	sub guard(&) {
197	bless \(my $cb = $_[0]), cf::guard::;
198	}
199
200	sub cf::guard::cancel {
201	${$_[0]} = sub { };
202	}
203
204	sub cf::guard::DESTROY {
205	${$_[0]}->();
206	}
207
208	=item cf::lock_wait $string	249	=item cf::lock_wait $string
209		250
210	Wait until the given lock is available. See cf::lock_acquire.	251	Wait until the given lock is available. See cf::lock_acquire.
211		252
212	=item my $lock = cf::lock_acquire $string	253	=item my $lock = cf::lock_acquire $string
213		254
214	Wait until the given lock is available and then acquires it and returns	255	Wait until the given lock is available and then acquires it and returns
215	a guard object. If the guard object gets destroyed (goes out of scope,	256	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
216	for example when the coroutine gets canceled), the lock is automatically	257	for example when the coroutine gets canceled), the lock is automatically
217	returned.	258	returned.
218		259
219	Lock names should begin with a unique identifier (for example, find_map	260	Lock names should begin with a unique identifier (for example, cf::map::find
220	uses map_find and load_map uses map_load).	261	uses map_find and cf::map::load uses map_load).
		262
		263	=item $locked = cf::lock_active $string
		264
		265	Return true if the lock is currently active, i.e. somebody has locked it.
221		266
222	=cut	267	=cut
223		268
224	our %LOCK;	269	our %LOCK;
225		270
…		…
239	# wait, to be sure we are not locked	284	# wait, to be sure we are not locked
240	lock_wait $key;	285	lock_wait $key;
241		286
242	$LOCK{$key} = [];	287	$LOCK{$key} = [];
243		288
244	cf::guard {	289	Coro::guard {
245	# wake up all waiters, to be on the safe side	290	# wake up all waiters, to be on the safe side
246	$_->ready for @{ delete $LOCK{$key} };	291	$_->ready for @{ delete $LOCK{$key} };
247	}	292	}
248	}	293	}
		294
		295	sub lock_active($) {
		296	my ($key) = @_;
		297
		298	! ! $LOCK{$key}
		299	}
		300
		301	sub freeze_mainloop {
		302	return unless $TICK_WATCHER->is_active;
		303
		304	my $guard = Coro::guard {
		305	$TICK_WATCHER->start;
		306	};
		307	$TICK_WATCHER->stop;
		308	$guard
		309	}
		310
		311	=item cf::async { BLOCK }
		312
		313	Currently the same as Coro::async_pool, meaning you cannot use
		314	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		315	thing you are allowed to do is call C<prio> on it.
		316
		317	=cut
		318
		319	BEGIN { *async = \&Coro::async_pool }
249		320
250	=item cf::sync_job { BLOCK }	321	=item cf::sync_job { BLOCK }
251		322
252	The design of crossfire+ requires that the main coro ($Coro::main) is	323	The design of crossfire+ requires that the main coro ($Coro::main) is
253	always able to handle events or runnable, as crossfire+ is only partly	324	always able to handle events or runnable, as crossfire+ is only partly
…		…
262		333
263	sub sync_job(&) {	334	sub sync_job(&) {
264	my ($job) = @_;	335	my ($job) = @_;
265		336
266	if ($Coro::current == $Coro::main) {	337	if ($Coro::current == $Coro::main) {
		338	my $time = Event::time;
		339
267	# this is the main coro, too bad, we have to block	340	# this is the main coro, too bad, we have to block
268	# till the operation succeeds, freezing the server :/	341	# till the operation succeeds, freezing the server :/
269		342
270	# TODO: use suspend/resume instead	343	# TODO: use suspend/resume instead
271	# (but this is cancel-safe)	344	# (but this is cancel-safe)
272	local $FREEZE = 1;	345	my $freeze_guard = freeze_mainloop;
273		346
274	my $busy = 1;	347	my $busy = 1;
275	my @res;	348	my @res;
276		349
277	(Coro::async {	350	(async {
278	@res = eval { $job->() };	351	@res = eval { $job->() };
279	warn $@ if $@;	352	warn $@ if $@;
280	undef $busy;	353	undef $busy;
281	})->prio (Coro::PRIO_MAX);	354	})->prio (Coro::PRIO_MAX);
282		355
283	while ($busy) {	356	while ($busy) {
284	Coro::cede_notself;	357	Coro::cede or Event::one_event;
285	Event::one_event unless Coro::nready;
286	}	358	}
		359
		360	$time = Event::time - $time;
		361
		362	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		363	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		364
		365	$tick_start += $time; # do not account sync jobs to server load
287		366
288	wantarray ? @res : $res[0]	367	wantarray ? @res : $res[0]
289	} else {	368	} else {
290	# we are in another coroutine, how wonderful, everything just works	369	# we are in another coroutine, how wonderful, everything just works
291		370
292	$job->()	371	$job->()
293	}	372	}
294	}	373	}
295		374
296	=item $coro = cf::coro { BLOCK }	375	=item $coro = cf::async_ext { BLOCK }
297		376
298	Creates and returns a new coro. This coro is automcatially being canceled	377	Like async, but this coro is automatically being canceled when the
299	when the extension calling this is being unloaded.	378	extension calling this is being unloaded.
300		379
301	=cut	380	=cut
302		381
303	sub coro(&) {	382	sub async_ext(&) {
304	my $cb = shift;	383	my $cb = shift;
305		384
306	my $coro; $coro = async {	385	my $coro = &Coro::async ($cb);
307	eval {
308	$cb->();
309	};
310	warn $@ if $@;
311	};
312		386
313	$coro->on_destroy (sub {	387	$coro->on_destroy (sub {
314	delete $EXT_CORO{$coro+0};	388	delete $EXT_CORO{$coro+0};
315	});	389	});
316	$EXT_CORO{$coro+0} = $coro;	390	$EXT_CORO{$coro+0} = $coro;
317		391
318	$coro	392	$coro
319	}	393	}
320		394
321	sub write_runtime {	395	sub write_runtime {
322	my $runtime = cf::localdir . "/runtime";	396	my $runtime = "$LOCALDIR/runtime";
		397
		398	# first touch the runtime file to show we are still running:
		399	# the fsync below can take a very very long time.
		400
		401	IO::AIO::aio_utime $runtime, undef, undef;
		402
		403	my $guard = cf::lock_acquire "write_runtime";
323		404
324	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	405	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
325	or return;	406	or return;
326		407
		408	my $value = $cf::RUNTIME + 90 + 10;
327	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	409	# 10 is the runtime save interval, for a monotonic clock
		410	# 60 allows for the watchdog to kill the server.
		411
328	(aio_write $fh, 0, (length $value), $value, 0) <= 0	412	(aio_write $fh, 0, (length $value), $value, 0) <= 0
329	and return;	413	and return;
330		414
		415	# always fsync - this file is important
331	aio_fsync $fh	416	aio_fsync $fh
332	and return;	417	and return;
333		418
		419	# touch it again to show we are up-to-date
		420	aio_utime $fh, undef, undef;
		421
334	close $fh	422	close $fh
335	or return;	423	or return;
336		424
337	aio_rename "$runtime~", $runtime	425	aio_rename "$runtime~", $runtime
338	and return;	426	and return;
339		427
		428	warn "runtime file written.\n";
		429
340	1	430	1
341	}	431	}
342		432
		433	=item cf::datalog type => key => value, ...
		434
		435	Log a datalog packet of the given type with the given key-value pairs.
		436
		437	=cut
		438
		439	sub datalog($@) {
		440	my ($type, %kv) = @_;
		441	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
		442	}
		443
343	=back	444	=back
344		445
345	=cut	446	=cut
346
347	#############################################################################
348
349	package cf::path;
350
351	sub new {
352	my ($class, $path, $base) = @_;
353
354	$path = $path->as_string if ref $path;
355
356	my $self = bless { }, $class;
357
358	# {... are special paths that are not touched
359	# ?xxx/... are special absolute paths
360	# ?random/... random maps
361	# /! non-realised random map exit
362	# /... normal maps
363	# ~/... per-player maps without a specific player (DO NOT USE)
364	# ~user/... per-player map of a specific user
365
366	if ($path =~ /^{/) {
367	# fine as it is
368	} elsif ($path =~ s{^\?random/}{}) {
369	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
370	$self->{random} = cf::from_json $data;
371	} else {
372	if ($path =~ s{^~([^/]+)?}{}) {
373	$self->{user_rel} = 1;
374
375	if (defined $1) {
376	$self->{user} = $1;
377	} elsif ($base =~ m{^~([^/]+)/}) {
378	$self->{user} = $1;
379	} else {
380	warn "cannot resolve user-relative path without user <$path,$base>\n";
381	}
382	} elsif ($path =~ /^\//) {
383	# already absolute
384	} else {
385	$base =~ s{[^/]+/?$}{};
386	return $class->new ("$base/$path");
387	}
388
389	for ($path) {
390	redo if s{/\.?/}{/};
391	redo if s{/[^/]+/\.\./}{/};
392	}
393	}
394
395	$self->{path} = $path;
396
397	$self
398	}
399
400	# the name / primary key / in-game path
401	sub as_string {
402	my ($self) = @_;
403
404	$self->{user_rel} ? "~$self->{user}$self->{path}"
405	: $self->{random} ? "?random/$self->{path}"
406	: $self->{path}
407	}
408
409	# the displayed name, this is a one way mapping
410	sub visible_name {
411	my ($self) = @_;
412
413	# if (my $rmp = $self->{random}) {
414	# # todo: be more intelligent about this
415	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
416	# } else {
417	$self->as_string
418	# }
419	}
420
421	# escape the /'s in the path
422	sub _escaped_path {
423	# ∕ is U+2215
424	(my $path = $_[0]{path}) =~ s/\//∕/g;
425	$path
426	}
427
428	# the original (read-only) location
429	sub load_path {
430	my ($self) = @_;
431
432	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
433	}
434
435	# the temporary/swap location
436	sub save_path {
437	my ($self) = @_;
438
439	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
440	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
441	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
442	}
443
444	# the unique path, might be eq to save_path
445	sub uniq_path {
446	my ($self) = @_;
447
448	$self->{user_rel} || $self->{random}
449	? undef
450	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
451	}
452
453	# return random map parameters, or undef
454	sub random_map_params {
455	my ($self) = @_;
456
457	$self->{random}
458	}
459
460	# this is somewhat ugly, but style maps do need special treatment
461	sub is_style_map {
462	$_[0]{path} =~ m{^/styles/}
463	}
464
465	package cf;
466		447
467	#############################################################################	448	#############################################################################
468		449
469	=head2 ATTACHABLE OBJECTS	450	=head2 ATTACHABLE OBJECTS
470		451
…		…
596	our @CB_TYPE = (); # registry for type (cf-object class) based events	577	our @CB_TYPE = (); # registry for type (cf-object class) based events
597	our @CB_MAP = ();	578	our @CB_MAP = ();
598		579
599	my %attachment;	580	my %attachment;
600		581
		582	sub cf::attachable::thawer_merge {
		583	# simply override everything except _meta
		584	local $_[0]{_meta};
		585	%{$_[0]} = %{$_[1]};
		586	}
		587
601	sub _attach_cb($$$$) {	588	sub _attach_cb($$$$) {
602	my ($registry, $event, $prio, $cb) = @_;	589	my ($registry, $event, $prio, $cb) = @_;
603		590
604	use sort 'stable';	591	use sort 'stable';
605		592
…		…
639	$registry = $CB_TYPE[$object_type] ||= [];	626	$registry = $CB_TYPE[$object_type] ||= [];
640		627
641	} elsif ($type eq "subtype") {	628	} elsif ($type eq "subtype") {
642	defined $object_type or Carp::croak "subtype specified without type";	629	defined $object_type or Carp::croak "subtype specified without type";
643	my $object_subtype = shift @arg;	630	my $object_subtype = shift @arg;
644	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	631	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
645		632
646	} elsif ($type eq "package") {	633	} elsif ($type eq "package") {
647	my $pkg = shift @arg;	634	my $pkg = shift @arg;
648		635
649	while (my ($name, $id) = each %cb_id) {	636	while (my ($name, $id) = each %cb_id) {
…		…
690	if (ref $_[0]) {	677	if (ref $_[0]) {
691	_object_attach @_;	678	_object_attach @_;
692	} else {	679	} else {
693	_attach shift->_attach_registry, @_;	680	_attach shift->_attach_registry, @_;
694	}	681	}
		682	_recalc_want;
695	};	683	};
696		684
697	# all those should be optimised	685	# all those should be optimised
698	sub cf::attachable::detach {	686	sub cf::attachable::detach {
699	my ($obj, $name) = @_;	687	my ($obj, $name) = @_;
…		…
702	delete $obj->{_attachment}{$name};	690	delete $obj->{_attachment}{$name};
703	reattach ($obj);	691	reattach ($obj);
704	} else {	692	} else {
705	Carp::croak "cannot, currently, detach class attachments";	693	Carp::croak "cannot, currently, detach class attachments";
706	}	694	}
		695	_recalc_want;
707	};	696	};
708		697
709	sub cf::attachable::attached {	698	sub cf::attachable::attached {
710	my ($obj, $name) = @_;	699	my ($obj, $name) = @_;
711		700
…		…
776	# object support	765	# object support
777		766
778	sub reattach {	767	sub reattach {
779	# basically do the same as instantiate, without calling instantiate	768	# basically do the same as instantiate, without calling instantiate
780	my ($obj) = @_;	769	my ($obj) = @_;
		770
		771	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
781		772
782	my $registry = $obj->registry;	773	my $registry = $obj->registry;
783		774
784	@$registry = ();	775	@$registry = ();
785		776
…		…
832	$filename, length $$rdata, scalar @$objs;	823	$filename, length $$rdata, scalar @$objs;
833		824
834	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	825	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
835	chmod SAVE_MODE, $fh;	826	chmod SAVE_MODE, $fh;
836	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	827	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
837	aio_fsync $fh;	828	aio_fsync $fh if $cf::USE_FSYNC;
838	close $fh;	829	close $fh;
839		830
840	if (@$objs) {	831	if (@$objs) {
841	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	832	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
842	chmod SAVE_MODE, $fh;	833	chmod SAVE_MODE, $fh;
843	my $data = Storable::nfreeze { version => 1, objs => $objs };	834	my $data = Storable::nfreeze { version => 1, objs => $objs };
844	aio_write $fh, 0, (length $data), $data, 0;	835	aio_write $fh, 0, (length $data), $data, 0;
845	aio_fsync $fh;	836	aio_fsync $fh if $cf::USE_FSYNC;
846	close $fh;	837	close $fh;
847	aio_rename "$filename.pst~", "$filename.pst";	838	aio_rename "$filename.pst~", "$filename.pst";
848	}	839	}
849	} else {	840	} else {
850	aio_unlink "$filename.pst";	841	aio_unlink "$filename.pst";
…		…
882	or return;	873	or return;
883	$av = eval { (Storable::thaw $av)->{objs} };	874	$av = eval { (Storable::thaw $av)->{objs} };
884	}	875	}
885		876
886	warn sprintf "loading %s (%d)\n",	877	warn sprintf "loading %s (%d)\n",
887	$filename, length $data, scalar @{$av || []};#d#	878	$filename, length $data, scalar @{$av || []};
888	return ($data, $av);	879	return ($data, $av);
889	}	880	}
890		881
891	#############################################################################	882	#############################################################################
892	# command handling &c	883	# command handling &c
…		…
917	=cut	908	=cut
918		909
919	sub register_extcmd {	910	sub register_extcmd {
920	my ($name, $cb) = @_;	911	my ($name, $cb) = @_;
921		912
922	my $caller = caller;
923	#warn "registering extcmd '$name' to '$caller'";
924
925	$EXTCMD{$name} = [$cb, $caller];	913	$EXTCMD{$name} = $cb;
926	}	914	}
927		915
928	cf::player->attach (	916	cf::player->attach (
929	on_command => sub {	917	on_command => sub {
930	my ($pl, $name, $params) = @_;	918	my ($pl, $name, $params) = @_;
…		…
943		931
944	my $msg = eval { from_json $buf };	932	my $msg = eval { from_json $buf };
945		933
946	if (ref $msg) {	934	if (ref $msg) {
947	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	935	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
948	if (my %reply = $cb->[0]->($pl, $msg)) {	936	if (my %reply = $cb->($pl, $msg)) {
949	$pl->ext_reply ($msg->{msgid}, %reply);	937	$pl->ext_reply ($msg->{msgid}, %reply);
950	}	938	}
951	}	939	}
952	} else {	940	} else {
953	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	941	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
…		…
955		943
956	cf::override;	944	cf::override;
957	},	945	},
958	);	946	);
959		947
960	sub register {
961	my ($base, $pkg) = @_;
962
963	#TODO
964	}
965
966	sub load_extension {	948	sub load_extension {
967	my ($path) = @_;	949	my ($path) = @_;
968		950
969	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	951	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
970	my $base = $1;	952	my $base = $1;
971	my $pkg = $1;	953	my $pkg = $1;
972	$pkg =~ s/[^[:word:]]/_/g;	954	$pkg =~ s/[^[:word:]]/_/g;
973	$pkg = "ext::$pkg";	955	$pkg = "ext::$pkg";
974		956
975	warn "loading '$path' into '$pkg'\n";	957	warn "... loading '$path' into '$pkg'\n";
976		958
977	open my $fh, "<:utf8", $path	959	open my $fh, "<:utf8", $path
978	or die "$path: $!";	960	or die "$path: $!";
979		961
980	my $source =	962	my $source =
981	"package $pkg; use strict; use utf8;\n"	963	"package $pkg; use strict; use utf8;\n"
982	. "#line 1 \"$path\"\n{\n"	964	. "#line 1 \"$path\"\n{\n"
983	. (do { local $/; <$fh> })	965	. (do { local $/; <$fh> })
984	. "\n};\n1";	966	. "\n};\n1";
985		967
986	eval $source	968	unless (eval $source) {
987	or die $@ ? "$path: $@\n"	969	my $msg = $@ ? "$path: $@\n"
988	: "extension disabled.\n";	970	: "extension disabled.\n";
989		971	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
990	push @exts, $pkg;	972	warn $@;
991	$ext_pkg{$base} = $pkg;	973	warn "mandatory extension failed to load, exiting.\n";
992		974	exit 1;
993	# no strict 'refs';	975	}
994	# @{"$pkg\::ISA"} = ext::;	976	die $@;
995
996	register $base, $pkg;
997	}
998
999	sub unload_extension {
1000	my ($pkg) = @_;
1001
1002	warn "removing extension $pkg\n";
1003
1004	# remove hooks
1005	#TODO
1006	# for my $idx (0 .. $#PLUGIN_EVENT) {
1007	# delete $hook[$idx]{$pkg};
1008	# }	977	}
1009		978
1010	# remove commands	979	push @EXTS, $pkg;
1011	for my $name (keys %COMMAND) {
1012	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1013
1014	if (@cb) {
1015	$COMMAND{$name} = \@cb;
1016	} else {
1017	delete $COMMAND{$name};
1018	}
1019	}
1020
1021	# remove extcmds
1022	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1023	delete $EXTCMD{$name};
1024	}
1025
1026	if (my $cb = $pkg->can ("unload")) {
1027	eval {
1028	$cb->($pkg);
1029	1
1030	} or warn "$pkg unloaded, but with errors: $@";
1031	}
1032
1033	Symbol::delete_package $pkg;
1034	}	980	}
1035		981
1036	sub load_extensions {	982	sub load_extensions {
1037	for my $ext (<$LIBDIR/*.ext>) {	983	for my $ext (<$LIBDIR/*.ext>) {
1038	next unless -r $ext;	984	next unless -r $ext;
…		…
1042	} or warn "$ext not loaded: $@";	988	} or warn "$ext not loaded: $@";
1043	}	989	}
1044	}	990	}
1045		991
1046	#############################################################################	992	#############################################################################
1047	# load/save/clean perl data associated with a map
1048
1049	*cf::mapsupport::on_clean = sub {
1050	my ($map) = @_;
1051
1052	my $path = $map->tmpname;
1053	defined $path or return;
1054
1055	unlink "$path.pst";
1056	};
1057
1058	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1059
1060	#############################################################################
1061	# load/save perl data associated with player->ob objects
1062
1063	sub all_objects(@) {
1064	@_, map all_objects ($_->inv), @_
1065	}
1066
1067	# TODO: compatibility cruft, remove when no longer needed
1068	cf::player->attach (
1069	on_load => sub {
1070	my ($pl, $path) = @_;
1071
1072	for my $o (all_objects $pl->ob) {
1073	if (my $value = $o->get_ob_key_value ("_perl_data")) {
1074	$o->set_ob_key_value ("_perl_data");
1075
1076	%$o = %{ Storable::thaw pack "H*", $value };
1077	}
1078	}
1079	},
1080	);
1081
1082	#############################################################################
1083		993
1084	=head2 CORE EXTENSIONS	994	=head2 CORE EXTENSIONS
1085		995
1086	Functions and methods that extend core crossfire objects.	996	Functions and methods that extend core crossfire objects.
1087		997
		998	=cut
		999
		1000	package cf::player;
		1001
		1002	use Coro::AIO;
		1003
1088	=head3 cf::player	1004	=head3 cf::player
1089		1005
1090	=over 4	1006	=over 4
1091		1007
1092	=item cf::player::exists $login	1008	=item cf::player::find $login
1093		1009
1094	Returns true when the given account exists.	1010	Returns the given player object, loading it if necessary (might block).
1095		1011
1096	=cut	1012	=cut
1097		1013
1098	sub cf::player::exists($) {	1014	sub playerdir($) {
1099	cf::player::find $_[0]	1015	"$PLAYERDIR/"
1100	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1016	. (ref $_[0] ? $_[0]->ob->name : $_[0])
1101	}	1017	}
1102		1018
		1019	sub path($) {
		1020	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		1021
		1022	(playerdir $login) . "/playerdata"
		1023	}
		1024
		1025	sub find_active($) {
		1026	$cf::PLAYER{$_[0]}
		1027	and $cf::PLAYER{$_[0]}->active
		1028	and $cf::PLAYER{$_[0]}
		1029	}
		1030
		1031	sub exists($) {
		1032	my ($login) = @_;
		1033
		1034	$cf::PLAYER{$login}
		1035	or cf::sync_job { !aio_stat path $login }
		1036	}
		1037
		1038	sub find($) {
		1039	return $cf::PLAYER{$_[0]} || do {
		1040	my $login = $_[0];
		1041
		1042	my $guard = cf::lock_acquire "user_find:$login";
		1043
		1044	$cf::PLAYER{$_[0]} || do {
		1045	# rename old playerfiles to new ones
		1046	#TODO: remove when no longer required
		1047	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1048	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1049	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1050	aio_unlink +(playerdir $login) . "/$login.pl";
		1051
		1052	my $pl = load_pl path $login
		1053	or return;
		1054	$cf::PLAYER{$login} = $pl
		1055	}
		1056	}
		1057	}
		1058
		1059	sub save($) {
		1060	my ($pl) = @_;
		1061
		1062	return if $pl->{deny_save};
		1063
		1064	my $path = path $pl;
		1065	my $guard = cf::lock_acquire "user_save:$path";
		1066
		1067	return if $pl->{deny_save};
		1068
		1069	aio_mkdir playerdir $pl, 0770;
		1070	$pl->{last_save} = $cf::RUNTIME;
		1071
		1072	$pl->save_pl ($path);
		1073	Coro::cede;
		1074	}
		1075
		1076	sub new($) {
		1077	my ($login) = @_;
		1078
		1079	my $self = create;
		1080
		1081	$self->ob->name ($login);
		1082	$self->{deny_save} = 1;
		1083
		1084	$cf::PLAYER{$login} = $self;
		1085
		1086	$self
		1087	}
		1088
		1089	=item $pl->quit_character
		1090
		1091	Nukes the player without looking back. If logged in, the connection will
		1092	be destroyed. May block for a long time.
		1093
		1094	=cut
		1095
		1096	sub quit_character {
		1097	my ($pl) = @_;
		1098
		1099	my $name = $pl->ob->name;
		1100
		1101	$pl->{deny_save} = 1;
		1102	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1103
		1104	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1105	$pl->deactivate;
		1106	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1107	$pl->ns->destroy if $pl->ns;
		1108
		1109	my $path = playerdir $pl;
		1110	my $temp = "$path~$cf::RUNTIME~deleting~";
		1111	aio_rename $path, $temp;
		1112	delete $cf::PLAYER{$pl->ob->name};
		1113	$pl->destroy;
		1114
		1115	my $prefix = qr<^~\Q$name\E/>;
		1116
		1117	# nuke player maps
		1118	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1119
		1120	IO::AIO::aio_rmtree $temp;
		1121	}
		1122
		1123	=item $pl->kick
		1124
		1125	Kicks a player out of the game. This destroys the connection.
		1126
		1127	=cut
		1128
		1129	sub kick {
		1130	my ($pl, $kicker) = @_;
		1131
		1132	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1133	$pl->killer ("kicked");
		1134	$pl->ns->destroy;
		1135	}
		1136
		1137	=item cf::player::list_logins
		1138
		1139	Returns am arrayref of all valid playernames in the system, can take a
		1140	while and may block, so not sync_job-capable, ever.
		1141
		1142	=cut
		1143
		1144	sub list_logins {
		1145	my $dirs = aio_readdir $PLAYERDIR
		1146	or return [];
		1147
		1148	my @logins;
		1149
		1150	for my $login (@$dirs) {
		1151	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1152	aio_read $fh, 0, 512, my $buf, 0 or next;
		1153	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1154
		1155	utf8::decode $login;
		1156	push @logins, $login;
		1157	}
		1158
		1159	\@logins
		1160	}
		1161
		1162	=item $player->maps
		1163
		1164	Returns an arrayref of map paths that are private for this
		1165	player. May block.
		1166
		1167	=cut
		1168
		1169	sub maps($) {
		1170	my ($pl) = @_;
		1171
		1172	$pl = ref $pl ? $pl->ob->name : $pl;
		1173
		1174	my $files = aio_readdir playerdir $pl
		1175	or return;
		1176
		1177	my @paths;
		1178
		1179	for (@$files) {
		1180	utf8::decode $_;
		1181	next if /\.(?:pl|pst)$/;
		1182	next unless /^$PATH_SEP/o;
		1183
		1184	push @paths, cf::map::normalise "~$pl/$_";
		1185	}
		1186
		1187	\@paths
		1188	}
		1189
1103	=item $player->ext_reply ($msgid, $msgtype, %msg)	1190	=item $player->ext_reply ($msgid, %msg)
1104		1191
1105	Sends an ext reply to the player.	1192	Sends an ext reply to the player.
1106		1193
1107	=cut	1194	=cut
1108		1195
1109	sub cf::player::ext_reply($$$%) {	1196	sub ext_reply($$%) {
1110	my ($self, $id, %msg) = @_;	1197	my ($self, $id, %msg) = @_;
1111		1198
1112	$msg{msgid} = $id;	1199	$msg{msgid} = $id;
1113		1200
1114	$self->send ("ext " . to_json \%msg);	1201	$self->send ("ext " . cf::to_json \%msg);
		1202	}
		1203
		1204	=item $player->ext_event ($type, %msg)
		1205
		1206	Sends an ext event to the client.
		1207
		1208	=cut
		1209
		1210	sub ext_event($$%) {
		1211	my ($self, $type, %msg) = @_;
		1212
		1213	$self->ns->ext_event ($type, %msg);
		1214	}
		1215
		1216	=head3 cf::region
		1217
		1218	=over 4
		1219
		1220	=cut
		1221
		1222	package cf::region;
		1223
		1224	=item cf::region::find_by_path $path
		1225
		1226	Tries to decuce the probable region for a map knowing only its path.
		1227
		1228	=cut
		1229
		1230	sub find_by_path($) {
		1231	my ($path) = @_;
		1232
		1233	my ($match, $specificity);
		1234
		1235	for my $region (list) {
		1236	if ($region->match && $path =~ $region->match) {
		1237	($match, $specificity) = ($region, $region->specificity)
		1238	if $region->specificity > $specificity;
		1239	}
		1240	}
		1241
		1242	$match
1115	}	1243	}
1116		1244
1117	=back	1245	=back
1118
1119		1246
1120	=head3 cf::map	1247	=head3 cf::map
1121		1248
1122	=over 4	1249	=over 4
1123		1250
…		…
1126	package cf::map;	1253	package cf::map;
1127		1254
1128	use Fcntl;	1255	use Fcntl;
1129	use Coro::AIO;	1256	use Coro::AIO;
1130		1257
		1258	use overload
		1259	'""' => \&as_string,
		1260	fallback => 1;
		1261
1131	our $MAX_RESET = 7200;	1262	our $MAX_RESET = 3600;
1132	our $DEFAULT_RESET = 3600;	1263	our $DEFAULT_RESET = 3000;
1133		1264
1134	sub generate_random_map {	1265	sub generate_random_map {
1135	my ($path, $rmp) = @_;	1266	my ($self, $rmp) = @_;
1136
1137	# mit "rum" bekleckern, nicht	1267	# mit "rum" bekleckern, nicht
1138	cf::map::_create_random_map	1268	$self->_create_random_map (
1139	$path,
1140	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1269	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1141	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1270	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1142	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1271	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1143	$rmp->{exit_on_final_map},	1272	$rmp->{exit_on_final_map},
1144	$rmp->{xsize}, $rmp->{ysize},	1273	$rmp->{xsize}, $rmp->{ysize},
1145	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1274	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1146	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1275	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1147	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1276	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1148	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},	1277	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1149	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1278	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1150	(cf::region::find $rmp->{region})	1279	(cf::region::find $rmp->{region}), $rmp->{custom}
		1280	)
		1281	}
		1282
		1283	=item cf::map->register ($regex, $prio)
		1284
		1285	Register a handler for the map path matching the given regex at the
		1286	givne priority (higher is better, built-in handlers have priority 0, the
		1287	default).
		1288
		1289	=cut
		1290
		1291	sub register {
		1292	my (undef, $regex, $prio) = @_;
		1293	my $pkg = caller;
		1294
		1295	no strict;
		1296	push @{"$pkg\::ISA"}, __PACKAGE__;
		1297
		1298	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1299	}
		1300
		1301	# also paths starting with '/'
		1302	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1303
		1304	sub thawer_merge {
		1305	my ($self, $merge) = @_;
		1306
		1307	# we have to keep some variables in memory intact
		1308	local $self->{path};
		1309	local $self->{load_path};
		1310
		1311	$self->SUPER::thawer_merge ($merge);
		1312	}
		1313
		1314	sub normalise {
		1315	my ($path, $base) = @_;
		1316
		1317	$path = "$path"; # make sure its a string
		1318
		1319	$path =~ s/\.map$//;
		1320
		1321	# map plan:
		1322	#
		1323	# /! non-realised random map exit (special hack!)
		1324	# {... are special paths that are not being touched
		1325	# ?xxx/... are special absolute paths
		1326	# ?random/... random maps
		1327	# /... normal maps
		1328	# ~user/... per-player map of a specific user
		1329
		1330	$path =~ s/$PATH_SEP/\//go;
		1331
		1332	# treat it as relative path if it starts with
		1333	# something that looks reasonable
		1334	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1335	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1336
		1337	$base =~ s{[^/]+/?$}{};
		1338	$path = "$base/$path";
		1339	}
		1340
		1341	for ($path) {
		1342	redo if s{//}{/};
		1343	redo if s{/\.?/}{/};
		1344	redo if s{/[^/]+/\.\./}{/};
		1345	}
		1346
		1347	$path
		1348	}
		1349
		1350	sub new_from_path {
		1351	my (undef, $path, $base) = @_;
		1352
		1353	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1354
		1355	$path = normalise $path, $base;
		1356
		1357	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1358	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1359	my $self = bless cf::map::new, $pkg;
		1360	$self->{path} = $path; $self->path ($path);
		1361	$self->init; # pass $1 etc.
		1362	return $self;
		1363	}
		1364	}
		1365
		1366	Carp::carp "unable to resolve path '$path' (base '$base').";
		1367	()
		1368	}
		1369
		1370	sub init {
		1371	my ($self) = @_;
		1372
		1373	$self
		1374	}
		1375
		1376	sub as_string {
		1377	my ($self) = @_;
		1378
		1379	"$self->{path}"
		1380	}
		1381
		1382	# the displayed name, this is a one way mapping
		1383	sub visible_name {
		1384	&as_string
		1385	}
		1386
		1387	# the original (read-only) location
		1388	sub load_path {
		1389	my ($self) = @_;
		1390
		1391	"$MAPDIR/$self->{path}.map"
		1392	}
		1393
		1394	# the temporary/swap location
		1395	sub save_path {
		1396	my ($self) = @_;
		1397
		1398	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1399	"$TMPDIR/$path.map"
		1400	}
		1401
		1402	# the unique path, undef == no special unique path
		1403	sub uniq_path {
		1404	my ($self) = @_;
		1405
		1406	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1407	"$UNIQUEDIR/$path"
1151	}	1408	}
1152		1409
1153	# and all this just because we cannot iterate over	1410	# and all this just because we cannot iterate over
1154	# all maps in C++...	1411	# all maps in C++...
1155	sub change_all_map_light {	1412	sub change_all_map_light {
…		…
1157		1414
1158	$_->change_map_light ($change)	1415	$_->change_map_light ($change)
1159	for grep $_->outdoor, values %cf::MAP;	1416	for grep $_->outdoor, values %cf::MAP;
1160	}	1417	}
1161		1418
		1419	sub decay_objects {
		1420	my ($self) = @_;
		1421
		1422	return if $self->{deny_reset};
		1423
		1424	$self->do_decay_objects;
		1425	}
		1426
		1427	sub unlink_save {
		1428	my ($self) = @_;
		1429
		1430	utf8::encode (my $save = $self->save_path);
		1431	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1432	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1433	}
		1434
1162	sub try_load_header($) {	1435	sub load_header_from($) {
1163	my ($path) = @_;	1436	my ($self, $path) = @_;
1164		1437
1165	utf8::encode $path;	1438	utf8::encode $path;
1166	aio_open $path, O_RDONLY, 0	1439	#aio_open $path, O_RDONLY, 0
		1440	# or return;
		1441
		1442	$self->_load_header ($path)
1167	or return;	1443	or return;
1168		1444
1169	my $map = cf::map::new	1445	$self->{load_path} = $path;
		1446
		1447	1
		1448	}
		1449
		1450	sub load_header_orig {
		1451	my ($self) = @_;
		1452
		1453	$self->load_header_from ($self->load_path)
		1454	}
		1455
		1456	sub load_header_temp {
		1457	my ($self) = @_;
		1458
		1459	$self->load_header_from ($self->save_path)
		1460	}
		1461
		1462	sub prepare_temp {
		1463	my ($self) = @_;
		1464
		1465	$self->last_access ((delete $self->{last_access})
		1466	|| $cf::RUNTIME); #d#
		1467	# safety
		1468	$self->{instantiate_time} = $cf::RUNTIME
		1469	if $self->{instantiate_time} > $cf::RUNTIME;
		1470	}
		1471
		1472	sub prepare_orig {
		1473	my ($self) = @_;
		1474
		1475	$self->{load_original} = 1;
		1476	$self->{instantiate_time} = $cf::RUNTIME;
		1477	$self->last_access ($cf::RUNTIME);
		1478	$self->instantiate;
		1479	}
		1480
		1481	sub load_header {
		1482	my ($self) = @_;
		1483
		1484	if ($self->load_header_temp) {
		1485	$self->prepare_temp;
		1486	} else {
		1487	$self->load_header_orig
1170	or return;	1488	or return;
		1489	$self->prepare_orig;
		1490	}
1171		1491
1172	$map->load_header ($path)	1492	$self->{deny_reset} = 1
1173	or return;	1493	if $self->no_reset;
1174		1494
1175	$map->{load_path} = $path;	1495	$self->default_region (cf::region::find_by_path $self->{path})
		1496	unless $self->default_region;
1176		1497
1177	$map	1498	1
1178	}	1499	}
1179		1500
		1501	sub find;
1180	sub find_map {	1502	sub find {
1181	my ($path, $origin) = @_;	1503	my ($path, $origin) = @_;
1182		1504
1183	#warn "find_map<$path,$origin>\n";#d#
1184
1185	$path = new cf::path $path, $origin && $origin->path;	1505	$path = normalise $path, $origin && $origin->path;
1186	my $key = $path->as_string;
1187		1506
1188	cf::lock_wait "map_find:$key";	1507	cf::lock_wait "map_find:$path";
1189		1508
1190	$cf::MAP{$key} || do {	1509	$cf::MAP{$path} || do {
1191	my $guard = cf::lock_acquire "map_find:$key";	1510	my $guard = cf::lock_acquire "map_find:$path";
1192		1511	my $map = new_from_path cf::map $path
1193	# do it the slow way
1194	my $map = try_load_header $path->save_path;
1195
1196	if ($map) {
1197	# safety
1198	$map->{instantiate_time} = $cf::RUNTIME
1199	if $map->{instantiate_time} > $cf::RUNTIME;
1200	} else {
1201	if (my $rmp = $path->random_map_params) {
1202	$map = generate_random_map $key, $rmp;
1203	} else {
1204	$map = try_load_header $path->load_path;
1205	}
1206
1207	$map or return;	1512	or return;
1208		1513
1209	$map->{load_original} = 1;
1210	$map->{instantiate_time} = $cf::RUNTIME;
1211	$map->instantiate;
1212
1213	# per-player maps become, after loading, normal maps
1214	$map->per_player (0) if $path->{user_rel};
1215	}
1216
1217	$map->path ($key);
1218	$map->{path} = $path;
1219	$map->{last_save} = $cf::RUNTIME;	1514	$map->{last_save} = $cf::RUNTIME;
1220	$map->last_access ($cf::RUNTIME);
1221		1515
1222	if ($map->should_reset) {	1516	$map->load_header
		1517	or return;
		1518
		1519	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1520	# doing this can freeze the server in a sync job, obviously
		1521	#$cf::WAIT_FOR_TICK->wait;
1223	$map->reset;	1522	$map->reset;
1224	undef $guard;	1523	undef $guard;
1225	$map = find_map $path;	1524	return find $path;
1226	}	1525	}
1227		1526
1228	$cf::MAP{$key} = $map	1527	$cf::MAP{$path} = $map
1229	}	1528	}
1230	}	1529	}
		1530
		1531	sub pre_load { }
		1532	sub post_load { }
1231		1533
1232	sub load {	1534	sub load {
1233	my ($self) = @_;	1535	my ($self) = @_;
1234		1536
		1537	local $self->{deny_reset} = 1; # loading can take a long time
		1538
1235	my $path = $self->{path};	1539	my $path = $self->{path};
		1540
		1541	{
1236	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	1542	my $guard = cf::lock_acquire "map_load:$path";
1237		1543
1238	return if $self->in_memory != cf::MAP_SWAPPED;	1544	return if $self->in_memory != cf::MAP_SWAPPED;
1239		1545
1240	$self->in_memory (cf::MAP_LOADING);	1546	$self->in_memory (cf::MAP_LOADING);
1241		1547
1242	$self->alloc;	1548	$self->alloc;
		1549
		1550	$self->pre_load;
		1551	Coro::cede;
		1552
1243	$self->load_objects ($self->{load_path}, 1)	1553	$self->_load_objects ($self->{load_path}, 1)
1244	or return;	1554	or return;
1245		1555
1246	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1556	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1247	if delete $self->{load_original};	1557	if delete $self->{load_original};
1248		1558
1249	if (my $uniq = $path->uniq_path) {	1559	if (my $uniq = $self->uniq_path) {
1250	utf8::encode $uniq;	1560	utf8::encode $uniq;
1251	if (aio_open $uniq, O_RDONLY, 0) {	1561	if (aio_open $uniq, O_RDONLY, 0) {
1252	$self->clear_unique_items;	1562	$self->clear_unique_items;
1253	$self->load_objects ($uniq, 0);	1563	$self->_load_objects ($uniq, 0);
1254	}	1564	}
1255	}	1565	}
1256		1566
		1567	Coro::cede;
1257	# now do the right thing for maps	1568	# now do the right thing for maps
1258	$self->link_multipart_objects;	1569	$self->link_multipart_objects;
1259
1260	if ($self->{path}->is_style_map) {
1261	$self->{deny_save} = 1;
1262	$self->{deny_reset} = 1;
1263	} else {
1264	$self->fix_auto_apply;
1265	$self->decay_objects;
1266	$self->update_buttons;
1267	$self->set_darkness_map;
1268	$self->difficulty ($self->estimate_difficulty)	1570	$self->difficulty ($self->estimate_difficulty)
1269	unless $self->difficulty;	1571	unless $self->difficulty;
		1572	Coro::cede;
		1573
		1574	unless ($self->{deny_activate}) {
		1575	$self->decay_objects;
		1576	$self->fix_auto_apply;
		1577	$self->update_buttons;
		1578	Coro::cede;
		1579	$self->set_darkness_map;
		1580	Coro::cede;
1270	$self->activate;	1581	$self->activate;
1271	}	1582	}
1272		1583
1273	$self->in_memory (cf::MAP_IN_MEMORY);	1584	$self->in_memory (cf::MAP_IN_MEMORY);
1274	}	1585	}
1275		1586
1276	sub load_map_sync {	1587	$self->post_load;
		1588	}
		1589
		1590	sub customise_for {
		1591	my ($self, $ob) = @_;
		1592
		1593	return find "~" . $ob->name . "/" . $self->{path}
		1594	if $self->per_player;
		1595
		1596	# return find "?party/" . $ob->name . "/" . $self->{path}
		1597	# if $self->per_party;
		1598
		1599	$self
		1600	}
		1601
		1602	# find and load all maps in the 3x3 area around a map
		1603	sub load_diag {
		1604	my ($map) = @_;
		1605
		1606	my @diag; # diagonal neighbours
		1607
		1608	for (0 .. 3) {
		1609	my $neigh = $map->tile_path ($_)
		1610	or next;
		1611	$neigh = find $neigh, $map
		1612	or next;
		1613	$neigh->load;
		1614
		1615	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1616	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1617	}
		1618
		1619	for (@diag) {
		1620	my $neigh = find @$_
		1621	or next;
		1622	$neigh->load;
		1623	}
		1624	}
		1625
		1626	sub find_sync {
1277	my ($path, $origin) = @_;	1627	my ($path, $origin) = @_;
1278		1628
1279	#warn "load_map_sync<$path, $origin>\n";#d#	1629	cf::sync_job { find $path, $origin }
		1630	}
1280		1631
1281	cf::sync_job {	1632	sub do_load_sync {
1282	my $map = cf::map::find_map $path, $origin	1633	my ($map) = @_;
1283	or return;	1634
		1635	cf::sync_job { $map->load };
		1636	}
		1637
		1638	our %MAP_PREFETCH;
		1639	our $MAP_PREFETCHER = undef;
		1640
		1641	sub find_async {
		1642	my ($path, $origin) = @_;
		1643
		1644	$path = normalise $path, $origin && $origin->{path};
		1645
		1646	if (my $map = $cf::MAP{$path}) {
		1647	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1648	}
		1649
		1650	undef $MAP_PREFETCH{$path};
		1651	$MAP_PREFETCHER ||= cf::async {
		1652	while (%MAP_PREFETCH) {
		1653	for my $path (keys %MAP_PREFETCH) {
		1654	my $map = find $path
		1655	or next;
1284	$map->load;	1656	$map->load;
1285	$map	1657
		1658	delete $MAP_PREFETCH{$path};
		1659	}
		1660	}
		1661	undef $MAP_PREFETCHER;
1286	}	1662	};
		1663	$MAP_PREFETCHER->prio (6);
		1664
		1665	()
1287	}	1666	}
1288		1667
1289	sub save {	1668	sub save {
1290	my ($self) = @_;	1669	my ($self) = @_;
1291		1670
		1671	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1672
1292	$self->{last_save} = $cf::RUNTIME;	1673	$self->{last_save} = $cf::RUNTIME;
1293		1674
1294	return unless $self->dirty;	1675	return unless $self->dirty;
1295		1676
1296	my $save = $self->{path}->save_path; utf8::encode $save;	1677	my $save = $self->save_path; utf8::encode $save;
1297	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	1678	my $uniq = $self->uniq_path; utf8::encode $uniq;
1298		1679
1299	$self->{load_path} = $save;	1680	$self->{load_path} = $save;
1300		1681
1301	return if $self->{deny_save};	1682	return if $self->{deny_save};
1302		1683
		1684	local $self->{last_access} = $self->last_access;#d#
		1685
		1686	cf::async {
		1687	$_->contr->save for $self->players;
		1688	};
		1689
1303	if ($uniq) {	1690	if ($uniq) {
1304	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	1691	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1305	$self->save_objects ($uniq, cf::IO_UNIQUES);	1692	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1306	} else {	1693	} else {
1307	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);	1694	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1308	}	1695	}
1309	}	1696	}
1310		1697
1311	sub swap_out {	1698	sub swap_out {
1312	my ($self) = @_;	1699	my ($self) = @_;
		1700
		1701	# save first because save cedes
		1702	$self->save;
		1703
		1704	my $lock = cf::lock_acquire "map_data:" . $self->path;
1313		1705
1314	return if $self->players;	1706	return if $self->players;
1315	return if $self->in_memory != cf::MAP_IN_MEMORY;	1707	return if $self->in_memory != cf::MAP_IN_MEMORY;
1316	return if $self->{deny_save};	1708	return if $self->{deny_save};
1317		1709
1318	$self->save;
1319	$self->clear;	1710	$self->clear;
1320	$self->in_memory (cf::MAP_SWAPPED);	1711	$self->in_memory (cf::MAP_SWAPPED);
1321	}	1712	}
1322		1713
1323	sub reset_at {	1714	sub reset_at {
1324	my ($self) = @_;	1715	my ($self) = @_;
1325		1716
1326	# TODO: safety, remove and allow resettable per-player maps	1717	# TODO: safety, remove and allow resettable per-player maps
1327	return 1e99 if $self->{path}{user_rel};
1328	return 1e99 if $self->{deny_reset};	1718	return 1e99 if $self->{deny_reset};
1329		1719
1330	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1720	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1331	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1721	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1332		1722
…		…
1337	my ($self) = @_;	1727	my ($self) = @_;
1338		1728
1339	$self->reset_at <= $cf::RUNTIME	1729	$self->reset_at <= $cf::RUNTIME
1340	}	1730	}
1341		1731
1342	sub unlink_save {
1343	my ($self) = @_;
1344
1345	utf8::encode (my $save = $self->{path}->save_path);
1346	aioreq_pri 3; IO::AIO::aio_unlink $save;
1347	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1348	}
1349
1350	sub rename {
1351	my ($self, $new_path) = @_;
1352
1353	$self->unlink_save;
1354
1355	delete $cf::MAP{$self->path};
1356	$self->{path} = new cf::path $new_path;
1357	$self->path ($self->{path}->as_string);
1358	$cf::MAP{$self->path} = $self;
1359
1360	$self->save;
1361	}
1362
1363	sub reset {	1732	sub reset {
1364	my ($self) = @_;	1733	my ($self) = @_;
1365		1734
		1735	my $lock = cf::lock_acquire "map_data:$self->{path}";
		1736
1366	return if $self->players;	1737	return if $self->players;
1367	return if $self->{path}{user_rel};#d#
1368		1738
1369	warn "resetting map ", $self->path;#d#	1739	warn "resetting map ", $self->path;
		1740
		1741	$self->in_memory (cf::MAP_SWAPPED);
		1742
		1743	# need to save uniques path
		1744	unless ($self->{deny_save}) {
		1745	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1746
		1747	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1748	if $uniq;
		1749	}
1370		1750
1371	delete $cf::MAP{$self->path};	1751	delete $cf::MAP{$self->path};
		1752
		1753	$self->clear;
1372		1754
1373	$_->clear_links_to ($self) for values %cf::MAP;	1755	$_->clear_links_to ($self) for values %cf::MAP;
1374		1756
1375	$self->unlink_save;	1757	$self->unlink_save;
1376	$self->destroy;	1758	$self->destroy;
…		…
1379	my $nuke_counter = "aaaa";	1761	my $nuke_counter = "aaaa";
1380		1762
1381	sub nuke {	1763	sub nuke {
1382	my ($self) = @_;	1764	my ($self) = @_;
1383		1765
		1766	delete $cf::MAP{$self->path};
		1767
		1768	$self->unlink_save;
		1769
		1770	bless $self, "cf::map";
		1771	delete $self->{deny_reset};
1384	$self->{deny_save} = 1;	1772	$self->{deny_save} = 1;
1385	$self->reset_timeout (1);	1773	$self->reset_timeout (1);
1386	$self->rename ("{nuke}/" . ($nuke_counter++));	1774	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		1775
		1776	$cf::MAP{$self->path} = $self;
		1777
1387	$self->reset; # polite request, might not happen	1778	$self->reset; # polite request, might not happen
1388	}	1779	}
1389		1780
1390	sub customise_for {	1781	=item cf::map::unique_maps
1391	my ($map, $ob) = @_;
1392		1782
1393	if ($map->per_player) {	1783	Returns an arrayref of paths of all shared maps that have
1394	return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path};	1784	instantiated unique items. May block.
1395	}
1396		1785
1397	$map	1786	=cut
1398	}
1399		1787
1400	sub emergency_save {	1788	sub unique_maps() {
1401	local $cf::FREEZE = 1;	1789	my $files = aio_readdir $UNIQUEDIR
		1790	or return;
1402		1791
1403	warn "enter emergency map save\n";	1792	my @paths;
1404		1793
1405	cf::sync_job {	1794	for (@$files) {
1406	warn "begin emergency map save\n";	1795	utf8::decode $_;
1407	$_->save for values %cf::MAP;	1796	next if /\.pst$/;
		1797	next unless /^$PATH_SEP/o;
		1798
		1799	push @paths, cf::map::normalise $_;
1408	};	1800	}
1409		1801
1410	warn "end emergency map save\n";	1802	\@paths
1411	}	1803	}
1412		1804
1413	package cf;	1805	package cf;
1414		1806
1415	=back	1807	=back
1416		1808
		1809	=head3 cf::object
		1810
		1811	=cut
		1812
		1813	package cf::object;
		1814
		1815	=over 4
		1816
		1817	=item $ob->inv_recursive
		1818
		1819	Returns the inventory of the object _and_ their inventories, recursively.
		1820
		1821	=cut
		1822
		1823	sub inv_recursive_;
		1824	sub inv_recursive_ {
		1825	map { $_, inv_recursive_ $_->inv } @_
		1826	}
		1827
		1828	sub inv_recursive {
		1829	inv_recursive_ inv $_[0]
		1830	}
		1831
		1832	package cf;
		1833
		1834	=back
1417		1835
1418	=head3 cf::object::player	1836	=head3 cf::object::player
1419		1837
1420	=over 4	1838	=over 4
1421		1839
…		…
1461		1879
1462	=item $player_object->enter_link	1880	=item $player_object->enter_link
1463		1881
1464	Freezes the player and moves him/her to a special map (C<{link}>).	1882	Freezes the player and moves him/her to a special map (C<{link}>).
1465		1883
1466	The player should be reaosnably safe there for short amounts of time. You	1884	The player should be reasonably safe there for short amounts of time. You
1467	I<MUST> call C<leave_link> as soon as possible, though.	1885	I<MUST> call C<leave_link> as soon as possible, though.
1468		1886
		1887	Will never block.
		1888
1469	=item $player_object->leave_link ($map, $x, $y)	1889	=item $player_object->leave_link ($map, $x, $y)
1470		1890
1471	Moves the player out of the specila link map onto the given map. If the	1891	Moves the player out of the special C<{link}> map onto the specified
1472	map is not valid (or omitted), the player will be moved back to the	1892	map. If the map is not valid (or omitted), the player will be moved back
1473	location he/she was before the call to C<enter_link>, or, if that fails,	1893	to the location he/she was before the call to C<enter_link>, or, if that
1474	to the emergency map position.	1894	fails, to the emergency map position.
1475		1895
1476	Might block.	1896	Might block.
1477		1897
1478	=cut	1898	=cut
		1899
		1900	sub link_map {
		1901	unless ($LINK_MAP) {
		1902	$LINK_MAP = cf::map::find "{link}"
		1903	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		1904	$LINK_MAP->load;
		1905	}
		1906
		1907	$LINK_MAP
		1908	}
1479		1909
1480	sub cf::object::player::enter_link {	1910	sub cf::object::player::enter_link {
1481	my ($self) = @_;	1911	my ($self) = @_;
1482		1912
1483	$self->deactivate_recursive;	1913	$self->deactivate_recursive;
1484		1914
1485	return if $self->map == $LINK_MAP;	1915	return if UNIVERSAL::isa $self->map, "ext::map_link";
1486		1916
1487	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	1917	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1488	if $self->map;	1918	if $self->map && $self->map->{path} ne "{link}";
1489		1919
1490	$self->enter_map ($LINK_MAP, 20, 20);	1920	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1491	}	1921	}
1492		1922
1493	sub cf::object::player::leave_link {	1923	sub cf::object::player::leave_link {
1494	my ($self, $map, $x, $y) = @_;	1924	my ($self, $map, $x, $y) = @_;
		1925
		1926	return unless $self->contr->active;
1495		1927
1496	my $link_pos = delete $self->{_link_pos};	1928	my $link_pos = delete $self->{_link_pos};
1497		1929
1498	unless ($map) {	1930	unless ($map) {
1499	# restore original map position	1931	# restore original map position
1500	($map, $x, $y) = @{ $link_pos || [] };	1932	($map, $x, $y) = @{ $link_pos || [] };
1501	$map = cf::map::find_map $map;	1933	$map = cf::map::find $map;
1502		1934
1503	unless ($map) {	1935	unless ($map) {
1504	($map, $x, $y) = @$EMERGENCY_POSITION;	1936	($map, $x, $y) = @$EMERGENCY_POSITION;
1505	$map = cf::map::find_map $map	1937	$map = cf::map::find $map
1506	or die "FATAL: cannot load emergency map\n";	1938	or die "FATAL: cannot load emergency map\n";
1507	}	1939	}
1508	}	1940	}
1509		1941
1510	($x, $y) = (-1, -1)	1942	($x, $y) = (-1, -1)
…		…
1513	# use -1 or undef as default coordinates, not 0, 0	1945	# use -1 or undef as default coordinates, not 0, 0
1514	($x, $y) = ($map->enter_x, $map->enter_y)	1946	($x, $y) = ($map->enter_x, $map->enter_y)
1515	if $x <=0 && $y <= 0;	1947	if $x <=0 && $y <= 0;
1516		1948
1517	$map->load;	1949	$map->load;
		1950	$map->load_diag;
1518		1951
		1952	return unless $self->contr->active;
1519	$self->activate_recursive;	1953	$self->activate_recursive;
		1954
		1955	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1520	$self->enter_map ($map, $x, $y);	1956	$self->enter_map ($map, $x, $y);
1521	}	1957	}
1522		1958
1523	cf::player->attach (
1524	on_logout => sub {
1525	my ($pl) = @_;
1526
1527	# abort map switching before logout
1528	if ($pl->ob->{_link_pos}) {
1529	cf::sync_job {
1530	$pl->ob->leave_link
1531	};
1532	}
1533	},
1534	on_login => sub {
1535	my ($pl) = @_;
1536
1537	# try to abort aborted map switching on player login :)
1538	# should happen only on crashes
1539	if ($pl->ob->{_link_pos}) {
1540	$pl->ob->enter_link;
1541	Coro::async {
1542	# we need this sleep as the login has a concurrent enter_exit running
1543	# and this sleep increases chances of the player not ending up in scorn
1544	Coro::Timer::sleep 1;
1545	$pl->ob->leave_link;
1546	};
1547	}
1548	},
1549	);
1550
1551	=item $player_object->goto_map ($path, $x, $y)	1959	=item $player_object->goto ($path, $x, $y[, $check->($map)])
1552		1960
1553	=cut	1961	Moves the player to the given map-path and coordinates by first freezing
		1962	her, loading and preparing them map, calling the provided $check callback
		1963	that has to return the map if sucecssful, and then unfreezes the player on
		1964	the new (success) or old (failed) map position.
1554		1965
		1966	=cut
		1967
		1968	our $GOTOGEN;
		1969
1555	sub cf::object::player::goto_map {	1970	sub cf::object::player::goto {
1556	my ($self, $path, $x, $y) = @_;	1971	my ($self, $path, $x, $y, $check) = @_;
		1972
		1973	# do generation counting so two concurrent goto's will be executed in-order
		1974	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1557		1975
1558	$self->enter_link;	1976	$self->enter_link;
1559		1977
1560	(Coro::async {	1978	(async {
1561	$path = new cf::path $path;	1979	my $map = eval {
1562
1563	my $map = cf::map::find_map $path->as_string;	1980	my $map = cf::map::find $path;
		1981
		1982	if ($map) {
1564	$map = $map->customise_for ($self) if $map;	1983	$map = $map->customise_for ($self);
1565		1984	$map = $check->($map) if $check && $map;
1566	# warn "entering ", $map->path, " at ($x, $y)\n"	1985	} else {
1567	# if $map;
1568
1569	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);	1986	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1987	}
1570		1988
		1989	$map
		1990	};
		1991
		1992	if ($@) {
		1993	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		1994	LOG llevError | logBacktrace, Carp::longmess $@;
		1995	}
		1996
		1997	if ($gen == $self->{_goto_generation}) {
		1998	delete $self->{_goto_generation};
1571	$self->leave_link ($map, $x, $y);	1999	$self->leave_link ($map, $x, $y);
		2000	}
1572	})->prio (1);	2001	})->prio (1);
1573	}	2002	}
1574		2003
1575	=item $player_object->enter_exit ($exit_object)	2004	=item $player_object->enter_exit ($exit_object)
1576		2005
…		…
1578		2007
1579	sub parse_random_map_params {	2008	sub parse_random_map_params {
1580	my ($spec) = @_;	2009	my ($spec) = @_;
1581		2010
1582	my $rmp = { # defaults	2011	my $rmp = { # defaults
1583	xsize => 10,	2012	xsize => (cf::rndm 15, 40),
1584	ysize => 10,	2013	ysize => (cf::rndm 15, 40),
		2014	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2015	#layout => string,
1585	};	2016	};
1586		2017
1587	for (split /\n/, $spec) {	2018	for (split /\n/, $spec) {
1588	my ($k, $v) = split /\s+/, $_, 2;	2019	my ($k, $v) = split /\s+/, $_, 2;
1589		2020
…		…
1593	$rmp	2024	$rmp
1594	}	2025	}
1595		2026
1596	sub prepare_random_map {	2027	sub prepare_random_map {
1597	my ($exit) = @_;	2028	my ($exit) = @_;
		2029
		2030	my $guard = cf::lock_acquire "exit_prepare:$exit";
1598		2031
1599	# all this does is basically replace the /! path by	2032	# all this does is basically replace the /! path by
1600	# a new random map path (?random/...) with a seed	2033	# a new random map path (?random/...) with a seed
1601	# that depends on the exit object	2034	# that depends on the exit object
1602		2035
1603	my $rmp = parse_random_map_params $exit->msg;	2036	my $rmp = parse_random_map_params $exit->msg;
1604		2037
1605	if ($exit->map) {	2038	if ($exit->map) {
1606	$rmp->{region} = $exit->map->region_name;	2039	$rmp->{region} = $exit->region->name;
1607	$rmp->{origin_map} = $exit->map->path;	2040	$rmp->{origin_map} = $exit->map->path;
1608	$rmp->{origin_x} = $exit->x;	2041	$rmp->{origin_x} = $exit->x;
1609	$rmp->{origin_y} = $exit->y;	2042	$rmp->{origin_y} = $exit->y;
1610	}	2043	}
1611		2044
1612	$rmp->{random_seed} ||= $exit->random_seed;	2045	$rmp->{random_seed} ||= $exit->random_seed;
1613		2046
1614	my $data = cf::to_json $rmp;	2047	my $data = cf::to_json $rmp;
1615	my $md5 = Digest::MD5::md5_hex $data;	2048	my $md5 = Digest::MD5::md5_hex $data;
		2049	my $meta = "$RANDOMDIR/$md5.meta";
1616		2050
1617	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2051	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1618	aio_write $fh, 0, (length $data), $data, 0;	2052	aio_write $fh, 0, (length $data), $data, 0;
		2053	undef $fh;
		2054	aio_rename "$meta~", $meta;
1619		2055
1620	$exit->slaying ("?random/$md5");	2056	$exit->slaying ("?random/$md5");
1621	$exit->msg (undef);	2057	$exit->msg (undef);
1622	}	2058	}
1623	}	2059	}
…		…
1625	sub cf::object::player::enter_exit {	2061	sub cf::object::player::enter_exit {
1626	my ($self, $exit) = @_;	2062	my ($self, $exit) = @_;
1627		2063
1628	return unless $self->type == cf::PLAYER;	2064	return unless $self->type == cf::PLAYER;
1629		2065
		2066	if ($exit->slaying eq "/!") {
		2067	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2068	# the problem is that $exit might not survive long enough
		2069	# so it needs to be done right now, right here
		2070	cf::sync_job { prepare_random_map $exit };
		2071	}
		2072
		2073	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2074	my $hp = $exit->stats->hp;
		2075	my $sp = $exit->stats->sp;
		2076
1630	$self->enter_link;	2077	$self->enter_link;
1631		2078
1632	(Coro::async {	2079	(async {
		2080	$self->deactivate_recursive; # just to be sure
1633	unless (eval {	2081	unless (eval {
1634		2082	$self->goto ($slaying, $hp, $sp);
1635	prepare_random_map $exit
1636	if $exit->slaying eq "/!";
1637
1638	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1639	$self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1640		2083
1641	1;	2084	1;
1642	}) {	2085	}) {
1643	$self->message ("Something went wrong deep within the crossfire server. "	2086	$self->message ("Something went wrong deep within the crossfire server. "
1644	. "I'll try to bring you back to the map you were before. "	2087	. "I'll try to bring you back to the map you were before. "
1645	. "Please report this to the dungeon master",	2088	. "Please report this to the dungeon master!",
1646	cf::NDI_UNIQUE | cf::NDI_RED);	2089	cf::NDI_UNIQUE | cf::NDI_RED);
1647		2090
1648	warn "ERROR in enter_exit: $@";	2091	warn "ERROR in enter_exit: $@";
1649	$self->leave_link;	2092	$self->leave_link;
1650	}	2093	}
1651	})->prio (1);	2094	})->prio (1);
…		…
1664		2107
1665	sub cf::client::send_drawinfo {	2108	sub cf::client::send_drawinfo {
1666	my ($self, $text, $flags) = @_;	2109	my ($self, $text, $flags) = @_;
1667		2110
1668	utf8::encode $text;	2111	utf8::encode $text;
1669	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2112	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1670	}	2113	}
1671		2114
		2115	=item $client->ext_event ($type, %msg)
		2116
		2117	Sends an exti event to the client.
		2118
		2119	=cut
		2120
		2121	sub cf::client::ext_event($$%) {
		2122	my ($self, $type, %msg) = @_;
		2123
		2124	$msg{msgtype} = "event_$type";
		2125	$self->send_packet ("ext " . cf::to_json \%msg);
		2126	}
1672		2127
1673	=item $success = $client->query ($flags, "text", \&cb)	2128	=item $success = $client->query ($flags, "text", \&cb)
1674		2129
1675	Queues a query to the client, calling the given callback with	2130	Queues a query to the client, calling the given callback with
1676	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2131	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
…		…
1701	on_reply => sub {	2156	on_reply => sub {
1702	my ($ns, $msg) = @_;	2157	my ($ns, $msg) = @_;
1703		2158
1704	# this weird shuffling is so that direct followup queries	2159	# this weird shuffling is so that direct followup queries
1705	# get handled first	2160	# get handled first
1706	my $queue = delete $ns->{query_queue};	2161	my $queue = delete $ns->{query_queue}
		2162	or return; # be conservative, not sure how that can happen, but we saw a crash here
1707		2163
1708	(shift @$queue)->[1]->($msg);	2164	(shift @$queue)->[1]->($msg);
		2165	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1709		2166
1710	push @{ $ns->{query_queue} }, @$queue;	2167	push @{ $ns->{query_queue} }, @$queue;
1711		2168
1712	if (@{ $ns->{query_queue} } == @$queue) {	2169	if (@{ $ns->{query_queue} } == @$queue) {
1713	if (@$queue) {	2170	if (@$queue) {
…		…
1717	}	2174	}
1718	}	2175	}
1719	},	2176	},
1720	);	2177	);
1721		2178
1722	=item $client->coro (\&cb)	2179	=item $client->async (\&cb)
1723		2180
1724	Create a new coroutine, running the specified callback. The coroutine will	2181	Create a new coroutine, running the specified callback. The coroutine will
1725	be automatically cancelled when the client gets destroyed (e.g. on logout,	2182	be automatically cancelled when the client gets destroyed (e.g. on logout,
1726	or loss of connection).	2183	or loss of connection).
1727		2184
1728	=cut	2185	=cut
1729		2186
1730	sub cf::client::coro {	2187	sub cf::client::async {
1731	my ($self, $cb) = @_;	2188	my ($self, $cb) = @_;
1732		2189
1733	my $coro; $coro = async {	2190	my $coro = &Coro::async ($cb);
1734	eval {
1735	$cb->();
1736	};
1737	warn $@ if $@;
1738	};
1739		2191
1740	$coro->on_destroy (sub {	2192	$coro->on_destroy (sub {
1741	delete $self->{_coro}{$coro+0};	2193	delete $self->{_coro}{$coro+0};
1742	});	2194	});
1743		2195
…		…
1776		2228
1777	# here we export the classes and methods available to script code	2229	# here we export the classes and methods available to script code
1778		2230
1779	=pod	2231	=pod
1780		2232
1781	The following fucntions and emthods are available within a safe environment:	2233	The following functions and methods are available within a safe environment:
1782		2234
1783	cf::object contr pay_amount pay_player map	2235	cf::object contr pay_amount pay_player map
1784	cf::object::player player	2236	cf::object::player player
1785	cf::player peaceful	2237	cf::player peaceful
1786	cf::map trigger	2238	cf::map trigger
…		…
1871	#############################################################################	2323	#############################################################################
1872		2324
1873	=head2 EXTENSION DATABASE SUPPORT	2325	=head2 EXTENSION DATABASE SUPPORT
1874		2326
1875	Crossfire maintains a very simple database for extension use. It can	2327	Crossfire maintains a very simple database for extension use. It can
1876	currently store anything that can be serialised using Storable, which	2328	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
1877	excludes objects.	2329	convert to/from binary).
1878		2330
1879	The parameter C<$family> should best start with the name of the extension	2331	The parameter C<$family> should best start with the name of the extension
1880	using it, it should be unique.	2332	using it, it should be unique.
1881		2333
1882	=over 4	2334	=over 4
1883		2335
1884	=item $hashref = cf::db_get $family
1885
1886	Return a hashref for use by the extension C<$family>, which can be
1887	modified. After modifications, you have to call C<cf::db_dirty> or
1888	C<cf::db_sync>.
1889
1890	=item $value = cf::db_get $family => $key	2336	=item $value = cf::db_get $family => $key
1891		2337
1892	Returns a single value from the database	2338	Returns a single value from the database.
1893
1894	=item cf::db_put $family => $hashref
1895
1896	Stores the given family hashref into the database. Updates are delayed, if
1897	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1898		2339
1899	=item cf::db_put $family => $key => $value	2340	=item cf::db_put $family => $key => $value
1900		2341
1901	Stores the given C<$value> in the family hash. Updates are delayed, if you	2342	Stores the given C<$value> in the family.
1902	want the data to be synced to disk immediately, use C<cf::db_sync>.
1903
1904	=item cf::db_dirty
1905
1906	Marks the database as dirty, to be updated at a later time.
1907
1908	=item cf::db_sync
1909
1910	Immediately write the database to disk I<if it is dirty>.
1911		2343
1912	=cut	2344	=cut
1913		2345
1914	our $DB;	2346	our $DB;
1915		2347
1916	{	2348	sub db_init {
1917	my $path = cf::localdir . "/database.pst";	2349	unless ($DB) {
		2350	$DB = BDB::db_create $DB_ENV;
1918		2351
1919	sub db_load() {	2352	cf::sync_job {
1920	$DB = stat $path ? Storable::retrieve $path : { };	2353	eval {
1921	}	2354	$DB->set_flags (BDB::CHKSUM);
1922		2355
1923	my $pid;	2356	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
1924		2357	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
1925	sub db_save() {	2358	cf::cleanup "db_open(db): $!" if $!;
1926	waitpid $pid, 0 if $pid;	2359	};
1927	if (0 == ($pid = fork)) {	2360	cf::cleanup "db_open(db): $@" if $@;
1928	$DB->{_meta}{version} = 1;
1929	Storable::nstore $DB, "$path~";
1930	rename "$path~", $path;
1931	cf::_exit 0 if defined $pid;
1932	}	2361	};
1933	}
1934
1935	my $dirty;
1936
1937	sub db_sync() {
1938	db_save if $dirty;
1939	undef $dirty;
1940	}
1941
1942	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1943	db_sync;
1944	});	2362	}
		2363	}
1945		2364
1946	sub db_dirty() {
1947	$dirty = 1;
1948	$idle->start;
1949	}
1950
1951	sub db_get($;$) {	2365	sub db_get($$) {
1952	@_ >= 2	2366	my $key = "$_[0]/$_[1]";
1953	? $DB->{$_[0]}{$_[1]}
1954	: ($DB->{$_[0]} ||= { })
1955	}
1956		2367
		2368	cf::sync_job {
		2369	BDB::db_get $DB, undef, $key, my $data;
		2370
		2371	$! ? ()
		2372	: $data
		2373	}
		2374	}
		2375
1957	sub db_put($$;$) {	2376	sub db_put($$$) {
1958	if (@_ >= 3) {	2377	BDB::dbreq_pri 4;
1959	$DB->{$_[0]}{$_[1]} = $_[2];	2378	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
1960	} else {	2379	}
1961	$DB->{$_[0]} = $_[1];
1962	}
1963	db_dirty;
1964	}
1965		2380
1966	cf::global->attach (	2381	=item cf::cache $id => [$paths...], $processversion => $process
1967	prio => 10000,	2382
1968	on_cleanup => sub {	2383	Generic caching function that returns the value of the resource $id,
1969	db_sync;	2384	caching and regenerating as required.
		2385
		2386	This function can block.
		2387
		2388	=cut
		2389
		2390	sub cache {
		2391	my ($id, $src, $processversion, $process) = @_;
		2392
		2393	my $meta =
		2394	join "\x00",
		2395	$processversion,
		2396	map {
		2397	aio_stat $_
		2398	and Carp::croak "$_: $!";
		2399
		2400	($_, (stat _)[7,9])
		2401	} @$src;
		2402
		2403	my $dbmeta = db_get cache => "$id/meta";
		2404	if ($dbmeta ne $meta) {
		2405	# changed, we may need to process
		2406
		2407	my @data;
		2408	my $md5;
		2409
		2410	for (0 .. $#$src) {
		2411	0 <= aio_load $src->[$_], $data[$_]
		2412	or Carp::croak "$src->[$_]: $!";
1970	},	2413	}
1971	);	2414
		2415	# if processing is expensive, check
		2416	# checksum first
		2417	if (1) {
		2418	$md5 =
		2419	join "\x00",
		2420	$processversion,
		2421	map {
		2422	Coro::cede;
		2423	($src->[$_], Digest::MD5::md5_hex $data[$_])
		2424	} 0.. $#$src;
		2425
		2426
		2427	my $dbmd5 = db_get cache => "$id/md5";
		2428	if ($dbmd5 eq $md5) {
		2429	db_put cache => "$id/meta", $meta;
		2430
		2431	return db_get cache => "$id/data";
		2432	}
		2433	}
		2434
		2435	my $t1 = Time::HiRes::time;
		2436	my $data = $process->(\@data);
		2437	my $t2 = Time::HiRes::time;
		2438
		2439	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		2440
		2441	db_put cache => "$id/data", $data;
		2442	db_put cache => "$id/md5" , $md5;
		2443	db_put cache => "$id/meta", $meta;
		2444
		2445	return $data;
		2446	}
		2447
		2448	db_get cache => "$id/data"
		2449	}
		2450
		2451	=item fork_call { }, $args
		2452
		2453	Executes the given code block with the given arguments in a seperate
		2454	process, returning the results. Everything must be serialisable with
		2455	Coro::Storable. May, of course, block. Note that the executed sub may
		2456	never block itself or use any form of Event handling.
		2457
		2458	=cut
		2459
		2460	sub fork_call(&@) {
		2461	my ($cb, @args) = @_;
		2462
		2463	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
		2464	# or die "socketpair: $!";
		2465	pipe my $fh1, my $fh2
		2466	or die "pipe: $!";
		2467
		2468	if (my $pid = fork) {
		2469	close $fh2;
		2470
		2471	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
		2472	$res = Coro::Storable::thaw $res;
		2473
		2474	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		2475
		2476	die $$res unless "ARRAY" eq ref $res;
		2477
		2478	return wantarray ? @$res : $res->[-1];
		2479	} else {
		2480	reset_signals;
		2481	local $SIG{__WARN__};
		2482	local $SIG{__DIE__};
		2483	eval {
		2484	close $fh1;
		2485
		2486	my @res = eval { $cb->(@args) };
		2487	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
		2488	};
		2489
		2490	warn $@ if $@;
		2491	_exit 0;
		2492	}
1972	}	2493	}
1973		2494
1974	#############################################################################	2495	#############################################################################
1975	# the server's main()	2496	# the server's init and main functions
		2497
		2498	sub load_facedata($) {
		2499	my ($path) = @_;
		2500
		2501	warn "loading facedata from $path\n";
		2502
		2503	my $facedata;
		2504	0 < aio_load $path, $facedata
		2505	or die "$path: $!";
		2506
		2507	$facedata = Coro::Storable::thaw $facedata;
		2508
		2509	$facedata->{version} == 2
		2510	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2511
		2512	{
		2513	my $faces = $facedata->{faceinfo};
		2514
		2515	while (my ($face, $info) = each %$faces) {
		2516	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2517	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
		2518	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2519	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2520	Coro::cede;
		2521	}
		2522
		2523	while (my ($face, $info) = each %$faces) {
		2524	next unless $info->{smooth};
		2525	my $idx = cf::face::find $face
		2526	or next;
		2527	if (my $smooth = cf::face::find $info->{smooth}) {
		2528	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2529	} else {
		2530	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2531	}
		2532	Coro::cede;
		2533	}
		2534	}
		2535
		2536	{
		2537	my $anims = $facedata->{animinfo};
		2538
		2539	while (my ($anim, $info) = each %$anims) {
		2540	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2541	Coro::cede;
		2542	}
		2543
		2544	cf::anim::invalidate_all; # d'oh
		2545	}
		2546
		2547	1
		2548	}
		2549
		2550	sub reload_regions {
		2551	load_resource_file "$MAPDIR/regions"
		2552	or die "unable to load regions file\n";
		2553	}
		2554
		2555	sub reload_facedata {
		2556	load_facedata "$DATADIR/facedata"
		2557	or die "unable to load facedata\n";
		2558	}
		2559
		2560	sub reload_archetypes {
		2561	load_resource_file "$DATADIR/archetypes"
		2562	or die "unable to load archetypes\n";
		2563	}
		2564
		2565	sub reload_treasures {
		2566	load_resource_file "$DATADIR/treasures"
		2567	or die "unable to load treasurelists\n";
		2568	}
		2569
		2570	sub reload_resources {
		2571	warn "reloading resource files...\n";
		2572
		2573	reload_regions;
		2574	reload_facedata;
		2575	#reload_archetypes;#d#
		2576	reload_archetypes;
		2577	reload_treasures;
		2578
		2579	warn "finished reloading resource files\n";
		2580	}
		2581
		2582	sub init {
		2583	reload_resources;
		2584	}
1976		2585
1977	sub cfg_load {	2586	sub cfg_load {
1978	open my $fh, "<:utf8", cf::confdir . "/config"	2587	open my $fh, "<:utf8", "$CONFDIR/config"
1979	or return;	2588	or return;
1980		2589
1981	local $/;	2590	local $/;
1982	*CFG = YAML::Syck::Load <$fh>;	2591	*CFG = YAML::Syck::Load <$fh>;
		2592
		2593	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2594
		2595	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2596	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2597
		2598	if (exists $CFG{mlockall}) {
		2599	eval {
		2600	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2601	and die "WARNING: m(un)lockall failed: $!\n";
		2602	};
		2603	warn $@ if $@;
		2604	}
1983	}	2605	}
1984		2606
1985	sub main {	2607	sub main {
1986	# we must not ever block the main coroutine	2608	# we must not ever block the main coroutine
1987	local $Coro::idle = sub {	2609	local $Coro::idle = sub {
1988	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	2610	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1989	(Coro::unblock_sub {	2611	(async {
1990	Event::one_event;	2612	Event::one_event;
1991	})->();	2613	})->prio (Coro::PRIO_MAX);
1992	};	2614	};
1993		2615
1994	cfg_load;	2616	cfg_load;
1995	db_load;	2617	db_init;
1996	load_extensions;	2618	load_extensions;
		2619
		2620	$TICK_WATCHER->start;
1997	Event::loop;	2621	Event::loop;
1998	}	2622	}
1999		2623
2000	#############################################################################	2624	#############################################################################
2001	# initialisation	2625	# initialisation and cleanup
2002		2626
		2627	# install some emergency cleanup handlers
		2628	BEGIN {
		2629	for my $signal (qw(INT HUP TERM)) {
		2630	Event->signal (
		2631	reentrant => 0,
		2632	data => WF_AUTOCANCEL,
		2633	signal => $signal,
		2634	prio => 0,
		2635	cb => sub {
		2636	cf::cleanup "SIG$signal";
		2637	},
		2638	);
		2639	}
		2640	}
		2641
		2642	sub emergency_save() {
		2643	my $freeze_guard = cf::freeze_mainloop;
		2644
		2645	warn "enter emergency perl save\n";
		2646
		2647	cf::sync_job {
		2648	# use a peculiar iteration method to avoid tripping on perl
		2649	# refcount bugs in for. also avoids problems with players
		2650	# and maps saved/destroyed asynchronously.
		2651	warn "begin emergency player save\n";
		2652	for my $login (keys %cf::PLAYER) {
		2653	my $pl = $cf::PLAYER{$login} or next;
		2654	$pl->valid or next;
		2655	$pl->save;
		2656	}
		2657	warn "end emergency player save\n";
		2658
		2659	warn "begin emergency map save\n";
		2660	for my $path (keys %cf::MAP) {
		2661	my $map = $cf::MAP{$path} or next;
		2662	$map->valid or next;
		2663	$map->save;
		2664	}
		2665	warn "end emergency map save\n";
		2666
		2667	warn "begin emergency database checkpoint\n";
		2668	BDB::db_env_txn_checkpoint $DB_ENV;
		2669	warn "end emergency database checkpoint\n";
		2670	};
		2671
		2672	warn "leave emergency perl save\n";
		2673	}
		2674
		2675	sub post_cleanup {
		2676	my ($make_core) = @_;
		2677
		2678	warn Carp::longmess "post_cleanup backtrace"
		2679	if $make_core;
		2680	}
		2681
2003	sub reload() {	2682	sub do_reload_perl() {
2004	# can/must only be called in main	2683	# can/must only be called in main
2005	if ($Coro::current != $Coro::main) {	2684	if ($Coro::current != $Coro::main) {
2006	warn "can only reload from main coroutine\n";	2685	warn "can only reload from main coroutine";
2007	return;	2686	return;
2008	}	2687	}
2009		2688
2010	warn "reloading...";	2689	warn "reloading...";
2011		2690
2012	local $FREEZE = 1;	2691	warn "entering sync_job";
		2692
		2693	cf::sync_job {
		2694	cf::write_runtime; # external watchdog should not bark
2013	cf::emergency_save;	2695	cf::emergency_save;
		2696	cf::write_runtime; # external watchdog should not bark
2014		2697
2015	eval {	2698	warn "syncing database to disk";
		2699	BDB::db_env_txn_checkpoint $DB_ENV;
		2700
2016	# if anything goes wrong in here, we should simply crash as we already saved	2701	# if anything goes wrong in here, we should simply crash as we already saved
2017		2702
2018	# cancel all watchers	2703	warn "cancelling all WF_AUTOCANCEL watchers";
2019	for (Event::all_watchers) {	2704	for (Event::all_watchers) {
2020	$_->cancel if $_->data & WF_AUTOCANCEL;	2705	$_->cancel if $_->data & WF_AUTOCANCEL;
2021	}	2706	}
2022		2707
		2708	warn "flushing outstanding aio requests";
		2709	for (;;) {
		2710	BDB::flush;
		2711	IO::AIO::flush;
		2712	Coro::cede;
		2713	last unless IO::AIO::nreqs || BDB::nreqs;
		2714	warn "iterate...";
		2715	}
		2716
		2717	++$RELOAD;
		2718
2023	# cancel all extension coros	2719	warn "cancelling all extension coros";
2024	$_->cancel for values %EXT_CORO;	2720	$_->cancel for values %EXT_CORO;
2025	%EXT_CORO = ();	2721	%EXT_CORO = ();
2026		2722
2027	# unload all extensions	2723	warn "removing commands";
2028	for (@exts) {	2724	%COMMAND = ();
		2725
		2726	warn "removing ext commands";
		2727	%EXTCMD = ();
		2728
		2729	warn "unloading/nuking all extensions";
		2730	for my $pkg (@EXTS) {
2029	warn "unloading <$_>";	2731	warn "... unloading $pkg";
2030	unload_extension $_;	2732
		2733	if (my $cb = $pkg->can ("unload")) {
		2734	eval {
		2735	$cb->($pkg);
		2736	1
		2737	} or warn "$pkg unloaded, but with errors: $@";
2031	}	2738	}
2032		2739
		2740	warn "... nuking $pkg";
		2741	Symbol::delete_package $pkg;
		2742	}
		2743
2033	# unload all modules loaded from $LIBDIR	2744	warn "unloading all perl modules loaded from $LIBDIR";
2034	while (my ($k, $v) = each %INC) {	2745	while (my ($k, $v) = each %INC) {
2035	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2746	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2036		2747
2037	warn "removing <$k>";	2748	warn "... unloading $k";
2038	delete $INC{$k};	2749	delete $INC{$k};
2039		2750
2040	$k =~ s/\.pm$//;	2751	$k =~ s/\.pm$//;
2041	$k =~ s/\//::/g;	2752	$k =~ s/\//::/g;
2042		2753
…		…
2045	}	2756	}
2046		2757
2047	Symbol::delete_package $k;	2758	Symbol::delete_package $k;
2048	}	2759	}
2049		2760
2050	# sync database to disk
2051	cf::db_sync;
2052	IO::AIO::flush;
2053
2054	# get rid of safe::, as good as possible	2761	warn "getting rid of safe::, as good as possible";
2055	Symbol::delete_package "safe::$_"	2762	Symbol::delete_package "safe::$_"
2056	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2763	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2057		2764
2058	# remove register_script_function callbacks
2059	# TODO
2060
2061	# unload cf.pm "a bit"	2765	warn "unloading cf.pm \"a bit\"";
2062	delete $INC{"cf.pm"};	2766	delete $INC{"cf.pm"};
		2767	delete $INC{"cf/pod.pm"};
2063		2768
2064	# don't, removes xs symbols, too,	2769	# don't, removes xs symbols, too,
2065	# and global variables created in xs	2770	# and global variables created in xs
2066	#Symbol::delete_package __PACKAGE__;	2771	#Symbol::delete_package __PACKAGE__;
2067		2772
2068	# reload cf.pm	2773	warn "unload completed, starting to reload now";
		2774
2069	warn "reloading cf.pm";	2775	warn "reloading cf.pm";
2070	require cf;	2776	require cf;
2071	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	2777	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2072		2778
2073	# load config and database again	2779	warn "loading config and database again";
2074	cf::cfg_load;	2780	cf::cfg_load;
2075	cf::db_load;
2076		2781
2077	# load extensions
2078	warn "load extensions";	2782	warn "loading extensions";
2079	cf::load_extensions;	2783	cf::load_extensions;
2080		2784
2081	# reattach attachments to objects	2785	warn "reattaching attachments to objects/players";
2082	warn "reattach";	2786	_global_reattach; # objects, sockets
2083	_global_reattach;	2787	warn "reattaching attachments to maps";
2084	};	2788	reattach $_ for values %MAP;
		2789	warn "reattaching attachments to players";
		2790	reattach $_ for values %PLAYER;
2085		2791
2086	if ($@) {	2792	warn "leaving sync_job";
		2793
		2794	1
		2795	} or do {
2087	warn $@;	2796	warn $@;
2088	warn "error while reloading, exiting.";	2797	warn "error while reloading, exiting.";
2089	exit 1;	2798	exit 1;
2090	}	2799	};
2091		2800
2092	warn "reloaded successfully";	2801	warn "reloaded";
2093	};	2802	};
2094		2803
2095	#############################################################################	2804	our $RELOAD_WATCHER; # used only during reload
2096		2805
2097	unless ($LINK_MAP) {	2806	sub reload_perl() {
2098	$LINK_MAP = cf::map::new;	2807	# doing reload synchronously and two reloads happen back-to-back,
		2808	# coro crashes during coro_state_free->destroy here.
2099		2809
2100	$LINK_MAP->width (41);	2810	$RELOAD_WATCHER ||= Event->timer (
2101	$LINK_MAP->height (41);	2811	reentrant => 0,
2102	$LINK_MAP->alloc;
2103	$LINK_MAP->path ("{link}");
2104	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2105	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2106
2107	# dirty hack because... archetypes are not yet loaded
2108	Event->timer (
2109	after => 2,	2812	after => 0,
		2813	data => WF_AUTOCANCEL,
2110	cb => sub {	2814	cb => sub {
2111	$_[0]->w->cancel;	2815	do_reload_perl;
2112		2816	undef $RELOAD_WATCHER;
2113	# provide some exits "home"
2114	my $exit = cf::object::new "exit";
2115
2116	$exit->slaying ($EMERGENCY_POSITION->[0]);
2117	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2118	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2119
2120	$LINK_MAP->insert ($exit->clone, 19, 19);
2121	$LINK_MAP->insert ($exit->clone, 19, 20);
2122	$LINK_MAP->insert ($exit->clone, 19, 21);
2123	$LINK_MAP->insert ($exit->clone, 20, 19);
2124	$LINK_MAP->insert ($exit->clone, 20, 21);
2125	$LINK_MAP->insert ($exit->clone, 21, 19);
2126	$LINK_MAP->insert ($exit->clone, 21, 20);
2127	$LINK_MAP->insert ($exit->clone, 21, 21);
2128
2129	$exit->destroy;
2130	});	2817	},
2131		2818	);
2132	$LINK_MAP->{deny_save} = 1;
2133	$LINK_MAP->{deny_reset} = 1;
2134
2135	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2136	}	2819	}
2137
2138	register "<global>", __PACKAGE__;
2139		2820
2140	register_command "reload" => sub {	2821	register_command "reload" => sub {
2141	my ($who, $arg) = @_;	2822	my ($who, $arg) = @_;
2142		2823
2143	if ($who->flag (FLAG_WIZ)) {	2824	if ($who->flag (FLAG_WIZ)) {
2144	$who->message ("start of reload.");
2145	reload;
2146	$who->message ("end of reload.");	2825	$who->message ("reloading server.");
		2826	async { reload_perl };
2147	}	2827	}
2148	};	2828	};
2149		2829
2150	unshift @INC, $LIBDIR;	2830	unshift @INC, $LIBDIR;
2151		2831
		2832	my $bug_warning = 0;
		2833
		2834	our @WAIT_FOR_TICK;
		2835	our @WAIT_FOR_TICK_BEGIN;
		2836
		2837	sub wait_for_tick {
		2838	return unless $TICK_WATCHER->is_active;
		2839	return if $Coro::current == $Coro::main;
		2840
		2841	my $signal = new Coro::Signal;
		2842	push @WAIT_FOR_TICK, $signal;
		2843	$signal->wait;
		2844	}
		2845
		2846	sub wait_for_tick_begin {
		2847	return unless $TICK_WATCHER->is_active;
		2848	return if $Coro::current == $Coro::main;
		2849
		2850	my $signal = new Coro::Signal;
		2851	push @WAIT_FOR_TICK_BEGIN, $signal;
		2852	$signal->wait;
		2853	}
		2854
		2855	my $min = 1e6;#d#
		2856	my $avg = 10;
2152	$TICK_WATCHER = Event->timer (	2857	$TICK_WATCHER = Event->timer (
2153	reentrant => 0,	2858	reentrant => 0,
		2859	parked => 1,
2154	prio => 0,	2860	prio => 0,
2155	at => $NEXT_TICK || $TICK,	2861	at => $NEXT_TICK || $TICK,
2156	data => WF_AUTOCANCEL,	2862	data => WF_AUTOCANCEL,
2157	cb => sub {	2863	cb => sub {
2158	unless ($FREEZE) {	2864	if ($Coro::current != $Coro::main) {
		2865	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		2866	unless ++$bug_warning > 10;
		2867	return;
		2868	}
		2869
		2870	$NOW = $tick_start = Event::time;
		2871
2159	cf::server_tick; # one server iteration	2872	cf::server_tick; # one server iteration
2160	$RUNTIME += $TICK;	2873
		2874	0 && sync_job {#d#
		2875	for(1..10) {
		2876	my $t = Event::time;
		2877	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		2878	or die;
		2879
		2880	$map->width (50);
		2881	$map->height (50);
		2882	$map->alloc;
		2883	$map->_load_objects ("/tmp/x.map", 1);
		2884	my $t = Event::time - $t;
		2885
		2886	#next unless $t < 0.0013;#d#
		2887	if ($t < $min) {
		2888	$min = $t;
		2889	}
		2890	$avg = $avg * 0.99 + $t * 0.01;
		2891	}
		2892	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		2893	exit 0;
		2894	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
2161	}	2895	};
2162		2896
		2897	$RUNTIME += $TICK;
2163	$NEXT_TICK += $TICK;	2898	$NEXT_TICK += $TICK;
2164		2899
		2900	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		2901	$NEXT_RUNTIME_WRITE = $NOW + 10;
		2902	Coro::async_pool {
		2903	write_runtime
		2904	or warn "ERROR: unable to write runtime file: $!";
		2905	};
		2906	}
		2907
		2908	# my $AFTER = Event::time;
		2909	# warn $AFTER - $NOW;#d#
		2910
		2911	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		2912	$sig->send;
		2913	}
		2914	while (my $sig = shift @WAIT_FOR_TICK) {
		2915	$sig->send;
		2916	}
		2917
		2918	$NOW = Event::time;
		2919
2165	# if we are delayed by four ticks or more, skip them all	2920	# if we are delayed by four ticks or more, skip them all
2166	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	2921	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2167		2922
2168	$TICK_WATCHER->at ($NEXT_TICK);	2923	$TICK_WATCHER->at ($NEXT_TICK);
2169	$TICK_WATCHER->start;	2924	$TICK_WATCHER->start;
		2925
		2926	$LOAD = ($NOW - $tick_start) / $TICK;
		2927	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		2928
		2929	_post_tick;
		2930
		2931
2170	},	2932	},
2171	);	2933	);
2172		2934
		2935	{
2173	IO::AIO::max_poll_time $TICK * 0.2;	2936	BDB::max_poll_time $TICK * 0.1;
2174		2937	$BDB_POLL_WATCHER = Event->io (
2175	Event->io (	2938	reentrant => 0,
2176	fd => IO::AIO::poll_fileno,	2939	fd => BDB::poll_fileno,
2177	poll => 'r',	2940	poll => 'r',
2178	prio => 5,	2941	prio => 0,
2179	data => WF_AUTOCANCEL,
2180	cb => \&IO::AIO::poll_cb,
2181	);
2182
2183	Event->timer (
2184	data => WF_AUTOCANCEL,	2942	data => WF_AUTOCANCEL,
2185	after => 0,	2943	cb => \&BDB::poll_cb,
2186	interval => 10,	2944	);
2187	cb => sub {	2945	BDB::min_parallel 8;
2188	(Coro::unblock_sub {	2946
2189	write_runtime	2947	BDB::set_sync_prepare {
2190	or warn "ERROR: unable to write runtime file: $!";	2948	my $status;
		2949	my $current = $Coro::current;
		2950	(
		2951	sub {
		2952	$status = $!;
		2953	$current->ready; undef $current;
		2954	},
		2955	sub {
		2956	Coro::schedule while defined $current;
		2957	$! = $status;
		2958	},
		2959	)
		2960	};
		2961
		2962	unless ($DB_ENV) {
		2963	$DB_ENV = BDB::db_env_create;
		2964
		2965	cf::sync_job {
		2966	eval {
		2967	BDB::db_env_open
		2968	$DB_ENV,
		2969	$BDBDIR,
		2970	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		2971	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		2972	0666;
		2973
		2974	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		2975
		2976	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		2977	$DB_ENV->set_lk_detect;
		2978	};
		2979
		2980	cf::cleanup "db_env_open(db): $@" if $@;
2191	})->();	2981	};
2192	},	2982	}
2193	);	2983	}
		2984
		2985	{
		2986	IO::AIO::min_parallel 8;
		2987
		2988	undef $Coro::AIO::WATCHER;
		2989	IO::AIO::max_poll_time $TICK * 0.1;
		2990	$AIO_POLL_WATCHER = Event->io (
		2991	reentrant => 0,
		2992	data => WF_AUTOCANCEL,
		2993	fd => IO::AIO::poll_fileno,
		2994	poll => 'r',
		2995	prio => 6,
		2996	cb => \&IO::AIO::poll_cb,
		2997	);
		2998	}
		2999
		3000	my $_log_backtrace;
		3001
		3002	sub _log_backtrace {
		3003	my ($msg, @addr) = @_;
		3004
		3005	$msg =~ s/\n//;
		3006
		3007	# limit the # of concurrent backtraces
		3008	if ($_log_backtrace < 2) {
		3009	++$_log_backtrace;
		3010	async {
		3011	my @bt = fork_call {
		3012	@addr = map { sprintf "%x", $_ } @addr;
		3013	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3014	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3015	or die "addr2line: $!";
		3016
		3017	my @funcs;
		3018	my @res = <$fh>;
		3019	chomp for @res;
		3020	while (@res) {
		3021	my ($func, $line) = splice @res, 0, 2, ();
		3022	push @funcs, "[$func] $line";
		3023	}
		3024
		3025	@funcs
		3026	};
		3027
		3028	LOG llevInfo, "[ABT] $msg\n";
		3029	LOG llevInfo, "[ABT] $_\n" for @bt;
		3030	--$_log_backtrace;
		3031	};
		3032	} else {
		3033	LOG llevInfo, "[ABT] $msg\n";
		3034	LOG llevInfo, "[ABT] [suppressed]\n";
		3035	}
		3036	}
		3037
		3038	# load additional modules
		3039	use cf::pod;
		3040
		3041	END { cf::emergency_save }
2194		3042
2195	1	3043	1
2196		3044

Diff Legend

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