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.103 by root, Sat Dec 30 10:16:11 2006 UTC vs.
Revision 1.196 by root, Sat Jan 27 23:59:29 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		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 (2); # run main coroutine ("the server") with very high priority	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;
42	our $NOW;	52	our $NOW;
43		53
44	our %CFG;	54	our %CFG;
45		55
46	our $UPTIME; $UPTIME ||= time;	56	our $UPTIME; $UPTIME ||= time;
47	our $RUNTIME;	57	our $RUNTIME;
48		58
		59	our %PLAYER; # all users
49	our %MAP; # all maps	60	our %MAP; # all maps
50	our $LINK_MAP; # the special {link} map	61	our $LINK_MAP; # the special {link} map, which is always available
51	our $FREEZE;	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
52		69
53	binmode STDOUT;	70	binmode STDOUT;
54	binmode STDERR;	71	binmode STDERR;
55		72
56	# read virtual server time, if available	73	# read virtual server time, if available
…		…
62		79
63	mkdir cf::localdir;	80	mkdir cf::localdir;
64	mkdir cf::localdir . "/" . cf::playerdir;	81	mkdir cf::localdir . "/" . cf::playerdir;
65	mkdir cf::localdir . "/" . cf::tmpdir;	82	mkdir cf::localdir . "/" . cf::tmpdir;
66	mkdir cf::localdir . "/" . cf::uniquedir;	83	mkdir cf::localdir . "/" . cf::uniquedir;
		84	mkdir $RANDOM_MAPS;
67		85
68	our %EXT_CORO;	86	our $EMERGENCY_POSITION;
69		87
70	#############################################################################	88	#############################################################################
71		89
72	=head2 GLOBAL VARIABLES	90	=head2 GLOBAL VARIABLES
73		91
…		…
97		115
98	=item %cf::CFG	116	=item %cf::CFG
99		117
100	Configuration for the server, loaded from C</etc/crossfire/config>, or	118	Configuration for the server, loaded from C</etc/crossfire/config>, or
101	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.
102		127
103	=back	128	=back
104		129
105	=cut	130	=cut
106		131
…		…
110	utf8::encode $msg;	135	utf8::encode $msg;
111		136
112	$msg .= "\n"	137	$msg .= "\n"
113	unless $msg =~ /\n$/;	138	unless $msg =~ /\n$/;
114		139
115	LOG llevError, "cfperl: $msg";	140	LOG llevError, $msg;
116	};	141	};
117	}	142	}
118		143
119	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	144	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
120	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	145	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
…		…
138		163
139	$Event::DIED = sub {	164	$Event::DIED = sub {
140	warn "error in event callback: @_";	165	warn "error in event callback: @_";
141	};	166	};
142		167
143	my %ext_pkg;
144	my @exts;
145	my @hook;
146
147	=head2 UTILITY FUNCTIONS	168	=head2 UTILITY FUNCTIONS
148		169
149	=over 4	170	=over 4
150		171
		172	=item dumpval $ref
		173
151	=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	}
152		194
153	use JSON::Syck (); # TODO# replace by JSON::PC once working	195	use JSON::Syck (); # TODO# replace by JSON::PC once working
154		196
155	=item $ref = cf::from_json $json	197	=item $ref = cf::from_json $json
156		198
…		…
172	sub to_json($) {	214	sub to_json($) {
173	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	215	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
174	JSON::Syck::Dump $_[0]	216	JSON::Syck::Dump $_[0]
175	}	217	}
176		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
177	=item $coro = cf::coro { BLOCK }	328	=item $coro = cf::async_ext { BLOCK }
178		329
179	Creates and returns a new coro. This coro is automcatially being canceled	330	Like async, but this coro is automatically being canceled when the
180	when the extension calling this is being unloaded.	331	extension calling this is being unloaded.
181		332
182	=cut	333	=cut
183		334
184	sub coro(&) {	335	sub async_ext(&) {
185	my $cb = shift;	336	my $cb = shift;
186		337
187	my $coro; $coro = async {	338	my $coro = &Coro::async ($cb);
188	eval {
189	$cb->();
190	};
191	warn $@ if $@;
192	};
193		339
194	$coro->on_destroy (sub {	340	$coro->on_destroy (sub {
195	delete $EXT_CORO{$coro+0};	341	delete $EXT_CORO{$coro+0};
196	});	342	});
197	$EXT_CORO{$coro+0} = $coro;	343	$EXT_CORO{$coro+0} = $coro;
198		344
199	$coro	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 + 90 + 10;
		355	# 10 is the runtime save interval, for a monotonic clock
		356	# 60 allows for the watchdog to kill the server.
		357
		358	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		359	and return;
		360
		361	aio_fsync $fh
		362	and return;
		363
		364	close $fh
		365	or return;
		366
		367	aio_rename "$runtime~", $runtime
		368	and return;
		369
		370	1
200	}	371	}
201		372
202	=back	373	=back
203		374
204	=cut	375	=cut
…		…
335	our @CB_TYPE = (); # registry for type (cf-object class) based events	506	our @CB_TYPE = (); # registry for type (cf-object class) based events
336	our @CB_MAP = ();	507	our @CB_MAP = ();
337		508
338	my %attachment;	509	my %attachment;
339		510
		511	sub cf::attachable::thawer_merge {
		512	# simply override everything except _meta
		513	local $_[0]{_meta};
		514	%{$_[0]} = %{$_[1]};
		515	}
		516
