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.170 by root, Sun Jan 14 02:00:37 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.3 ();
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 + 1 + 10; # 10 is the runtime save interval, for a monotonic clock
355 (aio_write $fh, 0, (length $value), $value, 0) <= 0
356 and return;
357
358 aio_fsync $fh
359 and return;
360
361 close $fh
362 or return;
363
364 aio_rename "$runtime~", $runtime
365 and return;
366
367 1
243} 368}
244 369
245=back 370=back
246 371
247=cut 372=cut
378our @CB_TYPE = (); # registry for type (cf-object class) based events 503our @CB_TYPE = (); # registry for type (cf-object class) based events
379our @CB_MAP = (); 504our @CB_MAP = ();
380 505
381my %attachment; 506my %attachment;
382 507
508sub cf::attachable::thawer_merge {
509 # simply override everything except _meta
510 local $_[0]{_meta};
511 %{$_[0]} = %{$_[1]};
512}
513
383sub _attach_cb($$$$) { 514sub _attach_cb($$$$) {
384 my ($registry, $event, $prio, $cb) = @_; 515 my ($registry, $event, $prio, $cb) = @_;
385 516
386 use sort 'stable'; 517 use sort 'stable';
387 518
558# object support 689# object support
559 690
560sub reattach { 691sub reattach {
561 # basically do the same as instantiate, without calling instantiate 692 # basically do the same as instantiate, without calling instantiate
562 my ($obj) = @_; 693 my ($obj) = @_;
694
695 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
563 696
564 my $registry = $obj->registry; 697 my $registry = $obj->registry;
565 698
566 @$registry = (); 699 @$registry = ();
567 700
660 or return; 793 or return;
661 794
662 unless (aio_stat "$filename.pst") { 795 unless (aio_stat "$filename.pst") {
663 (aio_load "$filename.pst", $av) >= 0 796 (aio_load "$filename.pst", $av) >= 0
664 or return; 797 or return;
665 $av = eval { (Storable::thaw <$av>)->{objs} }; 798 $av = eval { (Storable::thaw $av)->{objs} };
666 } 799 }
667 800
801 warn sprintf "loading %s (%d)\n",
802 $filename, length $data, scalar @{$av || []};#d#
668 return ($data, $av); 803 return ($data, $av);
669} 804}
670 805
671############################################################################# 806#############################################################################
672# command handling &c 807# command handling &c
697=cut 832=cut
698 833
699sub register_extcmd { 834sub register_extcmd {
700 my ($name, $cb) = @_; 835 my ($name, $cb) = @_;
701 836
702 my $caller = caller;
703 #warn "registering extcmd '$name' to '$caller'";
704
705 $EXTCMD{$name} = [$cb, $caller]; 837 $EXTCMD{$name} = $cb;
706} 838}
707 839
708cf::player->attach ( 840cf::player->attach (
709 on_command => sub { 841 on_command => sub {
710 my ($pl, $name, $params) = @_; 842 my ($pl, $name, $params) = @_;
723 855
724 my $msg = eval { from_json $buf }; 856 my $msg = eval { from_json $buf };
725 857
726 if (ref $msg) { 858 if (ref $msg) {
727 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 859 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
728 if (my %reply = $cb->[0]->($pl, $msg)) { 860 if (my %reply = $cb->($pl, $msg)) {
729 $pl->ext_reply ($msg->{msgid}, %reply); 861 $pl->ext_reply ($msg->{msgid}, %reply);
730 } 862 }
731 } 863 }
732 } else { 864 } else {
733 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 865 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
735 867
736 cf::override; 868 cf::override;
737 }, 869 },
738); 870);
739 871
740sub register {
741 my ($base, $pkg) = @_;
742
743 #TODO
744}
745
746sub load_extension { 872sub load_extension {
747 my ($path) = @_; 873 my ($path) = @_;
748 874
749 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 875 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
750 my $base = $1; 876 my $base = $1;
751 my $pkg = $1; 877 my $pkg = $1;
752 $pkg =~ s/[^[:word:]]/_/g; 878 $pkg =~ s/[^[:word:]]/_/g;
753 $pkg = "ext::$pkg"; 879 $pkg = "ext::$pkg";
754 880
755 warn "loading '$path' into '$pkg'\n"; 881 warn "... loading '$path' into '$pkg'\n";
756 882
757 open my $fh, "<:utf8", $path 883 open my $fh, "<:utf8", $path
758 or die "$path: $!"; 884 or die "$path: $!";
759 885
760 my $source = 886 my $source =
761 "package $pkg; use strict; use utf8;\n" 887 "package $pkg; use strict; use utf8;\n"
762 . "#line 1 \"$path\"\n{\n" 888 . "#line 1 \"$path\"\n{\n"
763 . (do { local $/; <$fh> }) 889 . (do { local $/; <$fh> })
764 . "\n};\n1"; 890 . "\n};\n1";
765 891
766 eval $source 892 unless (eval $source) {
767 or die $@ ? "$path: $@\n" 893 my $msg = $@ ? "$path: $@\n"
768 : "extension disabled.\n"; 894 : "extension disabled.\n";
769 895 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
770 push @exts, $pkg; 896 warn $@;
771 $ext_pkg{$base} = $pkg; 897 warn "mandatory extension failed to load, exiting.\n";
772 898 exit 1;
773# no strict 'refs'; 899 }
774# @{"$pkg\::ISA"} = ext::; 900 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# } 901 }
789 902
790 # remove commands 903 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} 904}
815 905
816sub load_extensions { 906sub load_extensions {
817 for my $ext (<$LIBDIR/*.ext>) { 907 for my $ext (<$LIBDIR/*.ext>) {
818 next unless -r $ext; 908 next unless -r $ext;
822 } or warn "$ext not loaded: $@"; 912 } or warn "$ext not loaded: $@";
823 } 913 }
824} 914}
825 915
826############################################################################# 916#############################################################################
827# load/save/clean perl data associated with a map
828 917
829*cf::mapsupport::on_clean = sub { 918=head2 CORE EXTENSIONS
919
920Functions and methods that extend core crossfire objects.
921
922=cut
923
924package cf::player;
925
926use Coro::AIO;
927
928=head3 cf::player
929
930=over 4
931
932=item cf::player::find $login
933
934Returns the given player object, loading it if necessary (might block).
935
936=cut
937
938sub playerdir($) {
939 cf::localdir
940 . "/"
941 . cf::playerdir
942 . "/"
943 . (ref $_[0] ? $_[0]->ob->name : $_[0])
944}
945
946sub path($) {
947 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
948
949 (playerdir $login) . "/$login.pl"
950}
951
952sub find_active($) {
953 $cf::PLAYER{$_[0]}
954 and $cf::PLAYER{$_[0]}->active
955 and $cf::PLAYER{$_[0]}
956}
957
958sub exists($) {
959 my ($login) = @_;
960
961 $cf::PLAYER{$login}
962 or cf::sync_job { !aio_stat $login }
963}
964
965sub find($) {
966 return $cf::PLAYER{$_[0]} || do {
967 my $login = $_[0];
968
969 my $guard = cf::lock_acquire "user_find:$login";
970
971 $cf::PLAYER{$_[0]} || do {
972 my $pl = load_pl path $login
973 or return;
974 $cf::PLAYER{$login} = $pl
975 }
976 }
977}
978
979sub save($) {
980 my ($pl) = @_;
981
982 return if $pl->{deny_save};
983
984 my $path = path $pl;
985 my $guard = cf::lock_acquire "user_save:$path";
986
987 return if $pl->{deny_save};
988
989 aio_mkdir playerdir $pl, 0770;
990 $pl->{last_save} = $cf::RUNTIME;
991
992 $pl->save_pl ($path);
993 Coro::cede;
994}
995
996sub new($) {
997 my ($login) = @_;
998
999 my $self = create;
1000
1001 $self->ob->name ($login);
1002 $self->{deny_save} = 1;
1003
1004 $cf::PLAYER{$login} = $self;
1005
1006 $self
1007}
1008
1009=item $pl->quit_character
1010
1011Nukes the player without looking back. If logged in, the connection will
1012be destroyed. May block for a long time.
1013
1014=cut
1015
1016sub quit_character {
1017 my ($pl) = @_;
1018
1019 $pl->{deny_save} = 1;
1020 $pl->password ("*"); # this should lock out the player until we nuked the dir
1021
1022 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1023 $pl->deactivate;
1024 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1025 $pl->ns->destroy if $pl->ns;
1026
1027 my $path = playerdir $pl;
1028 my $temp = "$path~$cf::RUNTIME~deleting~";
1029 aio_rename $path, $temp;
1030 delete $cf::PLAYER{$pl->ob->name};
1031 $pl->destroy;
1032 IO::AIO::aio_rmtree $temp;
1033}
1034
1035=item cf::player::list_logins
1036
1037Returns am arrayref of all valid playernames in the system, can take a
1038while and may block, so not sync_job-capable, ever.
1039
1040=cut
1041
1042sub list_logins {
1043 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
1044 or return [];
1045
1046 my @logins;
1047
1048 for my $login (@$dirs) {
1049 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1050 aio_read $fh, 0, 512, my $buf, 0 or next;
1051 $buf !~ /^password -------------$/m or next; # official not-valid tag
1052
1053 utf8::decode $login;
1054 push @logins, $login;
1055 }
1056
1057 \@logins
1058}
1059
1060=item $player->maps
1061
1062Returns an arrayref of map paths that are private for this
1063player. May block.
1064
1065=cut
1066
1067sub maps($) {
1068 my ($pl) = @_;
1069
1070 my $files = aio_readdir playerdir $pl
1071 or return;
1072
1073 my @paths;
1074
1075 for (@$files) {
1076 utf8::decode $_;
1077 next if /\.(?:pl|pst)$/;
1078 next unless /^$PATH_SEP/o;
1079
1080 s/\.map$//;
1081 push @paths, "~" . $pl->ob->name . "/" . $_;
1082 }
1083
1084 \@paths
1085}
1086
1087=item $player->ext_reply ($msgid, $msgtype, %msg)
1088
1089Sends an ext reply to the player.
1090
1091=cut
1092
1093sub ext_reply($$$%) {
1094 my ($self, $id, %msg) = @_;
1095
1096 $msg{msgid} = $id;
1097
1098 $self->send ("ext " . cf::to_json \%msg);
1099}
1100
1101package cf;
1102
1103=back
1104
1105
1106=head3 cf::map
1107
1108=over 4
1109
1110=cut
1111
1112package cf::map;
1113
1114use Fcntl;
1115use Coro::AIO;
1116
1117use overload
1118 '""' => \&as_string;
1119
1120our $MAX_RESET = 3600;
1121our $DEFAULT_RESET = 3000;
1122
1123sub generate_random_map {
1124 my ($self, $rmp) = @_;
1125
1126 # mit "rum" bekleckern, nicht
1127 $self->_create_random_map (
1128 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1129 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1130 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1131 $rmp->{exit_on_final_map},
1132 $rmp->{xsize}, $rmp->{ysize},
1133 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1134 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1135 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1136 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1137 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1138 (cf::region::find $rmp->{region}), $rmp->{custom}
1139 )
1140}
1141
1142sub register {
1143 my (undef, $regex) = @_;
1144 my $pkg = caller;
1145
1146 no strict;
1147 push @{"$pkg\::ISA"}, __PACKAGE__;
1148
1149 $EXT_MAP{$pkg} = qr<$regex>;
1150}
1151
1152# also paths starting with '/'
1153$EXT_MAP{"cf::map"} = qr{^(?=/)};
1154
1155sub thawer_merge {
1156 # we have to keep some variables in memory intact
1157 local $_[0]{path};
1158 local $_[0]{deny_save};
1159 local $_[0]{deny_reset};
1160
1161 $_[0]->SUPER::thawer_merge ($_[1]);
1162}
1163
1164sub normalise {
1165 my ($path, $base) = @_;
1166
1167 # map plan:
1168 #
1169 # /! non-realised random map exit (special hack!)
1170 # {... are special paths that are not being touched
1171 # ?xxx/... are special absolute paths
1172 # ?random/... random maps
1173 # /... normal maps
1174 # ~user/... per-player map of a specific user
1175
1176 $path =~ s/$PATH_SEP/\//go;
1177
1178 # treat it as relative path if it starts with
1179 # something that looks reasonable
1180 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1181 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1182
1183 $base =~ s{[^/]+/?$}{};
1184 $path = "$base/$path";
1185 }
1186
1187 for ($path) {
1188 redo if s{//}{/};
1189 redo if s{/\.?/}{/};
1190 redo if s{/[^/]+/\.\./}{/};
1191 }
1192
1193 $path
1194}
1195
1196sub new_from_path {
1197 my (undef, $path, $base) = @_;
1198
1199 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1200
1201 $path = normalise $path, $base;
1202
1203 for my $pkg (keys %EXT_MAP) {
1204 if ($path =~ $EXT_MAP{$pkg}) {
1205 my $self = bless cf::map::new, $pkg;
1206 $self->{path} = $path; $self->path ($path);
1207 $self->init; # pass $1 etc.
1208 return $self;
1209 }
1210 }
1211
1212 Carp::carp "unable to resolve path '$path'.";
1213 ()
1214}
1215
1216sub init {
1217 my ($self) = @_;
1218
1219 $self
1220}
1221
1222sub as_string {
1223 my ($self) = @_;
1224
1225 "$self->{path}"
1226}
1227
1228# the displayed name, this is a one way mapping
1229sub visible_name {
1230 &as_string
1231}
1232
1233# the original (read-only) location
1234sub load_path {
1235 my ($self) = @_;
1236
1237 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
1238}
1239
1240# the temporary/swap location
1241sub save_path {
1242 my ($self) = @_;
1243
1244 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1245 sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path
1246}
1247
1248# the unique path, undef == no special unique path
1249sub uniq_path {
1250 my ($self) = @_;
1251
1252 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1253 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
1254}
1255
1256# and all this just because we cannot iterate over
1257# all maps in C++...
1258sub change_all_map_light {
1259 my ($change) = @_;
1260
1261 $_->change_map_light ($change)
1262 for grep $_->outdoor, values %cf::MAP;
1263}
1264
1265sub unlink_save {
1266 my ($self) = @_;
1267
1268 utf8::encode (my $save = $self->save_path);
1269 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1270 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1271}
1272
1273sub load_header_from($) {
1274 my ($self, $path) = @_;
1275
1276 utf8::encode $path;
1277 aio_open $path, O_RDONLY, 0
1278 or return;
1279
1280 $self->_load_header ($path)
1281 or return;
1282
1283 $self->{load_path} = $path;
1284
1285 1
1286}
1287
1288sub load_orig {
1289 my ($self) = @_;
1290
1291 $self->load_header_from ($self->load_path)
1292}
1293
1294sub load_temp {
1295 my ($self) = @_;
1296
1297 $self->load_header_from ($self->save_path)
1298}
1299
1300sub load_header {
1301 my ($self) = @_;
1302
1303 if ($self->load_temp) {
1304 $self->last_access ((delete $self->{last_access})
1305 || $cf::RUNTIME); #d#
1306 # safety
1307 $self->{instantiate_time} = $cf::RUNTIME
1308 if $self->{instantiate_time} > $cf::RUNTIME;
1309 } else {
1310 $self->load_orig
1311 or return;
1312
1313 $self->{load_original} = 1;
1314 $self->{instantiate_time} = $cf::RUNTIME;
1315 $self->last_access ($cf::RUNTIME);
1316 $self->instantiate;
1317 }
1318
1319 1
1320}
1321
1322sub find;
1323sub find {
1324 my ($path, $origin) = @_;
1325
1326 $path = normalise $path, $origin && $origin->path;
1327
1328 cf::lock_wait "map_find:$path";
1329
1330 $cf::MAP{$path} || do {
1331 my $guard = cf::lock_acquire "map_find:$path";
1332 my $map = new_from_path cf::map $path
1333 or return;
1334
1335 $map->{last_save} = $cf::RUNTIME;
1336
1337 $map->load_header
1338 or return;
1339
1340 if ($map->should_reset) {
1341 $map->reset;
1342 undef $guard;
1343 $map = find $path
1344 or return;
1345 }
1346
1347 $cf::MAP{$path} = $map
1348 }
1349}
1350
1351sub load {
1352 my ($self) = @_;
1353
1354 my $path = $self->{path};
1355 my $guard = cf::lock_acquire "map_load:$path";
1356
1357 return if $self->in_memory != cf::MAP_SWAPPED;
1358
1359 $self->in_memory (cf::MAP_LOADING);
1360
1361 $self->alloc;
1362 $self->_load_objects ($self->{load_path}, 1)
1363 or return;
1364
1365 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1366 if delete $self->{load_original};
1367
1368 if (my $uniq = $self->uniq_path) {
1369 utf8::encode $uniq;
1370 if (aio_open $uniq, O_RDONLY, 0) {
1371 $self->clear_unique_items;
1372 $self->_load_objects ($uniq, 0);
1373 }
1374 }
1375
1376 Coro::cede;
1377
1378 # now do the right thing for maps
1379 $self->link_multipart_objects;
1380
1381 unless ($self->{deny_activate}) {
1382 $self->decay_objects;
1383 $self->fix_auto_apply;
1384 $self->update_buttons;
1385 Coro::cede;
1386 $self->set_darkness_map;
1387 $self->difficulty ($self->estimate_difficulty)
1388 unless $self->difficulty;
1389 Coro::cede;
1390 $self->activate;
1391 }
1392
1393 $self->in_memory (cf::MAP_IN_MEMORY);
1394}
1395
1396sub customise_for {
1397 my ($self, $ob) = @_;
1398
1399 return find "~" . $ob->name . "/" . $self->{path}
1400 if $self->per_player;
1401
1402 $self
1403}
1404
1405# find and load all maps in the 3x3 area around a map
1406sub load_diag {
830 my ($map) = @_; 1407 my ($map) = @_;
831 1408
832 my $path = $map->tmpname; 1409 my @diag; # diagonal neighbours
833 defined $path or return;
834 1410
835 unlink "$path.pst"; 1411 for (0 .. 3) {
1412 my $neigh = $map->tile_path ($_)
1413 or next;
1414 $neigh = find $neigh, $map
1415 or next;
1416 $neigh->load;
1417
1418 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1419 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1420 }
1421
1422 for (@diag) {
1423 my $neigh = find @$_
1424 or next;
1425 $neigh->load;
1426 }
1427}
1428
1429sub find_sync {
1430 my ($path, $origin) = @_;
1431
1432 cf::sync_job { find $path, $origin }
1433}
1434
1435sub do_load_sync {
1436 my ($map) = @_;
1437
1438 cf::sync_job { $map->load };
1439}
1440
1441our %MAP_PREFETCH;
1442our $MAP_PREFETCHER = Coro::async {
1443 while () {
1444 for my $path (keys %MAP_PREFETCH) {
1445 my $map = find $path
1446 or next;
1447 $map->load;
1448
1449 delete $MAP_PREFETCH{$path};
1450 }
1451 Coro::schedule;
1452 }
836}; 1453};
837 1454
838cf::map->attach (prio => -10000, package => cf::mapsupport::); 1455sub find_async {
1456 my ($path, $origin) = @_;
839 1457
840############################################################################# 1458 $path = normalise $path, $origin && $origin->{path};
841# load/save perl data associated with player->ob objects
842 1459
843sub all_objects(@) { 1460 if (my $map = $cf::MAP{$path}) {
844 @_, map all_objects ($_->inv), @_ 1461 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
845}
846
847# TODO: compatibility cruft, remove when no longer needed
848cf::player->attach (
849 on_load => sub {
850 my ($pl, $path) = @_;
851
852 for my $o (all_objects $pl->ob) {
853 if (my $value = $o->get_ob_key_value ("_perl_data")) {
854 $o->set_ob_key_value ("_perl_data");
855
856 %$o = %{ Storable::thaw pack "H*", $value };
857 }
858 }
859 }, 1462 }
860);
861 1463
862############################################################################# 1464 $MAP_PREFETCH{$path} = 0;
1465 $MAP_PREFETCHER->ready;
863 1466
864=head2 CORE EXTENSIONS 1467 ()
1468}
865 1469
866Functions and methods that extend core crossfire objects. 1470sub save {
1471 my ($self) = @_;
867 1472
868=head3 cf::player 1473 my $lock = cf::lock_acquire "map_data:" . $self->path;
1474
1475 $self->{last_save} = $cf::RUNTIME;
1476
1477 return unless $self->dirty;
1478
1479 my $save = $self->save_path; utf8::encode $save;
1480 my $uniq = $self->uniq_path; utf8::encode $uniq;
1481
1482 $self->{load_path} = $save;
1483
1484 return if $self->{deny_save};
1485
1486 local $self->{last_access} = $self->last_access;#d#
1487
1488 cf::async {
1489 $_->contr->save for $self->players;
1490 };
1491
1492 if ($uniq) {
1493 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1494 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1495 } else {
1496 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1497 }
1498}
1499
1500sub swap_out {
1501 my ($self) = @_;
1502
1503 # save first because save cedes
1504 $self->save;
1505
1506 my $lock = cf::lock_acquire "map_data:" . $self->path;
1507
1508 return if $self->players;
1509 return if $self->in_memory != cf::MAP_IN_MEMORY;
1510 return if $self->{deny_save};
1511
1512 $self->clear;
1513 $self->in_memory (cf::MAP_SWAPPED);
1514}
1515
1516sub reset_at {
1517 my ($self) = @_;
1518
1519 # TODO: safety, remove and allow resettable per-player maps
1520 return 1e99 if $self->isa ("ext::map_per_player");#d#
1521 return 1e99 if $self->{deny_reset};
1522
1523 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1524 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1525
1526 $time + $to
1527}
1528
1529sub should_reset {
1530 my ($self) = @_;
1531
1532 $self->reset_at <= $cf::RUNTIME
1533}
1534
1535sub rename {
1536 my ($self, $new_path) = @_;
1537
1538 normalise $new_path;
1539
1540 $self->unlink_save;
1541
1542 delete $cf::MAP{$self->path};
1543 $self->{path} = $new_path; $self->path ($self->{path});
1544 $cf::MAP{$self->path} = $self;
1545
1546 $self->save;
1547}
1548
1549sub reset {
1550 my ($self) = @_;
1551
1552 my $lock = cf::lock_acquire "map_data:$self->{path}";
1553
1554 return if $self->players;
1555 return if $self->isa ("ext::map_per_player");#d#
1556
1557 warn "resetting map ", $self->path;#d#
1558
1559 delete $cf::MAP{$self->path};
1560
1561 $self->in_memory (cf::MAP_SWAPPED);
1562 $self->clear;
1563
1564 $_->clear_links_to ($self) for values %cf::MAP;
1565
1566 $self->unlink_save;
1567 $self->destroy;
1568}
1569
1570my $nuke_counter = "aaaa";
1571
1572sub nuke {
1573 my ($self) = @_;
1574
1575 $self->{deny_save} = 1;
1576 $self->reset_timeout (1);
1577 $self->rename ("{nuke}/" . ($nuke_counter++));
1578 $self->reset; # polite request, might not happen
1579}
1580
1581=item cf::map::unique_maps
1582
1583Returns an arrayref of paths of all shared maps that have
1584instantiated unique items. May block.
1585
1586=cut
1587
1588sub unique_maps() {
1589 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
1590 or return;
1591
1592 my @paths;
1593
1594 for (@$files) {
1595 utf8::decode $_;
1596 next if /\.pst$/;
1597 next unless /^$PATH_SEP/o;
1598
1599 s/\.map$//;
1600 push @paths, $_;
1601 }
1602
1603 \@paths
1604}
1605
1606package cf;
1607
1608=back
1609
1610=head3 cf::object
1611
1612=cut
1613
1614package cf::object;
869 1615
870=over 4 1616=over 4
871 1617
872=item cf::player::exists $login 1618=item $ob->inv_recursive
873 1619
874Returns true when the given account exists. 1620Returns the inventory of the object _and_ their inventories, recursively.
875 1621
876=cut 1622=cut
877 1623
878sub cf::player::exists($) { 1624sub inv_recursive_;
879 cf::player::find $_[0] 1625sub inv_recursive_ {
880 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1626 map { $_, inv_recursive_ $_->inv } @_
881} 1627}
882 1628
883=item $player->ext_reply ($msgid, $msgtype, %msg) 1629sub inv_recursive {
884 1630 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} 1631}
1632
1633package cf;
896 1634
897=back 1635=back
898 1636
899=head3 cf::object::player 1637=head3 cf::object::player
900 1638
938 (ref $cf::CFG{"may_$access"} 1676 (ref $cf::CFG{"may_$access"}
939 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1677 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
940 : $cf::CFG{"may_$access"}) 1678 : $cf::CFG{"may_$access"})
941} 1679}
942 1680
1681=item $player_object->enter_link
1682
1683Freezes the player and moves him/her to a special map (C<{link}>).
1684
1685The player should be reasonably safe there for short amounts of time. You
1686I<MUST> call C<leave_link> as soon as possible, though.
1687
1688Will never block.
1689
1690=item $player_object->leave_link ($map, $x, $y)
1691
1692Moves the player out of the special C<{link}> map onto the specified
1693map. If the map is not valid (or omitted), the player will be moved back
1694to the location he/she was before the call to C<enter_link>, or, if that
1695fails, to the emergency map position.
1696
1697Might block.
1698
1699=cut
1700
1701sub link_map {
1702 unless ($LINK_MAP) {
1703 $LINK_MAP = cf::map::find "{link}"
1704 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };
1705 $LINK_MAP->load;
1706 }
1707
1708 $LINK_MAP
1709}
1710
1711sub cf::object::player::enter_link {
1712 my ($self) = @_;
1713
1714 $self->deactivate_recursive;
1715
1716 return if UNIVERSAL::isa $self->map, "ext::map_link";
1717
1718 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1719 if $self->map;
1720
1721 $self->enter_map ($LINK_MAP || link_map, 20, 20);
1722}
1723
1724sub cf::object::player::leave_link {
1725 my ($self, $map, $x, $y) = @_;
1726
1727 my $link_pos = delete $self->{_link_pos};
1728
1729 unless ($map) {
1730 # restore original map position
1731 ($map, $x, $y) = @{ $link_pos || [] };
1732 $map = cf::map::find $map;
1733
1734 unless ($map) {
1735 ($map, $x, $y) = @$EMERGENCY_POSITION;
1736 $map = cf::map::find $map
1737 or die "FATAL: cannot load emergency map\n";
1738 }
1739 }
1740
1741 ($x, $y) = (-1, -1)
1742 unless (defined $x) && (defined $y);
1743
1744 # use -1 or undef as default coordinates, not 0, 0
1745 ($x, $y) = ($map->enter_x, $map->enter_y)
1746 if $x <=0 && $y <= 0;
1747
1748 $map->load;
1749 $map->load_diag;
1750
1751 return unless $self->contr->active;
1752 $self->activate_recursive;
1753 $self->enter_map ($map, $x, $y);
1754}
1755
1756cf::player->attach (
1757 on_logout => sub {
1758 my ($pl) = @_;
1759
1760 # abort map switching before logout
1761 if ($pl->ob->{_link_pos}) {
1762 cf::sync_job {
1763 $pl->ob->leave_link
1764 };
1765 }
1766 },
1767 on_login => sub {
1768 my ($pl) = @_;
1769
1770 # try to abort aborted map switching on player login :)
1771 # should happen only on crashes
1772 if ($pl->ob->{_link_pos}) {
1773 $pl->ob->enter_link;
1774 (async {
1775 # we need this sleep as the login has a concurrent enter_exit running
1776 # and this sleep increases chances of the player not ending up in scorn
1777 $pl->ob->reply (undef,
1778 "There was an internal problem at your last logout, "
1779 . "the server will try to bring you to your intended destination in a second.",
1780 cf::NDI_RED);
1781 Coro::Timer::sleep 1;
1782 $pl->ob->leave_link;
1783 })->prio (2);
1784 }
1785 },
1786);
1787
1788=item $player_object->goto ($path, $x, $y)
1789
1790=cut
1791
1792sub cf::object::player::goto {
1793 my ($self, $path, $x, $y) = @_;
1794
1795 $self->enter_link;
1796
1797 (async {
1798 my $map = cf::map::find $path;
1799 $map = $map->customise_for ($self) if $map;
1800
1801# warn "entering ", $map->path, " at ($x, $y)\n"
1802# if $map;
1803
1804 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1805
1806 $self->leave_link ($map, $x, $y);
1807 })->prio (1);
1808}
1809
1810=item $player_object->enter_exit ($exit_object)
1811
1812=cut
1813
1814sub parse_random_map_params {
1815 my ($spec) = @_;
1816
1817 my $rmp = { # defaults
1818 xsize => 10,
1819 ysize => 10,
1820 };
1821
1822 for (split /\n/, $spec) {
1823 my ($k, $v) = split /\s+/, $_, 2;
1824
1825 $rmp->{lc $k} = $v if (length $k) && (length $v);
1826 }
1827
1828 $rmp
1829}
1830
1831sub prepare_random_map {
1832 my ($exit) = @_;
1833
1834 # all this does is basically replace the /! path by
1835 # a new random map path (?random/...) with a seed
1836 # that depends on the exit object
1837
1838 my $rmp = parse_random_map_params $exit->msg;
1839
1840 if ($exit->map) {
1841 $rmp->{region} = $exit->map->region_name;
1842 $rmp->{origin_map} = $exit->map->path;
1843 $rmp->{origin_x} = $exit->x;
1844 $rmp->{origin_y} = $exit->y;
1845 }
1846
1847 $rmp->{random_seed} ||= $exit->random_seed;
1848
1849 my $data = cf::to_json $rmp;
1850 my $md5 = Digest::MD5::md5_hex $data;
1851
1852 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
1853 aio_write $fh, 0, (length $data), $data, 0;
1854
1855 $exit->slaying ("?random/$md5");
1856 $exit->msg (undef);
1857 }
1858}
1859
1860sub cf::object::player::enter_exit {
1861 my ($self, $exit) = @_;
1862
1863 return unless $self->type == cf::PLAYER;
1864
1865 $self->enter_link;
1866
1867 (async {
1868 $self->deactivate_recursive; # just to be sure
1869 unless (eval {
1870 prepare_random_map $exit
1871 if $exit->slaying eq "/!";
1872
1873 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1874 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1875
1876 1;
1877 }) {
1878 $self->message ("Something went wrong deep within the crossfire server. "
1879 . "I'll try to bring you back to the map you were before. "
1880 . "Please report this to the dungeon master!",
1881 cf::NDI_UNIQUE | cf::NDI_RED);
1882
1883 warn "ERROR in enter_exit: $@";
1884 $self->leave_link;
1885 }
1886 })->prio (1);
1887}
1888
943=head3 cf::client 1889=head3 cf::client
944 1890
945=over 4 1891=over 4
946 1892
947=item $client->send_drawinfo ($text, $flags) 1893=item $client->send_drawinfo ($text, $flags)
990 on_reply => sub { 1936 on_reply => sub {
991 my ($ns, $msg) = @_; 1937 my ($ns, $msg) = @_;
992 1938
993 # this weird shuffling is so that direct followup queries 1939 # this weird shuffling is so that direct followup queries
994 # get handled first 1940 # get handled first
995 my $queue = delete $ns->{query_queue}; 1941 my $queue = delete $ns->{query_queue}
1942 or return; # be conservative, not sure how that can happen, but we saw a crash here
996 1943
997 (shift @$queue)->[1]->($msg); 1944 (shift @$queue)->[1]->($msg);
998 1945
999 push @{ $ns->{query_queue} }, @$queue; 1946 push @{ $ns->{query_queue} }, @$queue;
1000 1947
1006 } 1953 }
1007 } 1954 }
1008 }, 1955 },
1009); 1956);
1010 1957
1011=item $client->coro (\&cb) 1958=item $client->async (\&cb)
1012 1959
1013Create a new coroutine, running the specified callback. The coroutine will 1960Create a new coroutine, running the specified callback. The coroutine will
1014be automatically cancelled when the client gets destroyed (e.g. on logout, 1961be automatically cancelled when the client gets destroyed (e.g. on logout,
1015or loss of connection). 1962or loss of connection).
1016 1963
1017=cut 1964=cut
1018 1965
1019sub cf::client::coro { 1966sub cf::client::async {
1020 my ($self, $cb) = @_; 1967 my ($self, $cb) = @_;
1021 1968
1022 my $coro; $coro = async { 1969 my $coro = &Coro::async ($cb);
1023 eval {
1024 $cb->();
1025 };
1026 warn $@ if $@;
1027 };
1028 1970
1029 $coro->on_destroy (sub { 1971 $coro->on_destroy (sub {
1030 delete $self->{_coro}{$coro+0}; 1972 delete $self->{_coro}{$coro+0};
1031 }); 1973 });
1032 1974
1204 2146
1205{ 2147{
1206 my $path = cf::localdir . "/database.pst"; 2148 my $path = cf::localdir . "/database.pst";
1207 2149
1208 sub db_load() { 2150 sub db_load() {
1209 warn "loading database $path\n";#d# remove later
1210 $DB = stat $path ? Storable::retrieve $path : { }; 2151 $DB = stat $path ? Storable::retrieve $path : { };
1211 } 2152 }
1212 2153
1213 my $pid; 2154 my $pid;
1214 2155
1215 sub db_save() { 2156 sub db_save() {
1216 warn "saving database $path\n";#d# remove later
1217 waitpid $pid, 0 if $pid; 2157 waitpid $pid, 0 if $pid;
1218 if (0 == ($pid = fork)) { 2158 if (0 == ($pid = fork)) {
1219 $DB->{_meta}{version} = 1; 2159 $DB->{_meta}{version} = 1;
1220 Storable::nstore $DB, "$path~"; 2160 Storable::nstore $DB, "$path~";
1221 rename "$path~", $path; 2161 rename "$path~", $path;
1269 open my $fh, "<:utf8", cf::confdir . "/config" 2209 open my $fh, "<:utf8", cf::confdir . "/config"
1270 or return; 2210 or return;
1271 2211
1272 local $/; 2212 local $/;
1273 *CFG = YAML::Syck::Load <$fh>; 2213 *CFG = YAML::Syck::Load <$fh>;
2214
2215 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2216
2217 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2218 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2219
2220 if (exists $CFG{mlockall}) {
2221 eval {
2222 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2223 and die "WARNING: m(un)lockall failed: $!\n";
2224 };
2225 warn $@ if $@;
2226 }
1274} 2227}
1275 2228
1276sub main { 2229sub main {
2230 # we must not ever block the main coroutine
2231 local $Coro::idle = sub {
2232 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2233 async { Event::one_event };
2234 };
2235
1277 cfg_load; 2236 cfg_load;
1278 db_load; 2237 db_load;
1279 load_extensions; 2238 load_extensions;
1280 Event::loop; 2239 Event::loop;
1281} 2240}
1282 2241
1283############################################################################# 2242#############################################################################
1284# initialisation 2243# initialisation and cleanup
1285 2244
2245# install some emergency cleanup handlers
2246BEGIN {
2247 for my $signal (qw(INT HUP TERM)) {
2248 Event->signal (
2249 data => WF_AUTOCANCEL,
2250 signal => $signal,
2251 cb => sub {
2252 cf::cleanup "SIG$signal";
2253 },
2254 );
2255 }
2256}
2257
2258sub emergency_save() {
2259 my $freeze_guard = cf::freeze_mainloop;
2260
2261 warn "enter emergency perl save\n";
2262
2263 cf::sync_job {
2264 # use a peculiar iteration method to avoid tripping on perl
2265 # refcount bugs in for. also avoids problems with players
2266 # and maps saved/destroyed asynchronously.
2267 warn "begin emergency player save\n";
2268 for my $login (keys %cf::PLAYER) {
2269 my $pl = $cf::PLAYER{$login} or next;
2270 $pl->valid or next;
2271 $pl->save;
2272 }
2273 warn "end emergency player save\n";
2274
2275 warn "begin emergency map save\n";
2276 for my $path (keys %cf::MAP) {
2277 my $map = $cf::MAP{$path} or next;
2278 $map->valid or next;
2279 $map->save;
2280 }
2281 warn "end emergency map save\n";
2282 };
2283
2284 warn "leave emergency perl save\n";
2285}
2286
1286sub _perl_reload() { 2287sub reload() {
1287 # can/must only be called in main 2288 # can/must only be called in main
1288 if ($Coro::current != $Coro::main) { 2289 if ($Coro::current != $Coro::main) {
1289 warn "can only reload from main coroutine\n"; 2290 warn "can only reload from main coroutine\n";
1290 return; 2291 return;
1291 } 2292 }
1292 2293
1293 warn "reloading..."; 2294 warn "reloading...";
1294 2295
1295 local $FREEZE = 1; 2296 warn "freezing server";
2297 my $guard = freeze_mainloop;
1296 cf::emergency_save; 2298 cf::emergency_save;
2299
2300 warn "sync database to disk";
2301 cf::db_sync;
2302 IO::AIO::flush;
1297 2303
1298 eval { 2304 eval {
1299 # if anything goes wrong in here, we should simply crash as we already saved 2305 # if anything goes wrong in here, we should simply crash as we already saved
1300 2306
1301 # cancel all watchers 2307 warn "cancel all watchers";
1302 for (Event::all_watchers) { 2308 for (Event::all_watchers) {
1303 $_->cancel if $_->data & WF_AUTOCANCEL; 2309 $_->cancel if $_->data & WF_AUTOCANCEL;
1304 } 2310 }
1305 2311
1306 # cancel all extension coros 2312 warn "cancel all extension coros";
1307 $_->cancel for values %EXT_CORO; 2313 $_->cancel for values %EXT_CORO;
1308 %EXT_CORO = (); 2314 %EXT_CORO = ();
1309 2315
2316 warn "remove commands";
2317 %COMMAND = ();
2318
2319 warn "remove ext commands";
2320 %EXTCMD = ();
2321
1310 # unload all extensions 2322 warn "unload/nuke all extensions";
1311 for (@exts) { 2323 for my $pkg (@EXTS) {
1312 warn "unloading <$_>"; 2324 warn "... unloading $pkg";
1313 unload_extension $_; 2325
2326 if (my $cb = $pkg->can ("unload")) {
2327 eval {
2328 $cb->($pkg);
2329 1
2330 } or warn "$pkg unloaded, but with errors: $@";
1314 } 2331 }
1315 2332
2333 warn "... nuking $pkg";
2334 Symbol::delete_package $pkg;
2335 }
2336
1316 # unload all modules loaded from $LIBDIR 2337 warn "unload all perl modules loaded from $LIBDIR";
1317 while (my ($k, $v) = each %INC) { 2338 while (my ($k, $v) = each %INC) {
1318 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2339 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1319 2340
1320 warn "removing <$k>"; 2341 warn "removing <$k>";
1321 delete $INC{$k}; 2342 delete $INC{$k};
1328 } 2349 }
1329 2350
1330 Symbol::delete_package $k; 2351 Symbol::delete_package $k;
1331 } 2352 }
1332 2353
1333 # sync database to disk
1334 cf::db_sync;
1335 IO::AIO::flush;
1336
1337 # get rid of safe::, as good as possible 2354 warn "get rid of safe::, as good as possible";
1338 Symbol::delete_package "safe::$_" 2355 Symbol::delete_package "safe::$_"
1339 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 2356 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1340 2357
1341 # remove register_script_function callbacks
1342 # TODO
1343
1344 # unload cf.pm "a bit" 2358 warn "unload cf.pm \"a bit\"";
1345 delete $INC{"cf.pm"}; 2359 delete $INC{"cf.pm"};
1346 2360
1347 # don't, removes xs symbols, too, 2361 # don't, removes xs symbols, too,
1348 # and global variables created in xs 2362 # and global variables created in xs
1349 #Symbol::delete_package __PACKAGE__; 2363 #Symbol::delete_package __PACKAGE__;
1350 2364
1351 # reload cf.pm
1352 warn "reloading cf.pm"; 2365 warn "reloading cf.pm";
1353 require cf; 2366 require cf;
1354 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2367 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1355 2368
1356 # load config and database again 2369 warn "load config and database again";
1357 cf::cfg_load; 2370 cf::cfg_load;
1358 cf::db_load; 2371 cf::db_load;
1359 2372
1360 # load extensions
1361 warn "load extensions"; 2373 warn "load extensions";
1362 cf::load_extensions; 2374 cf::load_extensions;
1363 2375
1364 # reattach attachments to objects 2376 warn "reattach attachments to objects/players";
1365 warn "reattach";
1366 _global_reattach; 2377 _global_reattach;
2378 warn "reattach attachments to maps";
2379 reattach $_ for values %MAP;
1367 }; 2380 };
1368 2381
1369 if ($@) { 2382 if ($@) {
1370 warn $@; 2383 warn $@;
1371 warn "error while reloading, exiting."; 2384 warn "error while reloading, exiting.";
1372 exit 1; 2385 exit 1;
1373 } 2386 }
1374 2387
1375 warn "reloaded successfully"; 2388 warn "reloaded";
1376}; 2389};
1377 2390
1378sub perl_reload() {
1379 _perl_reload;
1380}
1381
1382register "<global>", __PACKAGE__;
1383
1384register_command "perl-reload" => sub { 2391register_command "reload" => sub {
1385 my ($who, $arg) = @_; 2392 my ($who, $arg) = @_;
1386 2393
1387 if ($who->flag (FLAG_WIZ)) { 2394 if ($who->flag (FLAG_WIZ)) {
2395 $who->message ("start of reload.");
2396 reload;
1388 $who->message ("reloading..."); 2397 $who->message ("end of reload.");
1389 _perl_reload;
1390 } 2398 }
1391}; 2399};
1392 2400
1393unshift @INC, $LIBDIR; 2401unshift @INC, $LIBDIR;
1394 2402
1396 reentrant => 0, 2404 reentrant => 0,
1397 prio => 0, 2405 prio => 0,
1398 at => $NEXT_TICK || $TICK, 2406 at => $NEXT_TICK || $TICK,
1399 data => WF_AUTOCANCEL, 2407 data => WF_AUTOCANCEL,
1400 cb => sub { 2408 cb => sub {
1401 unless ($FREEZE) { 2409 $NOW = Event::time;
2410
1402 cf::server_tick; # one server iteration 2411 cf::server_tick; # one server iteration
1403 $RUNTIME += $TICK; 2412 $RUNTIME += $TICK;
1404 }
1405
1406 $NEXT_TICK += $TICK; 2413 $NEXT_TICK += $TICK;
2414
2415 $WAIT_FOR_TICK->broadcast;
2416 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
1407 2417
1408 # if we are delayed by four ticks or more, skip them all 2418 # if we are delayed by four ticks or more, skip them all
1409 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 2419 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1410 2420
1411 $TICK_WATCHER->at ($NEXT_TICK); 2421 $TICK_WATCHER->at ($NEXT_TICK);
1413 }, 2423 },
1414); 2424);
1415 2425
1416IO::AIO::max_poll_time $TICK * 0.2; 2426IO::AIO::max_poll_time $TICK * 0.2;
1417 2427
2428$AIO_POLL_WATCHER = Event->io (
1418Event->io (fd => IO::AIO::poll_fileno, 2429 fd => IO::AIO::poll_fileno,
1419 poll => 'r', 2430 poll => 'r',
1420 prio => 5, 2431 prio => 5,
1421 data => WF_AUTOCANCEL, 2432 data => WF_AUTOCANCEL,
1422 cb => \&IO::AIO::poll_cb); 2433 cb => \&IO::AIO::poll_cb,
2434);
1423 2435
1424# we must not ever block the main coroutine 2436$WRITE_RUNTIME_WATCHER = Event->timer (
1425$Coro::idle = sub { 2437 data => WF_AUTOCANCEL,
1426 #Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d# 2438 after => 0,
1427 warn "FATAL: Coro::idle was called, major BUG\n"; 2439 interval => 10,
2440 cb => sub {
1428 (Coro::unblock_sub { 2441 (Coro::unblock_sub {
1429 Event::one_event; 2442 write_runtime
2443 or warn "ERROR: unable to write runtime file: $!";
1430 })->(); 2444 })->();
1431}; 2445 },
2446);
2447
2448END { cf::emergency_save }
1432 2449
14331 24501
1434 2451

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines