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.154 by root, Tue Jan 9 15:36:19 2007 UTC vs.
Revision 1.235 by root, Tue Apr 10 09:35:23 2007 UTC

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

Diff Legend

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