ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/cf.schmorp.de/server/lib/cf.pm

Comparing cf.schmorp.de/server/lib/cf.pm (file contents):
Revision 1.101 by root, Mon Dec 25 14:43:23 2006 UTC vs.
Revision 1.168 by root, Sun Jan 14 00:37:14 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;	13	use Coro 3.3 ();
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		19
		20	use Data::Dumper;
		21	use Digest::MD5;
		22	use Fcntl;
19	use IO::AIO 2.3;	23	use IO::AIO 2.32 ();
20	use YAML::Syck ();	24	use YAML::Syck ();
21	use Time::HiRes;	25	use Time::HiRes;
22		26
23	use Event; $Event::Eval = 1; # no idea why this is required, but it is	27	use Event; $Event::Eval = 1; # no idea why this is required, but it is
24		28
		29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		30
25	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
26	$YAML::Syck::ImplicitUnicode = 1;	32	$YAML::Syck::ImplicitUnicode = 1;
27		33
28	$Coro::main->prio (Coro::PRIO_MIN);	34	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
29
30	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
31		35
32	our %COMMAND = ();	36	our %COMMAND = ();
33	our %COMMAND_TIME = ();	37	our %COMMAND_TIME = ();
		38
		39	our @EXTS = (); # list of extension package names
34	our %EXTCMD = ();	40	our %EXTCMD = ();
		41	our %EXT_CORO = (); # coroutines bound to extensions
		42	our %EXT_MAP = (); # pluggable maps
35		43
36	our @EVENT;	44	our @EVENT;
37	our $LIBDIR = datadir . "/ext";	45	our $LIBDIR = datadir . "/ext";
38		46
39	our $TICK = MAX_TIME * 1e-6;	47	our $TICK = MAX_TIME * 1e-6;
40	our $TICK_WATCHER;	48	our $TICK_WATCHER;
		49	our $AIO_POLL_WATCHER;
		50	our $WRITE_RUNTIME_WATCHER;
41	our $NEXT_TICK;	51	our $NEXT_TICK;
		52	our $NOW;
42		53
43	our %CFG;	54	our %CFG;
44		55
45	our $UPTIME; $UPTIME ||= time;	56	our $UPTIME; $UPTIME ||= time;
		57	our $RUNTIME;
		58
		59	our %PLAYER; # all users
		60	our %MAP; # all maps
		61	our $LINK_MAP; # the special {link} map, which is always available
		62	our $RANDOM_MAPS = cf::localdir . "/random";
		63
		64	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
		65	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
		66
		67	# used to convert map paths into valid unix filenames by replacing / by ∕
		68	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		69
		70	binmode STDOUT;
		71	binmode STDERR;
		72
		73	# read virtual server time, if available
		74	unless ($RUNTIME || !-e cf::localdir . "/runtime") {
		75	open my $fh, "<", cf::localdir . "/runtime"
		76	or die "unable to read runtime file: $!";
		77	$RUNTIME = <$fh> + 0.;
		78	}
		79
		80	mkdir cf::localdir;
		81	mkdir cf::localdir . "/" . cf::playerdir;
		82	mkdir cf::localdir . "/" . cf::tmpdir;
		83	mkdir cf::localdir . "/" . cf::uniquedir;
		84	mkdir $RANDOM_MAPS;
		85
		86	our $EMERGENCY_POSITION;
46		87
47	#############################################################################	88	#############################################################################
48		89
49	=head2 GLOBAL VARIABLES	90	=head2 GLOBAL VARIABLES
50		91
51	=over 4	92	=over 4
52		93
53	=item $cf::UPTIME	94	=item $cf::UPTIME
54		95
55	The timestamp of the server start (so not actually an uptime).	96	The timestamp of the server start (so not actually an uptime).
		97
		98	=item $cf::RUNTIME
		99
		100	The time this server has run, starts at 0 and is increased by $cf::TICK on
		101	every server tick.
56		102
57	=item $cf::LIBDIR	103	=item $cf::LIBDIR
58		104
59	The perl library directory, where extensions and cf-specific modules can	105	The perl library directory, where extensions and cf-specific modules can
60	be found. It will be added to C<@INC> automatically.	106	be found. It will be added to C<@INC> automatically.
61		107
		108	=item $cf::NOW
		109
		110	The time of the last (current) server tick.
		111
62	=item $cf::TICK	112	=item $cf::TICK
63		113
64	The interval between server ticks, in seconds.	114	The interval between server ticks, in seconds.
65		115
66	=item %cf::CFG	116	=item %cf::CFG
67		117
68	Configuration for the server, loaded from C</etc/crossfire/config>, or	118	Configuration for the server, loaded from C</etc/crossfire/config>, or
69	from wherever your confdir points to.	119	from wherever your confdir points to.
		120
		121	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
		122
		123	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
		124	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
		125	processing has been done. Call C<< ->wait >> on them to maximise the
		126	window of cpu time available, or simply to synchronise to the server tick.
70		127
71	=back	128	=back
72		129
73	=cut	130	=cut
74		131
75	BEGIN {	132	BEGIN {
76	*CORE::GLOBAL::warn = sub {	133	*CORE::GLOBAL::warn = sub {
77	my $msg = join "", @_;	134	my $msg = join "", @_;
		135	utf8::encode $msg;
		136
78	$msg .= "\n"	137	$msg .= "\n"
79	unless $msg =~ /\n$/;	138	unless $msg =~ /\n$/;
80		139
81	print STDERR "cfperl: $msg";
82	LOG llevError, "cfperl: $msg";	140	LOG llevError, $msg;
83	};	141	};
84	}	142	}
85		143
86	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	144	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
87	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	145	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
…		…
105		163
106	$Event::DIED = sub {	164	$Event::DIED = sub {
107	warn "error in event callback: @_";	165	warn "error in event callback: @_";
108	};	166	};
109		167
110	my %ext_pkg;
111	my @exts;
112	my @hook;
113
114	=head2 UTILITY FUNCTIONS	168	=head2 UTILITY FUNCTIONS
115		169
116	=over 4	170	=over 4
117		171
		172	=item dumpval $ref
		173
118	=cut	174	=cut
		175
		176	sub dumpval {
		177	eval {
		178	local $SIG{__DIE__};
		179	my $d;
		180	if (1) {
		181	$d = new Data::Dumper([$_[0]], ["*var"]);
		182	$d->Terse(1);
		183	$d->Indent(2);
		184	$d->Quotekeys(0);
		185	$d->Useqq(1);
		186	#$d->Bless(...);
		187	$d->Seen($_[1]) if @_ > 1;
		188	$d = $d->Dump();
		189	}
		190	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		191	$d
		192	} || "[unable to dump $_[0]: '$@']";
		193	}
119		194
120	use JSON::Syck (); # TODO# replace by JSON::PC once working	195	use JSON::Syck (); # TODO# replace by JSON::PC once working
121		196
122	=item $ref = cf::from_json $json	197	=item $ref = cf::from_json $json
123		198
…		…
137	=cut	212	=cut
138		213
139	sub to_json($) {	214	sub to_json($) {
140	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	215	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
141	JSON::Syck::Dump $_[0]	216	JSON::Syck::Dump $_[0]
		217	}
		218
		219	=item cf::lock_wait $string
		220
		221	Wait until the given lock is available. See cf::lock_acquire.
		222
		223	=item my $lock = cf::lock_acquire $string
		224
		225	Wait until the given lock is available and then acquires it and returns
		226	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
		227	for example when the coroutine gets canceled), the lock is automatically
		228	returned.
		229
		230	Lock names should begin with a unique identifier (for example, cf::map::find
		231	uses map_find and cf::map::load uses map_load).
		232
		233	=cut
		234
		235	our %LOCK;
		236
		237	sub lock_wait($) {
		238	my ($key) = @_;
		239
		240	# wait for lock, if any
		241	while ($LOCK{$key}) {
		242	push @{ $LOCK{$key} }, $Coro::current;
		243	Coro::schedule;
		244	}
		245	}
		246
		247	sub lock_acquire($) {
		248	my ($key) = @_;
		249
		250	# wait, to be sure we are not locked
		251	lock_wait $key;
		252
		253	$LOCK{$key} = [];
		254
		255	Coro::guard {
		256	# wake up all waiters, to be on the safe side
		257	$_->ready for @{ delete $LOCK{$key} };
		258	}
		259	}
		260
		261	sub freeze_mainloop {
		262	return unless $TICK_WATCHER->is_active;
		263
		264	my $guard = Coro::guard {
		265	$TICK_WATCHER->start;
		266	$WRITE_RUNTIME_WATCHER->start;
		267	};
		268	$WRITE_RUNTIME_WATCHER->stop;
		269	$TICK_WATCHER->stop;
		270	$guard
		271	}
		272
		273	=item cf::async { BLOCK }
		274
		275	Currently the same as Coro::async_pool, meaning you cannot use
		276	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		277	thing you are allowed to do is call C<prio> on it.
		278
		279	=cut
		280
		281	BEGIN { *async = \&Coro::async_pool }
		282
		283	=item cf::sync_job { BLOCK }
		284
		285	The design of crossfire+ requires that the main coro ($Coro::main) is
		286	always able to handle events or runnable, as crossfire+ is only partly
		287	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
		288
		289	If it must be done, put the blocking parts into C<sync_job>. This will run
		290	the given BLOCK in another coroutine while waiting for the result. The
		291	server will be frozen during this time, so the block should either finish
		292	fast or be very important.
		293
		294	=cut
		295
		296	sub sync_job(&) {
		297	my ($job) = @_;
		298
		299	if ($Coro::current == $Coro::main) {
		300	# this is the main coro, too bad, we have to block
		301	# till the operation succeeds, freezing the server :/
		302
		303	# TODO: use suspend/resume instead
		304	# (but this is cancel-safe)
		305	my $freeze_guard = freeze_mainloop;
		306
		307	my $busy = 1;
		308	my @res;
		309
		310	(async {
		311	@res = eval { $job->() };
		312	warn $@ if $@;
		313	undef $busy;
		314	})->prio (Coro::PRIO_MAX);
		315
		316	while ($busy) {
		317	Coro::cede or Event::one_event;
		318	}
		319
		320	wantarray ? @res : $res[0]
		321	} else {
		322	# we are in another coroutine, how wonderful, everything just works
		323
		324	$job->()
		325	}
		326	}
		327
		328	=item $coro = cf::async_ext { BLOCK }
		329
		330	Like async, but this coro is automatically being canceled when the
		331	extension calling this is being unloaded.
		332
		333	=cut
		334
		335	sub async_ext(&) {
		336	my $cb = shift;
		337
		338	my $coro = &Coro::async ($cb);
		339
		340	$coro->on_destroy (sub {
		341	delete $EXT_CORO{$coro+0};
		342	});
		343	$EXT_CORO{$coro+0} = $coro;
		344
		345	$coro
		346	}
		347
		348	sub write_runtime {
		349	my $runtime = cf::localdir . "/runtime";
		350
		351	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		352	or return;
		353
		354	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock
		355	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		356	and return;
		357
		358	aio_fsync $fh
		359	and return;
		360
		361	close $fh
		362	or return;
		363
		364	aio_rename "$runtime~", $runtime
		365	and return;
		366
		367	1
142	}	368	}
143		369
144	=back	370	=back
145		371
146	=cut	372	=cut
…		…
454	=cut	680	=cut
455		681
456	#############################################################################	682	#############################################################################
457	# object support	683	# object support
458		684
		685	sub reattach {
		686	# basically do the same as instantiate, without calling instantiate
		687	my ($obj) = @_;
		688
		689	my $registry = $obj->registry;
		690
		691	@$registry = ();
		692
		693	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
		694
		695	for my $name (keys %{ $obj->{_attachment} || {} }) {
		696	if (my $attach = $attachment{$name}) {
		697	for (@$attach) {
		698	my ($klass, @attach) = @$_;
		699	_attach $registry, $klass, @attach;
		700	}
		701	} else {
		702	warn "object uses attachment '$name' that is not available, postponing.\n";
		703	}
		704	}
		705	}
		706
459	cf::attachable->attach (	707	cf::attachable->attach (
460	prio => -1000000,	708	prio => -1000000,
461	on_instantiate => sub {	709	on_instantiate => sub {
462	my ($obj, $data) = @_;	710	my ($obj, $data) = @_;
463		711
…		…
467	my ($name, $args) = @$_;	715	my ($name, $args) = @$_;
468		716
469	$obj->attach ($name, %{$args || {} });	717	$obj->attach ($name, %{$args || {} });
470	}	718	}
471	},	719	},
472	on_reattach => sub {	720	on_reattach => \&reattach,
473	# basically do the same as instantiate, without calling instantiate
474	my ($obj) = @_;
475	my $registry = $obj->registry;
476
477	@$registry = ();
478
479	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
480
481	for my $name (keys %{ $obj->{_attachment} || {} }) {
482	if (my $attach = $attachment{$name}) {
483	for (@$attach) {
484	my ($klass, @attach) = @$_;
485	_attach $registry, $klass, @attach;
486	}
487	} else {
488	warn "object uses attachment '$name' that is not available, postponing.\n";
489	}
490	}
491	},
492	on_clone => sub {	721	on_clone => sub {
493	my ($src, $dst) = @_;	722	my ($src, $dst) = @_;
494		723
495	@{$dst->registry} = @{$src->registry};	724	@{$dst->registry} = @{$src->registry};
496		725
…		…
502	);	731	);
503		732
504	sub object_freezer_save {	733	sub object_freezer_save {
505	my ($filename, $rdata, $objs) = @_;	734	my ($filename, $rdata, $objs) = @_;
506		735
		736	sync_job {
507	if (length $$rdata) {	737	if (length $$rdata) {
508	warn sprintf "saving %s (%d,%d)\n",	738	warn sprintf "saving %s (%d,%d)\n",
509	$filename, length $$rdata, scalar @$objs;	739	$filename, length $$rdata, scalar @$objs;
510		740
511	if (open my $fh, ">:raw", "$filename~") {	741	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
512	chmod SAVE_MODE, $fh;
513	syswrite $fh, $$rdata;
514	close $fh;
515
516	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
517	chmod SAVE_MODE, $fh;	742	chmod SAVE_MODE, $fh;
518	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };	743	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		744	aio_fsync $fh;
519	close $fh;	745	close $fh;
		746
		747	if (@$objs) {
		748	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		749	chmod SAVE_MODE, $fh;
		750	my $data = Storable::nfreeze { version => 1, objs => $objs };
		751	aio_write $fh, 0, (length $data), $data, 0;
		752	aio_fsync $fh;
		753	close $fh;
520	rename "$filename.pst~", "$filename.pst";	754	aio_rename "$filename.pst~", "$filename.pst";
		755	}
		756	} else {
		757	aio_unlink "$filename.pst";
		758	}
		759
		760	aio_rename "$filename~", $filename;
521	} else {	761	} else {
522	unlink "$filename.pst";	762	warn "FATAL: $filename~: $!\n";
523	}	763	}
524
525	rename "$filename~", $filename;
526	} else {	764	} else {
527	warn "FATAL: $filename~: $!\n";
528	}
529	} else {
530	unlink $filename;	765	aio_unlink $filename;
531	unlink "$filename.pst";	766	aio_unlink "$filename.pst";
		767	}
532	}	768	}
533	}	769	}
534		770
535	sub object_freezer_as_string {	771	sub object_freezer_as_string {
536	my ($rdata, $objs) = @_;	772	my ($rdata, $objs) = @_;
…		…
541	}	777	}
542		778
543	sub object_thawer_load {	779	sub object_thawer_load {
544	my ($filename) = @_;	780	my ($filename) = @_;
545		781
546	local $/;	782	my ($data, $av);
547		783
548	my $av;	784	(aio_load $filename, $data) >= 0
		785	or return;
549		786
550	#TODO: use sysread etc.	787	unless (aio_stat "$filename.pst") {
551	if (open my $data, "<:raw:perlio", $filename) {	788	(aio_load "$filename.pst", $av) >= 0
552	$data = <$data>;	789	or return;
553	if (open my $pst, "<:raw:perlio", "$filename.pst") {
554	$av = eval { (Storable::thaw <$pst>)->{objs} };	790	$av = eval { (Storable::thaw $av)->{objs} };
555	}	791	}
		792
		793	warn sprintf "loading %s (%d)\n",
		794	$filename, length $data, scalar @{$av || []};#d#
556	return ($data, $av);	795	return ($data, $av);
557	}
558
559	()
560	}	796	}
561		797
562	#############################################################################	798	#############################################################################
563	# command handling &c	799	# command handling &c
564		800
…		…
588	=cut	824	=cut
589		825
590	sub register_extcmd {	826	sub register_extcmd {
591	my ($name, $cb) = @_;	827	my ($name, $cb) = @_;
592		828
593	my $caller = caller;
594	#warn "registering extcmd '$name' to '$caller'";
595
596	$EXTCMD{$name} = [$cb, $caller];	829	$EXTCMD{$name} = $cb;
597	}	830	}
598		831
599	cf::player->attach (	832	cf::player->attach (
600	on_command => sub {	833	on_command => sub {
601	my ($pl, $name, $params) = @_;	834	my ($pl, $name, $params) = @_;
…		…
614		847
615	my $msg = eval { from_json $buf };	848	my $msg = eval { from_json $buf };
616		849
617	if (ref $msg) {	850	if (ref $msg) {
618	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	851	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
619	if (my %reply = $cb->[0]->($pl, $msg)) {	852	if (my %reply = $cb->($pl, $msg)) {
620	$pl->ext_reply ($msg->{msgid}, %reply);	853	$pl->ext_reply ($msg->{msgid}, %reply);
621	}	854	}
622	}	855	}
623	} else {	856	} else {
624	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	857	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
…		…
626		859
627	cf::override;	860	cf::override;
628	},	861	},
629	);	862	);
630		863
631	sub register {
632	my ($base, $pkg) = @_;
633
634	#TODO
635	}
636
637	sub load_extension {	864	sub load_extension {
638	my ($path) = @_;	865	my ($path) = @_;
639		866
640	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	867	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
641	my $base = $1;	868	my $base = $1;
642	my $pkg = $1;	869	my $pkg = $1;
643	$pkg =~ s/[^[:word:]]/_/g;	870	$pkg =~ s/[^[:word:]]/_/g;
644	$pkg = "ext::$pkg";	871	$pkg = "ext::$pkg";
645		872
646	warn "loading '$path' into '$pkg'\n";	873	warn "... loading '$path' into '$pkg'\n";
647		874
648	open my $fh, "<:utf8", $path	875	open my $fh, "<:utf8", $path
649	or die "$path: $!";	876	or die "$path: $!";
650		877
651	my $source =	878	my $source =
652	"package $pkg; use strict; use utf8;\n"	879	"package $pkg; use strict; use utf8;\n"
653	. "#line 1 \"$path\"\n{\n"	880	. "#line 1 \"$path\"\n{\n"
654	. (do { local $/; <$fh> })	881	. (do { local $/; <$fh> })
655	. "\n};\n1";	882	. "\n};\n1";
656		883
657	eval $source	884	unless (eval $source) {
658	or die $@ ? "$path: $@\n"	885	my $msg = $@ ? "$path: $@\n"
659	: "extension disabled.\n";	886	: "extension disabled.\n";
660		887	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
661	push @exts, $pkg;	888	warn $@;
662	$ext_pkg{$base} = $pkg;	889	warn "mandatory extension failed to load, exiting.\n";
663		890	exit 1;
664	# no strict 'refs';	891	}
665	# @{"$pkg\::ISA"} = ext::;	892	die $@;
666
667	register $base, $pkg;
668	}
669
670	sub unload_extension {
671	my ($pkg) = @_;
672
673	warn "removing extension $pkg\n";
674
675	# remove hooks
676	#TODO
677	# for my $idx (0 .. $#PLUGIN_EVENT) {
678	# delete $hook[$idx]{$pkg};
679	# }	893	}
680		894
681	# remove commands	895	push @EXTS, $pkg;
682	for my $name (keys %COMMAND) {
683	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
684
685	if (@cb) {
686	$COMMAND{$name} = \@cb;
687	} else {
688	delete $COMMAND{$name};
689	}
690	}
691
692	# remove extcmds
693	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
694	delete $EXTCMD{$name};
695	}
696
697	if (my $cb = $pkg->can ("unload")) {
698	eval {
699	$cb->($pkg);
700	1
701	} or warn "$pkg unloaded, but with errors: $@";
702	}
703
704	Symbol::delete_package $pkg;
705	}	896	}
706		897
707	sub load_extensions {	898	sub load_extensions {
708	for my $ext (<$LIBDIR/*.ext>) {	899	for my $ext (<$LIBDIR/*.ext>) {
709	next unless -r $ext;	900	next unless -r $ext;
…		…
713	} or warn "$ext not loaded: $@";	904	} or warn "$ext not loaded: $@";
714	}	905	}
715	}	906	}
716		907
717	#############################################################################	908	#############################################################################
718	# load/save/clean perl data associated with a map
719		909
720	*cf::mapsupport::on_clean = sub {	910	=head2 CORE EXTENSIONS
		911
		912	Functions and methods that extend core crossfire objects.
		913
		914	=cut
		915
		916	package cf::player;
		917
		918	use Coro::AIO;
		919
		920	=head3 cf::player
		921
		922	=over 4
		923
		924	=item cf::player::find $login
		925
		926	Returns the given player object, loading it if necessary (might block).
		927
		928	=cut
		929
		930	sub playerdir($) {
		931	cf::localdir
		932	. "/"
		933	. cf::playerdir
		934	. "/"
		935	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		936	}
		937
		938	sub path($) {
		939	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		940
		941	(playerdir $login) . "/$login.pl"
		942	}
		943
		944	sub find_active($) {
		945	$cf::PLAYER{$_[0]}
		946	and $cf::PLAYER{$_[0]}->active
		947	and $cf::PLAYER{$_[0]}
		948	}
		949
		950	sub exists($) {
		951	my ($login) = @_;
		952
		953	$cf::PLAYER{$login}
		954	or cf::sync_job { !aio_stat $login }
		955	}
		956
		957	sub find($) {
		958	return $cf::PLAYER{$_[0]} || do {
		959	my $login = $_[0];
		960
		961	my $guard = cf::lock_acquire "user_find:$login";
		962
		963	$cf::PLAYER{$_[0]} || do {
		964	my $pl = load_pl path $login
		965	or return;
		966	$cf::PLAYER{$login} = $pl
		967	}
		968	}
		969	}
		970
		971	sub save($) {
		972	my ($pl) = @_;
		973
		974	return if $pl->{deny_save};
		975
		976	my $path = path $pl;
		977	my $guard = cf::lock_acquire "user_save:$path";
		978
		979	return if $pl->{deny_save};
		980
		981	aio_mkdir playerdir $pl, 0770;
		982	$pl->{last_save} = $cf::RUNTIME;
		983
		984	$pl->save_pl ($path);
		985	Coro::cede;
		986	}
		987
		988	sub new($) {
		989	my ($login) = @_;
		990
		991	my $self = create;
		992
		993	$self->ob->name ($login);
		994	$self->{deny_save} = 1;
		995
		996	$cf::PLAYER{$login} = $self;
		997
		998	$self
		999	}
		1000
		1001	=item $pl->quit_character
		1002
		1003	Nukes the player without looking back. If logged in, the connection will
		1004	be destroyed. May block for a long time.
		1005
		1006	=cut
		1007
		1008	sub quit_character {
		1009	my ($pl) = @_;
		1010
		1011	$pl->{deny_save} = 1;
		1012	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1013
		1014	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1015	$pl->deactivate;
		1016	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1017	$pl->ns->destroy if $pl->ns;
		1018
		1019	my $path = playerdir $pl;
		1020	my $temp = "$path~$cf::RUNTIME~deleting~";
		1021	aio_rename $path, $temp;
		1022	delete $cf::PLAYER{$pl->ob->name};
		1023	$pl->destroy;
		1024	IO::AIO::aio_rmtree $temp;
		1025	}
		1026
		1027	=item cf::player::list_logins
		1028
		1029	Returns am arrayref of all valid playernames in the system, can take a
		1030	while and may block, so not sync_job-capable, ever.
		1031
		1032	=cut
		1033
		1034	sub list_logins {
		1035	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
		1036	or return [];
		1037
		1038	my @logins;
		1039
		1040	for my $login (@$dirs) {
		1041	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1042	aio_read $fh, 0, 512, my $buf, 0 or next;
		1043	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1044
		1045	utf8::decode $login;
		1046	push @logins, $login;
		1047	}
		1048
		1049	\@logins
		1050	}
		1051
		1052	=item $player->maps
		1053
		1054	Returns an arrayref of map paths that are private for this
		1055	player. May block.
		1056
		1057	=cut
		1058
		1059	sub maps($) {
		1060	my ($pl) = @_;
		1061
		1062	my $files = aio_readdir playerdir $pl
		1063	or return;
		1064
		1065	my @paths;
		1066
		1067	for (@$files) {
		1068	utf8::decode $_;
		1069	next if /\.(?:pl|pst)$/;
		1070	next unless /^$PATH_SEP/o;
		1071
		1072	s/\.map$//;
		1073	push @paths, "~" . $pl->ob->name . "/" . $_;
		1074	}
		1075
		1076	\@paths
		1077	}
		1078
		1079	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1080
		1081	Sends an ext reply to the player.
		1082
		1083	=cut
		1084
		1085	sub ext_reply($$$%) {
		1086	my ($self, $id, %msg) = @_;
		1087
		1088	$msg{msgid} = $id;
		1089
		1090	$self->send ("ext " . cf::to_json \%msg);
		1091	}
		1092
		1093	package cf;
		1094
		1095	=back
		1096
		1097
		1098	=head3 cf::map
		1099
		1100	=over 4
		1101
		1102	=cut
		1103
		1104	package cf::map;
		1105
		1106	use Fcntl;
		1107	use Coro::AIO;
		1108
		1109	use overload
		1110	'""' => \&as_string;
		1111
		1112	our $MAX_RESET = 3600;
		1113	our $DEFAULT_RESET = 3000;
		1114
		1115	sub generate_random_map {
		1116	my ($self, $rmp) = @_;
		1117
		1118	# mit "rum" bekleckern, nicht
		1119	$self->_create_random_map (
		1120	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1121	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1122	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1123	$rmp->{exit_on_final_map},
		1124	$rmp->{xsize}, $rmp->{ysize},
		1125	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1126	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1127	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1128	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1129	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1130	(cf::region::find $rmp->{region}), $rmp->{custom}
		1131	)
		1132	}
		1133
		1134	sub register {
		1135	my (undef, $regex) = @_;
		1136	my $pkg = caller;
		1137
		1138	no strict;
		1139	push @{"$pkg\::ISA"}, __PACKAGE__;
		1140
		1141	$EXT_MAP{$pkg} = qr<$regex>;
		1142	}
		1143
		1144	# also paths starting with '/'
		1145	$EXT_MAP{"cf::map"} = qr{^(?=/)};
		1146
		1147	sub normalise {
		1148	my ($path, $base) = @_;
		1149
		1150	# map plan:
		1151	#
		1152	# /! non-realised random map exit (special hack!)
		1153	# {... are special paths that are not being touched
		1154	# ?xxx/... are special absolute paths
		1155	# ?random/... random maps
		1156	# /... normal maps
		1157	# ~user/... per-player map of a specific user
		1158
		1159	$path =~ s/$PATH_SEP/\//go;
		1160
		1161	# treat it as relative path if it starts with
		1162	# something that looks reasonable
		1163	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1164	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1165
		1166	$base =~ s{[^/]+/?$}{};
		1167	$path = "$base/$path";
		1168	}
		1169
		1170	for ($path) {
		1171	redo if s{//}{/};
		1172	redo if s{/\.?/}{/};
		1173	redo if s{/[^/]+/\.\./}{/};
		1174	}
		1175
		1176	$path
		1177	}
		1178
		1179	sub new_from_path {
		1180	my (undef, $path, $base) = @_;
		1181
		1182	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1183
		1184	$path = normalise $path, $base;
		1185
		1186	for my $pkg (keys %EXT_MAP) {
		1187	if ($path =~ $EXT_MAP{$pkg}) {
		1188	my $self = bless cf::map::new, $pkg;
		1189	$self->{path} = $path; $self->path ($path);
		1190	$self->init; # pass $1 etc.
		1191	return $self;
		1192	}
		1193	}
		1194
		1195	Carp::carp "unable to resolve path '$path'.";
		1196	()
		1197	}
		1198
		1199	sub init {
		1200	my ($self) = @_;
		1201
		1202	$self
		1203	}
		1204
		1205	sub as_string {
		1206	my ($self) = @_;
		1207
		1208	"$self->{path}"
		1209	}
		1210
		1211	# the displayed name, this is a one way mapping
		1212	sub visible_name {
		1213	&as_string
		1214	}
		1215
		1216	# the original (read-only) location
		1217	sub load_path {
		1218	my ($self) = @_;
		1219
		1220	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
		1221	}
		1222
		1223	# the temporary/swap location
		1224	sub save_path {
		1225	my ($self) = @_;
		1226
		1227	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1228	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path
		1229	}
		1230
		1231	# the unique path, undef == no special unique path
		1232	sub uniq_path {
		1233	my ($self) = @_;
		1234
		1235	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1236	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
		1237	}
		1238
		1239	# and all this just because we cannot iterate over
		1240	# all maps in C++...
		1241	sub change_all_map_light {
		1242	my ($change) = @_;
		1243
		1244	$_->change_map_light ($change)
		1245	for grep $_->outdoor, values %cf::MAP;
		1246	}
		1247
		1248	sub unlink_save {
		1249	my ($self) = @_;
		1250
		1251	utf8::encode (my $save = $self->save_path);
		1252	IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink $save;
		1253	IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink "$save.pst";
		1254	}
		1255
		1256	sub load_header_from($) {
		1257	my ($self, $path) = @_;
		1258
		1259	utf8::encode $path;
		1260	aio_open $path, O_RDONLY, 0
		1261	or return;
		1262
		1263	$self->_load_header ($path)
		1264	or return;
		1265
		1266	$self->{load_path} = $path;
		1267
		1268	1
		1269	}
		1270
		1271	sub load_orig {
		1272	my ($self) = @_;
		1273
		1274	$self->load_header_from ($self->load_path)
		1275	}
		1276
		1277	sub load_temp {
		1278	my ($self) = @_;
		1279
		1280	$self->load_header_from ($self->save_path)
		1281	}
		1282
		1283	sub load_header {
		1284	my ($self) = @_;
		1285
		1286	if ($self->load_temp) {
		1287	$self->last_access ((delete $self->{last_access})
		1288	|| $cf::RUNTIME); #d#
		1289	# safety
		1290	$self->{instantiate_time} = $cf::RUNTIME
		1291	if $self->{instantiate_time} > $cf::RUNTIME;
		1292	} else {
		1293	$self->load_orig
		1294	or return;
		1295
		1296	$self->{load_original} = 1;
		1297	$self->{instantiate_time} = $cf::RUNTIME;
		1298	$self->last_access ($cf::RUNTIME);
		1299	$self->instantiate;
		1300	}
		1301
		1302	1
		1303	}
		1304
		1305	sub find;
		1306	sub find {
		1307	my ($path, $origin) = @_;
		1308
		1309	$path = normalise $path, $origin && $origin->path;
		1310
		1311	cf::lock_wait "map_find:$path";
		1312
		1313	$cf::MAP{$path} || do {
		1314	my $guard = cf::lock_acquire "map_find:$path";
		1315	my $map = new_from_path cf::map $path
		1316	or return;
		1317
		1318	$map->{last_save} = $cf::RUNTIME;
		1319
		1320	$map->load_header
		1321	or return;
		1322
		1323	if ($map->should_reset) {
		1324	$map->reset;
		1325	undef $guard;
		1326	$map = find $path
		1327	or return;
		1328	}
		1329
		1330	$cf::MAP{$path} = $map
		1331	}
		1332	}
		1333
		1334	sub load {
		1335	my ($self) = @_;
		1336
		1337	my $path = $self->{path};
		1338	my $guard = cf::lock_acquire "map_load:$path";
		1339
		1340	return if $self->in_memory != cf::MAP_SWAPPED;
		1341
		1342	$self->in_memory (cf::MAP_LOADING);
		1343
		1344	$self->alloc;
		1345	$self->_load_objects ($self->{load_path}, 1)
		1346	or return;
		1347
		1348	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1349	if delete $self->{load_original};
		1350
		1351	if (my $uniq = $self->uniq_path) {
		1352	utf8::encode $uniq;
		1353	if (aio_open $uniq, O_RDONLY, 0) {
		1354	$self->clear_unique_items;
		1355	$self->_load_objects ($uniq, 0);
		1356	}
		1357	}
		1358
		1359	Coro::cede;
		1360
		1361	# now do the right thing for maps
		1362	$self->link_multipart_objects;
		1363
		1364	unless ($self->{deny_activate}) {
		1365	$self->decay_objects;
		1366	$self->fix_auto_apply;
		1367	$self->update_buttons;
		1368	Coro::cede;
		1369	$self->set_darkness_map;
		1370	$self->difficulty ($self->estimate_difficulty)
		1371	unless $self->difficulty;
		1372	Coro::cede;
		1373	$self->activate;
		1374	}
		1375
		1376	$self->in_memory (cf::MAP_IN_MEMORY);
		1377	}
		1378
		1379	sub customise_for {
		1380	my ($self, $ob) = @_;
		1381
		1382	return find "~" . $ob->name . "/" . $self->{path}
		1383	if $self->per_player;
		1384
		1385	$self
		1386	}
		1387
		1388	# find and load all maps in the 3x3 area around a map
		1389	sub load_diag {
721	my ($map) = @_;	1390	my ($map) = @_;
722		1391
723	my $path = $map->tmpname;	1392	my @diag; # diagonal neighbours
724	defined $path or return;
725		1393
726	unlink "$path.pst";	1394	for (0 .. 3) {
		1395	my $neigh = $map->tile_path ($_)
		1396	or next;
		1397	$neigh = find $neigh, $map
		1398	or next;
		1399	$neigh->load;
		1400
		1401	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1402	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1403	}
		1404
		1405	for (@diag) {
		1406	my $neigh = find @$_
		1407	or next;
		1408	$neigh->load;
		1409	}
		1410	}
		1411
		1412	sub find_sync {
		1413	my ($path, $origin) = @_;
		1414
		1415	cf::sync_job { find $path, $origin }
		1416	}
		1417
		1418	sub do_load_sync {
		1419	my ($map) = @_;
		1420
		1421	cf::sync_job { $map->load };
		1422	}
		1423
		1424	our %MAP_PREFETCH;
		1425	our $MAP_PREFETCHER = Coro::async {
		1426	while () {
		1427	for my $path (keys %MAP_PREFETCH) {
		1428	my $map = find $path
		1429	or next;
		1430	$map->load;
		1431
		1432	delete $MAP_PREFETCH{$path};
		1433	}
		1434	Coro::schedule;
		1435	}
727	};	1436	};
728		1437
729	cf::map->attach (prio => -10000, package => cf::mapsupport::);	1438	sub find_async {
		1439	my ($path, $origin) = @_;
730		1440
731	#############################################################################	1441	$path = normalise $path, $origin && $origin->{path};
732	# load/save perl data associated with player->ob objects
733		1442
734	sub all_objects(@) {	1443	if (my $map = $cf::MAP{$path}) {
735	@_, map all_objects ($_->inv), @_	1444	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
736	}
737
738	# TODO: compatibility cruft, remove when no longer needed
739	cf::player->attach (
740	on_load => sub {
741	my ($pl, $path) = @_;
742
743	for my $o (all_objects $pl->ob) {
744	if (my $value = $o->get_ob_key_value ("_perl_data")) {
745	$o->set_ob_key_value ("_perl_data");
746
747	%$o = %{ Storable::thaw pack "H*", $value };
748	}
749	}
750	},	1445	}
751	);
752		1446
753	#############################################################################	1447	$MAP_PREFETCH{$path} = 0;
		1448	$MAP_PREFETCHER->ready;
754		1449
755	=head2 CORE EXTENSIONS	1450	()
		1451	}
756		1452
757	Functions and methods that extend core crossfire objects.	1453	sub save {
		1454	my ($self) = @_;
758		1455
759	=head3 cf::player	1456	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1457
		1458	$self->{last_save} = $cf::RUNTIME;
		1459
		1460	return unless $self->dirty;
		1461
		1462	my $save = $self->save_path; utf8::encode $save;
		1463	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1464
		1465	$self->{load_path} = $save;
		1466
		1467	return if $self->{deny_save};
		1468
		1469	local $self->{last_access} = $self->last_access;#d#
		1470
		1471	cf::async {
		1472	$_->contr->save for $self->players;
		1473	};
		1474
		1475	if ($uniq) {
		1476	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1477	$self->_save_objects ($uniq, cf::IO_UNIQUES);
		1478	} else {
		1479	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
		1480	}
		1481	}
		1482
		1483	sub swap_out {
		1484	my ($self) = @_;
		1485
		1486	# save first because save cedes
		1487	$self->save;
		1488
		1489	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1490
		1491	return if $self->players;
		1492	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1493	return if $self->{deny_save};
		1494
		1495	$self->clear;
		1496	$self->in_memory (cf::MAP_SWAPPED);
		1497	}
		1498
		1499	sub reset_at {
		1500	my ($self) = @_;
		1501
		1502	# TODO: safety, remove and allow resettable per-player maps
		1503	return 1e99 if $self->isa ("ext::map_per_player");
		1504	return 1e99 if $self->{deny_reset};
		1505
		1506	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1507	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1508
		1509	$time + $to
		1510	}
		1511
		1512	sub should_reset {
		1513	my ($self) = @_;
		1514
		1515	$self->reset_at <= $cf::RUNTIME
		1516	}
		1517
		1518	sub rename {
		1519	my ($self, $new_path) = @_;
		1520
		1521	normalise $new_path;
		1522
		1523	$self->unlink_save;
		1524
		1525	delete $cf::MAP{$self->path};
		1526	$self->{path} = $new_path; $self->path ($self->{path});
		1527	$cf::MAP{$self->path} = $self;
		1528
		1529	$self->save;
		1530	}
		1531
		1532	sub reset {
		1533	my ($self) = @_;
		1534
		1535	my $lock = cf::lock_acquire "map_data:$self->{path}";
		1536
		1537	return if $self->players;
		1538	return if $self->isa ("ext::map_per_player");#d#
		1539
		1540	warn "resetting map ", $self->path;#d#
		1541
		1542	delete $cf::MAP{$self->path};
		1543
		1544	$self->in_memory (cf::MAP_SWAPPED);
		1545	$self->clear;
		1546
		1547	$_->clear_links_to ($self) for values %cf::MAP;
		1548
		1549	$self->unlink_save;
		1550	$self->destroy;
		1551	}
		1552
		1553	my $nuke_counter = "aaaa";
		1554
		1555	sub nuke {
		1556	my ($self) = @_;
		1557
		1558	$self->{deny_save} = 1;
		1559	$self->reset_timeout (1);
		1560	$self->rename ("{nuke}/" . ($nuke_counter++));
		1561	$self->reset; # polite request, might not happen
		1562	}
		1563
		1564	=item cf::map::unique_maps
		1565
		1566	Returns an arrayref of paths of all shared maps that have
		1567	instantiated unique items. May block.
		1568
		1569	=cut
		1570
		1571	sub unique_maps() {
		1572	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
		1573	or return;
		1574
		1575	my @paths;
		1576
		1577	for (@$files) {
		1578	utf8::decode $_;
		1579	next if /\.pst$/;
		1580	next unless /^$PATH_SEP/o;
		1581
		1582	s/\.map$//;
		1583	push @paths, $_;
		1584	}
		1585
		1586	\@paths
		1587	}
		1588
		1589	package cf;
		1590
		1591	=back
		1592
		1593	=head3 cf::object
		1594
		1595	=cut
		1596
		1597	package cf::object;
760		1598
761	=over 4	1599	=over 4
762		1600
763	=item cf::player::exists $login	1601	=item $ob->inv_recursive
764		1602
765	Returns true when the given account exists.	1603	Returns the inventory of the object _and_ their inventories, recursively.
766		1604
767	=cut	1605	=cut
768		1606
769	sub cf::player::exists($) {	1607	sub inv_recursive_;
770	cf::player::find $_[0]	1608	sub inv_recursive_ {
771	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1609	map { $_, inv_recursive_ $_->inv } @_
772	}	1610	}
773		1611
774	=item $player->ext_reply ($msgid, $msgtype, %msg)	1612	sub inv_recursive {
775		1613	inv_recursive_ inv $_[0]
776	Sends an ext reply to the player.
777
778	=cut
779
780	sub cf::player::ext_reply($$$%) {
781	my ($self, $id, %msg) = @_;
782
783	$msg{msgid} = $id;
784
785	$self->send ("ext " . to_json \%msg);
786	}	1614	}
		1615
		1616	package cf;
787		1617
788	=back	1618	=back
789		1619
790	=head3 cf::object::player	1620	=head3 cf::object::player
791		1621
…		…
829	(ref $cf::CFG{"may_$access"}	1659	(ref $cf::CFG{"may_$access"}
830	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1660	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
831	: $cf::CFG{"may_$access"})	1661	: $cf::CFG{"may_$access"})
832	}	1662	}
833		1663
		1664	=item $player_object->enter_link
		1665
		1666	Freezes the player and moves him/her to a special map (C<{link}>).
		1667
		1668	The player should be reasonably safe there for short amounts of time. You
		1669	I<MUST> call C<leave_link> as soon as possible, though.
		1670
		1671	Will never block.
		1672
		1673	=item $player_object->leave_link ($map, $x, $y)
		1674
		1675	Moves the player out of the special C<{link}> map onto the specified
		1676	map. If the map is not valid (or omitted), the player will be moved back
		1677	to the location he/she was before the call to C<enter_link>, or, if that
		1678	fails, to the emergency map position.
		1679
		1680	Might block.
		1681
		1682	=cut
		1683
		1684	sub link_map {
		1685	unless ($LINK_MAP) {
		1686	$LINK_MAP = cf::map::find "{link}"
		1687	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };
		1688	$LINK_MAP->load;
		1689	}
		1690
		1691	$LINK_MAP
		1692	}
		1693
		1694	sub cf::object::player::enter_link {
		1695	my ($self) = @_;
		1696
		1697	$self->deactivate_recursive;
		1698
		1699	return if UNIVERSAL::isa $self->map, "ext::map_link";
		1700
		1701	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1702	if $self->map;
		1703
		1704	$self->enter_map ($LINK_MAP || link_map, 20, 20);
		1705	}
		1706
		1707	sub cf::object::player::leave_link {
		1708	my ($self, $map, $x, $y) = @_;
		1709
		1710	my $link_pos = delete $self->{_link_pos};
		1711
		1712	unless ($map) {
		1713	# restore original map position
		1714	($map, $x, $y) = @{ $link_pos || [] };
		1715	$map = cf::map::find $map;
		1716
		1717	unless ($map) {
		1718	($map, $x, $y) = @$EMERGENCY_POSITION;
		1719	$map = cf::map::find $map
		1720	or die "FATAL: cannot load emergency map\n";
		1721	}
		1722	}
		1723
		1724	($x, $y) = (-1, -1)
		1725	unless (defined $x) && (defined $y);
		1726
		1727	# use -1 or undef as default coordinates, not 0, 0
		1728	($x, $y) = ($map->enter_x, $map->enter_y)
		1729	if $x <=0 && $y <= 0;
		1730
		1731	$map->load;
		1732	$map->load_diag;
		1733
		1734	return unless $self->contr->active;
		1735	$self->activate_recursive;
		1736	$self->enter_map ($map, $x, $y);
		1737	}
		1738
		1739	cf::player->attach (
		1740	on_logout => sub {
		1741	my ($pl) = @_;
		1742
		1743	# abort map switching before logout
		1744	if ($pl->ob->{_link_pos}) {
		1745	cf::sync_job {
		1746	$pl->ob->leave_link
		1747	};
		1748	}
		1749	},
		1750	on_login => sub {
		1751	my ($pl) = @_;
		1752
		1753	# try to abort aborted map switching on player login :)
		1754	# should happen only on crashes
		1755	if ($pl->ob->{_link_pos}) {
		1756	$pl->ob->enter_link;
		1757	(async {
		1758	# we need this sleep as the login has a concurrent enter_exit running
		1759	# and this sleep increases chances of the player not ending up in scorn
		1760	$pl->ob->reply (undef,
		1761	"There was an internal problem at your last logout, "
		1762	. "the server will try to bring you to your intended destination in a second.",
		1763	cf::NDI_RED);
		1764	Coro::Timer::sleep 1;
		1765	$pl->ob->leave_link;
		1766	})->prio (2);
		1767	}
		1768	},
		1769	);
		1770
		1771	=item $player_object->goto ($path, $x, $y)
		1772
		1773	=cut
		1774
		1775	sub cf::object::player::goto {
		1776	my ($self, $path, $x, $y) = @_;
		1777
		1778	$self->enter_link;
		1779
		1780	(async {
		1781	my $map = cf::map::find $path;
		1782	$map = $map->customise_for ($self) if $map;
		1783
		1784	# warn "entering ", $map->path, " at ($x, $y)\n"
		1785	# if $map;
		1786
		1787	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1788
		1789	$self->leave_link ($map, $x, $y);
		1790	})->prio (1);
		1791	}
		1792
		1793	=item $player_object->enter_exit ($exit_object)
		1794
		1795	=cut
		1796
		1797	sub parse_random_map_params {
		1798	my ($spec) = @_;
		1799
		1800	my $rmp = { # defaults
		1801	xsize => 10,
		1802	ysize => 10,
		1803	};
		1804
		1805	for (split /\n/, $spec) {
		1806	my ($k, $v) = split /\s+/, $_, 2;
		1807
		1808	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1809	}
		1810
		1811	$rmp
		1812	}
		1813
		1814	sub prepare_random_map {
		1815	my ($exit) = @_;
		1816
		1817	# all this does is basically replace the /! path by
		1818	# a new random map path (?random/...) with a seed
		1819	# that depends on the exit object
		1820
		1821	my $rmp = parse_random_map_params $exit->msg;
		1822
		1823	if ($exit->map) {
		1824	$rmp->{region} = $exit->map->region_name;
		1825	$rmp->{origin_map} = $exit->map->path;
		1826	$rmp->{origin_x} = $exit->x;
		1827	$rmp->{origin_y} = $exit->y;
		1828	}
		1829
		1830	$rmp->{random_seed} ||= $exit->random_seed;
		1831
		1832	my $data = cf::to_json $rmp;
		1833	my $md5 = Digest::MD5::md5_hex $data;
		1834
		1835	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
		1836	aio_write $fh, 0, (length $data), $data, 0;
		1837
		1838	$exit->slaying ("?random/$md5");
		1839	$exit->msg (undef);
		1840	}
		1841	}
		1842
		1843	sub cf::object::player::enter_exit {
		1844	my ($self, $exit) = @_;
		1845
		1846	return unless $self->type == cf::PLAYER;
		1847
		1848	$self->enter_link;
		1849
		1850	(async {
		1851	$self->deactivate_recursive; # just to be sure
		1852	unless (eval {
		1853	prepare_random_map $exit
		1854	if $exit->slaying eq "/!";
		1855
		1856	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
		1857	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
		1858
		1859	1;
		1860	}) {
		1861	$self->message ("Something went wrong deep within the crossfire server. "
		1862	. "I'll try to bring you back to the map you were before. "
		1863	. "Please report this to the dungeon master!",
		1864	cf::NDI_UNIQUE | cf::NDI_RED);
		1865
		1866	warn "ERROR in enter_exit: $@";
		1867	$self->leave_link;
		1868	}
		1869	})->prio (1);
		1870	}
		1871
834	=head3 cf::client	1872	=head3 cf::client
835		1873
836	=over 4	1874	=over 4
837		1875
838	=item $client->send_drawinfo ($text, $flags)	1876	=item $client->send_drawinfo ($text, $flags)
…		…
881	on_reply => sub {	1919	on_reply => sub {
882	my ($ns, $msg) = @_;	1920	my ($ns, $msg) = @_;
883		1921
884	# this weird shuffling is so that direct followup queries	1922	# this weird shuffling is so that direct followup queries
885	# get handled first	1923	# get handled first
886	my $queue = delete $ns->{query_queue};	1924	my $queue = delete $ns->{query_queue}
		1925	or return; # be conservative, not sure how that can happen, but we saw a crash here
887		1926
888	(shift @$queue)->[1]->($msg);	1927	(shift @$queue)->[1]->($msg);
889		1928
890	push @{ $ns->{query_queue} }, @$queue;	1929	push @{ $ns->{query_queue} }, @$queue;
891		1930
…		…
897	}	1936	}
898	}	1937	}
899	},	1938	},
900	);	1939	);
901		1940
902	=item $client->coro (\&cb)	1941	=item $client->async (\&cb)
903		1942
904	Create a new coroutine, running the specified callback. The coroutine will	1943	Create a new coroutine, running the specified callback. The coroutine will
905	be automatically cancelled when the client gets destroyed (e.g. on logout,	1944	be automatically cancelled when the client gets destroyed (e.g. on logout,
906	or loss of connection).	1945	or loss of connection).
907		1946
908	=cut	1947	=cut
909		1948
910	sub cf::client::coro {	1949	sub cf::client::async {
911	my ($self, $cb) = @_;	1950	my ($self, $cb) = @_;
912		1951
913	my $coro; $coro = async {	1952	my $coro = &Coro::async ($cb);
914	eval {	1953
915	$cb->();	1954	$coro->on_destroy (sub {
916	};
917	warn $@ if $@;
918	delete $self->{_coro}{$coro+0};	1955	delete $self->{_coro}{$coro+0};
919	};	1956	});
920		1957
921	$self->{_coro}{$coro+0} = $coro;	1958	$self->{_coro}{$coro+0} = $coro;
		1959
		1960	$coro
922	}	1961	}
923		1962
924	cf::client->attach (	1963	cf::client->attach (
925	on_destroy => sub {	1964	on_destroy => sub {
926	my ($ns) = @_;	1965	my ($ns) = @_;
…		…
1090		2129
1091	{	2130	{
1092	my $path = cf::localdir . "/database.pst";	2131	my $path = cf::localdir . "/database.pst";
1093		2132
1094	sub db_load() {	2133	sub db_load() {
1095	warn "loading database $path\n";#d# remove later
1096	$DB = stat $path ? Storable::retrieve $path : { };	2134	$DB = stat $path ? Storable::retrieve $path : { };
1097	}	2135	}
1098		2136
1099	my $pid;	2137	my $pid;
1100		2138
1101	sub db_save() {	2139	sub db_save() {
1102	warn "saving database $path\n";#d# remove later
1103	waitpid $pid, 0 if $pid;	2140	waitpid $pid, 0 if $pid;
1104	if (0 == ($pid = fork)) {	2141	if (0 == ($pid = fork)) {
1105	$DB->{_meta}{version} = 1;	2142	$DB->{_meta}{version} = 1;
1106	Storable::nstore $DB, "$path~";	2143	Storable::nstore $DB, "$path~";
1107	rename "$path~", $path;	2144	rename "$path~", $path;
…		…
1155	open my $fh, "<:utf8", cf::confdir . "/config"	2192	open my $fh, "<:utf8", cf::confdir . "/config"
1156	or return;	2193	or return;
1157		2194
1158	local $/;	2195	local $/;
1159	*CFG = YAML::Syck::Load <$fh>;	2196	*CFG = YAML::Syck::Load <$fh>;
		2197
		2198	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2199
		2200	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2201	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2202
		2203	if (exists $CFG{mlockall}) {
		2204	eval {
		2205	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2206	and die "WARNING: m(un)lockall failed: $!\n";
		2207	};
		2208	warn $@ if $@;
		2209	}
1160	}	2210	}
1161		2211
1162	sub main {	2212	sub main {
		2213	# we must not ever block the main coroutine
		2214	local $Coro::idle = sub {
		2215	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2216	async { Event::one_event };
		2217	};
		2218
1163	cfg_load;	2219	cfg_load;
1164	db_load;	2220	db_load;
1165	load_extensions;	2221	load_extensions;
1166	Event::loop;	2222	Event::loop;
1167	}	2223	}
1168		2224
1169	#############################################################################	2225	#############################################################################
1170	# initialisation	2226	# initialisation and cleanup
1171		2227
		2228	# install some emergency cleanup handlers
		2229	BEGIN {
		2230	for my $signal (qw(INT HUP TERM)) {
		2231	Event->signal (
		2232	data => WF_AUTOCANCEL,
		2233	signal => $signal,
		2234	cb => sub {
		2235	cf::cleanup "SIG$signal";
		2236	},
		2237	);
		2238	}
		2239	}
		2240
		2241	sub emergency_save() {
		2242	my $freeze_guard = cf::freeze_mainloop;
		2243
		2244	warn "enter emergency perl save\n";
		2245
		2246	cf::sync_job {
		2247	# use a peculiar iteration method to avoid tripping on perl
		2248	# refcount bugs in for. also avoids problems with players
		2249	# and maps saved/destroyed asynchronously.
		2250	warn "begin emergency player save\n";
		2251	for my $login (keys %cf::PLAYER) {
		2252	my $pl = $cf::PLAYER{$login} or next;
		2253	$pl->valid or next;
		2254	$pl->save;
		2255	}
		2256	warn "end emergency player save\n";
		2257
		2258	warn "begin emergency map save\n";
		2259	for my $path (keys %cf::MAP) {
		2260	my $map = $cf::MAP{$path} or next;
		2261	$map->valid or next;
		2262	$map->save;
		2263	}
		2264	warn "end emergency map save\n";
		2265	};
		2266
		2267	warn "leave emergency perl save\n";
		2268	}
		2269
1172	sub _perl_reload(&) {	2270	sub reload() {
1173	my ($msg) = @_;	2271	# can/must only be called in main
		2272	if ($Coro::current != $Coro::main) {
		2273	warn "can only reload from main coroutine\n";
		2274	return;
		2275	}
1174		2276
1175	$msg->("reloading...");	2277	warn "reloading...";
		2278
		2279	warn "freezing server";
		2280	my $guard = freeze_mainloop;
		2281	cf::emergency_save;
		2282
		2283	warn "sync database to disk";
		2284	cf::db_sync;
		2285	IO::AIO::flush;
1176		2286
1177	eval {	2287	eval {
		2288	# if anything goes wrong in here, we should simply crash as we already saved
		2289
1178	# cancel all watchers	2290	warn "cancel all watchers";
1179	for (Event::all_watchers) {	2291	for (Event::all_watchers) {
1180	$_->cancel if $_->data & WF_AUTOCANCEL;	2292	$_->cancel if $_->data & WF_AUTOCANCEL;
1181	}	2293	}
1182		2294
		2295	warn "cancel all extension coros";
		2296	$_->cancel for values %EXT_CORO;
		2297	%EXT_CORO = ();
		2298
		2299	warn "remove commands";
		2300	%COMMAND = ();
		2301
		2302	warn "remove ext commands";
		2303	%EXTCMD = ();
		2304
1183	# unload all extensions	2305	warn "unload/nuke all extensions";
1184	for (@exts) {	2306	for my $pkg (@EXTS) {
1185	$msg->("unloading <$_>");	2307	warn "... unloading $pkg";
1186	unload_extension $_;	2308
		2309	if (my $cb = $pkg->can ("unload")) {
		2310	eval {
		2311	$cb->($pkg);
		2312	1
		2313	} or warn "$pkg unloaded, but with errors: $@";
1187	}	2314	}
1188		2315
		2316	warn "... nuking $pkg";
		2317	Symbol::delete_package $pkg;
		2318	}
		2319
1189	# unload all modules loaded from $LIBDIR	2320	warn "unload all perl modules loaded from $LIBDIR";
1190	while (my ($k, $v) = each %INC) {	2321	while (my ($k, $v) = each %INC) {
1191	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2322	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1192		2323
1193	$msg->("removing <$k>");	2324	warn "removing <$k>";
1194	delete $INC{$k};	2325	delete $INC{$k};
1195		2326
1196	$k =~ s/\.pm$//;	2327	$k =~ s/\.pm$//;
1197	$k =~ s/\//::/g;	2328	$k =~ s/\//::/g;
1198		2329
…		…
1201	}	2332	}
1202		2333
1203	Symbol::delete_package $k;	2334	Symbol::delete_package $k;
1204	}	2335	}
1205		2336
1206	# sync database to disk
1207	cf::db_sync;
1208
1209	# get rid of safe::, as good as possible	2337	warn "get rid of safe::, as good as possible";
1210	Symbol::delete_package "safe::$_"	2338	Symbol::delete_package "safe::$_"
1211	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	2339	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1212		2340
1213	# remove register_script_function callbacks
1214	# TODO
1215
1216	# unload cf.pm "a bit"	2341	warn "unload cf.pm \"a bit\"";
1217	delete $INC{"cf.pm"};	2342	delete $INC{"cf.pm"};
1218		2343
1219	# don't, removes xs symbols, too,	2344	# don't, removes xs symbols, too,
1220	# and global variables created in xs	2345	# and global variables created in xs
1221	#Symbol::delete_package __PACKAGE__;	2346	#Symbol::delete_package __PACKAGE__;
1222		2347
1223	# reload cf.pm
1224	$msg->("reloading cf.pm");	2348	warn "reloading cf.pm";
1225	require cf;	2349	require cf;
1226	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	2350	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1227		2351
1228	# load config and database again	2352	warn "load config and database again";
1229	cf::cfg_load;	2353	cf::cfg_load;
1230	cf::db_load;	2354	cf::db_load;
1231		2355
1232	# load extensions	2356	warn "load extensions";
1233	$msg->("load extensions");
1234	cf::load_extensions;	2357	cf::load_extensions;
1235		2358
1236	# reattach attachments to objects	2359	warn "reattach attachments to objects/players";
1237	$msg->("reattach");
1238	_global_reattach;	2360	_global_reattach;
		2361	warn "reattach attachments to maps";
		2362	reattach $_ for values %MAP;
1239	};	2363	};
1240	$msg->($@) if $@;
1241		2364
1242	$msg->("reloaded");	2365	if ($@) {
		2366	warn $@;
		2367	warn "error while reloading, exiting.";
		2368	exit 1;
		2369	}
		2370
		2371	warn "reloaded";
1243	};	2372	};
1244		2373
1245	sub perl_reload() {
1246	_perl_reload {
1247	warn $_[0];
1248	print "$_[0]\n";
1249	};
1250	}
1251
1252	register "<global>", __PACKAGE__;
1253
1254	register_command "perl-reload" => sub {	2374	register_command "reload" => sub {
1255	my ($who, $arg) = @_;	2375	my ($who, $arg) = @_;
1256		2376
1257	if ($who->flag (FLAG_WIZ)) {	2377	if ($who->flag (FLAG_WIZ)) {
1258	_perl_reload {	2378	$who->message ("start of reload.");
1259	warn $_[0];	2379	reload;
1260	$who->message ($_[0]);	2380	$who->message ("end of reload.");
1261	};
1262	}	2381	}
1263	};	2382	};
1264		2383
1265	unshift @INC, $LIBDIR;	2384	unshift @INC, $LIBDIR;
1266		2385
1267	$TICK_WATCHER = Event->timer (	2386	$TICK_WATCHER = Event->timer (
		2387	reentrant => 0,
1268	prio => 0,	2388	prio => 0,
1269	at => $NEXT_TICK || 1,	2389	at => $NEXT_TICK || $TICK,
1270	data => WF_AUTOCANCEL,	2390	data => WF_AUTOCANCEL,
1271	cb => sub {	2391	cb => sub {
		2392	$NOW = Event::time;
		2393
1272	cf::server_tick; # one server iteration	2394	cf::server_tick; # one server iteration
1273		2395	$RUNTIME += $TICK;
1274	my $NOW = Event::time;
1275	$NEXT_TICK += $TICK;	2396	$NEXT_TICK += $TICK;
1276		2397
		2398	$WAIT_FOR_TICK->broadcast;
		2399	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
		2400
1277	# if we are delayed by four ticks or more, skip them all	2401	# if we are delayed by four ticks or more, skip them all
1278	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2402	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1279		2403
1280	$TICK_WATCHER->at ($NEXT_TICK);	2404	$TICK_WATCHER->at ($NEXT_TICK);
1281	$TICK_WATCHER->start;	2405	$TICK_WATCHER->start;
1282	},	2406	},
1283	);	2407	);
1284		2408
1285	IO::AIO::max_poll_time $TICK * 0.2;	2409	IO::AIO::max_poll_time $TICK * 0.2;
1286		2410
		2411	$AIO_POLL_WATCHER = Event->io (
1287	Event->io (fd => IO::AIO::poll_fileno,	2412	fd => IO::AIO::poll_fileno,
1288	poll => 'r',	2413	poll => 'r',
1289	prio => 5,	2414	prio => 5,
1290	data => WF_AUTOCANCEL,	2415	data => WF_AUTOCANCEL,
1291	cb => \&IO::AIO::poll_cb);	2416	cb => \&IO::AIO::poll_cb,
		2417	);
		2418
		2419	$WRITE_RUNTIME_WATCHER = Event->timer (
		2420	data => WF_AUTOCANCEL,
		2421	after => 0,
		2422	interval => 10,
		2423	cb => sub {
		2424	(Coro::unblock_sub {
		2425	write_runtime
		2426	or warn "ERROR: unable to write runtime file: $!";
		2427	})->();
		2428	},
		2429	);
		2430
		2431	END { cf::emergency_save }
1292		2432
1293	1	2433	1
1294		2434

Diff Legend

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