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.198 by root, Sun Jan 28 01:58:37 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;
71		87
72	#############################################################################	88	#############################################################################
73		89
74	=head2 GLOBAL VARIABLES	90	=head2 GLOBAL VARIABLES
75		91
…		…
99		115
100	=item %cf::CFG	116	=item %cf::CFG
101		117
102	Configuration for the server, loaded from C</etc/crossfire/config>, or	118	Configuration for the server, loaded from C</etc/crossfire/config>, or
103	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.
104		127
105	=back	128	=back
106		129
107	=cut	130	=cut
108		131
…		…
112	utf8::encode $msg;	135	utf8::encode $msg;
113		136
114	$msg .= "\n"	137	$msg .= "\n"
115	unless $msg =~ /\n$/;	138	unless $msg =~ /\n$/;
116		139
117	LOG llevError, "cfperl: $msg";	140	LOG llevError, $msg;
118	};	141	};
119	}	142	}
120		143
121	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	144	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
122	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	145	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
…		…
140		163
141	$Event::DIED = sub {	164	$Event::DIED = sub {
142	warn "error in event callback: @_";	165	warn "error in event callback: @_";
143	};	166	};
144		167
145	my %ext_pkg;
146	my @exts;
147	my @hook;
148
149	=head2 UTILITY FUNCTIONS	168	=head2 UTILITY FUNCTIONS
150		169
151	=over 4	170	=over 4
152		171
		172	=item dumpval $ref
		173
153	=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	}
154		194
155	use JSON::Syck (); # TODO# replace by JSON::PC once working	195	use JSON::Syck (); # TODO# replace by JSON::PC once working
156		196
157	=item $ref = cf::from_json $json	197	=item $ref = cf::from_json $json
158		198
…		…
174	sub to_json($) {	214	sub to_json($) {
175	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	215	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
176	JSON::Syck::Dump $_[0]	216	JSON::Syck::Dump $_[0]
177	}	217	}
178		218
179	# main coro must never ever "block" except in Event	219	=item cf::lock_wait $string
180	# sync_job ensures this by running the job in a coroutine	220
181	# and waiting in Event while the server is otherwise frozen	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
182	sub sync_job(&) {	296	sub sync_job(&) {
183	my ($job) = @_;	297	my ($job) = @_;
184		298
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) {	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;
197	$coro->prio (Coro::PRIO_MAX);	314	})->prio (Coro::PRIO_MAX);
		315
198	while ($busy) {	316	while ($busy) {
199	Coro::cede_notself;	317	Coro::cede or Event::one_event;
200	Event::one_event unless Coro::nready;
201	}	318	}
		319
		320	wantarray ? @res : $res[0]
202	} else {	321	} else {
203	$coro->join;	322	# we are in another coroutine, how wonderful, everything just works
		323
		324	$job->()
204	}	325	}
205
206	wantarray ? @res : $res[0]
207	}	326	}
208		327
209	=item $coro = cf::coro { BLOCK }	328	=item $coro = cf::async_ext { BLOCK }
210		329
211	Creates and returns a new coro. This coro is automcatially being canceled	330	Like async, but this coro is automatically being canceled when the
212	when the extension calling this is being unloaded.	331	extension calling this is being unloaded.
213		332
214	=cut	333	=cut
215		334
216	sub coro(&) {	335	sub async_ext(&) {
217	my $cb = shift;	336	my $cb = shift;
218		337
219	my $coro; $coro = async {	338	my $coro = &Coro::async ($cb);
220	eval {
221	$cb->();
222	};
223	warn $@ if $@;
224	};
225		339
226	$coro->on_destroy (sub {	340	$coro->on_destroy (sub {
227	delete $EXT_CORO{$coro+0};	341	delete $EXT_CORO{$coro+0};
228	});	342	});
229	$EXT_CORO{$coro+0} = $coro;	343	$EXT_CORO{$coro+0} = $coro;
230		344
231	$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
232	}	371	}
233		372
234	=back	373	=back
235		374
236	=cut	375	=cut
…		…
367	our @CB_TYPE = (); # registry for type (cf-object class) based events	506	our @CB_TYPE = (); # registry for type (cf-object class) based events
368	our @CB_MAP = ();	507	our @CB_MAP = ();
369		508
370	my %attachment;	509	my %attachment;
371		510
		511	sub cf::attachable::thawer_merge {
		512	# simply override everything except _meta
		513	local $_[0]{_meta};
		514	%{$_[0]} = %{$_[1]};
		515	}
		516