340	sub _attach_cb($$$$) {	517	sub _attach_cb($$$$) {
341	my ($registry, $event, $prio, $cb) = @_;	518	my ($registry, $event, $prio, $cb) = @_;
342		519
343	use sort 'stable';	520	use sort 'stable';
344		521
…		…
515	# object support	692	# object support
516		693
517	sub reattach {	694	sub reattach {
518	# basically do the same as instantiate, without calling instantiate	695	# basically do the same as instantiate, without calling instantiate
519	my ($obj) = @_;	696	my ($obj) = @_;
		697
		698	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
520		699
521	my $registry = $obj->registry;	700	my $registry = $obj->registry;
522		701
523	@$registry = ();	702	@$registry = ();
524		703
…		…
563	);	742	);
564		743
565	sub object_freezer_save {	744	sub object_freezer_save {
566	my ($filename, $rdata, $objs) = @_;	745	my ($filename, $rdata, $objs) = @_;
567		746
		747	sync_job {
568	if (length $$rdata) {	748	if (length $$rdata) {
569	warn sprintf "saving %s (%d,%d)\n",	749	warn sprintf "saving %s (%d,%d)\n",
570	$filename, length $$rdata, scalar @$objs;	750	$filename, length $$rdata, scalar @$objs;
571		751
572	if (open my $fh, ">:raw", "$filename~") {	752	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
573	chmod SAVE_MODE, $fh;
574	syswrite $fh, $$rdata;
575	close $fh;
576
577	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
578	chmod SAVE_MODE, $fh;	753	chmod SAVE_MODE, $fh;
579	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };	754	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		755	aio_fsync $fh;
580	close $fh;	756	close $fh;
		757
		758	if (@$objs) {
		759	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		760	chmod SAVE_MODE, $fh;
		761	my $data = Storable::nfreeze { version => 1, objs => $objs };
		762	aio_write $fh, 0, (length $data), $data, 0;
		763	aio_fsync $fh;
		764	close $fh;
581	rename "$filename.pst~", "$filename.pst";	765	aio_rename "$filename.pst~", "$filename.pst";
		766	}
		767	} else {
		768	aio_unlink "$filename.pst";
		769	}
		770
		771	aio_rename "$filename~", $filename;
582	} else {	772	} else {
583	unlink "$filename.pst";	773	warn "FATAL: $filename~: $!\n";
584	}	774	}
585
586	rename "$filename~", $filename;
587	} else {	775	} else {
588	warn "FATAL: $filename~: $!\n";
589	}
590	} else {
591	unlink $filename;	776	aio_unlink $filename;
592	unlink "$filename.pst";	777	aio_unlink "$filename.pst";
		778	}
593	}	779	}
594	}	780	}
595		781
596	sub object_freezer_as_string {	782	sub object_freezer_as_string {
597	my ($rdata, $objs) = @_;	783	my ($rdata, $objs) = @_;
…		…
602	}	788	}
603		789
604	sub object_thawer_load {	790	sub object_thawer_load {
605	my ($filename) = @_;	791	my ($filename) = @_;
606		792
607	local $/;	793	my ($data, $av);
608		794
609	my $av;	795	(aio_load $filename, $data) >= 0
		796	or return;
610		797
611	#TODO: use sysread etc.	798	unless (aio_stat "$filename.pst") {
612	if (open my $data, "<:raw:perlio", $filename) {	799	(aio_load "$filename.pst", $av) >= 0
613	$data = <$data>;	800	or return;
614	if (open my $pst, "<:raw:perlio", "$filename.pst") {
615	$av = eval { (Storable::thaw <$pst>)->{objs} };	801	$av = eval { (Storable::thaw $av)->{objs} };
616	}	802	}
		803
		804	warn sprintf "loading %s (%d)\n",
		805	$filename, length $data, scalar @{$av || []};#d#
617	return ($data, $av);	806	return ($data, $av);
618	}
619
620	()
621	}	807	}
622		808
623	#############################################################################	809	#############################################################################
624	# command handling &c	810	# command handling &c
625		811
…		…
649	=cut	835	=cut
650		836
651	sub register_extcmd {	837	sub register_extcmd {
652	my ($name, $cb) = @_;	838	my ($name, $cb) = @_;
653		839
654	my $caller = caller;
655	#warn "registering extcmd '$name' to '$caller'";
656
657	$EXTCMD{$name} = [$cb, $caller];	840	$EXTCMD{$name} = $cb;
658	}	841	}
659		842
660	cf::player->attach (	843	cf::player->attach (
661	on_command => sub {	844	on_command => sub {
662	my ($pl, $name, $params) = @_;	845	my ($pl, $name, $params) = @_;
…		…
675		858
676	my $msg = eval { from_json $buf };	859	my $msg = eval { from_json $buf };
677		860
678	if (ref $msg) {	861	if (ref $msg) {
679	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	862	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
680	if (my %reply = $cb->[0]->($pl, $msg)) {	863	if (my %reply = $cb->($pl, $msg)) {
681	$pl->ext_reply ($msg->{msgid}, %reply);	864	$pl->ext_reply ($msg->{msgid}, %reply);
682	}	865	}
683	}	866	}
684	} else {	867	} else {
685	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	868	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
…		…
687		870
688	cf::override;	871	cf::override;
689	},	872	},
690	);	873	);
691		874
692	sub register {
693	my ($base, $pkg) = @_;
694
695	#TODO
696	}
697
698	sub load_extension {	875	sub load_extension {
699	my ($path) = @_;	876	my ($path) = @_;
700		877
701	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	878	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
702	my $base = $1;	879	my $base = $1;
703	my $pkg = $1;	880	my $pkg = $1;
704	$pkg =~ s/[^[:word:]]/_/g;	881	$pkg =~ s/[^[:word:]]/_/g;
705	$pkg = "ext::$pkg";	882	$pkg = "ext::$pkg";
706		883
707	warn "loading '$path' into '$pkg'\n";	884	warn "... loading '$path' into '$pkg'\n";
708		885
709	open my $fh, "<:utf8", $path	886	open my $fh, "<:utf8", $path
710	or die "$path: $!";	887	or die "$path: $!";
711		888
712	my $source =	889	my $source =
713	"package $pkg; use strict; use utf8;\n"	890	"package $pkg; use strict; use utf8;\n"
714	. "#line 1 \"$path\"\n{\n"	891	. "#line 1 \"$path\"\n{\n"
715	. (do { local $/; <$fh> })	892	. (do { local $/; <$fh> })
716	. "\n};\n1";	893	. "\n};\n1";
717		894
718	eval $source	895	unless (eval $source) {
719	or die $@ ? "$path: $@\n"	896	my $msg = $@ ? "$path: $@\n"
720	: "extension disabled.\n";	897	: "extension disabled.\n";
721		898	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
722	push @exts, $pkg;	899	warn $@;
723	$ext_pkg{$base} = $pkg;	900	warn "mandatory extension failed to load, exiting.\n";
724		901	exit 1;
725	# no strict 'refs';	902	}
726	# @{"$pkg\::ISA"} = ext::;	903	die $@;
727
728	register $base, $pkg;
729	}
730
731	sub unload_extension {
732	my ($pkg) = @_;
733
734	warn "removing extension $pkg\n";
735
736	# remove hooks
737	#TODO
738	# for my $idx (0 .. $#PLUGIN_EVENT) {
739	# delete $hook[$idx]{$pkg};
740	# }	904	}
741		905
742	# remove commands	906	push @EXTS, $pkg;
743	for my $name (keys %COMMAND) {
744	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
745
746	if (@cb) {
747	$COMMAND{$name} = \@cb;
748	} else {
749	delete $COMMAND{$name};
750	}
751	}
752
753	# remove extcmds
754	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
755	delete $EXTCMD{$name};
756	}
757
758	if (my $cb = $pkg->can ("unload")) {
759	eval {
760	$cb->($pkg);
761	1
762	} or warn "$pkg unloaded, but with errors: $@";
763	}
764
765	Symbol::delete_package $pkg;
766	}	907	}
767		908
768	sub load_extensions {	909	sub load_extensions {
769	for my $ext (<$LIBDIR/*.ext>) {	910	for my $ext (<$LIBDIR/*.ext>) {
770	next unless -r $ext;	911	next unless -r $ext;
…		…
774	} or warn "$ext not loaded: $@";	915	} or warn "$ext not loaded: $@";
775	}	916	}
776	}	917	}
777		918
778	#############################################################################	919	#############################################################################
779	# load/save/clean perl data associated with a map
780		920
781	*cf::mapsupport::on_clean = sub {	921	=head2 CORE EXTENSIONS
		922
		923	Functions and methods that extend core crossfire objects.
		924
		925	=cut
		926
		927	package cf::player;
		928
		929	use Coro::AIO;
		930
		931	=head3 cf::player
		932
		933	=over 4
		934
		935	=item cf::player::find $login
		936
		937	Returns the given player object, loading it if necessary (might block).
		938
		939	=cut
		940
		941	sub playerdir($) {
		942	cf::localdir
		943	. "/"
		944	. cf::playerdir
		945	. "/"
		946	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		947	}
		948
		949	sub path($) {
		950	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		951
		952	(playerdir $login) . "/$login.pl"
		953	}
		954
		955	sub find_active($) {
		956	$cf::PLAYER{$_[0]}
		957	and $cf::PLAYER{$_[0]}->active
		958	and $cf::PLAYER{$_[0]}
		959	}
		960
		961	sub exists($) {
		962	my ($login) = @_;
		963
		964	$cf::PLAYER{$login}
		965	or cf::sync_job { !aio_stat path $login }
		966	}
		967
		968	sub find($) {
		969	return $cf::PLAYER{$_[0]} || do {
		970	my $login = $_[0];
		971
		972	my $guard = cf::lock_acquire "user_find:$login";
		973
		974	$cf::PLAYER{$_[0]} || do {
		975	my $pl = load_pl path $login
		976	or return;
		977	$cf::PLAYER{$login} = $pl
		978	}
		979	}
		980	}
		981
		982	sub save($) {
		983	my ($pl) = @_;
		984
		985	return if $pl->{deny_save};
		986
		987	my $path = path $pl;
		988	my $guard = cf::lock_acquire "user_save:$path";
		989
		990	return if $pl->{deny_save};
		991
		992	aio_mkdir playerdir $pl, 0770;
		993	$pl->{last_save} = $cf::RUNTIME;
		994
		995	$pl->save_pl ($path);
		996	Coro::cede;
		997	}
		998
		999	sub new($) {
		1000	my ($login) = @_;
		1001
		1002	my $self = create;
		1003
		1004	$self->ob->name ($login);
		1005	$self->{deny_save} = 1;
		1006
		1007	$cf::PLAYER{$login} = $self;
		1008
		1009	$self
		1010	}
		1011
		1012	=item $pl->quit_character
		1013
		1014	Nukes the player without looking back. If logged in, the connection will
		1015	be destroyed. May block for a long time.
		1016
		1017	=cut
		1018
		1019	sub quit_character {
		1020	my ($pl) = @_;
		1021
		1022	$pl->{deny_save} = 1;
		1023	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1024
		1025	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1026	$pl->deactivate;
		1027	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1028	$pl->ns->destroy if $pl->ns;
		1029
		1030	my $path = playerdir $pl;
		1031	my $temp = "$path~$cf::RUNTIME~deleting~";
		1032	aio_rename $path, $temp;
		1033	delete $cf::PLAYER{$pl->ob->name};
		1034	$pl->destroy;
		1035	IO::AIO::aio_rmtree $temp;
		1036	}
		1037
		1038	=item cf::player::list_logins
		1039
		1040	Returns am arrayref of all valid playernames in the system, can take a
		1041	while and may block, so not sync_job-capable, ever.
		1042
		1043	=cut
		1044
		1045	sub list_logins {
		1046	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
		1047	or return [];
		1048
		1049	my @logins;
		1050
		1051	for my $login (@$dirs) {
		1052	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1053	aio_read $fh, 0, 512, my $buf, 0 or next;
		1054	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1055
		1056	utf8::decode $login;
		1057	push @logins, $login;
		1058	}
		1059
		1060	\@logins
		1061	}
		1062
		1063	=item $player->maps
		1064
		1065	Returns an arrayref of map paths that are private for this
		1066	player. May block.
		1067
		1068	=cut
		1069
		1070	sub maps($) {
		1071	my ($pl) = @_;
		1072
		1073	my $files = aio_readdir playerdir $pl
		1074	or return;
		1075
		1076	my @paths;
		1077
		1078	for (@$files) {
		1079	utf8::decode $_;
		1080	next if /\.(?:pl|pst)$/;
		1081	next unless /^$PATH_SEP/o;
		1082
		1083	s/\.map$//;
		1084	push @paths, "~" . $pl->ob->name . "/" . $_;
		1085	}
		1086
		1087	\@paths
		1088	}
		1089
		1090	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1091
		1092	Sends an ext reply to the player.
		1093
		1094	=cut
		1095
		1096	sub ext_reply($$$%) {
		1097	my ($self, $id, %msg) = @_;
		1098
		1099	$msg{msgid} = $id;
		1100
		1101	$self->send ("ext " . cf::to_json \%msg);
		1102	}
		1103
		1104	package cf;
		1105
		1106	=back
		1107
		1108
		1109	=head3 cf::map
		1110
		1111	=over 4
		1112
		1113	=cut
		1114
		1115	package cf::map;
		1116
		1117	use Fcntl;
		1118	use Coro::AIO;
		1119
		1120	use overload
		1121	'""' => \&as_string,
		1122	fallback => 1;
		1123
		1124	our $MAX_RESET = 3600;
		1125	our $DEFAULT_RESET = 3000;
		1126
		1127	sub generate_random_map {
		1128	my ($self, $rmp) = @_;
		1129	# mit "rum" bekleckern, nicht
		1130	$self->_create_random_map (
		1131	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1132	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1133	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1134	$rmp->{exit_on_final_map},
		1135	$rmp->{xsize}, $rmp->{ysize},
		1136	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1137	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1138	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1139	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1140	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1141	(cf::region::find $rmp->{region}), $rmp->{custom}
		1142	)
		1143	}
		1144
		1145	=item cf::map->register ($regex, $prio)
		1146
		1147	Register a handler for the map path matching the given regex at the
		1148	givne priority (higher is better, built-in handlers have priority 0, the
		1149	default).
		1150
		1151	=cut
		1152
		1153	sub register {
		1154	my (undef, $regex, $prio) = @_;
		1155	my $pkg = caller;
		1156
		1157	no strict;
		1158	push @{"$pkg\::ISA"}, __PACKAGE__;
		1159
		1160	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1161	}
		1162
		1163	# also paths starting with '/'
		1164	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1165
		1166	sub thawer_merge {
		1167	my ($self, $merge) = @_;
		1168
		1169	# we have to keep some variables in memory intact
		1170	local $self->{path};
		1171	local $self->{load_path};
		1172	local $self->{deny_save};
		1173	local $self->{deny_reset};
		1174
		1175	$self->SUPER::thawer_merge ($merge);
		1176	}
		1177
		1178	sub normalise {
		1179	my ($path, $base) = @_;
		1180
		1181	$path = "$path"; # make sure its a string
		1182
		1183	# map plan:
		1184	#
		1185	# /! non-realised random map exit (special hack!)
		1186	# {... are special paths that are not being touched
		1187	# ?xxx/... are special absolute paths
		1188	# ?random/... random maps
		1189	# /... normal maps
		1190	# ~user/... per-player map of a specific user
		1191
		1192	$path =~ s/$PATH_SEP/\//go;
		1193
		1194	# treat it as relative path if it starts with
		1195	# something that looks reasonable
		1196	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1197	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1198
		1199	$base =~ s{[^/]+/?$}{};
		1200	$path = "$base/$path";
		1201	}
		1202
		1203	for ($path) {
		1204	redo if s{//}{/};
		1205	redo if s{/\.?/}{/};
		1206	redo if s{/[^/]+/\.\./}{/};
		1207	}
		1208
		1209	$path
		1210	}
		1211
		1212	sub new_from_path {
		1213	my (undef, $path, $base) = @_;
		1214
		1215	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1216
		1217	$path = normalise $path, $base;
		1218
		1219	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1220	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1221	my $self = bless cf::map::new, $pkg;
		1222	$self->{path} = $path; $self->path ($path);
		1223	$self->init; # pass $1 etc.
		1224	return $self;
		1225	}
		1226	}
		1227
		1228	Carp::carp "unable to resolve path '$path' (base '$base').";
		1229	()
		1230	}
		1231
		1232	sub init {
		1233	my ($self) = @_;
		1234
		1235	$self
		1236	}
		1237
		1238	sub as_string {
		1239	my ($self) = @_;
		1240
		1241	"$self->{path}"
		1242	}
		1243
		1244	# the displayed name, this is a one way mapping
		1245	sub visible_name {
		1246	&as_string
		1247	}
		1248
		1249	# the original (read-only) location
		1250	sub load_path {
		1251	my ($self) = @_;
		1252
		1253	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
		1254	}
		1255
		1256	# the temporary/swap location
		1257	sub save_path {
		1258	my ($self) = @_;
		1259
		1260	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1261	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path
		1262	}
		1263
		1264	# the unique path, undef == no special unique path
		1265	sub uniq_path {
		1266	my ($self) = @_;
		1267
		1268	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1269	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
		1270	}
		1271
		1272	# and all this just because we cannot iterate over
		1273	# all maps in C++...
		1274	sub change_all_map_light {
		1275	my ($change) = @_;
		1276
		1277	$_->change_map_light ($change)
		1278	for grep $_->outdoor, values %cf::MAP;
		1279	}
		1280
		1281	sub unlink_save {
		1282	my ($self) = @_;
		1283
		1284	utf8::encode (my $save = $self->save_path);
		1285	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1286	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1287	}
		1288
		1289	sub load_header_from($) {
		1290	my ($self, $path) = @_;
		1291
		1292	utf8::encode $path;
		1293	aio_open $path, O_RDONLY, 0
		1294	or return;
		1295
		1296	$self->_load_header ($path)
		1297	or return;
		1298
		1299	$self->{load_path} = $path;
		1300
		1301	1
		1302	}
		1303
		1304	sub load_header_orig {
		1305	my ($self) = @_;
		1306
		1307	$self->load_header_from ($self->load_path)
		1308	}
		1309
		1310	sub load_header_temp {
		1311	my ($self) = @_;
		1312
		1313	$self->load_header_from ($self->save_path)
		1314	}
		1315
		1316	sub prepare_temp {
		1317	my ($self) = @_;
		1318
		1319	$self->last_access ((delete $self->{last_access})
		1320	|| $cf::RUNTIME); #d#
		1321	# safety
		1322	$self->{instantiate_time} = $cf::RUNTIME
		1323	if $self->{instantiate_time} > $cf::RUNTIME;
		1324	}
		1325
		1326	sub prepare_orig {
		1327	my ($self) = @_;
		1328
		1329	$self->{load_original} = 1;
		1330	$self->{instantiate_time} = $cf::RUNTIME;
		1331	$self->last_access ($cf::RUNTIME);
		1332	$self->instantiate;
		1333	}
		1334
		1335	sub load_header {
		1336	my ($self) = @_;
		1337
		1338	if ($self->load_header_temp) {
		1339	$self->prepare_temp;
		1340	} else {
		1341	$self->load_header_orig
		1342	or return;
		1343	$self->prepare_orig;
		1344	}
		1345
		1346	1
		1347	}
		1348
		1349	sub find;
		1350	sub find {
		1351	my ($path, $origin) = @_;
		1352
		1353	$path = normalise $path, $origin && $origin->path;
		1354
		1355	cf::lock_wait "map_find:$path";
		1356
		1357	$cf::MAP{$path} || do {
		1358	my $guard = cf::lock_acquire "map_find:$path";
		1359	my $map = new_from_path cf::map $path
		1360	or return;
		1361
		1362	$map->{last_save} = $cf::RUNTIME;
		1363
		1364	$map->load_header
		1365	or return;
		1366
		1367	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)
		1368	# doing this can freeze the server in a sync job, obviously
		1369	#$cf::WAIT_FOR_TICK->wait;
		1370	$map->reset;
		1371	undef $guard;
		1372	return find $path;
		1373	}
		1374
		1375	$cf::MAP{$path} = $map
		1376	}
		1377	}
		1378
		1379	sub pre_load { }
		1380	sub post_load { }
		1381
		1382	sub load {
		1383	my ($self) = @_;
		1384
		1385	local $self->{deny_reset} = 1; # loading can take a long time
		1386
		1387	my $path = $self->{path};
		1388	my $guard = cf::lock_acquire "map_load:$path";
		1389
		1390	return if $self->in_memory != cf::MAP_SWAPPED;
		1391
		1392	$self->in_memory (cf::MAP_LOADING);
		1393
		1394	$self->alloc;
		1395
		1396	$self->pre_load;
		1397
		1398	$self->_load_objects ($self->{load_path}, 1)
		1399	or return;
		1400
		1401	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1402	if delete $self->{load_original};
		1403
		1404	if (my $uniq = $self->uniq_path) {
		1405	utf8::encode $uniq;
		1406	if (aio_open $uniq, O_RDONLY, 0) {
		1407	$self->clear_unique_items;
		1408	$self->_load_objects ($uniq, 0);
		1409	}
		1410	}
		1411
		1412	Coro::cede;
		1413
		1414	# now do the right thing for maps
		1415	$self->link_multipart_objects;
		1416
		1417	unless ($self->{deny_activate}) {
		1418	$self->decay_objects;
		1419	$self->fix_auto_apply;
		1420	$self->update_buttons;
		1421	Coro::cede;
		1422	$self->set_darkness_map;
		1423	$self->difficulty ($self->estimate_difficulty)
		1424	unless $self->difficulty;
		1425	Coro::cede;
		1426	$self->activate;
		1427	}
		1428
		1429	$self->post_load;
		1430
		1431	$self->in_memory (cf::MAP_IN_MEMORY);
		1432	}
		1433
		1434	sub customise_for {
		1435	my ($self, $ob) = @_;
		1436
		1437	return find "~" . $ob->name . "/" . $self->{path}
		1438	if $self->per_player;
		1439
		1440	$self
		1441	}
		1442
		1443	# find and load all maps in the 3x3 area around a map
		1444	sub load_diag {
782	my ($map) = @_;	1445	my ($map) = @_;
783		1446
784	my $path = $map->tmpname;	1447	my @diag; # diagonal neighbours
785	defined $path or return;
786		1448
787	unlink "$path.pst";	1449	for (0 .. 3) {
788	};	1450	my $neigh = $map->tile_path ($_)
		1451	or next;
		1452	$neigh = find $neigh, $map
		1453	or next;
		1454	$neigh->load;
789		1455
790	cf::map->attach (prio => -10000, package => cf::mapsupport::);	1456	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1457	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1458	}
791		1459
792	#############################################################################	1460	for (@diag) {
793	# load/save perl data associated with player->ob objects	1461	my $neigh = find @$_
794		1462	or next;
795	sub all_objects(@) {	1463	$neigh->load;
796	@_, map all_objects ($_->inv), @_	1464	}
797	}	1465	}
798		1466
799	# TODO: compatibility cruft, remove when no longer needed	1467	sub find_sync {
800	cf::player->attach (	1468	my ($path, $origin) = @_;
801	on_load => sub {
802	my ($pl, $path) = @_;
803		1469
804	for my $o (all_objects $pl->ob) {	1470	cf::sync_job { find $path, $origin }
805	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1471	}
806	$o->set_ob_key_value ("_perl_data");
807		1472
808	%$o = %{ Storable::thaw pack "H*", $value };	1473	sub do_load_sync {
		1474	my ($map) = @_;
		1475
		1476	cf::sync_job { $map->load };
		1477	}
		1478
		1479	our %MAP_PREFETCH;
		1480	our $MAP_PREFETCHER = undef;
		1481
		1482	sub find_async {
		1483	my ($path, $origin) = @_;
		1484
		1485	$path = normalise $path, $origin && $origin->{path};
		1486
		1487	if (my $map = $cf::MAP{$path}) {
		1488	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1489	}
		1490
		1491	undef $MAP_PREFETCH{$path};
		1492	$MAP_PREFETCHER ||= cf::async {
		1493	while (%MAP_PREFETCH) {
		1494	for my $path (keys %MAP_PREFETCH) {
		1495	my $map = find $path
		1496	or next;
		1497	$map->load;
		1498
		1499	delete $MAP_PREFETCH{$path};
809	}	1500	}
810	}	1501	}
		1502	undef $MAP_PREFETCHER;
		1503	};
		1504	$MAP_PREFETCHER->prio (6);
		1505
		1506	()
		1507	}
		1508
		1509	sub save {
		1510	my ($self) = @_;
		1511
		1512	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1513
		1514	$self->{last_save} = $cf::RUNTIME;
		1515
		1516	return unless $self->dirty;
		1517
		1518	my $save = $self->save_path; utf8::encode $save;
		1519	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1520
		1521	$self->{load_path} = $save;
		1522
		1523	return if $self->{deny_save};
		1524
		1525	local $self->{last_access} = $self->last_access;#d#
		1526
		1527	cf::async {
		1528	$_->contr->save for $self->players;
		1529	};
		1530
		1531	if ($uniq) {
		1532	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1533	$self->_save_objects ($uniq, cf::IO_UNIQUES);
		1534	} else {
		1535	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
811	},	1536	}
812	);	1537	}
813		1538
814	#############################################################################	1539	sub swap_out {
		1540	my ($self) = @_;
815		1541
816	=head2 CORE EXTENSIONS	1542	# save first because save cedes
		1543	$self->save;
817		1544
818	Functions and methods that extend core crossfire objects.	1545	my $lock = cf::lock_acquire "map_data:" . $self->path;
819		1546
820	=head3 cf::player	1547	return if $self->players;
		1548	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1549	return if $self->{deny_save};
		1550
		1551	$self->clear;
		1552	$self->in_memory (cf::MAP_SWAPPED);
		1553	}
		1554
		1555	sub reset_at {
		1556	my ($self) = @_;
		1557
		1558	# TODO: safety, remove and allow resettable per-player maps
		1559	return 1e99 if $self->isa ("ext::map_per_player");#d#
		1560	return 1e99 if $self->{deny_reset};
		1561
		1562	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1563	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1564
		1565	$time + $to
		1566	}
		1567
		1568	sub should_reset {
		1569	my ($self) = @_;
		1570
		1571	$self->reset_at <= $cf::RUNTIME
		1572	}
		1573
		1574	sub reset {
		1575	my ($self) = @_;
		1576
		1577	my $lock = cf::lock_acquire "map_data:$self->{path}";
		1578
		1579	return if $self->players;
		1580	return if $self->isa ("ext::map_per_player");#d#
		1581
		1582	warn "resetting map ", $self->path;#d#
		1583
		1584	delete $cf::MAP{$self->path};
		1585
		1586	$self->in_memory (cf::MAP_SWAPPED);
		1587	$self->clear;
		1588
		1589	$_->clear_links_to ($self) for values %cf::MAP;
		1590
		1591	$self->unlink_save;
		1592	$self->destroy;
		1593	}
		1594
		1595	my $nuke_counter = "aaaa";
		1596
		1597	sub nuke {
		1598	my ($self) = @_;
		1599
		1600	delete $cf::MAP{$self->path};
		1601
		1602	$self->unlink_save;
		1603
		1604	bless $self, "cf::map";
		1605	delete $self->{deny_reset};
		1606	$self->{deny_save} = 1;
		1607	$self->reset_timeout (1);
		1608	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		1609
		1610	$cf::MAP{$self->path} = $self;
		1611
		1612	$self->reset; # polite request, might not happen
		1613	}
		1614
		1615	=item cf::map::unique_maps
		1616
		1617	Returns an arrayref of paths of all shared maps that have
		1618	instantiated unique items. May block.
		1619
		1620	=cut
		1621
		1622	sub unique_maps() {
		1623	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
		1624	or return;
		1625
		1626	my @paths;
		1627
		1628	for (@$files) {
		1629	utf8::decode $_;
		1630	next if /\.pst$/;
		1631	next unless /^$PATH_SEP/o;
		1632
		1633	s/\.map$//;
		1634	push @paths, $_;
		1635	}
		1636
		1637	\@paths
		1638	}
		1639
		1640	package cf;
		1641
		1642	=back
		1643
		1644	=head3 cf::object
		1645
		1646	=cut
		1647
		1648	package cf::object;
821		1649
822	=over 4	1650	=over 4
823		1651
824	=item cf::player::exists $login	1652	=item $ob->inv_recursive
825		1653
826	Returns true when the given account exists.	1654	Returns the inventory of the object _and_ their inventories, recursively.
827		1655
828	=cut	1656	=cut
829		1657
830	sub cf::player::exists($) {	1658	sub inv_recursive_;
831	cf::player::find $_[0]	1659	sub inv_recursive_ {
832	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1660	map { $_, inv_recursive_ $_->inv } @_
833	}	1661	}
834		1662
835	=item $player->ext_reply ($msgid, $msgtype, %msg)	1663	sub inv_recursive {
836		1664	inv_recursive_ inv $_[0]
837	Sends an ext reply to the player.
838
839	=cut
840
841	sub cf::player::ext_reply($$$%) {
842	my ($self, $id, %msg) = @_;
843
844	$msg{msgid} = $id;
845
846	$self->send ("ext " . to_json \%msg);
847	}	1665	}
		1666
		1667	package cf;
848		1668
849	=back	1669	=back
850		1670
851	=head3 cf::object::player	1671	=head3 cf::object::player
852		1672
…		…
890	(ref $cf::CFG{"may_$access"}	1710	(ref $cf::CFG{"may_$access"}
891	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1711	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
892	: $cf::CFG{"may_$access"})	1712	: $cf::CFG{"may_$access"})
893	}	1713	}
894		1714
		1715	=item $player_object->enter_link
		1716
		1717	Freezes the player and moves him/her to a special map (C<{link}>).
		1718
		1719	The player should be reasonably safe there for short amounts of time. You
		1720	I<MUST> call C<leave_link> as soon as possible, though.
		1721
		1722	Will never block.
		1723
		1724	=item $player_object->leave_link ($map, $x, $y)
		1725
		1726	Moves the player out of the special C<{link}> map onto the specified
		1727	map. If the map is not valid (or omitted), the player will be moved back
		1728	to the location he/she was before the call to C<enter_link>, or, if that
		1729	fails, to the emergency map position.
		1730
		1731	Might block.
		1732
		1733	=cut
		1734
		1735	sub link_map {
		1736	unless ($LINK_MAP) {
		1737	$LINK_MAP = cf::map::find "{link}"
		1738	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		1739	$LINK_MAP->load;
		1740	}
		1741
		1742	$LINK_MAP
		1743	}
		1744
		1745	sub cf::object::player::enter_link {
		1746	my ($self) = @_;
		1747
		1748	$self->deactivate_recursive;
		1749
		1750	return if UNIVERSAL::isa $self->map, "ext::map_link";
		1751
		1752	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1753	if $self->map;
		1754
		1755	$self->enter_map ($LINK_MAP || link_map, 10, 10);
		1756	}
		1757
		1758	sub cf::object::player::leave_link {
		1759	my ($self, $map, $x, $y) = @_;
		1760
		1761	my $link_pos = delete $self->{_link_pos};
		1762
		1763	unless ($map) {
		1764	# restore original map position
		1765	($map, $x, $y) = @{ $link_pos || [] };
		1766	$map = cf::map::find $map;
		1767
		1768	unless ($map) {
		1769	($map, $x, $y) = @$EMERGENCY_POSITION;
		1770	$map = cf::map::find $map
		1771	or die "FATAL: cannot load emergency map\n";
		1772	}
		1773	}
		1774
		1775	($x, $y) = (-1, -1)
		1776	unless (defined $x) && (defined $y);
		1777
		1778	# use -1 or undef as default coordinates, not 0, 0
		1779	($x, $y) = ($map->enter_x, $map->enter_y)
		1780	if $x <=0 && $y <= 0;
		1781
		1782	$map->load;
		1783	$map->load_diag;
		1784
		1785	return unless $self->contr->active;
		1786	$self->activate_recursive;
		1787	$self->enter_map ($map, $x, $y);
		1788	}
		1789
		1790	cf::player->attach (
		1791	on_logout => sub {
		1792	my ($pl) = @_;
		1793
		1794	# abort map switching before logout
		1795	if ($pl->ob->{_link_pos}) {
		1796	cf::sync_job {
		1797	$pl->ob->leave_link
		1798	};
		1799	}
		1800	},
		1801	on_login => sub {
		1802	my ($pl) = @_;
		1803
		1804	# try to abort aborted map switching on player login :)
		1805	# should happen only on crashes
		1806	if ($pl->ob->{_link_pos}) {
		1807	$pl->ob->enter_link;
		1808	(async {
		1809	# we need this sleep as the login has a concurrent enter_exit running
		1810	# and this sleep increases chances of the player not ending up in scorn
		1811	$pl->ob->reply (undef,
		1812	"There was an internal problem at your last logout, "
		1813	. "the server will try to bring you to your intended destination in a second.",
		1814	cf::NDI_RED);
		1815	Coro::Timer::sleep 1;
		1816	$pl->ob->leave_link;
		1817	})->prio (2);
		1818	}
		1819	},
		1820	);
		1821
		1822	=item $player_object->goto ($path, $x, $y)
		1823
		1824	=cut
		1825
		1826	sub cf::object::player::goto {
		1827	my ($self, $path, $x, $y) = @_;
		1828
		1829	$self->enter_link;
		1830
		1831	(async {
		1832	my $map = cf::map::find $path;
		1833	$map = $map->customise_for ($self) if $map;
		1834
		1835	# warn "entering ", $map->path, " at ($x, $y)\n"
		1836	# if $map;
		1837
		1838	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1839
		1840	$self->leave_link ($map, $x, $y);
		1841	})->prio (1);
		1842	}
		1843
		1844	=item $player_object->enter_exit ($exit_object)
		1845
		1846	=cut
		1847
		1848	sub parse_random_map_params {
		1849	my ($spec) = @_;
		1850
		1851	my $rmp = { # defaults
		1852	xsize => (cf::rndm 15, 40),
		1853	ysize => (cf::rndm 15, 40),
		1854	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		1855	#layout => string,
		1856	};
		1857
		1858	for (split /\n/, $spec) {
		1859	my ($k, $v) = split /\s+/, $_, 2;
		1860
		1861	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1862	}
		1863
		1864	$rmp
		1865	}
		1866
		1867	sub prepare_random_map {
		1868	my ($exit) = @_;
		1869
		1870	my $guard = cf::lock_acquire "exit_prepare:$exit";
		1871
		1872	# all this does is basically replace the /! path by
		1873	# a new random map path (?random/...) with a seed
		1874	# that depends on the exit object
		1875
		1876	my $rmp = parse_random_map_params $exit->msg;
		1877
		1878	if ($exit->map) {
		1879	$rmp->{region} = $exit->map->region_name;
		1880	$rmp->{origin_map} = $exit->map->path;
		1881	$rmp->{origin_x} = $exit->x;
		1882	$rmp->{origin_y} = $exit->y;
		1883	}
		1884
		1885	$rmp->{random_seed} ||= $exit->random_seed;
		1886
		1887	my $data = cf::to_json $rmp;
		1888	my $md5 = Digest::MD5::md5_hex $data;
		1889	my $meta = "$cf::RANDOM_MAPS/$md5.meta";
		1890
		1891	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		1892	aio_write $fh, 0, (length $data), $data, 0;
		1893	undef $fh;
		1894	aio_rename "$meta~", $meta;
		1895
		1896	$exit->slaying ("?random/$md5");
		1897	$exit->msg (undef);
		1898	}
		1899	}
		1900
		1901	sub cf::object::player::enter_exit {
		1902	my ($self, $exit) = @_;
		1903
		1904	return unless $self->type == cf::PLAYER;
		1905
		1906	if ($exit->slaying eq "/!") {
		1907	#TODO: this should de-fi-ni-te-ly not be a sync-job
		1908	cf::sync_job { prepare_random_map $exit };
		1909	}
		1910
		1911	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		1912	my $hp = $exit->stats->hp;
		1913	my $sp = $exit->stats->sp;
		1914
		1915	$self->enter_link;
		1916
		1917	(async {
		1918	$self->deactivate_recursive; # just to be sure
		1919	unless (eval {
		1920	$self->goto ($slaying, $hp, $sp);
		1921
		1922	1;
		1923	}) {
		1924	$self->message ("Something went wrong deep within the crossfire server. "
		1925	. "I'll try to bring you back to the map you were before. "
		1926	. "Please report this to the dungeon master!",
		1927	cf::NDI_UNIQUE | cf::NDI_RED);
		1928
		1929	warn "ERROR in enter_exit: $@";
		1930	$self->leave_link;
		1931	}
		1932	})->prio (1);
		1933	}
		1934
895	=head3 cf::client	1935	=head3 cf::client
896		1936
897	=over 4	1937	=over 4
898		1938
899	=item $client->send_drawinfo ($text, $flags)	1939	=item $client->send_drawinfo ($text, $flags)
…		…
942	on_reply => sub {	1982	on_reply => sub {
943	my ($ns, $msg) = @_;	1983	my ($ns, $msg) = @_;
944		1984
945	# this weird shuffling is so that direct followup queries	1985	# this weird shuffling is so that direct followup queries
946	# get handled first	1986	# get handled first
947	my $queue = delete $ns->{query_queue};	1987	my $queue = delete $ns->{query_queue}
		1988	or return; # be conservative, not sure how that can happen, but we saw a crash here
948		1989
949	(shift @$queue)->[1]->($msg);	1990	(shift @$queue)->[1]->($msg);
950		1991
951	push @{ $ns->{query_queue} }, @$queue;	1992	push @{ $ns->{query_queue} }, @$queue;
952		1993
…		…
958	}	1999	}
959	}	2000	}
960	},	2001	},
961	);	2002	);
962		2003
963	=item $client->coro (\&cb)	2004	=item $client->async (\&cb)
964		2005
965	Create a new coroutine, running the specified callback. The coroutine will	2006	Create a new coroutine, running the specified callback. The coroutine will
966	be automatically cancelled when the client gets destroyed (e.g. on logout,	2007	be automatically cancelled when the client gets destroyed (e.g. on logout,
967	or loss of connection).	2008	or loss of connection).
968		2009
969	=cut	2010	=cut
970		2011
971	sub cf::client::coro {	2012	sub cf::client::async {
972	my ($self, $cb) = @_;	2013	my ($self, $cb) = @_;
973		2014
974	my $coro; $coro = async {	2015	my $coro = &Coro::async ($cb);
975	eval {
976	$cb->();
977	};
978	warn $@ if $@;
979	};
980		2016
981	$coro->on_destroy (sub {	2017	$coro->on_destroy (sub {
982	delete $self->{_coro}{$coro+0};	2018	delete $self->{_coro}{$coro+0};
983	});	2019	});
984		2020
…		…
1156		2192
1157	{	2193	{
1158	my $path = cf::localdir . "/database.pst";	2194	my $path = cf::localdir . "/database.pst";
1159		2195
1160	sub db_load() {	2196	sub db_load() {
1161	warn "loading database $path\n";#d# remove later
1162	$DB = stat $path ? Storable::retrieve $path : { };	2197	$DB = stat $path ? Storable::retrieve $path : { };
1163	}	2198	}
1164		2199
1165	my $pid;	2200	my $pid;
1166		2201
1167	sub db_save() {	2202	sub db_save() {
1168	warn "saving database $path\n";#d# remove later
1169	waitpid $pid, 0 if $pid;	2203	waitpid $pid, 0 if $pid;
1170	if (0 == ($pid = fork)) {	2204	if (0 == ($pid = fork)) {
1171	$DB->{_meta}{version} = 1;	2205	$DB->{_meta}{version} = 1;
1172	Storable::nstore $DB, "$path~";	2206	Storable::nstore $DB, "$path~";
1173	rename "$path~", $path;	2207	rename "$path~", $path;
…		…
1180	sub db_sync() {	2214	sub db_sync() {
1181	db_save if $dirty;	2215	db_save if $dirty;
1182	undef $dirty;	2216	undef $dirty;
1183	}	2217	}
1184		2218
1185	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {	2219	my $idle = Event->idle (
1186	db_sync;	2220	reentrant => 0,
		2221	min => 10,
		2222	max => 20,
		2223	repeat => 0,
		2224	data => WF_AUTOCANCEL,
		2225	cb => \&db_sync,
1187	});	2226	);
1188		2227
1189	sub db_dirty() {	2228	sub db_dirty() {
1190	$dirty = 1;	2229	$dirty = 1;
1191	$idle->start;	2230	$idle->start;
1192	}	2231	}
…		…
1221	open my $fh, "<:utf8", cf::confdir . "/config"	2260	open my $fh, "<:utf8", cf::confdir . "/config"
1222	or return;	2261	or return;
1223		2262
1224	local $/;	2263	local $/;
1225	*CFG = YAML::Syck::Load <$fh>;	2264	*CFG = YAML::Syck::Load <$fh>;
		2265
		2266	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2267
		2268	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2269	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2270
		2271	if (exists $CFG{mlockall}) {
		2272	eval {
		2273	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2274	and die "WARNING: m(un)lockall failed: $!\n";
		2275	};
		2276	warn $@ if $@;
		2277	}
1226	}	2278	}
1227		2279
1228	sub main {	2280	sub main {
		2281	# we must not ever block the main coroutine
		2282	local $Coro::idle = sub {
		2283	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2284	(async {
		2285	Event::one_event;
		2286	})->prio (Coro::PRIO_MAX);
		2287	};
		2288
1229	cfg_load;	2289	cfg_load;
1230	db_load;	2290	db_load;
1231	load_extensions;	2291	load_extensions;
		2292
		2293	$TICK_WATCHER->start;
1232	Event::loop;	2294	Event::loop;
1233	}	2295	}
1234		2296
1235	#############################################################################	2297	#############################################################################
1236	# initialisation	2298	# initialisation and cleanup
1237		2299
		2300	# install some emergency cleanup handlers
		2301	BEGIN {
		2302	for my $signal (qw(INT HUP TERM)) {
		2303	Event->signal (
		2304	reentrant => 0,
		2305	data => WF_AUTOCANCEL,
		2306	signal => $signal,
		2307	prio => 0,
		2308	cb => sub {
		2309	cf::cleanup "SIG$signal";
		2310	},
		2311	);
		2312	}
		2313	}
		2314
		2315	sub emergency_save() {
		2316	my $freeze_guard = cf::freeze_mainloop;
		2317
		2318	warn "enter emergency perl save\n";
		2319
		2320	cf::sync_job {
		2321	# use a peculiar iteration method to avoid tripping on perl
		2322	# refcount bugs in for. also avoids problems with players
		2323	# and maps saved/destroyed asynchronously.
		2324	warn "begin emergency player save\n";
		2325	for my $login (keys %cf::PLAYER) {
		2326	my $pl = $cf::PLAYER{$login} or next;
		2327	$pl->valid or next;
		2328	$pl->save;
		2329	}
		2330	warn "end emergency player save\n";
		2331
		2332	warn "begin emergency map save\n";
		2333	for my $path (keys %cf::MAP) {
		2334	my $map = $cf::MAP{$path} or next;
		2335	$map->valid or next;
		2336	$map->save;
		2337	}
		2338	warn "end emergency map save\n";
		2339	};
		2340
		2341	warn "leave emergency perl save\n";
		2342	}
		2343
1238	sub _perl_reload() {	2344	sub reload() {
		2345	# can/must only be called in main
		2346	if ($Coro::current != $Coro::main) {
		2347	warn "can only reload from main coroutine";
		2348	return;
		2349	}
		2350
1239	warn "reloading...";	2351	warn "reloading...";
1240		2352
		2353	warn "cancelling server ticker";
		2354	$TICK_WATCHER->cancel;
		2355
		2356	cf::emergency_save;
		2357
1241	eval {	2358	eval {
1242	local $FREEZE = 1;	2359	# if anything goes wrong in here, we should simply crash as we already saved
1243		2360
1244	cf::emergency_save;	2361	warn "syncing database to disk";
		2362	cf::db_sync;
1245		2363
1246	# cancel all watchers	2364	warn "cancelling all WF_AUTOCANCEL watchers";
1247	for (Event::all_watchers) {	2365	for (Event::all_watchers) {
1248	$_->cancel if $_->data & WF_AUTOCANCEL;	2366	$_->cancel if $_->data & WF_AUTOCANCEL;
1249	}	2367	}
1250		2368
		2369	warn "flushing outstanding aio requests";
		2370	for (;;) {
		2371	IO::AIO::flush;
		2372	Coro::cede;
		2373	last unless IO::AIO::nreqs;
		2374	warn "iterate...";
		2375	}
		2376
1251	# cancel all extension coros	2377	warn "cancelling all extension coros";
1252	$_->cancel for values %EXT_CORO;	2378	$_->cancel for values %EXT_CORO;
1253	%EXT_CORO = ();	2379	%EXT_CORO = ();
1254		2380
1255	# unload all extensions	2381	warn "removing commands";
1256	for (@exts) {	2382	%COMMAND = ();
		2383
		2384	warn "removing ext commands";
		2385	%EXTCMD = ();
		2386
		2387	warn "unloading/nuking all extensions";
		2388	for my $pkg (@EXTS) {
1257	warn "unloading <$_>";	2389	warn "... unloading $pkg";
1258	unload_extension $_;	2390
		2391	if (my $cb = $pkg->can ("unload")) {
		2392	eval {
		2393	$cb->($pkg);
		2394	1
		2395	} or warn "$pkg unloaded, but with errors: $@";
1259	}	2396	}
1260		2397
		2398	warn "... nuking $pkg";
		2399	Symbol::delete_package $pkg;
		2400	}
		2401
1261	# unload all modules loaded from $LIBDIR	2402	warn "unloading all perl modules loaded from $LIBDIR";
1262	while (my ($k, $v) = each %INC) {	2403	while (my ($k, $v) = each %INC) {
1263	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2404	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1264		2405
1265	warn "removing <$k>";	2406	warn "... unloading $k";
1266	delete $INC{$k};	2407	delete $INC{$k};
1267		2408
1268	$k =~ s/\.pm$//;	2409	$k =~ s/\.pm$//;
1269	$k =~ s/\//::/g;	2410	$k =~ s/\//::/g;
1270		2411
…		…
1273	}	2414	}
1274		2415
1275	Symbol::delete_package $k;	2416	Symbol::delete_package $k;
1276	}	2417	}
1277		2418
1278	# sync database to disk
1279	cf::db_sync;
1280	IO::AIO::flush;
1281
1282	# get rid of safe::, as good as possible	2419	warn "getting rid of safe::, as good as possible";
1283	Symbol::delete_package "safe::$_"	2420	Symbol::delete_package "safe::$_"
1284	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2421	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1285		2422
1286	# remove register_script_function callbacks
1287	# TODO
1288
1289	# unload cf.pm "a bit"	2423	warn "unloading cf.pm \"a bit\"";
1290	delete $INC{"cf.pm"};	2424	delete $INC{"cf.pm"};
1291		2425
1292	# don't, removes xs symbols, too,	2426	# don't, removes xs symbols, too,
1293	# and global variables created in xs	2427	# and global variables created in xs
1294	#Symbol::delete_package __PACKAGE__;	2428	#Symbol::delete_package __PACKAGE__;
1295		2429
1296	# reload cf.pm	2430	warn "unload completed, starting to reload now";
		2431
1297	warn "reloading cf.pm";	2432	warn "reloading cf.pm";
1298	require cf;	2433	require cf;
1299	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	2434	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1300		2435
1301	# load config and database again	2436	warn "loading config and database again";
1302	cf::cfg_load;	2437	cf::cfg_load;
1303	cf::db_load;	2438	cf::db_load;
1304		2439
1305	# load extensions
1306	warn "load extensions";	2440	warn "loading extensions";
1307	cf::load_extensions;	2441	cf::load_extensions;
1308		2442
1309	# reattach attachments to objects	2443	warn "reattaching attachments to objects/players";
1310	warn "reattach";
1311	_global_reattach;	2444	_global_reattach;
		2445	warn "reattaching attachments to maps";
		2446	reattach $_ for values %MAP;
		2447
		2448	warn "restarting server ticker";
		2449
		2450	$TICK_WATCHER->start;
1312	};	2451	};
1313	warn $@ if $@;	2452
		2453	if ($@) {
		2454	warn $@;
		2455	warn "error while reloading, exiting.";
		2456	exit 1;
		2457	}
1314		2458
1315	warn "reloaded";	2459	warn "reloaded";
1316	};	2460	};
1317		2461
1318	sub perl_reload() {	2462	our $RELOAD_WATCHER; # used only during reload
1319	_perl_reload;
1320	}
1321		2463
1322	register "<global>", __PACKAGE__;
1323
1324	register_command "perl-reload" => sub {	2464	register_command "reload" => sub {
1325	my ($who, $arg) = @_;	2465	my ($who, $arg) = @_;
1326		2466
1327	if ($who->flag (FLAG_WIZ)) {	2467	if ($who->flag (FLAG_WIZ)) {
1328	$who->message ("reloading...");	2468	$who->message ("reloading server.");
1329	_perl_reload;	2469
		2470	# doing reload synchronously and two reloads happen back-to-back,
		2471	# coro crashes during coro_state_free->destroy here.
		2472
		2473	$RELOAD_WATCHER ||= Event->timer (
		2474	reentrant => 0,
		2475	after => 0,
		2476	data => WF_AUTOCANCEL,
		2477	cb => sub {
		2478	reload;
		2479	undef $RELOAD_WATCHER;
		2480	},
		2481	);
1330	}	2482	}
1331	};	2483	};
1332		2484
1333	unshift @INC, $LIBDIR;	2485	unshift @INC, $LIBDIR;
1334		2486
		2487	my $bug_warning = 0;
		2488
1335	$TICK_WATCHER = Event->timer (	2489	$TICK_WATCHER = Event->timer (
		2490	reentrant => 0,
		2491	parked => 1,
1336	prio => 0,	2492	prio => 0,
1337	at => $NEXT_TICK || $TICK,	2493	at => $NEXT_TICK || $TICK,
1338	data => WF_AUTOCANCEL,	2494	data => WF_AUTOCANCEL,
1339	cb => sub {	2495	cb => sub {
1340	unless ($FREEZE) {	2496	if ($Coro::current != $Coro::main) {
		2497	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		2498	unless ++$bug_warning > 10;
		2499	return;
		2500	}
		2501
		2502	$NOW = Event::time;
		2503
1341	cf::server_tick; # one server iteration	2504	cf::server_tick; # one server iteration
1342	$RUNTIME += $TICK;	2505	$RUNTIME += $TICK;
1343	}
1344
1345	$NEXT_TICK += $TICK;	2506	$NEXT_TICK += $TICK;
		2507
		2508	$WAIT_FOR_TICK->broadcast;
		2509	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
		2510
		2511	Event::sweep;
		2512	Coro::cede_notself;
		2513
		2514	# my $AFTER = Event::time;
		2515	# warn $AFTER - $NOW;#d#
1346		2516
1347	# if we are delayed by four ticks or more, skip them all	2517	# if we are delayed by four ticks or more, skip them all
1348	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	2518	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1349		2519
1350	$TICK_WATCHER->at ($NEXT_TICK);	2520	$TICK_WATCHER->at ($NEXT_TICK);
1351	$TICK_WATCHER->start;	2521	$TICK_WATCHER->start;
1352	},	2522	},
1353	);	2523	);
1354		2524
1355	IO::AIO::max_poll_time $TICK * 0.2;	2525	IO::AIO::max_poll_time $TICK * 0.1;
1356		2526
		2527	undef $Coro::AIO::WATCHER;
		2528	$AIO_POLL_WATCHER = Event->io (
		2529	reentrant => 0,
1357	Event->io (fd => IO::AIO::poll_fileno,	2530	fd => IO::AIO::poll_fileno,
1358	poll => 'r',	2531	poll => 'r',
1359	prio => 5,	2532	prio => 6,
1360	data => WF_AUTOCANCEL,	2533	data => WF_AUTOCANCEL,
1361	cb => \&IO::AIO::poll_cb);	2534	cb => \&IO::AIO::poll_cb,
		2535	);
1362		2536
1363	# we must not ever block the main coroutine	2537	$WRITE_RUNTIME_WATCHER = Event->timer (
1364	$Coro::idle = sub {	2538	reentrant => 0,
1365	#Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#	2539	data => WF_AUTOCANCEL,
1366	warn "FATAL: Coro::idle was called, major BUG\n";	2540	after => 1,
		2541	interval => 10,
		2542	prio => 6, # keep it lowest so it acts like a watchdog
1367	(Coro::unblock_sub {	2543	cb => Coro::unblock_sub {
1368	Event::one_event;	2544	write_runtime
1369	})->();	2545	or warn "ERROR: unable to write runtime file: $!";
1370	};	2546	},
		2547	);
		2548
		2549	END { cf::emergency_save }
1371		2550
1372	1	2551	1
1373		2552

Diff Legend

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