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.141 by root, Fri Jan 5 20:08:53 2007 UTC vs.
Revision 1.238 by root, Sat Apr 14 07:23:00 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines