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.105 by root, Sun Dec 31 17:17:23 2006 UTC vs.
Revision 1.199 by root, Mon Jan 29 14:46:01 2007 UTC

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

Diff Legend

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