ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.106 by root, Sun Dec 31 17:29:22 2006 UTC vs.
Revision 1.187 by root, Sat Jan 20 21:06:52 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines