ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

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

Diff Legend

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