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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines