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

Diff Legend

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