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.106 by root, Sun Dec 31 17:29:22 2006 UTC vs.
Revision 1.195 by root, Fri Jan 26 20:59:57 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines