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.135 by root, Thu Jan 4 20:29:46 2007 UTC vs.
Revision 1.220 by root, Sat Feb 17 23:54:35 2007 UTC

…		…
8	use Storable;	8	use Storable;
9	use Opcode;	9	use Opcode;
10	use Safe;	10	use Safe;
11	use Safe::Hole;	11	use Safe::Hole;
12		12
13	use Coro 3.3 ();	13	use Coro 3.5 ();
14	use Coro::Event;	14	use Coro::Event;
15	use Coro::Timer;	15	use Coro::Timer;
16	use Coro::Signal;	16	use Coro::Signal;
17	use Coro::Semaphore;	17	use Coro::Semaphore;
18	use Coro::AIO;	18	use Coro::AIO;
19		19
		20	use BDB ();
		21	use Data::Dumper;
20	use Digest::MD5;	22	use Digest::MD5;
21	use Fcntl;	23	use Fcntl;
22	use IO::AIO 2.31 ();	24	use IO::AIO 2.32 ();
23	use YAML::Syck ();	25	use YAML::Syck ();
24	use Time::HiRes;	26	use Time::HiRes;
		27	use Compress::LZF;
		28
		29	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
25		30
26	use Event; $Event::Eval = 1; # no idea why this is required, but it is	31	use Event; $Event::Eval = 1; # no idea why this is required, but it is
		32
		33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
27		34
28	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	35	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
29	$YAML::Syck::ImplicitUnicode = 1;	36	$YAML::Syck::ImplicitUnicode = 1;
30		37
31	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority	38	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
32
33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34		39
35	our %COMMAND = ();	40	our %COMMAND = ();
36	our %COMMAND_TIME = ();	41	our %COMMAND_TIME = ();
		42
		43	our @EXTS = (); # list of extension package names
37	our %EXTCMD = ();	44	our %EXTCMD = ();
		45	our %EXT_CORO = (); # coroutines bound to extensions
		46	our %EXT_MAP = (); # pluggable maps
38		47
39	our @EVENT;	48	our @EVENT;
40	our $LIBDIR = datadir . "/ext";	49	our $LIBDIR = datadir . "/ext";
41		50
42	our $TICK = MAX_TIME * 1e-6;	51	our $TICK = MAX_TIME * 1e-6;
43	our $TICK_WATCHER;	52	our $TICK_WATCHER;
		53	our $AIO_POLL_WATCHER;
		54	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44	our $NEXT_TICK;	55	our $NEXT_TICK;
45	our $NOW;	56	our $NOW;
		57	our $USE_FSYNC = 1; # use fsync to write maps - default off
		58
		59	our $BDB_POLL_WATCHER;
		60	our $DB_ENV;
46		61
47	our %CFG;	62	our %CFG;
48		63
49	our $UPTIME; $UPTIME ||= time;	64	our $UPTIME; $UPTIME ||= time;
50	our $RUNTIME;	65	our $RUNTIME;
51		66
		67	our %PLAYER; # all users
52	our %MAP; # all maps	68	our %MAP; # all maps
53	our $LINK_MAP; # the special {link} map	69	our $LINK_MAP; # the special {link} map, which is always available
54	our $RANDOM_MAPS = cf::localdir . "/random";	70	our $RANDOM_MAPS = cf::localdir . "/random";
55	our %EXT_CORO;	71	our $BDB_ENV_DIR = cf::localdir . "/db";
		72
		73	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
		74	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
		75
		76	# used to convert map paths into valid unix filenames by replacing / by ∕
		77	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
56		78
57	binmode STDOUT;	79	binmode STDOUT;
58	binmode STDERR;	80	binmode STDERR;
59		81
60	# read virtual server time, if available	82	# read virtual server time, if available
…		…
67	mkdir cf::localdir;	89	mkdir cf::localdir;
68	mkdir cf::localdir . "/" . cf::playerdir;	90	mkdir cf::localdir . "/" . cf::playerdir;
69	mkdir cf::localdir . "/" . cf::tmpdir;	91	mkdir cf::localdir . "/" . cf::tmpdir;
70	mkdir cf::localdir . "/" . cf::uniquedir;	92	mkdir cf::localdir . "/" . cf::uniquedir;
71	mkdir $RANDOM_MAPS;	93	mkdir $RANDOM_MAPS;
		94	mkdir $BDB_ENV_DIR;
72		95
73	# a special map that is always available
74	our $LINK_MAP;
75	our $EMERGENCY_POSITION;	96	our $EMERGENCY_POSITION;
		97
		98	sub cf::map::normalise;
76		99
77	#############################################################################	100	#############################################################################
78		101
79	=head2 GLOBAL VARIABLES	102	=head2 GLOBAL VARIABLES
80		103
…		…
104		127
105	=item %cf::CFG	128	=item %cf::CFG
106		129
107	Configuration for the server, loaded from C</etc/crossfire/config>, or	130	Configuration for the server, loaded from C</etc/crossfire/config>, or
108	from wherever your confdir points to.	131	from wherever your confdir points to.
		132
		133	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
		134
		135	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
		136	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
		137	processing has been done. Call C<< ->wait >> on them to maximise the
		138	window of cpu time available, or simply to synchronise to the server tick.
109		139
110	=back	140	=back
111		141
112	=cut	142	=cut
113		143
…		…
117	utf8::encode $msg;	147	utf8::encode $msg;
118		148
119	$msg .= "\n"	149	$msg .= "\n"
120	unless $msg =~ /\n$/;	150	unless $msg =~ /\n$/;
121		151
122	LOG llevError, "cfperl: $msg";	152	LOG llevError, $msg;
123	};	153	};
124	}	154	}
125		155
126	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	156	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
127	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	157	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
…		…
145		175
146	$Event::DIED = sub {	176	$Event::DIED = sub {
147	warn "error in event callback: @_";	177	warn "error in event callback: @_";
148	};	178	};
149		179
150	my %ext_pkg;
151	my @exts;
152	my @hook;
153
154	=head2 UTILITY FUNCTIONS	180	=head2 UTILITY FUNCTIONS
155		181
156	=over 4	182	=over 4
157		183
		184	=item dumpval $ref
		185
158	=cut	186	=cut
		187
		188	sub dumpval {
		189	eval {
		190	local $SIG{__DIE__};
		191	my $d;
		192	if (1) {
		193	$d = new Data::Dumper([$_[0]], ["*var"]);
		194	$d->Terse(1);
		195	$d->Indent(2);
		196	$d->Quotekeys(0);
		197	$d->Useqq(1);
		198	#$d->Bless(...);
		199	$d->Seen($_[1]) if @_ > 1;
		200	$d = $d->Dump();
		201	}
		202	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		203	$d
		204	} || "[unable to dump $_[0]: '$@']";
		205	}
159		206
160	use JSON::Syck (); # TODO# replace by JSON::PC once working	207	use JSON::Syck (); # TODO# replace by JSON::PC once working
161		208
162	=item $ref = cf::from_json $json	209	=item $ref = cf::from_json $json
163		210
…		…
221	# wake up all waiters, to be on the safe side	268	# wake up all waiters, to be on the safe side
222	$_->ready for @{ delete $LOCK{$key} };	269	$_->ready for @{ delete $LOCK{$key} };
223	}	270	}
224	}	271	}
225		272
226	=item cf::async { BLOCK }
227
228	Like C<Coro::async>, but runs the given BLOCK in an eval and only logs the
229	error instead of exiting the server in case of a problem.
230
231	=cut
232
233	sub async(&) {
234	my ($cb) = @_;
235
236	Coro::async {
237	eval { $cb->() };
238	warn $@ if $@;
239	}
240	}
241
242	sub freeze_mainloop {	273	sub freeze_mainloop {
243	return unless $TICK_WATCHER->is_active;	274	return unless $TICK_WATCHER->is_active;
244		275
245	my $guard = Coro::guard { $TICK_WATCHER->start };	276	my $guard = Coro::guard {
		277	$TICK_WATCHER->start;
		278	};
246	$TICK_WATCHER->stop;	279	$TICK_WATCHER->stop;
247	$guard	280	$guard
248	}	281	}
		282
		283	=item cf::async { BLOCK }
		284
		285	Currently the same as Coro::async_pool, meaning you cannot use
		286	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		287	thing you are allowed to do is call C<prio> on it.
		288
		289	=cut
		290
		291	BEGIN { *async = \&Coro::async_pool }
249		292
250	=item cf::sync_job { BLOCK }	293	=item cf::sync_job { BLOCK }
251		294
252	The design of crossfire+ requires that the main coro ($Coro::main) is	295	The design of crossfire+ requires that the main coro ($Coro::main) is
253	always able to handle events or runnable, as crossfire+ is only partly	296	always able to handle events or runnable, as crossfire+ is only partly
…		…
272	my $freeze_guard = freeze_mainloop;	315	my $freeze_guard = freeze_mainloop;
273		316
274	my $busy = 1;	317	my $busy = 1;
275	my @res;	318	my @res;
276		319
277	(Coro::async {	320	(async {
278	@res = eval { $job->() };	321	@res = eval { $job->() };
279	warn $@ if $@;	322	warn $@ if $@;
280	undef $busy;	323	undef $busy;
281	})->prio (Coro::PRIO_MAX);	324	})->prio (Coro::PRIO_MAX);
282		325
283	while ($busy) {	326	while ($busy) {
284	Coro::cede_notself;	327	Coro::cede or Event::one_event;
285	Event::one_event unless Coro::nready;
286	}	328	}
287		329
288	wantarray ? @res : $res[0]	330	wantarray ? @res : $res[0]
289	} else {	331	} else {
290	# we are in another coroutine, how wonderful, everything just works	332	# we are in another coroutine, how wonderful, everything just works
291		333
292	$job->()	334	$job->()
293	}	335	}
294	}	336	}
295		337
296	=item $coro = cf::coro { BLOCK }	338	=item $coro = cf::async_ext { BLOCK }
297		339
298	Creates and returns a new coro. This coro is automcatially being canceled	340	Like async, but this coro is automatically being canceled when the
299	when the extension calling this is being unloaded.	341	extension calling this is being unloaded.
300		342
301	=cut	343	=cut
302		344
303	sub coro(&) {	345	sub async_ext(&) {
304	my $cb = shift;	346	my $cb = shift;
305		347
306	my $coro = &cf::async ($cb);	348	my $coro = &Coro::async ($cb);
307		349
308	$coro->on_destroy (sub {	350	$coro->on_destroy (sub {
309	delete $EXT_CORO{$coro+0};	351	delete $EXT_CORO{$coro+0};
310	});	352	});
311	$EXT_CORO{$coro+0} = $coro;	353	$EXT_CORO{$coro+0} = $coro;
312		354
313	$coro	355	$coro
314	}	356	}
315		357
316	sub write_runtime {	358	sub write_runtime {
		359	my $guard = cf::lock_acquire "write_runtime";
		360
317	my $runtime = cf::localdir . "/runtime";	361	my $runtime = cf::localdir . "/runtime";
318		362
319	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	363	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
320	or return;	364	or return;
321		365
		366	my $value = $cf::RUNTIME + 90 + 10;
322	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	367	# 10 is the runtime save interval, for a monotonic clock
		368	# 60 allows for the watchdog to kill the server.
		369
323	(aio_write $fh, 0, (length $value), $value, 0) <= 0	370	(aio_write $fh, 0, (length $value), $value, 0) <= 0
324	and return;	371	and return;
325		372
		373	# always fsync - this file is important
326	aio_fsync $fh	374	aio_fsync $fh
327	and return;	375	and return;
328		376
329	close $fh	377	close $fh
330	or return;	378	or return;
…		…
336	}	384	}
337		385
338	=back	386	=back
339		387
340	=cut	388	=cut
341
342	#############################################################################
343
344	package cf::path;
345
346	sub new {
347	my ($class, $path, $base) = @_;
348
349	$path = $path->as_string if ref $path;
350
351	my $self = bless { }, $class;
352
353	# {... are special paths that are not touched
354	# ?xxx/... are special absolute paths
355	# ?random/... random maps
356	# /! non-realised random map exit
357	# /... normal maps
358	# ~/... per-player maps without a specific player (DO NOT USE)
359	# ~user/... per-player map of a specific user
360
361	if ($path =~ /^{/) {
362	# fine as it is
363	} elsif ($path =~ s{^\?random/}{}) {
364	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
365	$self->{random} = cf::from_json $data;
366	} else {
367	if ($path =~ s{^~([^/]+)?}{}) {
368	$self->{user_rel} = 1;
369
370	if (defined $1) {
371	$self->{user} = $1;
372	} elsif ($base =~ m{^~([^/]+)/}) {
373	$self->{user} = $1;
374	} else {
375	warn "cannot resolve user-relative path without user <$path,$base>\n";
376	}
377	} elsif ($path =~ /^\//) {
378	# already absolute
379	} else {
380	$base =~ s{[^/]+/?$}{};
381	return $class->new ("$base/$path");
382	}
383
384	for ($path) {
385	redo if s{/\.?/}{/};
386	redo if s{/[^/]+/\.\./}{/};
387	}
388	}
389
390	$self->{path} = $path;
391
392	$self
393	}
394
395	# the name / primary key / in-game path
396	sub as_string {
397	my ($self) = @_;
398
399	$self->{user_rel} ? "~$self->{user}$self->{path}"
400	: $self->{random} ? "?random/$self->{path}"
401	: $self->{path}
402	}
403
404	# the displayed name, this is a one way mapping
405	sub visible_name {
406	my ($self) = @_;
407
408	# if (my $rmp = $self->{random}) {
409	# # todo: be more intelligent about this
410	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
411	# } else {
412	$self->as_string
413	# }
414	}
415
416	# escape the /'s in the path
417	sub _escaped_path {
418	# ∕ is U+2215
419	(my $path = $_[0]{path}) =~ s/\//∕/g;
420	$path
421	}
422
423	# the original (read-only) location
424	sub load_path {
425	my ($self) = @_;
426
427	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
428	}
429
430	# the temporary/swap location
431	sub save_path {
432	my ($self) = @_;
433
434	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
435	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
436	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
437	}
438
439	# the unique path, might be eq to save_path
440	sub uniq_path {
441	my ($self) = @_;
442
443	$self->{user_rel} || $self->{random}
444	? undef
445	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
446	}
447
448	# return random map parameters, or undef
449	sub random_map_params {
450	my ($self) = @_;
451
452	$self->{random}
453	}
454
455	# this is somewhat ugly, but style maps do need special treatment
456	sub is_style_map {
457	$_[0]{path} =~ m{^/styles/}
458	}
459
460	package cf;
461		389
462	#############################################################################	390	#############################################################################
463		391
464	=head2 ATTACHABLE OBJECTS	392	=head2 ATTACHABLE OBJECTS
465		393
…		…
591	our @CB_TYPE = (); # registry for type (cf-object class) based events	519	our @CB_TYPE = (); # registry for type (cf-object class) based events
592	our @CB_MAP = ();	520	our @CB_MAP = ();
593		521
594	my %attachment;	522	my %attachment;
595		523
		524	sub cf::attachable::thawer_merge {
		525	# simply override everything except _meta
		526	local $_[0]{_meta};
		527	%{$_[0]} = %{$_[1]};
		528	}
		529
596	sub _attach_cb($$$$) {	530	sub _attach_cb($$$$) {
597	my ($registry, $event, $prio, $cb) = @_;	531	my ($registry, $event, $prio, $cb) = @_;
598		532
599	use sort 'stable';	533	use sort 'stable';
600		534
…		…
771	# object support	705	# object support
772		706
773	sub reattach {	707	sub reattach {
774	# basically do the same as instantiate, without calling instantiate	708	# basically do the same as instantiate, without calling instantiate
775	my ($obj) = @_;	709	my ($obj) = @_;
		710
		711	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
776		712
777	my $registry = $obj->registry;	713	my $registry = $obj->registry;
778		714
779	@$registry = ();	715	@$registry = ();
780		716
…		…
827	$filename, length $$rdata, scalar @$objs;	763	$filename, length $$rdata, scalar @$objs;
828		764
829	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	765	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
830	chmod SAVE_MODE, $fh;	766	chmod SAVE_MODE, $fh;
831	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	767	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
832	aio_fsync $fh;	768	aio_fsync $fh if $cf::USE_FSYNC;
833	close $fh;	769	close $fh;
834		770
835	if (@$objs) {	771	if (@$objs) {
836	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	772	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
837	chmod SAVE_MODE, $fh;	773	chmod SAVE_MODE, $fh;
838	my $data = Storable::nfreeze { version => 1, objs => $objs };	774	my $data = Storable::nfreeze { version => 1, objs => $objs };
839	aio_write $fh, 0, (length $data), $data, 0;	775	aio_write $fh, 0, (length $data), $data, 0;
840	aio_fsync $fh;	776	aio_fsync $fh if $cf::USE_FSYNC;
841	close $fh;	777	close $fh;
842	aio_rename "$filename.pst~", "$filename.pst";	778	aio_rename "$filename.pst~", "$filename.pst";
843	}	779	}
844	} else {	780	} else {
845	aio_unlink "$filename.pst";	781	aio_unlink "$filename.pst";
…		…
912	=cut	848	=cut
913		849
914	sub register_extcmd {	850	sub register_extcmd {
915	my ($name, $cb) = @_;	851	my ($name, $cb) = @_;
916		852
917	my $caller = caller;
918	#warn "registering extcmd '$name' to '$caller'";
919
920	$EXTCMD{$name} = [$cb, $caller];	853	$EXTCMD{$name} = $cb;
921	}	854	}
922		855
923	cf::player->attach (	856	cf::player->attach (
924	on_command => sub {	857	on_command => sub {
925	my ($pl, $name, $params) = @_;	858	my ($pl, $name, $params) = @_;
…		…
938		871
939	my $msg = eval { from_json $buf };	872	my $msg = eval { from_json $buf };
940		873
941	if (ref $msg) {	874	if (ref $msg) {
942	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	875	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
943	if (my %reply = $cb->[0]->($pl, $msg)) {	876	if (my %reply = $cb->($pl, $msg)) {
944	$pl->ext_reply ($msg->{msgid}, %reply);	877	$pl->ext_reply ($msg->{msgid}, %reply);
945	}	878	}
946	}	879	}
947	} else {	880	} else {
948	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	881	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
…		…
950		883
951	cf::override;	884	cf::override;
952	},	885	},
953	);	886	);
954		887
955	sub register {
956	my ($base, $pkg) = @_;
957
958	#TODO
959	}
960
961	sub load_extension {	888	sub load_extension {
962	my ($path) = @_;	889	my ($path) = @_;
963		890
964	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	891	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
965	my $base = $1;	892	my $base = $1;
966	my $pkg = $1;	893	my $pkg = $1;
967	$pkg =~ s/[^[:word:]]/_/g;	894	$pkg =~ s/[^[:word:]]/_/g;
968	$pkg = "ext::$pkg";	895	$pkg = "ext::$pkg";
969		896
970	warn "loading '$path' into '$pkg'\n";	897	warn "... loading '$path' into '$pkg'\n";
971		898
972	open my $fh, "<:utf8", $path	899	open my $fh, "<:utf8", $path
973	or die "$path: $!";	900	or die "$path: $!";
974		901
975	my $source =	902	my $source =
976	"package $pkg; use strict; use utf8;\n"	903	"package $pkg; use strict; use utf8;\n"
977	. "#line 1 \"$path\"\n{\n"	904	. "#line 1 \"$path\"\n{\n"
978	. (do { local $/; <$fh> })	905	. (do { local $/; <$fh> })
979	. "\n};\n1";	906	. "\n};\n1";
980		907
981	eval $source	908	unless (eval $source) {
982	or die $@ ? "$path: $@\n"	909	my $msg = $@ ? "$path: $@\n"
983	: "extension disabled.\n";	910	: "extension disabled.\n";
984		911	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
985	push @exts, $pkg;	912	warn $@;
986	$ext_pkg{$base} = $pkg;	913	warn "mandatory extension failed to load, exiting.\n";
987		914	exit 1;
988	# no strict 'refs';	915	}
989	# @{"$pkg\::ISA"} = ext::;	916	die $@;
990
991	register $base, $pkg;
992	}
993
994	sub unload_extension {
995	my ($pkg) = @_;
996
997	warn "removing extension $pkg\n";
998
999	# remove hooks
1000	#TODO
1001	# for my $idx (0 .. $#PLUGIN_EVENT) {
1002	# delete $hook[$idx]{$pkg};
1003	# }	917	}
1004		918
1005	# remove commands	919	push @EXTS, $pkg;
1006	for my $name (keys %COMMAND) {
1007	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1008
1009	if (@cb) {
1010	$COMMAND{$name} = \@cb;
1011	} else {
1012	delete $COMMAND{$name};
1013	}
1014	}
1015
1016	# remove extcmds
1017	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1018	delete $EXTCMD{$name};
1019	}
1020
1021	if (my $cb = $pkg->can ("unload")) {
1022	eval {
1023	$cb->($pkg);
1024	1
1025	} or warn "$pkg unloaded, but with errors: $@";
1026	}
1027
1028	Symbol::delete_package $pkg;
1029	}	920	}
1030		921
1031	sub load_extensions {	922	sub load_extensions {
1032	for my $ext (<$LIBDIR/*.ext>) {	923	for my $ext (<$LIBDIR/*.ext>) {
1033	next unless -r $ext;	924	next unless -r $ext;
…		…
1037	} or warn "$ext not loaded: $@";	928	} or warn "$ext not loaded: $@";
1038	}	929	}
1039	}	930	}
1040		931
1041	#############################################################################	932	#############################################################################
1042	# load/save/clean perl data associated with a map
1043
1044	*cf::mapsupport::on_clean = sub {
1045	my ($map) = @_;
1046
1047	my $path = $map->tmpname;
1048	defined $path or return;
1049
1050	unlink "$path.pst";
1051	};
1052
1053	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1054
1055	#############################################################################
1056	# load/save perl data associated with player->ob objects
1057
1058	sub all_objects(@) {
1059	@_, map all_objects ($_->inv), @_
1060	}
1061
1062	# TODO: compatibility cruft, remove when no longer needed
1063	cf::player->attach (
1064	on_load => sub {
1065	my ($pl, $path) = @_;
1066
1067	for my $o (all_objects $pl->ob) {
1068	if (my $value = $o->get_ob_key_value ("_perl_data")) {
1069	$o->set_ob_key_value ("_perl_data");
1070
1071	%$o = %{ Storable::thaw pack "H*", $value };
1072	}
1073	}
1074	},
1075	);
1076
1077	#############################################################################
1078		933
1079	=head2 CORE EXTENSIONS	934	=head2 CORE EXTENSIONS
1080		935
1081	Functions and methods that extend core crossfire objects.	936	Functions and methods that extend core crossfire objects.
1082		937
		938	=cut
		939
		940	package cf::player;
		941
		942	use Coro::AIO;
		943
1083	=head3 cf::player	944	=head3 cf::player
1084		945
1085	=over 4	946	=over 4
1086		947
1087	=item cf::player::exists $login	948	=item cf::player::find $login
1088		949
1089	Returns true when the given account exists.	950	Returns the given player object, loading it if necessary (might block).
1090		951
1091	=cut	952	=cut
1092		953
1093	sub cf::player::exists($) {	954	sub playerdir($) {
1094	cf::player::find $_[0]	955	cf::localdir
1095	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	956	. "/"
		957	. cf::playerdir
		958	. "/"
		959	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		960	}
		961
		962	sub path($) {
		963	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		964
		965	(playerdir $login) . "/$login.pl"
		966	}
		967
		968	sub find_active($) {
		969	$cf::PLAYER{$_[0]}
		970	and $cf::PLAYER{$_[0]}->active
		971	and $cf::PLAYER{$_[0]}
		972	}
		973
		974	sub exists($) {
		975	my ($login) = @_;
		976
		977	$cf::PLAYER{$login}
		978	or cf::sync_job { !aio_stat path $login }
		979	}
		980
		981	sub find($) {
		982	return $cf::PLAYER{$_[0]} || do {
		983	my $login = $_[0];
		984
		985	my $guard = cf::lock_acquire "user_find:$login";
		986
		987	$cf::PLAYER{$_[0]} || do {
		988	my $pl = load_pl path $login
		989	or return;
		990	$cf::PLAYER{$login} = $pl
		991	}
		992	}
		993	}
		994
		995	sub save($) {
		996	my ($pl) = @_;
		997
		998	return if $pl->{deny_save};
		999
		1000	my $path = path $pl;
		1001	my $guard = cf::lock_acquire "user_save:$path";
		1002
		1003	return if $pl->{deny_save};
		1004
		1005	aio_mkdir playerdir $pl, 0770;
		1006	$pl->{last_save} = $cf::RUNTIME;
		1007
		1008	$pl->save_pl ($path);
		1009	Coro::cede;
		1010	}
		1011
		1012	sub new($) {
		1013	my ($login) = @_;
		1014
		1015	my $self = create;
		1016
		1017	$self->ob->name ($login);
		1018	$self->{deny_save} = 1;
		1019
		1020	$cf::PLAYER{$login} = $self;
		1021
		1022	$self
		1023	}
		1024
		1025	=item $pl->quit_character
		1026
		1027	Nukes the player without looking back. If logged in, the connection will
		1028	be destroyed. May block for a long time.
		1029
		1030	=cut
		1031
		1032	sub quit_character {
		1033	my ($pl) = @_;
		1034
		1035	my $name = $pl->ob->name;
		1036
		1037	$pl->{deny_save} = 1;
		1038	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1039
		1040	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1041	$pl->deactivate;
		1042	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1043	$pl->ns->destroy if $pl->ns;
		1044
		1045	my $path = playerdir $pl;
		1046	my $temp = "$path~$cf::RUNTIME~deleting~";
		1047	aio_rename $path, $temp;
		1048	delete $cf::PLAYER{$pl->ob->name};
		1049	$pl->destroy;
		1050
		1051	my $prefix = qr<^~\Q$name\E/>;
		1052
		1053	# nuke player maps
		1054	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1055
		1056	IO::AIO::aio_rmtree $temp;
		1057	}
		1058
		1059	=item cf::player::list_logins
		1060
		1061	Returns am arrayref of all valid playernames in the system, can take a
		1062	while and may block, so not sync_job-capable, ever.
		1063
		1064	=cut
		1065
		1066	sub list_logins {
		1067	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
		1068	or return [];
		1069
		1070	my @logins;
		1071
		1072	for my $login (@$dirs) {
		1073	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1074	aio_read $fh, 0, 512, my $buf, 0 or next;
		1075	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1076
		1077	utf8::decode $login;
		1078	push @logins, $login;
		1079	}
		1080
		1081	\@logins
		1082	}
		1083
		1084	=item $player->maps
		1085
		1086	Returns an arrayref of map paths that are private for this
		1087	player. May block.
		1088
		1089	=cut
		1090
		1091	sub maps($) {
		1092	my ($pl) = @_;
		1093
		1094	$pl = ref $pl ? $pl->ob->name : $pl;
		1095
		1096	my $files = aio_readdir playerdir $pl
		1097	or return;
		1098
		1099	my @paths;
		1100
		1101	for (@$files) {
		1102	utf8::decode $_;
		1103	next if /\.(?:pl|pst)$/;
		1104	next unless /^$PATH_SEP/o;
		1105
		1106	push @paths, cf::map::normalise "~$pl/$_";
		1107	}
		1108
		1109	\@paths
1096	}	1110	}
1097		1111
1098	=item $player->ext_reply ($msgid, $msgtype, %msg)	1112	=item $player->ext_reply ($msgid, $msgtype, %msg)
1099		1113
1100	Sends an ext reply to the player.	1114	Sends an ext reply to the player.
1101		1115
1102	=cut	1116	=cut
1103		1117
1104	sub cf::player::ext_reply($$$%) {	1118	sub ext_reply($$$%) {
1105	my ($self, $id, %msg) = @_;	1119	my ($self, $id, %msg) = @_;
1106		1120
1107	$msg{msgid} = $id;	1121	$msg{msgid} = $id;
1108		1122
1109	$self->send ("ext " . to_json \%msg);	1123	$self->send ("ext " . cf::to_json \%msg);
1110	}	1124	}
		1125
		1126	package cf;
1111		1127
1112	=back	1128	=back
1113		1129
1114		1130
1115	=head3 cf::map	1131	=head3 cf::map
…		…
1121	package cf::map;	1137	package cf::map;
1122		1138
1123	use Fcntl;	1139	use Fcntl;
1124	use Coro::AIO;	1140	use Coro::AIO;
1125		1141
		1142	use overload
		1143	'""' => \&as_string,
		1144	fallback => 1;
		1145
1126	our $MAX_RESET = 3600;	1146	our $MAX_RESET = 3600;
1127	our $DEFAULT_RESET = 3000;	1147	our $DEFAULT_RESET = 3000;
1128		1148
1129	sub generate_random_map {	1149	sub generate_random_map {
1130	my ($path, $rmp) = @_;	1150	my ($self, $rmp) = @_;
1131
1132	# mit "rum" bekleckern, nicht	1151	# mit "rum" bekleckern, nicht
1133	cf::map::_create_random_map	1152	$self->_create_random_map (
1134	$path,
1135	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1153	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1136	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1154	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1137	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1155	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1138	$rmp->{exit_on_final_map},	1156	$rmp->{exit_on_final_map},
1139	$rmp->{xsize}, $rmp->{ysize},	1157	$rmp->{xsize}, $rmp->{ysize},
1140	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1158	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1141	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1159	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1142	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1160	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1143	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},	1161	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1144	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1162	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1145	(cf::region::find $rmp->{region})	1163	(cf::region::find $rmp->{region}), $rmp->{custom}
		1164	)
		1165	}
		1166
		1167	=item cf::map->register ($regex, $prio)
		1168
		1169	Register a handler for the map path matching the given regex at the
		1170	givne priority (higher is better, built-in handlers have priority 0, the
		1171	default).
		1172
		1173	=cut
		1174
		1175	sub register {
		1176	my (undef, $regex, $prio) = @_;
		1177	my $pkg = caller;
		1178
		1179	no strict;
		1180	push @{"$pkg\::ISA"}, __PACKAGE__;
		1181
		1182	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1183	}
		1184
		1185	# also paths starting with '/'
		1186	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1187
		1188	sub thawer_merge {
		1189	my ($self, $merge) = @_;
		1190
		1191	# we have to keep some variables in memory intact
		1192	local $self->{path};
		1193	local $self->{load_path};
		1194	local $self->{deny_save};
		1195	local $self->{deny_reset};
		1196
		1197	$self->SUPER::thawer_merge ($merge);
		1198	}
		1199
		1200	sub normalise {
		1201	my ($path, $base) = @_;
		1202
		1203	$path = "$path"; # make sure its a string
		1204
		1205	$path =~ s/\.map$//;
		1206
		1207	# map plan:
		1208	#
		1209	# /! non-realised random map exit (special hack!)
		1210	# {... are special paths that are not being touched
		1211	# ?xxx/... are special absolute paths
		1212	# ?random/... random maps
		1213	# /... normal maps
		1214	# ~user/... per-player map of a specific user
		1215
		1216	$path =~ s/$PATH_SEP/\//go;
		1217
		1218	# treat it as relative path if it starts with
		1219	# something that looks reasonable
		1220	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1221	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1222
		1223	$base =~ s{[^/]+/?$}{};
		1224	$path = "$base/$path";
		1225	}
		1226
		1227	for ($path) {
		1228	redo if s{//}{/};
		1229	redo if s{/\.?/}{/};
		1230	redo if s{/[^/]+/\.\./}{/};
		1231	}
		1232
		1233	$path
		1234	}
		1235
		1236	sub new_from_path {
		1237	my (undef, $path, $base) = @_;
		1238
		1239	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1240
		1241	$path = normalise $path, $base;
		1242
		1243	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1244	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1245	my $self = bless cf::map::new, $pkg;
		1246	$self->{path} = $path; $self->path ($path);
		1247	$self->init; # pass $1 etc.
		1248	return $self;
		1249	}
		1250	}
		1251
		1252	Carp::carp "unable to resolve path '$path' (base '$base').";
		1253	()
		1254	}
		1255
		1256	sub init {
		1257	my ($self) = @_;
		1258
		1259	$self
		1260	}
		1261
		1262	sub as_string {
		1263	my ($self) = @_;
		1264
		1265	"$self->{path}"
		1266	}
		1267
		1268	# the displayed name, this is a one way mapping
		1269	sub visible_name {
		1270	&as_string
		1271	}
		1272
		1273	# the original (read-only) location
		1274	sub load_path {
		1275	my ($self) = @_;
		1276
		1277	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}
		1278	}
		1279
		1280	# the temporary/swap location
		1281	sub save_path {
		1282	my ($self) = @_;
		1283
		1284	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1285	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path
		1286	}
		1287
		1288	# the unique path, undef == no special unique path
		1289	sub uniq_path {
		1290	my ($self) = @_;
		1291
		1292	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1293	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
1146	}	1294	}
1147		1295
1148	# and all this just because we cannot iterate over	1296	# and all this just because we cannot iterate over
1149	# all maps in C++...	1297	# all maps in C++...
1150	sub change_all_map_light {	1298	sub change_all_map_light {
…		…
1152		1300
1153	$_->change_map_light ($change)	1301	$_->change_map_light ($change)
1154	for grep $_->outdoor, values %cf::MAP;	1302	for grep $_->outdoor, values %cf::MAP;
1155	}	1303	}
1156		1304
		1305	sub unlink_save {
		1306	my ($self) = @_;
		1307
		1308	utf8::encode (my $save = $self->save_path);
		1309	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1310	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1311	}
		1312
1157	sub try_load_header($) {	1313	sub load_header_from($) {
1158	my ($path) = @_;	1314	my ($self, $path) = @_;
1159		1315
1160	utf8::encode $path;	1316	utf8::encode $path;
1161	aio_open $path, O_RDONLY, 0	1317	#aio_open $path, O_RDONLY, 0
		1318	# or return;
		1319
		1320	$self->_load_header ($path)
1162	or return;	1321	or return;
1163		1322
1164	my $map = cf::map::new	1323	$self->{load_path} = $path;
		1324
		1325	1
		1326	}
		1327
		1328	sub load_header_orig {
		1329	my ($self) = @_;
		1330
		1331	$self->load_header_from ($self->load_path)
		1332	}
		1333
		1334	sub load_header_temp {
		1335	my ($self) = @_;
		1336
		1337	$self->load_header_from ($self->save_path)
		1338	}
		1339
		1340	sub prepare_temp {
		1341	my ($self) = @_;
		1342
		1343	$self->last_access ((delete $self->{last_access})
		1344	|| $cf::RUNTIME); #d#
		1345	# safety
		1346	$self->{instantiate_time} = $cf::RUNTIME
		1347	if $self->{instantiate_time} > $cf::RUNTIME;
		1348	}
		1349
		1350	sub prepare_orig {
		1351	my ($self) = @_;
		1352
		1353	$self->{load_original} = 1;
		1354	$self->{instantiate_time} = $cf::RUNTIME;
		1355	$self->last_access ($cf::RUNTIME);
		1356	$self->instantiate;
		1357	}
		1358
		1359	sub load_header {
		1360	my ($self) = @_;
		1361
		1362	if ($self->load_header_temp) {
		1363	$self->prepare_temp;
		1364	} else {
		1365	$self->load_header_orig
1165	or return;	1366	or return;
		1367	$self->prepare_orig;
		1368	}
1166		1369
1167	# for better error messages only, will be overwritten	1370	1
1168	$map->path ($path);
1169
1170	$map->load_header ($path)
1171	or return;
1172
1173	$map->{load_path} = $path;
1174
1175	$map
1176	}	1371	}
1177		1372
1178	sub find;	1373	sub find;
1179	sub find {	1374	sub find {
1180	my ($path, $origin) = @_;	1375	my ($path, $origin) = @_;
1181		1376
1182	#warn "find<$path,$origin>\n";#d#
1183
1184	$path = new cf::path $path, $origin && $origin->path;	1377	$path = normalise $path, $origin && $origin->path;
1185	my $key = $path->as_string;
1186		1378
1187	cf::lock_wait "map_find:$key";	1379	cf::lock_wait "map_find:$path";
1188		1380
1189	$cf::MAP{$key} || do {	1381	$cf::MAP{$path} || do {
1190	my $guard = cf::lock_acquire "map_find:$key";	1382	my $guard = cf::lock_acquire "map_find:$path";
1191		1383	my $map = new_from_path cf::map $path
1192	# do it the slow way
1193	my $map = try_load_header $path->save_path;
1194
1195	Coro::cede;
1196
1197	if ($map) {
1198	$map->last_access ((delete $map->{last_access})
1199	|| $cf::RUNTIME); #d#
1200	# safety
1201	$map->{instantiate_time} = $cf::RUNTIME
1202	if $map->{instantiate_time} > $cf::RUNTIME;
1203	} else {
1204	if (my $rmp = $path->random_map_params) {
1205	$map = generate_random_map $key, $rmp;
1206	} else {
1207	$map = try_load_header $path->load_path;
1208	}
1209
1210	$map or return;	1384	or return;
1211		1385
1212	$map->{load_original} = 1;
1213	$map->{instantiate_time} = $cf::RUNTIME;
1214	$map->last_access ($cf::RUNTIME);
1215	$map->instantiate;
1216
1217	# per-player maps become, after loading, normal maps
1218	$map->per_player (0) if $path->{user_rel};
1219	}
1220
1221	$map->path ($key);
1222	$map->{path} = $path;
1223	$map->{last_save} = $cf::RUNTIME;	1386	$map->{last_save} = $cf::RUNTIME;
1224		1387
1225	Coro::cede;	1388	$map->load_header
		1389	or return;
1226		1390
1227	if ($map->should_reset) {	1391	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)
		1392	# doing this can freeze the server in a sync job, obviously
		1393	#$cf::WAIT_FOR_TICK->wait;
1228	$map->reset;	1394	$map->reset;
1229	undef $guard;	1395	undef $guard;
1230	$map = find $path	1396	return find $path;
1231	or return;
1232	}	1397	}
1233		1398
1234	$cf::MAP{$key} = $map	1399	$cf::MAP{$path} = $map
1235	}	1400	}
1236	}	1401	}
		1402
		1403	sub pre_load { }
		1404	sub post_load { }
1237		1405
1238	sub load {	1406	sub load {
1239	my ($self) = @_;	1407	my ($self) = @_;
1240		1408
		1409	local $self->{deny_reset} = 1; # loading can take a long time
		1410
1241	my $path = $self->{path};	1411	my $path = $self->{path};
1242	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	1412	my $guard = cf::lock_acquire "map_load:$path";
1243		1413
1244	return if $self->in_memory != cf::MAP_SWAPPED;	1414	return if $self->in_memory != cf::MAP_SWAPPED;
1245		1415
1246	$self->in_memory (cf::MAP_LOADING);	1416	$self->in_memory (cf::MAP_LOADING);
1247		1417
1248	$self->alloc;	1418	$self->alloc;
		1419
		1420	$self->pre_load;
		1421
1249	$self->load_objects ($self->{load_path}, 1)	1422	$self->_load_objects ($self->{load_path}, 1)
1250	or return;	1423	or return;
1251		1424
1252	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1425	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1253	if delete $self->{load_original};	1426	if delete $self->{load_original};
1254		1427
1255	if (my $uniq = $path->uniq_path) {	1428	if (my $uniq = $self->uniq_path) {
1256	utf8::encode $uniq;	1429	utf8::encode $uniq;
1257	if (aio_open $uniq, O_RDONLY, 0) {	1430	if (aio_open $uniq, O_RDONLY, 0) {
1258	$self->clear_unique_items;	1431	$self->clear_unique_items;
1259	$self->load_objects ($uniq, 0);	1432	$self->_load_objects ($uniq, 0);
1260	}	1433	}
1261	}	1434	}
1262		1435
1263	Coro::cede;	1436	Coro::cede;
1264		1437
1265	# now do the right thing for maps	1438	# now do the right thing for maps
1266	$self->link_multipart_objects;	1439	$self->link_multipart_objects;
1267		1440
1268	if ($self->{path}->is_style_map) {	1441	unless ($self->{deny_activate}) {
1269	$self->{deny_save} = 1;	1442	$self->decay_objects;
1270	$self->{deny_reset} = 1;
1271	} else {
1272	$self->fix_auto_apply;	1443	$self->fix_auto_apply;
1273	$self->decay_objects;
1274	$self->update_buttons;	1444	$self->update_buttons;
		1445	Coro::cede;
1275	$self->set_darkness_map;	1446	$self->set_darkness_map;
1276	$self->difficulty ($self->estimate_difficulty)	1447	$self->difficulty ($self->estimate_difficulty)
1277	unless $self->difficulty;	1448	unless $self->difficulty;
		1449	Coro::cede;
1278	$self->activate;	1450	$self->activate;
1279	}	1451	}
1280		1452
1281	Coro::cede;	1453	$self->post_load;
1282		1454
1283	$self->in_memory (cf::MAP_IN_MEMORY);	1455	$self->in_memory (cf::MAP_IN_MEMORY);
		1456	}
		1457
		1458	sub customise_for {
		1459	my ($self, $ob) = @_;
		1460
		1461	return find "~" . $ob->name . "/" . $self->{path}
		1462	if $self->per_player;
		1463
		1464	$self
		1465	}
		1466
		1467	# find and load all maps in the 3x3 area around a map
		1468	sub load_diag {
		1469	my ($map) = @_;
		1470
		1471	my @diag; # diagonal neighbours
		1472
		1473	for (0 .. 3) {
		1474	my $neigh = $map->tile_path ($_)
		1475	or next;
		1476	$neigh = find $neigh, $map
		1477	or next;
		1478	$neigh->load;
		1479
		1480	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1481	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1482	}
		1483
		1484	for (@diag) {
		1485	my $neigh = find @$_
		1486	or next;
		1487	$neigh->load;
		1488	}
1284	}	1489	}
1285		1490
1286	sub find_sync {	1491	sub find_sync {
1287	my ($path, $origin) = @_;	1492	my ($path, $origin) = @_;
1288		1493
1289	cf::sync_job { cf::map::find $path, $origin }	1494	cf::sync_job { find $path, $origin }
1290	}	1495	}
1291		1496
1292	sub do_load_sync {	1497	sub do_load_sync {
1293	my ($map) = @_;	1498	my ($map) = @_;
1294		1499
1295	cf::sync_job { $map->load };	1500	cf::sync_job { $map->load };
1296	}	1501	}
1297		1502
		1503	our %MAP_PREFETCH;
		1504	our $MAP_PREFETCHER = undef;
		1505
		1506	sub find_async {
		1507	my ($path, $origin) = @_;
		1508
		1509	$path = normalise $path, $origin && $origin->{path};
		1510
		1511	if (my $map = $cf::MAP{$path}) {
		1512	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1513	}
		1514
		1515	undef $MAP_PREFETCH{$path};
		1516	$MAP_PREFETCHER ||= cf::async {
		1517	while (%MAP_PREFETCH) {
		1518	for my $path (keys %MAP_PREFETCH) {
		1519	my $map = find $path
		1520	or next;
		1521	$map->load;
		1522
		1523	delete $MAP_PREFETCH{$path};
		1524	}
		1525	}
		1526	undef $MAP_PREFETCHER;
		1527	};
		1528	$MAP_PREFETCHER->prio (6);
		1529
		1530	()
		1531	}
		1532
1298	sub save {	1533	sub save {
1299	my ($self) = @_;	1534	my ($self) = @_;
1300		1535
		1536	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1537
1301	$self->{last_save} = $cf::RUNTIME;	1538	$self->{last_save} = $cf::RUNTIME;
1302		1539
1303	return unless $self->dirty;	1540	return unless $self->dirty;
1304		1541
1305	my $save = $self->{path}->save_path; utf8::encode $save;	1542	my $save = $self->save_path; utf8::encode $save;
1306	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	1543	my $uniq = $self->uniq_path; utf8::encode $uniq;
1307		1544
1308	$self->{load_path} = $save;	1545	$self->{load_path} = $save;
1309		1546
1310	return if $self->{deny_save};	1547	return if $self->{deny_save};
1311		1548
1312	local $self->{last_access} = $self->last_access;#d#	1549	local $self->{last_access} = $self->last_access;#d#
1313		1550
		1551	cf::async {
		1552	$_->contr->save for $self->players;
		1553	};
		1554
1314	if ($uniq) {	1555	if ($uniq) {
1315	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	1556	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1316	$self->save_objects ($uniq, cf::IO_UNIQUES);	1557	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1317	} else {	1558	} else {
1318	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);	1559	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1319	}	1560	}
1320	}	1561	}
1321		1562
1322	sub swap_out {	1563	sub swap_out {
1323	my ($self) = @_;	1564	my ($self) = @_;
1324		1565
1325	# save first because save cedes	1566	# save first because save cedes
1326	$self->save;	1567	$self->save;
		1568
		1569	my $lock = cf::lock_acquire "map_data:" . $self->path;
1327		1570
1328	return if $self->players;	1571	return if $self->players;
1329	return if $self->in_memory != cf::MAP_IN_MEMORY;	1572	return if $self->in_memory != cf::MAP_IN_MEMORY;
1330	return if $self->{deny_save};	1573	return if $self->{deny_save};
1331		1574
…		…
1335		1578
1336	sub reset_at {	1579	sub reset_at {
1337	my ($self) = @_;	1580	my ($self) = @_;
1338		1581
1339	# TODO: safety, remove and allow resettable per-player maps	1582	# TODO: safety, remove and allow resettable per-player maps
1340	return 1e99 if $self->{path}{user_rel};	1583	return 1e99 if $self->isa ("ext::map_per_player");#d#
1341	return 1e99 if $self->{deny_reset};	1584	return 1e99 if $self->{deny_reset};
1342		1585
1343	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1586	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1344	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1587	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1345		1588
…		…
1350	my ($self) = @_;	1593	my ($self) = @_;
1351		1594
1352	$self->reset_at <= $cf::RUNTIME	1595	$self->reset_at <= $cf::RUNTIME
1353	}	1596	}
1354		1597
1355	sub unlink_save {
1356	my ($self) = @_;
1357
1358	utf8::encode (my $save = $self->{path}->save_path);
1359	aioreq_pri 3; IO::AIO::aio_unlink $save;
1360	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1361	}
1362
1363	sub rename {
1364	my ($self, $new_path) = @_;
1365
1366	$self->unlink_save;
1367
1368	delete $cf::MAP{$self->path};
1369	$self->{path} = new cf::path $new_path;
1370	$self->path ($self->{path}->as_string);
1371	$cf::MAP{$self->path} = $self;
1372
1373	$self->save;
1374	}
1375
1376	sub reset {	1598	sub reset {
1377	my ($self) = @_;	1599	my ($self) = @_;
1378		1600
		1601	my $lock = cf::lock_acquire "map_data:$self->{path}";
		1602
1379	return if $self->players;	1603	return if $self->players;
1380	return if $self->{path}{user_rel};#d#	1604	return if $self->isa ("ext::map_per_player");#d#
1381		1605
1382	warn "resetting map ", $self->path;#d#	1606	warn "resetting map ", $self->path;#d#
1383		1607
		1608	$self->in_memory (cf::MAP_SWAPPED);
		1609
		1610	# need to save uniques path
		1611	unless ($self->{deny_save}) {
		1612	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1613
		1614	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1615	if $uniq;
		1616	}
		1617
1384	delete $cf::MAP{$self->path};	1618	delete $cf::MAP{$self->path};
		1619
		1620	$self->clear;
1385		1621
1386	$_->clear_links_to ($self) for values %cf::MAP;	1622	$_->clear_links_to ($self) for values %cf::MAP;
1387		1623
1388	$self->unlink_save;	1624	$self->unlink_save;
1389	$self->destroy;	1625	$self->destroy;
…		…
1392	my $nuke_counter = "aaaa";	1628	my $nuke_counter = "aaaa";
1393		1629
1394	sub nuke {	1630	sub nuke {
1395	my ($self) = @_;	1631	my ($self) = @_;
1396		1632
		1633	delete $cf::MAP{$self->path};
		1634
		1635	$self->unlink_save;
		1636
		1637	bless $self, "cf::map";
		1638	delete $self->{deny_reset};
1397	$self->{deny_save} = 1;	1639	$self->{deny_save} = 1;
1398	$self->reset_timeout (1);	1640	$self->reset_timeout (1);
1399	$self->rename ("{nuke}/" . ($nuke_counter++));	1641	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		1642
		1643	$cf::MAP{$self->path} = $self;
		1644
1400	$self->reset; # polite request, might not happen	1645	$self->reset; # polite request, might not happen
1401	}	1646	}
1402		1647
1403	sub customise_for {	1648	=item cf::map::unique_maps
1404	my ($map, $ob) = @_;
1405		1649
1406	if ($map->per_player) {	1650	Returns an arrayref of paths of all shared maps that have
1407	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	1651	instantiated unique items. May block.
1408	}
1409		1652
1410	$map	1653	=cut
1411	}
1412		1654
1413	sub emergency_save {	1655	sub unique_maps() {
1414	my $freeze_guard = cf::freeze_mainloop;	1656	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
		1657	or return;
1415		1658
1416	warn "enter emergency map save\n";	1659	my @paths;
1417		1660
1418	cf::sync_job {	1661	for (@$files) {
1419	warn "begin emergency map save\n";	1662	utf8::decode $_;
1420	$_->save for values %cf::MAP;	1663	next if /\.pst$/;
		1664	next unless /^$PATH_SEP/o;
		1665
		1666	push @paths, cf::map::normalise $_;
1421	};	1667	}
1422		1668
1423	warn "end emergency map save\n";	1669	\@paths
1424	}	1670	}
1425		1671
1426	package cf;	1672	package cf;
1427		1673
1428	=back	1674	=back
1429		1675
		1676	=head3 cf::object
		1677
		1678	=cut
		1679
		1680	package cf::object;
		1681
		1682	=over 4
		1683
		1684	=item $ob->inv_recursive
		1685
		1686	Returns the inventory of the object _and_ their inventories, recursively.
		1687
		1688	=cut
		1689
		1690	sub inv_recursive_;
		1691	sub inv_recursive_ {
		1692	map { $_, inv_recursive_ $_->inv } @_
		1693	}
		1694
		1695	sub inv_recursive {
		1696	inv_recursive_ inv $_[0]
		1697	}
		1698
		1699	package cf;
		1700
		1701	=back
1430		1702
1431	=head3 cf::object::player	1703	=head3 cf::object::player
1432		1704
1433	=over 4	1705	=over 4
1434		1706
…		…
1474		1746
1475	=item $player_object->enter_link	1747	=item $player_object->enter_link
1476		1748
1477	Freezes the player and moves him/her to a special map (C<{link}>).	1749	Freezes the player and moves him/her to a special map (C<{link}>).
1478		1750
1479	The player should be reaosnably safe there for short amounts of time. You	1751	The player should be reasonably safe there for short amounts of time. You
1480	I<MUST> call C<leave_link> as soon as possible, though.	1752	I<MUST> call C<leave_link> as soon as possible, though.
1481		1753
		1754	Will never block.
		1755
1482	=item $player_object->leave_link ($map, $x, $y)	1756	=item $player_object->leave_link ($map, $x, $y)
1483		1757
1484	Moves the player out of the specila link map onto the given map. If the	1758	Moves the player out of the special C<{link}> map onto the specified
1485	map is not valid (or omitted), the player will be moved back to the	1759	map. If the map is not valid (or omitted), the player will be moved back
1486	location he/she was before the call to C<enter_link>, or, if that fails,	1760	to the location he/she was before the call to C<enter_link>, or, if that
1487	to the emergency map position.	1761	fails, to the emergency map position.
1488		1762
1489	Might block.	1763	Might block.
1490		1764
1491	=cut	1765	=cut
		1766
		1767	sub link_map {
		1768	unless ($LINK_MAP) {
		1769	$LINK_MAP = cf::map::find "{link}"
		1770	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		1771	$LINK_MAP->load;
		1772	}
		1773
		1774	$LINK_MAP
		1775	}
1492		1776
1493	sub cf::object::player::enter_link {	1777	sub cf::object::player::enter_link {
1494	my ($self) = @_;	1778	my ($self) = @_;
1495		1779
1496	$self->deactivate_recursive;	1780	$self->deactivate_recursive;
1497		1781
1498	return if $self->map == $LINK_MAP;	1782	return if UNIVERSAL::isa $self->map, "ext::map_link";
1499		1783
1500	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	1784	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1501	if $self->map;	1785	if $self->map;
1502		1786
1503	$self->enter_map ($LINK_MAP, 20, 20);	1787	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1504	}	1788	}
1505		1789
1506	sub cf::object::player::leave_link {	1790	sub cf::object::player::leave_link {
1507	my ($self, $map, $x, $y) = @_;	1791	my ($self, $map, $x, $y) = @_;
1508		1792
…		…
1526	# use -1 or undef as default coordinates, not 0, 0	1810	# use -1 or undef as default coordinates, not 0, 0
1527	($x, $y) = ($map->enter_x, $map->enter_y)	1811	($x, $y) = ($map->enter_x, $map->enter_y)
1528	if $x <=0 && $y <= 0;	1812	if $x <=0 && $y <= 0;
1529		1813
1530	$map->load;	1814	$map->load;
		1815	$map->load_diag;
1531		1816
		1817	return unless $self->contr->active;
1532	$self->activate_recursive;	1818	$self->activate_recursive;
		1819
		1820	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1533	$self->enter_map ($map, $x, $y);	1821	$self->enter_map ($map, $x, $y);
1534	}	1822	}
1535		1823
1536	cf::player->attach (	1824	cf::player->attach (
1537	on_logout => sub {	1825	on_logout => sub {
…		…
1549		1837
1550	# try to abort aborted map switching on player login :)	1838	# try to abort aborted map switching on player login :)
1551	# should happen only on crashes	1839	# should happen only on crashes
1552	if ($pl->ob->{_link_pos}) {	1840	if ($pl->ob->{_link_pos}) {
1553	$pl->ob->enter_link;	1841	$pl->ob->enter_link;
1554	cf::async {	1842	(async {
		1843	$pl->ob->reply (undef,
		1844	"There was an internal problem at your last logout, "
		1845	. "the server will try to bring you to your intended destination in a second.",
		1846	cf::NDI_RED);
1555	# we need this sleep as the login has a concurrent enter_exit running	1847	# we need this sleep as the login has a concurrent enter_exit running
1556	# and this sleep increases chances of the player not ending up in scorn	1848	# and this sleep increases chances of the player not ending up in scorn
1557	Coro::Timer::sleep 1;	1849	Coro::Timer::sleep 1;
1558	$pl->ob->leave_link;	1850	$pl->ob->leave_link;
1559	};	1851	})->prio (2);
1560	}	1852	}
1561	},	1853	},
1562	);	1854	);
1563		1855
1564	=item $player_object->goto_map ($path, $x, $y)	1856	=item $player_object->goto ($path, $x, $y)
1565		1857
1566	=cut	1858	=cut
1567		1859
1568	sub cf::object::player::goto_map {	1860	sub cf::object::player::goto {
1569	my ($self, $path, $x, $y) = @_;	1861	my ($self, $path, $x, $y) = @_;
1570		1862
1571	$self->enter_link;	1863	$self->enter_link;
1572		1864
1573	(cf::async {	1865	(async {
1574	$path = new cf::path $path;	1866	my $map = eval {
1575
1576	my $map = cf::map::find $path->as_string;	1867	my $map = cf::map::find $path;
1577	$map = $map->customise_for ($self) if $map;	1868	$map = $map->customise_for ($self) if $map;
1578		1869	$map
1579	# warn "entering ", $map->path, " at ($x, $y)\n"	1870	} or
1580	# if $map;
1581
1582	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);	1871	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1583		1872
1584	$self->leave_link ($map, $x, $y);	1873	$self->leave_link ($map, $x, $y);
1585	})->prio (1);	1874	})->prio (1);
1586	}	1875	}
1587		1876
…		…
1591		1880
1592	sub parse_random_map_params {	1881	sub parse_random_map_params {
1593	my ($spec) = @_;	1882	my ($spec) = @_;
1594		1883
1595	my $rmp = { # defaults	1884	my $rmp = { # defaults
1596	xsize => 10,	1885	xsize => (cf::rndm 15, 40),
1597	ysize => 10,	1886	ysize => (cf::rndm 15, 40),
		1887	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		1888	#layout => string,
1598	};	1889	};
1599		1890
1600	for (split /\n/, $spec) {	1891	for (split /\n/, $spec) {
1601	my ($k, $v) = split /\s+/, $_, 2;	1892	my ($k, $v) = split /\s+/, $_, 2;
1602		1893
…		…
1606	$rmp	1897	$rmp
1607	}	1898	}
1608		1899
1609	sub prepare_random_map {	1900	sub prepare_random_map {
1610	my ($exit) = @_;	1901	my ($exit) = @_;
		1902
		1903	my $guard = cf::lock_acquire "exit_prepare:$exit";
1611		1904
1612	# all this does is basically replace the /! path by	1905	# all this does is basically replace the /! path by
1613	# a new random map path (?random/...) with a seed	1906	# a new random map path (?random/...) with a seed
1614	# that depends on the exit object	1907	# that depends on the exit object
1615		1908
1616	my $rmp = parse_random_map_params $exit->msg;	1909	my $rmp = parse_random_map_params $exit->msg;
1617		1910
1618	if ($exit->map) {	1911	if ($exit->map) {
1619	$rmp->{region} = $exit->map->region_name;	1912	$rmp->{region} = $exit->region->name;
1620	$rmp->{origin_map} = $exit->map->path;	1913	$rmp->{origin_map} = $exit->map->path;
1621	$rmp->{origin_x} = $exit->x;	1914	$rmp->{origin_x} = $exit->x;
1622	$rmp->{origin_y} = $exit->y;	1915	$rmp->{origin_y} = $exit->y;
1623	}	1916	}
1624		1917
1625	$rmp->{random_seed} ||= $exit->random_seed;	1918	$rmp->{random_seed} ||= $exit->random_seed;
1626		1919
1627	my $data = cf::to_json $rmp;	1920	my $data = cf::to_json $rmp;
1628	my $md5 = Digest::MD5::md5_hex $data;	1921	my $md5 = Digest::MD5::md5_hex $data;
		1922	my $meta = "$cf::RANDOM_MAPS/$md5.meta";
1629		1923
1630	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	1924	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1631	aio_write $fh, 0, (length $data), $data, 0;	1925	aio_write $fh, 0, (length $data), $data, 0;
		1926	undef $fh;
		1927	aio_rename "$meta~", $meta;
1632		1928
1633	$exit->slaying ("?random/$md5");	1929	$exit->slaying ("?random/$md5");
1634	$exit->msg (undef);	1930	$exit->msg (undef);
1635	}	1931	}
1636	}	1932	}
…		…
1638	sub cf::object::player::enter_exit {	1934	sub cf::object::player::enter_exit {
1639	my ($self, $exit) = @_;	1935	my ($self, $exit) = @_;
1640		1936
1641	return unless $self->type == cf::PLAYER;	1937	return unless $self->type == cf::PLAYER;
1642		1938
		1939	if ($exit->slaying eq "/!") {
		1940	#TODO: this should de-fi-ni-te-ly not be a sync-job
		1941	cf::sync_job { prepare_random_map $exit };
		1942	}
		1943
		1944	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		1945	my $hp = $exit->stats->hp;
		1946	my $sp = $exit->stats->sp;
		1947
1643	$self->enter_link;	1948	$self->enter_link;
1644		1949
1645	(cf::async {	1950	(async {
1646	$self->deactivate_recursive; # just to be sure	1951	$self->deactivate_recursive; # just to be sure
1647	unless (eval {	1952	unless (eval {
1648	prepare_random_map $exit	1953	$self->goto ($slaying, $hp, $sp);
1649	if $exit->slaying eq "/!";
1650
1651	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1652	$self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1653		1954
1654	1;	1955	1;
1655	}) {	1956	}) {
1656	$self->message ("Something went wrong deep within the crossfire server. "	1957	$self->message ("Something went wrong deep within the crossfire server. "
1657	. "I'll try to bring you back to the map you were before. "	1958	. "I'll try to bring you back to the map you were before. "
1658	. "Please report this to the dungeon master",	1959	. "Please report this to the dungeon master!",
1659	cf::NDI_UNIQUE | cf::NDI_RED);	1960	cf::NDI_UNIQUE | cf::NDI_RED);
1660		1961
1661	warn "ERROR in enter_exit: $@";	1962	warn "ERROR in enter_exit: $@";
1662	$self->leave_link;	1963	$self->leave_link;
1663	}	1964	}
…		…
1718	# get handled first	2019	# get handled first
1719	my $queue = delete $ns->{query_queue}	2020	my $queue = delete $ns->{query_queue}
1720	or return; # be conservative, not sure how that can happen, but we saw a crash here	2021	or return; # be conservative, not sure how that can happen, but we saw a crash here
1721		2022
1722	(shift @$queue)->[1]->($msg);	2023	(shift @$queue)->[1]->($msg);
		2024	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1723		2025
1724	push @{ $ns->{query_queue} }, @$queue;	2026	push @{ $ns->{query_queue} }, @$queue;
1725		2027
1726	if (@{ $ns->{query_queue} } == @$queue) {	2028	if (@{ $ns->{query_queue} } == @$queue) {
1727	if (@$queue) {	2029	if (@$queue) {
…		…
1731	}	2033	}
1732	}	2034	}
1733	},	2035	},
1734	);	2036	);
1735		2037
1736	=item $client->coro (\&cb)	2038	=item $client->async (\&cb)
1737		2039
1738	Create a new coroutine, running the specified callback. The coroutine will	2040	Create a new coroutine, running the specified callback. The coroutine will
1739	be automatically cancelled when the client gets destroyed (e.g. on logout,	2041	be automatically cancelled when the client gets destroyed (e.g. on logout,
1740	or loss of connection).	2042	or loss of connection).
1741		2043
1742	=cut	2044	=cut
1743		2045
1744	sub cf::client::coro {	2046	sub cf::client::async {
1745	my ($self, $cb) = @_;	2047	my ($self, $cb) = @_;
1746		2048
1747	my $coro = &cf::async ($cb);	2049	my $coro = &Coro::async ($cb);
1748		2050
1749	$coro->on_destroy (sub {	2051	$coro->on_destroy (sub {
1750	delete $self->{_coro}{$coro+0};	2052	delete $self->{_coro}{$coro+0};
1751	});	2053	});
1752		2054
…		…
1888	The parameter C<$family> should best start with the name of the extension	2190	The parameter C<$family> should best start with the name of the extension
1889	using it, it should be unique.	2191	using it, it should be unique.
1890		2192
1891	=over 4	2193	=over 4
1892		2194
1893	=item $hashref = cf::db_get $family
1894
1895	Return a hashref for use by the extension C<$family>, which can be
1896	modified. After modifications, you have to call C<cf::db_dirty> or
1897	C<cf::db_sync>.
1898
1899	=item $value = cf::db_get $family => $key	2195	=item $value = cf::db_get $family => $key
1900		2196
1901	Returns a single value from the database	2197	Returns a single value from the database.
1902
1903	=item cf::db_put $family => $hashref
1904
1905	Stores the given family hashref into the database. Updates are delayed, if
1906	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1907		2198
1908	=item cf::db_put $family => $key => $value	2199	=item cf::db_put $family => $key => $value
1909		2200
1910	Stores the given C<$value> in the family hash. Updates are delayed, if you	2201	Stores the given C<$value> in the family.
1911	want the data to be synced to disk immediately, use C<cf::db_sync>.
1912
1913	=item cf::db_dirty
1914
1915	Marks the database as dirty, to be updated at a later time.
1916
1917	=item cf::db_sync
1918
1919	Immediately write the database to disk I<if it is dirty>.
1920		2202
1921	=cut	2203	=cut
1922		2204
1923	our $DB;	2205	our $DB;
1924		2206
1925	{	2207	sub db_init {
		2208	unless ($DB) {
		2209	$DB = BDB::db_create $DB_ENV;
		2210
		2211	cf::sync_job {
		2212	eval {
		2213	$DB->set_flags (BDB::CHKSUM);
		2214
		2215	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		2216	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		2217	cf::cleanup "db_open(db): $!" if $!;
		2218	};
		2219	cf::cleanup "db_open(db): $@" if $@;
		2220	};
		2221
1926	my $path = cf::localdir . "/database.pst";	2222	my $path = cf::localdir . "/database.pst";
		2223	if (stat $path) {
		2224	cf::sync_job {
		2225	my $pst = Storable::retrieve $path;
1927		2226
1928	sub db_load() {	2227	cf::db_put (board => data => $pst->{board});
1929	$DB = stat $path ? Storable::retrieve $path : { };	2228	cf::db_put (guildrules => data => $pst->{guildrules});
1930	}	2229	cf::db_put (rent => balance => $pst->{rent}{balance});
		2230	BDB::db_env_txn_checkpoint $DB_ENV;
1931		2231
1932	my $pid;	2232	unlink $path;
1933
1934	sub db_save() {
1935	waitpid $pid, 0 if $pid;
1936	if (0 == ($pid = fork)) {
1937	$DB->{_meta}{version} = 1;
1938	Storable::nstore $DB, "$path~";
1939	rename "$path~", $path;
1940	cf::_exit 0 if defined $pid;
1941	}	2233	};
1942	}
1943
1944	my $dirty;
1945
1946	sub db_sync() {
1947	db_save if $dirty;
1948	undef $dirty;
1949	}
1950
1951	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1952	db_sync;
1953	});
1954
1955	sub db_dirty() {
1956	$dirty = 1;
1957	$idle->start;
1958	}
1959
1960	sub db_get($;$) {
1961	@_ >= 2
1962	? $DB->{$_[0]}{$_[1]}
1963	: ($DB->{$_[0]} ||= { })
1964	}
1965
1966	sub db_put($$;$) {
1967	if (@_ >= 3) {
1968	$DB->{$_[0]}{$_[1]} = $_[2];
1969	} else {
1970	$DB->{$_[0]} = $_[1];
1971	}
1972	db_dirty;
1973	}
1974
1975	cf::global->attach (
1976	prio => 10000,
1977	on_cleanup => sub {
1978	db_sync;
1979	},	2234	}
1980	);	2235	}
		2236	}
		2237
		2238	sub db_get($$) {
		2239	my $key = "$_[0]/$_[1]";
		2240
		2241	cf::sync_job {
		2242	BDB::db_get $DB, undef, $key, my $data;
		2243
		2244	$! ? ()
		2245	: Compress::LZF::sthaw $data
		2246	}
		2247	}
		2248
		2249	sub db_put($$$) {
		2250	BDB::dbreq_pri 4;
		2251	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
1981	}	2252	}
1982		2253
1983	#############################################################################	2254	#############################################################################
1984	# the server's main()	2255	# the server's init and main functions
		2256
		2257	sub init_resources {
		2258	load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir
		2259	or die "unable to load regions file\n";#d#
		2260	}
1985		2261
1986	sub cfg_load {	2262	sub cfg_load {
1987	open my $fh, "<:utf8", cf::confdir . "/config"	2263	open my $fh, "<:utf8", cf::confdir . "/config"
1988	or return;	2264	or return;
1989		2265
1990	local $/;	2266	local $/;
1991	*CFG = YAML::Syck::Load <$fh>;	2267	*CFG = YAML::Syck::Load <$fh>;
1992		2268
1993	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	2269	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
1994		2270
		2271	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2272	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2273
1995	if (exists $CFG{mlockall}) {	2274	if (exists $CFG{mlockall}) {
1996	eval {	2275	eval {
1997	$CFG{mlockall} ? &mlockall : &munlockall	2276	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
1998	and die "WARNING: m(un)lockall failed: $!\n";	2277	and die "WARNING: m(un)lockall failed: $!\n";
1999	};	2278	};
2000	warn $@ if $@;	2279	warn $@ if $@;
2001	}	2280	}
		2281	}
		2282
		2283	sub init {
		2284	init_resources;
2002	}	2285	}
2003		2286
2004	sub main {	2287	sub main {
2005	# we must not ever block the main coroutine	2288	# we must not ever block the main coroutine
2006	local $Coro::idle = sub {	2289	local $Coro::idle = sub {
2007	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	2290	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2008	(Coro::unblock_sub {	2291	(async {
2009	Event::one_event;	2292	Event::one_event;
2010	})->();	2293	})->prio (Coro::PRIO_MAX);
2011	};	2294	};
2012		2295
2013	cfg_load;	2296	cfg_load;
2014	db_load;	2297	db_init;
2015	load_extensions;	2298	load_extensions;
		2299
		2300	$TICK_WATCHER->start;
2016	Event::loop;	2301	Event::loop;
2017	}	2302	}
2018		2303
2019	#############################################################################	2304	#############################################################################
2020	# initialisation	2305	# initialisation and cleanup
		2306
		2307	# install some emergency cleanup handlers
		2308	BEGIN {
		2309	for my $signal (qw(INT HUP TERM)) {
		2310	Event->signal (
		2311	reentrant => 0,
		2312	data => WF_AUTOCANCEL,
		2313	signal => $signal,
		2314	prio => 0,
		2315	cb => sub {
		2316	cf::cleanup "SIG$signal";
		2317	},
		2318	);
		2319	}
		2320	}
		2321
		2322	sub emergency_save() {
		2323	my $freeze_guard = cf::freeze_mainloop;
		2324
		2325	warn "enter emergency perl save\n";
		2326
		2327	cf::sync_job {
		2328	# use a peculiar iteration method to avoid tripping on perl
		2329	# refcount bugs in for. also avoids problems with players
		2330	# and maps saved/destroyed asynchronously.
		2331	warn "begin emergency player save\n";
		2332	for my $login (keys %cf::PLAYER) {
		2333	my $pl = $cf::PLAYER{$login} or next;
		2334	$pl->valid or next;
		2335	$pl->save;
		2336	}
		2337	warn "end emergency player save\n";
		2338
		2339	warn "begin emergency map save\n";
		2340	for my $path (keys %cf::MAP) {
		2341	my $map = $cf::MAP{$path} or next;
		2342	$map->valid or next;
		2343	$map->save;
		2344	}
		2345	warn "end emergency map save\n";
		2346
		2347	warn "begin emergency database checkpoint\n";
		2348	BDB::db_env_txn_checkpoint $DB_ENV;
		2349	warn "end emergency database checkpoint\n";
		2350	};
		2351
		2352	warn "leave emergency perl save\n";
		2353	}
		2354
		2355	sub post_cleanup {
		2356	my ($make_core) = @_;
		2357
		2358	warn Carp::longmess "post_cleanup backtrace"
		2359	if $make_core;
		2360	}
2021		2361
2022	sub reload() {	2362	sub reload() {
2023	# can/must only be called in main	2363	# can/must only be called in main
2024	if ($Coro::current != $Coro::main) {	2364	if ($Coro::current != $Coro::main) {
2025	warn "can only reload from main coroutine\n";	2365	warn "can only reload from main coroutine";
2026	return;	2366	return;
2027	}	2367	}
2028		2368
2029	warn "reloading...";	2369	warn "reloading...";
2030		2370
2031	my $guard = freeze_mainloop;	2371	warn "entering sync_job";
		2372
		2373	cf::sync_job {
		2374	cf::write_runtime; # external watchdog should not bark
2032	cf::emergency_save;	2375	cf::emergency_save;
		2376	cf::write_runtime; # external watchdog should not bark
2033		2377
2034	eval {	2378	warn "syncing database to disk";
		2379	BDB::db_env_txn_checkpoint $DB_ENV;
		2380
2035	# if anything goes wrong in here, we should simply crash as we already saved	2381	# if anything goes wrong in here, we should simply crash as we already saved
2036		2382
2037	# cancel all watchers	2383	warn "cancelling all WF_AUTOCANCEL watchers";
2038	for (Event::all_watchers) {	2384	for (Event::all_watchers) {
2039	$_->cancel if $_->data & WF_AUTOCANCEL;	2385	$_->cancel if $_->data & WF_AUTOCANCEL;
2040	}	2386	}
2041		2387
		2388	warn "flushing outstanding aio requests";
		2389	for (;;) {
		2390	BDB::flush;
		2391	IO::AIO::flush;
		2392	Coro::cede;
		2393	last unless IO::AIO::nreqs || BDB::nreqs;
		2394	warn "iterate...";
		2395	}
		2396
2042	# cancel all extension coros	2397	warn "cancelling all extension coros";
2043	$_->cancel for values %EXT_CORO;	2398	$_->cancel for values %EXT_CORO;
2044	%EXT_CORO = ();	2399	%EXT_CORO = ();
2045		2400
2046	# unload all extensions	2401	warn "removing commands";
2047	for (@exts) {	2402	%COMMAND = ();
		2403
		2404	warn "removing ext commands";
		2405	%EXTCMD = ();
		2406
		2407	warn "unloading/nuking all extensions";
		2408	for my $pkg (@EXTS) {
2048	warn "unloading <$_>";	2409	warn "... unloading $pkg";
2049	unload_extension $_;	2410
		2411	if (my $cb = $pkg->can ("unload")) {
		2412	eval {
		2413	$cb->($pkg);
		2414	1
		2415	} or warn "$pkg unloaded, but with errors: $@";
2050	}	2416	}
2051		2417
		2418	warn "... nuking $pkg";
		2419	Symbol::delete_package $pkg;
		2420	}
		2421
2052	# unload all modules loaded from $LIBDIR	2422	warn "unloading all perl modules loaded from $LIBDIR";
2053	while (my ($k, $v) = each %INC) {	2423	while (my ($k, $v) = each %INC) {
2054	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2424	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2055		2425
2056	warn "removing <$k>";	2426	warn "... unloading $k";
2057	delete $INC{$k};	2427	delete $INC{$k};
2058		2428
2059	$k =~ s/\.pm$//;	2429	$k =~ s/\.pm$//;
2060	$k =~ s/\//::/g;	2430	$k =~ s/\//::/g;
2061		2431
…		…
2064	}	2434	}
2065		2435
2066	Symbol::delete_package $k;	2436	Symbol::delete_package $k;
2067	}	2437	}
2068		2438
2069	# sync database to disk
2070	cf::db_sync;
2071	IO::AIO::flush;
2072
2073	# get rid of safe::, as good as possible	2439	warn "getting rid of safe::, as good as possible";
2074	Symbol::delete_package "safe::$_"	2440	Symbol::delete_package "safe::$_"
2075	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2441	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2076		2442
2077	# remove register_script_function callbacks
2078	# TODO
2079
2080	# unload cf.pm "a bit"	2443	warn "unloading cf.pm \"a bit\"";
2081	delete $INC{"cf.pm"};	2444	delete $INC{"cf.pm"};
2082		2445
2083	# don't, removes xs symbols, too,	2446	# don't, removes xs symbols, too,
2084	# and global variables created in xs	2447	# and global variables created in xs
2085	#Symbol::delete_package __PACKAGE__;	2448	#Symbol::delete_package __PACKAGE__;
2086		2449
2087	# reload cf.pm	2450	warn "unload completed, starting to reload now";
		2451
2088	warn "reloading cf.pm";	2452	warn "reloading cf.pm";
2089	require cf;	2453	require cf;
2090	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	2454	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2091		2455
2092	# load config and database again	2456	warn "loading config and database again";
2093	cf::cfg_load;	2457	cf::cfg_load;
2094	cf::db_load;
2095		2458
2096	# load extensions
2097	warn "load extensions";	2459	warn "loading extensions";
2098	cf::load_extensions;	2460	cf::load_extensions;
2099		2461
2100	# reattach attachments to objects	2462	warn "reattaching attachments to objects/players";
2101	warn "reattach";
2102	_global_reattach;	2463	_global_reattach;
2103	};	2464	warn "reattaching attachments to maps";
		2465	reattach $_ for values %MAP;
2104		2466
2105	if ($@) {	2467	warn "loading reloadable resources";
		2468	init_resources;
		2469
		2470	warn "leaving sync_job";
		2471
		2472	1
		2473	} or do {
2106	warn $@;	2474	warn $@;
2107	warn "error while reloading, exiting.";	2475	warn "error while reloading, exiting.";
2108	exit 1;	2476	exit 1;
2109	}	2477	};
2110		2478
2111	warn "reloaded successfully";	2479	warn "reloaded";
2112	};	2480	};
2113		2481
2114	#############################################################################	2482	our $RELOAD_WATCHER; # used only during reload
2115
2116	unless ($LINK_MAP) {
2117	$LINK_MAP = cf::map::new;
2118
2119	$LINK_MAP->width (41);
2120	$LINK_MAP->height (41);
2121	$LINK_MAP->alloc;
2122	$LINK_MAP->path ("{link}");
2123	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2124	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2125
2126	# dirty hack because... archetypes are not yet loaded
2127	Event->timer (
2128	after => 2,
2129	cb => sub {
2130	$_[0]->w->cancel;
2131
2132	# provide some exits "home"
2133	my $exit = cf::object::new "exit";
2134
2135	$exit->slaying ($EMERGENCY_POSITION->[0]);
2136	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2137	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2138
2139	$LINK_MAP->insert ($exit->clone, 19, 19);
2140	$LINK_MAP->insert ($exit->clone, 19, 20);
2141	$LINK_MAP->insert ($exit->clone, 19, 21);
2142	$LINK_MAP->insert ($exit->clone, 20, 19);
2143	$LINK_MAP->insert ($exit->clone, 20, 21);
2144	$LINK_MAP->insert ($exit->clone, 21, 19);
2145	$LINK_MAP->insert ($exit->clone, 21, 20);
2146	$LINK_MAP->insert ($exit->clone, 21, 21);
2147
2148	$exit->destroy;
2149	});
2150
2151	$LINK_MAP->{deny_save} = 1;
2152	$LINK_MAP->{deny_reset} = 1;
2153
2154	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2155	}
2156
2157	register "<global>", __PACKAGE__;
2158		2483
2159	register_command "reload" => sub {	2484	register_command "reload" => sub {
2160	my ($who, $arg) = @_;	2485	my ($who, $arg) = @_;
2161		2486
2162	if ($who->flag (FLAG_WIZ)) {	2487	if ($who->flag (FLAG_WIZ)) {
2163	$who->message ("start of reload.");	2488	$who->message ("reloading server.");
		2489
		2490	# doing reload synchronously and two reloads happen back-to-back,
		2491	# coro crashes during coro_state_free->destroy here.
		2492
		2493	$RELOAD_WATCHER ||= Event->timer (
		2494	reentrant => 0,
		2495	after => 0,
		2496	data => WF_AUTOCANCEL,
		2497	cb => sub {
2164	reload;	2498	reload;
2165	$who->message ("end of reload.");	2499	undef $RELOAD_WATCHER;
		2500	},
		2501	);
2166	}	2502	}
2167	};	2503	};
2168		2504
2169	unshift @INC, $LIBDIR;	2505	unshift @INC, $LIBDIR;
		2506
		2507	my $bug_warning = 0;
2170		2508
2171	$TICK_WATCHER = Event->timer (	2509	$TICK_WATCHER = Event->timer (
2172	reentrant => 0,	2510	reentrant => 0,
		2511	parked => 1,
2173	prio => 0,	2512	prio => 0,
2174	at => $NEXT_TICK || $TICK,	2513	at => $NEXT_TICK || $TICK,
2175	data => WF_AUTOCANCEL,	2514	data => WF_AUTOCANCEL,
2176	cb => sub {	2515	cb => sub {
		2516	if ($Coro::current != $Coro::main) {
		2517	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		2518	unless ++$bug_warning > 10;
		2519	return;
		2520	}
		2521
		2522	$NOW = Event::time;
		2523
2177	cf::server_tick; # one server iteration	2524	cf::server_tick; # one server iteration
2178	$RUNTIME += $TICK;	2525	$RUNTIME += $TICK;
2179	$NEXT_TICK += $TICK;	2526	$NEXT_TICK += $TICK;
		2527
		2528	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		2529	$NEXT_RUNTIME_WRITE = $NOW + 10;
		2530	Coro::async_pool {
		2531	write_runtime
		2532	or warn "ERROR: unable to write runtime file: $!";
		2533	};
		2534	}
		2535
		2536	$WAIT_FOR_TICK->broadcast;
		2537	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
		2538
		2539	# my $AFTER = Event::time;
		2540	# warn $AFTER - $NOW;#d#
2180		2541
2181	# if we are delayed by four ticks or more, skip them all	2542	# if we are delayed by four ticks or more, skip them all
2182	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	2543	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2183		2544
2184	$TICK_WATCHER->at ($NEXT_TICK);	2545	$TICK_WATCHER->at ($NEXT_TICK);
2185	$TICK_WATCHER->start;	2546	$TICK_WATCHER->start;
2186	},	2547	},
2187	);	2548	);
2188		2549
		2550	{
2189	IO::AIO::max_poll_time $TICK * 0.2;	2551	BDB::max_poll_time $TICK * 0.1;
2190		2552	$BDB_POLL_WATCHER = Event->io (
2191	Event->io (	2553	reentrant => 0,
2192	fd => IO::AIO::poll_fileno,	2554	fd => BDB::poll_fileno,
2193	poll => 'r',	2555	poll => 'r',
2194	prio => 5,	2556	prio => 0,
2195	data => WF_AUTOCANCEL,
2196	cb => \&IO::AIO::poll_cb,
2197	);
2198
2199	Event->timer (
2200	data => WF_AUTOCANCEL,	2557	data => WF_AUTOCANCEL,
2201	after => 0,	2558	cb => \&BDB::poll_cb,
2202	interval => 10,	2559	);
2203	cb => sub {	2560	BDB::min_parallel 8;
2204	(Coro::unblock_sub {	2561
2205	write_runtime	2562	BDB::set_sync_prepare {
2206	or warn "ERROR: unable to write runtime file: $!";	2563	my $status;
		2564	my $current = $Coro::current;
		2565	(
		2566	sub {
		2567	$status = $!;
		2568	$current->ready; undef $current;
		2569	},
		2570	sub {
		2571	Coro::schedule while defined $current;
		2572	$! = $status;
		2573	},
		2574	)
		2575	};
		2576
		2577	unless ($DB_ENV) {
		2578	$DB_ENV = BDB::db_env_create;
		2579
		2580	cf::sync_job {
		2581	eval {
		2582	BDB::db_env_open
		2583	$DB_ENV,
		2584	$BDB_ENV_DIR,
		2585	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		2586	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		2587	0666;
		2588
		2589	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;
		2590
		2591	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		2592	$DB_ENV->set_lk_detect;
		2593	};
		2594
		2595	cf::cleanup "db_env_open(db): $@" if $@;
2207	})->();	2596	};
2208	},	2597	}
2209	);	2598	}
		2599
		2600	{
		2601	IO::AIO::min_parallel 8;
		2602
		2603	undef $Coro::AIO::WATCHER;
		2604	IO::AIO::max_poll_time $TICK * 0.1;
		2605	$AIO_POLL_WATCHER = Event->io (
		2606	reentrant => 0,
		2607	data => WF_AUTOCANCEL,
		2608	fd => IO::AIO::poll_fileno,
		2609	poll => 'r',
		2610	prio => 6,
		2611	cb => \&IO::AIO::poll_cb,
		2612	);
		2613	}
2210		2614
2211	END { cf::emergency_save }	2615	END { cf::emergency_save }
2212		2616
2213	1	2617	1
2214		2618

Diff Legend

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