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.189 by root, Sun Jan 21 21:28:27 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.4 ();
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 # map plan:
1182 #
1183 # /! non-realised random map exit (special hack!)
1184 # {... are special paths that are not being touched
1185 # ?xxx/... are special absolute paths
1186 # ?random/... random maps
1187 # /... normal maps
1188 # ~user/... per-player map of a specific user
1189
1190 $path =~ s/$PATH_SEP/\//go;
1191
1192 # treat it as relative path if it starts with
1193 # something that looks reasonable
1194 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1195 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1196
1197 $base =~ s{[^/]+/?$}{};
1198 $path = "$base/$path";
1199 }
1200
1201 for ($path) {
1202 redo if s{//}{/};
1203 redo if s{/\.?/}{/};
1204 redo if s{/[^/]+/\.\./}{/};
1205 }
1206
1207 $path
1208}
1209
1210sub new_from_path {
1211 my (undef, $path, $base) = @_;
1212
1213 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1214
1215 $path = normalise $path, $base;
1216
1217 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1218 if ($path =~ $EXT_MAP{$pkg}[1]) {
1219 my $self = bless cf::map::new, $pkg;
1220 $self->{path} = $path; $self->path ($path);
1221 $self->init; # pass $1 etc.
1222 return $self;
1223 }
1224 }
1225
1226 Carp::carp "unable to resolve path '$path'.";
1227 ()
1228}
1229
1230sub init {
1231 my ($self) = @_;
1232
1233 $self
1234}
1235
1236sub as_string {
1237 my ($self) = @_;
1238
1239 "$self->{path}"
1240}
1241
1242# the displayed name, this is a one way mapping
1243sub visible_name {
1244 &as_string
1245}
1246
1247# the original (read-only) location
1248sub load_path {
1249 my ($self) = @_;
1250
1251 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
1252}
1253
1254# the temporary/swap location
1255sub save_path {
1256 my ($self) = @_;
1257
1258 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1259 sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path
1260}
1261
1262# the unique path, undef == no special unique path
1263sub uniq_path {
1264 my ($self) = @_;
1265
1266 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1267 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
1268}
1269
1270# and all this just because we cannot iterate over
1271# all maps in C++...
1272sub change_all_map_light {
1273 my ($change) = @_;
1274
1275 $_->change_map_light ($change)
1276 for grep $_->outdoor, values %cf::MAP;
1277}
1278
1279sub unlink_save {
1280 my ($self) = @_;
1281
1282 utf8::encode (my $save = $self->save_path);
1283 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1284 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1285}
1286
1287sub load_header_from($) {
1288 my ($self, $path) = @_;
1289
1290 utf8::encode $path;
1291 aio_open $path, O_RDONLY, 0
1292 or return;
1293
1294 $self->_load_header ($path)
1295 or return;
1296
1297 $self->{load_path} = $path;
1298
1299 1
1300}
1301
1302sub load_header_orig {
1303 my ($self) = @_;
1304
1305 $self->load_header_from ($self->load_path)
1306}
1307
1308sub load_header_temp {
1309 my ($self) = @_;
1310
1311 $self->load_header_from ($self->save_path)
1312}
1313
1314sub prepare_temp {
1315 my ($self) = @_;
1316
1317 $self->last_access ((delete $self->{last_access})
1318 || $cf::RUNTIME); #d#
1319 # safety
1320 $self->{instantiate_time} = $cf::RUNTIME
1321 if $self->{instantiate_time} > $cf::RUNTIME;
1322}
1323
1324sub prepare_orig {
1325 my ($self) = @_;
1326
1327 $self->{load_original} = 1;
1328 $self->{instantiate_time} = $cf::RUNTIME;
1329 $self->last_access ($cf::RUNTIME);
1330 $self->instantiate;
1331}
1332
1333sub load_header {
1334 my ($self) = @_;
1335
1336 if ($self->load_header_temp) {
1337 $self->prepare_temp;
1338 } else {
1339 $self->load_header_orig
1340 or return;
1341 $self->prepare_orig;
1342 }
1343
1344 1
1345}
1346
1347sub find;
1348sub find {
1349 my ($path, $origin) = @_;
1350
1351 $path = normalise $path, $origin && $origin->path;
1352
1353 cf::lock_wait "map_find:$path";
1354
1355 $cf::MAP{$path} || do {
1356 my $guard = cf::lock_acquire "map_find:$path";
1357 my $map = new_from_path cf::map $path
1358 or return;
1359
1360 $map->{last_save} = $cf::RUNTIME;
1361
1362 $map->load_header
1363 or return;
1364
1365 if ($map->should_reset) {
1366 # doing this can freeze the server in a sync job, obviously
1367 #$cf::WAIT_FOR_TICK->wait;
1368 $map->reset;
1369 undef $guard;
1370 $map = find $path
1371 or return;
1372 }
1373
1374 $cf::MAP{$path} = $map
1375 }
1376}
1377
1378sub pre_load { }
1379sub post_load { }
1380
1381sub load {
1382 my ($self) = @_;
1383
1384 my $path = $self->{path};
1385 my $guard = cf::lock_acquire "map_load:$path";
1386
1387 return if $self->in_memory != cf::MAP_SWAPPED;
1388
1389 $self->in_memory (cf::MAP_LOADING);
1390
1391 $self->alloc;
1392
1393 $self->pre_load;
1394
1395 $self->_load_objects ($self->{load_path}, 1)
1396 or return;
1397
1398 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1399 if delete $self->{load_original};
1400
1401 if (my $uniq = $self->uniq_path) {
1402 utf8::encode $uniq;
1403 if (aio_open $uniq, O_RDONLY, 0) {
1404 $self->clear_unique_items;
1405 $self->_load_objects ($uniq, 0);
1406 }
1407 }
1408
1409 Coro::cede;
1410
1411 # now do the right thing for maps
1412 $self->link_multipart_objects;
1413
1414 unless ($self->{deny_activate}) {
1415 $self->decay_objects;
1416 $self->fix_auto_apply;
1417 $self->update_buttons;
1418 Coro::cede;
1419 $self->set_darkness_map;
1420 $self->difficulty ($self->estimate_difficulty)
1421 unless $self->difficulty;
1422 Coro::cede;
1423 $self->activate;
1424 }
1425
1426 $self->post_load;
1427
1428 $self->in_memory (cf::MAP_IN_MEMORY);
1429}
1430
1431sub customise_for {
1432 my ($self, $ob) = @_;
1433
1434 return find "~" . $ob->name . "/" . $self->{path}
1435 if $self->per_player;
1436
1437 $self
1438}
1439
1440# find and load all maps in the 3x3 area around a map
1441sub load_diag {
830 my ($map) = @_; 1442 my ($map) = @_;
831 1443
832 my $path = $map->tmpname; 1444 my @diag; # diagonal neighbours
833 defined $path or return;
834 1445
835 unlink "$path.pst"; 1446 for (0 .. 3) {
836}; 1447 my $neigh = $map->tile_path ($_)
1448 or next;
1449 $neigh = find $neigh, $map
1450 or next;
1451 $neigh->load;
837 1452
838cf::map->attach (prio => -10000, package => cf::mapsupport::); 1453 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1454 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1455 }
839 1456
840############################################################################# 1457 for (@diag) {
841# load/save perl data associated with player->ob objects 1458 my $neigh = find @$_
842 1459 or next;
843sub all_objects(@) { 1460 $neigh->load;
844 @_, map all_objects ($_->inv), @_ 1461 }
845} 1462}
846 1463
847# TODO: compatibility cruft, remove when no longer needed 1464sub find_sync {
848cf::player->attach ( 1465 my ($path, $origin) = @_;
849 on_load => sub {
850 my ($pl, $path) = @_;
851 1466
852 for my $o (all_objects $pl->ob) { 1467 cf::sync_job { find $path, $origin }
853 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1468}
854 $o->set_ob_key_value ("_perl_data");
855 1469
856 %$o = %{ Storable::thaw pack "H*", $value }; 1470sub do_load_sync {
1471 my ($map) = @_;
1472
1473 cf::sync_job { $map->load };
1474}
1475
1476our %MAP_PREFETCH;
1477our $MAP_PREFETCHER = undef;
1478
1479sub find_async {
1480 my ($path, $origin) = @_;
1481
1482 $path = normalise $path, $origin && $origin->{path};
1483
1484 if (my $map = $cf::MAP{$path}) {
1485 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1486 }
1487
1488 undef $MAP_PREFETCH{$path};
1489 $MAP_PREFETCHER ||= cf::async {
1490 while (%MAP_PREFETCH) {
1491 for my $path (keys %MAP_PREFETCH) {
1492 my $map = find $path
1493 or next;
1494 $map->load;
1495
1496 delete $MAP_PREFETCH{$path};
857 } 1497 }
858 } 1498 }
1499 undef $MAP_PREFETCHER;
1500 };
1501 $MAP_PREFETCHER->prio (6);
1502
1503 ()
1504}
1505
1506sub save {
1507 my ($self) = @_;
1508
1509 my $lock = cf::lock_acquire "map_data:" . $self->path;
1510
1511 $self->{last_save} = $cf::RUNTIME;
1512
1513 return unless $self->dirty;
1514
1515 my $save = $self->save_path; utf8::encode $save;
1516 my $uniq = $self->uniq_path; utf8::encode $uniq;
1517
1518 $self->{load_path} = $save;
1519
1520 return if $self->{deny_save};
1521
1522 local $self->{last_access} = $self->last_access;#d#
1523
1524 cf::async {
1525 $_->contr->save for $self->players;
1526 };
1527
1528 if ($uniq) {
1529 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1530 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1531 } else {
1532 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
859 }, 1533 }
860); 1534}
861 1535
862############################################################################# 1536sub swap_out {
1537 my ($self) = @_;
863 1538
864=head2 CORE EXTENSIONS 1539 # save first because save cedes
1540 $self->save;
865 1541
866Functions and methods that extend core crossfire objects. 1542 my $lock = cf::lock_acquire "map_data:" . $self->path;
867 1543
868=head3 cf::player 1544 return if $self->players;
1545 return if $self->in_memory != cf::MAP_IN_MEMORY;
1546 return if $self->{deny_save};
1547
1548 $self->clear;
1549 $self->in_memory (cf::MAP_SWAPPED);
1550}
1551
1552sub reset_at {
1553 my ($self) = @_;
1554
1555 # TODO: safety, remove and allow resettable per-player maps
1556 return 1e99 if $self->isa ("ext::map_per_player");#d#
1557 return 1e99 if $self->{deny_reset};
1558
1559 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1560 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1561
1562 $time + $to
1563}
1564
1565sub should_reset {
1566 my ($self) = @_;
1567
1568 $self->reset_at <= $cf::RUNTIME
1569}
1570
1571sub reset {
1572 my ($self) = @_;
1573
1574 my $lock = cf::lock_acquire "map_data:$self->{path}";
1575
1576 return if $self->players;
1577 return if $self->isa ("ext::map_per_player");#d#
1578
1579 warn "resetting map ", $self->path;#d#
1580
1581 delete $cf::MAP{$self->path};
1582
1583 $self->in_memory (cf::MAP_SWAPPED);
1584 $self->clear;
1585
1586 $_->clear_links_to ($self) for values %cf::MAP;
1587
1588 $self->unlink_save;
1589 $self->destroy;
1590}
1591
1592my $nuke_counter = "aaaa";
1593
1594sub nuke {
1595 my ($self) = @_;
1596
1597 delete $cf::MAP{$self->path};
1598
1599 $self->unlink_save;
1600
1601 bless $self, "cf::map";
1602 delete $self->{deny_reset};
1603 $self->{deny_save} = 1;
1604 $self->reset_timeout (1);
1605 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1606
1607 $cf::MAP{$self->path} = $self;
1608
1609 $self->reset; # polite request, might not happen
1610}
1611
1612=item cf::map::unique_maps
1613
1614Returns an arrayref of paths of all shared maps that have
1615instantiated unique items. May block.
1616
1617=cut
1618
1619sub unique_maps() {
1620 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
1621 or return;
1622
1623 my @paths;
1624
1625 for (@$files) {
1626 utf8::decode $_;
1627 next if /\.pst$/;
1628 next unless /^$PATH_SEP/o;
1629
1630 s/\.map$//;
1631 push @paths, $_;
1632 }
1633
1634 \@paths
1635}
1636
1637package cf;
1638
1639=back
1640
1641=head3 cf::object
1642
1643=cut
1644
1645package cf::object;
869 1646
870=over 4 1647=over 4
871 1648
872=item cf::player::exists $login 1649=item $ob->inv_recursive
873 1650
874Returns true when the given account exists. 1651Returns the inventory of the object _and_ their inventories, recursively.
875 1652
876=cut 1653=cut
877 1654
878sub cf::player::exists($) { 1655sub inv_recursive_;
879 cf::player::find $_[0] 1656sub inv_recursive_ {
880 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1657 map { $_, inv_recursive_ $_->inv } @_
881} 1658}
882 1659
883=item $player->ext_reply ($msgid, $msgtype, %msg) 1660sub inv_recursive {
884 1661 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} 1662}
1663
1664package cf;
896 1665
897=back 1666=back
898 1667
899=head3 cf::object::player 1668=head3 cf::object::player
900 1669
938 (ref $cf::CFG{"may_$access"} 1707 (ref $cf::CFG{"may_$access"}
939 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1708 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
940 : $cf::CFG{"may_$access"}) 1709 : $cf::CFG{"may_$access"})
941} 1710}
942 1711
1712=item $player_object->enter_link
1713
1714Freezes the player and moves him/her to a special map (C<{link}>).
1715
1716The player should be reasonably safe there for short amounts of time. You
1717I<MUST> call C<leave_link> as soon as possible, though.
1718
1719Will never block.
1720
1721=item $player_object->leave_link ($map, $x, $y)
1722
1723Moves the player out of the special C<{link}> map onto the specified
1724map. If the map is not valid (or omitted), the player will be moved back
1725to the location he/she was before the call to C<enter_link>, or, if that
1726fails, to the emergency map position.
1727
1728Might block.
1729
1730=cut
1731
1732sub link_map {
1733 unless ($LINK_MAP) {
1734 $LINK_MAP = cf::map::find "{link}"
1735 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };
1736 $LINK_MAP->load;
1737 }
1738
1739 $LINK_MAP
1740}
1741
1742sub cf::object::player::enter_link {
1743 my ($self) = @_;
1744
1745 $self->deactivate_recursive;
1746
1747 return if UNIVERSAL::isa $self->map, "ext::map_link";
1748
1749 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1750 if $self->map;
1751
1752 $self->enter_map ($LINK_MAP || link_map, 20, 20);
1753}
1754
1755sub cf::object::player::leave_link {
1756 my ($self, $map, $x, $y) = @_;
1757
1758 my $link_pos = delete $self->{_link_pos};
1759
1760 unless ($map) {
1761 # restore original map position
1762 ($map, $x, $y) = @{ $link_pos || [] };
1763 $map = cf::map::find $map;
1764
1765 unless ($map) {
1766 ($map, $x, $y) = @$EMERGENCY_POSITION;
1767 $map = cf::map::find $map
1768 or die "FATAL: cannot load emergency map\n";
1769 }
1770 }
1771
1772 ($x, $y) = (-1, -1)
1773 unless (defined $x) && (defined $y);
1774
1775 # use -1 or undef as default coordinates, not 0, 0
1776 ($x, $y) = ($map->enter_x, $map->enter_y)
1777 if $x <=0 && $y <= 0;
1778
1779 $map->load;
1780 $map->load_diag;
1781
1782 return unless $self->contr->active;
1783 $self->activate_recursive;
1784 $self->enter_map ($map, $x, $y);
1785}
1786
1787cf::player->attach (
1788 on_logout => sub {
1789 my ($pl) = @_;
1790
1791 # abort map switching before logout
1792 if ($pl->ob->{_link_pos}) {
1793 cf::sync_job {
1794 $pl->ob->leave_link
1795 };
1796 }
1797 },
1798 on_login => sub {
1799 my ($pl) = @_;
1800
1801 # try to abort aborted map switching on player login :)
1802 # should happen only on crashes
1803 if ($pl->ob->{_link_pos}) {
1804 $pl->ob->enter_link;
1805 (async {
1806 # we need this sleep as the login has a concurrent enter_exit running
1807 # and this sleep increases chances of the player not ending up in scorn
1808 $pl->ob->reply (undef,
1809 "There was an internal problem at your last logout, "
1810 . "the server will try to bring you to your intended destination in a second.",
1811 cf::NDI_RED);
1812 Coro::Timer::sleep 1;
1813 $pl->ob->leave_link;
1814 })->prio (2);
1815 }
1816 },
1817);
1818
1819=item $player_object->goto ($path, $x, $y)
1820
1821=cut
1822
1823sub cf::object::player::goto {
1824 my ($self, $path, $x, $y) = @_;
1825
1826 $self->enter_link;
1827
1828 (async {
1829 my $map = cf::map::find $path;
1830 $map = $map->customise_for ($self) if $map;
1831
1832# warn "entering ", $map->path, " at ($x, $y)\n"
1833# if $map;
1834
1835 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1836
1837 $self->leave_link ($map, $x, $y);
1838 })->prio (1);
1839}
1840
1841=item $player_object->enter_exit ($exit_object)
1842
1843=cut
1844
1845sub parse_random_map_params {
1846 my ($spec) = @_;
1847
1848 my $rmp = { # defaults
1849 xsize => (cf::rndm 15, 40),
1850 ysize => (cf::rndm 15, 40),
1851 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
1852 #layout => string,
1853 };
1854
1855 for (split /\n/, $spec) {
1856 my ($k, $v) = split /\s+/, $_, 2;
1857
1858 $rmp->{lc $k} = $v if (length $k) && (length $v);
1859 }
1860
1861 $rmp
1862}
1863
1864sub prepare_random_map {
1865 my ($exit) = @_;
1866
1867 my $guard = cf::lock_acquire "exit_prepare:$exit";
1868
1869 # all this does is basically replace the /! path by
1870 # a new random map path (?random/...) with a seed
1871 # that depends on the exit object
1872
1873 my $rmp = parse_random_map_params $exit->msg;
1874
1875 if ($exit->map) {
1876 $rmp->{region} = $exit->map->region_name;
1877 $rmp->{origin_map} = $exit->map->path;
1878 $rmp->{origin_x} = $exit->x;
1879 $rmp->{origin_y} = $exit->y;
1880 }
1881
1882 $rmp->{random_seed} ||= $exit->random_seed;
1883
1884 my $data = cf::to_json $rmp;
1885 my $md5 = Digest::MD5::md5_hex $data;
1886 my $meta = "$cf::RANDOM_MAPS/$md5.meta";
1887
1888 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1889 aio_write $fh, 0, (length $data), $data, 0;
1890 undef $fh;
1891 aio_rename "$meta~", $meta;
1892
1893 $exit->slaying ("?random/$md5");
1894 $exit->msg (undef);
1895 }
1896}
1897
1898sub cf::object::player::enter_exit {
1899 my ($self, $exit) = @_;
1900
1901 return unless $self->type == cf::PLAYER;
1902
1903 $self->enter_link;
1904
1905 (async {
1906 $self->deactivate_recursive; # just to be sure
1907 unless (eval {
1908 prepare_random_map $exit
1909 if $exit->slaying eq "/!";
1910
1911 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1912 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1913
1914 1;
1915 }) {
1916 $self->message ("Something went wrong deep within the crossfire server. "
1917 . "I'll try to bring you back to the map you were before. "
1918 . "Please report this to the dungeon master!",
1919 cf::NDI_UNIQUE | cf::NDI_RED);
1920
1921 warn "ERROR in enter_exit: $@";
1922 $self->leave_link;
1923 }
1924 })->prio (1);
1925}
1926
943=head3 cf::client 1927=head3 cf::client
944 1928
945=over 4 1929=over 4
946 1930
947=item $client->send_drawinfo ($text, $flags) 1931=item $client->send_drawinfo ($text, $flags)
990 on_reply => sub { 1974 on_reply => sub {
991 my ($ns, $msg) = @_; 1975 my ($ns, $msg) = @_;
992 1976
993 # this weird shuffling is so that direct followup queries 1977 # this weird shuffling is so that direct followup queries
994 # get handled first 1978 # get handled first
995 my $queue = delete $ns->{query_queue}; 1979 my $queue = delete $ns->{query_queue}
1980 or return; # be conservative, not sure how that can happen, but we saw a crash here
996 1981
997 (shift @$queue)->[1]->($msg); 1982 (shift @$queue)->[1]->($msg);
998 1983
999 push @{ $ns->{query_queue} }, @$queue; 1984 push @{ $ns->{query_queue} }, @$queue;
1000 1985
1006 } 1991 }
1007 } 1992 }
1008 }, 1993 },
1009); 1994);
1010 1995
1011=item $client->coro (\&cb) 1996=item $client->async (\&cb)
1012 1997
1013Create a new coroutine, running the specified callback. The coroutine will 1998Create a new coroutine, running the specified callback. The coroutine will
1014be automatically cancelled when the client gets destroyed (e.g. on logout, 1999be automatically cancelled when the client gets destroyed (e.g. on logout,
1015or loss of connection). 2000or loss of connection).
1016 2001
1017=cut 2002=cut
1018 2003
1019sub cf::client::coro { 2004sub cf::client::async {
1020 my ($self, $cb) = @_; 2005 my ($self, $cb) = @_;
1021 2006
1022 my $coro; $coro = async { 2007 my $coro = &Coro::async ($cb);
1023 eval {
1024 $cb->();
1025 };
1026 warn $@ if $@;
1027 };
1028 2008
1029 $coro->on_destroy (sub { 2009 $coro->on_destroy (sub {
1030 delete $self->{_coro}{$coro+0}; 2010 delete $self->{_coro}{$coro+0};
1031 }); 2011 });
1032 2012
1204 2184
1205{ 2185{
1206 my $path = cf::localdir . "/database.pst"; 2186 my $path = cf::localdir . "/database.pst";
1207 2187
1208 sub db_load() { 2188 sub db_load() {
1209 warn "loading database $path\n";#d# remove later
1210 $DB = stat $path ? Storable::retrieve $path : { }; 2189 $DB = stat $path ? Storable::retrieve $path : { };
1211 } 2190 }
1212 2191
1213 my $pid; 2192 my $pid;
1214 2193
1215 sub db_save() { 2194 sub db_save() {
1216 warn "saving database $path\n";#d# remove later
1217 waitpid $pid, 0 if $pid; 2195 waitpid $pid, 0 if $pid;
1218 if (0 == ($pid = fork)) { 2196 if (0 == ($pid = fork)) {
1219 $DB->{_meta}{version} = 1; 2197 $DB->{_meta}{version} = 1;
1220 Storable::nstore $DB, "$path~"; 2198 Storable::nstore $DB, "$path~";
1221 rename "$path~", $path; 2199 rename "$path~", $path;
1228 sub db_sync() { 2206 sub db_sync() {
1229 db_save if $dirty; 2207 db_save if $dirty;
1230 undef $dirty; 2208 undef $dirty;
1231 } 2209 }
1232 2210
1233 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub { 2211 my $idle = Event->idle (
1234 db_sync; 2212 reentrant => 0,
2213 min => 10,
2214 max => 20,
2215 repeat => 0,
2216 data => WF_AUTOCANCEL,
2217 cb => \&db_sync,
1235 }); 2218 );
1236 2219
1237 sub db_dirty() { 2220 sub db_dirty() {
1238 $dirty = 1; 2221 $dirty = 1;
1239 $idle->start; 2222 $idle->start;
1240 } 2223 }
1269 open my $fh, "<:utf8", cf::confdir . "/config" 2252 open my $fh, "<:utf8", cf::confdir . "/config"
1270 or return; 2253 or return;
1271 2254
1272 local $/; 2255 local $/;
1273 *CFG = YAML::Syck::Load <$fh>; 2256 *CFG = YAML::Syck::Load <$fh>;
2257
2258 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2259
2260 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2261 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2262
2263 if (exists $CFG{mlockall}) {
2264 eval {
2265 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2266 and die "WARNING: m(un)lockall failed: $!\n";
2267 };
2268 warn $@ if $@;
2269 }
1274} 2270}
1275 2271
1276sub main { 2272sub main {
2273 # we must not ever block the main coroutine
2274 local $Coro::idle = sub {
2275 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2276 (async {
2277 Event::one_event;
2278 })->prio (Coro::PRIO_MAX);
2279 };
2280
1277 cfg_load; 2281 cfg_load;
1278 db_load; 2282 db_load;
1279 load_extensions; 2283 load_extensions;
2284
2285 $TICK_WATCHER->start;
1280 Event::loop; 2286 Event::loop;
1281} 2287}
1282 2288
1283############################################################################# 2289#############################################################################
1284# initialisation 2290# initialisation and cleanup
1285 2291
2292# install some emergency cleanup handlers
2293BEGIN {
2294 for my $signal (qw(INT HUP TERM)) {
2295 Event->signal (
2296 reentrant => 0,
2297 data => WF_AUTOCANCEL,
2298 signal => $signal,
2299 cb => sub {
2300 cf::cleanup "SIG$signal";
2301 },
2302 );
2303 }
2304}
2305
2306sub emergency_save() {
2307 my $freeze_guard = cf::freeze_mainloop;
2308
2309 warn "enter emergency perl save\n";
2310
2311 cf::sync_job {
2312 # use a peculiar iteration method to avoid tripping on perl
2313 # refcount bugs in for. also avoids problems with players
2314 # and maps saved/destroyed asynchronously.
2315 warn "begin emergency player save\n";
2316 for my $login (keys %cf::PLAYER) {
2317 my $pl = $cf::PLAYER{$login} or next;
2318 $pl->valid or next;
2319 $pl->save;
2320 }
2321 warn "end emergency player save\n";
2322
2323 warn "begin emergency map save\n";
2324 for my $path (keys %cf::MAP) {
2325 my $map = $cf::MAP{$path} or next;
2326 $map->valid or next;
2327 $map->save;
2328 }
2329 warn "end emergency map save\n";
2330 };
2331
2332 warn "leave emergency perl save\n";
2333}
2334
1286sub _perl_reload() { 2335sub reload() {
1287 # can/must only be called in main 2336 # can/must only be called in main
1288 if ($Coro::current != $Coro::main) { 2337 if ($Coro::current != $Coro::main) {
1289 warn "can only reload from main coroutine\n"; 2338 warn "can only reload from main coroutine";
1290 return; 2339 return;
1291 } 2340 }
1292 2341
1293 warn "reloading..."; 2342 warn "reloading...";
1294 2343
1295 local $FREEZE = 1; 2344 warn "cancelling server ticker";
2345 $TICK_WATCHER->cancel;
2346
1296 cf::emergency_save; 2347 cf::emergency_save;
1297 2348
1298 eval { 2349 eval {
1299 # if anything goes wrong in here, we should simply crash as we already saved 2350 # if anything goes wrong in here, we should simply crash as we already saved
1300 2351
1301 # cancel all watchers 2352 warn "syncing database to disk";
2353 cf::db_sync;
2354
2355 warn "cancelling all WF_AUTOCANCEL watchers";
1302 for (Event::all_watchers) { 2356 for (Event::all_watchers) {
1303 $_->cancel if $_->data & WF_AUTOCANCEL; 2357 $_->cancel if $_->data & WF_AUTOCANCEL;
1304 } 2358 }
1305 2359
2360 warn "flushing outstanding aio requests";
2361 for (;;) {
2362 IO::AIO::flush;
2363 Coro::cede;
2364 last unless IO::AIO::nreqs;
2365 warn "iterate...";
2366 }
2367
1306 # cancel all extension coros 2368 warn "cancelling all extension coros";
1307 $_->cancel for values %EXT_CORO; 2369 $_->cancel for values %EXT_CORO;
1308 %EXT_CORO = (); 2370 %EXT_CORO = ();
1309 2371
1310 # unload all extensions 2372 warn "removing commands";
1311 for (@exts) { 2373 %COMMAND = ();
2374
2375 warn "removing ext commands";
2376 %EXTCMD = ();
2377
2378 warn "unloading/nuking all extensions";
2379 for my $pkg (@EXTS) {
1312 warn "unloading <$_>"; 2380 warn "... unloading $pkg";
1313 unload_extension $_; 2381
2382 if (my $cb = $pkg->can ("unload")) {
2383 eval {
2384 $cb->($pkg);
2385 1
2386 } or warn "$pkg unloaded, but with errors: $@";
1314 } 2387 }
1315 2388
2389 warn "... nuking $pkg";
2390 Symbol::delete_package $pkg;
2391 }
2392
1316 # unload all modules loaded from $LIBDIR 2393 warn "unloading all perl modules loaded from $LIBDIR";
1317 while (my ($k, $v) = each %INC) { 2394 while (my ($k, $v) = each %INC) {
1318 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2395 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1319 2396
1320 warn "removing <$k>"; 2397 warn "... unloading $k";
1321 delete $INC{$k}; 2398 delete $INC{$k};
1322 2399
1323 $k =~ s/\.pm$//; 2400 $k =~ s/\.pm$//;
1324 $k =~ s/\//::/g; 2401 $k =~ s/\//::/g;
1325 2402
1328 } 2405 }
1329 2406
1330 Symbol::delete_package $k; 2407 Symbol::delete_package $k;
1331 } 2408 }
1332 2409
1333 # sync database to disk
1334 cf::db_sync;
1335 IO::AIO::flush;
1336
1337 # get rid of safe::, as good as possible 2410 warn "getting rid of safe::, as good as possible";
1338 Symbol::delete_package "safe::$_" 2411 Symbol::delete_package "safe::$_"
1339 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 2412 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1340 2413
1341 # remove register_script_function callbacks
1342 # TODO
1343
1344 # unload cf.pm "a bit" 2414 warn "unloading cf.pm \"a bit\"";
1345 delete $INC{"cf.pm"}; 2415 delete $INC{"cf.pm"};
1346 2416
1347 # don't, removes xs symbols, too, 2417 # don't, removes xs symbols, too,
1348 # and global variables created in xs 2418 # and global variables created in xs
1349 #Symbol::delete_package __PACKAGE__; 2419 #Symbol::delete_package __PACKAGE__;
1350 2420
1351 # reload cf.pm 2421 warn "unload completed, starting to reload now";
2422
1352 warn "reloading cf.pm"; 2423 warn "reloading cf.pm";
1353 require cf; 2424 require cf;
1354 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2425 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1355 2426
1356 # load config and database again 2427 warn "loading config and database again";
1357 cf::cfg_load; 2428 cf::cfg_load;
1358 cf::db_load; 2429 cf::db_load;
1359 2430
1360 # load extensions
1361 warn "load extensions"; 2431 warn "loading extensions";
1362 cf::load_extensions; 2432 cf::load_extensions;
1363 2433
1364 # reattach attachments to objects 2434 warn "reattaching attachments to objects/players";
1365 warn "reattach";
1366 _global_reattach; 2435 _global_reattach;
2436 warn "reattaching attachments to maps";
2437 reattach $_ for values %MAP;
2438
2439 warn "restarting server ticker";
2440
2441 $TICK_WATCHER->start;
1367 }; 2442 };
1368 2443
1369 if ($@) { 2444 if ($@) {
1370 warn $@; 2445 warn $@;
1371 warn "error while reloading, exiting."; 2446 warn "error while reloading, exiting.";
1372 exit 1; 2447 exit 1;
1373 } 2448 }
1374 2449
1375 warn "reloaded successfully"; 2450 warn "reloaded";
1376}; 2451};
1377 2452
1378sub perl_reload() { 2453our $RELOAD_WATCHER; # used only during reload
1379 _perl_reload;
1380}
1381 2454
1382register "<global>", __PACKAGE__;
1383
1384register_command "perl-reload" => sub { 2455register_command "reload" => sub {
1385 my ($who, $arg) = @_; 2456 my ($who, $arg) = @_;
1386 2457
1387 if ($who->flag (FLAG_WIZ)) { 2458 if ($who->flag (FLAG_WIZ)) {
1388 $who->message ("reloading..."); 2459 $who->message ("reloading server.");
1389 _perl_reload; 2460
2461 # doing reload synchronously and two reloads happen back-to-back,
2462 # coro crashes during coro_state_free->destroy here.
2463
2464 $RELOAD_WATCHER ||= Event->timer (
2465 reentrant => 0,
2466 after => 0,
2467 data => WF_AUTOCANCEL,
2468 cb => sub {
2469 reload;
2470 undef $RELOAD_WATCHER;
2471 },
2472 );
1390 } 2473 }
1391}; 2474};
1392 2475
1393unshift @INC, $LIBDIR; 2476unshift @INC, $LIBDIR;
2477
2478my $bug_warning = 0;
1394 2479
1395$TICK_WATCHER = Event->timer ( 2480$TICK_WATCHER = Event->timer (
1396 reentrant => 0, 2481 reentrant => 0,
2482 parked => 1,
1397 prio => 0, 2483 prio => 0,
1398 at => $NEXT_TICK || $TICK, 2484 at => $NEXT_TICK || $TICK,
1399 data => WF_AUTOCANCEL, 2485 data => WF_AUTOCANCEL,
1400 cb => sub { 2486 cb => sub {
1401 unless ($FREEZE) { 2487 if ($Coro::current != $Coro::main) {
2488 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2489 unless ++$bug_warning > 10;
2490 return;
2491 }
2492
2493 $NOW = Event::time;
2494
1402 cf::server_tick; # one server iteration 2495 cf::server_tick; # one server iteration
1403 $RUNTIME += $TICK; 2496 $RUNTIME += $TICK;
1404 }
1405
1406 $NEXT_TICK += $TICK; 2497 $NEXT_TICK += $TICK;
2498
2499 $WAIT_FOR_TICK->broadcast;
2500 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
1407 2501
1408 # if we are delayed by four ticks or more, skip them all 2502 # if we are delayed by four ticks or more, skip them all
1409 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 2503 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1410 2504
1411 $TICK_WATCHER->at ($NEXT_TICK); 2505 $TICK_WATCHER->at ($NEXT_TICK);
1413 }, 2507 },
1414); 2508);
1415 2509
1416IO::AIO::max_poll_time $TICK * 0.2; 2510IO::AIO::max_poll_time $TICK * 0.2;
1417 2511
2512undef $Coro::AIO::WATCHER;
2513$AIO_POLL_WATCHER = Event->io (
2514 reentrant => 0,
1418Event->io (fd => IO::AIO::poll_fileno, 2515 fd => IO::AIO::poll_fileno,
1419 poll => 'r', 2516 poll => 'r',
1420 prio => 5, 2517 prio => 6,
1421 data => WF_AUTOCANCEL, 2518 data => WF_AUTOCANCEL,
1422 cb => \&IO::AIO::poll_cb); 2519 cb => \&IO::AIO::poll_cb,
2520);
1423 2521
1424# we must not ever block the main coroutine 2522$WRITE_RUNTIME_WATCHER = Event->timer (
1425$Coro::idle = sub { 2523 reentrant => 0,
1426 #Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d# 2524 data => WF_AUTOCANCEL,
1427 warn "FATAL: Coro::idle was called, major BUG\n"; 2525 after => 1,
2526 interval => 10,
2527 prio => 6, # keep it lowest so it acts like a watchdog
1428 (Coro::unblock_sub { 2528 cb => Coro::unblock_sub {
1429 Event::one_event; 2529 write_runtime
1430 })->(); 2530 or warn "ERROR: unable to write runtime file: $!";
1431}; 2531 },
2532);
2533
2534END { cf::emergency_save }
1432 2535
14331 25361
1434 2537

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines