ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.151 by root, Mon Jan 8 20:59:15 2007 UTC vs.
Revision 1.187 by root, Sat Jan 20 21:06:52 2007 UTC

8use Storable; 8use Storable;
9use Opcode; 9use Opcode;
10use Safe; 10use Safe;
11use Safe::Hole; 11use Safe::Hole;
12 12
13use Coro 3.3 (); 13use Coro 3.4 ();
14use Coro::Event; 14use Coro::Event;
15use Coro::Timer; 15use Coro::Timer;
16use Coro::Signal; 16use Coro::Signal;
17use Coro::Semaphore; 17use Coro::Semaphore;
18use Coro::AIO; 18use Coro::AIO;
19 19
20use Data::Dumper;
20use Digest::MD5; 21use Digest::MD5;
21use Fcntl; 22use Fcntl;
22use IO::AIO 2.32 (); 23use IO::AIO 2.32 ();
23use YAML::Syck (); 24use YAML::Syck ();
24use Time::HiRes; 25use Time::HiRes;
25 26
26use Event; $Event::Eval = 1; # no idea why this is required, but it is 27use Event; $Event::Eval = 1; # no idea why this is required, but it is
27 28
29sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30
28# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 31# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
29$YAML::Syck::ImplicitUnicode = 1; 32$YAML::Syck::ImplicitUnicode = 1;
30 33
31$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority 34$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
32 35
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34
35our %COMMAND = (); 36our %COMMAND = ();
36our %COMMAND_TIME = (); 37our %COMMAND_TIME = ();
38
39our @EXTS = (); # list of extension package names
37our %EXTCMD = (); 40our %EXTCMD = ();
41our %EXT_CORO = (); # coroutines bound to extensions
42our %EXT_MAP = (); # pluggable maps
38 43
39our @EVENT; 44our @EVENT;
40our $LIBDIR = datadir . "/ext"; 45our $LIBDIR = datadir . "/ext";
41 46
42our $TICK = MAX_TIME * 1e-6; 47our $TICK = MAX_TIME * 1e-6;
43our $TICK_WATCHER; 48our $TICK_WATCHER;
49our $AIO_POLL_WATCHER;
50our $WRITE_RUNTIME_WATCHER;
44our $NEXT_TICK; 51our $NEXT_TICK;
45our $NOW; 52our $NOW;
46 53
47our %CFG; 54our %CFG;
48 55
49our $UPTIME; $UPTIME ||= time; 56our $UPTIME; $UPTIME ||= time;
50our $RUNTIME; 57our $RUNTIME;
51 58
52our %PLAYER; # all users 59our %PLAYER; # all users
53our %MAP; # all maps 60our %MAP; # all maps
54our $LINK_MAP; # the special {link} map 61our $LINK_MAP; # the special {link} map, which is always available
55our $RANDOM_MAPS = cf::localdir . "/random"; 62our $RANDOM_MAPS = cf::localdir . "/random";
56our %EXT_CORO; # coroutines bound to extensions 63
64our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
65our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
66
67# used to convert map paths into valid unix filenames by replacing / by ∕
68our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
57 69
58binmode STDOUT; 70binmode STDOUT;
59binmode STDERR; 71binmode STDERR;
60 72
61# read virtual server time, if available 73# read virtual server time, if available
69mkdir cf::localdir . "/" . cf::playerdir; 81mkdir cf::localdir . "/" . cf::playerdir;
70mkdir cf::localdir . "/" . cf::tmpdir; 82mkdir cf::localdir . "/" . cf::tmpdir;
71mkdir cf::localdir . "/" . cf::uniquedir; 83mkdir cf::localdir . "/" . cf::uniquedir;
72mkdir $RANDOM_MAPS; 84mkdir $RANDOM_MAPS;
73 85
74# a special map that is always available
75our $LINK_MAP;
76our $EMERGENCY_POSITION; 86our $EMERGENCY_POSITION;
77 87
78############################################################################# 88#############################################################################
79 89
80=head2 GLOBAL VARIABLES 90=head2 GLOBAL VARIABLES
105 115
106=item %cf::CFG 116=item %cf::CFG
107 117
108Configuration for the server, loaded from C</etc/crossfire/config>, or 118Configuration for the server, loaded from C</etc/crossfire/config>, or
109from wherever your confdir points to. 119from wherever your confdir points to.
120
121=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
122
123These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
124or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
125processing has been done. Call C<< ->wait >> on them to maximise the
126window of cpu time available, or simply to synchronise to the server tick.
110 127
111=back 128=back
112 129
113=cut 130=cut
114 131
146 163
147$Event::DIED = sub { 164$Event::DIED = sub {
148 warn "error in event callback: @_"; 165 warn "error in event callback: @_";
149}; 166};
150 167
151my %ext_pkg;
152my @exts;
153my @hook;
154
155=head2 UTILITY FUNCTIONS 168=head2 UTILITY FUNCTIONS
156 169
157=over 4 170=over 4
158 171
172=item dumpval $ref
173
159=cut 174=cut
175
176sub dumpval {
177 eval {
178 local $SIG{__DIE__};
179 my $d;
180 if (1) {
181 $d = new Data::Dumper([$_[0]], ["*var"]);
182 $d->Terse(1);
183 $d->Indent(2);
184 $d->Quotekeys(0);
185 $d->Useqq(1);
186 #$d->Bless(...);
187 $d->Seen($_[1]) if @_ > 1;
188 $d = $d->Dump();
189 }
190 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
191 $d
192 } || "[unable to dump $_[0]: '$@']";
193}
160 194
161use JSON::Syck (); # TODO# replace by JSON::PC once working 195use JSON::Syck (); # TODO# replace by JSON::PC once working
162 196
163=item $ref = cf::from_json $json 197=item $ref = cf::from_json $json
164 198
225} 259}
226 260
227sub freeze_mainloop { 261sub freeze_mainloop {
228 return unless $TICK_WATCHER->is_active; 262 return unless $TICK_WATCHER->is_active;
229 263
230 my $guard = Coro::guard { $TICK_WATCHER->start }; 264 my $guard = Coro::guard {
265 $TICK_WATCHER->start;
266 $WRITE_RUNTIME_WATCHER->start;
267 };
268 $WRITE_RUNTIME_WATCHER->stop;
231 $TICK_WATCHER->stop; 269 $TICK_WATCHER->stop;
232 $guard 270 $guard
233} 271}
234 272
235=item cf::async { BLOCK } 273=item cf::async { BLOCK }
287 } 325 }
288} 326}
289 327
290=item $coro = cf::async_ext { BLOCK } 328=item $coro = cf::async_ext { BLOCK }
291 329
292Like async, but this coro is automcatially being canceled when the 330Like async, but this coro is automatically being canceled when the
293extension calling this is being unloaded. 331extension calling this is being unloaded.
294 332
295=cut 333=cut
296 334
297sub async_ext(&) { 335sub async_ext(&) {
311 my $runtime = cf::localdir . "/runtime"; 349 my $runtime = cf::localdir . "/runtime";
312 350
313 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 351 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
314 or return; 352 or return;
315 353
354 my $value = $cf::RUNTIME + 90 + 10;
316 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 355 # 10 is the runtime save interval, for a monotonic clock
356 # 60 allows for the watchdog to kill the server.
357
317 (aio_write $fh, 0, (length $value), $value, 0) <= 0 358 (aio_write $fh, 0, (length $value), $value, 0) <= 0
318 and return; 359 and return;
319 360
320 aio_fsync $fh 361 aio_fsync $fh
321 and return; 362 and return;
330} 371}
331 372
332=back 373=back
333 374
334=cut 375=cut
335
336#############################################################################
337
338package cf::path;
339
340sub new {
341 my ($class, $path, $base) = @_;
342
343 $path = $path->as_string if ref $path;
344
345 my $self = bless { }, $class;
346
347 # {... are special paths that are not touched
348 # ?xxx/... are special absolute paths
349 # ?random/... random maps
350 # /! non-realised random map exit
351 # /... normal maps
352 # ~/... per-player maps without a specific player (DO NOT USE)
353 # ~user/... per-player map of a specific user
354
355 if ($path =~ /^{/) {
356 # fine as it is
357 } elsif ($path =~ s{^\?random/}{}) {
358 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
359 $self->{random} = cf::from_json $data;
360 } else {
361 if ($path =~ s{^~([^/]+)?}{}) {
362 $self->{user_rel} = 1;
363
364 if (defined $1) {
365 $self->{user} = $1;
366 } elsif ($base =~ m{^~([^/]+)/}) {
367 $self->{user} = $1;
368 } else {
369 warn "cannot resolve user-relative path without user <$path,$base>\n";
370 }
371 } elsif ($path =~ /^\//) {
372 # already absolute
373 } else {
374 $base =~ s{[^/]+/?$}{};
375 return $class->new ("$base/$path");
376 }
377
378 for ($path) {
379 redo if s{/\.?/}{/};
380 redo if s{/[^/]+/\.\./}{/};
381 }
382 }
383
384 $self->{path} = $path;
385
386 $self
387}
388
389# the name / primary key / in-game path
390sub as_string {
391 my ($self) = @_;
392
393 $self->{user_rel} ? "~$self->{user}$self->{path}"
394 : $self->{random} ? "?random/$self->{path}"
395 : $self->{path}
396}
397
398# the displayed name, this is a one way mapping
399sub visible_name {
400 my ($self) = @_;
401
402# if (my $rmp = $self->{random}) {
403# # todo: be more intelligent about this
404# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
405# } else {
406 $self->as_string
407# }
408}
409
410# escape the /'s in the path
411sub _escaped_path {
412 # ∕ is U+2215
413 (my $path = $_[0]{path}) =~ s/\//∕/g;
414 $path
415}
416
417# the original (read-only) location
418sub load_path {
419 my ($self) = @_;
420
421 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
422}
423
424# the temporary/swap location
425sub save_path {
426 my ($self) = @_;
427
428 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
429 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
430 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
431}
432
433# the unique path, might be eq to save_path
434sub uniq_path {
435 my ($self) = @_;
436
437 $self->{user_rel} || $self->{random}
438 ? undef
439 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
440}
441
442# return random map parameters, or undef
443sub random_map_params {
444 my ($self) = @_;
445
446 $self->{random}
447}
448
449# this is somewhat ugly, but style maps do need special treatment
450sub is_style_map {
451 $_[0]{path} =~ m{^/styles/}
452}
453
454package cf;
455 376
456############################################################################# 377#############################################################################
457 378
458=head2 ATTACHABLE OBJECTS 379=head2 ATTACHABLE OBJECTS
459 380
585our @CB_TYPE = (); # registry for type (cf-object class) based events 506our @CB_TYPE = (); # registry for type (cf-object class) based events
586our @CB_MAP = (); 507our @CB_MAP = ();
587 508
588my %attachment; 509my %attachment;
589 510
511sub cf::attachable::thawer_merge {
512 # simply override everything except _meta
513 local $_[0]{_meta};
514 %{$_[0]} = %{$_[1]};
515}
516
590sub _attach_cb($$$$) { 517sub _attach_cb($$$$) {
591 my ($registry, $event, $prio, $cb) = @_; 518 my ($registry, $event, $prio, $cb) = @_;
592 519
593 use sort 'stable'; 520 use sort 'stable';
594 521
765# object support 692# object support
766 693
767sub reattach { 694sub reattach {
768 # basically do the same as instantiate, without calling instantiate 695 # basically do the same as instantiate, without calling instantiate
769 my ($obj) = @_; 696 my ($obj) = @_;
697
698 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
770 699
771 my $registry = $obj->registry; 700 my $registry = $obj->registry;
772 701
773 @$registry = (); 702 @$registry = ();
774 703
906=cut 835=cut
907 836
908sub register_extcmd { 837sub register_extcmd {
909 my ($name, $cb) = @_; 838 my ($name, $cb) = @_;
910 839
911 my $caller = caller;
912 #warn "registering extcmd '$name' to '$caller'";
913
914 $EXTCMD{$name} = [$cb, $caller]; 840 $EXTCMD{$name} = $cb;
915} 841}
916 842
917cf::player->attach ( 843cf::player->attach (
918 on_command => sub { 844 on_command => sub {
919 my ($pl, $name, $params) = @_; 845 my ($pl, $name, $params) = @_;
932 858
933 my $msg = eval { from_json $buf }; 859 my $msg = eval { from_json $buf };
934 860
935 if (ref $msg) { 861 if (ref $msg) {
936 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 862 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
937 if (my %reply = $cb->[0]->($pl, $msg)) { 863 if (my %reply = $cb->($pl, $msg)) {
938 $pl->ext_reply ($msg->{msgid}, %reply); 864 $pl->ext_reply ($msg->{msgid}, %reply);
939 } 865 }
940 } 866 }
941 } else { 867 } else {
942 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 868 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
944 870
945 cf::override; 871 cf::override;
946 }, 872 },
947); 873);
948 874
949sub register {
950 my ($base, $pkg) = @_;
951
952 #TODO
953}
954
955sub load_extension { 875sub load_extension {
956 my ($path) = @_; 876 my ($path) = @_;
957 877
958 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 878 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
959 my $base = $1; 879 my $base = $1;
960 my $pkg = $1; 880 my $pkg = $1;
961 $pkg =~ s/[^[:word:]]/_/g; 881 $pkg =~ s/[^[:word:]]/_/g;
962 $pkg = "ext::$pkg"; 882 $pkg = "ext::$pkg";
963 883
964 warn "loading '$path' into '$pkg'\n"; 884 warn "... loading '$path' into '$pkg'\n";
965 885
966 open my $fh, "<:utf8", $path 886 open my $fh, "<:utf8", $path
967 or die "$path: $!"; 887 or die "$path: $!";
968 888
969 my $source = 889 my $source =
970 "package $pkg; use strict; use utf8;\n" 890 "package $pkg; use strict; use utf8;\n"
971 . "#line 1 \"$path\"\n{\n" 891 . "#line 1 \"$path\"\n{\n"
972 . (do { local $/; <$fh> }) 892 . (do { local $/; <$fh> })
973 . "\n};\n1"; 893 . "\n};\n1";
974 894
975 eval $source 895 unless (eval $source) {
976 or die $@ ? "$path: $@\n" 896 my $msg = $@ ? "$path: $@\n"
977 : "extension disabled.\n"; 897 : "extension disabled.\n";
978 898 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
979 push @exts, $pkg; 899 warn $@;
980 $ext_pkg{$base} = $pkg; 900 warn "mandatory extension failed to load, exiting.\n";
981 901 exit 1;
982# no strict 'refs'; 902 }
983# @{"$pkg\::ISA"} = ext::; 903 die $@;
984
985 register $base, $pkg;
986}
987
988sub unload_extension {
989 my ($pkg) = @_;
990
991 warn "removing extension $pkg\n";
992
993 # remove hooks
994 #TODO
995# for my $idx (0 .. $#PLUGIN_EVENT) {
996# delete $hook[$idx]{$pkg};
997# } 904 }
998 905
999 # remove commands 906 push @EXTS, $pkg;
1000 for my $name (keys %COMMAND) {
1001 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1002
1003 if (@cb) {
1004 $COMMAND{$name} = \@cb;
1005 } else {
1006 delete $COMMAND{$name};
1007 }
1008 }
1009
1010 # remove extcmds
1011 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1012 delete $EXTCMD{$name};
1013 }
1014
1015 if (my $cb = $pkg->can ("unload")) {
1016 eval {
1017 $cb->($pkg);
1018 1
1019 } or warn "$pkg unloaded, but with errors: $@";
1020 }
1021
1022 Symbol::delete_package $pkg;
1023} 907}
1024 908
1025sub load_extensions { 909sub load_extensions {
1026 for my $ext (<$LIBDIR/*.ext>) { 910 for my $ext (<$LIBDIR/*.ext>) {
1027 next unless -r $ext; 911 next unless -r $ext;
1031 } or warn "$ext not loaded: $@"; 915 } or warn "$ext not loaded: $@";
1032 } 916 }
1033} 917}
1034 918
1035############################################################################# 919#############################################################################
1036# load/save/clean perl data associated with a map
1037
1038*cf::mapsupport::on_clean = sub {
1039 my ($map) = @_;
1040
1041 my $path = $map->tmpname;
1042 defined $path or return;
1043
1044 unlink "$path.pst";
1045};
1046
1047cf::map->attach (prio => -10000, package => cf::mapsupport::);
1048
1049#############################################################################
1050# load/save perl data associated with player->ob objects
1051
1052sub all_objects(@) {
1053 @_, map all_objects ($_->inv), @_
1054}
1055
1056# TODO: compatibility cruft, remove when no longer needed
1057cf::player->attach (
1058 on_load => sub {
1059 my ($pl, $path) = @_;
1060
1061 for my $o (all_objects $pl->ob) {
1062 if (my $value = $o->get_ob_key_value ("_perl_data")) {
1063 $o->set_ob_key_value ("_perl_data");
1064
1065 %$o = %{ Storable::thaw pack "H*", $value };
1066 }
1067 }
1068 },
1069);
1070
1071#############################################################################
1072 920
1073=head2 CORE EXTENSIONS 921=head2 CORE EXTENSIONS
1074 922
1075Functions and methods that extend core crossfire objects. 923Functions and methods that extend core crossfire objects.
1076 924
1077=cut 925=cut
1078 926
1079package cf::player; 927package cf::player;
928
929use Coro::AIO;
1080 930
1081=head3 cf::player 931=head3 cf::player
1082 932
1083=over 4 933=over 4
1084 934
1110 960
1111sub exists($) { 961sub exists($) {
1112 my ($login) = @_; 962 my ($login) = @_;
1113 963
1114 $cf::PLAYER{$login} 964 $cf::PLAYER{$login}
1115 or cf::sync_job { !aio_stat $login } 965 or cf::sync_job { !aio_stat path $login }
1116} 966}
1117 967
1118sub find($) { 968sub find($) {
1119 return $cf::PLAYER{$_[0]} || do { 969 return $cf::PLAYER{$_[0]} || do {
1120 my $login = $_[0]; 970 my $login = $_[0];
1137 my $path = path $pl; 987 my $path = path $pl;
1138 my $guard = cf::lock_acquire "user_save:$path"; 988 my $guard = cf::lock_acquire "user_save:$path";
1139 989
1140 return if $pl->{deny_save}; 990 return if $pl->{deny_save};
1141 991
1142 Coro::AIO::aio_mkdir playerdir $pl, 0770; 992 aio_mkdir playerdir $pl, 0770;
1143 $pl->{last_save} = $cf::RUNTIME; 993 $pl->{last_save} = $cf::RUNTIME;
1144 994
1145 $pl->save_pl ($path); 995 $pl->save_pl ($path);
1146 Coro::cede; 996 Coro::cede;
1147} 997}
1156 1006
1157 $cf::PLAYER{$login} = $self; 1007 $cf::PLAYER{$login} = $self;
1158 1008
1159 $self 1009 $self
1160} 1010}
1011
1012=item $pl->quit_character
1013
1014Nukes the player without looking back. If logged in, the connection will
1015be destroyed. May block for a long time.
1016
1017=cut
1161 1018
1162sub quit_character { 1019sub quit_character {
1163 my ($pl) = @_; 1020 my ($pl) = @_;
1164 1021
1165 $pl->{deny_save} = 1; 1022 $pl->{deny_save} = 1;
1170 $pl->invoke (cf::EVENT_PLAYER_QUIT); 1027 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1171 $pl->ns->destroy if $pl->ns; 1028 $pl->ns->destroy if $pl->ns;
1172 1029
1173 my $path = playerdir $pl; 1030 my $path = playerdir $pl;
1174 my $temp = "$path~$cf::RUNTIME~deleting~"; 1031 my $temp = "$path~$cf::RUNTIME~deleting~";
1175 Coro::AIO::aio_rename $path, $temp; 1032 aio_rename $path, $temp;
1176 delete $cf::PLAYER{$pl->ob->name}; 1033 delete $cf::PLAYER{$pl->ob->name};
1177 $pl->destroy; 1034 $pl->destroy;
1178 IO::AIO::aio_rmtree $temp; 1035 IO::AIO::aio_rmtree $temp;
1179} 1036}
1180 1037
1038=item cf::player::list_logins
1039
1040Returns am arrayref of all valid playernames in the system, can take a
1041while and may block, so not sync_job-capable, ever.
1042
1043=cut
1044
1045sub list_logins {
1046 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
1047 or return [];
1048
1049 my @logins;
1050
1051 for my $login (@$dirs) {
1052 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1053 aio_read $fh, 0, 512, my $buf, 0 or next;
1054 $buf !~ /^password -------------$/m or next; # official not-valid tag
1055
1056 utf8::decode $login;
1057 push @logins, $login;
1058 }
1059
1060 \@logins
1061}
1062
1063=item $player->maps
1064
1065Returns an arrayref of map paths that are private for this
1066player. May block.
1067
1068=cut
1069
1070sub maps($) {
1071 my ($pl) = @_;
1072
1073 my $files = aio_readdir playerdir $pl
1074 or return;
1075
1076 my @paths;
1077
1078 for (@$files) {
1079 utf8::decode $_;
1080 next if /\.(?:pl|pst)$/;
1081 next unless /^$PATH_SEP/o;
1082
1083 s/\.map$//;
1084 push @paths, "~" . $pl->ob->name . "/" . $_;
1085 }
1086
1087 \@paths
1088}
1089
1181=item $player->ext_reply ($msgid, $msgtype, %msg) 1090=item $player->ext_reply ($msgid, $msgtype, %msg)
1182 1091
1183Sends an ext reply to the player. 1092Sends an ext reply to the player.
1184 1093
1185=cut 1094=cut
1206package cf::map; 1115package cf::map;
1207 1116
1208use Fcntl; 1117use Fcntl;
1209use Coro::AIO; 1118use Coro::AIO;
1210 1119
1120use overload
1121 '""' => \&as_string,
1122 fallback => 1;
1123
1211our $MAX_RESET = 3600; 1124our $MAX_RESET = 3600;
1212our $DEFAULT_RESET = 3000; 1125our $DEFAULT_RESET = 3000;
1213 1126
1214sub generate_random_map { 1127sub generate_random_map {
1215 my ($path, $rmp) = @_; 1128 my ($self, $rmp) = @_;
1216
1217 # mit "rum" bekleckern, nicht 1129 # mit "rum" bekleckern, nicht
1218 cf::map::_create_random_map 1130 $self->_create_random_map (
1219 $path,
1220 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1131 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1221 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1132 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1222 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1133 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1223 $rmp->{exit_on_final_map}, 1134 $rmp->{exit_on_final_map},
1224 $rmp->{xsize}, $rmp->{ysize}, 1135 $rmp->{xsize}, $rmp->{ysize},
1225 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1136 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1226 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1137 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1227 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1138 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1228 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp}, 1139 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1229 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1140 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1230 (cf::region::find $rmp->{region}) 1141 (cf::region::find $rmp->{region}), $rmp->{custom}
1142 )
1143}
1144
1145=item cf::map->register ($regex, $prio)
1146
1147Register a handler for the map path matching the given regex at the
1148givne priority (higher is better, built-in handlers have priority 0, the
1149default).
1150
1151=cut
1152
1153sub register {
1154 my (undef, $regex, $prio) = @_;
1155 my $pkg = caller;
1156
1157 no strict;
1158 push @{"$pkg\::ISA"}, __PACKAGE__;
1159
1160 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1161}
1162
1163# also paths starting with '/'
1164$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1165
1166sub thawer_merge {
1167 my ($self, $merge) = @_;
1168
1169 # we have to keep some variables in memory intact
1170 local $self->{path};
1171 local $self->{load_path};
1172 local $self->{deny_save};
1173 local $self->{deny_reset};
1174
1175 $self->SUPER::thawer_merge ($merge);
1176}
1177
1178sub normalise {
1179 my ($path, $base) = @_;
1180
1181 # map plan:
1182 #
1183 # /! non-realised random map exit (special hack!)
1184 # {... are special paths that are not being touched
1185 # ?xxx/... are special absolute paths
1186 # ?random/... random maps
1187 # /... normal maps
1188 # ~user/... per-player map of a specific user
1189
1190 $path =~ s/$PATH_SEP/\//go;
1191
1192 # treat it as relative path if it starts with
1193 # something that looks reasonable
1194 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1195 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1196
1197 $base =~ s{[^/]+/?$}{};
1198 $path = "$base/$path";
1199 }
1200
1201 for ($path) {
1202 redo if s{//}{/};
1203 redo if s{/\.?/}{/};
1204 redo if s{/[^/]+/\.\./}{/};
1205 }
1206
1207 $path
1208}
1209
1210sub new_from_path {
1211 my (undef, $path, $base) = @_;
1212
1213 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1214
1215 $path = normalise $path, $base;
1216
1217 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1218 if ($path =~ $EXT_MAP{$pkg}[1]) {
1219 my $self = bless cf::map::new, $pkg;
1220 $self->{path} = $path; $self->path ($path);
1221 $self->init; # pass $1 etc.
1222 return $self;
1223 }
1224 }
1225
1226 Carp::carp "unable to resolve path '$path'.";
1227 ()
1228}
1229
1230sub init {
1231 my ($self) = @_;
1232
1233 $self
1234}
1235
1236sub as_string {
1237 my ($self) = @_;
1238
1239 "$self->{path}"
1240}
1241
1242# the displayed name, this is a one way mapping
1243sub visible_name {
1244 &as_string
1245}
1246
1247# the original (read-only) location
1248sub load_path {
1249 my ($self) = @_;
1250
1251 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
1252}
1253
1254# the temporary/swap location
1255sub save_path {
1256 my ($self) = @_;
1257
1258 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1259 sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path
1260}
1261
1262# the unique path, undef == no special unique path
1263sub uniq_path {
1264 my ($self) = @_;
1265
1266 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1267 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
1231} 1268}
1232 1269
1233# and all this just because we cannot iterate over 1270# and all this just because we cannot iterate over
1234# all maps in C++... 1271# all maps in C++...
1235sub change_all_map_light { 1272sub change_all_map_light {
1237 1274
1238 $_->change_map_light ($change) 1275 $_->change_map_light ($change)
1239 for grep $_->outdoor, values %cf::MAP; 1276 for grep $_->outdoor, values %cf::MAP;
1240} 1277}
1241 1278
1279sub unlink_save {
1280 my ($self) = @_;
1281
1282 utf8::encode (my $save = $self->save_path);
1283 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1284 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1285}
1286
1242sub try_load_header($) { 1287sub load_header_from($) {
1243 my ($path) = @_; 1288 my ($self, $path) = @_;
1244 1289
1245 utf8::encode $path; 1290 utf8::encode $path;
1246 aio_open $path, O_RDONLY, 0 1291 aio_open $path, O_RDONLY, 0
1247 or return; 1292 or return;
1248 1293
1249 my $map = cf::map::new 1294 $self->_load_header ($path)
1250 or return; 1295 or return;
1251 1296
1252 # for better error messages only, will be overwritten 1297 $self->{load_path} = $path;
1253 $map->path ($path);
1254 1298
1255 $map->load_header ($path) 1299 1
1300}
1301
1302sub load_orig {
1303 my ($self) = @_;
1304
1305 $self->load_header_from ($self->load_path)
1306}
1307
1308sub load_temp {
1309 my ($self) = @_;
1310
1311 $self->load_header_from ($self->save_path)
1312}
1313
1314sub load_header {
1315 my ($self) = @_;
1316
1317 if ($self->load_temp) {
1318 $self->last_access ((delete $self->{last_access})
1319 || $cf::RUNTIME); #d#
1320 # safety
1321 $self->{instantiate_time} = $cf::RUNTIME
1322 if $self->{instantiate_time} > $cf::RUNTIME;
1323 } else {
1324 $self->load_orig
1256 or return; 1325 or return;
1257 1326
1258 $map->{load_path} = $path; 1327 $self->{load_original} = 1;
1328 $self->{instantiate_time} = $cf::RUNTIME;
1329 $self->last_access ($cf::RUNTIME);
1330 $self->instantiate;
1331 }
1259 1332
1260 $map 1333 1
1261} 1334}
1262 1335
1263sub find; 1336sub find;
1264sub find { 1337sub find {
1265 my ($path, $origin) = @_; 1338 my ($path, $origin) = @_;
1266 1339
1267 #warn "find<$path,$origin>\n";#d#
1268
1269 $path = new cf::path $path, $origin && $origin->path; 1340 $path = normalise $path, $origin && $origin->path;
1270 my $key = $path->as_string;
1271 1341
1272 cf::lock_wait "map_find:$key"; 1342 cf::lock_wait "map_find:$path";
1273 1343
1274 $cf::MAP{$key} || do { 1344 $cf::MAP{$path} || do {
1275 my $guard = cf::lock_acquire "map_find:$key"; 1345 my $guard = cf::lock_acquire "map_find:$path";
1276 1346 my $map = new_from_path cf::map $path
1277 # do it the slow way
1278 my $map = try_load_header $path->save_path;
1279
1280 Coro::cede;
1281
1282 if ($map) {
1283 $map->last_access ((delete $map->{last_access})
1284 || $cf::RUNTIME); #d#
1285 # safety
1286 $map->{instantiate_time} = $cf::RUNTIME
1287 if $map->{instantiate_time} > $cf::RUNTIME;
1288 } else {
1289 if (my $rmp = $path->random_map_params) {
1290 $map = generate_random_map $key, $rmp;
1291 } else {
1292 $map = try_load_header $path->load_path;
1293 }
1294
1295 $map or return; 1347 or return;
1296 1348
1297 $map->{load_original} = 1;
1298 $map->{instantiate_time} = $cf::RUNTIME;
1299 $map->last_access ($cf::RUNTIME);
1300 $map->instantiate;
1301
1302 # per-player maps become, after loading, normal maps
1303 $map->per_player (0) if $path->{user_rel};
1304 }
1305
1306 $map->path ($key);
1307 $map->{path} = $path;
1308 $map->{last_save} = $cf::RUNTIME; 1349 $map->{last_save} = $cf::RUNTIME;
1309 1350
1310 Coro::cede; 1351 $map->load_header
1352 or return;
1311 1353
1312 if ($map->should_reset) { 1354 if ($map->should_reset) {
1355 # doing this can freeze the server in a sync job, obviously
1356 #$cf::WAIT_FOR_TICK->wait;
1313 $map->reset; 1357 $map->reset;
1314 undef $guard; 1358 undef $guard;
1315 $map = find $path 1359 $map = find $path
1316 or return; 1360 or return;
1317 } 1361 }
1318 1362
1319 $cf::MAP{$key} = $map 1363 $cf::MAP{$path} = $map
1320 } 1364 }
1321} 1365}
1322 1366
1323sub load { 1367sub load {
1324 my ($self) = @_; 1368 my ($self) = @_;
1325 1369
1326 my $path = $self->{path}; 1370 my $path = $self->{path};
1327 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1371 my $guard = cf::lock_acquire "map_load:$path";
1328 1372
1329 return if $self->in_memory != cf::MAP_SWAPPED; 1373 return if $self->in_memory != cf::MAP_SWAPPED;
1330 1374
1331 $self->in_memory (cf::MAP_LOADING); 1375 $self->in_memory (cf::MAP_LOADING);
1332 1376
1333 $self->alloc; 1377 $self->alloc;
1334 $self->load_objects ($self->{load_path}, 1) 1378 $self->_load_objects ($self->{load_path}, 1)
1335 or return; 1379 or return;
1336 1380
1337 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1381 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1338 if delete $self->{load_original}; 1382 if delete $self->{load_original};
1339 1383
1340 if (my $uniq = $path->uniq_path) { 1384 if (my $uniq = $self->uniq_path) {
1341 utf8::encode $uniq; 1385 utf8::encode $uniq;
1342 if (aio_open $uniq, O_RDONLY, 0) { 1386 if (aio_open $uniq, O_RDONLY, 0) {
1343 $self->clear_unique_items; 1387 $self->clear_unique_items;
1344 $self->load_objects ($uniq, 0); 1388 $self->_load_objects ($uniq, 0);
1345 } 1389 }
1346 } 1390 }
1347 1391
1348 Coro::cede; 1392 Coro::cede;
1349 1393
1350 # now do the right thing for maps 1394 # now do the right thing for maps
1351 $self->link_multipart_objects; 1395 $self->link_multipart_objects;
1352 1396
1353 if ($self->{path}->is_style_map) { 1397 unless ($self->{deny_activate}) {
1354 $self->{deny_save} = 1; 1398 $self->decay_objects;
1355 $self->{deny_reset} = 1;
1356 } else {
1357 $self->fix_auto_apply; 1399 $self->fix_auto_apply;
1358 $self->decay_objects;
1359 $self->update_buttons; 1400 $self->update_buttons;
1401 Coro::cede;
1360 $self->set_darkness_map; 1402 $self->set_darkness_map;
1361 $self->difficulty ($self->estimate_difficulty) 1403 $self->difficulty ($self->estimate_difficulty)
1362 unless $self->difficulty; 1404 unless $self->difficulty;
1405 Coro::cede;
1363 $self->activate; 1406 $self->activate;
1364 } 1407 }
1365 1408
1366 Coro::cede;
1367
1368 $self->in_memory (cf::MAP_IN_MEMORY); 1409 $self->in_memory (cf::MAP_IN_MEMORY);
1410}
1411
1412sub customise_for {
1413 my ($self, $ob) = @_;
1414
1415 return find "~" . $ob->name . "/" . $self->{path}
1416 if $self->per_player;
1417
1418 $self
1419}
1420
1421# find and load all maps in the 3x3 area around a map
1422sub load_diag {
1423 my ($map) = @_;
1424
1425 my @diag; # diagonal neighbours
1426
1427 for (0 .. 3) {
1428 my $neigh = $map->tile_path ($_)
1429 or next;
1430 $neigh = find $neigh, $map
1431 or next;
1432 $neigh->load;
1433
1434 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1435 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1436 }
1437
1438 for (@diag) {
1439 my $neigh = find @$_
1440 or next;
1441 $neigh->load;
1442 }
1369} 1443}
1370 1444
1371sub find_sync { 1445sub find_sync {
1372 my ($path, $origin) = @_; 1446 my ($path, $origin) = @_;
1373 1447
1374 cf::sync_job { cf::map::find $path, $origin } 1448 cf::sync_job { find $path, $origin }
1375} 1449}
1376 1450
1377sub do_load_sync { 1451sub do_load_sync {
1378 my ($map) = @_; 1452 my ($map) = @_;
1379 1453
1380 cf::sync_job { $map->load }; 1454 cf::sync_job { $map->load };
1381} 1455}
1382 1456
1457our %MAP_PREFETCH;
1458our $MAP_PREFETCHER = undef;
1459
1460sub find_async {
1461 my ($path, $origin) = @_;
1462
1463 $path = normalise $path, $origin && $origin->{path};
1464
1465 if (my $map = $cf::MAP{$path}) {
1466 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1467 }
1468
1469 undef $MAP_PREFETCH{$path};
1470 $MAP_PREFETCHER ||= cf::async {
1471 while (%MAP_PREFETCH) {
1472 for my $path (keys %MAP_PREFETCH) {
1473 my $map = find $path
1474 or next;
1475 $map->load;
1476
1477 delete $MAP_PREFETCH{$path};
1478 }
1479 }
1480 undef $MAP_PREFETCHER;
1481 };
1482
1483 ()
1484}
1485
1383sub save { 1486sub save {
1384 my ($self) = @_; 1487 my ($self) = @_;
1385 1488
1386 my $lock = cf::lock_acquire "map_data:" . $self->path; 1489 my $lock = cf::lock_acquire "map_data:" . $self->path;
1387 1490
1388 $self->{last_save} = $cf::RUNTIME; 1491 $self->{last_save} = $cf::RUNTIME;
1389 1492
1390 return unless $self->dirty; 1493 return unless $self->dirty;
1391 1494
1392 my $save = $self->{path}->save_path; utf8::encode $save; 1495 my $save = $self->save_path; utf8::encode $save;
1393 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 1496 my $uniq = $self->uniq_path; utf8::encode $uniq;
1394 1497
1395 $self->{load_path} = $save; 1498 $self->{load_path} = $save;
1396 1499
1397 return if $self->{deny_save}; 1500 return if $self->{deny_save};
1398 1501
1401 cf::async { 1504 cf::async {
1402 $_->contr->save for $self->players; 1505 $_->contr->save for $self->players;
1403 }; 1506 };
1404 1507
1405 if ($uniq) { 1508 if ($uniq) {
1406 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 1509 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1407 $self->save_objects ($uniq, cf::IO_UNIQUES); 1510 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1408 } else { 1511 } else {
1409 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); 1512 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1410 } 1513 }
1411} 1514}
1412 1515
1413sub swap_out { 1516sub swap_out {
1414 my ($self) = @_; 1517 my ($self) = @_;
1428 1531
1429sub reset_at { 1532sub reset_at {
1430 my ($self) = @_; 1533 my ($self) = @_;
1431 1534
1432 # TODO: safety, remove and allow resettable per-player maps 1535 # TODO: safety, remove and allow resettable per-player maps
1433 return 1e99 if $self->{path}{user_rel}; 1536 return 1e99 if $self->isa ("ext::map_per_player");#d#
1434 return 1e99 if $self->{deny_reset}; 1537 return 1e99 if $self->{deny_reset};
1435 1538
1436 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1539 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1437 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1540 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1438 1541
1443 my ($self) = @_; 1546 my ($self) = @_;
1444 1547
1445 $self->reset_at <= $cf::RUNTIME 1548 $self->reset_at <= $cf::RUNTIME
1446} 1549}
1447 1550
1448sub unlink_save {
1449 my ($self) = @_;
1450
1451 utf8::encode (my $save = $self->{path}->save_path);
1452 aioreq_pri 3; IO::AIO::aio_unlink $save;
1453 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1454}
1455
1456sub rename {
1457 my ($self, $new_path) = @_;
1458
1459 $self->unlink_save;
1460
1461 delete $cf::MAP{$self->path};
1462 $self->{path} = new cf::path $new_path;
1463 $self->path ($self->{path}->as_string);
1464 $cf::MAP{$self->path} = $self;
1465
1466 $self->save;
1467}
1468
1469sub reset { 1551sub reset {
1470 my ($self) = @_; 1552 my ($self) = @_;
1471 1553
1472 my $lock = cf::lock_acquire "map_data:" . $self->path; 1554 my $lock = cf::lock_acquire "map_data:$self->{path}";
1473 1555
1474 return if $self->players; 1556 return if $self->players;
1475 return if $self->{path}{user_rel};#d# 1557 return if $self->isa ("ext::map_per_player");#d#
1476 1558
1477 warn "resetting map ", $self->path;#d# 1559 warn "resetting map ", $self->path;#d#
1478 1560
1479 delete $cf::MAP{$self->path}; 1561 delete $cf::MAP{$self->path};
1562
1563 $self->in_memory (cf::MAP_SWAPPED);
1564 $self->clear;
1480 1565
1481 $_->clear_links_to ($self) for values %cf::MAP; 1566 $_->clear_links_to ($self) for values %cf::MAP;
1482 1567
1483 $self->unlink_save; 1568 $self->unlink_save;
1484 $self->destroy; 1569 $self->destroy;
1487my $nuke_counter = "aaaa"; 1572my $nuke_counter = "aaaa";
1488 1573
1489sub nuke { 1574sub nuke {
1490 my ($self) = @_; 1575 my ($self) = @_;
1491 1576
1577 delete $cf::MAP{$self->path};
1578
1579 $self->unlink_save;
1580
1581 bless $self, "cf::map";
1582 delete $self->{deny_reset};
1492 $self->{deny_save} = 1; 1583 $self->{deny_save} = 1;
1493 $self->reset_timeout (1); 1584 $self->reset_timeout (1);
1494 $self->rename ("{nuke}/" . ($nuke_counter++)); 1585 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1586
1587 $cf::MAP{$self->path} = $self;
1588
1495 $self->reset; # polite request, might not happen 1589 $self->reset; # polite request, might not happen
1496} 1590}
1497 1591
1498sub customise_for { 1592=item cf::map::unique_maps
1499 my ($map, $ob) = @_;
1500 1593
1501 if ($map->per_player) { 1594Returns an arrayref of paths of all shared maps that have
1502 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path}; 1595instantiated unique items. May block.
1503 }
1504 1596
1505 $map 1597=cut
1506}
1507 1598
1508sub emergency_save { 1599sub unique_maps() {
1509 my $freeze_guard = cf::freeze_mainloop; 1600 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
1601 or return;
1510 1602
1511 warn "enter emergency perl save\n"; 1603 my @paths;
1512 1604
1513 cf::sync_job { 1605 for (@$files) {
1514 warn "begin emergency player save\n"; 1606 utf8::decode $_;
1515 $_->save for values %cf::PLAYER; 1607 next if /\.pst$/;
1516 warn "end emergency player save\n"; 1608 next unless /^$PATH_SEP/o;
1517 1609
1518 warn "begin emergency map save\n"; 1610 s/\.map$//;
1519 $_->save for values %cf::MAP; 1611 push @paths, $_;
1520 warn "end emergency map save\n";
1521 }; 1612 }
1522 1613
1523 warn "leave emergency perl save\n"; 1614 \@paths
1524} 1615}
1525 1616
1526package cf; 1617package cf;
1527 1618
1528=back 1619=back
1529 1620
1621=head3 cf::object
1622
1623=cut
1624
1625package cf::object;
1626
1627=over 4
1628
1629=item $ob->inv_recursive
1630
1631Returns the inventory of the object _and_ their inventories, recursively.
1632
1633=cut
1634
1635sub inv_recursive_;
1636sub inv_recursive_ {
1637 map { $_, inv_recursive_ $_->inv } @_
1638}
1639
1640sub inv_recursive {
1641 inv_recursive_ inv $_[0]
1642}
1643
1644package cf;
1645
1646=back
1530 1647
1531=head3 cf::object::player 1648=head3 cf::object::player
1532 1649
1533=over 4 1650=over 4
1534 1651
1574 1691
1575=item $player_object->enter_link 1692=item $player_object->enter_link
1576 1693
1577Freezes the player and moves him/her to a special map (C<{link}>). 1694Freezes the player and moves him/her to a special map (C<{link}>).
1578 1695
1579The player should be reaosnably safe there for short amounts of time. You 1696The player should be reasonably safe there for short amounts of time. You
1580I<MUST> call C<leave_link> as soon as possible, though. 1697I<MUST> call C<leave_link> as soon as possible, though.
1581 1698
1699Will never block.
1700
1582=item $player_object->leave_link ($map, $x, $y) 1701=item $player_object->leave_link ($map, $x, $y)
1583 1702
1584Moves the player out of the specila link map onto the given map. If the 1703Moves the player out of the special C<{link}> map onto the specified
1585map is not valid (or omitted), the player will be moved back to the 1704map. If the map is not valid (or omitted), the player will be moved back
1586location he/she was before the call to C<enter_link>, or, if that fails, 1705to the location he/she was before the call to C<enter_link>, or, if that
1587to the emergency map position. 1706fails, to the emergency map position.
1588 1707
1589Might block. 1708Might block.
1590 1709
1591=cut 1710=cut
1711
1712sub link_map {
1713 unless ($LINK_MAP) {
1714 $LINK_MAP = cf::map::find "{link}"
1715 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };
1716 $LINK_MAP->load;
1717 }
1718
1719 $LINK_MAP
1720}
1592 1721
1593sub cf::object::player::enter_link { 1722sub cf::object::player::enter_link {
1594 my ($self) = @_; 1723 my ($self) = @_;
1595 1724
1596 $self->deactivate_recursive; 1725 $self->deactivate_recursive;
1597 1726
1598 return if $self->map == $LINK_MAP; 1727 return if UNIVERSAL::isa $self->map, "ext::map_link";
1599 1728
1600 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 1729 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1601 if $self->map; 1730 if $self->map;
1602 1731
1603 $self->enter_map ($LINK_MAP, 20, 20); 1732 $self->enter_map ($LINK_MAP || link_map, 20, 20);
1604} 1733}
1605 1734
1606sub cf::object::player::leave_link { 1735sub cf::object::player::leave_link {
1607 my ($self, $map, $x, $y) = @_; 1736 my ($self, $map, $x, $y) = @_;
1608 1737
1626 # use -1 or undef as default coordinates, not 0, 0 1755 # use -1 or undef as default coordinates, not 0, 0
1627 ($x, $y) = ($map->enter_x, $map->enter_y) 1756 ($x, $y) = ($map->enter_x, $map->enter_y)
1628 if $x <=0 && $y <= 0; 1757 if $x <=0 && $y <= 0;
1629 1758
1630 $map->load; 1759 $map->load;
1760 $map->load_diag;
1631 1761
1632 return unless $self->contr->active; 1762 return unless $self->contr->active;
1633 $self->activate_recursive; 1763 $self->activate_recursive;
1634 $self->enter_map ($map, $x, $y); 1764 $self->enter_map ($map, $x, $y);
1635} 1765}
1674 my ($self, $path, $x, $y) = @_; 1804 my ($self, $path, $x, $y) = @_;
1675 1805
1676 $self->enter_link; 1806 $self->enter_link;
1677 1807
1678 (async { 1808 (async {
1679 $path = new cf::path $path;
1680
1681 my $map = cf::map::find $path->as_string; 1809 my $map = cf::map::find $path;
1682 $map = $map->customise_for ($self) if $map; 1810 $map = $map->customise_for ($self) if $map;
1683 1811
1684# warn "entering ", $map->path, " at ($x, $y)\n" 1812# warn "entering ", $map->path, " at ($x, $y)\n"
1685# if $map; 1813# if $map;
1686 1814
1687 $map or $map->cluck ("oy");#d#
1688 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED); 1815 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1689 1816
1690 $self->leave_link ($map, $x, $y); 1817 $self->leave_link ($map, $x, $y);
1691 })->prio (1); 1818 })->prio (1);
1692} 1819}
1697 1824
1698sub parse_random_map_params { 1825sub parse_random_map_params {
1699 my ($spec) = @_; 1826 my ($spec) = @_;
1700 1827
1701 my $rmp = { # defaults 1828 my $rmp = { # defaults
1702 xsize => 10, 1829 xsize => (cf::rndm 15, 40),
1703 ysize => 10, 1830 ysize => (cf::rndm 15, 40),
1831 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
1832 #layout => string,
1704 }; 1833 };
1705 1834
1706 for (split /\n/, $spec) { 1835 for (split /\n/, $spec) {
1707 my ($k, $v) = split /\s+/, $_, 2; 1836 my ($k, $v) = split /\s+/, $_, 2;
1708 1837
1712 $rmp 1841 $rmp
1713} 1842}
1714 1843
1715sub prepare_random_map { 1844sub prepare_random_map {
1716 my ($exit) = @_; 1845 my ($exit) = @_;
1846
1847 my $guard = cf::lock_acquire "exit_prepare:$exit";
1717 1848
1718 # all this does is basically replace the /! path by 1849 # all this does is basically replace the /! path by
1719 # a new random map path (?random/...) with a seed 1850 # a new random map path (?random/...) with a seed
1720 # that depends on the exit object 1851 # that depends on the exit object
1721 1852
1730 1861
1731 $rmp->{random_seed} ||= $exit->random_seed; 1862 $rmp->{random_seed} ||= $exit->random_seed;
1732 1863
1733 my $data = cf::to_json $rmp; 1864 my $data = cf::to_json $rmp;
1734 my $md5 = Digest::MD5::md5_hex $data; 1865 my $md5 = Digest::MD5::md5_hex $data;
1866 my $meta = "$cf::RANDOM_MAPS/$md5.meta";
1735 1867
1736 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 1868 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1737 aio_write $fh, 0, (length $data), $data, 0; 1869 aio_write $fh, 0, (length $data), $data, 0;
1870 undef $fh;
1871 aio_rename "$meta~", $meta;
1738 1872
1739 $exit->slaying ("?random/$md5"); 1873 $exit->slaying ("?random/$md5");
1740 $exit->msg (undef); 1874 $exit->msg (undef);
1741 } 1875 }
1742} 1876}
1752 $self->deactivate_recursive; # just to be sure 1886 $self->deactivate_recursive; # just to be sure
1753 unless (eval { 1887 unless (eval {
1754 prepare_random_map $exit 1888 prepare_random_map $exit
1755 if $exit->slaying eq "/!"; 1889 if $exit->slaying eq "/!";
1756 1890
1757 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path; 1891 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1758 $self->goto ($path, $exit->stats->hp, $exit->stats->sp); 1892 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1759 1893
1760 1; 1894 1;
1761 }) { 1895 }) {
1762 $self->message ("Something went wrong deep within the crossfire server. " 1896 $self->message ("Something went wrong deep within the crossfire server. "
1763 . "I'll try to bring you back to the map you were before. " 1897 . "I'll try to bring you back to the map you were before. "
1764 . "Please report this to the dungeon master", 1898 . "Please report this to the dungeon master!",
1765 cf::NDI_UNIQUE | cf::NDI_RED); 1899 cf::NDI_UNIQUE | cf::NDI_RED);
1766 1900
1767 warn "ERROR in enter_exit: $@"; 1901 warn "ERROR in enter_exit: $@";
1768 $self->leave_link; 1902 $self->leave_link;
1769 } 1903 }
2052 sub db_sync() { 2186 sub db_sync() {
2053 db_save if $dirty; 2187 db_save if $dirty;
2054 undef $dirty; 2188 undef $dirty;
2055 } 2189 }
2056 2190
2057 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub { 2191 my $idle = Event->idle (min => 10, max => 20, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2058 db_sync; 2192 db_sync;
2059 }); 2193 });
2060 2194
2061 sub db_dirty() { 2195 sub db_dirty() {
2062 $dirty = 1; 2196 $dirty = 1;
2112 2246
2113sub main { 2247sub main {
2114 # we must not ever block the main coroutine 2248 # we must not ever block the main coroutine
2115 local $Coro::idle = sub { 2249 local $Coro::idle = sub {
2116 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 2250 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2251 (async {
2117 async { Event::one_event }; 2252 Event::one_event;
2253 })->prio (Coro::PRIO_MAX);
2118 }; 2254 };
2119 2255
2120 cfg_load; 2256 cfg_load;
2121 db_load; 2257 db_load;
2122 load_extensions; 2258 load_extensions;
2259
2260 $TICK_WATCHER->start;
2123 Event::loop; 2261 Event::loop;
2124} 2262}
2125 2263
2126############################################################################# 2264#############################################################################
2127# initialisation 2265# initialisation and cleanup
2266
2267# install some emergency cleanup handlers
2268BEGIN {
2269 for my $signal (qw(INT HUP TERM)) {
2270 Event->signal (
2271 data => WF_AUTOCANCEL,
2272 signal => $signal,
2273 cb => sub {
2274 cf::cleanup "SIG$signal";
2275 },
2276 );
2277 }
2278}
2279
2280sub emergency_save() {
2281 my $freeze_guard = cf::freeze_mainloop;
2282
2283 warn "enter emergency perl save\n";
2284
2285 cf::sync_job {
2286 # use a peculiar iteration method to avoid tripping on perl
2287 # refcount bugs in for. also avoids problems with players
2288 # and maps saved/destroyed asynchronously.
2289 warn "begin emergency player save\n";
2290 for my $login (keys %cf::PLAYER) {
2291 my $pl = $cf::PLAYER{$login} or next;
2292 $pl->valid or next;
2293 $pl->save;
2294 }
2295 warn "end emergency player save\n";
2296
2297 warn "begin emergency map save\n";
2298 for my $path (keys %cf::MAP) {
2299 my $map = $cf::MAP{$path} or next;
2300 $map->valid or next;
2301 $map->save;
2302 }
2303 warn "end emergency map save\n";
2304 };
2305
2306 warn "leave emergency perl save\n";
2307}
2128 2308
2129sub reload() { 2309sub reload() {
2130 # can/must only be called in main 2310 # can/must only be called in main
2131 if ($Coro::current != $Coro::main) { 2311 if ($Coro::current != $Coro::main) {
2132 warn "can only reload from main coroutine\n"; 2312 warn "can only reload from main coroutine";
2133 return; 2313 return;
2134 } 2314 }
2135 2315
2136 warn "reloading..."; 2316 warn "reloading...";
2137 2317
2138 my $guard = freeze_mainloop; 2318 warn "cancelling server ticker";
2319 $TICK_WATCHER->cancel;
2320
2139 cf::emergency_save; 2321 cf::emergency_save;
2140 2322
2141 eval { 2323 eval {
2142 # if anything goes wrong in here, we should simply crash as we already saved 2324 # if anything goes wrong in here, we should simply crash as we already saved
2143 2325
2144 # cancel all watchers 2326 warn "syncing database to disk";
2327 cf::db_sync;
2328
2329 warn "cancelling all WF_AUTOCANCEL watchers";
2145 for (Event::all_watchers) { 2330 for (Event::all_watchers) {
2146 $_->cancel if $_->data & WF_AUTOCANCEL; 2331 $_->cancel if $_->data & WF_AUTOCANCEL;
2147 } 2332 }
2148 2333
2334 warn "flushing outstanding aio requests";
2335 for (;;) {
2336 IO::AIO::flush;
2337 Coro::cede;
2338 last unless IO::AIO::nreqs;
2339 warn "iterate...";
2340 }
2341
2149 # cancel all extension coros 2342 warn "cancelling all extension coros";
2150 $_->cancel for values %EXT_CORO; 2343 $_->cancel for values %EXT_CORO;
2151 %EXT_CORO = (); 2344 %EXT_CORO = ();
2152 2345
2153 # unload all extensions 2346 warn "removing commands";
2154 for (@exts) { 2347 %COMMAND = ();
2348
2349 warn "removing ext commands";
2350 %EXTCMD = ();
2351
2352 warn "unloading/nuking all extensions";
2353 for my $pkg (@EXTS) {
2155 warn "unloading <$_>"; 2354 warn "... unloading $pkg";
2156 unload_extension $_; 2355
2356 if (my $cb = $pkg->can ("unload")) {
2357 eval {
2358 $cb->($pkg);
2359 1
2360 } or warn "$pkg unloaded, but with errors: $@";
2157 } 2361 }
2158 2362
2363 warn "... nuking $pkg";
2364 Symbol::delete_package $pkg;
2365 }
2366
2159 # unload all modules loaded from $LIBDIR 2367 warn "unloading all perl modules loaded from $LIBDIR";
2160 while (my ($k, $v) = each %INC) { 2368 while (my ($k, $v) = each %INC) {
2161 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2369 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2162 2370
2163 warn "removing <$k>"; 2371 warn "... unloading $k";
2164 delete $INC{$k}; 2372 delete $INC{$k};
2165 2373
2166 $k =~ s/\.pm$//; 2374 $k =~ s/\.pm$//;
2167 $k =~ s/\//::/g; 2375 $k =~ s/\//::/g;
2168 2376
2171 } 2379 }
2172 2380
2173 Symbol::delete_package $k; 2381 Symbol::delete_package $k;
2174 } 2382 }
2175 2383
2176 # sync database to disk
2177 cf::db_sync;
2178 IO::AIO::flush;
2179
2180 # get rid of safe::, as good as possible 2384 warn "getting rid of safe::, as good as possible";
2181 Symbol::delete_package "safe::$_" 2385 Symbol::delete_package "safe::$_"
2182 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 2386 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2183 2387
2184 # remove register_script_function callbacks
2185 # TODO
2186
2187 # unload cf.pm "a bit" 2388 warn "unloading cf.pm \"a bit\"";
2188 delete $INC{"cf.pm"}; 2389 delete $INC{"cf.pm"};
2189 2390
2190 # don't, removes xs symbols, too, 2391 # don't, removes xs symbols, too,
2191 # and global variables created in xs 2392 # and global variables created in xs
2192 #Symbol::delete_package __PACKAGE__; 2393 #Symbol::delete_package __PACKAGE__;
2193 2394
2194 # reload cf.pm 2395 warn "unload completed, starting to reload now";
2396
2195 warn "reloading cf.pm"; 2397 warn "reloading cf.pm";
2196 require cf; 2398 require cf;
2197 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2399 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2198 2400
2199 # load config and database again 2401 warn "loading config and database again";
2200 cf::cfg_load; 2402 cf::cfg_load;
2201 cf::db_load; 2403 cf::db_load;
2202 2404
2203 # load extensions
2204 warn "load extensions"; 2405 warn "loading extensions";
2205 cf::load_extensions; 2406 cf::load_extensions;
2206 2407
2207 # reattach attachments to objects 2408 warn "reattaching attachments to objects/players";
2208 warn "reattach";
2209 _global_reattach; 2409 _global_reattach;
2410 warn "reattaching attachments to maps";
2210 reattach $_ for values %MAP; 2411 reattach $_ for values %MAP;
2412
2413 warn "restarting server ticker";
2414
2415 $TICK_WATCHER->start;
2211 }; 2416 };
2212 2417
2213 if ($@) { 2418 if ($@) {
2214 warn $@; 2419 warn $@;
2215 warn "error while reloading, exiting."; 2420 warn "error while reloading, exiting.";
2216 exit 1; 2421 exit 1;
2217 } 2422 }
2218 2423
2219 warn "reloaded successfully"; 2424 warn "reloaded";
2220}; 2425};
2221 2426
2222############################################################################# 2427our $RELOAD_WATCHER; # used only during reload
2223
2224unless ($LINK_MAP) {
2225 $LINK_MAP = cf::map::new;
2226
2227 $LINK_MAP->width (41);
2228 $LINK_MAP->height (41);
2229 $LINK_MAP->alloc;
2230 $LINK_MAP->path ("{link}");
2231 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2232 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2233
2234 # dirty hack because... archetypes are not yet loaded
2235 Event->timer (
2236 after => 10,
2237 cb => sub {
2238 $_[0]->w->cancel;
2239
2240 # provide some exits "home"
2241 my $exit = cf::object::new "exit";
2242
2243 $exit->slaying ($EMERGENCY_POSITION->[0]);
2244 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2245 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2246
2247 $LINK_MAP->insert ($exit->clone, 19, 19);
2248 $LINK_MAP->insert ($exit->clone, 19, 20);
2249 $LINK_MAP->insert ($exit->clone, 19, 21);
2250 $LINK_MAP->insert ($exit->clone, 20, 19);
2251 $LINK_MAP->insert ($exit->clone, 20, 21);
2252 $LINK_MAP->insert ($exit->clone, 21, 19);
2253 $LINK_MAP->insert ($exit->clone, 21, 20);
2254 $LINK_MAP->insert ($exit->clone, 21, 21);
2255
2256 $exit->destroy;
2257 });
2258
2259 $LINK_MAP->{deny_save} = 1;
2260 $LINK_MAP->{deny_reset} = 1;
2261
2262 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2263}
2264
2265register "<global>", __PACKAGE__;
2266 2428
2267register_command "reload" => sub { 2429register_command "reload" => sub {
2268 my ($who, $arg) = @_; 2430 my ($who, $arg) = @_;
2269 2431
2270 if ($who->flag (FLAG_WIZ)) { 2432 if ($who->flag (FLAG_WIZ)) {
2271 $who->message ("start of reload."); 2433 $who->message ("reloading server.");
2434
2435 # doing reload synchronously and two reloads happen back-to-back,
2436 # coro crashes during coro_state_free->destroy here.
2437
2438 $RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub {
2272 reload; 2439 reload;
2273 $who->message ("end of reload."); 2440 undef $RELOAD_WATCHER;
2441 });
2274 } 2442 }
2275}; 2443};
2276 2444
2277unshift @INC, $LIBDIR; 2445unshift @INC, $LIBDIR;
2446
2447my $bug_warning = 0;
2278 2448
2279$TICK_WATCHER = Event->timer ( 2449$TICK_WATCHER = Event->timer (
2280 reentrant => 0, 2450 reentrant => 0,
2451 parked => 1,
2281 prio => 0, 2452 prio => 0,
2282 at => $NEXT_TICK || $TICK, 2453 at => $NEXT_TICK || $TICK,
2283 data => WF_AUTOCANCEL, 2454 data => WF_AUTOCANCEL,
2284 cb => sub { 2455 cb => sub {
2456 if ($Coro::current != $Coro::main) {
2457 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2458 unless ++$bug_warning > 10;
2459 return;
2460 }
2461
2462 $NOW = Event::time;
2463
2285 cf::server_tick; # one server iteration 2464 cf::server_tick; # one server iteration
2286 $RUNTIME += $TICK; 2465 $RUNTIME += $TICK;
2287 $NEXT_TICK += $TICK; 2466 $NEXT_TICK += $TICK;
2467
2468 $WAIT_FOR_TICK->broadcast;
2469 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2288 2470
2289 # if we are delayed by four ticks or more, skip them all 2471 # if we are delayed by four ticks or more, skip them all
2290 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 2472 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2291 2473
2292 $TICK_WATCHER->at ($NEXT_TICK); 2474 $TICK_WATCHER->at ($NEXT_TICK);
2294 }, 2476 },
2295); 2477);
2296 2478
2297IO::AIO::max_poll_time $TICK * 0.2; 2479IO::AIO::max_poll_time $TICK * 0.2;
2298 2480
2299Event->io ( 2481$AIO_POLL_WATCHER = Event->io (
2300 fd => IO::AIO::poll_fileno, 2482 fd => IO::AIO::poll_fileno,
2301 poll => 'r', 2483 poll => 'r',
2302 prio => 5, 2484 prio => 5,
2303 data => WF_AUTOCANCEL, 2485 data => WF_AUTOCANCEL,
2304 cb => \&IO::AIO::poll_cb, 2486 cb => \&IO::AIO::poll_cb,
2305); 2487);
2306 2488
2307Event->timer ( 2489$WRITE_RUNTIME_WATCHER = Event->timer (
2308 data => WF_AUTOCANCEL, 2490 data => WF_AUTOCANCEL,
2309 after => 0, 2491 after => 1,
2310 interval => 10, 2492 interval => 10,
2311 cb => sub { 2493 prio => 6, # keep it lowest so it acts like a watchdog
2312 (Coro::unblock_sub { 2494 cb => Coro::unblock_sub {
2313 write_runtime 2495 write_runtime
2314 or warn "ERROR: unable to write runtime file: $!"; 2496 or warn "ERROR: unable to write runtime file: $!";
2315 })->();
2316 }, 2497 },
2317); 2498);
2318 2499
2319END { cf::emergency_save } 2500END { cf::emergency_save }
2320 2501

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines