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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines