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.135 by root, Thu Jan 4 20:29:46 2007 UTC vs.
Revision 1.222 by root, Tue Mar 6 03:06:00 2007 UTC

…		…
8	use Storable;	8	use Storable;
9	use Opcode;	9	use Opcode;
10	use Safe;	10	use Safe;
11	use Safe::Hole;	11	use Safe::Hole;
12		12
13	use Coro 3.3 ();	13	use Coro 3.5 ();
14	use Coro::Event;	14	use Coro::Event;
15	use Coro::Timer;	15	use Coro::Timer;
16	use Coro::Signal;	16	use Coro::Signal;
17	use Coro::Semaphore;	17	use Coro::Semaphore;
18	use Coro::AIO;	18	use Coro::AIO;
19		19
		20	use BDB ();
		21	use Data::Dumper;
20	use Digest::MD5;	22	use Digest::MD5;
21	use Fcntl;	23	use Fcntl;
22	use IO::AIO 2.31 ();	24	use IO::AIO 2.32 ();
23	use YAML::Syck ();	25	use YAML::Syck ();
24	use Time::HiRes;	26	use Time::HiRes;
		27	use Compress::LZF;
		28
		29	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
25		30
26	use Event; $Event::Eval = 1; # no idea why this is required, but it is	31	use Event; $Event::Eval = 1; # no idea why this is required, but it is
		32
		33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
27		34
28	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	35	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
29	$YAML::Syck::ImplicitUnicode = 1;	36	$YAML::Syck::ImplicitUnicode = 1;
30		37
31	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority	38	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
32
33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34		39
35	our %COMMAND = ();	40	our %COMMAND = ();
36	our %COMMAND_TIME = ();	41	our %COMMAND_TIME = ();
		42
		43	our @EXTS = (); # list of extension package names
37	our %EXTCMD = ();	44	our %EXTCMD = ();
		45	our %EXT_CORO = (); # coroutines bound to extensions
		46	our %EXT_MAP = (); # pluggable maps
38		47
39	our @EVENT;	48	our @EVENT;
40	our $LIBDIR = datadir . "/ext";	49	our $LIBDIR = datadir . "/ext";
41		50
42	our $TICK = MAX_TIME * 1e-6;	51	our $TICK = MAX_TIME * 1e-6;
43	our $TICK_WATCHER;	52	our $TICK_WATCHER;
		53	our $AIO_POLL_WATCHER;
		54	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44	our $NEXT_TICK;	55	our $NEXT_TICK;
45	our $NOW;	56	our $NOW;
		57	our $USE_FSYNC = 1; # use fsync to write maps - default off
		58
		59	our $BDB_POLL_WATCHER;
		60	our $DB_ENV;
46		61
47	our %CFG;	62	our %CFG;
48		63
49	our $UPTIME; $UPTIME ||= time;	64	our $UPTIME; $UPTIME ||= time;
50	our $RUNTIME;	65	our $RUNTIME;
51		66
		67	our %PLAYER; # all users
52	our %MAP; # all maps	68	our %MAP; # all maps
53	our $LINK_MAP; # the special {link} map	69	our $LINK_MAP; # the special {link} map, which is always available
54	our $RANDOM_MAPS = cf::localdir . "/random";	70	our $RANDOM_MAPS = cf::localdir . "/random";
55	our %EXT_CORO;	71	our $BDB_ENV_DIR = cf::localdir . "/db";
		72
		73	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
		74	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
		75
		76	# used to convert map paths into valid unix filenames by replacing / by ∕
		77	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
56		78
57	binmode STDOUT;	79	binmode STDOUT;
58	binmode STDERR;	80	binmode STDERR;
59		81
60	# read virtual server time, if available	82	# read virtual server time, if available
…		…
67	mkdir cf::localdir;	89	mkdir cf::localdir;
68	mkdir cf::localdir . "/" . cf::playerdir;	90	mkdir cf::localdir . "/" . cf::playerdir;
69	mkdir cf::localdir . "/" . cf::tmpdir;	91	mkdir cf::localdir . "/" . cf::tmpdir;
70	mkdir cf::localdir . "/" . cf::uniquedir;	92	mkdir cf::localdir . "/" . cf::uniquedir;
71	mkdir $RANDOM_MAPS;	93	mkdir $RANDOM_MAPS;
		94	mkdir $BDB_ENV_DIR;
72		95
73	# a special map that is always available
74	our $LINK_MAP;
75	our $EMERGENCY_POSITION;	96	our $EMERGENCY_POSITION;
		97
		98	sub cf::map::normalise;
76		99
77	#############################################################################	100	#############################################################################
78		101
79	=head2 GLOBAL VARIABLES	102	=head2 GLOBAL VARIABLES
80		103
…		…
104		127
105	=item %cf::CFG	128	=item %cf::CFG
106		129
107	Configuration for the server, loaded from C</etc/crossfire/config>, or	130	Configuration for the server, loaded from C</etc/crossfire/config>, or
108	from wherever your confdir points to.	131	from wherever your confdir points to.
		132
		133	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
		134
		135	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
		136	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
		137	processing has been done. Call C<< ->wait >> on them to maximise the
		138	window of cpu time available, or simply to synchronise to the server tick.
109		139
110	=back	140	=back
111		141
112	=cut	142	=cut
113		143
…		…
117	utf8::encode $msg;	147	utf8::encode $msg;
118		148
119	$msg .= "\n"	149	$msg .= "\n"
120	unless $msg =~ /\n$/;	150	unless $msg =~ /\n$/;
121		151
122	LOG llevError, "cfperl: $msg";	152	LOG llevError, $msg;
123	};	153	};
124	}	154	}
125		155
126	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	156	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
127	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	157	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
…		…
145		175
146	$Event::DIED = sub {	176	$Event::DIED = sub {
147	warn "error in event callback: @_";	177	warn "error in event callback: @_";
148	};	178	};
149		179
150	my %ext_pkg;
151	my @exts;
152	my @hook;
153
154	=head2 UTILITY FUNCTIONS	180	=head2 UTILITY FUNCTIONS
155		181
156	=over 4	182	=over 4
157		183
		184	=item dumpval $ref
		185
158	=cut	186	=cut
		187
		188	sub dumpval {
		189	eval {
		190	local $SIG{__DIE__};
		191	my $d;
		192	if (1) {
		193	$d = new Data::Dumper([$_[0]], ["*var"]);
		194	$d->Terse(1);
		195	$d->Indent(2);
		196	$d->Quotekeys(0);
		197	$d->Useqq(1);
		198	#$d->Bless(...);
		199	$d->Seen($_[1]) if @_ > 1;
		200	$d = $d->Dump();
		201	}
		202	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		203	$d
		204	} || "[unable to dump $_[0]: '$@']";
		205	}
159		206
160	use JSON::Syck (); # TODO# replace by JSON::PC once working	207	use JSON::Syck (); # TODO# replace by JSON::PC once working
161		208
162	=item $ref = cf::from_json $json	209	=item $ref = cf::from_json $json
163		210
…		…
221	# wake up all waiters, to be on the safe side	268	# wake up all waiters, to be on the safe side
222	$_->ready for @{ delete $LOCK{$key} };	269	$_->ready for @{ delete $LOCK{$key} };
223	}	270	}
224	}	271	}
225		272
226	=item cf::async { BLOCK }
227
228	Like C<Coro::async>, but runs the given BLOCK in an eval and only logs the
229	error instead of exiting the server in case of a problem.
230
231	=cut
232
233	sub async(&) {
234	my ($cb) = @_;
235
236	Coro::async {
237	eval { $cb->() };
238	warn $@ if $@;
239	}
240	}
241
242	sub freeze_mainloop {	273	sub freeze_mainloop {
243	return unless $TICK_WATCHER->is_active;	274	return unless $TICK_WATCHER->is_active;
244		275
245	my $guard = Coro::guard { $TICK_WATCHER->start };	276	my $guard = Coro::guard {
		277	$TICK_WATCHER->start;
		278	};
246	$TICK_WATCHER->stop;	279	$TICK_WATCHER->stop;
247	$guard	280	$guard
248	}	281	}
		282
		283	=item cf::async { BLOCK }
		284
		285	Currently the same as Coro::async_pool, meaning you cannot use
		286	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		287	thing you are allowed to do is call C<prio> on it.
		288
		289	=cut
		290
		291	BEGIN { *async = \&Coro::async_pool }
249		292
250	=item cf::sync_job { BLOCK }	293	=item cf::sync_job { BLOCK }
251		294
252	The design of crossfire+ requires that the main coro ($Coro::main) is	295	The design of crossfire+ requires that the main coro ($Coro::main) is
253	always able to handle events or runnable, as crossfire+ is only partly	296	always able to handle events or runnable, as crossfire+ is only partly
…		…
272	my $freeze_guard = freeze_mainloop;	315	my $freeze_guard = freeze_mainloop;
273		316
274	my $busy = 1;	317	my $busy = 1;
275	my @res;	318	my @res;
276		319
277	(Coro::async {	320	(async {
278	@res = eval { $job->() };	321	@res = eval { $job->() };
279	warn $@ if $@;	322	warn $@ if $@;
280	undef $busy;	323	undef $busy;
281	})->prio (Coro::PRIO_MAX);	324	})->prio (Coro::PRIO_MAX);
282		325
283	while ($busy) {	326	while ($busy) {
284	Coro::cede_notself;	327	Coro::cede or Event::one_event;
285	Event::one_event unless Coro::nready;
286	}	328	}
287		329
288	wantarray ? @res : $res[0]	330	wantarray ? @res : $res[0]
289	} else {	331	} else {
290	# we are in another coroutine, how wonderful, everything just works	332	# we are in another coroutine, how wonderful, everything just works
291		333
292	$job->()	334	$job->()
293	}	335	}
294	}	336	}
295		337
296	=item $coro = cf::coro { BLOCK }	338	=item $coro = cf::async_ext { BLOCK }
297		339
298	Creates and returns a new coro. This coro is automcatially being canceled	340	Like async, but this coro is automatically being canceled when the
299	when the extension calling this is being unloaded.	341	extension calling this is being unloaded.
300		342
301	=cut	343	=cut
302		344
303	sub coro(&) {	345	sub async_ext(&) {
304	my $cb = shift;	346	my $cb = shift;
305		347
306	my $coro = &cf::async ($cb);	348	my $coro = &Coro::async ($cb);
307		349
308	$coro->on_destroy (sub {	350	$coro->on_destroy (sub {
309	delete $EXT_CORO{$coro+0};	351	delete $EXT_CORO{$coro+0};
310	});	352	});
311	$EXT_CORO{$coro+0} = $coro;	353	$EXT_CORO{$coro+0} = $coro;
312		354
313	$coro	355	$coro
314	}	356	}
315		357
316	sub write_runtime {	358	sub write_runtime {
		359	my $guard = cf::lock_acquire "write_runtime";
		360
317	my $runtime = cf::localdir . "/runtime";	361	my $runtime = cf::localdir . "/runtime";
318		362
319	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	363	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
320	or return;	364	or return;
321		365
		366	my $value = $cf::RUNTIME + 90 + 10;
322	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	367	# 10 is the runtime save interval, for a monotonic clock
		368	# 60 allows for the watchdog to kill the server.
		369
323	(aio_write $fh, 0, (length $value), $value, 0) <= 0	370	(aio_write $fh, 0, (length $value), $value, 0) <= 0
324	and return;	371	and return;
325		372
		373	# always fsync - this file is important
326	aio_fsync $fh	374	aio_fsync $fh
327	and return;	375	and return;
328		376
329	close $fh	377	close $fh
330	or return;	378	or return;
…		…
336	}	384	}
337		385
338	=back	386	=back
339		387
340	=cut	388	=cut
341
342	#############################################################################
343
344	package cf::path;
345
346	sub new {
347	my ($class, $path, $base) = @_;
348
349	$path = $path->as_string if ref $path;
350
351	my $self = bless { }, $class;
352
353	# {... are special paths that are not touched
354	# ?xxx/... are special absolute paths
355	# ?random/... random maps
356	# /! non-realised random map exit
357	# /... normal maps
358	# ~/... per-player maps without a specific player (DO NOT USE)
359	# ~user/... per-player map of a specific user
360
361	if ($path =~ /^{/) {
362	# fine as it is
363	} elsif ($path =~ s{^\?random/}{}) {
364	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
365	$self->{random} = cf::from_json $data;
366	} else {
367	if ($path =~ s{^~([^/]+)?}{}) {
368	$self->{user_rel} = 1;
369
370	if (defined $1) {
371	$self->{user} = $1;
372	} elsif ($base =~ m{^~([^/]+)/}) {
373	$self->{user} = $1;
374	} else {
375	warn "cannot resolve user-relative path without user <$path,$base>\n";
376	}
377	} elsif ($path =~ /^\//) {
378	# already absolute
379	} else {
380	$base =~ s{[^/]+/?$}{};
381	return $class->new ("$base/$path");
382	}
383
384	for ($path) {
385	redo if s{/\.?/}{/};
386	redo if s{/[^/]+/\.\./}{/};
387	}
388	}
389
390	$self->{path} = $path;
391
392	$self
393	}
394
395	# the name / primary key / in-game path
396	sub as_string {
397	my ($self) = @_;
398
399	$self->{user_rel} ? "~$self->{user}$self->{path}"
400	: $self->{random} ? "?random/$self->{path}"
401	: $self->{path}
402	}
403
404	# the displayed name, this is a one way mapping
405	sub visible_name {
406	my ($self) = @_;
407
408	# if (my $rmp = $self->{random}) {
409	# # todo: be more intelligent about this
410	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
411	# } else {
412	$self->as_string
413	# }
414	}
415
416	# escape the /'s in the path
417	sub _escaped_path {
418	# ∕ is U+2215
419	(my $path = $_[0]{path}) =~ s/\//∕/g;
420	$path
421	}
422
423	# the original (read-only) location
424	sub load_path {
425	my ($self) = @_;
426
427	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
428	}
429
430	# the temporary/swap location
431	sub save_path {
432	my ($self) = @_;
433
434	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
435	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
436	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
437	}
438
439	# the unique path, might be eq to save_path
440	sub uniq_path {
441	my ($self) = @_;
442
443	$self->{user_rel} || $self->{random}
444	? undef
445	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
446	}
447
448	# return random map parameters, or undef
449	sub random_map_params {
450	my ($self) = @_;
451
452	$self->{random}
453	}
454
455	# this is somewhat ugly, but style maps do need special treatment
456	sub is_style_map {
457	$_[0]{path} =~ m{^/styles/}
458	}
459
460	package cf;
461		389
462	#############################################################################	390	#############################################################################
463		391
464	=head2 ATTACHABLE OBJECTS	392	=head2 ATTACHABLE OBJECTS
465		393
…		…
591	our @CB_TYPE = (); # registry for type (cf-object class) based events	519	our @CB_TYPE = (); # registry for type (cf-object class) based events
592	our @CB_MAP = ();	520	our @CB_MAP = ();
593		521
594	my %attachment;	522	my %attachment;
595		523
		524	sub cf::attachable::thawer_merge {
		525	# simply override everything except _meta
		526	local $_[0]{_meta};
		527	%{$_[0]} = %{$_[1]};
		528	}
		529
596	sub _attach_cb($$$$) {	530	sub _attach_cb($$$$) {
597	my ($registry, $event, $prio, $cb) = @_;	531	my ($registry, $event, $prio, $cb) = @_;
598		532
599	use sort 'stable';	533	use sort 'stable';
600		534
…		…
771	# object support	705	# object support
772		706
773	sub reattach {	707	sub reattach {
774	# basically do the same as instantiate, without calling instantiate	708	# basically do the same as instantiate, without calling instantiate
775	my ($obj) = @_;	709	my ($obj) = @_;
		710
		711	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
776		712
777	my $registry = $obj->registry;	713	my $registry = $obj->registry;
778		714
779	@$registry = ();	715	@$registry = ();
780		716
…		…
827	$filename, length $$rdata, scalar @$objs;	763	$filename, length $$rdata, scalar @$objs;
828		764
829	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	765	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
830	chmod SAVE_MODE, $fh;	766	chmod SAVE_MODE, $fh;
831	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	767	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
832	aio_fsync $fh;	768	aio_fsync $fh if $cf::USE_FSYNC;
833	close $fh;	769	close $fh;
834		770
835	if (@$objs) {	771	if (@$objs) {
836	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	772	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
837	chmod SAVE_MODE, $fh;	773	chmod SAVE_MODE, $fh;
838	my $data = Storable::nfreeze { version => 1, objs => $objs };	774	my $data = Storable::nfreeze { version => 1, objs => $objs };
839	aio_write $fh, 0, (length $data), $data, 0;	775	aio_write $fh, 0, (length $data), $data, 0;
840	aio_fsync $fh;	776	aio_fsync $fh if $cf::USE_FSYNC;
841	close $fh;	777	close $fh;
842	aio_rename "$filename.pst~", "$filename.pst";	778	aio_rename "$filename.pst~", "$filename.pst";
843	}	779	}
844	} else {	780	} else {
845	aio_unlink "$filename.pst";	781	aio_unlink "$filename.pst";
…		…
912	=cut	848	=cut
913		849
914	sub register_extcmd {	850	sub register_extcmd {
915	my ($name, $cb) = @_;	851	my ($name, $cb) = @_;
916		852
917	my $caller = caller;
918	#warn "registering extcmd '$name' to '$caller'";
919
920	$EXTCMD{$name} = [$cb, $caller];	853	$EXTCMD{$name} = $cb;
921	}	854	}
922		855
923	cf::player->attach (	856	cf::player->attach (
924	on_command => sub {	857	on_command => sub {
925	my ($pl, $name, $params) = @_;	858	my ($pl, $name, $params) = @_;
…		…
938		871
939	my $msg = eval { from_json $buf };	872	my $msg = eval { from_json $buf };
940		873
941	if (ref $msg) {	874	if (ref $msg) {
942	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	875	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
943	if (my %reply = $cb->[0]->($pl, $msg)) {	876	if (my %reply = $cb->($pl, $msg)) {
944	$pl->ext_reply ($msg->{msgid}, %reply);	877	$pl->ext_reply ($msg->{msgid}, %reply);
945	}	878	}
946	}	879	}
947	} else {	880	} else {
948	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	881	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
…		…
950		883
951	cf::override;	884	cf::override;
952	},	885	},
953	);	886	);
954		887
955	sub register {
956	my ($base, $pkg) = @_;
957
958	#TODO
959	}
960
961	sub load_extension {	888	sub load_extension {
962	my ($path) = @_;	889	my ($path) = @_;
963		890
964	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	891	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
965	my $base = $1;	892	my $base = $1;
966	my $pkg = $1;	893	my $pkg = $1;
967	$pkg =~ s/[^[:word:]]/_/g;	894	$pkg =~ s/[^[:word:]]/_/g;
968	$pkg = "ext::$pkg";	895	$pkg = "ext::$pkg";
969		896
970	warn "loading '$path' into '$pkg'\n";	897	warn "... loading '$path' into '$pkg'\n";
971		898
972	open my $fh, "<:utf8", $path	899	open my $fh, "<:utf8", $path
973	or die "$path: $!";	900	or die "$path: $!";
974		901
975	my $source =	902	my $source =
976	"package $pkg; use strict; use utf8;\n"	903	"package $pkg; use strict; use utf8;\n"
977	. "#line 1 \"$path\"\n{\n"	904	. "#line 1 \"$path\"\n{\n"
978	. (do { local $/; <$fh> })	905	. (do { local $/; <$fh> })
979	. "\n};\n1";	906	. "\n};\n1";
980		907
981	eval $source	908	unless (eval $source) {
982	or die $@ ? "$path: $@\n"	909	my $msg = $@ ? "$path: $@\n"
983	: "extension disabled.\n";	910	: "extension disabled.\n";
984		911	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
985	push @exts, $pkg;	912	warn $@;
986	$ext_pkg{$base} = $pkg;	913	warn "mandatory extension failed to load, exiting.\n";
987		914	exit 1;
988	# no strict 'refs';	915	}
989	# @{"$pkg\::ISA"} = ext::;	916	die $@;
990
991	register $base, $pkg;
992	}
993
994	sub unload_extension {
995	my ($pkg) = @_;
996
997	warn "removing extension $pkg\n";
998
999	# remove hooks
1000	#TODO
1001	# for my $idx (0 .. $#PLUGIN_EVENT) {
1002	# delete $hook[$idx]{$pkg};
1003	# }	917	}
1004		918
1005	# remove commands	919	push @EXTS, $pkg;
1006	for my $name (keys %COMMAND) {
1007	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1008
1009	if (@cb) {
1010	$COMMAND{$name} = \@cb;
1011	} else {
1012	delete $COMMAND{$name};
1013	}
1014	}
1015
1016	# remove extcmds
1017	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1018	delete $EXTCMD{$name};
1019	}
1020
1021	if (my $cb = $pkg->can ("unload")) {
1022	eval {
1023	$cb->($pkg);
1024	1
1025	} or warn "$pkg unloaded, but with errors: $@";
1026	}
1027
1028	Symbol::delete_package $pkg;
1029	}	920	}
1030		921
1031	sub load_extensions {	922	sub load_extensions {
1032	for my $ext (<$LIBDIR/*.ext>) {	923	for my $ext (<$LIBDIR/*.ext>) {
1033	next unless -r $ext;	924	next unless -r $ext;
…		…
1037	} or warn "$ext not loaded: $@";	928	} or warn "$ext not loaded: $@";
1038	}	929	}
1039	}	930	}
1040		931
1041	#############################################################################	932	#############################################################################
1042	# load/save/clean perl data associated with a map
1043
1044	*cf::mapsupport::on_clean = sub {
1045	my ($map) = @_;
1046
1047	my $path = $map->tmpname;
1048	defined $path or return;
1049
1050	unlink "$path.pst";
1051	};
1052
1053	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1054
1055	#############################################################################
1056	# load/save perl data associated with player->ob objects
1057
1058	sub all_objects(@) {
1059	@_, map all_objects ($_->inv), @_
1060	}
1061
1062	# TODO: compatibility cruft, remove when no longer needed
1063	cf::player->attach (
1064	on_load => sub {
1065	my ($pl, $path) = @_;
1066
1067	for my $o (all_objects $pl->ob) {
1068	if (my $value = $o->get_ob_key_value ("_perl_data")) {
1069	$o->set_ob_key_value ("_perl_data");
1070
1071	%$o = %{ Storable::thaw pack "H*", $value };
1072	}
1073	}
1074	},
1075	);
1076
1077	#############################################################################
1078		933
1079	=head2 CORE EXTENSIONS	934	=head2 CORE EXTENSIONS
1080		935
1081	Functions and methods that extend core crossfire objects.	936	Functions and methods that extend core crossfire objects.
1082		937
		938	=cut
		939
		940	package cf::player;
		941
		942	use Coro::AIO;
		943
1083	=head3 cf::player	944	=head3 cf::player
1084		945
1085	=over 4	946	=over 4
1086		947
1087	=item cf::player::exists $login	948	=item cf::player::find $login
1088		949
1089	Returns true when the given account exists.	950	Returns the given player object, loading it if necessary (might block).
1090		951
1091	=cut	952	=cut
1092		953
1093	sub cf::player::exists($) {	954	sub playerdir($) {
1094	cf::player::find $_[0]	955	cf::localdir
1095	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	956	. "/"
		957	. cf::playerdir
		958	. "/"
		959	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		960	}
		961
		962	sub path($) {
		963	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		964
		965	(playerdir $login) . "/$login.pl"
		966	}
		967
		968	sub find_active($) {
		969	$cf::PLAYER{$_[0]}
		970	and $cf::PLAYER{$_[0]}->active
		971	and $cf::PLAYER{$_[0]}
		972	}
		973
		974	sub exists($) {
		975	my ($login) = @_;
		976
		977	$cf::PLAYER{$login}
		978	or cf::sync_job { !aio_stat path $login }
		979	}
		980
		981	sub find($) {
		982	return $cf::PLAYER{$_[0]} || do {
		983	my $login = $_[0];
		984
		985	my $guard = cf::lock_acquire "user_find:$login";
		986
		987	$cf::PLAYER{$_[0]} || do {
		988	my $pl = load_pl path $login
		989	or return;
		990	$cf::PLAYER{$login} = $pl
		991	}
		992	}
		993	}
		994
		995	sub save($) {
		996	my ($pl) = @_;
		997
		998	return if $pl->{deny_save};
		999
		1000	my $path = path $pl;
		1001	my $guard = cf::lock_acquire "user_save:$path";
		1002
		1003	return if $pl->{deny_save};
		1004
		1005	aio_mkdir playerdir $pl, 0770;
		1006	$pl->{last_save} = $cf::RUNTIME;
		1007
		1008	$pl->save_pl ($path);
		1009	Coro::cede;
		1010	}
		1011
		1012	sub new($) {
		1013	my ($login) = @_;
		1014
		1015	my $self = create;
		1016
		1017	$self->ob->name ($login);
		1018	$self->{deny_save} = 1;
		1019
		1020	$cf::PLAYER{$login} = $self;
		1021
		1022	$self
		1023	}
		1024
		1025	=item $pl->quit_character
		1026
		1027	Nukes the player without looking back. If logged in, the connection will
		1028	be destroyed. May block for a long time.
		1029
		1030	=cut
		1031
		1032	sub quit_character {
		1033	my ($pl) = @_;
		1034
		1035	my $name = $pl->ob->name;
		1036
		1037	$pl->{deny_save} = 1;
		1038	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1039
		1040	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1041	$pl->deactivate;
		1042	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1043	$pl->ns->destroy if $pl->ns;
		1044
		1045	my $path = playerdir $pl;
		1046	my $temp = "$path~$cf::RUNTIME~deleting~";
		1047	aio_rename $path, $temp;
		1048	delete $cf::PLAYER{$pl->ob->name};
		1049	$pl->destroy;
		1050
		1051	my $prefix = qr<^~\Q$name\E/>;
		1052
		1053	# nuke player maps
		1054	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1055
		1056	IO::AIO::aio_rmtree $temp;
		1057	}
		1058
		1059	=item $pl->kick
		1060
		1061	Kicks a player out of the game. This destroys the connection.
		1062
		1063	=cut
		1064
		1065	sub kick {
		1066	my ($pl, $kicker) = @_;
		1067
		1068	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1069	$pl->killer ("kicked");
		1070	$pl->ns->destroy;
		1071	}
		1072
		1073	=item cf::player::list_logins
		1074
		1075	Returns am arrayref of all valid playernames in the system, can take a
		1076	while and may block, so not sync_job-capable, ever.
		1077
		1078	=cut
		1079
		1080	sub list_logins {
		1081	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
		1082	or return [];
		1083
		1084	my @logins;
		1085
		1086	for my $login (@$dirs) {
		1087	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1088	aio_read $fh, 0, 512, my $buf, 0 or next;
		1089	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1090
		1091	utf8::decode $login;
		1092	push @logins, $login;
		1093	}
		1094
		1095	\@logins
		1096	}
		1097
		1098	=item $player->maps
		1099
		1100	Returns an arrayref of map paths that are private for this
		1101	player. May block.
		1102
		1103	=cut
		1104
		1105	sub maps($) {
		1106	my ($pl) = @_;
		1107
		1108	$pl = ref $pl ? $pl->ob->name : $pl;
		1109
		1110	my $files = aio_readdir playerdir $pl
		1111	or return;
		1112
		1113	my @paths;
		1114
		1115	for (@$files) {
		1116	utf8::decode $_;
		1117	next if /\.(?:pl|pst)$/;
		1118	next unless /^$PATH_SEP/o;
		1119
		1120	push @paths, cf::map::normalise "~$pl/$_";
		1121	}
		1122
		1123	\@paths
1096	}	1124	}
1097		1125
1098	=item $player->ext_reply ($msgid, $msgtype, %msg)	1126	=item $player->ext_reply ($msgid, $msgtype, %msg)
1099		1127
1100	Sends an ext reply to the player.	1128	Sends an ext reply to the player.
1101		1129
1102	=cut	1130	=cut
1103		1131
1104	sub cf::player::ext_reply($$$%) {	1132	sub ext_reply($$$%) {
1105	my ($self, $id, %msg) = @_;	1133	my ($self, $id, %msg) = @_;
1106		1134
1107	$msg{msgid} = $id;	1135	$msg{msgid} = $id;
1108		1136
1109	$self->send ("ext " . to_json \%msg);	1137	$self->send ("ext " . cf::to_json \%msg);
1110	}	1138	}
		1139
		1140	package cf;
1111		1141
1112	=back	1142	=back
1113		1143
1114		1144
1115	=head3 cf::map	1145	=head3 cf::map
…		…
1121	package cf::map;	1151	package cf::map;
1122		1152
1123	use Fcntl;	1153	use Fcntl;
1124	use Coro::AIO;	1154	use Coro::AIO;
1125		1155
		1156	use overload
		1157	'""' => \&as_string,
		1158	fallback => 1;
		1159
1126	our $MAX_RESET = 3600;	1160	our $MAX_RESET = 3600;
1127	our $DEFAULT_RESET = 3000;	1161	our $DEFAULT_RESET = 3000;
1128		1162
1129	sub generate_random_map {	1163	sub generate_random_map {
1130	my ($path, $rmp) = @_;	1164	my ($self, $rmp) = @_;
1131
1132	# mit "rum" bekleckern, nicht	1165	# mit "rum" bekleckern, nicht
1133	cf::map::_create_random_map	1166	$self->_create_random_map (
1134	$path,
1135	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1167	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1136	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1168	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1137	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1169	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1138	$rmp->{exit_on_final_map},	1170	$rmp->{exit_on_final_map},
1139	$rmp->{xsize}, $rmp->{ysize},	1171	$rmp->{xsize}, $rmp->{ysize},
1140	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1172	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1141	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1173	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1142	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1174	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1143	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},	1175	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1144	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1176	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1145	(cf::region::find $rmp->{region})	1177	(cf::region::find $rmp->{region}), $rmp->{custom}
		1178	)
		1179	}
		1180
		1181	=item cf::map->register ($regex, $prio)
		1182
		1183	Register a handler for the map path matching the given regex at the
		1184	givne priority (higher is better, built-in handlers have priority 0, the
		1185	default).
		1186
		1187	=cut
		1188
		1189	sub register {
		1190	my (undef, $regex, $prio) = @_;
		1191	my $pkg = caller;
		1192
		1193	no strict;
		1194	push @{"$pkg\::ISA"}, __PACKAGE__;
		1195
		1196	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1197	}
		1198
		1199	# also paths starting with '/'
		1200	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1201
		1202	sub thawer_merge {
		1203	my ($self, $merge) = @_;
		1204
		1205	# we have to keep some variables in memory intact
		1206	local $self->{path};
		1207	local $self->{load_path};
		1208	local $self->{deny_save};
		1209	local $self->{deny_reset};
		1210
		1211	$self->SUPER::thawer_merge ($merge);
		1212	}
		1213
		1214	sub normalise {
		1215	my ($path, $base) = @_;
		1216
		1217	$path = "$path"; # make sure its a string
		1218
		1219	$path =~ s/\.map$//;
		1220
		1221	# map plan:
		1222	#
		1223	# /! non-realised random map exit (special hack!)
		1224	# {... are special paths that are not being touched
		1225	# ?xxx/... are special absolute paths
		1226	# ?random/... random maps
		1227	# /... normal maps
		1228	# ~user/... per-player map of a specific user
		1229
		1230	$path =~ s/$PATH_SEP/\//go;
		1231
		1232	# treat it as relative path if it starts with
		1233	# something that looks reasonable
		1234	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1235	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1236
		1237	$base =~ s{[^/]+/?$}{};
		1238	$path = "$base/$path";
		1239	}
		1240
		1241	for ($path) {
		1242	redo if s{//}{/};
		1243	redo if s{/\.?/}{/};
		1244	redo if s{/[^/]+/\.\./}{/};
		1245	}
		1246
		1247	$path
		1248	}
		1249
		1250	sub new_from_path {
		1251	my (undef, $path, $base) = @_;
		1252
		1253	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1254
		1255	$path = normalise $path, $base;
		1256
		1257	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1258	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1259	my $self = bless cf::map::new, $pkg;
		1260	$self->{path} = $path; $self->path ($path);
		1261	$self->init; # pass $1 etc.
		1262	return $self;
		1263	}
		1264	}
		1265
		1266	Carp::carp "unable to resolve path '$path' (base '$base').";
		1267	()
		1268	}
		1269
		1270	sub init {
		1271	my ($self) = @_;
		1272
		1273	$self
		1274	}
		1275
		1276	sub as_string {
		1277	my ($self) = @_;
		1278
		1279	"$self->{path}"
		1280	}
		1281
		1282	# the displayed name, this is a one way mapping
		1283	sub visible_name {
		1284	&as_string
		1285	}
		1286
		1287	# the original (read-only) location
		1288	sub load_path {
		1289	my ($self) = @_;
		1290
		1291	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}
		1292	}
		1293
		1294	# the temporary/swap location
		1295	sub save_path {
		1296	my ($self) = @_;
		1297
		1298	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1299	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path
		1300	}
		1301
		1302	# the unique path, undef == no special unique path
		1303	sub uniq_path {
		1304	my ($self) = @_;
		1305
		1306	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1307	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
1146	}	1308	}
1147		1309
1148	# and all this just because we cannot iterate over	1310	# and all this just because we cannot iterate over
1149	# all maps in C++...	1311	# all maps in C++...
1150	sub change_all_map_light {	1312	sub change_all_map_light {
…		…
1152		1314
1153	$_->change_map_light ($change)	1315	$_->change_map_light ($change)
1154	for grep $_->outdoor, values %cf::MAP;	1316	for grep $_->outdoor, values %cf::MAP;
1155	}	1317	}
1156		1318
		1319	sub unlink_save {
		1320	my ($self) = @_;
		1321
		1322	utf8::encode (my $save = $self->save_path);
		1323	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1324	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1325	}
		1326
1157	sub try_load_header($) {	1327	sub load_header_from($) {
1158	my ($path) = @_;	1328	my ($self, $path) = @_;
1159		1329
1160	utf8::encode $path;	1330	utf8::encode $path;
1161	aio_open $path, O_RDONLY, 0	1331	#aio_open $path, O_RDONLY, 0
		1332	# or return;
		1333
		1334	$self->_load_header ($path)
1162	or return;	1335	or return;
1163		1336
1164	my $map = cf::map::new	1337	$self->{load_path} = $path;
		1338
		1339	1
		1340	}
		1341
		1342	sub load_header_orig {
		1343	my ($self) = @_;
		1344
		1345	$self->load_header_from ($self->load_path)
		1346	}
		1347
		1348	sub load_header_temp {
		1349	my ($self) = @_;
		1350
		1351	$self->load_header_from ($self->save_path)
		1352	}
		1353
		1354	sub prepare_temp {
		1355	my ($self) = @_;
		1356
		1357	$self->last_access ((delete $self->{last_access})
		1358	|| $cf::RUNTIME); #d#
		1359	# safety
		1360	$self->{instantiate_time} = $cf::RUNTIME
		1361	if $self->{instantiate_time} > $cf::RUNTIME;
		1362	}
		1363
		1364	sub prepare_orig {
		1365	my ($self) = @_;
		1366
		1367	$self->{load_original} = 1;
		1368	$self->{instantiate_time} = $cf::RUNTIME;
		1369	$self->last_access ($cf::RUNTIME);
		1370	$self->instantiate;
		1371	}
		1372
		1373	sub load_header {
		1374	my ($self) = @_;
		1375
		1376	if ($self->load_header_temp) {
		1377	$self->prepare_temp;
		1378	} else {
		1379	$self->load_header_orig
1165	or return;	1380	or return;
		1381	$self->prepare_orig;
		1382	}
1166		1383
1167	# for better error messages only, will be overwritten	1384	1
1168	$map->path ($path);
1169
1170	$map->load_header ($path)
1171	or return;
1172
1173	$map->{load_path} = $path;
1174
1175	$map
1176	}	1385	}
1177		1386
1178	sub find;	1387	sub find;
1179	sub find {	1388	sub find {
1180	my ($path, $origin) = @_;	1389	my ($path, $origin) = @_;
1181		1390
1182	#warn "find<$path,$origin>\n";#d#
1183
1184	$path = new cf::path $path, $origin && $origin->path;	1391	$path = normalise $path, $origin && $origin->path;
1185	my $key = $path->as_string;
1186		1392
1187	cf::lock_wait "map_find:$key";	1393	cf::lock_wait "map_find:$path";
1188		1394
1189	$cf::MAP{$key} || do {	1395	$cf::MAP{$path} || do {
1190	my $guard = cf::lock_acquire "map_find:$key";	1396	my $guard = cf::lock_acquire "map_find:$path";
1191		1397	my $map = new_from_path cf::map $path
1192	# do it the slow way
1193	my $map = try_load_header $path->save_path;
1194
1195	Coro::cede;
1196
1197	if ($map) {
1198	$map->last_access ((delete $map->{last_access})
1199	|| $cf::RUNTIME); #d#
1200	# safety
1201	$map->{instantiate_time} = $cf::RUNTIME
1202	if $map->{instantiate_time} > $cf::RUNTIME;
1203	} else {
1204	if (my $rmp = $path->random_map_params) {
1205	$map = generate_random_map $key, $rmp;
1206	} else {
1207	$map = try_load_header $path->load_path;
1208	}
1209
1210	$map or return;	1398	or return;
1211		1399
1212	$map->{load_original} = 1;
1213	$map->{instantiate_time} = $cf::RUNTIME;
1214	$map->last_access ($cf::RUNTIME);
1215	$map->instantiate;
1216
1217	# per-player maps become, after loading, normal maps
1218	$map->per_player (0) if $path->{user_rel};
1219	}
1220
1221	$map->path ($key);
1222	$map->{path} = $path;
1223	$map->{last_save} = $cf::RUNTIME;	1400	$map->{last_save} = $cf::RUNTIME;
1224		1401
1225	Coro::cede;	1402	$map->load_header
		1403	or return;
1226		1404
1227	if ($map->should_reset) {	1405	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)
		1406	# doing this can freeze the server in a sync job, obviously
		1407	#$cf::WAIT_FOR_TICK->wait;
1228	$map->reset;	1408	$map->reset;
1229	undef $guard;	1409	undef $guard;
1230	$map = find $path	1410	return find $path;
1231	or return;
1232	}	1411	}
1233		1412
1234	$cf::MAP{$key} = $map	1413	$cf::MAP{$path} = $map
1235	}	1414	}
1236	}	1415	}
		1416
		1417	sub pre_load { }
		1418	sub post_load { }
1237		1419
1238	sub load {	1420	sub load {
1239	my ($self) = @_;	1421	my ($self) = @_;
1240		1422
		1423	local $self->{deny_reset} = 1; # loading can take a long time
		1424
1241	my $path = $self->{path};	1425	my $path = $self->{path};
1242	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	1426	my $guard = cf::lock_acquire "map_load:$path";
1243		1427
1244	return if $self->in_memory != cf::MAP_SWAPPED;	1428	return if $self->in_memory != cf::MAP_SWAPPED;
1245		1429
1246	$self->in_memory (cf::MAP_LOADING);	1430	$self->in_memory (cf::MAP_LOADING);
1247		1431
1248	$self->alloc;	1432	$self->alloc;
		1433
		1434	$self->pre_load;
		1435
1249	$self->load_objects ($self->{load_path}, 1)	1436	$self->_load_objects ($self->{load_path}, 1)
1250	or return;	1437	or return;
1251		1438
1252	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1439	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1253	if delete $self->{load_original};	1440	if delete $self->{load_original};
1254		1441
1255	if (my $uniq = $path->uniq_path) {	1442	if (my $uniq = $self->uniq_path) {
1256	utf8::encode $uniq;	1443	utf8::encode $uniq;
1257	if (aio_open $uniq, O_RDONLY, 0) {	1444	if (aio_open $uniq, O_RDONLY, 0) {
1258	$self->clear_unique_items;	1445	$self->clear_unique_items;
1259	$self->load_objects ($uniq, 0);	1446	$self->_load_objects ($uniq, 0);
1260	}	1447	}
1261	}	1448	}
1262		1449
1263	Coro::cede;	1450	Coro::cede;
1264		1451
1265	# now do the right thing for maps	1452	# now do the right thing for maps
1266	$self->link_multipart_objects;	1453	$self->link_multipart_objects;
1267		1454
1268	if ($self->{path}->is_style_map) {	1455	unless ($self->{deny_activate}) {
1269	$self->{deny_save} = 1;	1456	$self->decay_objects;
1270	$self->{deny_reset} = 1;
1271	} else {
1272	$self->fix_auto_apply;	1457	$self->fix_auto_apply;
1273	$self->decay_objects;
1274	$self->update_buttons;	1458	$self->update_buttons;
		1459	Coro::cede;
1275	$self->set_darkness_map;	1460	$self->set_darkness_map;
1276	$self->difficulty ($self->estimate_difficulty)	1461	$self->difficulty ($self->estimate_difficulty)
1277	unless $self->difficulty;	1462	unless $self->difficulty;
		1463	Coro::cede;
1278	$self->activate;	1464	$self->activate;
1279	}	1465	}
1280		1466
1281	Coro::cede;	1467	$self->post_load;
1282		1468
1283	$self->in_memory (cf::MAP_IN_MEMORY);	1469	$self->in_memory (cf::MAP_IN_MEMORY);
		1470	}
		1471
		1472	sub customise_for {
		1473	my ($self, $ob) = @_;
		1474
		1475	return find "~" . $ob->name . "/" . $self->{path}
		1476	if $self->per_player;
		1477
		1478	$self
		1479	}
		1480
		1481	# find and load all maps in the 3x3 area around a map
		1482	sub load_diag {
		1483	my ($map) = @_;
		1484
		1485	my @diag; # diagonal neighbours
		1486
		1487	for (0 .. 3) {
		1488	my $neigh = $map->tile_path ($_)
		1489	or next;
		1490	$neigh = find $neigh, $map
		1491	or next;
		1492	$neigh->load;
		1493
		1494	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1495	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1496	}
		1497
		1498	for (@diag) {
		1499	my $neigh = find @$_
		1500	or next;
		1501	$neigh->load;
		1502	}
1284	}	1503	}
1285		1504
1286	sub find_sync {	1505	sub find_sync {
1287	my ($path, $origin) = @_;	1506	my ($path, $origin) = @_;
1288		1507
1289	cf::sync_job { cf::map::find $path, $origin }	1508	cf::sync_job { find $path, $origin }
1290	}	1509	}
1291		1510
1292	sub do_load_sync {	1511	sub do_load_sync {
1293	my ($map) = @_;	1512	my ($map) = @_;
1294		1513
1295	cf::sync_job { $map->load };	1514	cf::sync_job { $map->load };
1296	}	1515	}
1297		1516
		1517	our %MAP_PREFETCH;
		1518	our $MAP_PREFETCHER = undef;
		1519
		1520	sub find_async {
		1521	my ($path, $origin) = @_;
		1522
		1523	$path = normalise $path, $origin && $origin->{path};
		1524
		1525	if (my $map = $cf::MAP{$path}) {
		1526	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1527	}
		1528
		1529	undef $MAP_PREFETCH{$path};
		1530	$MAP_PREFETCHER ||= cf::async {
		1531	while (%MAP_PREFETCH) {
		1532	for my $path (keys %MAP_PREFETCH) {
		1533	my $map = find $path
		1534	or next;
		1535	$map->load;
		1536
		1537	delete $MAP_PREFETCH{$path};
		1538	}
		1539	}
		1540	undef $MAP_PREFETCHER;
		1541	};
		1542	$MAP_PREFETCHER->prio (6);
		1543
		1544	()
		1545	}
		1546
1298	sub save {	1547	sub save {
1299	my ($self) = @_;	1548	my ($self) = @_;
1300		1549
		1550	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1551
1301	$self->{last_save} = $cf::RUNTIME;	1552	$self->{last_save} = $cf::RUNTIME;
1302		1553
1303	return unless $self->dirty;	1554	return unless $self->dirty;
1304		1555
1305	my $save = $self->{path}->save_path; utf8::encode $save;	1556	my $save = $self->save_path; utf8::encode $save;
1306	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	1557	my $uniq = $self->uniq_path; utf8::encode $uniq;
1307		1558
1308	$self->{load_path} = $save;	1559	$self->{load_path} = $save;
1309		1560
1310	return if $self->{deny_save};	1561	return if $self->{deny_save};
1311		1562
1312	local $self->{last_access} = $self->last_access;#d#	1563	local $self->{last_access} = $self->last_access;#d#
1313		1564
		1565	cf::async {
		1566	$_->contr->save for $self->players;
		1567	};
		1568
1314	if ($uniq) {	1569	if ($uniq) {
1315	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	1570	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1316	$self->save_objects ($uniq, cf::IO_UNIQUES);	1571	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1317	} else {	1572	} else {
1318	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);	1573	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1319	}	1574	}
1320	}	1575	}
1321		1576
1322	sub swap_out {	1577	sub swap_out {
1323	my ($self) = @_;	1578	my ($self) = @_;
1324		1579
1325	# save first because save cedes	1580	# save first because save cedes
1326	$self->save;	1581	$self->save;
		1582
		1583	my $lock = cf::lock_acquire "map_data:" . $self->path;
1327		1584
1328	return if $self->players;	1585	return if $self->players;
1329	return if $self->in_memory != cf::MAP_IN_MEMORY;	1586	return if $self->in_memory != cf::MAP_IN_MEMORY;
1330	return if $self->{deny_save};	1587	return if $self->{deny_save};
1331		1588
…		…
1335		1592
1336	sub reset_at {	1593	sub reset_at {
1337	my ($self) = @_;	1594	my ($self) = @_;
1338		1595
1339	# TODO: safety, remove and allow resettable per-player maps	1596	# TODO: safety, remove and allow resettable per-player maps
1340	return 1e99 if $self->{path}{user_rel};	1597	return 1e99 if $self->isa ("ext::map_per_player");#d#
1341	return 1e99 if $self->{deny_reset};	1598	return 1e99 if $self->{deny_reset};
1342		1599
1343	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1600	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1344	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1601	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1345		1602
…		…
1350	my ($self) = @_;	1607	my ($self) = @_;
1351		1608
1352	$self->reset_at <= $cf::RUNTIME	1609	$self->reset_at <= $cf::RUNTIME
1353	}	1610	}
1354		1611
1355	sub unlink_save {
1356	my ($self) = @_;
1357
1358	utf8::encode (my $save = $self->{path}->save_path);
1359	aioreq_pri 3; IO::AIO::aio_unlink $save;
1360	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1361	}
1362
1363	sub rename {
1364	my ($self, $new_path) = @_;
1365
1366	$self->unlink_save;
1367
1368	delete $cf::MAP{$self->path};
1369	$self->{path} = new cf::path $new_path;
1370	$self->path ($self->{path}->as_string);
1371	$cf::MAP{$self->path} = $self;
1372
1373	$self->save;
1374	}
1375
1376	sub reset {	1612	sub reset {
1377	my ($self) = @_;	1613	my ($self) = @_;
1378		1614
		1615	my $lock = cf::lock_acquire "map_data:$self->{path}";
		1616
1379	return if $self->players;	1617	return if $self->players;
1380	return if $self->{path}{user_rel};#d#	1618	return if $self->isa ("ext::map_per_player");#d#
1381		1619
1382	warn "resetting map ", $self->path;#d#	1620	warn "resetting map ", $self->path;#d#
1383		1621
		1622	$self->in_memory (cf::MAP_SWAPPED);
		1623
		1624	# need to save uniques path
		1625	unless ($self->{deny_save}) {
		1626	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1627
		1628	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1629	if $uniq;
		1630	}
		1631
1384	delete $cf::MAP{$self->path};	1632	delete $cf::MAP{$self->path};
		1633
		1634	$self->clear;
1385		1635
1386	$_->clear_links_to ($self) for values %cf::MAP;	1636	$_->clear_links_to ($self) for values %cf::MAP;
1387		1637
1388	$self->unlink_save;	1638	$self->unlink_save;
1389	$self->destroy;	1639	$self->destroy;
…		…
1392	my $nuke_counter = "aaaa";	1642	my $nuke_counter = "aaaa";
1393		1643
1394	sub nuke {	1644	sub nuke {
1395	my ($self) = @_;	1645	my ($self) = @_;
1396		1646
		1647	delete $cf::MAP{$self->path};
		1648
		1649	$self->unlink_save;
		1650
		1651	bless $self, "cf::map";
		1652	delete $self->{deny_reset};
1397	$self->{deny_save} = 1;	1653	$self->{deny_save} = 1;
1398	$self->reset_timeout (1);	1654	$self->reset_timeout (1);
1399	$self->rename ("{nuke}/" . ($nuke_counter++));	1655	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		1656
		1657	$cf::MAP{$self->path} = $self;
		1658
1400	$self->reset; # polite request, might not happen	1659	$self->reset; # polite request, might not happen
1401	}	1660	}
1402		1661
1403	sub customise_for {	1662	=item cf::map::unique_maps
1404	my ($map, $ob) = @_;
1405		1663
1406	if ($map->per_player) {	1664	Returns an arrayref of paths of all shared maps that have
1407	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	1665	instantiated unique items. May block.
1408	}
1409		1666
1410	$map	1667	=cut
1411	}
1412		1668
1413	sub emergency_save {	1669	sub unique_maps() {
1414	my $freeze_guard = cf::freeze_mainloop;	1670	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
		1671	or return;
1415		1672
1416	warn "enter emergency map save\n";	1673	my @paths;
1417		1674
1418	cf::sync_job {	1675	for (@$files) {
1419	warn "begin emergency map save\n";	1676	utf8::decode $_;
1420	$_->save for values %cf::MAP;	1677	next if /\.pst$/;
		1678	next unless /^$PATH_SEP/o;
		1679
		1680	push @paths, cf::map::normalise $_;
1421	};	1681	}
1422		1682
1423	warn "end emergency map save\n";	1683	\@paths
1424	}	1684	}
1425		1685
1426	package cf;	1686	package cf;
1427		1687
1428	=back	1688	=back
1429		1689
		1690	=head3 cf::object
		1691
		1692	=cut
		1693
		1694	package cf::object;
		1695
		1696	=over 4
		1697
		1698	=item $ob->inv_recursive
		1699
		1700	Returns the inventory of the object _and_ their inventories, recursively.
		1701
		1702	=cut
		1703
		1704	sub inv_recursive_;
		1705	sub inv_recursive_ {
		1706	map { $_, inv_recursive_ $_->inv } @_
		1707	}
		1708
		1709	sub inv_recursive {
		1710	inv_recursive_ inv $_[0]
		1711	}
		1712
		1713	package cf;
		1714
		1715	=back
1430		1716
1431	=head3 cf::object::player	1717	=head3 cf::object::player
1432		1718
1433	=over 4	1719	=over 4
1434		1720
…		…
1474		1760
1475	=item $player_object->enter_link	1761	=item $player_object->enter_link
1476		1762
1477	Freezes the player and moves him/her to a special map (C<{link}>).	1763	Freezes the player and moves him/her to a special map (C<{link}>).
1478		1764
1479	The player should be reaosnably safe there for short amounts of time. You	1765	The player should be reasonably safe there for short amounts of time. You
1480	I<MUST> call C<leave_link> as soon as possible, though.	1766	I<MUST> call C<leave_link> as soon as possible, though.
1481		1767
		1768	Will never block.
		1769
1482	=item $player_object->leave_link ($map, $x, $y)	1770	=item $player_object->leave_link ($map, $x, $y)
1483		1771
1484	Moves the player out of the specila link map onto the given map. If the	1772	Moves the player out of the special C<{link}> map onto the specified
1485	map is not valid (or omitted), the player will be moved back to the	1773	map. If the map is not valid (or omitted), the player will be moved back
1486	location he/she was before the call to C<enter_link>, or, if that fails,	1774	to the location he/she was before the call to C<enter_link>, or, if that
1487	to the emergency map position.	1775	fails, to the emergency map position.
1488		1776
1489	Might block.	1777	Might block.
1490		1778
1491	=cut	1779	=cut
		1780
		1781	sub link_map {
		1782	unless ($LINK_MAP) {
		1783	$LINK_MAP = cf::map::find "{link}"
		1784	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		1785	$LINK_MAP->load;
		1786	}
		1787
		1788	$LINK_MAP
		1789	}
1492		1790
1493	sub cf::object::player::enter_link {	1791	sub cf::object::player::enter_link {
1494	my ($self) = @_;	1792	my ($self) = @_;
1495		1793
1496	$self->deactivate_recursive;	1794	$self->deactivate_recursive;
1497		1795
1498	return if $self->map == $LINK_MAP;	1796	return if UNIVERSAL::isa $self->map, "ext::map_link";
1499		1797
1500	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	1798	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1501	if $self->map;	1799	if $self->map;
1502		1800
1503	$self->enter_map ($LINK_MAP, 20, 20);	1801	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1504	}	1802	}
1505		1803
1506	sub cf::object::player::leave_link {	1804	sub cf::object::player::leave_link {
1507	my ($self, $map, $x, $y) = @_;	1805	my ($self, $map, $x, $y) = @_;
1508		1806
…		…
1526	# use -1 or undef as default coordinates, not 0, 0	1824	# use -1 or undef as default coordinates, not 0, 0
1527	($x, $y) = ($map->enter_x, $map->enter_y)	1825	($x, $y) = ($map->enter_x, $map->enter_y)
1528	if $x <=0 && $y <= 0;	1826	if $x <=0 && $y <= 0;
1529		1827
1530	$map->load;	1828	$map->load;
		1829	$map->load_diag;
1531		1830
		1831	return unless $self->contr->active;
1532	$self->activate_recursive;	1832	$self->activate_recursive;
		1833
		1834	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1533	$self->enter_map ($map, $x, $y);	1835	$self->enter_map ($map, $x, $y);
1534	}	1836	}
1535		1837
1536	cf::player->attach (	1838	cf::player->attach (
1537	on_logout => sub {	1839	on_logout => sub {
…		…
1549		1851
1550	# try to abort aborted map switching on player login :)	1852	# try to abort aborted map switching on player login :)
1551	# should happen only on crashes	1853	# should happen only on crashes
1552	if ($pl->ob->{_link_pos}) {	1854	if ($pl->ob->{_link_pos}) {
1553	$pl->ob->enter_link;	1855	$pl->ob->enter_link;
1554	cf::async {	1856	(async {
		1857	$pl->ob->reply (undef,
		1858	"There was an internal problem at your last logout, "
		1859	. "the server will try to bring you to your intended destination in a second.",
		1860	cf::NDI_RED);
1555	# we need this sleep as the login has a concurrent enter_exit running	1861	# we need this sleep as the login has a concurrent enter_exit running
1556	# and this sleep increases chances of the player not ending up in scorn	1862	# and this sleep increases chances of the player not ending up in scorn
1557	Coro::Timer::sleep 1;	1863	Coro::Timer::sleep 1;
1558	$pl->ob->leave_link;	1864	$pl->ob->leave_link;
1559	};	1865	})->prio (2);
1560	}	1866	}
1561	},	1867	},
1562	);	1868	);
1563		1869
1564	=item $player_object->goto_map ($path, $x, $y)	1870	=item $player_object->goto ($path, $x, $y)
1565		1871
1566	=cut	1872	=cut
1567		1873
1568	sub cf::object::player::goto_map {	1874	sub cf::object::player::goto {
1569	my ($self, $path, $x, $y) = @_;	1875	my ($self, $path, $x, $y) = @_;
1570		1876
1571	$self->enter_link;	1877	$self->enter_link;
1572		1878
1573	(cf::async {	1879	(async {
1574	$path = new cf::path $path;	1880	my $map = eval {
1575
1576	my $map = cf::map::find $path->as_string;	1881	my $map = cf::map::find $path;
1577	$map = $map->customise_for ($self) if $map;	1882	$map = $map->customise_for ($self) if $map;
1578		1883	$map
1579	# warn "entering ", $map->path, " at ($x, $y)\n"	1884	} or
1580	# if $map;
1581
1582	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);	1885	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1583		1886
1584	$self->leave_link ($map, $x, $y);	1887	$self->leave_link ($map, $x, $y);
1585	})->prio (1);	1888	})->prio (1);
1586	}	1889	}
1587		1890
…		…
1591		1894
1592	sub parse_random_map_params {	1895	sub parse_random_map_params {
1593	my ($spec) = @_;	1896	my ($spec) = @_;
1594		1897
1595	my $rmp = { # defaults	1898	my $rmp = { # defaults
1596	xsize => 10,	1899	xsize => (cf::rndm 15, 40),
1597	ysize => 10,	1900	ysize => (cf::rndm 15, 40),
		1901	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		1902	#layout => string,
1598	};	1903	};
1599		1904
1600	for (split /\n/, $spec) {	1905	for (split /\n/, $spec) {
1601	my ($k, $v) = split /\s+/, $_, 2;	1906	my ($k, $v) = split /\s+/, $_, 2;
1602		1907
…		…
1606	$rmp	1911	$rmp
1607	}	1912	}
1608		1913
1609	sub prepare_random_map {	1914	sub prepare_random_map {
1610	my ($exit) = @_;	1915	my ($exit) = @_;
		1916
		1917	my $guard = cf::lock_acquire "exit_prepare:$exit";
1611		1918
1612	# all this does is basically replace the /! path by	1919	# all this does is basically replace the /! path by
1613	# a new random map path (?random/...) with a seed	1920	# a new random map path (?random/...) with a seed
1614	# that depends on the exit object	1921	# that depends on the exit object
1615		1922
1616	my $rmp = parse_random_map_params $exit->msg;	1923	my $rmp = parse_random_map_params $exit->msg;
1617		1924
1618	if ($exit->map) {	1925	if ($exit->map) {
1619	$rmp->{region} = $exit->map->region_name;	1926	$rmp->{region} = $exit->region->name;
1620	$rmp->{origin_map} = $exit->map->path;	1927	$rmp->{origin_map} = $exit->map->path;
1621	$rmp->{origin_x} = $exit->x;	1928	$rmp->{origin_x} = $exit->x;
1622	$rmp->{origin_y} = $exit->y;	1929	$rmp->{origin_y} = $exit->y;
1623	}	1930	}
1624		1931
1625	$rmp->{random_seed} ||= $exit->random_seed;	1932	$rmp->{random_seed} ||= $exit->random_seed;
1626		1933
1627	my $data = cf::to_json $rmp;	1934	my $data = cf::to_json $rmp;
1628	my $md5 = Digest::MD5::md5_hex $data;	1935	my $md5 = Digest::MD5::md5_hex $data;
		1936	my $meta = "$cf::RANDOM_MAPS/$md5.meta";
1629		1937
1630	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	1938	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1631	aio_write $fh, 0, (length $data), $data, 0;	1939	aio_write $fh, 0, (length $data), $data, 0;
		1940	undef $fh;
		1941	aio_rename "$meta~", $meta;
1632		1942
1633	$exit->slaying ("?random/$md5");	1943	$exit->slaying ("?random/$md5");
1634	$exit->msg (undef);	1944	$exit->msg (undef);
1635	}	1945	}
1636	}	1946	}
…		…
1638	sub cf::object::player::enter_exit {	1948	sub cf::object::player::enter_exit {
1639	my ($self, $exit) = @_;	1949	my ($self, $exit) = @_;
1640		1950
1641	return unless $self->type == cf::PLAYER;	1951	return unless $self->type == cf::PLAYER;
1642		1952
		1953	if ($exit->slaying eq "/!") {
		1954	#TODO: this should de-fi-ni-te-ly not be a sync-job
		1955	cf::sync_job { prepare_random_map $exit };
		1956	}
		1957
		1958	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		1959	my $hp = $exit->stats->hp;
		1960	my $sp = $exit->stats->sp;
		1961
1643	$self->enter_link;	1962	$self->enter_link;
1644		1963
1645	(cf::async {	1964	(async {
1646	$self->deactivate_recursive; # just to be sure	1965	$self->deactivate_recursive; # just to be sure
1647	unless (eval {	1966	unless (eval {
1648	prepare_random_map $exit	1967	$self->goto ($slaying, $hp, $sp);
1649	if $exit->slaying eq "/!";
1650
1651	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1652	$self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1653		1968
1654	1;	1969	1;
1655	}) {	1970	}) {
1656	$self->message ("Something went wrong deep within the crossfire server. "	1971	$self->message ("Something went wrong deep within the crossfire server. "
1657	. "I'll try to bring you back to the map you were before. "	1972	. "I'll try to bring you back to the map you were before. "
1658	. "Please report this to the dungeon master",	1973	. "Please report this to the dungeon master!",
1659	cf::NDI_UNIQUE | cf::NDI_RED);	1974	cf::NDI_UNIQUE | cf::NDI_RED);
1660		1975
1661	warn "ERROR in enter_exit: $@";	1976	warn "ERROR in enter_exit: $@";
1662	$self->leave_link;	1977	$self->leave_link;
1663	}	1978	}
…		…
1718	# get handled first	2033	# get handled first
1719	my $queue = delete $ns->{query_queue}	2034	my $queue = delete $ns->{query_queue}
1720	or return; # be conservative, not sure how that can happen, but we saw a crash here	2035	or return; # be conservative, not sure how that can happen, but we saw a crash here
1721		2036
1722	(shift @$queue)->[1]->($msg);	2037	(shift @$queue)->[1]->($msg);
		2038	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1723		2039
1724	push @{ $ns->{query_queue} }, @$queue;	2040	push @{ $ns->{query_queue} }, @$queue;
1725		2041
1726	if (@{ $ns->{query_queue} } == @$queue) {	2042	if (@{ $ns->{query_queue} } == @$queue) {
1727	if (@$queue) {	2043	if (@$queue) {
…		…
1731	}	2047	}
1732	}	2048	}
1733	},	2049	},
1734	);	2050	);
1735		2051
1736	=item $client->coro (\&cb)	2052	=item $client->async (\&cb)
1737		2053
1738	Create a new coroutine, running the specified callback. The coroutine will	2054	Create a new coroutine, running the specified callback. The coroutine will
1739	be automatically cancelled when the client gets destroyed (e.g. on logout,	2055	be automatically cancelled when the client gets destroyed (e.g. on logout,
1740	or loss of connection).	2056	or loss of connection).
1741		2057
1742	=cut	2058	=cut
1743		2059
1744	sub cf::client::coro {	2060	sub cf::client::async {
1745	my ($self, $cb) = @_;	2061	my ($self, $cb) = @_;
1746		2062
1747	my $coro = &cf::async ($cb);	2063	my $coro = &Coro::async ($cb);
1748		2064
1749	$coro->on_destroy (sub {	2065	$coro->on_destroy (sub {
1750	delete $self->{_coro}{$coro+0};	2066	delete $self->{_coro}{$coro+0};
1751	});	2067	});
1752		2068
…		…
1888	The parameter C<$family> should best start with the name of the extension	2204	The parameter C<$family> should best start with the name of the extension
1889	using it, it should be unique.	2205	using it, it should be unique.
1890		2206
1891	=over 4	2207	=over 4
1892		2208
1893	=item $hashref = cf::db_get $family
1894
1895	Return a hashref for use by the extension C<$family>, which can be
1896	modified. After modifications, you have to call C<cf::db_dirty> or
1897	C<cf::db_sync>.
1898
1899	=item $value = cf::db_get $family => $key	2209	=item $value = cf::db_get $family => $key
1900		2210
1901	Returns a single value from the database	2211	Returns a single value from the database.
1902
1903	=item cf::db_put $family => $hashref
1904
1905	Stores the given family hashref into the database. Updates are delayed, if
1906	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1907		2212
1908	=item cf::db_put $family => $key => $value	2213	=item cf::db_put $family => $key => $value
1909		2214
1910	Stores the given C<$value> in the family hash. Updates are delayed, if you	2215	Stores the given C<$value> in the family.
1911	want the data to be synced to disk immediately, use C<cf::db_sync>.
1912
1913	=item cf::db_dirty
1914
1915	Marks the database as dirty, to be updated at a later time.
1916
1917	=item cf::db_sync
1918
1919	Immediately write the database to disk I<if it is dirty>.
1920		2216
1921	=cut	2217	=cut
1922		2218
1923	our $DB;	2219	our $DB;
1924		2220
1925	{	2221	sub db_init {
		2222	unless ($DB) {
		2223	$DB = BDB::db_create $DB_ENV;
		2224
		2225	cf::sync_job {
		2226	eval {
		2227	$DB->set_flags (BDB::CHKSUM);
		2228
		2229	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		2230	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		2231	cf::cleanup "db_open(db): $!" if $!;
		2232	};
		2233	cf::cleanup "db_open(db): $@" if $@;
		2234	};
		2235
1926	my $path = cf::localdir . "/database.pst";	2236	my $path = cf::localdir . "/database.pst";
		2237	if (stat $path) {
		2238	cf::sync_job {
		2239	my $pst = Storable::retrieve $path;
1927		2240
1928	sub db_load() {	2241	cf::db_put (board => data => $pst->{board});
1929	$DB = stat $path ? Storable::retrieve $path : { };	2242	cf::db_put (guildrules => data => $pst->{guildrules});
1930	}	2243	cf::db_put (rent => balance => $pst->{rent}{balance});
		2244	BDB::db_env_txn_checkpoint $DB_ENV;
1931		2245
1932	my $pid;	2246	unlink $path;
1933
1934	sub db_save() {
1935	waitpid $pid, 0 if $pid;
1936	if (0 == ($pid = fork)) {
1937	$DB->{_meta}{version} = 1;
1938	Storable::nstore $DB, "$path~";
1939	rename "$path~", $path;
1940	cf::_exit 0 if defined $pid;
1941	}	2247	};
1942	}
1943
1944	my $dirty;
1945
1946	sub db_sync() {
1947	db_save if $dirty;
1948	undef $dirty;
1949	}
1950
1951	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1952	db_sync;
1953	});
1954
1955	sub db_dirty() {
1956	$dirty = 1;
1957	$idle->start;
1958	}
1959
1960	sub db_get($;$) {
1961	@_ >= 2
1962	? $DB->{$_[0]}{$_[1]}
1963	: ($DB->{$_[0]} ||= { })
1964	}
1965
1966	sub db_put($$;$) {
1967	if (@_ >= 3) {
1968	$DB->{$_[0]}{$_[1]} = $_[2];
1969	} else {
1970	$DB->{$_[0]} = $_[1];
1971	}
1972	db_dirty;
1973	}
1974
1975	cf::global->attach (
1976	prio => 10000,
1977	on_cleanup => sub {
1978	db_sync;
1979	},	2248	}
1980	);	2249	}
		2250	}
		2251
		2252	sub db_get($$) {
		2253	my $key = "$_[0]/$_[1]";
		2254
		2255	cf::sync_job {
		2256	BDB::db_get $DB, undef, $key, my $data;
		2257
		2258	$! ? ()
		2259	: Compress::LZF::sthaw $data
		2260	}
		2261	}
		2262
		2263	sub db_put($$$) {
		2264	BDB::dbreq_pri 4;
		2265	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
1981	}	2266	}
1982		2267
1983	#############################################################################	2268	#############################################################################
1984	# the server's main()	2269	# the server's init and main functions
		2270
		2271	sub init_resources {
		2272	load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir
		2273	or die "unable to load regions file\n";#d#
		2274	}
1985		2275
1986	sub cfg_load {	2276	sub cfg_load {
1987	open my $fh, "<:utf8", cf::confdir . "/config"	2277	open my $fh, "<:utf8", cf::confdir . "/config"
1988	or return;	2278	or return;
1989		2279
1990	local $/;	2280	local $/;
1991	*CFG = YAML::Syck::Load <$fh>;	2281	*CFG = YAML::Syck::Load <$fh>;
1992		2282
1993	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	2283	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
1994		2284
		2285	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2286	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2287
1995	if (exists $CFG{mlockall}) {	2288	if (exists $CFG{mlockall}) {
1996	eval {	2289	eval {
1997	$CFG{mlockall} ? &mlockall : &munlockall	2290	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
1998	and die "WARNING: m(un)lockall failed: $!\n";	2291	and die "WARNING: m(un)lockall failed: $!\n";
1999	};	2292	};
2000	warn $@ if $@;	2293	warn $@ if $@;
2001	}	2294	}
		2295	}
		2296
		2297	sub init {
		2298	init_resources;
2002	}	2299	}
2003		2300
2004	sub main {	2301	sub main {
2005	# we must not ever block the main coroutine	2302	# we must not ever block the main coroutine
2006	local $Coro::idle = sub {	2303	local $Coro::idle = sub {
2007	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	2304	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2008	(Coro::unblock_sub {	2305	(async {
2009	Event::one_event;	2306	Event::one_event;
2010	})->();	2307	})->prio (Coro::PRIO_MAX);
2011	};	2308	};
2012		2309
2013	cfg_load;	2310	cfg_load;
2014	db_load;	2311	db_init;
2015	load_extensions;	2312	load_extensions;
		2313
		2314	$TICK_WATCHER->start;
2016	Event::loop;	2315	Event::loop;
2017	}	2316	}
2018		2317
2019	#############################################################################	2318	#############################################################################
2020	# initialisation	2319	# initialisation and cleanup
		2320
		2321	# install some emergency cleanup handlers
		2322	BEGIN {
		2323	for my $signal (qw(INT HUP TERM)) {
		2324	Event->signal (
		2325	reentrant => 0,
		2326	data => WF_AUTOCANCEL,
		2327	signal => $signal,
		2328	prio => 0,
		2329	cb => sub {
		2330	cf::cleanup "SIG$signal";
		2331	},
		2332	);
		2333	}
		2334	}
		2335
		2336	sub emergency_save() {
		2337	my $freeze_guard = cf::freeze_mainloop;
		2338
		2339	warn "enter emergency perl save\n";
		2340
		2341	cf::sync_job {
		2342	# use a peculiar iteration method to avoid tripping on perl
		2343	# refcount bugs in for. also avoids problems with players
		2344	# and maps saved/destroyed asynchronously.
		2345	warn "begin emergency player save\n";
		2346	for my $login (keys %cf::PLAYER) {
		2347	my $pl = $cf::PLAYER{$login} or next;
		2348	$pl->valid or next;
		2349	$pl->save;
		2350	}
		2351	warn "end emergency player save\n";
		2352
		2353	warn "begin emergency map save\n";
		2354	for my $path (keys %cf::MAP) {
		2355	my $map = $cf::MAP{$path} or next;
		2356	$map->valid or next;
		2357	$map->save;
		2358	}
		2359	warn "end emergency map save\n";
		2360
		2361	warn "begin emergency database checkpoint\n";
		2362	BDB::db_env_txn_checkpoint $DB_ENV;
		2363	warn "end emergency database checkpoint\n";
		2364	};
		2365
		2366	warn "leave emergency perl save\n";
		2367	}
		2368
		2369	sub post_cleanup {
		2370	my ($make_core) = @_;
		2371
		2372	warn Carp::longmess "post_cleanup backtrace"
		2373	if $make_core;
		2374	}
2021		2375
2022	sub reload() {	2376	sub reload() {
2023	# can/must only be called in main	2377	# can/must only be called in main
2024	if ($Coro::current != $Coro::main) {	2378	if ($Coro::current != $Coro::main) {
2025	warn "can only reload from main coroutine\n";	2379	warn "can only reload from main coroutine";
2026	return;	2380	return;
2027	}	2381	}
2028		2382
2029	warn "reloading...";	2383	warn "reloading...";
2030		2384
2031	my $guard = freeze_mainloop;	2385	warn "entering sync_job";
		2386
		2387	cf::sync_job {
		2388	cf::write_runtime; # external watchdog should not bark
2032	cf::emergency_save;	2389	cf::emergency_save;
		2390	cf::write_runtime; # external watchdog should not bark
2033		2391
2034	eval {	2392	warn "syncing database to disk";
		2393	BDB::db_env_txn_checkpoint $DB_ENV;
		2394
2035	# if anything goes wrong in here, we should simply crash as we already saved	2395	# if anything goes wrong in here, we should simply crash as we already saved
2036		2396
2037	# cancel all watchers	2397	warn "cancelling all WF_AUTOCANCEL watchers";
2038	for (Event::all_watchers) {	2398	for (Event::all_watchers) {
2039	$_->cancel if $_->data & WF_AUTOCANCEL;	2399	$_->cancel if $_->data & WF_AUTOCANCEL;
2040	}	2400	}
2041		2401
		2402	warn "flushing outstanding aio requests";
		2403	for (;;) {
		2404	BDB::flush;
		2405	IO::AIO::flush;
		2406	Coro::cede;
		2407	last unless IO::AIO::nreqs || BDB::nreqs;
		2408	warn "iterate...";
		2409	}
		2410
2042	# cancel all extension coros	2411	warn "cancelling all extension coros";
2043	$_->cancel for values %EXT_CORO;	2412	$_->cancel for values %EXT_CORO;
2044	%EXT_CORO = ();	2413	%EXT_CORO = ();
2045		2414
2046	# unload all extensions	2415	warn "removing commands";
2047	for (@exts) {	2416	%COMMAND = ();
		2417
		2418	warn "removing ext commands";
		2419	%EXTCMD = ();
		2420
		2421	warn "unloading/nuking all extensions";
		2422	for my $pkg (@EXTS) {
2048	warn "unloading <$_>";	2423	warn "... unloading $pkg";
2049	unload_extension $_;	2424
		2425	if (my $cb = $pkg->can ("unload")) {
		2426	eval {
		2427	$cb->($pkg);
		2428	1
		2429	} or warn "$pkg unloaded, but with errors: $@";
2050	}	2430	}
2051		2431
		2432	warn "... nuking $pkg";
		2433	Symbol::delete_package $pkg;
		2434	}
		2435
2052	# unload all modules loaded from $LIBDIR	2436	warn "unloading all perl modules loaded from $LIBDIR";
2053	while (my ($k, $v) = each %INC) {	2437	while (my ($k, $v) = each %INC) {
2054	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2438	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2055		2439
2056	warn "removing <$k>";	2440	warn "... unloading $k";
2057	delete $INC{$k};	2441	delete $INC{$k};
2058		2442
2059	$k =~ s/\.pm$//;	2443	$k =~ s/\.pm$//;
2060	$k =~ s/\//::/g;	2444	$k =~ s/\//::/g;
2061		2445
…		…
2064	}	2448	}
2065		2449
2066	Symbol::delete_package $k;	2450	Symbol::delete_package $k;
2067	}	2451	}
2068		2452
2069	# sync database to disk
2070	cf::db_sync;
2071	IO::AIO::flush;
2072
2073	# get rid of safe::, as good as possible	2453	warn "getting rid of safe::, as good as possible";
2074	Symbol::delete_package "safe::$_"	2454	Symbol::delete_package "safe::$_"
2075	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2455	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2076		2456
2077	# remove register_script_function callbacks
2078	# TODO
2079
2080	# unload cf.pm "a bit"	2457	warn "unloading cf.pm \"a bit\"";
2081	delete $INC{"cf.pm"};	2458	delete $INC{"cf.pm"};
2082		2459
2083	# don't, removes xs symbols, too,	2460	# don't, removes xs symbols, too,
2084	# and global variables created in xs	2461	# and global variables created in xs
2085	#Symbol::delete_package __PACKAGE__;	2462	#Symbol::delete_package __PACKAGE__;
2086		2463
2087	# reload cf.pm	2464	warn "unload completed, starting to reload now";
		2465
2088	warn "reloading cf.pm";	2466	warn "reloading cf.pm";
2089	require cf;	2467	require cf;
2090	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	2468	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2091		2469
2092	# load config and database again	2470	warn "loading config and database again";
2093	cf::cfg_load;	2471	cf::cfg_load;
2094	cf::db_load;
2095		2472
2096	# load extensions
2097	warn "load extensions";	2473	warn "loading extensions";
2098	cf::load_extensions;	2474	cf::load_extensions;
2099		2475
2100	# reattach attachments to objects	2476	warn "reattaching attachments to objects/players";
2101	warn "reattach";	2477	_global_reattach; # objects, sockets
2102	_global_reattach;	2478	warn "reattaching attachments to maps";
2103	};	2479	reattach $_ for values %MAP;
		2480	warn "reattaching attachments to players";
		2481	reattach $_ for values %PLAYER;
2104		2482
2105	if ($@) {	2483	warn "loading reloadable resources";
		2484	init_resources;
		2485
		2486	warn "leaving sync_job";
		2487
		2488	1
		2489	} or do {
2106	warn $@;	2490	warn $@;
2107	warn "error while reloading, exiting.";	2491	warn "error while reloading, exiting.";
2108	exit 1;	2492	exit 1;
2109	}	2493	};
2110		2494
2111	warn "reloaded successfully";	2495	warn "reloaded";
2112	};	2496	};
2113		2497
2114	#############################################################################	2498	our $RELOAD_WATCHER; # used only during reload
2115
2116	unless ($LINK_MAP) {
2117	$LINK_MAP = cf::map::new;
2118
2119	$LINK_MAP->width (41);
2120	$LINK_MAP->height (41);
2121	$LINK_MAP->alloc;
2122	$LINK_MAP->path ("{link}");
2123	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2124	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2125
2126	# dirty hack because... archetypes are not yet loaded
2127	Event->timer (
2128	after => 2,
2129	cb => sub {
2130	$_[0]->w->cancel;
2131
2132	# provide some exits "home"
2133	my $exit = cf::object::new "exit";
2134
2135	$exit->slaying ($EMERGENCY_POSITION->[0]);
2136	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2137	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2138
2139	$LINK_MAP->insert ($exit->clone, 19, 19);
2140	$LINK_MAP->insert ($exit->clone, 19, 20);
2141	$LINK_MAP->insert ($exit->clone, 19, 21);
2142	$LINK_MAP->insert ($exit->clone, 20, 19);
2143	$LINK_MAP->insert ($exit->clone, 20, 21);
2144	$LINK_MAP->insert ($exit->clone, 21, 19);
2145	$LINK_MAP->insert ($exit->clone, 21, 20);
2146	$LINK_MAP->insert ($exit->clone, 21, 21);
2147
2148	$exit->destroy;
2149	});
2150
2151	$LINK_MAP->{deny_save} = 1;
2152	$LINK_MAP->{deny_reset} = 1;
2153
2154	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2155	}
2156
2157	register "<global>", __PACKAGE__;
2158		2499
2159	register_command "reload" => sub {	2500	register_command "reload" => sub {
2160	my ($who, $arg) = @_;	2501	my ($who, $arg) = @_;
2161		2502
2162	if ($who->flag (FLAG_WIZ)) {	2503	if ($who->flag (FLAG_WIZ)) {
2163	$who->message ("start of reload.");	2504	$who->message ("reloading server.");
		2505
		2506	# doing reload synchronously and two reloads happen back-to-back,
		2507	# coro crashes during coro_state_free->destroy here.
		2508
		2509	$RELOAD_WATCHER ||= Event->timer (
		2510	reentrant => 0,
		2511	after => 0,
		2512	data => WF_AUTOCANCEL,
		2513	cb => sub {
2164	reload;	2514	reload;
2165	$who->message ("end of reload.");	2515	undef $RELOAD_WATCHER;
		2516	},
		2517	);
2166	}	2518	}
2167	};	2519	};
2168		2520
2169	unshift @INC, $LIBDIR;	2521	unshift @INC, $LIBDIR;
		2522
		2523	my $bug_warning = 0;
2170		2524
2171	$TICK_WATCHER = Event->timer (	2525	$TICK_WATCHER = Event->timer (
2172	reentrant => 0,	2526	reentrant => 0,
		2527	parked => 1,
2173	prio => 0,	2528	prio => 0,
2174	at => $NEXT_TICK || $TICK,	2529	at => $NEXT_TICK || $TICK,
2175	data => WF_AUTOCANCEL,	2530	data => WF_AUTOCANCEL,
2176	cb => sub {	2531	cb => sub {
		2532	if ($Coro::current != $Coro::main) {
		2533	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		2534	unless ++$bug_warning > 10;
		2535	return;
		2536	}
		2537
		2538	$NOW = Event::time;
		2539
2177	cf::server_tick; # one server iteration	2540	cf::server_tick; # one server iteration
2178	$RUNTIME += $TICK;	2541	$RUNTIME += $TICK;
2179	$NEXT_TICK += $TICK;	2542	$NEXT_TICK += $TICK;
		2543
		2544	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		2545	$NEXT_RUNTIME_WRITE = $NOW + 10;
		2546	Coro::async_pool {
		2547	write_runtime
		2548	or warn "ERROR: unable to write runtime file: $!";
		2549	};
		2550	}
		2551
		2552	$WAIT_FOR_TICK->broadcast;
		2553	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
		2554
		2555	# my $AFTER = Event::time;
		2556	# warn $AFTER - $NOW;#d#
2180		2557
2181	# if we are delayed by four ticks or more, skip them all	2558	# if we are delayed by four ticks or more, skip them all
2182	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	2559	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2183		2560
2184	$TICK_WATCHER->at ($NEXT_TICK);	2561	$TICK_WATCHER->at ($NEXT_TICK);
2185	$TICK_WATCHER->start;	2562	$TICK_WATCHER->start;
2186	},	2563	},
2187	);	2564	);
2188		2565
		2566	{
2189	IO::AIO::max_poll_time $TICK * 0.2;	2567	BDB::max_poll_time $TICK * 0.1;
2190		2568	$BDB_POLL_WATCHER = Event->io (
2191	Event->io (	2569	reentrant => 0,
2192	fd => IO::AIO::poll_fileno,	2570	fd => BDB::poll_fileno,
2193	poll => 'r',	2571	poll => 'r',
2194	prio => 5,	2572	prio => 0,
2195	data => WF_AUTOCANCEL,
2196	cb => \&IO::AIO::poll_cb,
2197	);
2198
2199	Event->timer (
2200	data => WF_AUTOCANCEL,	2573	data => WF_AUTOCANCEL,
2201	after => 0,	2574	cb => \&BDB::poll_cb,
2202	interval => 10,	2575	);
2203	cb => sub {	2576	BDB::min_parallel 8;
2204	(Coro::unblock_sub {	2577
2205	write_runtime	2578	BDB::set_sync_prepare {
2206	or warn "ERROR: unable to write runtime file: $!";	2579	my $status;
		2580	my $current = $Coro::current;
		2581	(
		2582	sub {
		2583	$status = $!;
		2584	$current->ready; undef $current;
		2585	},
		2586	sub {
		2587	Coro::schedule while defined $current;
		2588	$! = $status;
		2589	},
		2590	)
		2591	};
		2592
		2593	unless ($DB_ENV) {
		2594	$DB_ENV = BDB::db_env_create;
		2595
		2596	cf::sync_job {
		2597	eval {
		2598	BDB::db_env_open
		2599	$DB_ENV,
		2600	$BDB_ENV_DIR,
		2601	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		2602	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		2603	0666;
		2604
		2605	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;
		2606
		2607	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		2608	$DB_ENV->set_lk_detect;
		2609	};
		2610
		2611	cf::cleanup "db_env_open(db): $@" if $@;
2207	})->();	2612	};
2208	},	2613	}
2209	);	2614	}
		2615
		2616	{
		2617	IO::AIO::min_parallel 8;
		2618
		2619	undef $Coro::AIO::WATCHER;
		2620	IO::AIO::max_poll_time $TICK * 0.1;
		2621	$AIO_POLL_WATCHER = Event->io (
		2622	reentrant => 0,
		2623	data => WF_AUTOCANCEL,
		2624	fd => IO::AIO::poll_fileno,
		2625	poll => 'r',
		2626	prio => 6,
		2627	cb => \&IO::AIO::poll_cb,
		2628	);
		2629	}
2210		2630
2211	END { cf::emergency_save }	2631	END { cf::emergency_save }
2212		2632
2213	1	2633	1
2214		2634

Diff Legend

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