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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines