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.105 by root, Sun Dec 31 17:17:23 2006 UTC vs.
Revision 1.172 by root, Sun Jan 14 13:32:48 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
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}
178 218
179# main coro must never ever "block" except in Event 219=item cf::lock_wait $string
180# sync_job ensures this by running the job in a coroutine 220
181# and waiting in Event while the server is otherwise frozen 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 }
282
283=item cf::sync_job { BLOCK }
284
285The design of crossfire+ requires that the main coro ($Coro::main) is
286always able to handle events or runnable, as crossfire+ is only partly
287reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
288
289If it must be done, put the blocking parts into C<sync_job>. This will run
290the given BLOCK in another coroutine while waiting for the result. The
291server will be frozen during this time, so the block should either finish
292fast or be very important.
293
294=cut
295
182sub sync_job(&) { 296sub sync_job(&) {
183 my ($job) = @_; 297 my ($job) = @_;
184 298
185 my $busy = 1;
186 my @res;
187
188 local $FREEZE = 1;
189
190 my $coro = Coro::async {
191 @res = eval { $job->() };
192 warn $@ if $@;
193 undef $busy;
194 };
195
196 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;
197 $coro->prio (Coro::PRIO_MAX); 314 })->prio (Coro::PRIO_MAX);
315
198 while ($busy) { 316 while ($busy) {
199 Coro::cede_notself; 317 Coro::cede or Event::one_event;
200 Event::one_event unless Coro::nready;
201 } 318 }
319
320 wantarray ? @res : $res[0]
202 } else { 321 } else {
203 $coro->join; 322 # we are in another coroutine, how wonderful, everything just works
323
324 $job->()
204 } 325 }
205
206 wantarray ? @res : $res[0]
207} 326}
208 327
209=item $coro = cf::coro { BLOCK } 328=item $coro = cf::async_ext { BLOCK }
210 329
211Creates and returns a new coro. This coro is automcatially being canceled 330Like async, but this coro is automatically being canceled when the
212when the extension calling this is being unloaded. 331extension calling this is being unloaded.
213 332
214=cut 333=cut
215 334
216sub coro(&) { 335sub async_ext(&) {
217 my $cb = shift; 336 my $cb = shift;
218 337
219 my $coro; $coro = async { 338 my $coro = &Coro::async ($cb);
220 eval {
221 $cb->();
222 };
223 warn $@ if $@;
224 };
225 339
226 $coro->on_destroy (sub { 340 $coro->on_destroy (sub {
227 delete $EXT_CORO{$coro+0}; 341 delete $EXT_CORO{$coro+0};
228 }); 342 });
229 $EXT_CORO{$coro+0} = $coro; 343 $EXT_CORO{$coro+0} = $coro;
230 344
231 $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
232} 368}
233 369
234=back 370=back
235 371
236=cut 372=cut
367our @CB_TYPE = (); # registry for type (cf-object class) based events 503our @CB_TYPE = (); # registry for type (cf-object class) based events
368our @CB_MAP = (); 504our @CB_MAP = ();
369 505
370my %attachment; 506my %attachment;
371 507
508sub cf::attachable::thawer_merge {
509 # simply override everything except _meta
510 local $_[0]{_meta};
511 %{$_[0]} = %{$_[1]};
512}
513
372sub _attach_cb($$$$) { 514sub _attach_cb($$$$) {
373 my ($registry, $event, $prio, $cb) = @_; 515 my ($registry, $event, $prio, $cb) = @_;
374 516
375 use sort 'stable'; 517 use sort 'stable';
376 518
547# object support 689# object support
548 690
549sub reattach { 691sub reattach {
550 # basically do the same as instantiate, without calling instantiate 692 # basically do the same as instantiate, without calling instantiate
551 my ($obj) = @_; 693 my ($obj) = @_;
694
695 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
552 696
553 my $registry = $obj->registry; 697 my $registry = $obj->registry;
554 698
555 @$registry = (); 699 @$registry = ();
556 700
649 or return; 793 or return;
650 794
651 unless (aio_stat "$filename.pst") { 795 unless (aio_stat "$filename.pst") {
652 (aio_load "$filename.pst", $av) >= 0 796 (aio_load "$filename.pst", $av) >= 0
653 or return; 797 or return;
654 $av = eval { (Storable::thaw <$av>)->{objs} }; 798 $av = eval { (Storable::thaw $av)->{objs} };
655 } 799 }
656 800
801 warn sprintf "loading %s (%d)\n",
802 $filename, length $data, scalar @{$av || []};#d#
657 return ($data, $av); 803 return ($data, $av);
658} 804}
659 805
660############################################################################# 806#############################################################################
661# command handling &c 807# command handling &c
686=cut 832=cut
687 833
688sub register_extcmd { 834sub register_extcmd {
689 my ($name, $cb) = @_; 835 my ($name, $cb) = @_;
690 836
691 my $caller = caller;
692 #warn "registering extcmd '$name' to '$caller'";
693
694 $EXTCMD{$name} = [$cb, $caller]; 837 $EXTCMD{$name} = $cb;
695} 838}
696 839
697cf::player->attach ( 840cf::player->attach (
698 on_command => sub { 841 on_command => sub {
699 my ($pl, $name, $params) = @_; 842 my ($pl, $name, $params) = @_;
712 855
713 my $msg = eval { from_json $buf }; 856 my $msg = eval { from_json $buf };
714 857
715 if (ref $msg) { 858 if (ref $msg) {
716 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 859 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
717 if (my %reply = $cb->[0]->($pl, $msg)) { 860 if (my %reply = $cb->($pl, $msg)) {
718 $pl->ext_reply ($msg->{msgid}, %reply); 861 $pl->ext_reply ($msg->{msgid}, %reply);
719 } 862 }
720 } 863 }
721 } else { 864 } else {
722 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 865 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
724 867
725 cf::override; 868 cf::override;
726 }, 869 },
727); 870);
728 871
729sub register {
730 my ($base, $pkg) = @_;
731
732 #TODO
733}
734
735sub load_extension { 872sub load_extension {
736 my ($path) = @_; 873 my ($path) = @_;
737 874
738 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 875 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
739 my $base = $1; 876 my $base = $1;
740 my $pkg = $1; 877 my $pkg = $1;
741 $pkg =~ s/[^[:word:]]/_/g; 878 $pkg =~ s/[^[:word:]]/_/g;
742 $pkg = "ext::$pkg"; 879 $pkg = "ext::$pkg";
743 880
744 warn "loading '$path' into '$pkg'\n"; 881 warn "... loading '$path' into '$pkg'\n";
745 882
746 open my $fh, "<:utf8", $path 883 open my $fh, "<:utf8", $path
747 or die "$path: $!"; 884 or die "$path: $!";
748 885
749 my $source = 886 my $source =
750 "package $pkg; use strict; use utf8;\n" 887 "package $pkg; use strict; use utf8;\n"
751 . "#line 1 \"$path\"\n{\n" 888 . "#line 1 \"$path\"\n{\n"
752 . (do { local $/; <$fh> }) 889 . (do { local $/; <$fh> })
753 . "\n};\n1"; 890 . "\n};\n1";
754 891
755 eval $source 892 unless (eval $source) {
756 or die $@ ? "$path: $@\n" 893 my $msg = $@ ? "$path: $@\n"
757 : "extension disabled.\n"; 894 : "extension disabled.\n";
758 895 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
759 push @exts, $pkg; 896 warn $@;
760 $ext_pkg{$base} = $pkg; 897 warn "mandatory extension failed to load, exiting.\n";
761 898 exit 1;
762# no strict 'refs'; 899 }
763# @{"$pkg\::ISA"} = ext::; 900 die $@;
764
765 register $base, $pkg;
766}
767
768sub unload_extension {
769 my ($pkg) = @_;
770
771 warn "removing extension $pkg\n";
772
773 # remove hooks
774 #TODO
775# for my $idx (0 .. $#PLUGIN_EVENT) {
776# delete $hook[$idx]{$pkg};
777# } 901 }
778 902
779 # remove commands 903 push @EXTS, $pkg;
780 for my $name (keys %COMMAND) {
781 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
782
783 if (@cb) {
784 $COMMAND{$name} = \@cb;
785 } else {
786 delete $COMMAND{$name};
787 }
788 }
789
790 # remove extcmds
791 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
792 delete $EXTCMD{$name};
793 }
794
795 if (my $cb = $pkg->can ("unload")) {
796 eval {
797 $cb->($pkg);
798 1
799 } or warn "$pkg unloaded, but with errors: $@";
800 }
801
802 Symbol::delete_package $pkg;
803} 904}
804 905
805sub load_extensions { 906sub load_extensions {
806 for my $ext (<$LIBDIR/*.ext>) { 907 for my $ext (<$LIBDIR/*.ext>) {
807 next unless -r $ext; 908 next unless -r $ext;
811 } or warn "$ext not loaded: $@"; 912 } or warn "$ext not loaded: $@";
812 } 913 }
813} 914}
814 915
815############################################################################# 916#############################################################################
816# load/save/clean perl data associated with a map
817 917
818*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 my ($self, $merge) = @_;
1157
1158 # we have to keep some variables in memory intact
1159 local $self->{path};
1160 local $self->{load_path};
1161 local $self->{deny_save};
1162 local $self->{deny_reset};
1163
1164 $self->SUPER::thawer_merge ($merge);
1165}
1166
1167sub normalise {
1168 my ($path, $base) = @_;
1169
1170 # map plan:
1171 #
1172 # /! non-realised random map exit (special hack!)
1173 # {... are special paths that are not being touched
1174 # ?xxx/... are special absolute paths
1175 # ?random/... random maps
1176 # /... normal maps
1177 # ~user/... per-player map of a specific user
1178
1179 $path =~ s/$PATH_SEP/\//go;
1180
1181 # treat it as relative path if it starts with
1182 # something that looks reasonable
1183 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1184 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1185
1186 $base =~ s{[^/]+/?$}{};
1187 $path = "$base/$path";
1188 }
1189
1190 for ($path) {
1191 redo if s{//}{/};
1192 redo if s{/\.?/}{/};
1193 redo if s{/[^/]+/\.\./}{/};
1194 }
1195
1196 $path
1197}
1198
1199sub new_from_path {
1200 my (undef, $path, $base) = @_;
1201
1202 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1203
1204 $path = normalise $path, $base;
1205
1206 for my $pkg (keys %EXT_MAP) {
1207 if ($path =~ $EXT_MAP{$pkg}) {
1208 my $self = bless cf::map::new, $pkg;
1209 $self->{path} = $path; $self->path ($path);
1210 $self->init; # pass $1 etc.
1211 return $self;
1212 }
1213 }
1214
1215 Carp::carp "unable to resolve path '$path'.";
1216 ()
1217}
1218
1219sub init {
1220 my ($self) = @_;
1221
1222 $self
1223}
1224
1225sub as_string {
1226 my ($self) = @_;
1227
1228 "$self->{path}"
1229}
1230
1231# the displayed name, this is a one way mapping
1232sub visible_name {
1233 &as_string
1234}
1235
1236# the original (read-only) location
1237sub load_path {
1238 my ($self) = @_;
1239
1240 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
1241}
1242
1243# the temporary/swap location
1244sub save_path {
1245 my ($self) = @_;
1246
1247 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1248 sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path
1249}
1250
1251# the unique path, undef == no special unique path
1252sub uniq_path {
1253 my ($self) = @_;
1254
1255 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1256 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
1257}
1258
1259# and all this just because we cannot iterate over
1260# all maps in C++...
1261sub change_all_map_light {
1262 my ($change) = @_;
1263
1264 $_->change_map_light ($change)
1265 for grep $_->outdoor, values %cf::MAP;
1266}
1267
1268sub unlink_save {
1269 my ($self) = @_;
1270
1271 utf8::encode (my $save = $self->save_path);
1272 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1273 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1274}
1275
1276sub load_header_from($) {
1277 my ($self, $path) = @_;
1278
1279 utf8::encode $path;
1280 aio_open $path, O_RDONLY, 0
1281 or return;
1282
1283 $self->_load_header ($path)
1284 or return;
1285
1286 $self->{load_path} = $path;
1287
1288 1
1289}
1290
1291sub load_orig {
1292 my ($self) = @_;
1293
1294 $self->load_header_from ($self->load_path)
1295}
1296
1297sub load_temp {
1298 my ($self) = @_;
1299
1300 $self->load_header_from ($self->save_path)
1301}
1302
1303sub load_header {
1304 my ($self) = @_;
1305
1306 if ($self->load_temp) {
1307 $self->last_access ((delete $self->{last_access})
1308 || $cf::RUNTIME); #d#
1309 # safety
1310 $self->{instantiate_time} = $cf::RUNTIME
1311 if $self->{instantiate_time} > $cf::RUNTIME;
1312 } else {
1313 $self->load_orig
1314 or return;
1315
1316 $self->{load_original} = 1;
1317 $self->{instantiate_time} = $cf::RUNTIME;
1318 $self->last_access ($cf::RUNTIME);
1319 $self->instantiate;
1320 }
1321
1322 1
1323}
1324
1325sub find;
1326sub find {
1327 my ($path, $origin) = @_;
1328
1329 $path = normalise $path, $origin && $origin->path;
1330
1331 cf::lock_wait "map_find:$path";
1332
1333 $cf::MAP{$path} || do {
1334 my $guard = cf::lock_acquire "map_find:$path";
1335 my $map = new_from_path cf::map $path
1336 or return;
1337
1338 $map->{last_save} = $cf::RUNTIME;
1339
1340 $map->load_header
1341 or return;
1342
1343 if ($map->should_reset) {
1344 $cf::WAIT_FOR_TICK->wait;
1345 $map->reset;
1346 undef $guard;
1347 $map = find $path
1348 or return;
1349 }
1350
1351 $cf::MAP{$path} = $map
1352 }
1353}
1354
1355sub load {
1356 my ($self) = @_;
1357
1358 my $path = $self->{path};
1359 my $guard = cf::lock_acquire "map_load:$path";
1360
1361 return if $self->in_memory != cf::MAP_SWAPPED;
1362
1363 $self->in_memory (cf::MAP_LOADING);
1364
1365 $self->alloc;
1366 $self->_load_objects ($self->{load_path}, 1)
1367 or return;
1368
1369 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1370 if delete $self->{load_original};
1371
1372 if (my $uniq = $self->uniq_path) {
1373 utf8::encode $uniq;
1374 if (aio_open $uniq, O_RDONLY, 0) {
1375 $self->clear_unique_items;
1376 $self->_load_objects ($uniq, 0);
1377 }
1378 }
1379
1380 Coro::cede;
1381
1382 # now do the right thing for maps
1383 $self->link_multipart_objects;
1384
1385 unless ($self->{deny_activate}) {
1386 $self->decay_objects;
1387 $self->fix_auto_apply;
1388 $self->update_buttons;
1389 Coro::cede;
1390 $self->set_darkness_map;
1391 $self->difficulty ($self->estimate_difficulty)
1392 unless $self->difficulty;
1393 Coro::cede;
1394 $self->activate;
1395 }
1396
1397 $self->in_memory (cf::MAP_IN_MEMORY);
1398}
1399
1400sub customise_for {
1401 my ($self, $ob) = @_;
1402
1403 return find "~" . $ob->name . "/" . $self->{path}
1404 if $self->per_player;
1405
1406 $self
1407}
1408
1409# find and load all maps in the 3x3 area around a map
1410sub load_diag {
819 my ($map) = @_; 1411 my ($map) = @_;
820 1412
821 my $path = $map->tmpname; 1413 my @diag; # diagonal neighbours
822 defined $path or return;
823 1414
824 unlink "$path.pst"; 1415 for (0 .. 3) {
1416 my $neigh = $map->tile_path ($_)
1417 or next;
1418 $neigh = find $neigh, $map
1419 or next;
1420 $neigh->load;
1421
1422 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1423 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1424 }
1425
1426 for (@diag) {
1427 my $neigh = find @$_
1428 or next;
1429 $neigh->load;
1430 }
1431}
1432
1433sub find_sync {
1434 my ($path, $origin) = @_;
1435
1436 cf::sync_job { find $path, $origin }
1437}
1438
1439sub do_load_sync {
1440 my ($map) = @_;
1441
1442 cf::sync_job { $map->load };
1443}
1444
1445our %MAP_PREFETCH;
1446our $MAP_PREFETCHER = Coro::async {
1447 while () {
1448 for my $path (keys %MAP_PREFETCH) {
1449 my $map = find $path
1450 or next;
1451 $map->load;
1452
1453 delete $MAP_PREFETCH{$path};
1454 }
1455 Coro::schedule;
1456 }
825}; 1457};
826 1458
827cf::map->attach (prio => -10000, package => cf::mapsupport::); 1459sub find_async {
1460 my ($path, $origin) = @_;
828 1461
829############################################################################# 1462 $path = normalise $path, $origin && $origin->{path};
830# load/save perl data associated with player->ob objects
831 1463
832sub all_objects(@) { 1464 if (my $map = $cf::MAP{$path}) {
833 @_, map all_objects ($_->inv), @_ 1465 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
834}
835
836# TODO: compatibility cruft, remove when no longer needed
837cf::player->attach (
838 on_load => sub {
839 my ($pl, $path) = @_;
840
841 for my $o (all_objects $pl->ob) {
842 if (my $value = $o->get_ob_key_value ("_perl_data")) {
843 $o->set_ob_key_value ("_perl_data");
844
845 %$o = %{ Storable::thaw pack "H*", $value };
846 }
847 }
848 }, 1466 }
849);
850 1467
851############################################################################# 1468 $MAP_PREFETCH{$path} = 0;
1469 $MAP_PREFETCHER->ready;
852 1470
853=head2 CORE EXTENSIONS 1471 ()
1472}
854 1473
855Functions and methods that extend core crossfire objects. 1474sub save {
1475 my ($self) = @_;
856 1476
857=head3 cf::player 1477 my $lock = cf::lock_acquire "map_data:" . $self->path;
1478
1479 $self->{last_save} = $cf::RUNTIME;
1480
1481 return unless $self->dirty;
1482
1483 my $save = $self->save_path; utf8::encode $save;
1484 my $uniq = $self->uniq_path; utf8::encode $uniq;
1485
1486 $self->{load_path} = $save;
1487
1488 return if $self->{deny_save};
1489
1490 local $self->{last_access} = $self->last_access;#d#
1491
1492 cf::async {
1493 $_->contr->save for $self->players;
1494 };
1495
1496 if ($uniq) {
1497 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1498 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1499 } else {
1500 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1501 }
1502}
1503
1504sub swap_out {
1505 my ($self) = @_;
1506
1507 # save first because save cedes
1508 $self->save;
1509
1510 my $lock = cf::lock_acquire "map_data:" . $self->path;
1511
1512 return if $self->players;
1513 return if $self->in_memory != cf::MAP_IN_MEMORY;
1514 return if $self->{deny_save};
1515
1516 $self->clear;
1517 $self->in_memory (cf::MAP_SWAPPED);
1518}
1519
1520sub reset_at {
1521 my ($self) = @_;
1522
1523 # TODO: safety, remove and allow resettable per-player maps
1524 return 1e99 if $self->isa ("ext::map_per_player");#d#
1525 return 1e99 if $self->{deny_reset};
1526
1527 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1528 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1529
1530 $time + $to
1531}
1532
1533sub should_reset {
1534 my ($self) = @_;
1535
1536 $self->reset_at <= $cf::RUNTIME
1537}
1538
1539sub rename {
1540 my ($self, $new_path) = @_;
1541
1542 normalise $new_path;
1543
1544 $self->unlink_save;
1545
1546 delete $cf::MAP{$self->path};
1547 $self->{path} = $new_path; $self->path ($self->{path});
1548 $cf::MAP{$self->path} = $self;
1549
1550 $self->save;
1551}
1552
1553sub reset {
1554 my ($self) = @_;
1555
1556 my $lock = cf::lock_acquire "map_data:$self->{path}";
1557
1558 return if $self->players;
1559 return if $self->isa ("ext::map_per_player");#d#
1560
1561 warn "resetting map ", $self->path;#d#
1562
1563 delete $cf::MAP{$self->path};
1564
1565 $self->in_memory (cf::MAP_SWAPPED);
1566 $self->clear;
1567
1568 $_->clear_links_to ($self) for values %cf::MAP;
1569
1570 $self->unlink_save;
1571 $self->destroy;
1572}
1573
1574my $nuke_counter = "aaaa";
1575
1576sub nuke {
1577 my ($self) = @_;
1578
1579 $self->{deny_save} = 1;
1580 $self->reset_timeout (1);
1581 $self->rename ("{nuke}/" . ($nuke_counter++));
1582 $self->reset; # polite request, might not happen
1583}
1584
1585=item cf::map::unique_maps
1586
1587Returns an arrayref of paths of all shared maps that have
1588instantiated unique items. May block.
1589
1590=cut
1591
1592sub unique_maps() {
1593 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
1594 or return;
1595
1596 my @paths;
1597
1598 for (@$files) {
1599 utf8::decode $_;
1600 next if /\.pst$/;
1601 next unless /^$PATH_SEP/o;
1602
1603 s/\.map$//;
1604 push @paths, $_;
1605 }
1606
1607 \@paths
1608}
1609
1610package cf;
1611
1612=back
1613
1614=head3 cf::object
1615
1616=cut
1617
1618package cf::object;
858 1619
859=over 4 1620=over 4
860 1621
861=item cf::player::exists $login 1622=item $ob->inv_recursive
862 1623
863Returns true when the given account exists. 1624Returns the inventory of the object _and_ their inventories, recursively.
864 1625
865=cut 1626=cut
866 1627
867sub cf::player::exists($) { 1628sub inv_recursive_;
868 cf::player::find $_[0] 1629sub inv_recursive_ {
869 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1630 map { $_, inv_recursive_ $_->inv } @_
870} 1631}
871 1632
872=item $player->ext_reply ($msgid, $msgtype, %msg) 1633sub inv_recursive {
873 1634 inv_recursive_ inv $_[0]
874Sends an ext reply to the player.
875
876=cut
877
878sub cf::player::ext_reply($$$%) {
879 my ($self, $id, %msg) = @_;
880
881 $msg{msgid} = $id;
882
883 $self->send ("ext " . to_json \%msg);
884} 1635}
1636
1637package cf;
885 1638
886=back 1639=back
887 1640
888=head3 cf::object::player 1641=head3 cf::object::player
889 1642
927 (ref $cf::CFG{"may_$access"} 1680 (ref $cf::CFG{"may_$access"}
928 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1681 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
929 : $cf::CFG{"may_$access"}) 1682 : $cf::CFG{"may_$access"})
930} 1683}
931 1684
1685=item $player_object->enter_link
1686
1687Freezes the player and moves him/her to a special map (C<{link}>).
1688
1689The player should be reasonably safe there for short amounts of time. You
1690I<MUST> call C<leave_link> as soon as possible, though.
1691
1692Will never block.
1693
1694=item $player_object->leave_link ($map, $x, $y)
1695
1696Moves the player out of the special C<{link}> map onto the specified
1697map. If the map is not valid (or omitted), the player will be moved back
1698to the location he/she was before the call to C<enter_link>, or, if that
1699fails, to the emergency map position.
1700
1701Might block.
1702
1703=cut
1704
1705sub link_map {
1706 unless ($LINK_MAP) {
1707 $LINK_MAP = cf::map::find "{link}"
1708 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };
1709 $LINK_MAP->load;
1710 }
1711
1712 $LINK_MAP
1713}
1714
1715sub cf::object::player::enter_link {
1716 my ($self) = @_;
1717
1718 $self->deactivate_recursive;
1719
1720 return if UNIVERSAL::isa $self->map, "ext::map_link";
1721
1722 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1723 if $self->map;
1724
1725 $self->enter_map ($LINK_MAP || link_map, 20, 20);
1726}
1727
1728sub cf::object::player::leave_link {
1729 my ($self, $map, $x, $y) = @_;
1730
1731 my $link_pos = delete $self->{_link_pos};
1732
1733 unless ($map) {
1734 # restore original map position
1735 ($map, $x, $y) = @{ $link_pos || [] };
1736 $map = cf::map::find $map;
1737
1738 unless ($map) {
1739 ($map, $x, $y) = @$EMERGENCY_POSITION;
1740 $map = cf::map::find $map
1741 or die "FATAL: cannot load emergency map\n";
1742 }
1743 }
1744
1745 ($x, $y) = (-1, -1)
1746 unless (defined $x) && (defined $y);
1747
1748 # use -1 or undef as default coordinates, not 0, 0
1749 ($x, $y) = ($map->enter_x, $map->enter_y)
1750 if $x <=0 && $y <= 0;
1751
1752 $map->load;
1753 $map->load_diag;
1754
1755 return unless $self->contr->active;
1756 $self->activate_recursive;
1757 $self->enter_map ($map, $x, $y);
1758}
1759
1760cf::player->attach (
1761 on_logout => sub {
1762 my ($pl) = @_;
1763
1764 # abort map switching before logout
1765 if ($pl->ob->{_link_pos}) {
1766 cf::sync_job {
1767 $pl->ob->leave_link
1768 };
1769 }
1770 },
1771 on_login => sub {
1772 my ($pl) = @_;
1773
1774 # try to abort aborted map switching on player login :)
1775 # should happen only on crashes
1776 if ($pl->ob->{_link_pos}) {
1777 $pl->ob->enter_link;
1778 (async {
1779 # we need this sleep as the login has a concurrent enter_exit running
1780 # and this sleep increases chances of the player not ending up in scorn
1781 $pl->ob->reply (undef,
1782 "There was an internal problem at your last logout, "
1783 . "the server will try to bring you to your intended destination in a second.",
1784 cf::NDI_RED);
1785 Coro::Timer::sleep 1;
1786 $pl->ob->leave_link;
1787 })->prio (2);
1788 }
1789 },
1790);
1791
1792=item $player_object->goto ($path, $x, $y)
1793
1794=cut
1795
1796sub cf::object::player::goto {
1797 my ($self, $path, $x, $y) = @_;
1798
1799 $self->enter_link;
1800
1801 (async {
1802 my $map = cf::map::find $path;
1803 $map = $map->customise_for ($self) if $map;
1804
1805# warn "entering ", $map->path, " at ($x, $y)\n"
1806# if $map;
1807
1808 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1809
1810 $self->leave_link ($map, $x, $y);
1811 })->prio (1);
1812}
1813
1814=item $player_object->enter_exit ($exit_object)
1815
1816=cut
1817
1818sub parse_random_map_params {
1819 my ($spec) = @_;
1820
1821 my $rmp = { # defaults
1822 xsize => 10,
1823 ysize => 10,
1824 };
1825
1826 for (split /\n/, $spec) {
1827 my ($k, $v) = split /\s+/, $_, 2;
1828
1829 $rmp->{lc $k} = $v if (length $k) && (length $v);
1830 }
1831
1832 $rmp
1833}
1834
1835sub prepare_random_map {
1836 my ($exit) = @_;
1837
1838 # all this does is basically replace the /! path by
1839 # a new random map path (?random/...) with a seed
1840 # that depends on the exit object
1841
1842 my $rmp = parse_random_map_params $exit->msg;
1843
1844 if ($exit->map) {
1845 $rmp->{region} = $exit->map->region_name;
1846 $rmp->{origin_map} = $exit->map->path;
1847 $rmp->{origin_x} = $exit->x;
1848 $rmp->{origin_y} = $exit->y;
1849 }
1850
1851 $rmp->{random_seed} ||= $exit->random_seed;
1852
1853 my $data = cf::to_json $rmp;
1854 my $md5 = Digest::MD5::md5_hex $data;
1855
1856 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
1857 aio_write $fh, 0, (length $data), $data, 0;
1858
1859 $exit->slaying ("?random/$md5");
1860 $exit->msg (undef);
1861 }
1862}
1863
1864sub cf::object::player::enter_exit {
1865 my ($self, $exit) = @_;
1866
1867 return unless $self->type == cf::PLAYER;
1868
1869 $self->enter_link;
1870
1871 (async {
1872 $self->deactivate_recursive; # just to be sure
1873 unless (eval {
1874 prepare_random_map $exit
1875 if $exit->slaying eq "/!";
1876
1877 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1878 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1879
1880 1;
1881 }) {
1882 $self->message ("Something went wrong deep within the crossfire server. "
1883 . "I'll try to bring you back to the map you were before. "
1884 . "Please report this to the dungeon master!",
1885 cf::NDI_UNIQUE | cf::NDI_RED);
1886
1887 warn "ERROR in enter_exit: $@";
1888 $self->leave_link;
1889 }
1890 })->prio (1);
1891}
1892
932=head3 cf::client 1893=head3 cf::client
933 1894
934=over 4 1895=over 4
935 1896
936=item $client->send_drawinfo ($text, $flags) 1897=item $client->send_drawinfo ($text, $flags)
979 on_reply => sub { 1940 on_reply => sub {
980 my ($ns, $msg) = @_; 1941 my ($ns, $msg) = @_;
981 1942
982 # this weird shuffling is so that direct followup queries 1943 # this weird shuffling is so that direct followup queries
983 # get handled first 1944 # get handled first
984 my $queue = delete $ns->{query_queue}; 1945 my $queue = delete $ns->{query_queue}
1946 or return; # be conservative, not sure how that can happen, but we saw a crash here
985 1947
986 (shift @$queue)->[1]->($msg); 1948 (shift @$queue)->[1]->($msg);
987 1949
988 push @{ $ns->{query_queue} }, @$queue; 1950 push @{ $ns->{query_queue} }, @$queue;
989 1951
995 } 1957 }
996 } 1958 }
997 }, 1959 },
998); 1960);
999 1961
1000=item $client->coro (\&cb) 1962=item $client->async (\&cb)
1001 1963
1002Create a new coroutine, running the specified callback. The coroutine will 1964Create a new coroutine, running the specified callback. The coroutine will
1003be automatically cancelled when the client gets destroyed (e.g. on logout, 1965be automatically cancelled when the client gets destroyed (e.g. on logout,
1004or loss of connection). 1966or loss of connection).
1005 1967
1006=cut 1968=cut
1007 1969
1008sub cf::client::coro { 1970sub cf::client::async {
1009 my ($self, $cb) = @_; 1971 my ($self, $cb) = @_;
1010 1972
1011 my $coro; $coro = async { 1973 my $coro = &Coro::async ($cb);
1012 eval {
1013 $cb->();
1014 };
1015 warn $@ if $@;
1016 };
1017 1974
1018 $coro->on_destroy (sub { 1975 $coro->on_destroy (sub {
1019 delete $self->{_coro}{$coro+0}; 1976 delete $self->{_coro}{$coro+0};
1020 }); 1977 });
1021 1978
1193 2150
1194{ 2151{
1195 my $path = cf::localdir . "/database.pst"; 2152 my $path = cf::localdir . "/database.pst";
1196 2153
1197 sub db_load() { 2154 sub db_load() {
1198 warn "loading database $path\n";#d# remove later
1199 $DB = stat $path ? Storable::retrieve $path : { }; 2155 $DB = stat $path ? Storable::retrieve $path : { };
1200 } 2156 }
1201 2157
1202 my $pid; 2158 my $pid;
1203 2159
1204 sub db_save() { 2160 sub db_save() {
1205 warn "saving database $path\n";#d# remove later
1206 waitpid $pid, 0 if $pid; 2161 waitpid $pid, 0 if $pid;
1207 if (0 == ($pid = fork)) { 2162 if (0 == ($pid = fork)) {
1208 $DB->{_meta}{version} = 1; 2163 $DB->{_meta}{version} = 1;
1209 Storable::nstore $DB, "$path~"; 2164 Storable::nstore $DB, "$path~";
1210 rename "$path~", $path; 2165 rename "$path~", $path;
1258 open my $fh, "<:utf8", cf::confdir . "/config" 2213 open my $fh, "<:utf8", cf::confdir . "/config"
1259 or return; 2214 or return;
1260 2215
1261 local $/; 2216 local $/;
1262 *CFG = YAML::Syck::Load <$fh>; 2217 *CFG = YAML::Syck::Load <$fh>;
2218
2219 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2220
2221 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2222 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2223
2224 if (exists $CFG{mlockall}) {
2225 eval {
2226 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2227 and die "WARNING: m(un)lockall failed: $!\n";
2228 };
2229 warn $@ if $@;
2230 }
1263} 2231}
1264 2232
1265sub main { 2233sub main {
2234 # we must not ever block the main coroutine
2235 local $Coro::idle = sub {
2236 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2237 async { Event::one_event };
2238 };
2239
1266 cfg_load; 2240 cfg_load;
1267 db_load; 2241 db_load;
1268 load_extensions; 2242 load_extensions;
1269 Event::loop; 2243 Event::loop;
1270} 2244}
1271 2245
1272############################################################################# 2246#############################################################################
1273# initialisation 2247# initialisation and cleanup
1274 2248
2249# install some emergency cleanup handlers
2250BEGIN {
2251 for my $signal (qw(INT HUP TERM)) {
2252 Event->signal (
2253 data => WF_AUTOCANCEL,
2254 signal => $signal,
2255 cb => sub {
2256 cf::cleanup "SIG$signal";
2257 },
2258 );
2259 }
2260}
2261
2262sub emergency_save() {
2263 my $freeze_guard = cf::freeze_mainloop;
2264
2265 warn "enter emergency perl save\n";
2266
2267 cf::sync_job {
2268 # use a peculiar iteration method to avoid tripping on perl
2269 # refcount bugs in for. also avoids problems with players
2270 # and maps saved/destroyed asynchronously.
2271 warn "begin emergency player save\n";
2272 for my $login (keys %cf::PLAYER) {
2273 my $pl = $cf::PLAYER{$login} or next;
2274 $pl->valid or next;
2275 $pl->save;
2276 }
2277 warn "end emergency player save\n";
2278
2279 warn "begin emergency map save\n";
2280 for my $path (keys %cf::MAP) {
2281 my $map = $cf::MAP{$path} or next;
2282 $map->valid or next;
2283 $map->save;
2284 }
2285 warn "end emergency map save\n";
2286 };
2287
2288 warn "leave emergency perl save\n";
2289}
2290
1275sub _perl_reload() { 2291sub reload() {
2292 # can/must only be called in main
2293 if ($Coro::current != $Coro::main) {
2294 warn "can only reload from main coroutine\n";
2295 return;
2296 }
2297
1276 warn "reloading..."; 2298 warn "reloading...";
1277 2299
2300 warn "freezing server";
2301 my $guard = freeze_mainloop;
2302 cf::emergency_save;
2303
2304 warn "sync database to disk";
2305 cf::db_sync;
2306 IO::AIO::flush;
2307
1278 eval { 2308 eval {
1279 local $FREEZE = 1; 2309 # if anything goes wrong in here, we should simply crash as we already saved
1280 2310
1281 cf::emergency_save;
1282
1283 # cancel all watchers 2311 warn "cancel all watchers";
1284 for (Event::all_watchers) { 2312 for (Event::all_watchers) {
1285 $_->cancel if $_->data & WF_AUTOCANCEL; 2313 $_->cancel if $_->data & WF_AUTOCANCEL;
1286 } 2314 }
1287 2315
1288 # cancel all extension coros 2316 warn "cancel all extension coros";
1289 $_->cancel for values %EXT_CORO; 2317 $_->cancel for values %EXT_CORO;
1290 %EXT_CORO = (); 2318 %EXT_CORO = ();
1291 2319
2320 warn "remove commands";
2321 %COMMAND = ();
2322
2323 warn "remove ext commands";
2324 %EXTCMD = ();
2325
1292 # unload all extensions 2326 warn "unload/nuke all extensions";
1293 for (@exts) { 2327 for my $pkg (@EXTS) {
1294 warn "unloading <$_>"; 2328 warn "... unloading $pkg";
1295 unload_extension $_; 2329
2330 if (my $cb = $pkg->can ("unload")) {
2331 eval {
2332 $cb->($pkg);
2333 1
2334 } or warn "$pkg unloaded, but with errors: $@";
1296 } 2335 }
1297 2336
2337 warn "... nuking $pkg";
2338 Symbol::delete_package $pkg;
2339 }
2340
1298 # unload all modules loaded from $LIBDIR 2341 warn "unload all perl modules loaded from $LIBDIR";
1299 while (my ($k, $v) = each %INC) { 2342 while (my ($k, $v) = each %INC) {
1300 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2343 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1301 2344
1302 warn "removing <$k>"; 2345 warn "removing <$k>";
1303 delete $INC{$k}; 2346 delete $INC{$k};
1310 } 2353 }
1311 2354
1312 Symbol::delete_package $k; 2355 Symbol::delete_package $k;
1313 } 2356 }
1314 2357
1315 # sync database to disk
1316 cf::db_sync;
1317 IO::AIO::flush;
1318
1319 # get rid of safe::, as good as possible 2358 warn "get rid of safe::, as good as possible";
1320 Symbol::delete_package "safe::$_" 2359 Symbol::delete_package "safe::$_"
1321 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 2360 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1322 2361
1323 # remove register_script_function callbacks
1324 # TODO
1325
1326 # unload cf.pm "a bit" 2362 warn "unload cf.pm \"a bit\"";
1327 delete $INC{"cf.pm"}; 2363 delete $INC{"cf.pm"};
1328 2364
1329 # don't, removes xs symbols, too, 2365 # don't, removes xs symbols, too,
1330 # and global variables created in xs 2366 # and global variables created in xs
1331 #Symbol::delete_package __PACKAGE__; 2367 #Symbol::delete_package __PACKAGE__;
1332 2368
1333 # reload cf.pm
1334 warn "reloading cf.pm"; 2369 warn "reloading cf.pm";
1335 require cf; 2370 require cf;
1336 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2371 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1337 2372
1338 # load config and database again 2373 warn "load config and database again";
1339 cf::cfg_load; 2374 cf::cfg_load;
1340 cf::db_load; 2375 cf::db_load;
1341 2376
1342 # load extensions
1343 warn "load extensions"; 2377 warn "load extensions";
1344 cf::load_extensions; 2378 cf::load_extensions;
1345 2379
1346 # reattach attachments to objects 2380 warn "reattach attachments to objects/players";
1347 warn "reattach";
1348 _global_reattach; 2381 _global_reattach;
2382 warn "reattach attachments to maps";
2383 reattach $_ for values %MAP;
1349 }; 2384 };
1350 warn $@ if $@; 2385
2386 if ($@) {
2387 warn $@;
2388 warn "error while reloading, exiting.";
2389 exit 1;
2390 }
1351 2391
1352 warn "reloaded"; 2392 warn "reloaded";
1353}; 2393};
1354 2394
1355sub perl_reload() {
1356 _perl_reload;
1357}
1358
1359register "<global>", __PACKAGE__;
1360
1361register_command "perl-reload" => sub { 2395register_command "reload" => sub {
1362 my ($who, $arg) = @_; 2396 my ($who, $arg) = @_;
1363 2397
1364 if ($who->flag (FLAG_WIZ)) { 2398 if ($who->flag (FLAG_WIZ)) {
2399 $who->message ("start of reload.");
2400 reload;
1365 $who->message ("reloading..."); 2401 $who->message ("end of reload.");
1366 _perl_reload;
1367 } 2402 }
1368}; 2403};
1369 2404
1370unshift @INC, $LIBDIR; 2405unshift @INC, $LIBDIR;
1371 2406
1373 reentrant => 0, 2408 reentrant => 0,
1374 prio => 0, 2409 prio => 0,
1375 at => $NEXT_TICK || $TICK, 2410 at => $NEXT_TICK || $TICK,
1376 data => WF_AUTOCANCEL, 2411 data => WF_AUTOCANCEL,
1377 cb => sub { 2412 cb => sub {
1378 unless ($FREEZE) { 2413 $NOW = Event::time;
2414
1379 cf::server_tick; # one server iteration 2415 cf::server_tick; # one server iteration
1380 $RUNTIME += $TICK; 2416 $RUNTIME += $TICK;
1381 }
1382
1383 $NEXT_TICK += $TICK; 2417 $NEXT_TICK += $TICK;
2418
2419 $WAIT_FOR_TICK->broadcast;
2420 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
1384 2421
1385 # if we are delayed by four ticks or more, skip them all 2422 # if we are delayed by four ticks or more, skip them all
1386 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 2423 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1387 2424
1388 $TICK_WATCHER->at ($NEXT_TICK); 2425 $TICK_WATCHER->at ($NEXT_TICK);
1390 }, 2427 },
1391); 2428);
1392 2429
1393IO::AIO::max_poll_time $TICK * 0.2; 2430IO::AIO::max_poll_time $TICK * 0.2;
1394 2431
2432$AIO_POLL_WATCHER = Event->io (
1395Event->io (fd => IO::AIO::poll_fileno, 2433 fd => IO::AIO::poll_fileno,
1396 poll => 'r', 2434 poll => 'r',
1397 prio => 5, 2435 prio => 5,
1398 data => WF_AUTOCANCEL, 2436 data => WF_AUTOCANCEL,
1399 cb => \&IO::AIO::poll_cb); 2437 cb => \&IO::AIO::poll_cb,
2438);
1400 2439
1401# we must not ever block the main coroutine 2440$WRITE_RUNTIME_WATCHER = Event->timer (
1402$Coro::idle = sub { 2441 data => WF_AUTOCANCEL,
1403 #Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d# 2442 after => 0,
1404 warn "FATAL: Coro::idle was called, major BUG\n"; 2443 interval => 10,
2444 cb => sub {
1405 (Coro::unblock_sub { 2445 (Coro::unblock_sub {
1406 Event::one_event; 2446 write_runtime
2447 or warn "ERROR: unable to write runtime file: $!";
1407 })->(); 2448 })->();
1408}; 2449 },
2450);
2451
2452END { cf::emergency_save }
1409 2453
14101 24541
1411 2455

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines