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.104 by root, Sat Dec 30 16:56:16 2006 UTC vs.
Revision 1.253 by root, Wed Apr 18 17:32:07 2007 UTC

…		…
3	use utf8;	3	use utf8;
4	use strict;	4	use strict;
5		5
6	use Symbol;	6	use Symbol;
7	use List::Util;	7	use List::Util;
		8	use Socket;
8	use Storable;	9	use Storable;
		10	use Event;
9	use Opcode;	11	use Opcode;
10	use Safe;	12	use Safe;
11	use Safe::Hole;	13	use Safe::Hole;
12		14
13	use Coro 3.3;	15	use Coro 3.61 ();
		16	use Coro::State;
		17	use Coro::Handle;
14	use Coro::Event;	18	use Coro::Event;
15	use Coro::Timer;	19	use Coro::Timer;
16	use Coro::Signal;	20	use Coro::Signal;
17	use Coro::Semaphore;	21	use Coro::Semaphore;
		22	use Coro::AIO;
		23	use Coro::Storable;
18		24
19	use IO::AIO 2.3;	25	use BDB ();
		26	use Data::Dumper;
		27	use Digest::MD5;
		28	use Fcntl;
20	use YAML::Syck ();	29	use YAML::Syck ();
		30	use IO::AIO 2.32 ();
21	use Time::HiRes;	31	use Time::HiRes;
		32	use Compress::LZF;
22		33
		34	# configure various modules to our taste
		35	#
		36	$Storable::canonical = 1; # reduce rsync transfers
		37	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		38	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		39
23	use Event; $Event::Eval = 1; # no idea why this is required, but it is	40	$Event::Eval = 1; # no idea why this is required, but it is
24		41
25	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	42	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
26	$YAML::Syck::ImplicitUnicode = 1;	43	$YAML::Syck::ImplicitUnicode = 1;
27		44
28	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority	45	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
29		46
30	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	47	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
31		48
32	our %COMMAND = ();	49	our %COMMAND = ();
33	our %COMMAND_TIME = ();	50	our %COMMAND_TIME = ();
		51
		52	our @EXTS = (); # list of extension package names
34	our %EXTCMD = ();	53	our %EXTCMD = ();
		54	our %EXT_CORO = (); # coroutines bound to extensions
		55	our %EXT_MAP = (); # pluggable maps
35		56
		57	our $RELOAD; # number of reloads so far
36	our @EVENT;	58	our @EVENT;
37	our $LIBDIR = datadir . "/ext";
38		59
39	our $TICK = MAX_TIME * 1e-6;	60	our $CONFDIR = confdir;
		61	our $DATADIR = datadir;
		62	our $LIBDIR = "$DATADIR/ext";
		63	our $PODDIR = "$DATADIR/pod";
		64	our $MAPDIR = "$DATADIR/" . mapdir;
		65	our $LOCALDIR = localdir;
		66	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		67	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		68	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		69	our $RANDOMDIR = "$LOCALDIR/random";
		70	our $BDBDIR = "$LOCALDIR/db";
		71
		72	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
40	our $TICK_WATCHER;	73	our $TICK_WATCHER;
		74	our $AIO_POLL_WATCHER;
		75	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
41	our $NEXT_TICK;	76	our $NEXT_TICK;
42	our $NOW;	77	our $NOW;
		78	our $USE_FSYNC = 1; # use fsync to write maps - default off
		79
		80	our $BDB_POLL_WATCHER;
		81	our $DB_ENV;
43		82
44	our %CFG;	83	our %CFG;
45		84
46	our $UPTIME; $UPTIME ||= time;	85	our $UPTIME; $UPTIME ||= time;
47	our $RUNTIME;	86	our $RUNTIME;
48		87
		88	our %PLAYER; # all users
49	our %MAP; # all maps	89	our %MAP; # all maps
50	our $LINK_MAP; # the special {link} map	90	our $LINK_MAP; # the special {link} map, which is always available
51	our $FREEZE;	91
		92	# used to convert map paths into valid unix filenames by replacing / by ∕
		93	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
52		94
53	binmode STDOUT;	95	binmode STDOUT;
54	binmode STDERR;	96	binmode STDERR;
55		97
56	# read virtual server time, if available	98	# read virtual server time, if available
57	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	99	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
58	open my $fh, "<", cf::localdir . "/runtime"	100	open my $fh, "<", "$LOCALDIR/runtime"
59	or die "unable to read runtime file: $!";	101	or die "unable to read runtime file: $!";
60	$RUNTIME = <$fh> + 0.;	102	$RUNTIME = <$fh> + 0.;
61	}	103	}
62		104
63	mkdir cf::localdir;	105	mkdir $_
64	mkdir cf::localdir . "/" . cf::playerdir;	106	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
65	mkdir cf::localdir . "/" . cf::tmpdir;
66	mkdir cf::localdir . "/" . cf::uniquedir;
67		107
68	our %EXT_CORO;	108	our $EMERGENCY_POSITION;
		109
		110	sub cf::map::normalise;
69		111
70	#############################################################################	112	#############################################################################
71		113
72	=head2 GLOBAL VARIABLES	114	=head2 GLOBAL VARIABLES
73		115
…		…
80	=item $cf::RUNTIME	122	=item $cf::RUNTIME
81		123
82	The time this server has run, starts at 0 and is increased by $cf::TICK on	124	The time this server has run, starts at 0 and is increased by $cf::TICK on
83	every server tick.	125	every server tick.
84		126
85	=item $cf::LIBDIR	127	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		128	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		129	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
86		130
87	The perl library directory, where extensions and cf-specific modules can	131	Various directories - "/etc", read-only install directory, perl-library
88	be found. It will be added to C<@INC> automatically.	132	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		133	unique-items directory, player file directory, random maps directory and
		134	database environment.
89		135
90	=item $cf::NOW	136	=item $cf::NOW
91		137
92	The time of the last (current) server tick.	138	The time of the last (current) server tick.
93		139
…		…
97		143
98	=item %cf::CFG	144	=item %cf::CFG
99		145
100	Configuration for the server, loaded from C</etc/crossfire/config>, or	146	Configuration for the server, loaded from C</etc/crossfire/config>, or
101	from wherever your confdir points to.	147	from wherever your confdir points to.
		148
		149	=item cf::wait_for_tick, cf::wait_for_tick_begin
		150
		151	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
		152	returns directly I<after> the tick processing (and consequently, can only wake one process
		153	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
102		154
103	=back	155	=back
104		156
105	=cut	157	=cut
106		158
107	BEGIN {	159	BEGIN {
108	*CORE::GLOBAL::warn = sub {	160	*CORE::GLOBAL::warn = sub {
109	my $msg = join "", @_;	161	my $msg = join "", @_;
110	utf8::encode $msg;
111		162
112	$msg .= "\n"	163	$msg .= "\n"
113	unless $msg =~ /\n$/;	164	unless $msg =~ /\n$/;
114		165
		166	$msg =~ s/([\x00-\x09\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		167
		168	utf8::encode $msg;
115	LOG llevError, "cfperl: $msg";	169	LOG llevError, $msg;
116	};	170	};
117	}	171	}
118		172
119	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	173	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
120	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	174	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
…		…
138		192
139	$Event::DIED = sub {	193	$Event::DIED = sub {
140	warn "error in event callback: @_";	194	warn "error in event callback: @_";
141	};	195	};
142		196
143	my %ext_pkg;
144	my @exts;
145	my @hook;
146
147	=head2 UTILITY FUNCTIONS	197	=head2 UTILITY FUNCTIONS
148		198
149	=over 4	199	=over 4
150		200
151	=cut	201	=item dumpval $ref
152		202
		203	=cut
		204
		205	sub dumpval {
		206	eval {
		207	local $SIG{__DIE__};
		208	my $d;
		209	if (1) {
		210	$d = new Data::Dumper([$_[0]], ["*var"]);
		211	$d->Terse(1);
		212	$d->Indent(2);
		213	$d->Quotekeys(0);
		214	$d->Useqq(1);
		215	#$d->Bless(...);
		216	$d->Seen($_[1]) if @_ > 1;
		217	$d = $d->Dump();
		218	}
		219	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		220	$d
		221	} || "[unable to dump $_[0]: '$@']";
		222	}
		223
153	use JSON::Syck (); # TODO# replace by JSON::PC once working	224	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
154		225
155	=item $ref = cf::from_json $json	226	=item $ref = cf::from_json $json
156		227
157	Converts a JSON string into the corresponding perl data structure.	228	Converts a JSON string into the corresponding perl data structure.
158		229
159	=cut
160
161	sub from_json($) {
162	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
163	JSON::Syck::Load $_[0]
164	}
165
166	=item $json = cf::to_json $ref	230	=item $json = cf::to_json $ref
167		231
168	Converts a perl data structure into its JSON representation.	232	Converts a perl data structure into its JSON representation.
169		233
170	=cut	234	=item cf::lock_wait $string
171		235
172	sub to_json($) {	236	Wait until the given lock is available. See cf::lock_acquire.
173	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
174	JSON::Syck::Dump $_[0]
175	}
176		237
		238	=item my $lock = cf::lock_acquire $string
		239
		240	Wait until the given lock is available and then acquires it and returns
		241	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
		242	for example when the coroutine gets canceled), the lock is automatically
		243	returned.
		244
		245	Lock names should begin with a unique identifier (for example, cf::map::find
		246	uses map_find and cf::map::load uses map_load).
		247
		248	=item $locked = cf::lock_active $string
		249
		250	Return true if the lock is currently active, i.e. somebody has locked it.
		251
		252	=cut
		253
		254	our %LOCK;
		255
		256	sub lock_wait($) {
		257	my ($key) = @_;
		258
		259	# wait for lock, if any
		260	while ($LOCK{$key}) {
		261	push @{ $LOCK{$key} }, $Coro::current;
		262	Coro::schedule;
		263	}
		264	}
		265
		266	sub lock_acquire($) {
		267	my ($key) = @_;
		268
		269	# wait, to be sure we are not locked
		270	lock_wait $key;
		271
		272	$LOCK{$key} = [];
		273
		274	Coro::guard {
		275	# wake up all waiters, to be on the safe side
		276	$_->ready for @{ delete $LOCK{$key} };
		277	}
		278	}
		279
		280	sub lock_active($) {
		281	my ($key) = @_;
		282
		283	! ! $LOCK{$key}
		284	}
		285
		286	sub freeze_mainloop {
		287	return unless $TICK_WATCHER->is_active;
		288
		289	my $guard = Coro::guard {
		290	$TICK_WATCHER->start;
		291	};
		292	$TICK_WATCHER->stop;
		293	$guard
		294	}
		295
		296	=item cf::async { BLOCK }
		297
		298	Currently the same as Coro::async_pool, meaning you cannot use
		299	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		300	thing you are allowed to do is call C<prio> on it.
		301
		302	=cut
		303
		304	BEGIN { *async = \&Coro::async_pool }
		305
		306	=item cf::sync_job { BLOCK }
		307
		308	The design of crossfire+ requires that the main coro ($Coro::main) is
		309	always able to handle events or runnable, as crossfire+ is only partly
		310	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
		311
		312	If it must be done, put the blocking parts into C<sync_job>. This will run
		313	the given BLOCK in another coroutine while waiting for the result. The
		314	server will be frozen during this time, so the block should either finish
		315	fast or be very important.
		316
		317	=cut
		318
		319	sub sync_job(&) {
		320	my ($job) = @_;
		321
		322	if ($Coro::current == $Coro::main) {
		323	# this is the main coro, too bad, we have to block
		324	# till the operation succeeds, freezing the server :/
		325
		326	# TODO: use suspend/resume instead
		327	# (but this is cancel-safe)
		328	my $freeze_guard = freeze_mainloop;
		329
		330	my $busy = 1;
		331	my @res;
		332
		333	(async {
		334	@res = eval { $job->() };
		335	warn $@ if $@;
		336	undef $busy;
		337	})->prio (Coro::PRIO_MAX);
		338
		339	while ($busy) {
		340	Coro::cede or Event::one_event;
		341	}
		342
		343	wantarray ? @res : $res[0]
		344	} else {
		345	# we are in another coroutine, how wonderful, everything just works
		346
		347	$job->()
		348	}
		349	}
		350
177	=item $coro = cf::coro { BLOCK }	351	=item $coro = cf::async_ext { BLOCK }
178		352
179	Creates and returns a new coro. This coro is automcatially being canceled	353	Like async, but this coro is automatically being canceled when the
180	when the extension calling this is being unloaded.	354	extension calling this is being unloaded.
181		355
182	=cut	356	=cut
183		357
184	sub coro(&) {	358	sub async_ext(&) {
185	my $cb = shift;	359	my $cb = shift;
186		360
187	my $coro; $coro = async {	361	my $coro = &Coro::async ($cb);
188	eval {
189	$cb->();
190	};
191	warn $@ if $@;
192	};
193		362
194	$coro->on_destroy (sub {	363	$coro->on_destroy (sub {
195	delete $EXT_CORO{$coro+0};	364	delete $EXT_CORO{$coro+0};
196	});	365	});
197	$EXT_CORO{$coro+0} = $coro;	366	$EXT_CORO{$coro+0} = $coro;
198		367
199	$coro	368	$coro
		369	}
		370
		371	sub write_runtime {
		372	my $guard = cf::lock_acquire "write_runtime";
		373
		374	my $runtime = "$LOCALDIR/runtime";
		375
		376	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		377	or return;
		378
		379	my $value = $cf::RUNTIME + 90 + 10;
		380	# 10 is the runtime save interval, for a monotonic clock
		381	# 60 allows for the watchdog to kill the server.
		382
		383	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		384	and return;
		385
		386	# always fsync - this file is important
		387	aio_fsync $fh
		388	and return;
		389
		390	close $fh
		391	or return;
		392
		393	aio_rename "$runtime~", $runtime
		394	and return;
		395
		396	1
		397	}
		398
		399	=item cf::datalog type => key => value, ...
		400
		401	Log a datalog packet of the given type with the given key-value pairs.
		402
		403	=cut
		404
		405	sub datalog($@) {
		406	my ($type, %kv) = @_;
		407	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
200	}	408	}
201		409
202	=back	410	=back
203		411
204	=cut	412	=cut
…		…
335	our @CB_TYPE = (); # registry for type (cf-object class) based events	543	our @CB_TYPE = (); # registry for type (cf-object class) based events
336	our @CB_MAP = ();	544	our @CB_MAP = ();
337		545
338	my %attachment;	546	my %attachment;
339		547
		548	sub cf::attachable::thawer_merge {
		549	# simply override everything except _meta
		550	local $_[0]{_meta};
		551	%{$_[0]} = %{$_[1]};
		552	}
		553
340	sub _attach_cb($$$$) {	554	sub _attach_cb($$$$) {
341	my ($registry, $event, $prio, $cb) = @_;	555	my ($registry, $event, $prio, $cb) = @_;
342		556
343	use sort 'stable';	557	use sort 'stable';
344		558
…		…
515	# object support	729	# object support
516		730
517	sub reattach {	731	sub reattach {
518	# basically do the same as instantiate, without calling instantiate	732	# basically do the same as instantiate, without calling instantiate
519	my ($obj) = @_;	733	my ($obj) = @_;
		734
		735	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
520		736
521	my $registry = $obj->registry;	737	my $registry = $obj->registry;
522		738
523	@$registry = ();	739	@$registry = ();
524		740
…		…
563	);	779	);
564		780
565	sub object_freezer_save {	781	sub object_freezer_save {
566	my ($filename, $rdata, $objs) = @_;	782	my ($filename, $rdata, $objs) = @_;
567		783
		784	sync_job {
568	if (length $$rdata) {	785	if (length $$rdata) {
569	warn sprintf "saving %s (%d,%d)\n",	786	warn sprintf "saving %s (%d,%d)\n",
570	$filename, length $$rdata, scalar @$objs;	787	$filename, length $$rdata, scalar @$objs;
571		788
572	if (open my $fh, ">:raw", "$filename~") {	789	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
573	chmod SAVE_MODE, $fh;
574	syswrite $fh, $$rdata;
575	close $fh;
576
577	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
578	chmod SAVE_MODE, $fh;	790	chmod SAVE_MODE, $fh;
579	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };	791	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		792	aio_fsync $fh if $cf::USE_FSYNC;
580	close $fh;	793	close $fh;
		794
		795	if (@$objs) {
		796	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		797	chmod SAVE_MODE, $fh;
		798	my $data = Storable::nfreeze { version => 1, objs => $objs };
		799	aio_write $fh, 0, (length $data), $data, 0;
		800	aio_fsync $fh if $cf::USE_FSYNC;
		801	close $fh;
581	rename "$filename.pst~", "$filename.pst";	802	aio_rename "$filename.pst~", "$filename.pst";
		803	}
		804	} else {
		805	aio_unlink "$filename.pst";
		806	}
		807
		808	aio_rename "$filename~", $filename;
582	} else {	809	} else {
583	unlink "$filename.pst";	810	warn "FATAL: $filename~: $!\n";
584	}	811	}
585
586	rename "$filename~", $filename;
587	} else {	812	} else {
588	warn "FATAL: $filename~: $!\n";
589	}
590	} else {
591	unlink $filename;	813	aio_unlink $filename;
592	unlink "$filename.pst";	814	aio_unlink "$filename.pst";
		815	}
593	}	816	}
594	}	817	}
595		818
596	sub object_freezer_as_string {	819	sub object_freezer_as_string {
597	my ($rdata, $objs) = @_;	820	my ($rdata, $objs) = @_;
…		…
602	}	825	}
603		826
604	sub object_thawer_load {	827	sub object_thawer_load {
605	my ($filename) = @_;	828	my ($filename) = @_;
606		829
607	local $/;	830	my ($data, $av);
608		831
609	my $av;	832	(aio_load $filename, $data) >= 0
		833	or return;
610		834
611	#TODO: use sysread etc.	835	unless (aio_stat "$filename.pst") {
612	if (open my $data, "<:raw:perlio", $filename) {	836	(aio_load "$filename.pst", $av) >= 0
613	$data = <$data>;	837	or return;
614	if (open my $pst, "<:raw:perlio", "$filename.pst") {
615	$av = eval { (Storable::thaw <$pst>)->{objs} };	838	$av = eval { (Storable::thaw $av)->{objs} };
616	}	839	}
		840
		841	warn sprintf "loading %s (%d)\n",
		842	$filename, length $data, scalar @{$av || []};#d#
617	return ($data, $av);	843	return ($data, $av);
618	}
619
620	()
621	}	844	}
622		845
623	#############################################################################	846	#############################################################################
624	# command handling &c	847	# command handling &c
625		848
…		…
649	=cut	872	=cut
650		873
651	sub register_extcmd {	874	sub register_extcmd {
652	my ($name, $cb) = @_;	875	my ($name, $cb) = @_;
653		876
654	my $caller = caller;
655	#warn "registering extcmd '$name' to '$caller'";
656
657	$EXTCMD{$name} = [$cb, $caller];	877	$EXTCMD{$name} = $cb;
658	}	878	}
659		879
660	cf::player->attach (	880	cf::player->attach (
661	on_command => sub {	881	on_command => sub {
662	my ($pl, $name, $params) = @_;	882	my ($pl, $name, $params) = @_;
…		…
675		895
676	my $msg = eval { from_json $buf };	896	my $msg = eval { from_json $buf };
677		897
678	if (ref $msg) {	898	if (ref $msg) {
679	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	899	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
680	if (my %reply = $cb->[0]->($pl, $msg)) {	900	if (my %reply = $cb->($pl, $msg)) {
681	$pl->ext_reply ($msg->{msgid}, %reply);	901	$pl->ext_reply ($msg->{msgid}, %reply);
682	}	902	}
683	}	903	}
684	} else {	904	} else {
685	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	905	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
…		…
687		907
688	cf::override;	908	cf::override;
689	},	909	},
690	);	910	);
691		911
692	sub register {
693	my ($base, $pkg) = @_;
694
695	#TODO
696	}
697
698	sub load_extension {	912	sub load_extension {
699	my ($path) = @_;	913	my ($path) = @_;
700		914
701	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	915	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
702	my $base = $1;	916	my $base = $1;
703	my $pkg = $1;	917	my $pkg = $1;
704	$pkg =~ s/[^[:word:]]/_/g;	918	$pkg =~ s/[^[:word:]]/_/g;
705	$pkg = "ext::$pkg";	919	$pkg = "ext::$pkg";
706		920
707	warn "loading '$path' into '$pkg'\n";	921	warn "... loading '$path' into '$pkg'\n";
708		922
709	open my $fh, "<:utf8", $path	923	open my $fh, "<:utf8", $path
710	or die "$path: $!";	924	or die "$path: $!";
711		925
712	my $source =	926	my $source =
713	"package $pkg; use strict; use utf8;\n"	927	"package $pkg; use strict; use utf8;\n"
714	. "#line 1 \"$path\"\n{\n"	928	. "#line 1 \"$path\"\n{\n"
715	. (do { local $/; <$fh> })	929	. (do { local $/; <$fh> })
716	. "\n};\n1";	930	. "\n};\n1";
717		931
718	eval $source	932	unless (eval $source) {
719	or die $@ ? "$path: $@\n"	933	my $msg = $@ ? "$path: $@\n"
720	: "extension disabled.\n";	934	: "extension disabled.\n";
721		935	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
722	push @exts, $pkg;	936	warn $@;
723	$ext_pkg{$base} = $pkg;	937	warn "mandatory extension failed to load, exiting.\n";
724		938	exit 1;
725	# no strict 'refs';	939	}
726	# @{"$pkg\::ISA"} = ext::;	940	die $@;
727
728	register $base, $pkg;
729	}
730
731	sub unload_extension {
732	my ($pkg) = @_;
733
734	warn "removing extension $pkg\n";
735
736	# remove hooks
737	#TODO
738	# for my $idx (0 .. $#PLUGIN_EVENT) {
739	# delete $hook[$idx]{$pkg};
740	# }	941	}
741		942
742	# remove commands	943	push @EXTS, $pkg;
743	for my $name (keys %COMMAND) {
744	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
745
746	if (@cb) {
747	$COMMAND{$name} = \@cb;
748	} else {
749	delete $COMMAND{$name};
750	}
751	}
752
753	# remove extcmds
754	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
755	delete $EXTCMD{$name};
756	}
757
758	if (my $cb = $pkg->can ("unload")) {
759	eval {
760	$cb->($pkg);
761	1
762	} or warn "$pkg unloaded, but with errors: $@";
763	}
764
765	Symbol::delete_package $pkg;
766	}	944	}
767		945
768	sub load_extensions {	946	sub load_extensions {
769	for my $ext (<$LIBDIR/*.ext>) {	947	for my $ext (<$LIBDIR/*.ext>) {
770	next unless -r $ext;	948	next unless -r $ext;
…		…
774	} or warn "$ext not loaded: $@";	952	} or warn "$ext not loaded: $@";
775	}	953	}
776	}	954	}
777		955
778	#############################################################################	956	#############################################################################
779	# load/save/clean perl data associated with a map
780		957
781	*cf::mapsupport::on_clean = sub {	958	=head2 CORE EXTENSIONS
		959
		960	Functions and methods that extend core crossfire objects.
		961
		962	=cut
		963
		964	package cf::player;
		965
		966	use Coro::AIO;
		967
		968	=head3 cf::player
		969
		970	=over 4
		971
		972	=item cf::player::find $login
		973
		974	Returns the given player object, loading it if necessary (might block).
		975
		976	=cut
		977
		978	sub playerdir($) {
		979	"$PLAYERDIR/"
		980	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		981	}
		982
		983	sub path($) {
		984	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		985
		986	(playerdir $login) . "/playerdata"
		987	}
		988
		989	sub find_active($) {
		990	$cf::PLAYER{$_[0]}
		991	and $cf::PLAYER{$_[0]}->active
		992	and $cf::PLAYER{$_[0]}
		993	}
		994
		995	sub exists($) {
		996	my ($login) = @_;
		997
		998	$cf::PLAYER{$login}
		999	or cf::sync_job { !aio_stat path $login }
		1000	}
		1001
		1002	sub find($) {
		1003	return $cf::PLAYER{$_[0]} || do {
		1004	my $login = $_[0];
		1005
		1006	my $guard = cf::lock_acquire "user_find:$login";
		1007
		1008	$cf::PLAYER{$_[0]} || do {
		1009	# rename old playerfiles to new ones
		1010	#TODO: remove when no longer required
		1011	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1012	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1013	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1014	aio_unlink +(playerdir $login) . "/$login.pl";
		1015
		1016	my $pl = load_pl path $login
		1017	or return;
		1018	$cf::PLAYER{$login} = $pl
		1019	}
		1020	}
		1021	}
		1022
		1023	sub save($) {
		1024	my ($pl) = @_;
		1025
		1026	return if $pl->{deny_save};
		1027
		1028	my $path = path $pl;
		1029	my $guard = cf::lock_acquire "user_save:$path";
		1030
		1031	return if $pl->{deny_save};
		1032
		1033	aio_mkdir playerdir $pl, 0770;
		1034	$pl->{last_save} = $cf::RUNTIME;
		1035
		1036	$pl->save_pl ($path);
		1037	Coro::cede;
		1038	}
		1039
		1040	sub new($) {
		1041	my ($login) = @_;
		1042
		1043	my $self = create;
		1044
		1045	$self->ob->name ($login);
		1046	$self->{deny_save} = 1;
		1047
		1048	$cf::PLAYER{$login} = $self;
		1049
		1050	$self
		1051	}
		1052
		1053	=item $pl->quit_character
		1054
		1055	Nukes the player without looking back. If logged in, the connection will
		1056	be destroyed. May block for a long time.
		1057
		1058	=cut
		1059
		1060	sub quit_character {
		1061	my ($pl) = @_;
		1062
		1063	my $name = $pl->ob->name;
		1064
		1065	$pl->{deny_save} = 1;
		1066	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1067
		1068	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1069	$pl->deactivate;
		1070	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1071	$pl->ns->destroy if $pl->ns;
		1072
		1073	my $path = playerdir $pl;
		1074	my $temp = "$path~$cf::RUNTIME~deleting~";
		1075	aio_rename $path, $temp;
		1076	delete $cf::PLAYER{$pl->ob->name};
		1077	$pl->destroy;
		1078
		1079	my $prefix = qr<^~\Q$name\E/>;
		1080
		1081	# nuke player maps
		1082	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1083
		1084	IO::AIO::aio_rmtree $temp;
		1085	}
		1086
		1087	=item $pl->kick
		1088
		1089	Kicks a player out of the game. This destroys the connection.
		1090
		1091	=cut
		1092
		1093	sub kick {
		1094	my ($pl, $kicker) = @_;
		1095
		1096	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1097	$pl->killer ("kicked");
		1098	$pl->ns->destroy;
		1099	}
		1100
		1101	=item cf::player::list_logins
		1102
		1103	Returns am arrayref of all valid playernames in the system, can take a
		1104	while and may block, so not sync_job-capable, ever.
		1105
		1106	=cut
		1107
		1108	sub list_logins {
		1109	my $dirs = aio_readdir $PLAYERDIR
		1110	or return [];
		1111
		1112	my @logins;
		1113
		1114	for my $login (@$dirs) {
		1115	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1116	aio_read $fh, 0, 512, my $buf, 0 or next;
		1117	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1118
		1119	utf8::decode $login;
		1120	push @logins, $login;
		1121	}
		1122
		1123	\@logins
		1124	}
		1125
		1126	=item $player->maps
		1127
		1128	Returns an arrayref of map paths that are private for this
		1129	player. May block.
		1130
		1131	=cut
		1132
		1133	sub maps($) {
		1134	my ($pl) = @_;
		1135
		1136	$pl = ref $pl ? $pl->ob->name : $pl;
		1137
		1138	my $files = aio_readdir playerdir $pl
		1139	or return;
		1140
		1141	my @paths;
		1142
		1143	for (@$files) {
		1144	utf8::decode $_;
		1145	next if /\.(?:pl|pst)$/;
		1146	next unless /^$PATH_SEP/o;
		1147
		1148	push @paths, cf::map::normalise "~$pl/$_";
		1149	}
		1150
		1151	\@paths
		1152	}
		1153
		1154	=item $player->ext_reply ($msgid, %msg)
		1155
		1156	Sends an ext reply to the player.
		1157
		1158	=cut
		1159
		1160	sub ext_reply($$%) {
		1161	my ($self, $id, %msg) = @_;
		1162
		1163	$msg{msgid} = $id;
		1164
		1165	$self->send ("ext " . cf::to_json \%msg);
		1166	}
		1167
		1168	=item $player->ext_event ($type, %msg)
		1169
		1170	Sends an ext event to the client.
		1171
		1172	=cut
		1173
		1174	sub ext_event($$%) {
		1175	my ($self, $type, %msg) = @_;
		1176
		1177	$self->ns->ext_event ($type, %msg);
		1178	}
		1179
		1180	=head3 cf::region
		1181
		1182	=over 4
		1183
		1184	=cut
		1185
		1186	package cf::region;
		1187
		1188	=item cf::region::find_by_path $path
		1189
		1190	Tries to decuce the probable region for a map knowing only its path.
		1191
		1192	=cut
		1193
		1194	sub find_by_path($) {
		1195	my ($path) = @_;
		1196
		1197	my ($match, $specificity);
		1198
		1199	for my $region (list) {
		1200	if ($region->match && $path =~ $region->match) {
		1201	($match, $specificity) = ($region, $region->specificity)
		1202	if $region->specificity > $specificity;
		1203	}
		1204	}
		1205
		1206	$match
		1207	}
		1208
		1209	=back
		1210
		1211	=head3 cf::map
		1212
		1213	=over 4
		1214
		1215	=cut
		1216
		1217	package cf::map;
		1218
		1219	use Fcntl;
		1220	use Coro::AIO;
		1221
		1222	use overload
		1223	'""' => \&as_string,
		1224	fallback => 1;
		1225
		1226	our $MAX_RESET = 3600;
		1227	our $DEFAULT_RESET = 3000;
		1228
		1229	sub generate_random_map {
		1230	my ($self, $rmp) = @_;
		1231	# mit "rum" bekleckern, nicht
		1232	$self->_create_random_map (
		1233	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1234	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1235	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1236	$rmp->{exit_on_final_map},
		1237	$rmp->{xsize}, $rmp->{ysize},
		1238	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1239	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1240	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1241	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1242	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1243	(cf::region::find $rmp->{region}), $rmp->{custom}
		1244	)
		1245	}
		1246
		1247	=item cf::map->register ($regex, $prio)
		1248
		1249	Register a handler for the map path matching the given regex at the
		1250	givne priority (higher is better, built-in handlers have priority 0, the
		1251	default).
		1252
		1253	=cut
		1254
		1255	sub register {
		1256	my (undef, $regex, $prio) = @_;
		1257	my $pkg = caller;
		1258
		1259	no strict;
		1260	push @{"$pkg\::ISA"}, __PACKAGE__;
		1261
		1262	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1263	}
		1264
		1265	# also paths starting with '/'
		1266	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1267
		1268	sub thawer_merge {
		1269	my ($self, $merge) = @_;
		1270
		1271	# we have to keep some variables in memory intact
		1272	local $self->{path};
		1273	local $self->{load_path};
		1274	local $self->{deny_save};
		1275	local $self->{deny_reset};
		1276
		1277	$self->SUPER::thawer_merge ($merge);
		1278	}
		1279
		1280	sub normalise {
		1281	my ($path, $base) = @_;
		1282
		1283	$path = "$path"; # make sure its a string
		1284
		1285	$path =~ s/\.map$//;
		1286
		1287	# map plan:
		1288	#
		1289	# /! non-realised random map exit (special hack!)
		1290	# {... are special paths that are not being touched
		1291	# ?xxx/... are special absolute paths
		1292	# ?random/... random maps
		1293	# /... normal maps
		1294	# ~user/... per-player map of a specific user
		1295
		1296	$path =~ s/$PATH_SEP/\//go;
		1297
		1298	# treat it as relative path if it starts with
		1299	# something that looks reasonable
		1300	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1301	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1302
		1303	$base =~ s{[^/]+/?$}{};
		1304	$path = "$base/$path";
		1305	}
		1306
		1307	for ($path) {
		1308	redo if s{//}{/};
		1309	redo if s{/\.?/}{/};
		1310	redo if s{/[^/]+/\.\./}{/};
		1311	}
		1312
		1313	$path
		1314	}
		1315
		1316	sub new_from_path {
		1317	my (undef, $path, $base) = @_;
		1318
		1319	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1320
		1321	$path = normalise $path, $base;
		1322
		1323	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1324	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1325	my $self = bless cf::map::new, $pkg;
		1326	$self->{path} = $path; $self->path ($path);
		1327	$self->init; # pass $1 etc.
		1328	return $self;
		1329	}
		1330	}
		1331
		1332	Carp::carp "unable to resolve path '$path' (base '$base').";
		1333	()
		1334	}
		1335
		1336	sub init {
		1337	my ($self) = @_;
		1338
		1339	$self
		1340	}
		1341
		1342	sub as_string {
		1343	my ($self) = @_;
		1344
		1345	"$self->{path}"
		1346	}
		1347
		1348	# the displayed name, this is a one way mapping
		1349	sub visible_name {
		1350	&as_string
		1351	}
		1352
		1353	# the original (read-only) location
		1354	sub load_path {
		1355	my ($self) = @_;
		1356
		1357	"$MAPDIR($self->{path}"
		1358	}
		1359
		1360	# the temporary/swap location
		1361	sub save_path {
		1362	my ($self) = @_;
		1363
		1364	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1365	"$TMPDIR/$path"
		1366	}
		1367
		1368	# the unique path, undef == no special unique path
		1369	sub uniq_path {
		1370	my ($self) = @_;
		1371
		1372	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1373	"$UNIQUEDIR/$path"
		1374	}
		1375
		1376	# and all this just because we cannot iterate over
		1377	# all maps in C++...
		1378	sub change_all_map_light {
		1379	my ($change) = @_;
		1380
		1381	$_->change_map_light ($change)
		1382	for grep $_->outdoor, values %cf::MAP;
		1383	}
		1384
		1385	sub unlink_save {
		1386	my ($self) = @_;
		1387
		1388	utf8::encode (my $save = $self->save_path);
		1389	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1390	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1391	}
		1392
		1393	sub load_header_from($) {
		1394	my ($self, $path) = @_;
		1395
		1396	utf8::encode $path;
		1397	#aio_open $path, O_RDONLY, 0
		1398	# or return;
		1399
		1400	$self->_load_header ($path)
		1401	or return;
		1402
		1403	$self->{load_path} = $path;
		1404
		1405	1
		1406	}
		1407
		1408	sub load_header_orig {
		1409	my ($self) = @_;
		1410
		1411	$self->load_header_from ($self->load_path)
		1412	}
		1413
		1414	sub load_header_temp {
		1415	my ($self) = @_;
		1416
		1417	$self->load_header_from ($self->save_path)
		1418	}
		1419
		1420	sub prepare_temp {
		1421	my ($self) = @_;
		1422
		1423	$self->last_access ((delete $self->{last_access})
		1424	|| $cf::RUNTIME); #d#
		1425	# safety
		1426	$self->{instantiate_time} = $cf::RUNTIME
		1427	if $self->{instantiate_time} > $cf::RUNTIME;
		1428	}
		1429
		1430	sub prepare_orig {
		1431	my ($self) = @_;
		1432
		1433	$self->{load_original} = 1;
		1434	$self->{instantiate_time} = $cf::RUNTIME;
		1435	$self->last_access ($cf::RUNTIME);
		1436	$self->instantiate;
		1437	}
		1438
		1439	sub load_header {
		1440	my ($self) = @_;
		1441
		1442	if ($self->load_header_temp) {
		1443	$self->prepare_temp;
		1444	} else {
		1445	$self->load_header_orig
		1446	or return;
		1447	$self->prepare_orig;
		1448	}
		1449
		1450	$self->default_region (cf::region::find_by_path $self->{path})
		1451	unless $self->default_region;
		1452
		1453	1
		1454	}
		1455
		1456	sub find;
		1457	sub find {
		1458	my ($path, $origin) = @_;
		1459
		1460	$path = normalise $path, $origin && $origin->path;
		1461
		1462	cf::lock_wait "map_find:$path";
		1463
		1464	$cf::MAP{$path} || do {
		1465	my $guard = cf::lock_acquire "map_find:$path";
		1466	my $map = new_from_path cf::map $path
		1467	or return;
		1468
		1469	$map->{last_save} = $cf::RUNTIME;
		1470
		1471	$map->load_header
		1472	or return;
		1473
		1474	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)
		1475	# doing this can freeze the server in a sync job, obviously
		1476	#$cf::WAIT_FOR_TICK->wait;
		1477	$map->reset;
		1478	undef $guard;
		1479	return find $path;
		1480	}
		1481
		1482	$cf::MAP{$path} = $map
		1483	}
		1484	}
		1485
		1486	sub pre_load { }
		1487	sub post_load { }
		1488
		1489	sub load {
		1490	my ($self) = @_;
		1491
		1492	local $self->{deny_reset} = 1; # loading can take a long time
		1493
		1494	my $path = $self->{path};
		1495	my $guard = cf::lock_acquire "map_load:$path";
		1496
		1497	return if $self->in_memory != cf::MAP_SWAPPED;
		1498
		1499	$self->in_memory (cf::MAP_LOADING);
		1500
		1501	$self->alloc;
		1502
		1503	$self->pre_load;
		1504	Coro::cede;
		1505
		1506	$self->_load_objects ($self->{load_path}, 1)
		1507	or return;
		1508
		1509	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1510	if delete $self->{load_original};
		1511
		1512	if (my $uniq = $self->uniq_path) {
		1513	utf8::encode $uniq;
		1514	if (aio_open $uniq, O_RDONLY, 0) {
		1515	$self->clear_unique_items;
		1516	$self->_load_objects ($uniq, 0);
		1517	}
		1518	}
		1519
		1520	Coro::cede;
		1521	# now do the right thing for maps
		1522	$self->link_multipart_objects;
		1523	Coro::cede;
		1524
		1525	unless ($self->{deny_activate}) {
		1526	$self->decay_objects;
		1527	$self->fix_auto_apply;
		1528	$self->update_buttons;
		1529	Coro::cede;
		1530	$self->set_darkness_map;
		1531	$self->difficulty ($self->estimate_difficulty)
		1532	unless $self->difficulty;
		1533	Coro::cede;
		1534	$self->activate;
		1535	Coro::cede;
		1536	}
		1537
		1538	$self->post_load;
		1539	Coro::cede;
		1540
		1541	$self->in_memory (cf::MAP_IN_MEMORY);
		1542	}
		1543
		1544	sub customise_for {
		1545	my ($self, $ob) = @_;
		1546
		1547	return find "~" . $ob->name . "/" . $self->{path}
		1548	if $self->per_player;
		1549
		1550	$self
		1551	}
		1552
		1553	# find and load all maps in the 3x3 area around a map
		1554	sub load_diag {
782	my ($map) = @_;	1555	my ($map) = @_;
783		1556
784	my $path = $map->tmpname;	1557	my @diag; # diagonal neighbours
785	defined $path or return;
786		1558
787	unlink "$path.pst";	1559	for (0 .. 3) {
788	};	1560	my $neigh = $map->tile_path ($_)
		1561	or next;
		1562	$neigh = find $neigh, $map
		1563	or next;
		1564	$neigh->load;
789		1565
790	cf::map->attach (prio => -10000, package => cf::mapsupport::);	1566	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1567	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1568	}
791		1569
792	#############################################################################	1570	for (@diag) {
793	# load/save perl data associated with player->ob objects	1571	my $neigh = find @$_
794		1572	or next;
795	sub all_objects(@) {	1573	$neigh->load;
796	@_, map all_objects ($_->inv), @_	1574	}
797	}	1575	}
798		1576
799	# TODO: compatibility cruft, remove when no longer needed	1577	sub find_sync {
800	cf::player->attach (	1578	my ($path, $origin) = @_;
801	on_load => sub {
802	my ($pl, $path) = @_;
803		1579
804	for my $o (all_objects $pl->ob) {	1580	cf::sync_job { find $path, $origin }
805	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1581	}
806	$o->set_ob_key_value ("_perl_data");
807		1582
808	%$o = %{ Storable::thaw pack "H*", $value };	1583	sub do_load_sync {
		1584	my ($map) = @_;
		1585
		1586	cf::sync_job { $map->load };
		1587	}
		1588
		1589	our %MAP_PREFETCH;
		1590	our $MAP_PREFETCHER = undef;
		1591
		1592	sub find_async {
		1593	my ($path, $origin) = @_;
		1594
		1595	$path = normalise $path, $origin && $origin->{path};
		1596
		1597	if (my $map = $cf::MAP{$path}) {
		1598	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1599	}
		1600
		1601	undef $MAP_PREFETCH{$path};
		1602	$MAP_PREFETCHER ||= cf::async {
		1603	while (%MAP_PREFETCH) {
		1604	for my $path (keys %MAP_PREFETCH) {
		1605	my $map = find $path
		1606	or next;
		1607	$map->load;
		1608
		1609	delete $MAP_PREFETCH{$path};
809	}	1610	}
810	}	1611	}
		1612	undef $MAP_PREFETCHER;
		1613	};
		1614	$MAP_PREFETCHER->prio (6);
		1615
		1616	()
		1617	}
		1618
		1619	sub save {
		1620	my ($self) = @_;
		1621
		1622	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1623
		1624	$self->{last_save} = $cf::RUNTIME;
		1625
		1626	return unless $self->dirty;
		1627
		1628	my $save = $self->save_path; utf8::encode $save;
		1629	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1630
		1631	$self->{load_path} = $save;
		1632
		1633	return if $self->{deny_save};
		1634
		1635	local $self->{last_access} = $self->last_access;#d#
		1636
		1637	cf::async {
		1638	$_->contr->save for $self->players;
		1639	};
		1640
		1641	if ($uniq) {
		1642	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1643	$self->_save_objects ($uniq, cf::IO_UNIQUES);
		1644	} else {
		1645	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
811	},	1646	}
812	);	1647	}
813		1648
814	#############################################################################	1649	sub swap_out {
		1650	my ($self) = @_;
815		1651
816	=head2 CORE EXTENSIONS	1652	# save first because save cedes
		1653	$self->save;
817		1654
818	Functions and methods that extend core crossfire objects.	1655	my $lock = cf::lock_acquire "map_data:" . $self->path;
819		1656
820	=head3 cf::player	1657	return if $self->players;
		1658	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1659	return if $self->{deny_save};
		1660
		1661	$self->clear;
		1662	$self->in_memory (cf::MAP_SWAPPED);
		1663	}
		1664
		1665	sub reset_at {
		1666	my ($self) = @_;
		1667
		1668	# TODO: safety, remove and allow resettable per-player maps
		1669	return 1e99 if $self->isa ("ext::map_per_player");#d#
		1670	return 1e99 if $self->{deny_reset};
		1671
		1672	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1673	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1674
		1675	$time + $to
		1676	}
		1677
		1678	sub should_reset {
		1679	my ($self) = @_;
		1680
		1681	$self->reset_at <= $cf::RUNTIME
		1682	}
		1683
		1684	sub reset {
		1685	my ($self) = @_;
		1686
		1687	my $lock = cf::lock_acquire "map_data:$self->{path}";
		1688
		1689	return if $self->players;
		1690	return if $self->isa ("ext::map_per_player");#d#
		1691
		1692	warn "resetting map ", $self->path;#d#
		1693
		1694	$self->in_memory (cf::MAP_SWAPPED);
		1695
		1696	# need to save uniques path
		1697	unless ($self->{deny_save}) {
		1698	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1699
		1700	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1701	if $uniq;
		1702	}
		1703
		1704	delete $cf::MAP{$self->path};
		1705
		1706	$self->clear;
		1707
		1708	$_->clear_links_to ($self) for values %cf::MAP;
		1709
		1710	$self->unlink_save;
		1711	$self->destroy;
		1712	}
		1713
		1714	my $nuke_counter = "aaaa";
		1715
		1716	sub nuke {
		1717	my ($self) = @_;
		1718
		1719	delete $cf::MAP{$self->path};
		1720
		1721	$self->unlink_save;
		1722
		1723	bless $self, "cf::map";
		1724	delete $self->{deny_reset};
		1725	$self->{deny_save} = 1;
		1726	$self->reset_timeout (1);
		1727	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		1728
		1729	$cf::MAP{$self->path} = $self;
		1730
		1731	$self->reset; # polite request, might not happen
		1732	}
		1733
		1734	=item cf::map::unique_maps
		1735
		1736	Returns an arrayref of paths of all shared maps that have
		1737	instantiated unique items. May block.
		1738
		1739	=cut
		1740
		1741	sub unique_maps() {
		1742	my $files = aio_readdir $UNIQUEDIR
		1743	or return;
		1744
		1745	my @paths;
		1746
		1747	for (@$files) {
		1748	utf8::decode $_;
		1749	next if /\.pst$/;
		1750	next unless /^$PATH_SEP/o;
		1751
		1752	push @paths, cf::map::normalise $_;
		1753	}
		1754
		1755	\@paths
		1756	}
		1757
		1758	package cf;
		1759
		1760	=back
		1761
		1762	=head3 cf::object
		1763
		1764	=cut
		1765
		1766	package cf::object;
821		1767
822	=over 4	1768	=over 4
823		1769
824	=item cf::player::exists $login	1770	=item $ob->inv_recursive
825		1771
826	Returns true when the given account exists.	1772	Returns the inventory of the object _and_ their inventories, recursively.
827		1773
828	=cut	1774	=cut
829		1775
830	sub cf::player::exists($) {	1776	sub inv_recursive_;
831	cf::player::find $_[0]	1777	sub inv_recursive_ {
832	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1778	map { $_, inv_recursive_ $_->inv } @_
833	}	1779	}
834		1780
835	=item $player->ext_reply ($msgid, $msgtype, %msg)	1781	sub inv_recursive {
836		1782	inv_recursive_ inv $_[0]
837	Sends an ext reply to the player.
838
839	=cut
840
841	sub cf::player::ext_reply($$$%) {
842	my ($self, $id, %msg) = @_;
843
844	$msg{msgid} = $id;
845
846	$self->send ("ext " . to_json \%msg);
847	}	1783	}
		1784
		1785	package cf;
848		1786
849	=back	1787	=back
850		1788
851	=head3 cf::object::player	1789	=head3 cf::object::player
852		1790
…		…
890	(ref $cf::CFG{"may_$access"}	1828	(ref $cf::CFG{"may_$access"}
891	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1829	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
892	: $cf::CFG{"may_$access"})	1830	: $cf::CFG{"may_$access"})
893	}	1831	}
894		1832
		1833	=item $player_object->enter_link
		1834
		1835	Freezes the player and moves him/her to a special map (C<{link}>).
		1836
		1837	The player should be reasonably safe there for short amounts of time. You
		1838	I<MUST> call C<leave_link> as soon as possible, though.
		1839
		1840	Will never block.
		1841
		1842	=item $player_object->leave_link ($map, $x, $y)
		1843
		1844	Moves the player out of the special C<{link}> map onto the specified
		1845	map. If the map is not valid (or omitted), the player will be moved back
		1846	to the location he/she was before the call to C<enter_link>, or, if that
		1847	fails, to the emergency map position.
		1848
		1849	Might block.
		1850
		1851	=cut
		1852
		1853	sub link_map {
		1854	unless ($LINK_MAP) {
		1855	$LINK_MAP = cf::map::find "{link}"
		1856	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		1857	$LINK_MAP->load;
		1858	}
		1859
		1860	$LINK_MAP
		1861	}
		1862
		1863	sub cf::object::player::enter_link {
		1864	my ($self) = @_;
		1865
		1866	$self->deactivate_recursive;
		1867
		1868	return if UNIVERSAL::isa $self->map, "ext::map_link";
		1869
		1870	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1871	if $self->map;
		1872
		1873	$self->enter_map ($LINK_MAP || link_map, 10, 10);
		1874	}
		1875
		1876	sub cf::object::player::leave_link {
		1877	my ($self, $map, $x, $y) = @_;
		1878
		1879	my $link_pos = delete $self->{_link_pos};
		1880
		1881	unless ($map) {
		1882	# restore original map position
		1883	($map, $x, $y) = @{ $link_pos || [] };
		1884	$map = cf::map::find $map;
		1885
		1886	unless ($map) {
		1887	($map, $x, $y) = @$EMERGENCY_POSITION;
		1888	$map = cf::map::find $map
		1889	or die "FATAL: cannot load emergency map\n";
		1890	}
		1891	}
		1892
		1893	($x, $y) = (-1, -1)
		1894	unless (defined $x) && (defined $y);
		1895
		1896	# use -1 or undef as default coordinates, not 0, 0
		1897	($x, $y) = ($map->enter_x, $map->enter_y)
		1898	if $x <=0 && $y <= 0;
		1899
		1900	$map->load;
		1901	$map->load_diag;
		1902
		1903	return unless $self->contr->active;
		1904	$self->activate_recursive;
		1905
		1906	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
		1907	$self->enter_map ($map, $x, $y);
		1908	}
		1909
		1910	cf::player->attach (
		1911	on_logout => sub {
		1912	my ($pl) = @_;
		1913
		1914	# abort map switching before logout
		1915	if ($pl->ob->{_link_pos}) {
		1916	cf::sync_job {
		1917	$pl->ob->leave_link
		1918	};
		1919	}
		1920	},
		1921	on_login => sub {
		1922	my ($pl) = @_;
		1923
		1924	# try to abort aborted map switching on player login :)
		1925	# should happen only on crashes
		1926	if ($pl->ob->{_link_pos}) {
		1927	$pl->ob->enter_link;
		1928	(async {
		1929	$pl->ob->reply (undef,
		1930	"There was an internal problem at your last logout, "
		1931	. "the server will try to bring you to your intended destination in a second.",
		1932	cf::NDI_RED);
		1933	# we need this sleep as the login has a concurrent enter_exit running
		1934	# and this sleep increases chances of the player not ending up in scorn
		1935	Coro::Timer::sleep 1;
		1936	$pl->ob->leave_link;
		1937	})->prio (2);
		1938	}
		1939	},
		1940	);
		1941
		1942	=item $player_object->goto ($path, $x, $y)
		1943
		1944	=cut
		1945
		1946	sub cf::object::player::goto {
		1947	my ($self, $path, $x, $y) = @_;
		1948
		1949	$self->enter_link;
		1950
		1951	(async {
		1952	my $map = eval {
		1953	my $map = cf::map::find $path;
		1954	$map = $map->customise_for ($self) if $map;
		1955	$map
		1956	} or
		1957	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1958
		1959	$self->leave_link ($map, $x, $y);
		1960	})->prio (1);
		1961	}
		1962
		1963	=item $player_object->enter_exit ($exit_object)
		1964
		1965	=cut
		1966
		1967	sub parse_random_map_params {
		1968	my ($spec) = @_;
		1969
		1970	my $rmp = { # defaults
		1971	xsize => (cf::rndm 15, 40),
		1972	ysize => (cf::rndm 15, 40),
		1973	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		1974	#layout => string,
		1975	};
		1976
		1977	for (split /\n/, $spec) {
		1978	my ($k, $v) = split /\s+/, $_, 2;
		1979
		1980	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1981	}
		1982
		1983	$rmp
		1984	}
		1985
		1986	sub prepare_random_map {
		1987	my ($exit) = @_;
		1988
		1989	my $guard = cf::lock_acquire "exit_prepare:$exit";
		1990
		1991	# all this does is basically replace the /! path by
		1992	# a new random map path (?random/...) with a seed
		1993	# that depends on the exit object
		1994
		1995	my $rmp = parse_random_map_params $exit->msg;
		1996
		1997	if ($exit->map) {
		1998	$rmp->{region} = $exit->region->name;
		1999	$rmp->{origin_map} = $exit->map->path;
		2000	$rmp->{origin_x} = $exit->x;
		2001	$rmp->{origin_y} = $exit->y;
		2002	}
		2003
		2004	$rmp->{random_seed} ||= $exit->random_seed;
		2005
		2006	my $data = cf::to_json $rmp;
		2007	my $md5 = Digest::MD5::md5_hex $data;
		2008	my $meta = "$RANDOMDIR/$md5.meta";
		2009
		2010	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		2011	aio_write $fh, 0, (length $data), $data, 0;
		2012	undef $fh;
		2013	aio_rename "$meta~", $meta;
		2014
		2015	$exit->slaying ("?random/$md5");
		2016	$exit->msg (undef);
		2017	}
		2018	}
		2019
		2020	sub cf::object::player::enter_exit {
		2021	my ($self, $exit) = @_;
		2022
		2023	return unless $self->type == cf::PLAYER;
		2024
		2025	if ($exit->slaying eq "/!") {
		2026	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2027	# the problem is that $exit might not survive long enough
		2028	# so it needs to be done right now, right here
		2029	cf::sync_job { prepare_random_map $exit };
		2030	}
		2031
		2032	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2033	my $hp = $exit->stats->hp;
		2034	my $sp = $exit->stats->sp;
		2035
		2036	$self->enter_link;
		2037
		2038	(async {
		2039	$self->deactivate_recursive; # just to be sure
		2040	unless (eval {
		2041	$self->goto ($slaying, $hp, $sp);
		2042
		2043	1;
		2044	}) {
		2045	$self->message ("Something went wrong deep within the crossfire server. "
		2046	. "I'll try to bring you back to the map you were before. "
		2047	. "Please report this to the dungeon master!",
		2048	cf::NDI_UNIQUE | cf::NDI_RED);
		2049
		2050	warn "ERROR in enter_exit: $@";
		2051	$self->leave_link;
		2052	}
		2053	})->prio (1);
		2054	}
		2055
895	=head3 cf::client	2056	=head3 cf::client
896		2057
897	=over 4	2058	=over 4
898		2059
899	=item $client->send_drawinfo ($text, $flags)	2060	=item $client->send_drawinfo ($text, $flags)
…		…
905		2066
906	sub cf::client::send_drawinfo {	2067	sub cf::client::send_drawinfo {
907	my ($self, $text, $flags) = @_;	2068	my ($self, $text, $flags) = @_;
908		2069
909	utf8::encode $text;	2070	utf8::encode $text;
910	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2071	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
911	}	2072	}
912		2073
		2074	=item $client->ext_event ($type, %msg)
		2075
		2076	Sends an exti event to the client.
		2077
		2078	=cut
		2079
		2080	sub cf::client::ext_event($$%) {
		2081	my ($self, $type, %msg) = @_;
		2082
		2083	$msg{msgtype} = "event_$type";
		2084	$self->send_packet ("ext " . cf::to_json \%msg);
		2085	}
913		2086
914	=item $success = $client->query ($flags, "text", \&cb)	2087	=item $success = $client->query ($flags, "text", \&cb)
915		2088
916	Queues a query to the client, calling the given callback with	2089	Queues a query to the client, calling the given callback with
917	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2090	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
…		…
942	on_reply => sub {	2115	on_reply => sub {
943	my ($ns, $msg) = @_;	2116	my ($ns, $msg) = @_;
944		2117
945	# this weird shuffling is so that direct followup queries	2118	# this weird shuffling is so that direct followup queries
946	# get handled first	2119	# get handled first
947	my $queue = delete $ns->{query_queue};	2120	my $queue = delete $ns->{query_queue}
		2121	or return; # be conservative, not sure how that can happen, but we saw a crash here
948		2122
949	(shift @$queue)->[1]->($msg);	2123	(shift @$queue)->[1]->($msg);
		2124	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
950		2125
951	push @{ $ns->{query_queue} }, @$queue;	2126	push @{ $ns->{query_queue} }, @$queue;
952		2127
953	if (@{ $ns->{query_queue} } == @$queue) {	2128	if (@{ $ns->{query_queue} } == @$queue) {
954	if (@$queue) {	2129	if (@$queue) {
…		…
958	}	2133	}
959	}	2134	}
960	},	2135	},
961	);	2136	);
962		2137
963	=item $client->coro (\&cb)	2138	=item $client->async (\&cb)
964		2139
965	Create a new coroutine, running the specified callback. The coroutine will	2140	Create a new coroutine, running the specified callback. The coroutine will
966	be automatically cancelled when the client gets destroyed (e.g. on logout,	2141	be automatically cancelled when the client gets destroyed (e.g. on logout,
967	or loss of connection).	2142	or loss of connection).
968		2143
969	=cut	2144	=cut
970		2145
971	sub cf::client::coro {	2146	sub cf::client::async {
972	my ($self, $cb) = @_;	2147	my ($self, $cb) = @_;
973		2148
974	my $coro; $coro = async {	2149	my $coro = &Coro::async ($cb);
975	eval {
976	$cb->();
977	};
978	warn $@ if $@;
979	};
980		2150
981	$coro->on_destroy (sub {	2151	$coro->on_destroy (sub {
982	delete $self->{_coro}{$coro+0};	2152	delete $self->{_coro}{$coro+0};
983	});	2153	});
984		2154
…		…
1017		2187
1018	# here we export the classes and methods available to script code	2188	# here we export the classes and methods available to script code
1019		2189
1020	=pod	2190	=pod
1021		2191
1022	The following fucntions and emthods are available within a safe environment:	2192	The following functions and methods are available within a safe environment:
1023		2193
1024	cf::object contr pay_amount pay_player map	2194	cf::object contr pay_amount pay_player map
1025	cf::object::player player	2195	cf::object::player player
1026	cf::player peaceful	2196	cf::player peaceful
1027	cf::map trigger	2197	cf::map trigger
…		…
1112	#############################################################################	2282	#############################################################################
1113		2283
1114	=head2 EXTENSION DATABASE SUPPORT	2284	=head2 EXTENSION DATABASE SUPPORT
1115		2285
1116	Crossfire maintains a very simple database for extension use. It can	2286	Crossfire maintains a very simple database for extension use. It can
1117	currently store anything that can be serialised using Storable, which	2287	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
1118	excludes objects.	2288	convert to/from binary).
1119		2289
1120	The parameter C<$family> should best start with the name of the extension	2290	The parameter C<$family> should best start with the name of the extension
1121	using it, it should be unique.	2291	using it, it should be unique.
1122		2292
1123	=over 4	2293	=over 4
1124		2294
1125	=item $hashref = cf::db_get $family
1126
1127	Return a hashref for use by the extension C<$family>, which can be
1128	modified. After modifications, you have to call C<cf::db_dirty> or
1129	C<cf::db_sync>.
1130
1131	=item $value = cf::db_get $family => $key	2295	=item $value = cf::db_get $family => $key
1132		2296
1133	Returns a single value from the database	2297	Returns a single value from the database.
1134
1135	=item cf::db_put $family => $hashref
1136
1137	Stores the given family hashref into the database. Updates are delayed, if
1138	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1139		2298
1140	=item cf::db_put $family => $key => $value	2299	=item cf::db_put $family => $key => $value
1141		2300
1142	Stores the given C<$value> in the family hash. Updates are delayed, if you	2301	Stores the given C<$value> in the family.
1143	want the data to be synced to disk immediately, use C<cf::db_sync>.
1144
1145	=item cf::db_dirty
1146
1147	Marks the database as dirty, to be updated at a later time.
1148
1149	=item cf::db_sync
1150
1151	Immediately write the database to disk I<if it is dirty>.
1152		2302
1153	=cut	2303	=cut
1154		2304
1155	our $DB;	2305	our $DB;
1156		2306
1157	{	2307	sub db_init {
1158	my $path = cf::localdir . "/database.pst";	2308	unless ($DB) {
		2309	$DB = BDB::db_create $DB_ENV;
1159		2310
1160	sub db_load() {	2311	cf::sync_job {
1161	warn "loading database $path\n";#d# remove later	2312	eval {
1162	$DB = stat $path ? Storable::retrieve $path : { };	2313	$DB->set_flags (BDB::CHKSUM);
1163	}
1164		2314
1165	my $pid;	2315	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
1166		2316	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
1167	sub db_save() {	2317	cf::cleanup "db_open(db): $!" if $!;
1168	warn "saving database $path\n";#d# remove later	2318	};
1169	waitpid $pid, 0 if $pid;	2319	cf::cleanup "db_open(db): $@" if $@;
1170	if (0 == ($pid = fork)) {
1171	$DB->{_meta}{version} = 1;
1172	Storable::nstore $DB, "$path~";
1173	rename "$path~", $path;
1174	cf::_exit 0 if defined $pid;
1175	}	2320	};
1176	}
1177
1178	my $dirty;
1179
1180	sub db_sync() {
1181	db_save if $dirty;
1182	undef $dirty;
1183	}
1184
1185	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1186	db_sync;
1187	});	2321	}
		2322	}
1188		2323
1189	sub db_dirty() {
1190	$dirty = 1;
1191	$idle->start;
1192	}
1193
1194	sub db_get($;$) {	2324	sub db_get($$) {
1195	@_ >= 2	2325	my $key = "$_[0]/$_[1]";
1196	? $DB->{$_[0]}{$_[1]}
1197	: ($DB->{$_[0]} ||= { })
1198	}
1199		2326
		2327	cf::sync_job {
		2328	BDB::db_get $DB, undef, $key, my $data;
		2329
		2330	$! ? ()
		2331	: $data
		2332	}
		2333	}
		2334
1200	sub db_put($$;$) {	2335	sub db_put($$$) {
1201	if (@_ >= 3) {	2336	BDB::dbreq_pri 4;
1202	$DB->{$_[0]}{$_[1]} = $_[2];	2337	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
1203	} else {	2338	}
1204	$DB->{$_[0]} = $_[1];
1205	}
1206	db_dirty;
1207	}
1208		2339
1209	cf::global->attach (	2340	=item cf::cache $id => [$paths...], $processversion => $process
1210	prio => 10000,	2341
1211	on_cleanup => sub {	2342	Generic caching function that returns the value of the resource $id,
1212	db_sync;	2343	caching and regenerating as required.
		2344
		2345	This function can block.
		2346
		2347	=cut
		2348
		2349	sub cache {
		2350	my ($id, $src, $processversion, $process) = @_;
		2351
		2352	my $meta =
		2353	join "\x00",
		2354	$processversion,
		2355	map {
		2356	aio_stat $_
		2357	and Carp::croak "$_: $!";
		2358
		2359	($_, (stat _)[7,9])
		2360	} @$src;
		2361
		2362	my $dbmeta = db_get cache => "$id/meta";
		2363	if ($dbmeta ne $meta) {
		2364	# changed, we may need to process
		2365
		2366	my @data;
		2367	my $md5;
		2368
		2369	for (0 .. $#$src) {
		2370	0 <= aio_load $src->[$_], $data[$_]
		2371	or Carp::croak "$src->[$_]: $!";
1213	},	2372	}
1214	);	2373
		2374	# if processing is expensive, check
		2375	# checksum first
		2376	if (1) {
		2377	$md5 =
		2378	join "\x00",
		2379	$processversion,
		2380	map {
		2381	Coro::cede;
		2382	($src->[$_], Digest::MD5::md5_hex $data[$_])
		2383	} 0.. $#$src;
		2384
		2385
		2386	my $dbmd5 = db_get cache => "$id/md5";
		2387	if ($dbmd5 eq $md5) {
		2388	db_put cache => "$id/meta", $meta;
		2389
		2390	return db_get cache => "$id/data";
		2391	}
		2392	}
		2393
		2394	my $t1 = Time::HiRes::time;
		2395	my $data = $process->(\@data);
		2396	my $t2 = Time::HiRes::time;
		2397
		2398	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		2399
		2400	db_put cache => "$id/data", $data;
		2401	db_put cache => "$id/md5" , $md5;
		2402	db_put cache => "$id/meta", $meta;
		2403
		2404	return $data;
		2405	}
		2406
		2407	db_get cache => "$id/data"
1215	}	2408	}
		2409
		2410	=item fork_call { }, $args
		2411
		2412	Executes the given code block with the given arguments in a seperate
		2413	process, returning the results. Everything must be serialisable with
		2414	Coro::Storable. May, of course, block. Note that the executed sub may
		2415	never block itself or use any form of Event handling.
		2416
		2417	=cut
		2418
		2419	sub fork_call(&@) {
		2420	my ($cb, @args) = @_;
		2421
		2422	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
		2423	# or die "socketpair: $!";
		2424	pipe my $fh1, my $fh2
		2425	or die "pipe: $!";
		2426
		2427	if (my $pid = fork) {
		2428	close $fh2;
		2429
		2430	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
		2431	$res = Coro::Storable::thaw $res;
		2432
		2433	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		2434
		2435	die $$res unless "ARRAY" eq ref $res;
		2436
		2437	return wantarray ? @$res : $res->[-1];
		2438	} else {
		2439	local $SIG{__WARN__};
		2440	eval {
		2441	local $SIG{__DIE__};
		2442	close $fh1;
		2443
		2444	my @res = eval { $cb->(@args) };
		2445	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
		2446	};
		2447
		2448	warn $@ if $@;
		2449	_exit 0;
		2450	}
		2451	}
		2452
		2453
1216		2454
1217	#############################################################################	2455	#############################################################################
1218	# the server's main()	2456	# the server's init and main functions
		2457
		2458	sub load_facedata($) {
		2459	my ($path) = @_;
		2460
		2461	warn "loading facedata from $path\n";
		2462
		2463	my $facedata;
		2464	0 < aio_load $path, $facedata
		2465	or die "$path: $!";
		2466
		2467	$facedata = Coro::Storable::thaw $facedata;
		2468
		2469	$facedata->{version} == 2
		2470	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2471
		2472	{
		2473	my $faces = $facedata->{faceinfo};
		2474
		2475	while (my ($face, $info) = each %$faces) {
		2476	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2477	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
		2478	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2479	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2480	Coro::cede;
		2481	}
		2482
		2483	while (my ($face, $info) = each %$faces) {
		2484	next unless $info->{smooth};
		2485	my $idx = cf::face::find $face
		2486	or next;
		2487	if (my $smooth = cf::face::find $info->{smooth}) {
		2488	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2489	} else {
		2490	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2491	}
		2492	Coro::cede;
		2493	}
		2494	}
		2495
		2496	{
		2497	my $anims = $facedata->{animinfo};
		2498
		2499	while (my ($anim, $info) = each %$anims) {
		2500	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2501	Coro::cede;
		2502	}
		2503
		2504	cf::anim::invalidate_all; # d'oh
		2505	}
		2506
		2507	1
		2508	}
		2509
		2510	sub reload_regions {
		2511	load_resource_file "$MAPDIR/regions"
		2512	or die "unable to load regions file\n";
		2513	}
		2514
		2515	sub reload_facedata {
		2516	load_facedata "$DATADIR/facedata"
		2517	or die "unable to load facedata\n";
		2518	}
		2519
		2520	sub reload_archetypes {
		2521	load_resource_file "$DATADIR/archetypes"
		2522	or die "unable to load archetypes\n";
		2523	}
		2524
		2525	sub reload_treasures {
		2526	load_resource_file "$DATADIR/treasures"
		2527	or die "unable to load treasurelists\n";
		2528	}
		2529
		2530	sub reload_resources {
		2531	warn "reloading resource files...\n";
		2532
		2533	reload_regions;
		2534	reload_facedata;
		2535	reload_archetypes;
		2536	reload_treasures;
		2537
		2538	warn "finished reloading resource files\n";
		2539	}
		2540
		2541	sub init {
		2542	reload_resources;
		2543	}
1219		2544
1220	sub cfg_load {	2545	sub cfg_load {
1221	open my $fh, "<:utf8", cf::confdir . "/config"	2546	open my $fh, "<:utf8", "$CONFDIR/config"
1222	or return;	2547	or return;
1223		2548
1224	local $/;	2549	local $/;
1225	*CFG = YAML::Syck::Load <$fh>;	2550	*CFG = YAML::Syck::Load <$fh>;
		2551
		2552	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2553
		2554	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2555	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2556
		2557	if (exists $CFG{mlockall}) {
		2558	eval {
		2559	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2560	and die "WARNING: m(un)lockall failed: $!\n";
		2561	};
		2562	warn $@ if $@;
		2563	}
1226	}	2564	}
1227		2565
1228	sub main {	2566	sub main {
		2567	# we must not ever block the main coroutine
		2568	local $Coro::idle = sub {
		2569	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2570	(async {
		2571	Event::one_event;
		2572	})->prio (Coro::PRIO_MAX);
		2573	};
		2574
1229	cfg_load;	2575	cfg_load;
1230	db_load;	2576	db_init;
1231	load_extensions;	2577	load_extensions;
		2578
		2579	$TICK_WATCHER->start;
1232	Event::loop;	2580	Event::loop;
1233	}	2581	}
1234		2582
1235	#############################################################################	2583	#############################################################################
1236	# initialisation	2584	# initialisation and cleanup
1237		2585
1238	sub _perl_reload() {	2586	# install some emergency cleanup handlers
		2587	BEGIN {
		2588	for my $signal (qw(INT HUP TERM)) {
		2589	Event->signal (
		2590	reentrant => 0,
		2591	data => WF_AUTOCANCEL,
		2592	signal => $signal,
		2593	prio => 0,
		2594	cb => sub {
		2595	cf::cleanup "SIG$signal";
		2596	},
		2597	);
		2598	}
		2599	}
		2600
		2601	sub emergency_save() {
		2602	my $freeze_guard = cf::freeze_mainloop;
		2603
		2604	warn "enter emergency perl save\n";
		2605
		2606	cf::sync_job {
		2607	# use a peculiar iteration method to avoid tripping on perl
		2608	# refcount bugs in for. also avoids problems with players
		2609	# and maps saved/destroyed asynchronously.
		2610	warn "begin emergency player save\n";
		2611	for my $login (keys %cf::PLAYER) {
		2612	my $pl = $cf::PLAYER{$login} or next;
		2613	$pl->valid or next;
		2614	$pl->save;
		2615	}
		2616	warn "end emergency player save\n";
		2617
		2618	warn "begin emergency map save\n";
		2619	for my $path (keys %cf::MAP) {
		2620	my $map = $cf::MAP{$path} or next;
		2621	$map->valid or next;
		2622	$map->save;
		2623	}
		2624	warn "end emergency map save\n";
		2625
		2626	warn "begin emergency database checkpoint\n";
		2627	BDB::db_env_txn_checkpoint $DB_ENV;
		2628	warn "end emergency database checkpoint\n";
		2629	};
		2630
		2631	warn "leave emergency perl save\n";
		2632	}
		2633
		2634	sub post_cleanup {
		2635	my ($make_core) = @_;
		2636
		2637	warn Carp::longmess "post_cleanup backtrace"
		2638	if $make_core;
		2639	}
		2640
		2641	sub do_reload_perl() {
		2642	# can/must only be called in main
		2643	if ($Coro::current != $Coro::main) {
		2644	warn "can only reload from main coroutine";
		2645	return;
		2646	}
		2647
1239	warn "reloading...";	2648	warn "reloading...";
1240		2649
1241	eval {	2650	warn "entering sync_job";
1242	local $FREEZE = 1;
1243		2651
		2652	cf::sync_job {
		2653	cf::write_runtime; # external watchdog should not bark
1244	cf::emergency_save;	2654	cf::emergency_save;
		2655	cf::write_runtime; # external watchdog should not bark
1245		2656
1246	# cancel all watchers	2657	warn "syncing database to disk";
		2658	BDB::db_env_txn_checkpoint $DB_ENV;
		2659
		2660	# if anything goes wrong in here, we should simply crash as we already saved
		2661
		2662	warn "cancelling all WF_AUTOCANCEL watchers";
1247	for (Event::all_watchers) {	2663	for (Event::all_watchers) {
1248	$_->cancel if $_->data & WF_AUTOCANCEL;	2664	$_->cancel if $_->data & WF_AUTOCANCEL;
1249	}	2665	}
1250		2666
		2667	warn "flushing outstanding aio requests";
		2668	for (;;) {
		2669	BDB::flush;
		2670	IO::AIO::flush;
		2671	Coro::cede;
		2672	last unless IO::AIO::nreqs || BDB::nreqs;
		2673	warn "iterate...";
		2674	}
		2675
		2676	++$RELOAD;
		2677
1251	# cancel all extension coros	2678	warn "cancelling all extension coros";
1252	$_->cancel for values %EXT_CORO;	2679	$_->cancel for values %EXT_CORO;
1253	%EXT_CORO = ();	2680	%EXT_CORO = ();
1254		2681
1255	# unload all extensions	2682	warn "removing commands";
1256	for (@exts) {	2683	%COMMAND = ();
		2684
		2685	warn "removing ext commands";
		2686	%EXTCMD = ();
		2687
		2688	warn "unloading/nuking all extensions";
		2689	for my $pkg (@EXTS) {
1257	warn "unloading <$_>";	2690	warn "... unloading $pkg";
1258	unload_extension $_;	2691
		2692	if (my $cb = $pkg->can ("unload")) {
		2693	eval {
		2694	$cb->($pkg);
		2695	1
		2696	} or warn "$pkg unloaded, but with errors: $@";
1259	}	2697	}
1260		2698
		2699	warn "... nuking $pkg";
		2700	Symbol::delete_package $pkg;
		2701	}
		2702
1261	# unload all modules loaded from $LIBDIR	2703	warn "unloading all perl modules loaded from $LIBDIR";
1262	while (my ($k, $v) = each %INC) {	2704	while (my ($k, $v) = each %INC) {
1263	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2705	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1264		2706
1265	warn "removing <$k>";	2707	warn "... unloading $k";
1266	delete $INC{$k};	2708	delete $INC{$k};
1267		2709
1268	$k =~ s/\.pm$//;	2710	$k =~ s/\.pm$//;
1269	$k =~ s/\//::/g;	2711	$k =~ s/\//::/g;
1270		2712
…		…
1273	}	2715	}
1274		2716
1275	Symbol::delete_package $k;	2717	Symbol::delete_package $k;
1276	}	2718	}
1277		2719
1278	# sync database to disk
1279	cf::db_sync;
1280	IO::AIO::flush;
1281
1282	# get rid of safe::, as good as possible	2720	warn "getting rid of safe::, as good as possible";
1283	Symbol::delete_package "safe::$_"	2721	Symbol::delete_package "safe::$_"
1284	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2722	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1285		2723
1286	# remove register_script_function callbacks
1287	# TODO
1288
1289	# unload cf.pm "a bit"	2724	warn "unloading cf.pm \"a bit\"";
1290	delete $INC{"cf.pm"};	2725	delete $INC{"cf.pm"};
		2726	delete $INC{"cf/pod.pm"};
1291		2727
1292	# don't, removes xs symbols, too,	2728	# don't, removes xs symbols, too,
1293	# and global variables created in xs	2729	# and global variables created in xs
1294	#Symbol::delete_package __PACKAGE__;	2730	#Symbol::delete_package __PACKAGE__;
1295		2731
1296	# reload cf.pm	2732	warn "unload completed, starting to reload now";
		2733
1297	warn "reloading cf.pm";	2734	warn "reloading cf.pm";
1298	require cf;	2735	require cf;
1299	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	2736	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1300		2737
1301	# load config and database again	2738	warn "loading config and database again";
1302	cf::cfg_load;	2739	cf::cfg_load;
1303	cf::db_load;
1304		2740
1305	# load extensions
1306	warn "load extensions";	2741	warn "loading extensions";
1307	cf::load_extensions;	2742	cf::load_extensions;
1308		2743
1309	# reattach attachments to objects	2744	warn "reattaching attachments to objects/players";
1310	warn "reattach";	2745	_global_reattach; # objects, sockets
1311	_global_reattach;	2746	warn "reattaching attachments to maps";
		2747	reattach $_ for values %MAP;
		2748	warn "reattaching attachments to players";
		2749	reattach $_ for values %PLAYER;
		2750
		2751	warn "leaving sync_job";
		2752
		2753	1
		2754	} or do {
		2755	warn $@;
		2756	warn "error while reloading, exiting.";
		2757	exit 1;
1312	};	2758	};
1313	warn $@ if $@;
1314		2759
1315	warn "reloaded";	2760	warn "reloaded";
1316	};	2761	};
1317		2762
1318	sub perl_reload() {	2763	our $RELOAD_WATCHER; # used only during reload
1319	_perl_reload;
1320	}
1321		2764
1322	register "<global>", __PACKAGE__;	2765	sub reload_perl() {
		2766	# doing reload synchronously and two reloads happen back-to-back,
		2767	# coro crashes during coro_state_free->destroy here.
1323		2768
		2769	$RELOAD_WATCHER ||= Event->timer (
		2770	reentrant => 0,
		2771	after => 0,
		2772	data => WF_AUTOCANCEL,
		2773	cb => sub {
		2774	do_reload_perl;
		2775	undef $RELOAD_WATCHER;
		2776	},
		2777	);
		2778	}
		2779
1324	register_command "perl-reload" => sub {	2780	register_command "reload" => sub {
1325	my ($who, $arg) = @_;	2781	my ($who, $arg) = @_;
1326		2782
1327	if ($who->flag (FLAG_WIZ)) {	2783	if ($who->flag (FLAG_WIZ)) {
1328	$who->message ("reloading...");	2784	$who->message ("reloading server.");
1329	_perl_reload;	2785	async { reload_perl };
1330	}	2786	}
1331	};	2787	};
1332		2788
1333	unshift @INC, $LIBDIR;	2789	unshift @INC, $LIBDIR;
		2790
		2791	my $bug_warning = 0;
		2792
		2793	our @WAIT_FOR_TICK;
		2794	our @WAIT_FOR_TICK_BEGIN;
		2795
		2796	sub wait_for_tick {
		2797	return unless $TICK_WATCHER->is_active;
		2798	return if $Coro::current == $Coro::main;
		2799
		2800	my $signal = new Coro::Signal;
		2801	push @WAIT_FOR_TICK, $signal;
		2802	$signal->wait;
		2803	}
		2804
		2805	sub wait_for_tick_begin {
		2806	return unless $TICK_WATCHER->is_active;
		2807	return if $Coro::current == $Coro::main;
		2808
		2809	my $signal = new Coro::Signal;
		2810	push @WAIT_FOR_TICK_BEGIN, $signal;
		2811	$signal->wait;
		2812	}
1334		2813
1335	$TICK_WATCHER = Event->timer (	2814	$TICK_WATCHER = Event->timer (
1336	reentrant => 0,	2815	reentrant => 0,
		2816	parked => 1,
1337	prio => 0,	2817	prio => 0,
1338	at => $NEXT_TICK || $TICK,	2818	at => $NEXT_TICK || $TICK,
1339	data => WF_AUTOCANCEL,	2819	data => WF_AUTOCANCEL,
1340	cb => sub {	2820	cb => sub {
1341	unless ($FREEZE) {	2821	if ($Coro::current != $Coro::main) {
		2822	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		2823	unless ++$bug_warning > 10;
		2824	return;
		2825	}
		2826
		2827	$NOW = Event::time;
		2828
1342	cf::server_tick; # one server iteration	2829	cf::server_tick; # one server iteration
		2830
1343	$RUNTIME += $TICK;	2831	$RUNTIME += $TICK;
1344	}
1345
1346	$NEXT_TICK += $TICK;	2832	$NEXT_TICK += $TICK;
		2833
		2834	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		2835	$NEXT_RUNTIME_WRITE = $NOW + 10;
		2836	Coro::async_pool {
		2837	write_runtime
		2838	or warn "ERROR: unable to write runtime file: $!";
		2839	};
		2840	}
		2841
		2842	# my $AFTER = Event::time;
		2843	# warn $AFTER - $NOW;#d#
1347		2844
1348	# if we are delayed by four ticks or more, skip them all	2845	# if we are delayed by four ticks or more, skip them all
1349	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	2846	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1350		2847
1351	$TICK_WATCHER->at ($NEXT_TICK);	2848	$TICK_WATCHER->at ($NEXT_TICK);
1352	$TICK_WATCHER->start;	2849	$TICK_WATCHER->start;
		2850
		2851	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		2852	$sig->send;
		2853	}
		2854	while (my $sig = shift @WAIT_FOR_TICK) {
		2855	$sig->send;
		2856	}
		2857
		2858	_post_tick;
1353	},	2859	},
1354	);	2860	);
1355		2861
		2862	{
		2863	BDB::max_poll_time $TICK * 0.1;
		2864	$BDB_POLL_WATCHER = Event->io (
		2865	reentrant => 0,
		2866	fd => BDB::poll_fileno,
		2867	poll => 'r',
		2868	prio => 0,
		2869	data => WF_AUTOCANCEL,
		2870	cb => \&BDB::poll_cb,
		2871	);
		2872	BDB::min_parallel 8;
		2873
		2874	BDB::set_sync_prepare {
		2875	my $status;
		2876	my $current = $Coro::current;
		2877	(
		2878	sub {
		2879	$status = $!;
		2880	$current->ready; undef $current;
		2881	},
		2882	sub {
		2883	Coro::schedule while defined $current;
		2884	$! = $status;
		2885	},
		2886	)
		2887	};
		2888
		2889	unless ($DB_ENV) {
		2890	$DB_ENV = BDB::db_env_create;
		2891
		2892	cf::sync_job {
		2893	eval {
		2894	BDB::db_env_open
		2895	$DB_ENV,
		2896	$BDBDIR,
		2897	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		2898	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		2899	0666;
		2900
		2901	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		2902
		2903	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		2904	$DB_ENV->set_lk_detect;
		2905	};
		2906
		2907	cf::cleanup "db_env_open(db): $@" if $@;
		2908	};
		2909	}
		2910	}
		2911
		2912	{
		2913	IO::AIO::min_parallel 8;
		2914
		2915	undef $Coro::AIO::WATCHER;
1356	IO::AIO::max_poll_time $TICK * 0.2;	2916	IO::AIO::max_poll_time $TICK * 0.1;
1357		2917	$AIO_POLL_WATCHER = Event->io (
1358	Event->io (fd => IO::AIO::poll_fileno,	2918	reentrant => 0,
1359	poll => 'r',
1360	prio => 5,
1361	data => WF_AUTOCANCEL,	2919	data => WF_AUTOCANCEL,
		2920	fd => IO::AIO::poll_fileno,
		2921	poll => 'r',
		2922	prio => 6,
1362	cb => \&IO::AIO::poll_cb);	2923	cb => \&IO::AIO::poll_cb,
		2924	);
		2925	}
1363		2926
1364	# we must not ever block the main coroutine	2927	# load additional modules
1365	$Coro::idle = sub {	2928	use cf::pod;
1366	#Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#	2929
1367	warn "FATAL: Coro::idle was called, major BUG\n";	2930	END { cf::emergency_save }
1368	(Coro::unblock_sub {
1369	Event::one_event;
1370	})->();
1371	};
1372		2931
1373	1	2932	1
1374		2933

Diff Legend

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