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.107 by root, Sun Dec 31 18:10:40 2006 UTC vs.
Revision 1.256 by root, Sat Apr 21 16:56:32 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;
18	use Coro::AIO;	22	use Coro::AIO;
		23	use Coro::Storable;
19		24
		25	use BDB ();
		26	use Data::Dumper;
		27	use Digest::MD5;
20	use Fcntl;	28	use Fcntl;
21	use IO::AIO 2.31 ();
22	use YAML::Syck ();	29	use YAML::Syck ();
		30	use IO::AIO 2.32 ();
23	use Time::HiRes;	31	use Time::HiRes;
		32	use Compress::LZF;
24		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
25	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
26		41
27	# 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?
28	$YAML::Syck::ImplicitUnicode = 1;	43	$YAML::Syck::ImplicitUnicode = 1;
29		44
30	$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
31		46
32	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	47	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
33		48
34	our %COMMAND = ();	49	our %COMMAND = ();
35	our %COMMAND_TIME = ();	50	our %COMMAND_TIME = ();
		51
		52	our @EXTS = (); # list of extension package names
36	our %EXTCMD = ();	53	our %EXTCMD = ();
		54	our %EXT_CORO = (); # coroutines bound to extensions
		55	our %EXT_MAP = (); # pluggable maps
37		56
		57	our $RELOAD; # number of reloads so far
38	our @EVENT;	58	our @EVENT;
39	our $LIBDIR = datadir . "/ext";
40		59
41	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(!)
42	our $TICK_WATCHER;	73	our $TICK_WATCHER;
		74	our $AIO_POLL_WATCHER;
		75	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
43	our $NEXT_TICK;	76	our $NEXT_TICK;
44	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;
45		82
46	our %CFG;	83	our %CFG;
47		84
48	our $UPTIME; $UPTIME ||= time;	85	our $UPTIME; $UPTIME ||= time;
49	our $RUNTIME;	86	our $RUNTIME;
50		87
		88	our %PLAYER; # all users
51	our %MAP; # all maps	89	our %MAP; # all maps
52	our $LINK_MAP; # the special {link} map	90	our $LINK_MAP; # the special {link} map, which is always available
53	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
54		94
55	binmode STDOUT;	95	binmode STDOUT;
56	binmode STDERR;	96	binmode STDERR;
57		97
58	# read virtual server time, if available	98	# read virtual server time, if available
59	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	99	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
60	open my $fh, "<", cf::localdir . "/runtime"	100	open my $fh, "<", "$LOCALDIR/runtime"
61	or die "unable to read runtime file: $!";	101	or die "unable to read runtime file: $!";
62	$RUNTIME = <$fh> + 0.;	102	$RUNTIME = <$fh> + 0.;
63	}	103	}
64		104
65	mkdir cf::localdir;	105	mkdir $_
66	mkdir cf::localdir . "/" . cf::playerdir;	106	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
67	mkdir cf::localdir . "/" . cf::tmpdir;
68	mkdir cf::localdir . "/" . cf::uniquedir;
69		107
70	our %EXT_CORO;	108	our $EMERGENCY_POSITION;
		109
		110	sub cf::map::normalise;
71		111
72	#############################################################################	112	#############################################################################
73		113
74	=head2 GLOBAL VARIABLES	114	=head2 GLOBAL VARIABLES
75		115
…		…
82	=item $cf::RUNTIME	122	=item $cf::RUNTIME
83		123
84	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
85	every server tick.	125	every server tick.
86		126
87	=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
88		130
89	The perl library directory, where extensions and cf-specific modules can	131	Various directories - "/etc", read-only install directory, perl-library
90	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.
91		135
92	=item $cf::NOW	136	=item $cf::NOW
93		137
94	The time of the last (current) server tick.	138	The time of the last (current) server tick.
95		139
…		…
99		143
100	=item %cf::CFG	144	=item %cf::CFG
101		145
102	Configuration for the server, loaded from C</etc/crossfire/config>, or	146	Configuration for the server, loaded from C</etc/crossfire/config>, or
103	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.
104		154
105	=back	155	=back
106		156
107	=cut	157	=cut
108		158
109	BEGIN {	159	BEGIN {
110	*CORE::GLOBAL::warn = sub {	160	*CORE::GLOBAL::warn = sub {
111	my $msg = join "", @_;	161	my $msg = join "", @_;
112	utf8::encode $msg;
113		162
114	$msg .= "\n"	163	$msg .= "\n"
115	unless $msg =~ /\n$/;	164	unless $msg =~ /\n$/;
116		165
		166	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		167
		168	utf8::encode $msg;
117	LOG llevError, "cfperl: $msg";	169	LOG llevError, $msg;
118	};	170	};
119	}	171	}
120		172
121	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	173	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
122	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	174	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
…		…
140		192
141	$Event::DIED = sub {	193	$Event::DIED = sub {
142	warn "error in event callback: @_";	194	warn "error in event callback: @_";
143	};	195	};
144		196
145	my %ext_pkg;
146	my @exts;
147	my @hook;
148
149	=head2 UTILITY FUNCTIONS	197	=head2 UTILITY FUNCTIONS
150		198
151	=over 4	199	=over 4
152		200
153	=cut	201	=item dumpval $ref
154		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
155	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
156		225
157	=item $ref = cf::from_json $json	226	=item $ref = cf::from_json $json
158		227
159	Converts a JSON string into the corresponding perl data structure.	228	Converts a JSON string into the corresponding perl data structure.
160		229
161	=cut
162
163	sub from_json($) {
164	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
165	JSON::Syck::Load $_[0]
166	}
167
168	=item $json = cf::to_json $ref	230	=item $json = cf::to_json $ref
169		231
170	Converts a perl data structure into its JSON representation.	232	Converts a perl data structure into its JSON representation.
171		233
172	=cut	234	=item cf::lock_wait $string
173		235
174	sub to_json($) {	236	Wait until the given lock is available. See cf::lock_acquire.
175	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	237
176	JSON::Syck::Dump $_[0]	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	}
177	}	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 }
178		305
179	=item cf::sync_job { BLOCK }	306	=item cf::sync_job { BLOCK }
180		307
181	The design of crossfire+ requires that the main coro ($Coro::main) is	308	The design of crossfire+ requires that the main coro ($Coro::main) is
182	always able to handle events or runnable, as crossfire+ is only partly	309	always able to handle events or runnable, as crossfire+ is only partly
…		…
190	=cut	317	=cut
191		318
192	sub sync_job(&) {	319	sub sync_job(&) {
193	my ($job) = @_;	320	my ($job) = @_;
194		321
195	my $busy = 1;
196	my @res;
197
198	# TODO: use suspend/resume instead
199	local $FREEZE = 1;
200
201	my $coro = Coro::async {
202	@res = eval { $job->() };
203	warn $@ if $@;
204	undef $busy;
205	};
206
207	if ($Coro::current == $Coro::main) {	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;
208	$coro->prio (Coro::PRIO_MAX);	337	})->prio (Coro::PRIO_MAX);
		338
209	while ($busy) {	339	while ($busy) {
210	Coro::cede_notself;	340	Coro::cede or Event::one_event;
211	Event::one_event unless Coro::nready;
212	}	341	}
		342
		343	wantarray ? @res : $res[0]
213	} else {	344	} else {
214	$coro->join;	345	# we are in another coroutine, how wonderful, everything just works
		346
		347	$job->()
215	}	348	}
216
217	wantarray ? @res : $res[0]
218	}	349	}
219		350
220	=item $coro = cf::coro { BLOCK }	351	=item $coro = cf::async_ext { BLOCK }
221		352
222	Creates and returns a new coro. This coro is automcatially being canceled	353	Like async, but this coro is automatically being canceled when the
223	when the extension calling this is being unloaded.	354	extension calling this is being unloaded.
224		355
225	=cut	356	=cut
226		357
227	sub coro(&) {	358	sub async_ext(&) {
228	my $cb = shift;	359	my $cb = shift;
229		360
230	my $coro; $coro = async {	361	my $coro = &Coro::async ($cb);
231	eval {
232	$cb->();
233	};
234	warn $@ if $@;
235	};
236		362
237	$coro->on_destroy (sub {	363	$coro->on_destroy (sub {
238	delete $EXT_CORO{$coro+0};	364	delete $EXT_CORO{$coro+0};
239	});	365	});
240	$EXT_CORO{$coro+0} = $coro;	366	$EXT_CORO{$coro+0} = $coro;
241		367
242	$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 });
243	}	408	}
244		409
245	=back	410	=back
246		411
247	=cut	412	=cut
…		…
378	our @CB_TYPE = (); # registry for type (cf-object class) based events	543	our @CB_TYPE = (); # registry for type (cf-object class) based events
379	our @CB_MAP = ();	544	our @CB_MAP = ();
380		545
381	my %attachment;	546	my %attachment;
382		547
		548	sub cf::attachable::thawer_merge {
		549	# simply override everything except _meta
		550	local $_[0]{_meta};
		551	%{$_[0]} = %{$_[1]};
		552	}
		553
383	sub _attach_cb($$$$) {	554	sub _attach_cb($$$$) {
384	my ($registry, $event, $prio, $cb) = @_;	555	my ($registry, $event, $prio, $cb) = @_;
385		556
386	use sort 'stable';	557	use sort 'stable';
387		558
…		…
558	# object support	729	# object support
559		730
560	sub reattach {	731	sub reattach {
561	# basically do the same as instantiate, without calling instantiate	732	# basically do the same as instantiate, without calling instantiate
562	my ($obj) = @_;	733	my ($obj) = @_;
		734
		735	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
563		736
564	my $registry = $obj->registry;	737	my $registry = $obj->registry;
565		738
566	@$registry = ();	739	@$registry = ();
567		740
…		…
614	$filename, length $$rdata, scalar @$objs;	787	$filename, length $$rdata, scalar @$objs;
615		788
616	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	789	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
617	chmod SAVE_MODE, $fh;	790	chmod SAVE_MODE, $fh;
618	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	791	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
619	aio_fsync $fh;	792	aio_fsync $fh if $cf::USE_FSYNC;
620	close $fh;	793	close $fh;
621		794
622	if (@$objs) {	795	if (@$objs) {
623	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	796	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
624	chmod SAVE_MODE, $fh;	797	chmod SAVE_MODE, $fh;
625	my $data = Storable::nfreeze { version => 1, objs => $objs };	798	my $data = Storable::nfreeze { version => 1, objs => $objs };
626	aio_write $fh, 0, (length $data), $data, 0;	799	aio_write $fh, 0, (length $data), $data, 0;
627	aio_fsync $fh;	800	aio_fsync $fh if $cf::USE_FSYNC;
628	close $fh;	801	close $fh;
629	aio_rename "$filename.pst~", "$filename.pst";	802	aio_rename "$filename.pst~", "$filename.pst";
630	}	803	}
631	} else {	804	} else {
632	aio_unlink "$filename.pst";	805	aio_unlink "$filename.pst";
…		…
660	or return;	833	or return;
661		834
662	unless (aio_stat "$filename.pst") {	835	unless (aio_stat "$filename.pst") {
663	(aio_load "$filename.pst", $av) >= 0	836	(aio_load "$filename.pst", $av) >= 0
664	or return;	837	or return;
665	$av = eval { (Storable::thaw <$av>)->{objs} };	838	$av = eval { (Storable::thaw $av)->{objs} };
666	}	839	}
667		840
		841	warn sprintf "loading %s (%d)\n",
		842	$filename, length $data, scalar @{$av || []};#d#
668	return ($data, $av);	843	return ($data, $av);
669	}	844	}
670		845
671	#############################################################################	846	#############################################################################
672	# command handling &c	847	# command handling &c
…		…
697	=cut	872	=cut
698		873
699	sub register_extcmd {	874	sub register_extcmd {
700	my ($name, $cb) = @_;	875	my ($name, $cb) = @_;
701		876
702	my $caller = caller;
703	#warn "registering extcmd '$name' to '$caller'";
704
705	$EXTCMD{$name} = [$cb, $caller];	877	$EXTCMD{$name} = $cb;
706	}	878	}
707		879
708	cf::player->attach (	880	cf::player->attach (
709	on_command => sub {	881	on_command => sub {
710	my ($pl, $name, $params) = @_;	882	my ($pl, $name, $params) = @_;
…		…
723		895
724	my $msg = eval { from_json $buf };	896	my $msg = eval { from_json $buf };
725		897
726	if (ref $msg) {	898	if (ref $msg) {
727	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	899	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
728	if (my %reply = $cb->[0]->($pl, $msg)) {	900	if (my %reply = $cb->($pl, $msg)) {
729	$pl->ext_reply ($msg->{msgid}, %reply);	901	$pl->ext_reply ($msg->{msgid}, %reply);
730	}	902	}
731	}	903	}
732	} else {	904	} else {
733	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	905	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
…		…
735		907
736	cf::override;	908	cf::override;
737	},	909	},
738	);	910	);
739		911
740	sub register {
741	my ($base, $pkg) = @_;
742
743	#TODO
744	}
745
746	sub load_extension {	912	sub load_extension {
747	my ($path) = @_;	913	my ($path) = @_;
748		914
749	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	915	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
750	my $base = $1;	916	my $base = $1;
751	my $pkg = $1;	917	my $pkg = $1;
752	$pkg =~ s/[^[:word:]]/_/g;	918	$pkg =~ s/[^[:word:]]/_/g;
753	$pkg = "ext::$pkg";	919	$pkg = "ext::$pkg";
754		920
755	warn "loading '$path' into '$pkg'\n";	921	warn "... loading '$path' into '$pkg'\n";
756		922
757	open my $fh, "<:utf8", $path	923	open my $fh, "<:utf8", $path
758	or die "$path: $!";	924	or die "$path: $!";
759		925
760	my $source =	926	my $source =
761	"package $pkg; use strict; use utf8;\n"	927	"package $pkg; use strict; use utf8;\n"
762	. "#line 1 \"$path\"\n{\n"	928	. "#line 1 \"$path\"\n{\n"
763	. (do { local $/; <$fh> })	929	. (do { local $/; <$fh> })
764	. "\n};\n1";	930	. "\n};\n1";
765		931
766	eval $source	932	unless (eval $source) {
767	or die $@ ? "$path: $@\n"	933	my $msg = $@ ? "$path: $@\n"
768	: "extension disabled.\n";	934	: "extension disabled.\n";
769		935	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
770	push @exts, $pkg;	936	warn $@;
771	$ext_pkg{$base} = $pkg;	937	warn "mandatory extension failed to load, exiting.\n";
772		938	exit 1;
773	# no strict 'refs';	939	}
774	# @{"$pkg\::ISA"} = ext::;	940	die $@;
775
776	register $base, $pkg;
777	}
778
779	sub unload_extension {
780	my ($pkg) = @_;
781
782	warn "removing extension $pkg\n";
783
784	# remove hooks
785	#TODO
786	# for my $idx (0 .. $#PLUGIN_EVENT) {
787	# delete $hook[$idx]{$pkg};
788	# }	941	}
789		942
790	# remove commands	943	push @EXTS, $pkg;
791	for my $name (keys %COMMAND) {
792	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
793
794	if (@cb) {
795	$COMMAND{$name} = \@cb;
796	} else {
797	delete $COMMAND{$name};
798	}
799	}
800
801	# remove extcmds
802	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
803	delete $EXTCMD{$name};
804	}
805
806	if (my $cb = $pkg->can ("unload")) {
807	eval {
808	$cb->($pkg);
809	1
810	} or warn "$pkg unloaded, but with errors: $@";
811	}
812
813	Symbol::delete_package $pkg;
814	}	944	}
815		945
816	sub load_extensions {	946	sub load_extensions {
817	for my $ext (<$LIBDIR/*.ext>) {	947	for my $ext (<$LIBDIR/*.ext>) {
818	next unless -r $ext;	948	next unless -r $ext;
…		…
822	} or warn "$ext not loaded: $@";	952	} or warn "$ext not loaded: $@";
823	}	953	}
824	}	954	}
825		955
826	#############################################################################	956	#############################################################################
827	# load/save/clean perl data associated with a map
828		957
829	*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}.map"
		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.map"
		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
		1496	{
		1497	my $guard = cf::lock_acquire "map_load:$path";
		1498
		1499	return if $self->in_memory != cf::MAP_SWAPPED;
		1500
		1501	$self->in_memory (cf::MAP_LOADING);
		1502
		1503	$self->alloc;
		1504
		1505	$self->pre_load;
		1506	Coro::cede;
		1507
		1508	$self->_load_objects ($self->{load_path}, 1)
		1509	or return;
		1510
		1511	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1512	if delete $self->{load_original};
		1513
		1514	if (my $uniq = $self->uniq_path) {
		1515	utf8::encode $uniq;
		1516	if (aio_open $uniq, O_RDONLY, 0) {
		1517	$self->clear_unique_items;
		1518	$self->_load_objects ($uniq, 0);
		1519	}
		1520	}
		1521
		1522	Coro::cede;
		1523	# now do the right thing for maps
		1524	$self->link_multipart_objects;
		1525	$self->difficulty ($self->estimate_difficulty)
		1526	unless $self->difficulty;
		1527	Coro::cede;
		1528
		1529	unless ($self->{deny_activate}) {
		1530	$self->decay_objects;
		1531	$self->fix_auto_apply;
		1532	$self->update_buttons;
		1533	Coro::cede;
		1534	$self->set_darkness_map;
		1535	Coro::cede;
		1536	$self->activate;
		1537	}
		1538
		1539	$self->in_memory (cf::MAP_IN_MEMORY);
		1540
		1541	undef $guard;
		1542	}
		1543
		1544	$self->post_load;
		1545	}
		1546
		1547	sub customise_for {
		1548	my ($self, $ob) = @_;
		1549
		1550	return find "~" . $ob->name . "/" . $self->{path}
		1551	if $self->per_player;
		1552
		1553	$self
		1554	}
		1555
		1556	# find and load all maps in the 3x3 area around a map
		1557	sub load_diag {
830	my ($map) = @_;	1558	my ($map) = @_;
831		1559
832	my $path = $map->tmpname;	1560	my @diag; # diagonal neighbours
833	defined $path or return;
834		1561
835	unlink "$path.pst";	1562	for (0 .. 3) {
836	};	1563	my $neigh = $map->tile_path ($_)
		1564	or next;
		1565	$neigh = find $neigh, $map
		1566	or next;
		1567	$neigh->load;
837		1568
838	cf::map->attach (prio => -10000, package => cf::mapsupport::);	1569	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1570	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1571	}
839		1572
840	#############################################################################	1573	for (@diag) {
841	# load/save perl data associated with player->ob objects	1574	my $neigh = find @$_
842		1575	or next;
843	sub all_objects(@) {	1576	$neigh->load;
844	@_, map all_objects ($_->inv), @_	1577	}
845	}	1578	}
846		1579
847	# TODO: compatibility cruft, remove when no longer needed	1580	sub find_sync {
848	cf::player->attach (	1581	my ($path, $origin) = @_;
849	on_load => sub {
850	my ($pl, $path) = @_;
851		1582
852	for my $o (all_objects $pl->ob) {	1583	cf::sync_job { find $path, $origin }
853	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1584	}
854	$o->set_ob_key_value ("_perl_data");
855		1585
856	%$o = %{ Storable::thaw pack "H*", $value };	1586	sub do_load_sync {
		1587	my ($map) = @_;
		1588
		1589	cf::sync_job { $map->load };
		1590	}
		1591
		1592	our %MAP_PREFETCH;
		1593	our $MAP_PREFETCHER = undef;
		1594
		1595	sub find_async {
		1596	my ($path, $origin) = @_;
		1597
		1598	$path = normalise $path, $origin && $origin->{path};
		1599
		1600	if (my $map = $cf::MAP{$path}) {
		1601	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1602	}
		1603
		1604	undef $MAP_PREFETCH{$path};
		1605	$MAP_PREFETCHER ||= cf::async {
		1606	while (%MAP_PREFETCH) {
		1607	for my $path (keys %MAP_PREFETCH) {
		1608	my $map = find $path
		1609	or next;
		1610	$map->load;
		1611
		1612	delete $MAP_PREFETCH{$path};
857	}	1613	}
858	}	1614	}
		1615	undef $MAP_PREFETCHER;
		1616	};
		1617	$MAP_PREFETCHER->prio (6);
		1618
		1619	()
		1620	}
		1621
		1622	sub save {
		1623	my ($self) = @_;
		1624
		1625	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1626
		1627	$self->{last_save} = $cf::RUNTIME;
		1628
		1629	return unless $self->dirty;
		1630
		1631	my $save = $self->save_path; utf8::encode $save;
		1632	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1633
		1634	$self->{load_path} = $save;
		1635
		1636	return if $self->{deny_save};
		1637
		1638	local $self->{last_access} = $self->last_access;#d#
		1639
		1640	cf::async {
		1641	$_->contr->save for $self->players;
		1642	};
		1643
		1644	if ($uniq) {
		1645	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1646	$self->_save_objects ($uniq, cf::IO_UNIQUES);
		1647	} else {
		1648	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
859	},	1649	}
860	);	1650	}
861		1651
862	#############################################################################	1652	sub swap_out {
		1653	my ($self) = @_;
863		1654
864	=head2 CORE EXTENSIONS	1655	# save first because save cedes
		1656	$self->save;
865		1657
866	Functions and methods that extend core crossfire objects.	1658	my $lock = cf::lock_acquire "map_data:" . $self->path;
867		1659
868	=head3 cf::player	1660	return if $self->players;
		1661	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1662	return if $self->{deny_save};
		1663
		1664	$self->clear;
		1665	$self->in_memory (cf::MAP_SWAPPED);
		1666	}
		1667
		1668	sub reset_at {
		1669	my ($self) = @_;
		1670
		1671	# TODO: safety, remove and allow resettable per-player maps
		1672	return 1e99 if $self->isa ("ext::map_per_player");#d#
		1673	return 1e99 if $self->{deny_reset};
		1674
		1675	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1676	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1677
		1678	$time + $to
		1679	}
		1680
		1681	sub should_reset {
		1682	my ($self) = @_;
		1683
		1684	$self->reset_at <= $cf::RUNTIME
		1685	}
		1686
		1687	sub reset {
		1688	my ($self) = @_;
		1689
		1690	my $lock = cf::lock_acquire "map_data:$self->{path}";
		1691
		1692	return if $self->players;
		1693	return if $self->isa ("ext::map_per_player");#d#
		1694
		1695	warn "resetting map ", $self->path;#d#
		1696
		1697	$self->in_memory (cf::MAP_SWAPPED);
		1698
		1699	# need to save uniques path
		1700	unless ($self->{deny_save}) {
		1701	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1702
		1703	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1704	if $uniq;
		1705	}
		1706
		1707	delete $cf::MAP{$self->path};
		1708
		1709	$self->clear;
		1710
		1711	$_->clear_links_to ($self) for values %cf::MAP;
		1712
		1713	$self->unlink_save;
		1714	$self->destroy;
		1715	}
		1716
		1717	my $nuke_counter = "aaaa";
		1718
		1719	sub nuke {
		1720	my ($self) = @_;
		1721
		1722	delete $cf::MAP{$self->path};
		1723
		1724	$self->unlink_save;
		1725
		1726	bless $self, "cf::map";
		1727	delete $self->{deny_reset};
		1728	$self->{deny_save} = 1;
		1729	$self->reset_timeout (1);
		1730	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		1731
		1732	$cf::MAP{$self->path} = $self;
		1733
		1734	$self->reset; # polite request, might not happen
		1735	}
		1736
		1737	=item cf::map::unique_maps
		1738
		1739	Returns an arrayref of paths of all shared maps that have
		1740	instantiated unique items. May block.
		1741
		1742	=cut
		1743
		1744	sub unique_maps() {
		1745	my $files = aio_readdir $UNIQUEDIR
		1746	or return;
		1747
		1748	my @paths;
		1749
		1750	for (@$files) {
		1751	utf8::decode $_;
		1752	next if /\.pst$/;
		1753	next unless /^$PATH_SEP/o;
		1754
		1755	push @paths, cf::map::normalise $_;
		1756	}
		1757
		1758	\@paths
		1759	}
		1760
		1761	package cf;
		1762
		1763	=back
		1764
		1765	=head3 cf::object
		1766
		1767	=cut
		1768
		1769	package cf::object;
869		1770
870	=over 4	1771	=over 4
871		1772
872	=item cf::player::exists $login	1773	=item $ob->inv_recursive
873		1774
874	Returns true when the given account exists.	1775	Returns the inventory of the object _and_ their inventories, recursively.
875		1776
876	=cut	1777	=cut
877		1778
878	sub cf::player::exists($) {	1779	sub inv_recursive_;
879	cf::player::find $_[0]	1780	sub inv_recursive_ {
880	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1781	map { $_, inv_recursive_ $_->inv } @_
881	}	1782	}
882		1783
883	=item $player->ext_reply ($msgid, $msgtype, %msg)	1784	sub inv_recursive {
884		1785	inv_recursive_ inv $_[0]
885	Sends an ext reply to the player.
886
887	=cut
888
889	sub cf::player::ext_reply($$$%) {
890	my ($self, $id, %msg) = @_;
891
892	$msg{msgid} = $id;
893
894	$self->send ("ext " . to_json \%msg);
895	}	1786	}
		1787
		1788	package cf;
896		1789
897	=back	1790	=back
898		1791
899	=head3 cf::object::player	1792	=head3 cf::object::player
900		1793
…		…
938	(ref $cf::CFG{"may_$access"}	1831	(ref $cf::CFG{"may_$access"}
939	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1832	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
940	: $cf::CFG{"may_$access"})	1833	: $cf::CFG{"may_$access"})
941	}	1834	}
942		1835
		1836	=item $player_object->enter_link
		1837
		1838	Freezes the player and moves him/her to a special map (C<{link}>).
		1839
		1840	The player should be reasonably safe there for short amounts of time. You
		1841	I<MUST> call C<leave_link> as soon as possible, though.
		1842
		1843	Will never block.
		1844
		1845	=item $player_object->leave_link ($map, $x, $y)
		1846
		1847	Moves the player out of the special C<{link}> map onto the specified
		1848	map. If the map is not valid (or omitted), the player will be moved back
		1849	to the location he/she was before the call to C<enter_link>, or, if that
		1850	fails, to the emergency map position.
		1851
		1852	Might block.
		1853
		1854	=cut
		1855
		1856	sub link_map {
		1857	unless ($LINK_MAP) {
		1858	$LINK_MAP = cf::map::find "{link}"
		1859	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		1860	$LINK_MAP->load;
		1861	}
		1862
		1863	$LINK_MAP
		1864	}
		1865
		1866	sub cf::object::player::enter_link {
		1867	my ($self) = @_;
		1868
		1869	$self->deactivate_recursive;
		1870
		1871	return if UNIVERSAL::isa $self->map, "ext::map_link";
		1872
		1873	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1874	if $self->map;
		1875
		1876	$self->enter_map ($LINK_MAP || link_map, 10, 10);
		1877	}
		1878
		1879	sub cf::object::player::leave_link {
		1880	my ($self, $map, $x, $y) = @_;
		1881
		1882	my $link_pos = delete $self->{_link_pos};
		1883
		1884	unless ($map) {
		1885	# restore original map position
		1886	($map, $x, $y) = @{ $link_pos || [] };
		1887	$map = cf::map::find $map;
		1888
		1889	unless ($map) {
		1890	($map, $x, $y) = @$EMERGENCY_POSITION;
		1891	$map = cf::map::find $map
		1892	or die "FATAL: cannot load emergency map\n";
		1893	}
		1894	}
		1895
		1896	($x, $y) = (-1, -1)
		1897	unless (defined $x) && (defined $y);
		1898
		1899	# use -1 or undef as default coordinates, not 0, 0
		1900	($x, $y) = ($map->enter_x, $map->enter_y)
		1901	if $x <=0 && $y <= 0;
		1902
		1903	$map->load;
		1904	$map->load_diag;
		1905
		1906	return unless $self->contr->active;
		1907	$self->activate_recursive;
		1908
		1909	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
		1910	$self->enter_map ($map, $x, $y);
		1911	}
		1912
		1913	cf::player->attach (
		1914	on_logout => sub {
		1915	my ($pl) = @_;
		1916
		1917	# abort map switching before logout
		1918	if ($pl->ob->{_link_pos}) {
		1919	cf::sync_job {
		1920	$pl->ob->leave_link
		1921	};
		1922	}
		1923	},
		1924	on_login => sub {
		1925	my ($pl) = @_;
		1926
		1927	# try to abort aborted map switching on player login :)
		1928	# should happen only on crashes
		1929	if ($pl->ob->{_link_pos}) {
		1930	$pl->ob->enter_link;
		1931	(async {
		1932	$pl->ob->reply (undef,
		1933	"There was an internal problem at your last logout, "
		1934	. "the server will try to bring you to your intended destination in a second.",
		1935	cf::NDI_RED);
		1936	# we need this sleep as the login has a concurrent enter_exit running
		1937	# and this sleep increases chances of the player not ending up in scorn
		1938	Coro::Timer::sleep 1;
		1939	$pl->ob->leave_link;
		1940	})->prio (2);
		1941	}
		1942	},
		1943	);
		1944
		1945	=item $player_object->goto ($path, $x, $y)
		1946
		1947	=cut
		1948
		1949	sub cf::object::player::goto {
		1950	my ($self, $path, $x, $y) = @_;
		1951
		1952	$self->enter_link;
		1953
		1954	(async {
		1955	my $map = eval {
		1956	my $map = cf::map::find $path;
		1957	$map = $map->customise_for ($self) if $map;
		1958	$map
		1959	} or
		1960	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1961
		1962	$self->leave_link ($map, $x, $y);
		1963	})->prio (1);
		1964	}
		1965
		1966	=item $player_object->enter_exit ($exit_object)
		1967
		1968	=cut
		1969
		1970	sub parse_random_map_params {
		1971	my ($spec) = @_;
		1972
		1973	my $rmp = { # defaults
		1974	xsize => (cf::rndm 15, 40),
		1975	ysize => (cf::rndm 15, 40),
		1976	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		1977	#layout => string,
		1978	};
		1979
		1980	for (split /\n/, $spec) {
		1981	my ($k, $v) = split /\s+/, $_, 2;
		1982
		1983	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1984	}
		1985
		1986	$rmp
		1987	}
		1988
		1989	sub prepare_random_map {
		1990	my ($exit) = @_;
		1991
		1992	my $guard = cf::lock_acquire "exit_prepare:$exit";
		1993
		1994	# all this does is basically replace the /! path by
		1995	# a new random map path (?random/...) with a seed
		1996	# that depends on the exit object
		1997
		1998	my $rmp = parse_random_map_params $exit->msg;
		1999
		2000	if ($exit->map) {
		2001	$rmp->{region} = $exit->region->name;
		2002	$rmp->{origin_map} = $exit->map->path;
		2003	$rmp->{origin_x} = $exit->x;
		2004	$rmp->{origin_y} = $exit->y;
		2005	}
		2006
		2007	$rmp->{random_seed} ||= $exit->random_seed;
		2008
		2009	my $data = cf::to_json $rmp;
		2010	my $md5 = Digest::MD5::md5_hex $data;
		2011	my $meta = "$RANDOMDIR/$md5.meta";
		2012
		2013	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		2014	aio_write $fh, 0, (length $data), $data, 0;
		2015	undef $fh;
		2016	aio_rename "$meta~", $meta;
		2017
		2018	$exit->slaying ("?random/$md5");
		2019	$exit->msg (undef);
		2020	}
		2021	}
		2022
		2023	sub cf::object::player::enter_exit {
		2024	my ($self, $exit) = @_;
		2025
		2026	return unless $self->type == cf::PLAYER;
		2027
		2028	if ($exit->slaying eq "/!") {
		2029	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2030	# the problem is that $exit might not survive long enough
		2031	# so it needs to be done right now, right here
		2032	cf::sync_job { prepare_random_map $exit };
		2033	}
		2034
		2035	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2036	my $hp = $exit->stats->hp;
		2037	my $sp = $exit->stats->sp;
		2038
		2039	$self->enter_link;
		2040
		2041	(async {
		2042	$self->deactivate_recursive; # just to be sure
		2043	unless (eval {
		2044	$self->goto ($slaying, $hp, $sp);
		2045
		2046	1;
		2047	}) {
		2048	$self->message ("Something went wrong deep within the crossfire server. "
		2049	. "I'll try to bring you back to the map you were before. "
		2050	. "Please report this to the dungeon master!",
		2051	cf::NDI_UNIQUE | cf::NDI_RED);
		2052
		2053	warn "ERROR in enter_exit: $@";
		2054	$self->leave_link;
		2055	}
		2056	})->prio (1);
		2057	}
		2058
943	=head3 cf::client	2059	=head3 cf::client
944		2060
945	=over 4	2061	=over 4
946		2062
947	=item $client->send_drawinfo ($text, $flags)	2063	=item $client->send_drawinfo ($text, $flags)
…		…
953		2069
954	sub cf::client::send_drawinfo {	2070	sub cf::client::send_drawinfo {
955	my ($self, $text, $flags) = @_;	2071	my ($self, $text, $flags) = @_;
956		2072
957	utf8::encode $text;	2073	utf8::encode $text;
958	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2074	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
959	}	2075	}
960		2076
		2077	=item $client->ext_event ($type, %msg)
		2078
		2079	Sends an exti event to the client.
		2080
		2081	=cut
		2082
		2083	sub cf::client::ext_event($$%) {
		2084	my ($self, $type, %msg) = @_;
		2085
		2086	$msg{msgtype} = "event_$type";
		2087	$self->send_packet ("ext " . cf::to_json \%msg);
		2088	}
961		2089
962	=item $success = $client->query ($flags, "text", \&cb)	2090	=item $success = $client->query ($flags, "text", \&cb)
963		2091
964	Queues a query to the client, calling the given callback with	2092	Queues a query to the client, calling the given callback with
965	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2093	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
…		…
990	on_reply => sub {	2118	on_reply => sub {
991	my ($ns, $msg) = @_;	2119	my ($ns, $msg) = @_;
992		2120
993	# this weird shuffling is so that direct followup queries	2121	# this weird shuffling is so that direct followup queries
994	# get handled first	2122	# get handled first
995	my $queue = delete $ns->{query_queue};	2123	my $queue = delete $ns->{query_queue}
		2124	or return; # be conservative, not sure how that can happen, but we saw a crash here
996		2125
997	(shift @$queue)->[1]->($msg);	2126	(shift @$queue)->[1]->($msg);
		2127	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
998		2128
999	push @{ $ns->{query_queue} }, @$queue;	2129	push @{ $ns->{query_queue} }, @$queue;
1000		2130
1001	if (@{ $ns->{query_queue} } == @$queue) {	2131	if (@{ $ns->{query_queue} } == @$queue) {
1002	if (@$queue) {	2132	if (@$queue) {
…		…
1006	}	2136	}
1007	}	2137	}
1008	},	2138	},
1009	);	2139	);
1010		2140
1011	=item $client->coro (\&cb)	2141	=item $client->async (\&cb)
1012		2142
1013	Create a new coroutine, running the specified callback. The coroutine will	2143	Create a new coroutine, running the specified callback. The coroutine will
1014	be automatically cancelled when the client gets destroyed (e.g. on logout,	2144	be automatically cancelled when the client gets destroyed (e.g. on logout,
1015	or loss of connection).	2145	or loss of connection).
1016		2146
1017	=cut	2147	=cut
1018		2148
1019	sub cf::client::coro {	2149	sub cf::client::async {
1020	my ($self, $cb) = @_;	2150	my ($self, $cb) = @_;
1021		2151
1022	my $coro; $coro = async {	2152	my $coro = &Coro::async ($cb);
1023	eval {
1024	$cb->();
1025	};
1026	warn $@ if $@;
1027	};
1028		2153
1029	$coro->on_destroy (sub {	2154	$coro->on_destroy (sub {
1030	delete $self->{_coro}{$coro+0};	2155	delete $self->{_coro}{$coro+0};
1031	});	2156	});
1032		2157
…		…
1065		2190
1066	# here we export the classes and methods available to script code	2191	# here we export the classes and methods available to script code
1067		2192
1068	=pod	2193	=pod
1069		2194
1070	The following fucntions and emthods are available within a safe environment:	2195	The following functions and methods are available within a safe environment:
1071		2196
1072	cf::object contr pay_amount pay_player map	2197	cf::object contr pay_amount pay_player map
1073	cf::object::player player	2198	cf::object::player player
1074	cf::player peaceful	2199	cf::player peaceful
1075	cf::map trigger	2200	cf::map trigger
…		…
1160	#############################################################################	2285	#############################################################################
1161		2286
1162	=head2 EXTENSION DATABASE SUPPORT	2287	=head2 EXTENSION DATABASE SUPPORT
1163		2288
1164	Crossfire maintains a very simple database for extension use. It can	2289	Crossfire maintains a very simple database for extension use. It can
1165	currently store anything that can be serialised using Storable, which	2290	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
1166	excludes objects.	2291	convert to/from binary).
1167		2292
1168	The parameter C<$family> should best start with the name of the extension	2293	The parameter C<$family> should best start with the name of the extension
1169	using it, it should be unique.	2294	using it, it should be unique.
1170		2295
1171	=over 4	2296	=over 4
1172		2297
1173	=item $hashref = cf::db_get $family
1174
1175	Return a hashref for use by the extension C<$family>, which can be
1176	modified. After modifications, you have to call C<cf::db_dirty> or
1177	C<cf::db_sync>.
1178
1179	=item $value = cf::db_get $family => $key	2298	=item $value = cf::db_get $family => $key
1180		2299
1181	Returns a single value from the database	2300	Returns a single value from the database.
1182
1183	=item cf::db_put $family => $hashref
1184
1185	Stores the given family hashref into the database. Updates are delayed, if
1186	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1187		2301
1188	=item cf::db_put $family => $key => $value	2302	=item cf::db_put $family => $key => $value
1189		2303
1190	Stores the given C<$value> in the family hash. Updates are delayed, if you	2304	Stores the given C<$value> in the family.
1191	want the data to be synced to disk immediately, use C<cf::db_sync>.
1192
1193	=item cf::db_dirty
1194
1195	Marks the database as dirty, to be updated at a later time.
1196
1197	=item cf::db_sync
1198
1199	Immediately write the database to disk I<if it is dirty>.
1200		2305
1201	=cut	2306	=cut
1202		2307
1203	our $DB;	2308	our $DB;
1204		2309
1205	{	2310	sub db_init {
1206	my $path = cf::localdir . "/database.pst";	2311	unless ($DB) {
		2312	$DB = BDB::db_create $DB_ENV;
1207		2313
1208	sub db_load() {	2314	cf::sync_job {
1209	warn "loading database $path\n";#d# remove later	2315	eval {
1210	$DB = stat $path ? Storable::retrieve $path : { };	2316	$DB->set_flags (BDB::CHKSUM);
1211	}
1212		2317
1213	my $pid;	2318	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
1214		2319	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
1215	sub db_save() {	2320	cf::cleanup "db_open(db): $!" if $!;
1216	warn "saving database $path\n";#d# remove later	2321	};
1217	waitpid $pid, 0 if $pid;	2322	cf::cleanup "db_open(db): $@" if $@;
1218	if (0 == ($pid = fork)) {
1219	$DB->{_meta}{version} = 1;
1220	Storable::nstore $DB, "$path~";
1221	rename "$path~", $path;
1222	cf::_exit 0 if defined $pid;
1223	}	2323	};
1224	}
1225
1226	my $dirty;
1227
1228	sub db_sync() {
1229	db_save if $dirty;
1230	undef $dirty;
1231	}
1232
1233	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1234	db_sync;
1235	});	2324	}
		2325	}
1236		2326
1237	sub db_dirty() {
1238	$dirty = 1;
1239	$idle->start;
1240	}
1241
1242	sub db_get($;$) {	2327	sub db_get($$) {
1243	@_ >= 2	2328	my $key = "$_[0]/$_[1]";
1244	? $DB->{$_[0]}{$_[1]}
1245	: ($DB->{$_[0]} ||= { })
1246	}
1247		2329
		2330	cf::sync_job {
		2331	BDB::db_get $DB, undef, $key, my $data;
		2332
		2333	$! ? ()
		2334	: $data
		2335	}
		2336	}
		2337
1248	sub db_put($$;$) {	2338	sub db_put($$$) {
1249	if (@_ >= 3) {	2339	BDB::dbreq_pri 4;
1250	$DB->{$_[0]}{$_[1]} = $_[2];	2340	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
1251	} else {	2341	}
1252	$DB->{$_[0]} = $_[1];
1253	}
1254	db_dirty;
1255	}
1256		2342
1257	cf::global->attach (	2343	=item cf::cache $id => [$paths...], $processversion => $process
1258	prio => 10000,	2344
1259	on_cleanup => sub {	2345	Generic caching function that returns the value of the resource $id,
1260	db_sync;	2346	caching and regenerating as required.
		2347
		2348	This function can block.
		2349
		2350	=cut
		2351
		2352	sub cache {
		2353	my ($id, $src, $processversion, $process) = @_;
		2354
		2355	my $meta =
		2356	join "\x00",
		2357	$processversion,
		2358	map {
		2359	aio_stat $_
		2360	and Carp::croak "$_: $!";
		2361
		2362	($_, (stat _)[7,9])
		2363	} @$src;
		2364
		2365	my $dbmeta = db_get cache => "$id/meta";
		2366	if ($dbmeta ne $meta) {
		2367	# changed, we may need to process
		2368
		2369	my @data;
		2370	my $md5;
		2371
		2372	for (0 .. $#$src) {
		2373	0 <= aio_load $src->[$_], $data[$_]
		2374	or Carp::croak "$src->[$_]: $!";
1261	},	2375	}
1262	);	2376
		2377	# if processing is expensive, check
		2378	# checksum first
		2379	if (1) {
		2380	$md5 =
		2381	join "\x00",
		2382	$processversion,
		2383	map {
		2384	Coro::cede;
		2385	($src->[$_], Digest::MD5::md5_hex $data[$_])
		2386	} 0.. $#$src;
		2387
		2388
		2389	my $dbmd5 = db_get cache => "$id/md5";
		2390	if ($dbmd5 eq $md5) {
		2391	db_put cache => "$id/meta", $meta;
		2392
		2393	return db_get cache => "$id/data";
		2394	}
		2395	}
		2396
		2397	my $t1 = Time::HiRes::time;
		2398	my $data = $process->(\@data);
		2399	my $t2 = Time::HiRes::time;
		2400
		2401	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		2402
		2403	db_put cache => "$id/data", $data;
		2404	db_put cache => "$id/md5" , $md5;
		2405	db_put cache => "$id/meta", $meta;
		2406
		2407	return $data;
		2408	}
		2409
		2410	db_get cache => "$id/data"
1263	}	2411	}
		2412
		2413	=item fork_call { }, $args
		2414
		2415	Executes the given code block with the given arguments in a seperate
		2416	process, returning the results. Everything must be serialisable with
		2417	Coro::Storable. May, of course, block. Note that the executed sub may
		2418	never block itself or use any form of Event handling.
		2419
		2420	=cut
		2421
		2422	sub fork_call(&@) {
		2423	my ($cb, @args) = @_;
		2424
		2425	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
		2426	# or die "socketpair: $!";
		2427	pipe my $fh1, my $fh2
		2428	or die "pipe: $!";
		2429
		2430	if (my $pid = fork) {
		2431	close $fh2;
		2432
		2433	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
		2434	$res = Coro::Storable::thaw $res;
		2435
		2436	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		2437
		2438	die $$res unless "ARRAY" eq ref $res;
		2439
		2440	return wantarray ? @$res : $res->[-1];
		2441	} else {
		2442	local $SIG{__WARN__};
		2443	eval {
		2444	local $SIG{__DIE__};
		2445	close $fh1;
		2446
		2447	my @res = eval { $cb->(@args) };
		2448	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
		2449	};
		2450
		2451	warn $@ if $@;
		2452	_exit 0;
		2453	}
		2454	}
		2455
		2456
1264		2457
1265	#############################################################################	2458	#############################################################################
1266	# the server's main()	2459	# the server's init and main functions
		2460
		2461	sub load_facedata($) {
		2462	my ($path) = @_;
		2463
		2464	warn "loading facedata from $path\n";
		2465
		2466	my $facedata;
		2467	0 < aio_load $path, $facedata
		2468	or die "$path: $!";
		2469
		2470	$facedata = Coro::Storable::thaw $facedata;
		2471
		2472	$facedata->{version} == 2
		2473	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2474
		2475	{
		2476	my $faces = $facedata->{faceinfo};
		2477
		2478	while (my ($face, $info) = each %$faces) {
		2479	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2480	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
		2481	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2482	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2483	Coro::cede;
		2484	}
		2485
		2486	while (my ($face, $info) = each %$faces) {
		2487	next unless $info->{smooth};
		2488	my $idx = cf::face::find $face
		2489	or next;
		2490	if (my $smooth = cf::face::find $info->{smooth}) {
		2491	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2492	} else {
		2493	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2494	}
		2495	Coro::cede;
		2496	}
		2497	}
		2498
		2499	{
		2500	my $anims = $facedata->{animinfo};
		2501
		2502	while (my ($anim, $info) = each %$anims) {
		2503	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2504	Coro::cede;
		2505	}
		2506
		2507	cf::anim::invalidate_all; # d'oh
		2508	}
		2509
		2510	1
		2511	}
		2512
		2513	sub reload_regions {
		2514	load_resource_file "$MAPDIR/regions"
		2515	or die "unable to load regions file\n";
		2516	}
		2517
		2518	sub reload_facedata {
		2519	load_facedata "$DATADIR/facedata"
		2520	or die "unable to load facedata\n";
		2521	}
		2522
		2523	sub reload_archetypes {
		2524	load_resource_file "$DATADIR/archetypes"
		2525	or die "unable to load archetypes\n";
		2526	}
		2527
		2528	sub reload_treasures {
		2529	load_resource_file "$DATADIR/treasures"
		2530	or die "unable to load treasurelists\n";
		2531	}
		2532
		2533	sub reload_resources {
		2534	warn "reloading resource files...\n";
		2535
		2536	reload_regions;
		2537	reload_facedata;
		2538	reload_archetypes;
		2539	reload_treasures;
		2540
		2541	warn "finished reloading resource files\n";
		2542	}
		2543
		2544	sub init {
		2545	reload_resources;
		2546	}
1267		2547
1268	sub cfg_load {	2548	sub cfg_load {
1269	open my $fh, "<:utf8", cf::confdir . "/config"	2549	open my $fh, "<:utf8", "$CONFDIR/config"
1270	or return;	2550	or return;
1271		2551
1272	local $/;	2552	local $/;
1273	*CFG = YAML::Syck::Load <$fh>;	2553	*CFG = YAML::Syck::Load <$fh>;
		2554
		2555	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2556
		2557	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2558	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2559
		2560	if (exists $CFG{mlockall}) {
		2561	eval {
		2562	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2563	and die "WARNING: m(un)lockall failed: $!\n";
		2564	};
		2565	warn $@ if $@;
		2566	}
1274	}	2567	}
1275		2568
1276	sub main {	2569	sub main {
		2570	# we must not ever block the main coroutine
		2571	local $Coro::idle = sub {
		2572	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2573	(async {
		2574	Event::one_event;
		2575	})->prio (Coro::PRIO_MAX);
		2576	};
		2577
1277	cfg_load;	2578	cfg_load;
1278	db_load;	2579	db_init;
1279	load_extensions;	2580	load_extensions;
		2581
		2582	$TICK_WATCHER->start;
1280	Event::loop;	2583	Event::loop;
1281	}	2584	}
1282		2585
1283	#############################################################################	2586	#############################################################################
1284	# initialisation	2587	# initialisation and cleanup
1285		2588
1286	sub perl_reload() {	2589	# install some emergency cleanup handlers
		2590	BEGIN {
		2591	for my $signal (qw(INT HUP TERM)) {
		2592	Event->signal (
		2593	reentrant => 0,
		2594	data => WF_AUTOCANCEL,
		2595	signal => $signal,
		2596	prio => 0,
		2597	cb => sub {
		2598	cf::cleanup "SIG$signal";
		2599	},
		2600	);
		2601	}
		2602	}
		2603
		2604	sub emergency_save() {
		2605	my $freeze_guard = cf::freeze_mainloop;
		2606
		2607	warn "enter emergency perl save\n";
		2608
		2609	cf::sync_job {
		2610	# use a peculiar iteration method to avoid tripping on perl
		2611	# refcount bugs in for. also avoids problems with players
		2612	# and maps saved/destroyed asynchronously.
		2613	warn "begin emergency player save\n";
		2614	for my $login (keys %cf::PLAYER) {
		2615	my $pl = $cf::PLAYER{$login} or next;
		2616	$pl->valid or next;
		2617	$pl->save;
		2618	}
		2619	warn "end emergency player save\n";
		2620
		2621	warn "begin emergency map save\n";
		2622	for my $path (keys %cf::MAP) {
		2623	my $map = $cf::MAP{$path} or next;
		2624	$map->valid or next;
		2625	$map->save;
		2626	}
		2627	warn "end emergency map save\n";
		2628
		2629	warn "begin emergency database checkpoint\n";
		2630	BDB::db_env_txn_checkpoint $DB_ENV;
		2631	warn "end emergency database checkpoint\n";
		2632	};
		2633
		2634	warn "leave emergency perl save\n";
		2635	}
		2636
		2637	sub post_cleanup {
		2638	my ($make_core) = @_;
		2639
		2640	warn Carp::longmess "post_cleanup backtrace"
		2641	if $make_core;
		2642	}
		2643
		2644	sub do_reload_perl() {
1287	# can/must only be called in main	2645	# can/must only be called in main
1288	if ($Coro::current != $Coro::main) {	2646	if ($Coro::current != $Coro::main) {
1289	warn "can only reload from main coroutine\n";	2647	warn "can only reload from main coroutine";
1290	return;	2648	return;
1291	}	2649	}
1292		2650
1293	warn "reloading...";	2651	warn "reloading...";
1294		2652
1295	local $FREEZE = 1;	2653	warn "entering sync_job";
		2654
		2655	cf::sync_job {
		2656	cf::write_runtime; # external watchdog should not bark
1296	cf::emergency_save;	2657	cf::emergency_save;
		2658	cf::write_runtime; # external watchdog should not bark
1297		2659
1298	eval {	2660	warn "syncing database to disk";
		2661	BDB::db_env_txn_checkpoint $DB_ENV;
		2662
1299	# if anything goes wrong in here, we should simply crash as we already saved	2663	# if anything goes wrong in here, we should simply crash as we already saved
1300		2664
1301	# cancel all watchers	2665	warn "cancelling all WF_AUTOCANCEL watchers";
1302	for (Event::all_watchers) {	2666	for (Event::all_watchers) {
1303	$_->cancel if $_->data & WF_AUTOCANCEL;	2667	$_->cancel if $_->data & WF_AUTOCANCEL;
1304	}	2668	}
1305		2669
		2670	warn "flushing outstanding aio requests";
		2671	for (;;) {
		2672	BDB::flush;
		2673	IO::AIO::flush;
		2674	Coro::cede;
		2675	last unless IO::AIO::nreqs || BDB::nreqs;
		2676	warn "iterate...";
		2677	}
		2678
		2679	++$RELOAD;
		2680
1306	# cancel all extension coros	2681	warn "cancelling all extension coros";
1307	$_->cancel for values %EXT_CORO;	2682	$_->cancel for values %EXT_CORO;
1308	%EXT_CORO = ();	2683	%EXT_CORO = ();
1309		2684
1310	# unload all extensions	2685	warn "removing commands";
1311	for (@exts) {	2686	%COMMAND = ();
		2687
		2688	warn "removing ext commands";
		2689	%EXTCMD = ();
		2690
		2691	warn "unloading/nuking all extensions";
		2692	for my $pkg (@EXTS) {
1312	warn "unloading <$_>";	2693	warn "... unloading $pkg";
1313	unload_extension $_;	2694
		2695	if (my $cb = $pkg->can ("unload")) {
		2696	eval {
		2697	$cb->($pkg);
		2698	1
		2699	} or warn "$pkg unloaded, but with errors: $@";
1314	}	2700	}
1315		2701
		2702	warn "... nuking $pkg";
		2703	Symbol::delete_package $pkg;
		2704	}
		2705
1316	# unload all modules loaded from $LIBDIR	2706	warn "unloading all perl modules loaded from $LIBDIR";
1317	while (my ($k, $v) = each %INC) {	2707	while (my ($k, $v) = each %INC) {
1318	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2708	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1319		2709
1320	warn "removing <$k>";	2710	warn "... unloading $k";
1321	delete $INC{$k};	2711	delete $INC{$k};
1322		2712
1323	$k =~ s/\.pm$//;	2713	$k =~ s/\.pm$//;
1324	$k =~ s/\//::/g;	2714	$k =~ s/\//::/g;
1325		2715
…		…
1328	}	2718	}
1329		2719
1330	Symbol::delete_package $k;	2720	Symbol::delete_package $k;
1331	}	2721	}
1332		2722
1333	# sync database to disk
1334	cf::db_sync;
1335	IO::AIO::flush;
1336
1337	# get rid of safe::, as good as possible	2723	warn "getting rid of safe::, as good as possible";
1338	Symbol::delete_package "safe::$_"	2724	Symbol::delete_package "safe::$_"
1339	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2725	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1340		2726
1341	# remove register_script_function callbacks
1342	# TODO
1343
1344	# unload cf.pm "a bit"	2727	warn "unloading cf.pm \"a bit\"";
1345	delete $INC{"cf.pm"};	2728	delete $INC{"cf.pm"};
		2729	delete $INC{"cf/pod.pm"};
1346		2730
1347	# don't, removes xs symbols, too,	2731	# don't, removes xs symbols, too,
1348	# and global variables created in xs	2732	# and global variables created in xs
1349	#Symbol::delete_package __PACKAGE__;	2733	#Symbol::delete_package __PACKAGE__;
1350		2734
1351	# reload cf.pm	2735	warn "unload completed, starting to reload now";
		2736
1352	warn "reloading cf.pm";	2737	warn "reloading cf.pm";
1353	require cf;	2738	require cf;
1354	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	2739	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1355		2740
1356	# load config and database again	2741	warn "loading config and database again";
1357	cf::cfg_load;	2742	cf::cfg_load;
1358	cf::db_load;
1359		2743
1360	# load extensions
1361	warn "load extensions";	2744	warn "loading extensions";
1362	cf::load_extensions;	2745	cf::load_extensions;
1363		2746
1364	# reattach attachments to objects	2747	warn "reattaching attachments to objects/players";
1365	warn "reattach";	2748	_global_reattach; # objects, sockets
1366	_global_reattach;	2749	warn "reattaching attachments to maps";
1367	};	2750	reattach $_ for values %MAP;
		2751	warn "reattaching attachments to players";
		2752	reattach $_ for values %PLAYER;
1368		2753
1369	if ($@) {	2754	warn "leaving sync_job";
		2755
		2756	1
		2757	} or do {
1370	warn $@;	2758	warn $@;
1371	warn "error while reloading, exiting.";	2759	warn "error while reloading, exiting.";
1372	exit 1;	2760	exit 1;
1373	}	2761	};
1374		2762
1375	warn "reloaded successfully";	2763	warn "reloaded";
1376	};	2764	};
1377		2765
1378	register "<global>", __PACKAGE__;	2766	our $RELOAD_WATCHER; # used only during reload
1379		2767
		2768	sub reload_perl() {
		2769	# doing reload synchronously and two reloads happen back-to-back,
		2770	# coro crashes during coro_state_free->destroy here.
		2771
		2772	$RELOAD_WATCHER ||= Event->timer (
		2773	reentrant => 0,
		2774	after => 0,
		2775	data => WF_AUTOCANCEL,
		2776	cb => sub {
		2777	do_reload_perl;
		2778	undef $RELOAD_WATCHER;
		2779	},
		2780	);
		2781	}
		2782
1380	register_command "perl-reload" => sub {	2783	register_command "reload" => sub {
1381	my ($who, $arg) = @_;	2784	my ($who, $arg) = @_;
1382		2785
1383	if ($who->flag (FLAG_WIZ)) {	2786	if ($who->flag (FLAG_WIZ)) {
1384	$who->message ("start of reload.");
1385	perl_reload;
1386	$who->message ("end of reload.");	2787	$who->message ("reloading server.");
		2788	async { reload_perl };
1387	}	2789	}
1388	};	2790	};
1389		2791
1390	unshift @INC, $LIBDIR;	2792	unshift @INC, $LIBDIR;
		2793
		2794	my $bug_warning = 0;
		2795
		2796	our @WAIT_FOR_TICK;
		2797	our @WAIT_FOR_TICK_BEGIN;
		2798
		2799	sub wait_for_tick {
		2800	return unless $TICK_WATCHER->is_active;
		2801	return if $Coro::current == $Coro::main;
		2802
		2803	my $signal = new Coro::Signal;
		2804	push @WAIT_FOR_TICK, $signal;
		2805	$signal->wait;
		2806	}
		2807
		2808	sub wait_for_tick_begin {
		2809	return unless $TICK_WATCHER->is_active;
		2810	return if $Coro::current == $Coro::main;
		2811
		2812	my $signal = new Coro::Signal;
		2813	push @WAIT_FOR_TICK_BEGIN, $signal;
		2814	$signal->wait;
		2815	}
1391		2816
1392	$TICK_WATCHER = Event->timer (	2817	$TICK_WATCHER = Event->timer (
1393	reentrant => 0,	2818	reentrant => 0,
		2819	parked => 1,
1394	prio => 0,	2820	prio => 0,
1395	at => $NEXT_TICK || $TICK,	2821	at => $NEXT_TICK || $TICK,
1396	data => WF_AUTOCANCEL,	2822	data => WF_AUTOCANCEL,
1397	cb => sub {	2823	cb => sub {
1398	unless ($FREEZE) {	2824	if ($Coro::current != $Coro::main) {
		2825	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		2826	unless ++$bug_warning > 10;
		2827	return;
		2828	}
		2829
		2830	$NOW = Event::time;
		2831
1399	cf::server_tick; # one server iteration	2832	cf::server_tick; # one server iteration
		2833
1400	$RUNTIME += $TICK;	2834	$RUNTIME += $TICK;
1401	}
1402
1403	$NEXT_TICK += $TICK;	2835	$NEXT_TICK += $TICK;
		2836
		2837	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		2838	$NEXT_RUNTIME_WRITE = $NOW + 10;
		2839	Coro::async_pool {
		2840	write_runtime
		2841	or warn "ERROR: unable to write runtime file: $!";
		2842	};
		2843	}
		2844
		2845	# my $AFTER = Event::time;
		2846	# warn $AFTER - $NOW;#d#
1404		2847
1405	# if we are delayed by four ticks or more, skip them all	2848	# if we are delayed by four ticks or more, skip them all
1406	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	2849	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1407		2850
1408	$TICK_WATCHER->at ($NEXT_TICK);	2851	$TICK_WATCHER->at ($NEXT_TICK);
1409	$TICK_WATCHER->start;	2852	$TICK_WATCHER->start;
		2853
		2854	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		2855	$sig->send;
		2856	}
		2857	while (my $sig = shift @WAIT_FOR_TICK) {
		2858	$sig->send;
		2859	}
		2860
		2861	_post_tick;
1410	},	2862	},
1411	);	2863	);
1412		2864
		2865	{
		2866	BDB::max_poll_time $TICK * 0.1;
		2867	$BDB_POLL_WATCHER = Event->io (
		2868	reentrant => 0,
		2869	fd => BDB::poll_fileno,
		2870	poll => 'r',
		2871	prio => 0,
		2872	data => WF_AUTOCANCEL,
		2873	cb => \&BDB::poll_cb,
		2874	);
		2875	BDB::min_parallel 8;
		2876
		2877	BDB::set_sync_prepare {
		2878	my $status;
		2879	my $current = $Coro::current;
		2880	(
		2881	sub {
		2882	$status = $!;
		2883	$current->ready; undef $current;
		2884	},
		2885	sub {
		2886	Coro::schedule while defined $current;
		2887	$! = $status;
		2888	},
		2889	)
		2890	};
		2891
		2892	unless ($DB_ENV) {
		2893	$DB_ENV = BDB::db_env_create;
		2894
		2895	cf::sync_job {
		2896	eval {
		2897	BDB::db_env_open
		2898	$DB_ENV,
		2899	$BDBDIR,
		2900	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		2901	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		2902	0666;
		2903
		2904	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		2905
		2906	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		2907	$DB_ENV->set_lk_detect;
		2908	};
		2909
		2910	cf::cleanup "db_env_open(db): $@" if $@;
		2911	};
		2912	}
		2913	}
		2914
		2915	{
		2916	IO::AIO::min_parallel 8;
		2917
		2918	undef $Coro::AIO::WATCHER;
1413	IO::AIO::max_poll_time $TICK * 0.2;	2919	IO::AIO::max_poll_time $TICK * 0.1;
1414		2920	$AIO_POLL_WATCHER = Event->io (
1415	Event->io (fd => IO::AIO::poll_fileno,	2921	reentrant => 0,
1416	poll => 'r',
1417	prio => 5,
1418	data => WF_AUTOCANCEL,	2922	data => WF_AUTOCANCEL,
		2923	fd => IO::AIO::poll_fileno,
		2924	poll => 'r',
		2925	prio => 6,
1419	cb => \&IO::AIO::poll_cb);	2926	cb => \&IO::AIO::poll_cb,
		2927	);
		2928	}
1420		2929
1421	# we must not ever block the main coroutine	2930	# load additional modules
1422	$Coro::idle = sub {	2931	use cf::pod;
1423	#Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#	2932
1424	warn "FATAL: Coro::idle was called, major BUG\n";	2933	END { cf::emergency_save }
1425	(Coro::unblock_sub {
1426	Event::one_event;
1427	})->();
1428	};
1429		2934
1430	1	2935	1
1431		2936

Diff Legend

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