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

Diff Legend

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