372	sub _attach_cb($$$$) {	517	sub _attach_cb($$$$) {
373	my ($registry, $event, $prio, $cb) = @_;	518	my ($registry, $event, $prio, $cb) = @_;
374		519
375	use sort 'stable';	520	use sort 'stable';
376		521
…		…
547	# object support	692	# object support
548		693
549	sub reattach {	694	sub reattach {
550	# basically do the same as instantiate, without calling instantiate	695	# basically do the same as instantiate, without calling instantiate
551	my ($obj) = @_;	696	my ($obj) = @_;
		697
		698	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
552		699
553	my $registry = $obj->registry;	700	my $registry = $obj->registry;
554		701
555	@$registry = ();	702	@$registry = ();
556		703
…		…
649	or return;	796	or return;
650		797
651	unless (aio_stat "$filename.pst") {	798	unless (aio_stat "$filename.pst") {
652	(aio_load "$filename.pst", $av) >= 0	799	(aio_load "$filename.pst", $av) >= 0
653	or return;	800	or return;
654	$av = eval { (Storable::thaw <$av>)->{objs} };	801	$av = eval { (Storable::thaw $av)->{objs} };
655	}	802	}
656		803
		804	warn sprintf "loading %s (%d)\n",
		805	$filename, length $data, scalar @{$av || []};#d#
657	return ($data, $av);	806	return ($data, $av);
658	}	807	}
659		808
660	#############################################################################	809	#############################################################################
661	# command handling &c	810	# command handling &c
…		…
686	=cut	835	=cut
687		836
688	sub register_extcmd {	837	sub register_extcmd {
689	my ($name, $cb) = @_;	838	my ($name, $cb) = @_;
690		839
691	my $caller = caller;
692	#warn "registering extcmd '$name' to '$caller'";
693
694	$EXTCMD{$name} = [$cb, $caller];	840	$EXTCMD{$name} = $cb;
695	}	841	}
696		842
697	cf::player->attach (	843	cf::player->attach (
698	on_command => sub {	844	on_command => sub {
699	my ($pl, $name, $params) = @_;	845	my ($pl, $name, $params) = @_;
…		…
712		858
713	my $msg = eval { from_json $buf };	859	my $msg = eval { from_json $buf };
714		860
715	if (ref $msg) {	861	if (ref $msg) {
716	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	862	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
717	if (my %reply = $cb->[0]->($pl, $msg)) {	863	if (my %reply = $cb->($pl, $msg)) {
718	$pl->ext_reply ($msg->{msgid}, %reply);	864	$pl->ext_reply ($msg->{msgid}, %reply);
719	}	865	}
720	}	866	}
721	} else {	867	} else {
722	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	868	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
…		…
724		870
725	cf::override;	871	cf::override;
726	},	872	},
727	);	873	);
728		874
729	sub register {
730	my ($base, $pkg) = @_;
731
732	#TODO
733	}
734
735	sub load_extension {	875	sub load_extension {
736	my ($path) = @_;	876	my ($path) = @_;
737		877
738	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	878	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
739	my $base = $1;	879	my $base = $1;
740	my $pkg = $1;	880	my $pkg = $1;
741	$pkg =~ s/[^[:word:]]/_/g;	881	$pkg =~ s/[^[:word:]]/_/g;
742	$pkg = "ext::$pkg";	882	$pkg = "ext::$pkg";
743		883
744	warn "loading '$path' into '$pkg'\n";	884	warn "... loading '$path' into '$pkg'\n";
745		885
746	open my $fh, "<:utf8", $path	886	open my $fh, "<:utf8", $path
747	or die "$path: $!";	887	or die "$path: $!";
748		888
749	my $source =	889	my $source =
750	"package $pkg; use strict; use utf8;\n"	890	"package $pkg; use strict; use utf8;\n"
751	. "#line 1 \"$path\"\n{\n"	891	. "#line 1 \"$path\"\n{\n"
752	. (do { local $/; <$fh> })	892	. (do { local $/; <$fh> })
753	. "\n};\n1";	893	. "\n};\n1";
754		894
755	eval $source	895	unless (eval $source) {
756	or die $@ ? "$path: $@\n"	896	my $msg = $@ ? "$path: $@\n"
757	: "extension disabled.\n";	897	: "extension disabled.\n";
758		898	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
759	push @exts, $pkg;	899	warn $@;
760	$ext_pkg{$base} = $pkg;	900	warn "mandatory extension failed to load, exiting.\n";
761		901	exit 1;
762	# no strict 'refs';	902	}
763	# @{"$pkg\::ISA"} = ext::;	903	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	# }	904	}
778		905
779	# remove commands	906	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	}	907	}
804		908
805	sub load_extensions {	909	sub load_extensions {
806	for my $ext (<$LIBDIR/*.ext>) {	910	for my $ext (<$LIBDIR/*.ext>) {
807	next unless -r $ext;	911	next unless -r $ext;
…		…
811	} or warn "$ext not loaded: $@";	915	} or warn "$ext not loaded: $@";
812	}	916	}
813	}	917	}
814		918
815	#############################################################################	919	#############################################################################
816	# load/save/clean perl data associated with a map
817		920
818	*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 {
819	my ($map) = @_;	1445	my ($map) = @_;
820		1446
821	my $path = $map->tmpname;	1447	my @diag; # diagonal neighbours
822	defined $path or return;
823		1448
824	unlink "$path.pst";	1449	for (0 .. 3) {
825	};	1450	my $neigh = $map->tile_path ($_)
		1451	or next;
		1452	$neigh = find $neigh, $map
		1453	or next;
		1454	$neigh->load;
826		1455
827	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	}
828		1459
829	#############################################################################	1460	for (@diag) {
830	# load/save perl data associated with player->ob objects	1461	my $neigh = find @$_
831		1462	or next;
832	sub all_objects(@) {	1463	$neigh->load;
833	@_, map all_objects ($_->inv), @_	1464	}
834	}	1465	}
835		1466
836	# TODO: compatibility cruft, remove when no longer needed	1467	sub find_sync {
837	cf::player->attach (	1468	my ($path, $origin) = @_;
838	on_load => sub {
839	my ($pl, $path) = @_;
840		1469
841	for my $o (all_objects $pl->ob) {	1470	cf::sync_job { find $path, $origin }
842	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1471	}
843	$o->set_ob_key_value ("_perl_data");
844		1472
845	%$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};
846	}	1500	}
847	}	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);
848	},	1536	}
849	);	1537	}
850		1538
851	#############################################################################	1539	sub swap_out {
		1540	my ($self) = @_;
852		1541
853	=head2 CORE EXTENSIONS	1542	# save first because save cedes
		1543	$self->save;
854		1544
855	Functions and methods that extend core crossfire objects.	1545	my $lock = cf::lock_acquire "map_data:" . $self->path;
856		1546
857	=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;
858		1649
859	=over 4	1650	=over 4
860		1651
861	=item cf::player::exists $login	1652	=item $ob->inv_recursive
862		1653
863	Returns true when the given account exists.	1654	Returns the inventory of the object _and_ their inventories, recursively.
864		1655
865	=cut	1656	=cut
866		1657
867	sub cf::player::exists($) {	1658	sub inv_recursive_;
868	cf::player::find $_[0]	1659	sub inv_recursive_ {
869	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1660	map { $_, inv_recursive_ $_->inv } @_
870	}	1661	}
871		1662
872	=item $player->ext_reply ($msgid, $msgtype, %msg)	1663	sub inv_recursive {
873		1664	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	}	1665	}
		1666
		1667	package cf;
885		1668
886	=back	1669	=back
887		1670
888	=head3 cf::object::player	1671	=head3 cf::object::player
889		1672
…		…
927	(ref $cf::CFG{"may_$access"}	1710	(ref $cf::CFG{"may_$access"}
928	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1711	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
929	: $cf::CFG{"may_$access"})	1712	: $cf::CFG{"may_$access"})
930	}	1713	}
931		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 = eval {
		1833	my $map = cf::map::find $path;
		1834	$map = $map->customise_for ($self) if $map;
		1835	$map
		1836	} or
		1837	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1838
		1839	$self->leave_link ($map, $x, $y);
		1840	})->prio (1);
		1841	}
		1842
		1843	=item $player_object->enter_exit ($exit_object)
		1844
		1845	=cut
		1846
		1847	sub parse_random_map_params {
		1848	my ($spec) = @_;
		1849
		1850	my $rmp = { # defaults
		1851	xsize => (cf::rndm 15, 40),
		1852	ysize => (cf::rndm 15, 40),
		1853	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		1854	#layout => string,
		1855	};
		1856
		1857	for (split /\n/, $spec) {
		1858	my ($k, $v) = split /\s+/, $_, 2;
		1859
		1860	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1861	}
		1862
		1863	$rmp
		1864	}
		1865
		1866	sub prepare_random_map {
		1867	my ($exit) = @_;
		1868
		1869	my $guard = cf::lock_acquire "exit_prepare:$exit";
		1870
		1871	# all this does is basically replace the /! path by
		1872	# a new random map path (?random/...) with a seed
		1873	# that depends on the exit object
		1874
		1875	my $rmp = parse_random_map_params $exit->msg;
		1876
		1877	if ($exit->map) {
		1878	$rmp->{region} = $exit->region->name;
		1879	$rmp->{origin_map} = $exit->map->path;
		1880	$rmp->{origin_x} = $exit->x;
		1881	$rmp->{origin_y} = $exit->y;
		1882	}
		1883
		1884	$rmp->{random_seed} ||= $exit->random_seed;
		1885
		1886	my $data = cf::to_json $rmp;
		1887	my $md5 = Digest::MD5::md5_hex $data;
		1888	my $meta = "$cf::RANDOM_MAPS/$md5.meta";
		1889
		1890	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		1891	aio_write $fh, 0, (length $data), $data, 0;
		1892	undef $fh;
		1893	aio_rename "$meta~", $meta;
		1894
		1895	$exit->slaying ("?random/$md5");
		1896	$exit->msg (undef);
		1897	}
		1898	}
		1899
		1900	sub cf::object::player::enter_exit {
		1901	my ($self, $exit) = @_;
		1902
		1903	return unless $self->type == cf::PLAYER;
		1904
		1905	if ($exit->slaying eq "/!") {
		1906	#TODO: this should de-fi-ni-te-ly not be a sync-job
		1907	cf::sync_job { prepare_random_map $exit };
		1908	}
		1909
		1910	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		1911	my $hp = $exit->stats->hp;
		1912	my $sp = $exit->stats->sp;
		1913
		1914	$self->enter_link;
		1915
		1916	(async {
		1917	$self->deactivate_recursive; # just to be sure
		1918	unless (eval {
		1919	$self->goto ($slaying, $hp, $sp);
		1920
		1921	1;
		1922	}) {
		1923	$self->message ("Something went wrong deep within the crossfire server. "
		1924	. "I'll try to bring you back to the map you were before. "
		1925	. "Please report this to the dungeon master!",
		1926	cf::NDI_UNIQUE | cf::NDI_RED);
		1927
		1928	warn "ERROR in enter_exit: $@";
		1929	$self->leave_link;
		1930	}
		1931	})->prio (1);
		1932	}
		1933
932	=head3 cf::client	1934	=head3 cf::client
933		1935
934	=over 4	1936	=over 4
935		1937
936	=item $client->send_drawinfo ($text, $flags)	1938	=item $client->send_drawinfo ($text, $flags)
…		…
979	on_reply => sub {	1981	on_reply => sub {
980	my ($ns, $msg) = @_;	1982	my ($ns, $msg) = @_;
981		1983
982	# this weird shuffling is so that direct followup queries	1984	# this weird shuffling is so that direct followup queries
983	# get handled first	1985	# get handled first
984	my $queue = delete $ns->{query_queue};	1986	my $queue = delete $ns->{query_queue}
		1987	or return; # be conservative, not sure how that can happen, but we saw a crash here
985		1988
986	(shift @$queue)->[1]->($msg);	1989	(shift @$queue)->[1]->($msg);
987		1990
988	push @{ $ns->{query_queue} }, @$queue;	1991	push @{ $ns->{query_queue} }, @$queue;
989		1992
…		…
995	}	1998	}
996	}	1999	}
997	},	2000	},
998	);	2001	);
999		2002
1000	=item $client->coro (\&cb)	2003	=item $client->async (\&cb)
1001		2004
1002	Create a new coroutine, running the specified callback. The coroutine will	2005	Create a new coroutine, running the specified callback. The coroutine will
1003	be automatically cancelled when the client gets destroyed (e.g. on logout,	2006	be automatically cancelled when the client gets destroyed (e.g. on logout,
1004	or loss of connection).	2007	or loss of connection).
1005		2008
1006	=cut	2009	=cut
1007		2010
1008	sub cf::client::coro {	2011	sub cf::client::async {
1009	my ($self, $cb) = @_;	2012	my ($self, $cb) = @_;
1010		2013
1011	my $coro; $coro = async {	2014	my $coro = &Coro::async ($cb);
1012	eval {
1013	$cb->();
1014	};
1015	warn $@ if $@;
1016	};
1017		2015
1018	$coro->on_destroy (sub {	2016	$coro->on_destroy (sub {
1019	delete $self->{_coro}{$coro+0};	2017	delete $self->{_coro}{$coro+0};
1020	});	2018	});
1021		2019
…		…
1193		2191
1194	{	2192	{
1195	my $path = cf::localdir . "/database.pst";	2193	my $path = cf::localdir . "/database.pst";
1196		2194
1197	sub db_load() {	2195	sub db_load() {
1198	warn "loading database $path\n";#d# remove later
1199	$DB = stat $path ? Storable::retrieve $path : { };	2196	$DB = stat $path ? Storable::retrieve $path : { };
1200	}	2197	}
1201		2198
1202	my $pid;	2199	my $pid;
1203		2200
1204	sub db_save() {	2201	sub db_save() {
1205	warn "saving database $path\n";#d# remove later
1206	waitpid $pid, 0 if $pid;	2202	waitpid $pid, 0 if $pid;
1207	if (0 == ($pid = fork)) {	2203	if (0 == ($pid = fork)) {
1208	$DB->{_meta}{version} = 1;	2204	$DB->{_meta}{version} = 1;
1209	Storable::nstore $DB, "$path~";	2205	Storable::nstore $DB, "$path~";
1210	rename "$path~", $path;	2206	rename "$path~", $path;
…		…
1217	sub db_sync() {	2213	sub db_sync() {
1218	db_save if $dirty;	2214	db_save if $dirty;
1219	undef $dirty;	2215	undef $dirty;
1220	}	2216	}
1221		2217
1222	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {	2218	my $idle = Event->idle (
1223	db_sync;	2219	reentrant => 0,
		2220	min => 10,
		2221	max => 20,
		2222	repeat => 0,
		2223	data => WF_AUTOCANCEL,
		2224	cb => \&db_sync,
1224	});	2225	);
1225		2226
1226	sub db_dirty() {	2227	sub db_dirty() {
1227	$dirty = 1;	2228	$dirty = 1;
1228	$idle->start;	2229	$idle->start;
1229	}	2230	}
…		…
1258	open my $fh, "<:utf8", cf::confdir . "/config"	2259	open my $fh, "<:utf8", cf::confdir . "/config"
1259	or return;	2260	or return;
1260		2261
1261	local $/;	2262	local $/;
1262	*CFG = YAML::Syck::Load <$fh>;	2263	*CFG = YAML::Syck::Load <$fh>;
		2264
		2265	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2266
		2267	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2268	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2269
		2270	if (exists $CFG{mlockall}) {
		2271	eval {
		2272	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2273	and die "WARNING: m(un)lockall failed: $!\n";
		2274	};
		2275	warn $@ if $@;
		2276	}
1263	}	2277	}
1264		2278
1265	sub main {	2279	sub main {
		2280	# we must not ever block the main coroutine
		2281	local $Coro::idle = sub {
		2282	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2283	(async {
		2284	Event::one_event;
		2285	})->prio (Coro::PRIO_MAX);
		2286	};
		2287
1266	cfg_load;	2288	cfg_load;
1267	db_load;	2289	db_load;
1268	load_extensions;	2290	load_extensions;
		2291
		2292	$TICK_WATCHER->start;
1269	Event::loop;	2293	Event::loop;
1270	}	2294	}
1271		2295
1272	#############################################################################	2296	#############################################################################
1273	# initialisation	2297	# initialisation and cleanup
1274		2298
		2299	# install some emergency cleanup handlers
		2300	BEGIN {
		2301	for my $signal (qw(INT HUP TERM)) {
		2302	Event->signal (
		2303	reentrant => 0,
		2304	data => WF_AUTOCANCEL,
		2305	signal => $signal,
		2306	prio => 0,
		2307	cb => sub {
		2308	cf::cleanup "SIG$signal";
		2309	},
		2310	);
		2311	}
		2312	}
		2313
		2314	sub emergency_save() {
		2315	my $freeze_guard = cf::freeze_mainloop;
		2316
		2317	warn "enter emergency perl save\n";
		2318
		2319	cf::sync_job {
		2320	# use a peculiar iteration method to avoid tripping on perl
		2321	# refcount bugs in for. also avoids problems with players
		2322	# and maps saved/destroyed asynchronously.
		2323	warn "begin emergency player save\n";
		2324	for my $login (keys %cf::PLAYER) {
		2325	my $pl = $cf::PLAYER{$login} or next;
		2326	$pl->valid or next;
		2327	$pl->save;
		2328	}
		2329	warn "end emergency player save\n";
		2330
		2331	warn "begin emergency map save\n";
		2332	for my $path (keys %cf::MAP) {
		2333	my $map = $cf::MAP{$path} or next;
		2334	$map->valid or next;
		2335	$map->save;
		2336	}
		2337	warn "end emergency map save\n";
		2338	};
		2339
		2340	warn "leave emergency perl save\n";
		2341	}
		2342
1275	sub _perl_reload() {	2343	sub reload() {
		2344	# can/must only be called in main
		2345	if ($Coro::current != $Coro::main) {
		2346	warn "can only reload from main coroutine";
		2347	return;
		2348	}
		2349
1276	warn "reloading...";	2350	warn "reloading...";
1277		2351
		2352	warn "cancelling server ticker";
		2353	$TICK_WATCHER->cancel;
		2354
		2355	cf::emergency_save;
		2356
1278	eval {	2357	eval {
1279	local $FREEZE = 1;	2358	# if anything goes wrong in here, we should simply crash as we already saved
1280		2359
1281	cf::emergency_save;	2360	warn "syncing database to disk";
		2361	cf::db_sync;
1282		2362
1283	# cancel all watchers	2363	warn "cancelling all WF_AUTOCANCEL watchers";
1284	for (Event::all_watchers) {	2364	for (Event::all_watchers) {
1285	$_->cancel if $_->data & WF_AUTOCANCEL;	2365	$_->cancel if $_->data & WF_AUTOCANCEL;
1286	}	2366	}
1287		2367
		2368	warn "flushing outstanding aio requests";
		2369	for (;;) {
		2370	IO::AIO::flush;
		2371	Coro::cede;
		2372	last unless IO::AIO::nreqs;
		2373	warn "iterate...";
		2374	}
		2375
1288	# cancel all extension coros	2376	warn "cancelling all extension coros";
1289	$_->cancel for values %EXT_CORO;	2377	$_->cancel for values %EXT_CORO;
1290	%EXT_CORO = ();	2378	%EXT_CORO = ();
1291		2379
1292	# unload all extensions	2380	warn "removing commands";
1293	for (@exts) {	2381	%COMMAND = ();
		2382
		2383	warn "removing ext commands";
		2384	%EXTCMD = ();
		2385
		2386	warn "unloading/nuking all extensions";
		2387	for my $pkg (@EXTS) {
1294	warn "unloading <$_>";	2388	warn "... unloading $pkg";
1295	unload_extension $_;	2389
		2390	if (my $cb = $pkg->can ("unload")) {
		2391	eval {
		2392	$cb->($pkg);
		2393	1
		2394	} or warn "$pkg unloaded, but with errors: $@";
1296	}	2395	}
1297		2396
		2397	warn "... nuking $pkg";
		2398	Symbol::delete_package $pkg;
		2399	}
		2400
1298	# unload all modules loaded from $LIBDIR	2401	warn "unloading all perl modules loaded from $LIBDIR";
1299	while (my ($k, $v) = each %INC) {	2402	while (my ($k, $v) = each %INC) {
1300	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2403	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1301		2404
1302	warn "removing <$k>";	2405	warn "... unloading $k";
1303	delete $INC{$k};	2406	delete $INC{$k};
1304		2407
1305	$k =~ s/\.pm$//;	2408	$k =~ s/\.pm$//;
1306	$k =~ s/\//::/g;	2409	$k =~ s/\//::/g;
1307		2410
…		…
1310	}	2413	}
1311		2414
1312	Symbol::delete_package $k;	2415	Symbol::delete_package $k;
1313	}	2416	}
1314		2417
1315	# sync database to disk
1316	cf::db_sync;
1317	IO::AIO::flush;
1318
1319	# get rid of safe::, as good as possible	2418	warn "getting rid of safe::, as good as possible";
1320	Symbol::delete_package "safe::$_"	2419	Symbol::delete_package "safe::$_"
1321	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2420	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1322		2421
1323	# remove register_script_function callbacks
1324	# TODO
1325
1326	# unload cf.pm "a bit"	2422	warn "unloading cf.pm \"a bit\"";
1327	delete $INC{"cf.pm"};	2423	delete $INC{"cf.pm"};
1328		2424
1329	# don't, removes xs symbols, too,	2425	# don't, removes xs symbols, too,
1330	# and global variables created in xs	2426	# and global variables created in xs
1331	#Symbol::delete_package __PACKAGE__;	2427	#Symbol::delete_package __PACKAGE__;
1332		2428
1333	# reload cf.pm	2429	warn "unload completed, starting to reload now";
		2430
1334	warn "reloading cf.pm";	2431	warn "reloading cf.pm";
1335	require cf;	2432	require cf;
1336	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	2433	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1337		2434
1338	# load config and database again	2435	warn "loading config and database again";
1339	cf::cfg_load;	2436	cf::cfg_load;
1340	cf::db_load;	2437	cf::db_load;
1341		2438
1342	# load extensions
1343	warn "load extensions";	2439	warn "loading extensions";
1344	cf::load_extensions;	2440	cf::load_extensions;
1345		2441
1346	# reattach attachments to objects	2442	warn "reattaching attachments to objects/players";
1347	warn "reattach";
1348	_global_reattach;	2443	_global_reattach;
		2444	warn "reattaching attachments to maps";
		2445	reattach $_ for values %MAP;
		2446
		2447	warn "restarting server ticker";
		2448
		2449	$TICK_WATCHER->start;
1349	};	2450	};
1350	warn $@ if $@;	2451
		2452	if ($@) {
		2453	warn $@;
		2454	warn "error while reloading, exiting.";
		2455	exit 1;
		2456	}
1351		2457
1352	warn "reloaded";	2458	warn "reloaded";
1353	};	2459	};
1354		2460
1355	sub perl_reload() {	2461	our $RELOAD_WATCHER; # used only during reload
1356	_perl_reload;
1357	}
1358		2462
1359	register "<global>", __PACKAGE__;
1360
1361	register_command "perl-reload" => sub {	2463	register_command "reload" => sub {
1362	my ($who, $arg) = @_;	2464	my ($who, $arg) = @_;
1363		2465
1364	if ($who->flag (FLAG_WIZ)) {	2466	if ($who->flag (FLAG_WIZ)) {
1365	$who->message ("reloading...");	2467	$who->message ("reloading server.");
1366	_perl_reload;	2468
		2469	# doing reload synchronously and two reloads happen back-to-back,
		2470	# coro crashes during coro_state_free->destroy here.
		2471
		2472	$RELOAD_WATCHER ||= Event->timer (
		2473	reentrant => 0,
		2474	after => 0,
		2475	data => WF_AUTOCANCEL,
		2476	cb => sub {
		2477	reload;
		2478	undef $RELOAD_WATCHER;
		2479	},
		2480	);
1367	}	2481	}
1368	};	2482	};
1369		2483
1370	unshift @INC, $LIBDIR;	2484	unshift @INC, $LIBDIR;
		2485
		2486	my $bug_warning = 0;
1371		2487
1372	$TICK_WATCHER = Event->timer (	2488	$TICK_WATCHER = Event->timer (
1373	reentrant => 0,	2489	reentrant => 0,
		2490	parked => 1,
1374	prio => 0,	2491	prio => 0,
1375	at => $NEXT_TICK || $TICK,	2492	at => $NEXT_TICK || $TICK,
1376	data => WF_AUTOCANCEL,	2493	data => WF_AUTOCANCEL,
1377	cb => sub {	2494	cb => sub {
1378	unless ($FREEZE) {	2495	if ($Coro::current != $Coro::main) {
		2496	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		2497	unless ++$bug_warning > 10;
		2498	return;
		2499	}
		2500
		2501	$NOW = Event::time;
		2502
1379	cf::server_tick; # one server iteration	2503	cf::server_tick; # one server iteration
1380	$RUNTIME += $TICK;	2504	$RUNTIME += $TICK;
1381	}
1382
1383	$NEXT_TICK += $TICK;	2505	$NEXT_TICK += $TICK;
		2506
		2507	$WAIT_FOR_TICK->broadcast;
		2508	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
		2509
		2510	Event::sweep;
		2511	Coro::cede_notself;
		2512
		2513	# my $AFTER = Event::time;
		2514	# warn $AFTER - $NOW;#d#
1384		2515
1385	# if we are delayed by four ticks or more, skip them all	2516	# if we are delayed by four ticks or more, skip them all
1386	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	2517	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1387		2518
1388	$TICK_WATCHER->at ($NEXT_TICK);	2519	$TICK_WATCHER->at ($NEXT_TICK);
1389	$TICK_WATCHER->start;	2520	$TICK_WATCHER->start;
1390	},	2521	},
1391	);	2522	);
1392		2523
1393	IO::AIO::max_poll_time $TICK * 0.2;	2524	IO::AIO::max_poll_time $TICK * 0.1;
1394		2525
		2526	undef $Coro::AIO::WATCHER;
		2527	$AIO_POLL_WATCHER = Event->io (
		2528	reentrant => 0,
1395	Event->io (fd => IO::AIO::poll_fileno,	2529	fd => IO::AIO::poll_fileno,
1396	poll => 'r',	2530	poll => 'r',
1397	prio => 5,	2531	prio => 6,
1398	data => WF_AUTOCANCEL,	2532	data => WF_AUTOCANCEL,
1399	cb => \&IO::AIO::poll_cb);	2533	cb => \&IO::AIO::poll_cb,
		2534	);
1400		2535
1401	# we must not ever block the main coroutine	2536	$WRITE_RUNTIME_WATCHER = Event->timer (
1402	$Coro::idle = sub {	2537	reentrant => 0,
1403	#Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#	2538	data => WF_AUTOCANCEL,
1404	warn "FATAL: Coro::idle was called, major BUG\n";	2539	after => 1,
		2540	interval => 10,
		2541	prio => 6, # keep it lowest so it acts like a watchdog
1405	(Coro::unblock_sub {	2542	cb => Coro::unblock_sub {
1406	Event::one_event;	2543	write_runtime
1407	})->();	2544	or warn "ERROR: unable to write runtime file: $!";
1408	};	2545	},
		2546	);
		2547
		2548	END { cf::emergency_save }
1409		2549
1410	1	2550	1
1411		2551

Diff Legend

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