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.101 by root, Mon Dec 25 14:43:23 2006 UTC vs.
Revision 1.176 by root, Sun Jan 14 22:14:35 2007 UTC

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

Diff Legend

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