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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines