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.105 by root, Sun Dec 31 17:17:23 2006 UTC vs.
Revision 1.207 by root, Sun Feb 11 22:42:09 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.5 ();
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 BDB ();
21use Data::Dumper;
22use Digest::MD5;
20use Fcntl; 23use Fcntl;
21use IO::AIO 2.31 (); 24use IO::AIO 2.32 ();
22use YAML::Syck (); 25use YAML::Syck ();
23use Time::HiRes; 26use Time::HiRes;
24 27
25use Event; $Event::Eval = 1; # no idea why this is required, but it is 28use Event; $Event::Eval = 1; # no idea why this is required, but it is
26 29
30sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
31
27# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 32# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
28$YAML::Syck::ImplicitUnicode = 1; 33$YAML::Syck::ImplicitUnicode = 1;
29 34
30$Coro::main->prio (2); # run main coroutine ("the server") with very high priority 35$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
31
32sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
33 36
34our %COMMAND = (); 37our %COMMAND = ();
35our %COMMAND_TIME = (); 38our %COMMAND_TIME = ();
39
40our @EXTS = (); # list of extension package names
36our %EXTCMD = (); 41our %EXTCMD = ();
42our %EXT_CORO = (); # coroutines bound to extensions
43our %EXT_MAP = (); # pluggable maps
37 44
38our @EVENT; 45our @EVENT;
39our $LIBDIR = datadir . "/ext"; 46our $LIBDIR = datadir . "/ext";
40 47
41our $TICK = MAX_TIME * 1e-6; 48our $TICK = MAX_TIME * 1e-6;
42our $TICK_WATCHER; 49our $TICK_WATCHER;
50our $AIO_POLL_WATCHER;
51our $WRITE_RUNTIME_WATCHER;
43our $NEXT_TICK; 52our $NEXT_TICK;
44our $NOW; 53our $NOW;
54our $USE_FSYNC = 1; # use fsync to write maps - default off
55
56our $BDB_POLL_WATCHER;
57our $DB_ENV;
45 58
46our %CFG; 59our %CFG;
47 60
48our $UPTIME; $UPTIME ||= time; 61our $UPTIME; $UPTIME ||= time;
49our $RUNTIME; 62our $RUNTIME;
50 63
64our %PLAYER; # all users
51our %MAP; # all maps 65our %MAP; # all maps
52our $LINK_MAP; # the special {link} map 66our $LINK_MAP; # the special {link} map, which is always available
53our $FREEZE; 67our $RANDOM_MAPS = cf::localdir . "/random";
68our $BDB_ENV_DIR = cf::localdir . "/db";
69
70our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
71our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
72
73# used to convert map paths into valid unix filenames by replacing / by ∕
74our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
54 75
55binmode STDOUT; 76binmode STDOUT;
56binmode STDERR; 77binmode STDERR;
57 78
58# read virtual server time, if available 79# read virtual server time, if available
64 85
65mkdir cf::localdir; 86mkdir cf::localdir;
66mkdir cf::localdir . "/" . cf::playerdir; 87mkdir cf::localdir . "/" . cf::playerdir;
67mkdir cf::localdir . "/" . cf::tmpdir; 88mkdir cf::localdir . "/" . cf::tmpdir;
68mkdir cf::localdir . "/" . cf::uniquedir; 89mkdir cf::localdir . "/" . cf::uniquedir;
90mkdir $RANDOM_MAPS;
91mkdir $BDB_ENV_DIR;
69 92
70our %EXT_CORO; 93our $EMERGENCY_POSITION;
94
95sub cf::map::normalise;
71 96
72############################################################################# 97#############################################################################
73 98
74=head2 GLOBAL VARIABLES 99=head2 GLOBAL VARIABLES
75 100
99 124
100=item %cf::CFG 125=item %cf::CFG
101 126
102Configuration for the server, loaded from C</etc/crossfire/config>, or 127Configuration for the server, loaded from C</etc/crossfire/config>, or
103from wherever your confdir points to. 128from wherever your confdir points to.
129
130=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
131
132These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
133or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
134processing has been done. Call C<< ->wait >> on them to maximise the
135window of cpu time available, or simply to synchronise to the server tick.
104 136
105=back 137=back
106 138
107=cut 139=cut
108 140
112 utf8::encode $msg; 144 utf8::encode $msg;
113 145
114 $msg .= "\n" 146 $msg .= "\n"
115 unless $msg =~ /\n$/; 147 unless $msg =~ /\n$/;
116 148
117 LOG llevError, "cfperl: $msg"; 149 LOG llevError, $msg;
118 }; 150 };
119} 151}
120 152
121@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 153@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
122@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 154@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
140 172
141$Event::DIED = sub { 173$Event::DIED = sub {
142 warn "error in event callback: @_"; 174 warn "error in event callback: @_";
143}; 175};
144 176
145my %ext_pkg;
146my @exts;
147my @hook;
148
149=head2 UTILITY FUNCTIONS 177=head2 UTILITY FUNCTIONS
150 178
151=over 4 179=over 4
152 180
181=item dumpval $ref
182
153=cut 183=cut
184
185sub dumpval {
186 eval {
187 local $SIG{__DIE__};
188 my $d;
189 if (1) {
190 $d = new Data::Dumper([$_[0]], ["*var"]);
191 $d->Terse(1);
192 $d->Indent(2);
193 $d->Quotekeys(0);
194 $d->Useqq(1);
195 #$d->Bless(...);
196 $d->Seen($_[1]) if @_ > 1;
197 $d = $d->Dump();
198 }
199 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
200 $d
201 } || "[unable to dump $_[0]: '$@']";
202}
154 203
155use JSON::Syck (); # TODO# replace by JSON::PC once working 204use JSON::Syck (); # TODO# replace by JSON::PC once working
156 205
157=item $ref = cf::from_json $json 206=item $ref = cf::from_json $json
158 207
174sub to_json($) { 223sub to_json($) {
175 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 224 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
176 JSON::Syck::Dump $_[0] 225 JSON::Syck::Dump $_[0]
177} 226}
178 227
179# main coro must never ever "block" except in Event 228=item cf::lock_wait $string
180# sync_job ensures this by running the job in a coroutine 229
181# and waiting in Event while the server is otherwise frozen 230Wait until the given lock is available. See cf::lock_acquire.
231
232=item my $lock = cf::lock_acquire $string
233
234Wait until the given lock is available and then acquires it and returns
235a Coro::guard object. If the guard object gets destroyed (goes out of scope,
236for example when the coroutine gets canceled), the lock is automatically
237returned.
238
239Lock names should begin with a unique identifier (for example, cf::map::find
240uses map_find and cf::map::load uses map_load).
241
242=cut
243
244our %LOCK;
245
246sub lock_wait($) {
247 my ($key) = @_;
248
249 # wait for lock, if any
250 while ($LOCK{$key}) {
251 push @{ $LOCK{$key} }, $Coro::current;
252 Coro::schedule;
253 }
254}
255
256sub lock_acquire($) {
257 my ($key) = @_;
258
259 # wait, to be sure we are not locked
260 lock_wait $key;
261
262 $LOCK{$key} = [];
263
264 Coro::guard {
265 # wake up all waiters, to be on the safe side
266 $_->ready for @{ delete $LOCK{$key} };
267 }
268}
269
270sub freeze_mainloop {
271 return unless $TICK_WATCHER->is_active;
272
273 my $guard = Coro::guard {
274 $TICK_WATCHER->start;
275 $WRITE_RUNTIME_WATCHER->start;
276 };
277 $WRITE_RUNTIME_WATCHER->stop;
278 $TICK_WATCHER->stop;
279 $guard
280}
281
282=item cf::async { BLOCK }
283
284Currently the same as Coro::async_pool, meaning you cannot use
285C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
286thing you are allowed to do is call C<prio> on it.
287
288=cut
289
290BEGIN { *async = \&Coro::async_pool }
291
292=item cf::sync_job { BLOCK }
293
294The design of crossfire+ requires that the main coro ($Coro::main) is
295always able to handle events or runnable, as crossfire+ is only partly
296reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
297
298If it must be done, put the blocking parts into C<sync_job>. This will run
299the given BLOCK in another coroutine while waiting for the result. The
300server will be frozen during this time, so the block should either finish
301fast or be very important.
302
303=cut
304
182sub sync_job(&) { 305sub sync_job(&) {
183 my ($job) = @_; 306 my ($job) = @_;
184 307
185 my $busy = 1;
186 my @res;
187
188 local $FREEZE = 1;
189
190 my $coro = Coro::async {
191 @res = eval { $job->() };
192 warn $@ if $@;
193 undef $busy;
194 };
195
196 if ($Coro::current == $Coro::main) { 308 if ($Coro::current == $Coro::main) {
309 # this is the main coro, too bad, we have to block
310 # till the operation succeeds, freezing the server :/
311
312 # TODO: use suspend/resume instead
313 # (but this is cancel-safe)
314 my $freeze_guard = freeze_mainloop;
315
316 my $busy = 1;
317 my @res;
318
319 (async {
320 @res = eval { $job->() };
321 warn $@ if $@;
322 undef $busy;
197 $coro->prio (Coro::PRIO_MAX); 323 })->prio (Coro::PRIO_MAX);
324
198 while ($busy) { 325 while ($busy) {
199 Coro::cede_notself; 326 Coro::cede or Event::one_event;
200 Event::one_event unless Coro::nready;
201 } 327 }
328
329 wantarray ? @res : $res[0]
202 } else { 330 } else {
203 $coro->join; 331 # we are in another coroutine, how wonderful, everything just works
332
333 $job->()
204 } 334 }
205
206 wantarray ? @res : $res[0]
207} 335}
208 336
209=item $coro = cf::coro { BLOCK } 337=item $coro = cf::async_ext { BLOCK }
210 338
211Creates and returns a new coro. This coro is automcatially being canceled 339Like async, but this coro is automatically being canceled when the
212when the extension calling this is being unloaded. 340extension calling this is being unloaded.
213 341
214=cut 342=cut
215 343
216sub coro(&) { 344sub async_ext(&) {
217 my $cb = shift; 345 my $cb = shift;
218 346
219 my $coro; $coro = async { 347 my $coro = &Coro::async ($cb);
220 eval {
221 $cb->();
222 };
223 warn $@ if $@;
224 };
225 348
226 $coro->on_destroy (sub { 349 $coro->on_destroy (sub {
227 delete $EXT_CORO{$coro+0}; 350 delete $EXT_CORO{$coro+0};
228 }); 351 });
229 $EXT_CORO{$coro+0} = $coro; 352 $EXT_CORO{$coro+0} = $coro;
230 353
231 $coro 354 $coro
355}
356
357sub write_runtime {
358 my $runtime = cf::localdir . "/runtime";
359
360 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
361 or return;
362
363 my $value = $cf::RUNTIME + 90 + 10;
364 # 10 is the runtime save interval, for a monotonic clock
365 # 60 allows for the watchdog to kill the server.
366
367 (aio_write $fh, 0, (length $value), $value, 0) <= 0
368 and return;
369
370 # always fsync - this file is important
371 aio_fsync $fh
372 and return;
373
374 close $fh
375 or return;
376
377 aio_rename "$runtime~", $runtime
378 and return;
379
380 1
232} 381}
233 382
234=back 383=back
235 384
236=cut 385=cut
367our @CB_TYPE = (); # registry for type (cf-object class) based events 516our @CB_TYPE = (); # registry for type (cf-object class) based events
368our @CB_MAP = (); 517our @CB_MAP = ();
369 518
370my %attachment; 519my %attachment;
371 520
521sub cf::attachable::thawer_merge {
522 # simply override everything except _meta
523 local $_[0]{_meta};
524 %{$_[0]} = %{$_[1]};
525}
526
372sub _attach_cb($$$$) { 527sub _attach_cb($$$$) {
373 my ($registry, $event, $prio, $cb) = @_; 528 my ($registry, $event, $prio, $cb) = @_;
374 529
375 use sort 'stable'; 530 use sort 'stable';
376 531
547# object support 702# object support
548 703
549sub reattach { 704sub reattach {
550 # basically do the same as instantiate, without calling instantiate 705 # basically do the same as instantiate, without calling instantiate
551 my ($obj) = @_; 706 my ($obj) = @_;
707
708 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
552 709
553 my $registry = $obj->registry; 710 my $registry = $obj->registry;
554 711
555 @$registry = (); 712 @$registry = ();
556 713
603 $filename, length $$rdata, scalar @$objs; 760 $filename, length $$rdata, scalar @$objs;
604 761
605 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 762 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
606 chmod SAVE_MODE, $fh; 763 chmod SAVE_MODE, $fh;
607 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 764 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
608 aio_fsync $fh; 765 aio_fsync $fh if $cf::USE_FSYNC;
609 close $fh; 766 close $fh;
610 767
611 if (@$objs) { 768 if (@$objs) {
612 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 769 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
613 chmod SAVE_MODE, $fh; 770 chmod SAVE_MODE, $fh;
614 my $data = Storable::nfreeze { version => 1, objs => $objs }; 771 my $data = Storable::nfreeze { version => 1, objs => $objs };
615 aio_write $fh, 0, (length $data), $data, 0; 772 aio_write $fh, 0, (length $data), $data, 0;
616 aio_fsync $fh; 773 aio_fsync $fh if $cf::USE_FSYNC;
617 close $fh; 774 close $fh;
618 aio_rename "$filename.pst~", "$filename.pst"; 775 aio_rename "$filename.pst~", "$filename.pst";
619 } 776 }
620 } else { 777 } else {
621 aio_unlink "$filename.pst"; 778 aio_unlink "$filename.pst";
627 } 784 }
628 } else { 785 } else {
629 aio_unlink $filename; 786 aio_unlink $filename;
630 aio_unlink "$filename.pst"; 787 aio_unlink "$filename.pst";
631 } 788 }
789
790 #d##TODO# nuke non .map-files if exist
791 if ($filename =~ s/\.map$//) {
792 aio_unlink $filename;
793 aio_unlink "$filename.pst";
794 }
632 } 795 }
633} 796}
634 797
635sub object_freezer_as_string { 798sub object_freezer_as_string {
636 my ($rdata, $objs) = @_; 799 my ($rdata, $objs) = @_;
642 805
643sub object_thawer_load { 806sub object_thawer_load {
644 my ($filename) = @_; 807 my ($filename) = @_;
645 808
646 my ($data, $av); 809 my ($data, $av);
810
811 #d#TODO remove .map if file does not exist
812 aio_stat $filename and $filename =~ s/\.map$//;
647 813
648 (aio_load $filename, $data) >= 0 814 (aio_load $filename, $data) >= 0
649 or return; 815 or return;
650 816
651 unless (aio_stat "$filename.pst") { 817 unless (aio_stat "$filename.pst") {
652 (aio_load "$filename.pst", $av) >= 0 818 (aio_load "$filename.pst", $av) >= 0
653 or return; 819 or return;
654 $av = eval { (Storable::thaw <$av>)->{objs} }; 820 $av = eval { (Storable::thaw $av)->{objs} };
655 } 821 }
656 822
823 warn sprintf "loading %s (%d)\n",
824 $filename, length $data, scalar @{$av || []};#d#
657 return ($data, $av); 825 return ($data, $av);
658} 826}
659 827
660############################################################################# 828#############################################################################
661# command handling &c 829# command handling &c
686=cut 854=cut
687 855
688sub register_extcmd { 856sub register_extcmd {
689 my ($name, $cb) = @_; 857 my ($name, $cb) = @_;
690 858
691 my $caller = caller;
692 #warn "registering extcmd '$name' to '$caller'";
693
694 $EXTCMD{$name} = [$cb, $caller]; 859 $EXTCMD{$name} = $cb;
695} 860}
696 861
697cf::player->attach ( 862cf::player->attach (
698 on_command => sub { 863 on_command => sub {
699 my ($pl, $name, $params) = @_; 864 my ($pl, $name, $params) = @_;
712 877
713 my $msg = eval { from_json $buf }; 878 my $msg = eval { from_json $buf };
714 879
715 if (ref $msg) { 880 if (ref $msg) {
716 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 881 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
717 if (my %reply = $cb->[0]->($pl, $msg)) { 882 if (my %reply = $cb->($pl, $msg)) {
718 $pl->ext_reply ($msg->{msgid}, %reply); 883 $pl->ext_reply ($msg->{msgid}, %reply);
719 } 884 }
720 } 885 }
721 } else { 886 } else {
722 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 887 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
724 889
725 cf::override; 890 cf::override;
726 }, 891 },
727); 892);
728 893
729sub register {
730 my ($base, $pkg) = @_;
731
732 #TODO
733}
734
735sub load_extension { 894sub load_extension {
736 my ($path) = @_; 895 my ($path) = @_;
737 896
738 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 897 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
739 my $base = $1; 898 my $base = $1;
740 my $pkg = $1; 899 my $pkg = $1;
741 $pkg =~ s/[^[:word:]]/_/g; 900 $pkg =~ s/[^[:word:]]/_/g;
742 $pkg = "ext::$pkg"; 901 $pkg = "ext::$pkg";
743 902
744 warn "loading '$path' into '$pkg'\n"; 903 warn "... loading '$path' into '$pkg'\n";
745 904
746 open my $fh, "<:utf8", $path 905 open my $fh, "<:utf8", $path
747 or die "$path: $!"; 906 or die "$path: $!";
748 907
749 my $source = 908 my $source =
750 "package $pkg; use strict; use utf8;\n" 909 "package $pkg; use strict; use utf8;\n"
751 . "#line 1 \"$path\"\n{\n" 910 . "#line 1 \"$path\"\n{\n"
752 . (do { local $/; <$fh> }) 911 . (do { local $/; <$fh> })
753 . "\n};\n1"; 912 . "\n};\n1";
754 913
755 eval $source 914 unless (eval $source) {
756 or die $@ ? "$path: $@\n" 915 my $msg = $@ ? "$path: $@\n"
757 : "extension disabled.\n"; 916 : "extension disabled.\n";
758 917 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
759 push @exts, $pkg; 918 warn $@;
760 $ext_pkg{$base} = $pkg; 919 warn "mandatory extension failed to load, exiting.\n";
761 920 exit 1;
762# no strict 'refs'; 921 }
763# @{"$pkg\::ISA"} = ext::; 922 die $@;
764
765 register $base, $pkg;
766}
767
768sub unload_extension {
769 my ($pkg) = @_;
770
771 warn "removing extension $pkg\n";
772
773 # remove hooks
774 #TODO
775# for my $idx (0 .. $#PLUGIN_EVENT) {
776# delete $hook[$idx]{$pkg};
777# } 923 }
778 924
779 # remove commands 925 push @EXTS, $pkg;
780 for my $name (keys %COMMAND) {
781 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
782
783 if (@cb) {
784 $COMMAND{$name} = \@cb;
785 } else {
786 delete $COMMAND{$name};
787 }
788 }
789
790 # remove extcmds
791 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
792 delete $EXTCMD{$name};
793 }
794
795 if (my $cb = $pkg->can ("unload")) {
796 eval {
797 $cb->($pkg);
798 1
799 } or warn "$pkg unloaded, but with errors: $@";
800 }
801
802 Symbol::delete_package $pkg;
803} 926}
804 927
805sub load_extensions { 928sub load_extensions {
806 for my $ext (<$LIBDIR/*.ext>) { 929 for my $ext (<$LIBDIR/*.ext>) {
807 next unless -r $ext; 930 next unless -r $ext;
811 } or warn "$ext not loaded: $@"; 934 } or warn "$ext not loaded: $@";
812 } 935 }
813} 936}
814 937
815############################################################################# 938#############################################################################
816# load/save/clean perl data associated with a map
817 939
818*cf::mapsupport::on_clean = sub { 940=head2 CORE EXTENSIONS
941
942Functions and methods that extend core crossfire objects.
943
944=cut
945
946package cf::player;
947
948use Coro::AIO;
949
950=head3 cf::player
951
952=over 4
953
954=item cf::player::find $login
955
956Returns the given player object, loading it if necessary (might block).
957
958=cut
959
960sub playerdir($) {
961 cf::localdir
962 . "/"
963 . cf::playerdir
964 . "/"
965 . (ref $_[0] ? $_[0]->ob->name : $_[0])
966}
967
968sub path($) {
969 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
970
971 (playerdir $login) . "/$login.pl"
972}
973
974sub find_active($) {
975 $cf::PLAYER{$_[0]}
976 and $cf::PLAYER{$_[0]}->active
977 and $cf::PLAYER{$_[0]}
978}
979
980sub exists($) {
981 my ($login) = @_;
982
983 $cf::PLAYER{$login}
984 or cf::sync_job { !aio_stat path $login }
985}
986
987sub find($) {
988 return $cf::PLAYER{$_[0]} || do {
989 my $login = $_[0];
990
991 my $guard = cf::lock_acquire "user_find:$login";
992
993 $cf::PLAYER{$_[0]} || do {
994 my $pl = load_pl path $login
995 or return;
996 $cf::PLAYER{$login} = $pl
997 }
998 }
999}
1000
1001sub save($) {
1002 my ($pl) = @_;
1003
1004 return if $pl->{deny_save};
1005
1006 my $path = path $pl;
1007 my $guard = cf::lock_acquire "user_save:$path";
1008
1009 return if $pl->{deny_save};
1010
1011 aio_mkdir playerdir $pl, 0770;
1012 $pl->{last_save} = $cf::RUNTIME;
1013
1014 $pl->save_pl ($path);
1015 Coro::cede;
1016}
1017
1018sub new($) {
1019 my ($login) = @_;
1020
1021 my $self = create;
1022
1023 $self->ob->name ($login);
1024 $self->{deny_save} = 1;
1025
1026 $cf::PLAYER{$login} = $self;
1027
1028 $self
1029}
1030
1031=item $pl->quit_character
1032
1033Nukes the player without looking back. If logged in, the connection will
1034be destroyed. May block for a long time.
1035
1036=cut
1037
1038sub quit_character {
1039 my ($pl) = @_;
1040
1041 $pl->{deny_save} = 1;
1042 $pl->password ("*"); # this should lock out the player until we nuked the dir
1043
1044 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1045 $pl->deactivate;
1046 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1047 $pl->ns->destroy if $pl->ns;
1048
1049 my $path = playerdir $pl;
1050 my $temp = "$path~$cf::RUNTIME~deleting~";
1051 aio_rename $path, $temp;
1052 delete $cf::PLAYER{$pl->ob->name};
1053 $pl->destroy;
1054 IO::AIO::aio_rmtree $temp;
1055}
1056
1057=item cf::player::list_logins
1058
1059Returns am arrayref of all valid playernames in the system, can take a
1060while and may block, so not sync_job-capable, ever.
1061
1062=cut
1063
1064sub list_logins {
1065 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
1066 or return [];
1067
1068 my @logins;
1069
1070 for my $login (@$dirs) {
1071 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1072 aio_read $fh, 0, 512, my $buf, 0 or next;
1073 $buf !~ /^password -------------$/m or next; # official not-valid tag
1074
1075 utf8::decode $login;
1076 push @logins, $login;
1077 }
1078
1079 \@logins
1080}
1081
1082=item $player->maps
1083
1084Returns an arrayref of map paths that are private for this
1085player. May block.
1086
1087=cut
1088
1089sub maps($) {
1090 my ($pl) = @_;
1091
1092 $pl = ref $pl ? $pl->ob->name : $pl;
1093
1094 my $files = aio_readdir playerdir $pl
1095 or return;
1096
1097 my @paths;
1098
1099 for (@$files) {
1100 utf8::decode $_;
1101 next if /\.(?:pl|pst)$/;
1102 next unless /^$PATH_SEP/o;
1103
1104 push @paths, cf::map::normalise "~$pl/$_";
1105 }
1106
1107 \@paths
1108}
1109
1110=item $player->ext_reply ($msgid, $msgtype, %msg)
1111
1112Sends an ext reply to the player.
1113
1114=cut
1115
1116sub ext_reply($$$%) {
1117 my ($self, $id, %msg) = @_;
1118
1119 $msg{msgid} = $id;
1120
1121 $self->send ("ext " . cf::to_json \%msg);
1122}
1123
1124package cf;
1125
1126=back
1127
1128
1129=head3 cf::map
1130
1131=over 4
1132
1133=cut
1134
1135package cf::map;
1136
1137use Fcntl;
1138use Coro::AIO;
1139
1140use overload
1141 '""' => \&as_string,
1142 fallback => 1;
1143
1144our $MAX_RESET = 3600;
1145our $DEFAULT_RESET = 3000;
1146
1147sub generate_random_map {
1148 my ($self, $rmp) = @_;
1149 # mit "rum" bekleckern, nicht
1150 $self->_create_random_map (
1151 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1152 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1153 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1154 $rmp->{exit_on_final_map},
1155 $rmp->{xsize}, $rmp->{ysize},
1156 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1157 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1158 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1159 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1160 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1161 (cf::region::find $rmp->{region}), $rmp->{custom}
1162 )
1163}
1164
1165=item cf::map->register ($regex, $prio)
1166
1167Register a handler for the map path matching the given regex at the
1168givne priority (higher is better, built-in handlers have priority 0, the
1169default).
1170
1171=cut
1172
1173sub register {
1174 my (undef, $regex, $prio) = @_;
1175 my $pkg = caller;
1176
1177 no strict;
1178 push @{"$pkg\::ISA"}, __PACKAGE__;
1179
1180 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1181}
1182
1183# also paths starting with '/'
1184$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1185
1186sub thawer_merge {
1187 my ($self, $merge) = @_;
1188
1189 # we have to keep some variables in memory intact
1190 local $self->{path};
1191 local $self->{load_path};
1192 local $self->{deny_save};
1193 local $self->{deny_reset};
1194
1195 $self->SUPER::thawer_merge ($merge);
1196}
1197
1198sub normalise {
1199 my ($path, $base) = @_;
1200
1201 $path = "$path"; # make sure its a string
1202
1203 $path =~ s/\.map$//;
1204
1205 # map plan:
1206 #
1207 # /! non-realised random map exit (special hack!)
1208 # {... are special paths that are not being touched
1209 # ?xxx/... are special absolute paths
1210 # ?random/... random maps
1211 # /... normal maps
1212 # ~user/... per-player map of a specific user
1213
1214 $path =~ s/$PATH_SEP/\//go;
1215
1216 # treat it as relative path if it starts with
1217 # something that looks reasonable
1218 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1219 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1220
1221 $base =~ s{[^/]+/?$}{};
1222 $path = "$base/$path";
1223 }
1224
1225 for ($path) {
1226 redo if s{//}{/};
1227 redo if s{/\.?/}{/};
1228 redo if s{/[^/]+/\.\./}{/};
1229 }
1230
1231 $path
1232}
1233
1234sub new_from_path {
1235 my (undef, $path, $base) = @_;
1236
1237 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1238
1239 $path = normalise $path, $base;
1240
1241 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1242 if ($path =~ $EXT_MAP{$pkg}[1]) {
1243 my $self = bless cf::map::new, $pkg;
1244 $self->{path} = $path; $self->path ($path);
1245 $self->init; # pass $1 etc.
1246 return $self;
1247 }
1248 }
1249
1250 Carp::carp "unable to resolve path '$path' (base '$base').";
1251 ()
1252}
1253
1254sub init {
1255 my ($self) = @_;
1256
1257 $self
1258}
1259
1260sub as_string {
1261 my ($self) = @_;
1262
1263 "$self->{path}"
1264}
1265
1266# the displayed name, this is a one way mapping
1267sub visible_name {
1268 &as_string
1269}
1270
1271# the original (read-only) location
1272sub load_path {
1273 my ($self) = @_;
1274
1275 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}
1276}
1277
1278# the temporary/swap location
1279sub save_path {
1280 my ($self) = @_;
1281
1282 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1283 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path
1284}
1285
1286# the unique path, undef == no special unique path
1287sub uniq_path {
1288 my ($self) = @_;
1289
1290 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1291 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
1292}
1293
1294# and all this just because we cannot iterate over
1295# all maps in C++...
1296sub change_all_map_light {
1297 my ($change) = @_;
1298
1299 $_->change_map_light ($change)
1300 for grep $_->outdoor, values %cf::MAP;
1301}
1302
1303sub unlink_save {
1304 my ($self) = @_;
1305
1306 utf8::encode (my $save = $self->save_path);
1307 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1308 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1309
1310 #d#TODO remove .map and also nuke
1311 $save =~ s/\.map// or return;#d#
1312 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1313 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1314}
1315
1316sub load_header_from($) {
1317 my ($self, $path) = @_;
1318
1319 utf8::encode $path;
1320 #aio_open $path, O_RDONLY, 0
1321 # or return;
1322
1323 $self->_load_header ($path)
1324 or return;
1325
1326 $self->{load_path} = $path;
1327
1328 1
1329}
1330
1331sub load_header_orig {
1332 my ($self) = @_;
1333
1334 $self->load_header_from ($self->load_path)
1335}
1336
1337sub load_header_temp {
1338 my ($self) = @_;
1339
1340 $self->load_header_from ($self->save_path)
1341}
1342
1343sub prepare_temp {
1344 my ($self) = @_;
1345
1346 $self->last_access ((delete $self->{last_access})
1347 || $cf::RUNTIME); #d#
1348 # safety
1349 $self->{instantiate_time} = $cf::RUNTIME
1350 if $self->{instantiate_time} > $cf::RUNTIME;
1351}
1352
1353sub prepare_orig {
1354 my ($self) = @_;
1355
1356 $self->{load_original} = 1;
1357 $self->{instantiate_time} = $cf::RUNTIME;
1358 $self->last_access ($cf::RUNTIME);
1359 $self->instantiate;
1360}
1361
1362sub load_header {
1363 my ($self) = @_;
1364
1365 if ($self->load_header_temp) {
1366 $self->prepare_temp;
1367 } else {
1368 $self->load_header_orig
1369 or return;
1370 $self->prepare_orig;
1371 }
1372
1373 1
1374}
1375
1376sub find;
1377sub find {
1378 my ($path, $origin) = @_;
1379
1380 $path = normalise $path, $origin && $origin->path;
1381
1382 cf::lock_wait "map_find:$path";
1383
1384 $cf::MAP{$path} || do {
1385 my $guard = cf::lock_acquire "map_find:$path";
1386 my $map = new_from_path cf::map $path
1387 or return;
1388
1389 $map->{last_save} = $cf::RUNTIME;
1390
1391 $map->load_header
1392 or return;
1393
1394 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)
1395 # doing this can freeze the server in a sync job, obviously
1396 #$cf::WAIT_FOR_TICK->wait;
1397 $map->reset;
1398 undef $guard;
1399 return find $path;
1400 }
1401
1402 $cf::MAP{$path} = $map
1403 }
1404}
1405
1406sub pre_load { }
1407sub post_load { }
1408
1409sub load {
1410 my ($self) = @_;
1411
1412 local $self->{deny_reset} = 1; # loading can take a long time
1413
1414 my $path = $self->{path};
1415 my $guard = cf::lock_acquire "map_load:$path";
1416
1417 return if $self->in_memory != cf::MAP_SWAPPED;
1418
1419 $self->in_memory (cf::MAP_LOADING);
1420
1421 $self->alloc;
1422
1423 $self->pre_load;
1424
1425 $self->_load_objects ($self->{load_path}, 1)
1426 or return;
1427
1428 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1429 if delete $self->{load_original};
1430
1431 if (my $uniq = $self->uniq_path) {
1432 utf8::encode $uniq;
1433 if (aio_open $uniq, O_RDONLY, 0) {
1434 $self->clear_unique_items;
1435 $self->_load_objects ($uniq, 0);
1436 }
1437 }
1438
1439 Coro::cede;
1440
1441 # now do the right thing for maps
1442 $self->link_multipart_objects;
1443
1444 unless ($self->{deny_activate}) {
1445 $self->decay_objects;
1446 $self->fix_auto_apply;
1447 $self->update_buttons;
1448 Coro::cede;
1449 $self->set_darkness_map;
1450 $self->difficulty ($self->estimate_difficulty)
1451 unless $self->difficulty;
1452 Coro::cede;
1453 $self->activate;
1454 }
1455
1456 $self->post_load;
1457
1458 $self->in_memory (cf::MAP_IN_MEMORY);
1459}
1460
1461sub customise_for {
1462 my ($self, $ob) = @_;
1463
1464 return find "~" . $ob->name . "/" . $self->{path}
1465 if $self->per_player;
1466
1467 $self
1468}
1469
1470# find and load all maps in the 3x3 area around a map
1471sub load_diag {
819 my ($map) = @_; 1472 my ($map) = @_;
820 1473
821 my $path = $map->tmpname; 1474 my @diag; # diagonal neighbours
822 defined $path or return;
823 1475
824 unlink "$path.pst"; 1476 for (0 .. 3) {
825}; 1477 my $neigh = $map->tile_path ($_)
1478 or next;
1479 $neigh = find $neigh, $map
1480 or next;
1481 $neigh->load;
826 1482
827cf::map->attach (prio => -10000, package => cf::mapsupport::); 1483 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1484 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1485 }
828 1486
829############################################################################# 1487 for (@diag) {
830# load/save perl data associated with player->ob objects 1488 my $neigh = find @$_
831 1489 or next;
832sub all_objects(@) { 1490 $neigh->load;
833 @_, map all_objects ($_->inv), @_ 1491 }
834} 1492}
835 1493
836# TODO: compatibility cruft, remove when no longer needed 1494sub find_sync {
837cf::player->attach ( 1495 my ($path, $origin) = @_;
838 on_load => sub {
839 my ($pl, $path) = @_;
840 1496
841 for my $o (all_objects $pl->ob) { 1497 cf::sync_job { find $path, $origin }
842 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1498}
843 $o->set_ob_key_value ("_perl_data");
844 1499
845 %$o = %{ Storable::thaw pack "H*", $value }; 1500sub do_load_sync {
1501 my ($map) = @_;
1502
1503 cf::sync_job { $map->load };
1504}
1505
1506our %MAP_PREFETCH;
1507our $MAP_PREFETCHER = undef;
1508
1509sub find_async {
1510 my ($path, $origin) = @_;
1511
1512 $path = normalise $path, $origin && $origin->{path};
1513
1514 if (my $map = $cf::MAP{$path}) {
1515 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1516 }
1517
1518 undef $MAP_PREFETCH{$path};
1519 $MAP_PREFETCHER ||= cf::async {
1520 while (%MAP_PREFETCH) {
1521 for my $path (keys %MAP_PREFETCH) {
1522 my $map = find $path
1523 or next;
1524 $map->load;
1525
1526 delete $MAP_PREFETCH{$path};
846 } 1527 }
847 } 1528 }
1529 undef $MAP_PREFETCHER;
1530 };
1531 $MAP_PREFETCHER->prio (6);
1532
1533 ()
1534}
1535
1536sub save {
1537 my ($self) = @_;
1538
1539 my $lock = cf::lock_acquire "map_data:" . $self->path;
1540
1541 $self->{last_save} = $cf::RUNTIME;
1542
1543 return unless $self->dirty;
1544
1545 my $save = $self->save_path; utf8::encode $save;
1546 my $uniq = $self->uniq_path; utf8::encode $uniq;
1547
1548 $self->{load_path} = $save;
1549
1550 return if $self->{deny_save};
1551
1552 local $self->{last_access} = $self->last_access;#d#
1553
1554 cf::async {
1555 $_->contr->save for $self->players;
1556 };
1557
1558 if ($uniq) {
1559 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1560 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1561 } else {
1562 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
848 }, 1563 }
849); 1564}
850 1565
851############################################################################# 1566sub swap_out {
1567 my ($self) = @_;
852 1568
853=head2 CORE EXTENSIONS 1569 # save first because save cedes
1570 $self->save;
854 1571
855Functions and methods that extend core crossfire objects. 1572 my $lock = cf::lock_acquire "map_data:" . $self->path;
856 1573
857=head3 cf::player 1574 return if $self->players;
1575 return if $self->in_memory != cf::MAP_IN_MEMORY;
1576 return if $self->{deny_save};
1577
1578 $self->clear;
1579 $self->in_memory (cf::MAP_SWAPPED);
1580}
1581
1582sub reset_at {
1583 my ($self) = @_;
1584
1585 # TODO: safety, remove and allow resettable per-player maps
1586 return 1e99 if $self->isa ("ext::map_per_player");#d#
1587 return 1e99 if $self->{deny_reset};
1588
1589 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1590 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1591
1592 $time + $to
1593}
1594
1595sub should_reset {
1596 my ($self) = @_;
1597
1598 $self->reset_at <= $cf::RUNTIME
1599}
1600
1601sub reset {
1602 my ($self) = @_;
1603
1604 my $lock = cf::lock_acquire "map_data:$self->{path}";
1605
1606 return if $self->players;
1607 return if $self->isa ("ext::map_per_player");#d#
1608
1609 warn "resetting map ", $self->path;#d#
1610
1611 delete $cf::MAP{$self->path};
1612
1613 $self->in_memory (cf::MAP_SWAPPED);
1614 $self->clear;
1615
1616 $_->clear_links_to ($self) for values %cf::MAP;
1617
1618 $self->unlink_save;
1619 $self->destroy;
1620}
1621
1622my $nuke_counter = "aaaa";
1623
1624sub nuke {
1625 my ($self) = @_;
1626
1627 delete $cf::MAP{$self->path};
1628
1629 $self->unlink_save;
1630
1631 bless $self, "cf::map";
1632 delete $self->{deny_reset};
1633 $self->{deny_save} = 1;
1634 $self->reset_timeout (1);
1635 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1636
1637 $cf::MAP{$self->path} = $self;
1638
1639 $self->reset; # polite request, might not happen
1640}
1641
1642=item cf::map::unique_maps
1643
1644Returns an arrayref of paths of all shared maps that have
1645instantiated unique items. May block.
1646
1647=cut
1648
1649sub unique_maps() {
1650 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
1651 or return;
1652
1653 my @paths;
1654
1655 for (@$files) {
1656 utf8::decode $_;
1657 next if /\.pst$/;
1658 next unless /^$PATH_SEP/o;
1659
1660 push @paths, cf::map::normalise $_;
1661 }
1662
1663 \@paths
1664}
1665
1666package cf;
1667
1668=back
1669
1670=head3 cf::object
1671
1672=cut
1673
1674package cf::object;
858 1675
859=over 4 1676=over 4
860 1677
861=item cf::player::exists $login 1678=item $ob->inv_recursive
862 1679
863Returns true when the given account exists. 1680Returns the inventory of the object _and_ their inventories, recursively.
864 1681
865=cut 1682=cut
866 1683
867sub cf::player::exists($) { 1684sub inv_recursive_;
868 cf::player::find $_[0] 1685sub inv_recursive_ {
869 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1686 map { $_, inv_recursive_ $_->inv } @_
870} 1687}
871 1688
872=item $player->ext_reply ($msgid, $msgtype, %msg) 1689sub inv_recursive {
873 1690 inv_recursive_ inv $_[0]
874Sends an ext reply to the player.
875
876=cut
877
878sub cf::player::ext_reply($$$%) {
879 my ($self, $id, %msg) = @_;
880
881 $msg{msgid} = $id;
882
883 $self->send ("ext " . to_json \%msg);
884} 1691}
1692
1693package cf;
885 1694
886=back 1695=back
887 1696
888=head3 cf::object::player 1697=head3 cf::object::player
889 1698
927 (ref $cf::CFG{"may_$access"} 1736 (ref $cf::CFG{"may_$access"}
928 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1737 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
929 : $cf::CFG{"may_$access"}) 1738 : $cf::CFG{"may_$access"})
930} 1739}
931 1740
1741=item $player_object->enter_link
1742
1743Freezes the player and moves him/her to a special map (C<{link}>).
1744
1745The player should be reasonably safe there for short amounts of time. You
1746I<MUST> call C<leave_link> as soon as possible, though.
1747
1748Will never block.
1749
1750=item $player_object->leave_link ($map, $x, $y)
1751
1752Moves the player out of the special C<{link}> map onto the specified
1753map. If the map is not valid (or omitted), the player will be moved back
1754to the location he/she was before the call to C<enter_link>, or, if that
1755fails, to the emergency map position.
1756
1757Might block.
1758
1759=cut
1760
1761sub link_map {
1762 unless ($LINK_MAP) {
1763 $LINK_MAP = cf::map::find "{link}"
1764 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1765 $LINK_MAP->load;
1766 }
1767
1768 $LINK_MAP
1769}
1770
1771sub cf::object::player::enter_link {
1772 my ($self) = @_;
1773
1774 $self->deactivate_recursive;
1775
1776 return if UNIVERSAL::isa $self->map, "ext::map_link";
1777
1778 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1779 if $self->map;
1780
1781 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1782}
1783
1784sub cf::object::player::leave_link {
1785 my ($self, $map, $x, $y) = @_;
1786
1787 my $link_pos = delete $self->{_link_pos};
1788
1789 unless ($map) {
1790 # restore original map position
1791 ($map, $x, $y) = @{ $link_pos || [] };
1792 $map = cf::map::find $map;
1793
1794 unless ($map) {
1795 ($map, $x, $y) = @$EMERGENCY_POSITION;
1796 $map = cf::map::find $map
1797 or die "FATAL: cannot load emergency map\n";
1798 }
1799 }
1800
1801 ($x, $y) = (-1, -1)
1802 unless (defined $x) && (defined $y);
1803
1804 # use -1 or undef as default coordinates, not 0, 0
1805 ($x, $y) = ($map->enter_x, $map->enter_y)
1806 if $x <=0 && $y <= 0;
1807
1808 $map->load;
1809 $map->load_diag;
1810
1811 return unless $self->contr->active;
1812 $self->activate_recursive;
1813 $self->enter_map ($map, $x, $y);
1814}
1815
1816cf::player->attach (
1817 on_logout => sub {
1818 my ($pl) = @_;
1819
1820 # abort map switching before logout
1821 if ($pl->ob->{_link_pos}) {
1822 cf::sync_job {
1823 $pl->ob->leave_link
1824 };
1825 }
1826 },
1827 on_login => sub {
1828 my ($pl) = @_;
1829
1830 # try to abort aborted map switching on player login :)
1831 # should happen only on crashes
1832 if ($pl->ob->{_link_pos}) {
1833 $pl->ob->enter_link;
1834 (async {
1835 # we need this sleep as the login has a concurrent enter_exit running
1836 # and this sleep increases chances of the player not ending up in scorn
1837 $pl->ob->reply (undef,
1838 "There was an internal problem at your last logout, "
1839 . "the server will try to bring you to your intended destination in a second.",
1840 cf::NDI_RED);
1841 Coro::Timer::sleep 1;
1842 $pl->ob->leave_link;
1843 })->prio (2);
1844 }
1845 },
1846);
1847
1848=item $player_object->goto ($path, $x, $y)
1849
1850=cut
1851
1852sub cf::object::player::goto {
1853 my ($self, $path, $x, $y) = @_;
1854
1855 $self->enter_link;
1856
1857 (async {
1858 my $map = eval {
1859 my $map = cf::map::find $path;
1860 $map = $map->customise_for ($self) if $map;
1861 $map
1862 } or
1863 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1864
1865 $self->leave_link ($map, $x, $y);
1866 })->prio (1);
1867}
1868
1869=item $player_object->enter_exit ($exit_object)
1870
1871=cut
1872
1873sub parse_random_map_params {
1874 my ($spec) = @_;
1875
1876 my $rmp = { # defaults
1877 xsize => (cf::rndm 15, 40),
1878 ysize => (cf::rndm 15, 40),
1879 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
1880 #layout => string,
1881 };
1882
1883 for (split /\n/, $spec) {
1884 my ($k, $v) = split /\s+/, $_, 2;
1885
1886 $rmp->{lc $k} = $v if (length $k) && (length $v);
1887 }
1888
1889 $rmp
1890}
1891
1892sub prepare_random_map {
1893 my ($exit) = @_;
1894
1895 my $guard = cf::lock_acquire "exit_prepare:$exit";
1896
1897 # all this does is basically replace the /! path by
1898 # a new random map path (?random/...) with a seed
1899 # that depends on the exit object
1900
1901 my $rmp = parse_random_map_params $exit->msg;
1902
1903 if ($exit->map) {
1904 $rmp->{region} = $exit->region->name;
1905 $rmp->{origin_map} = $exit->map->path;
1906 $rmp->{origin_x} = $exit->x;
1907 $rmp->{origin_y} = $exit->y;
1908 }
1909
1910 $rmp->{random_seed} ||= $exit->random_seed;
1911
1912 my $data = cf::to_json $rmp;
1913 my $md5 = Digest::MD5::md5_hex $data;
1914 my $meta = "$cf::RANDOM_MAPS/$md5.meta";
1915
1916 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1917 aio_write $fh, 0, (length $data), $data, 0;
1918 undef $fh;
1919 aio_rename "$meta~", $meta;
1920
1921 $exit->slaying ("?random/$md5");
1922 $exit->msg (undef);
1923 }
1924}
1925
1926sub cf::object::player::enter_exit {
1927 my ($self, $exit) = @_;
1928
1929 return unless $self->type == cf::PLAYER;
1930
1931 if ($exit->slaying eq "/!") {
1932 #TODO: this should de-fi-ni-te-ly not be a sync-job
1933 cf::sync_job { prepare_random_map $exit };
1934 }
1935
1936 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1937 my $hp = $exit->stats->hp;
1938 my $sp = $exit->stats->sp;
1939
1940 $self->enter_link;
1941
1942 (async {
1943 $self->deactivate_recursive; # just to be sure
1944 unless (eval {
1945 $self->goto ($slaying, $hp, $sp);
1946
1947 1;
1948 }) {
1949 $self->message ("Something went wrong deep within the crossfire server. "
1950 . "I'll try to bring you back to the map you were before. "
1951 . "Please report this to the dungeon master!",
1952 cf::NDI_UNIQUE | cf::NDI_RED);
1953
1954 warn "ERROR in enter_exit: $@";
1955 $self->leave_link;
1956 }
1957 })->prio (1);
1958}
1959
932=head3 cf::client 1960=head3 cf::client
933 1961
934=over 4 1962=over 4
935 1963
936=item $client->send_drawinfo ($text, $flags) 1964=item $client->send_drawinfo ($text, $flags)
979 on_reply => sub { 2007 on_reply => sub {
980 my ($ns, $msg) = @_; 2008 my ($ns, $msg) = @_;
981 2009
982 # this weird shuffling is so that direct followup queries 2010 # this weird shuffling is so that direct followup queries
983 # get handled first 2011 # get handled first
984 my $queue = delete $ns->{query_queue}; 2012 my $queue = delete $ns->{query_queue}
2013 or return; # be conservative, not sure how that can happen, but we saw a crash here
985 2014
986 (shift @$queue)->[1]->($msg); 2015 (shift @$queue)->[1]->($msg);
2016 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
987 2017
988 push @{ $ns->{query_queue} }, @$queue; 2018 push @{ $ns->{query_queue} }, @$queue;
989 2019
990 if (@{ $ns->{query_queue} } == @$queue) { 2020 if (@{ $ns->{query_queue} } == @$queue) {
991 if (@$queue) { 2021 if (@$queue) {
995 } 2025 }
996 } 2026 }
997 }, 2027 },
998); 2028);
999 2029
1000=item $client->coro (\&cb) 2030=item $client->async (\&cb)
1001 2031
1002Create a new coroutine, running the specified callback. The coroutine will 2032Create a new coroutine, running the specified callback. The coroutine will
1003be automatically cancelled when the client gets destroyed (e.g. on logout, 2033be automatically cancelled when the client gets destroyed (e.g. on logout,
1004or loss of connection). 2034or loss of connection).
1005 2035
1006=cut 2036=cut
1007 2037
1008sub cf::client::coro { 2038sub cf::client::async {
1009 my ($self, $cb) = @_; 2039 my ($self, $cb) = @_;
1010 2040
1011 my $coro; $coro = async { 2041 my $coro = &Coro::async ($cb);
1012 eval {
1013 $cb->();
1014 };
1015 warn $@ if $@;
1016 };
1017 2042
1018 $coro->on_destroy (sub { 2043 $coro->on_destroy (sub {
1019 delete $self->{_coro}{$coro+0}; 2044 delete $self->{_coro}{$coro+0};
1020 }); 2045 });
1021 2046
1193 2218
1194{ 2219{
1195 my $path = cf::localdir . "/database.pst"; 2220 my $path = cf::localdir . "/database.pst";
1196 2221
1197 sub db_load() { 2222 sub db_load() {
1198 warn "loading database $path\n";#d# remove later
1199 $DB = stat $path ? Storable::retrieve $path : { }; 2223 $DB = stat $path ? Storable::retrieve $path : { };
1200 } 2224 }
1201 2225
1202 my $pid; 2226 my $pid;
1203 2227
1204 sub db_save() { 2228 sub db_save() {
1205 warn "saving database $path\n";#d# remove later
1206 waitpid $pid, 0 if $pid; 2229 waitpid $pid, 0 if $pid;
1207 if (0 == ($pid = fork)) { 2230 if (0 == ($pid = fork)) {
1208 $DB->{_meta}{version} = 1; 2231 $DB->{_meta}{version} = 1;
1209 Storable::nstore $DB, "$path~"; 2232 Storable::nstore $DB, "$path~";
1210 rename "$path~", $path; 2233 rename "$path~", $path;
1217 sub db_sync() { 2240 sub db_sync() {
1218 db_save if $dirty; 2241 db_save if $dirty;
1219 undef $dirty; 2242 undef $dirty;
1220 } 2243 }
1221 2244
1222 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub { 2245 my $idle = Event->idle (
1223 db_sync; 2246 reentrant => 0,
2247 min => 10,
2248 max => 20,
2249 repeat => 0,
2250 data => WF_AUTOCANCEL,
2251 cb => \&db_sync,
1224 }); 2252 );
1225 2253
1226 sub db_dirty() { 2254 sub db_dirty() {
1227 $dirty = 1; 2255 $dirty = 1;
1228 $idle->start; 2256 $idle->start;
1229 } 2257 }
1250 }, 2278 },
1251 ); 2279 );
1252} 2280}
1253 2281
1254############################################################################# 2282#############################################################################
1255# the server's main() 2283# the server's init and main functions
2284
2285sub load_resources {
2286 load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir
2287 or die "unable to load regions file\n";#d#
2288}
1256 2289
1257sub cfg_load { 2290sub cfg_load {
1258 open my $fh, "<:utf8", cf::confdir . "/config" 2291 open my $fh, "<:utf8", cf::confdir . "/config"
1259 or return; 2292 or return;
1260 2293
1261 local $/; 2294 local $/;
1262 *CFG = YAML::Syck::Load <$fh>; 2295 *CFG = YAML::Syck::Load <$fh>;
2296
2297 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2298
2299 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2300 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2301
2302 if (exists $CFG{mlockall}) {
2303 eval {
2304 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2305 and die "WARNING: m(un)lockall failed: $!\n";
2306 };
2307 warn $@ if $@;
2308 }
2309}
2310
2311sub init {
2312 load_resources;
1263} 2313}
1264 2314
1265sub main { 2315sub main {
2316 # we must not ever block the main coroutine
2317 local $Coro::idle = sub {
2318 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2319 (async {
2320 Event::one_event;
2321 })->prio (Coro::PRIO_MAX);
2322 };
2323
1266 cfg_load; 2324 cfg_load;
1267 db_load; 2325 db_load;
1268 load_extensions; 2326 load_extensions;
2327
2328 $TICK_WATCHER->start;
1269 Event::loop; 2329 Event::loop;
1270} 2330}
1271 2331
1272############################################################################# 2332#############################################################################
1273# initialisation 2333# initialisation and cleanup
1274 2334
2335# install some emergency cleanup handlers
2336BEGIN {
2337 for my $signal (qw(INT HUP TERM)) {
2338 Event->signal (
2339 reentrant => 0,
2340 data => WF_AUTOCANCEL,
2341 signal => $signal,
2342 prio => 0,
2343 cb => sub {
2344 cf::cleanup "SIG$signal";
2345 },
2346 );
2347 }
2348}
2349
2350sub emergency_save() {
2351 my $freeze_guard = cf::freeze_mainloop;
2352
2353 warn "enter emergency perl save\n";
2354
2355 cf::sync_job {
2356 # use a peculiar iteration method to avoid tripping on perl
2357 # refcount bugs in for. also avoids problems with players
2358 # and maps saved/destroyed asynchronously.
2359 warn "begin emergency player save\n";
2360 for my $login (keys %cf::PLAYER) {
2361 my $pl = $cf::PLAYER{$login} or next;
2362 $pl->valid or next;
2363 $pl->save;
2364 }
2365 warn "end emergency player save\n";
2366
2367 warn "begin emergency map save\n";
2368 for my $path (keys %cf::MAP) {
2369 my $map = $cf::MAP{$path} or next;
2370 $map->valid or next;
2371 $map->save;
2372 }
2373 warn "end emergency map save\n";
2374 };
2375
2376 warn "leave emergency perl save\n";
2377}
2378
1275sub _perl_reload() { 2379sub reload() {
2380 # can/must only be called in main
2381 if ($Coro::current != $Coro::main) {
2382 warn "can only reload from main coroutine";
2383 return;
2384 }
2385
1276 warn "reloading..."; 2386 warn "reloading...";
1277 2387
2388 warn "cancelling server ticker";
2389 $TICK_WATCHER->cancel;
2390
2391 cf::emergency_save;
2392
1278 eval { 2393 eval {
1279 local $FREEZE = 1; 2394 # if anything goes wrong in here, we should simply crash as we already saved
1280 2395
1281 cf::emergency_save; 2396 warn "syncing database to disk";
2397 cf::db_sync;
1282 2398
1283 # cancel all watchers 2399 warn "cancelling all WF_AUTOCANCEL watchers";
1284 for (Event::all_watchers) { 2400 for (Event::all_watchers) {
1285 $_->cancel if $_->data & WF_AUTOCANCEL; 2401 $_->cancel if $_->data & WF_AUTOCANCEL;
1286 } 2402 }
1287 2403
2404 warn "flushing outstanding aio requests";
2405 for (;;) {
2406 IO::AIO::flush;
2407 Coro::cede;
2408 last unless IO::AIO::nreqs;
2409 warn "iterate...";
2410 }
2411
1288 # cancel all extension coros 2412 warn "cancelling all extension coros";
1289 $_->cancel for values %EXT_CORO; 2413 $_->cancel for values %EXT_CORO;
1290 %EXT_CORO = (); 2414 %EXT_CORO = ();
1291 2415
1292 # unload all extensions 2416 warn "removing commands";
1293 for (@exts) { 2417 %COMMAND = ();
2418
2419 warn "removing ext commands";
2420 %EXTCMD = ();
2421
2422 warn "unloading/nuking all extensions";
2423 for my $pkg (@EXTS) {
1294 warn "unloading <$_>"; 2424 warn "... unloading $pkg";
1295 unload_extension $_; 2425
2426 if (my $cb = $pkg->can ("unload")) {
2427 eval {
2428 $cb->($pkg);
2429 1
2430 } or warn "$pkg unloaded, but with errors: $@";
1296 } 2431 }
1297 2432
2433 warn "... nuking $pkg";
2434 Symbol::delete_package $pkg;
2435 }
2436
1298 # unload all modules loaded from $LIBDIR 2437 warn "unloading all perl modules loaded from $LIBDIR";
1299 while (my ($k, $v) = each %INC) { 2438 while (my ($k, $v) = each %INC) {
1300 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2439 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1301 2440
1302 warn "removing <$k>"; 2441 warn "... unloading $k";
1303 delete $INC{$k}; 2442 delete $INC{$k};
1304 2443
1305 $k =~ s/\.pm$//; 2444 $k =~ s/\.pm$//;
1306 $k =~ s/\//::/g; 2445 $k =~ s/\//::/g;
1307 2446
1310 } 2449 }
1311 2450
1312 Symbol::delete_package $k; 2451 Symbol::delete_package $k;
1313 } 2452 }
1314 2453
1315 # sync database to disk
1316 cf::db_sync;
1317 IO::AIO::flush;
1318
1319 # get rid of safe::, as good as possible 2454 warn "getting rid of safe::, as good as possible";
1320 Symbol::delete_package "safe::$_" 2455 Symbol::delete_package "safe::$_"
1321 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 2456 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1322 2457
1323 # remove register_script_function callbacks
1324 # TODO
1325
1326 # unload cf.pm "a bit" 2458 warn "unloading cf.pm \"a bit\"";
1327 delete $INC{"cf.pm"}; 2459 delete $INC{"cf.pm"};
1328 2460
1329 # don't, removes xs symbols, too, 2461 # don't, removes xs symbols, too,
1330 # and global variables created in xs 2462 # and global variables created in xs
1331 #Symbol::delete_package __PACKAGE__; 2463 #Symbol::delete_package __PACKAGE__;
1332 2464
1333 # reload cf.pm 2465 warn "unload completed, starting to reload now";
2466
1334 warn "reloading cf.pm"; 2467 warn "reloading cf.pm";
1335 require cf; 2468 require cf;
1336 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2469 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1337 2470
1338 # load config and database again 2471 warn "loading config and database again";
1339 cf::cfg_load; 2472 cf::cfg_load;
1340 cf::db_load; 2473 cf::db_load;
1341 2474
1342 # load extensions
1343 warn "load extensions"; 2475 warn "loading extensions";
1344 cf::load_extensions; 2476 cf::load_extensions;
1345 2477
1346 # reattach attachments to objects 2478 warn "reattaching attachments to objects/players";
1347 warn "reattach";
1348 _global_reattach; 2479 _global_reattach;
2480 warn "reattaching attachments to maps";
2481 reattach $_ for values %MAP;
2482
2483 warn "loading reloadable resources";
2484 load_resources;
2485
2486 warn "restarting server ticker";
2487
2488 $TICK_WATCHER->start;
1349 }; 2489 };
1350 warn $@ if $@; 2490
2491 if ($@) {
2492 warn $@;
2493 warn "error while reloading, exiting.";
2494 exit 1;
2495 }
1351 2496
1352 warn "reloaded"; 2497 warn "reloaded";
1353}; 2498};
1354 2499
1355sub perl_reload() { 2500our $RELOAD_WATCHER; # used only during reload
1356 _perl_reload;
1357}
1358 2501
1359register "<global>", __PACKAGE__;
1360
1361register_command "perl-reload" => sub { 2502register_command "reload" => sub {
1362 my ($who, $arg) = @_; 2503 my ($who, $arg) = @_;
1363 2504
1364 if ($who->flag (FLAG_WIZ)) { 2505 if ($who->flag (FLAG_WIZ)) {
1365 $who->message ("reloading..."); 2506 $who->message ("reloading server.");
1366 _perl_reload; 2507
2508 # doing reload synchronously and two reloads happen back-to-back,
2509 # coro crashes during coro_state_free->destroy here.
2510
2511 $RELOAD_WATCHER ||= Event->timer (
2512 reentrant => 0,
2513 after => 0,
2514 data => WF_AUTOCANCEL,
2515 cb => sub {
2516 reload;
2517 undef $RELOAD_WATCHER;
2518 },
2519 );
1367 } 2520 }
1368}; 2521};
1369 2522
1370unshift @INC, $LIBDIR; 2523unshift @INC, $LIBDIR;
2524
2525my $bug_warning = 0;
1371 2526
1372$TICK_WATCHER = Event->timer ( 2527$TICK_WATCHER = Event->timer (
1373 reentrant => 0, 2528 reentrant => 0,
2529 parked => 1,
1374 prio => 0, 2530 prio => 0,
1375 at => $NEXT_TICK || $TICK, 2531 at => $NEXT_TICK || $TICK,
1376 data => WF_AUTOCANCEL, 2532 data => WF_AUTOCANCEL,
1377 cb => sub { 2533 cb => sub {
1378 unless ($FREEZE) { 2534 if ($Coro::current != $Coro::main) {
2535 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2536 unless ++$bug_warning > 10;
2537 return;
2538 }
2539
2540 $NOW = Event::time;
2541
1379 cf::server_tick; # one server iteration 2542 cf::server_tick; # one server iteration
1380 $RUNTIME += $TICK; 2543 $RUNTIME += $TICK;
1381 }
1382
1383 $NEXT_TICK += $TICK; 2544 $NEXT_TICK += $TICK;
2545
2546 $WAIT_FOR_TICK->broadcast;
2547 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2548
2549 Event::sweep;
2550 Coro::cede_notself;
2551
2552# my $AFTER = Event::time;
2553# warn $AFTER - $NOW;#d#
1384 2554
1385 # if we are delayed by four ticks or more, skip them all 2555 # if we are delayed by four ticks or more, skip them all
1386 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 2556 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1387 2557
1388 $TICK_WATCHER->at ($NEXT_TICK); 2558 $TICK_WATCHER->at ($NEXT_TICK);
1389 $TICK_WATCHER->start; 2559 $TICK_WATCHER->start;
1390 }, 2560 },
1391); 2561);
1392 2562
2563{
2564 BDB::max_poll_time $TICK * 0.1;
2565 $BDB_POLL_WATCHER = Event->io (
2566 reentrant => 0,
2567 fd => BDB::poll_fileno,
2568 poll => 'r',
2569 prio => 0,
2570 data => WF_AUTOCANCEL,
2571 cb => \&BDB::poll_cb,
2572 );
2573 BDB::min_parallel 8;
2574
2575 BDB::set_sync_prepare {
2576 my $status;
2577 my $current = $Coro::current;
2578 (
2579 sub {
2580 $status = $!;
2581 $current->ready; undef $current;
2582 },
2583 sub {
2584 Coro::schedule while defined $current;
2585 $! = $status;
2586 },
2587 )
2588 };
2589
2590 unless ($DB_ENV) {
2591 $DB_ENV = BDB::db_env_create;
2592
2593 cf::sync_job {
2594 BDB::db_env_open
2595 $DB_ENV,
2596 $BDB_ENV_DIR,
2597 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2598 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2599 0666;
2600
2601 cf::cleanup "$!" if $!;
2602
2603 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2604 $DB_ENV->set_lk_detect;
2605 };
2606 }
2607}
2608
2609{
2610 IO::AIO::min_parallel 8;
2611
2612 undef $Coro::AIO::WATCHER;
1393IO::AIO::max_poll_time $TICK * 0.2; 2613 IO::AIO::max_poll_time $TICK * 0.1;
1394 2614 $AIO_POLL_WATCHER = Event->io (
1395Event->io (fd => IO::AIO::poll_fileno, 2615 reentrant => 0,
2616 fd => IO::AIO::poll_fileno,
1396 poll => 'r', 2617 poll => 'r',
1397 prio => 5, 2618 prio => 6,
1398 data => WF_AUTOCANCEL, 2619 data => WF_AUTOCANCEL,
1399 cb => \&IO::AIO::poll_cb); 2620 cb => \&IO::AIO::poll_cb,
2621 );
2622}
1400 2623
1401# we must not ever block the main coroutine 2624$WRITE_RUNTIME_WATCHER = Event->timer (
1402$Coro::idle = sub { 2625 reentrant => 0,
1403 #Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d# 2626 data => WF_AUTOCANCEL,
1404 warn "FATAL: Coro::idle was called, major BUG\n"; 2627 after => 1,
2628 interval => 10,
2629 prio => 6, # keep it lowest so it acts like a watchdog
1405 (Coro::unblock_sub { 2630 cb => Coro::unblock_sub {
1406 Event::one_event; 2631 write_runtime
1407 })->(); 2632 or warn "ERROR: unable to write runtime file: $!";
1408}; 2633 },
2634);
2635
2636END { cf::emergency_save }
1409 2637
14101 26381
1411 2639

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines