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.171 by root, Sun Jan 14 12:24: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 # 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 $cf::WAIT_FOR_TICK->wait;
1342 $map->reset;
1343 undef $guard;
1344 $map = find $path
1345 or return;
1346 }
1347
1348 $cf::MAP{$path} = $map
1349 }
1350}
1351
1352sub load {
1353 my ($self) = @_;
1354
1355 my $path = $self->{path};
1356 my $guard = cf::lock_acquire "map_load:$path";
1357
1358 return if $self->in_memory != cf::MAP_SWAPPED;
1359
1360 $self->in_memory (cf::MAP_LOADING);
1361
1362 $self->alloc;
1363 $self->_load_objects ($self->{load_path}, 1)
1364 or return;
1365
1366 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1367 if delete $self->{load_original};
1368
1369 if (my $uniq = $self->uniq_path) {
1370 utf8::encode $uniq;
1371 if (aio_open $uniq, O_RDONLY, 0) {
1372 $self->clear_unique_items;
1373 $self->_load_objects ($uniq, 0);
1374 }
1375 }
1376
1377 Coro::cede;
1378
1379 # now do the right thing for maps
1380 $self->link_multipart_objects;
1381
1382 unless ($self->{deny_activate}) {
1383 $self->decay_objects;
1384 $self->fix_auto_apply;
1385 $self->update_buttons;
1386 Coro::cede;
1387 $self->set_darkness_map;
1388 $self->difficulty ($self->estimate_difficulty)
1389 unless $self->difficulty;
1390 Coro::cede;
1391 $self->activate;
1392 }
1393
1394 $self->in_memory (cf::MAP_IN_MEMORY);
1395}
1396
1397sub customise_for {
1398 my ($self, $ob) = @_;
1399
1400 return find "~" . $ob->name . "/" . $self->{path}
1401 if $self->per_player;
1402
1403 $self
1404}
1405
1406# find and load all maps in the 3x3 area around a map
1407sub load_diag {
819 my ($map) = @_; 1408 my ($map) = @_;
820 1409
821 my $path = $map->tmpname; 1410 my @diag; # diagonal neighbours
822 defined $path or return;
823 1411
824 unlink "$path.pst"; 1412 for (0 .. 3) {
1413 my $neigh = $map->tile_path ($_)
1414 or next;
1415 $neigh = find $neigh, $map
1416 or next;
1417 $neigh->load;
1418
1419 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1420 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1421 }
1422
1423 for (@diag) {
1424 my $neigh = find @$_
1425 or next;
1426 $neigh->load;
1427 }
1428}
1429
1430sub find_sync {
1431 my ($path, $origin) = @_;
1432
1433 cf::sync_job { find $path, $origin }
1434}
1435
1436sub do_load_sync {
1437 my ($map) = @_;
1438
1439 cf::sync_job { $map->load };
1440}
1441
1442our %MAP_PREFETCH;
1443our $MAP_PREFETCHER = Coro::async {
1444 while () {
1445 for my $path (keys %MAP_PREFETCH) {
1446 my $map = find $path
1447 or next;
1448 $map->load;
1449
1450 delete $MAP_PREFETCH{$path};
1451 }
1452 Coro::schedule;
1453 }
825}; 1454};
826 1455
827cf::map->attach (prio => -10000, package => cf::mapsupport::); 1456sub find_async {
1457 my ($path, $origin) = @_;
828 1458
829############################################################################# 1459 $path = normalise $path, $origin && $origin->{path};
830# load/save perl data associated with player->ob objects
831 1460
832sub all_objects(@) { 1461 if (my $map = $cf::MAP{$path}) {
833 @_, map all_objects ($_->inv), @_ 1462 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 }, 1463 }
849);
850 1464
851############################################################################# 1465 $MAP_PREFETCH{$path} = 0;
1466 $MAP_PREFETCHER->ready;
852 1467
853=head2 CORE EXTENSIONS 1468 ()
1469}
854 1470
855Functions and methods that extend core crossfire objects. 1471sub save {
1472 my ($self) = @_;
856 1473
857=head3 cf::player 1474 my $lock = cf::lock_acquire "map_data:" . $self->path;
1475
1476 $self->{last_save} = $cf::RUNTIME;
1477
1478 return unless $self->dirty;
1479
1480 my $save = $self->save_path; utf8::encode $save;
1481 my $uniq = $self->uniq_path; utf8::encode $uniq;
1482
1483 $self->{load_path} = $save;
1484
1485 return if $self->{deny_save};
1486
1487 local $self->{last_access} = $self->last_access;#d#
1488
1489 cf::async {
1490 $_->contr->save for $self->players;
1491 };
1492
1493 if ($uniq) {
1494 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1495 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1496 } else {
1497 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1498 }
1499}
1500
1501sub swap_out {
1502 my ($self) = @_;
1503
1504 # save first because save cedes
1505 $self->save;
1506
1507 my $lock = cf::lock_acquire "map_data:" . $self->path;
1508
1509 return if $self->players;
1510 return if $self->in_memory != cf::MAP_IN_MEMORY;
1511 return if $self->{deny_save};
1512
1513 $self->clear;
1514 $self->in_memory (cf::MAP_SWAPPED);
1515}
1516
1517sub reset_at {
1518 my ($self) = @_;
1519
1520 # TODO: safety, remove and allow resettable per-player maps
1521 return 1e99 if $self->isa ("ext::map_per_player");#d#
1522 return 1e99 if $self->{deny_reset};
1523
1524 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1525 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1526
1527 $time + $to
1528}
1529
1530sub should_reset {
1531 my ($self) = @_;
1532
1533 $self->reset_at <= $cf::RUNTIME
1534}
1535
1536sub rename {
1537 my ($self, $new_path) = @_;
1538
1539 normalise $new_path;
1540
1541 $self->unlink_save;
1542
1543 delete $cf::MAP{$self->path};
1544 $self->{path} = $new_path; $self->path ($self->{path});
1545 $cf::MAP{$self->path} = $self;
1546
1547 $self->save;
1548}
1549
1550sub reset {
1551 my ($self) = @_;
1552
1553 my $lock = cf::lock_acquire "map_data:$self->{path}";
1554
1555 return if $self->players;
1556 return if $self->isa ("ext::map_per_player");#d#
1557
1558 warn "resetting map ", $self->path;#d#
1559
1560 delete $cf::MAP{$self->path};
1561
1562 $self->in_memory (cf::MAP_SWAPPED);
1563 $self->clear;
1564
1565 $_->clear_links_to ($self) for values %cf::MAP;
1566
1567 $self->unlink_save;
1568 $self->destroy;
1569}
1570
1571my $nuke_counter = "aaaa";
1572
1573sub nuke {
1574 my ($self) = @_;
1575
1576 $self->{deny_save} = 1;
1577 $self->reset_timeout (1);
1578 $self->rename ("{nuke}/" . ($nuke_counter++));
1579 $self->reset; # polite request, might not happen
1580}
1581
1582=item cf::map::unique_maps
1583
1584Returns an arrayref of paths of all shared maps that have
1585instantiated unique items. May block.
1586
1587=cut
1588
1589sub unique_maps() {
1590 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
1591 or return;
1592
1593 my @paths;
1594
1595 for (@$files) {
1596 utf8::decode $_;
1597 next if /\.pst$/;
1598 next unless /^$PATH_SEP/o;
1599
1600 s/\.map$//;
1601 push @paths, $_;
1602 }
1603
1604 \@paths
1605}
1606
1607package cf;
1608
1609=back
1610
1611=head3 cf::object
1612
1613=cut
1614
1615package cf::object;
858 1616
859=over 4 1617=over 4
860 1618
861=item cf::player::exists $login 1619=item $ob->inv_recursive
862 1620
863Returns true when the given account exists. 1621Returns the inventory of the object _and_ their inventories, recursively.
864 1622
865=cut 1623=cut
866 1624
867sub cf::player::exists($) { 1625sub inv_recursive_;
868 cf::player::find $_[0] 1626sub inv_recursive_ {
869 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1627 map { $_, inv_recursive_ $_->inv } @_
870} 1628}
871 1629
872=item $player->ext_reply ($msgid, $msgtype, %msg) 1630sub inv_recursive {
873 1631 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} 1632}
1633
1634package cf;
885 1635
886=back 1636=back
887 1637
888=head3 cf::object::player 1638=head3 cf::object::player
889 1639
927 (ref $cf::CFG{"may_$access"} 1677 (ref $cf::CFG{"may_$access"}
928 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1678 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
929 : $cf::CFG{"may_$access"}) 1679 : $cf::CFG{"may_$access"})
930} 1680}
931 1681
1682=item $player_object->enter_link
1683
1684Freezes the player and moves him/her to a special map (C<{link}>).
1685
1686The player should be reasonably safe there for short amounts of time. You
1687I<MUST> call C<leave_link> as soon as possible, though.
1688
1689Will never block.
1690
1691=item $player_object->leave_link ($map, $x, $y)
1692
1693Moves the player out of the special C<{link}> map onto the specified
1694map. If the map is not valid (or omitted), the player will be moved back
1695to the location he/she was before the call to C<enter_link>, or, if that
1696fails, to the emergency map position.
1697
1698Might block.
1699
1700=cut
1701
1702sub link_map {
1703 unless ($LINK_MAP) {
1704 $LINK_MAP = cf::map::find "{link}"
1705 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };
1706 $LINK_MAP->load;
1707 }
1708
1709 $LINK_MAP
1710}
1711
1712sub cf::object::player::enter_link {
1713 my ($self) = @_;
1714
1715 $self->deactivate_recursive;
1716
1717 return if UNIVERSAL::isa $self->map, "ext::map_link";
1718
1719 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1720 if $self->map;
1721
1722 $self->enter_map ($LINK_MAP || link_map, 20, 20);
1723}
1724
1725sub cf::object::player::leave_link {
1726 my ($self, $map, $x, $y) = @_;
1727
1728 my $link_pos = delete $self->{_link_pos};
1729
1730 unless ($map) {
1731 # restore original map position
1732 ($map, $x, $y) = @{ $link_pos || [] };
1733 $map = cf::map::find $map;
1734
1735 unless ($map) {
1736 ($map, $x, $y) = @$EMERGENCY_POSITION;
1737 $map = cf::map::find $map
1738 or die "FATAL: cannot load emergency map\n";
1739 }
1740 }
1741
1742 ($x, $y) = (-1, -1)
1743 unless (defined $x) && (defined $y);
1744
1745 # use -1 or undef as default coordinates, not 0, 0
1746 ($x, $y) = ($map->enter_x, $map->enter_y)
1747 if $x <=0 && $y <= 0;
1748
1749 $map->load;
1750 $map->load_diag;
1751
1752 return unless $self->contr->active;
1753 $self->activate_recursive;
1754 $self->enter_map ($map, $x, $y);
1755}
1756
1757cf::player->attach (
1758 on_logout => sub {
1759 my ($pl) = @_;
1760
1761 # abort map switching before logout
1762 if ($pl->ob->{_link_pos}) {
1763 cf::sync_job {
1764 $pl->ob->leave_link
1765 };
1766 }
1767 },
1768 on_login => sub {
1769 my ($pl) = @_;
1770
1771 # try to abort aborted map switching on player login :)
1772 # should happen only on crashes
1773 if ($pl->ob->{_link_pos}) {
1774 $pl->ob->enter_link;
1775 (async {
1776 # we need this sleep as the login has a concurrent enter_exit running
1777 # and this sleep increases chances of the player not ending up in scorn
1778 $pl->ob->reply (undef,
1779 "There was an internal problem at your last logout, "
1780 . "the server will try to bring you to your intended destination in a second.",
1781 cf::NDI_RED);
1782 Coro::Timer::sleep 1;
1783 $pl->ob->leave_link;
1784 })->prio (2);
1785 }
1786 },
1787);
1788
1789=item $player_object->goto ($path, $x, $y)
1790
1791=cut
1792
1793sub cf::object::player::goto {
1794 my ($self, $path, $x, $y) = @_;
1795
1796 $self->enter_link;
1797
1798 (async {
1799 my $map = cf::map::find $path;
1800 $map = $map->customise_for ($self) if $map;
1801
1802# warn "entering ", $map->path, " at ($x, $y)\n"
1803# if $map;
1804
1805 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1806
1807 $self->leave_link ($map, $x, $y);
1808 })->prio (1);
1809}
1810
1811=item $player_object->enter_exit ($exit_object)
1812
1813=cut
1814
1815sub parse_random_map_params {
1816 my ($spec) = @_;
1817
1818 my $rmp = { # defaults
1819 xsize => 10,
1820 ysize => 10,
1821 };
1822
1823 for (split /\n/, $spec) {
1824 my ($k, $v) = split /\s+/, $_, 2;
1825
1826 $rmp->{lc $k} = $v if (length $k) && (length $v);
1827 }
1828
1829 $rmp
1830}
1831
1832sub prepare_random_map {
1833 my ($exit) = @_;
1834
1835 # all this does is basically replace the /! path by
1836 # a new random map path (?random/...) with a seed
1837 # that depends on the exit object
1838
1839 my $rmp = parse_random_map_params $exit->msg;
1840
1841 if ($exit->map) {
1842 $rmp->{region} = $exit->map->region_name;
1843 $rmp->{origin_map} = $exit->map->path;
1844 $rmp->{origin_x} = $exit->x;
1845 $rmp->{origin_y} = $exit->y;
1846 }
1847
1848 $rmp->{random_seed} ||= $exit->random_seed;
1849
1850 my $data = cf::to_json $rmp;
1851 my $md5 = Digest::MD5::md5_hex $data;
1852
1853 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
1854 aio_write $fh, 0, (length $data), $data, 0;
1855
1856 $exit->slaying ("?random/$md5");
1857 $exit->msg (undef);
1858 }
1859}
1860
1861sub cf::object::player::enter_exit {
1862 my ($self, $exit) = @_;
1863
1864 return unless $self->type == cf::PLAYER;
1865
1866 $self->enter_link;
1867
1868 (async {
1869 $self->deactivate_recursive; # just to be sure
1870 unless (eval {
1871 prepare_random_map $exit
1872 if $exit->slaying eq "/!";
1873
1874 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1875 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1876
1877 1;
1878 }) {
1879 $self->message ("Something went wrong deep within the crossfire server. "
1880 . "I'll try to bring you back to the map you were before. "
1881 . "Please report this to the dungeon master!",
1882 cf::NDI_UNIQUE | cf::NDI_RED);
1883
1884 warn "ERROR in enter_exit: $@";
1885 $self->leave_link;
1886 }
1887 })->prio (1);
1888}
1889
932=head3 cf::client 1890=head3 cf::client
933 1891
934=over 4 1892=over 4
935 1893
936=item $client->send_drawinfo ($text, $flags) 1894=item $client->send_drawinfo ($text, $flags)
979 on_reply => sub { 1937 on_reply => sub {
980 my ($ns, $msg) = @_; 1938 my ($ns, $msg) = @_;
981 1939
982 # this weird shuffling is so that direct followup queries 1940 # this weird shuffling is so that direct followup queries
983 # get handled first 1941 # get handled first
984 my $queue = delete $ns->{query_queue}; 1942 my $queue = delete $ns->{query_queue}
1943 or return; # be conservative, not sure how that can happen, but we saw a crash here
985 1944
986 (shift @$queue)->[1]->($msg); 1945 (shift @$queue)->[1]->($msg);
987 1946
988 push @{ $ns->{query_queue} }, @$queue; 1947 push @{ $ns->{query_queue} }, @$queue;
989 1948
995 } 1954 }
996 } 1955 }
997 }, 1956 },
998); 1957);
999 1958
1000=item $client->coro (\&cb) 1959=item $client->async (\&cb)
1001 1960
1002Create a new coroutine, running the specified callback. The coroutine will 1961Create a new coroutine, running the specified callback. The coroutine will
1003be automatically cancelled when the client gets destroyed (e.g. on logout, 1962be automatically cancelled when the client gets destroyed (e.g. on logout,
1004or loss of connection). 1963or loss of connection).
1005 1964
1006=cut 1965=cut
1007 1966
1008sub cf::client::coro { 1967sub cf::client::async {
1009 my ($self, $cb) = @_; 1968 my ($self, $cb) = @_;
1010 1969
1011 my $coro; $coro = async { 1970 my $coro = &Coro::async ($cb);
1012 eval {
1013 $cb->();
1014 };
1015 warn $@ if $@;
1016 };
1017 1971
1018 $coro->on_destroy (sub { 1972 $coro->on_destroy (sub {
1019 delete $self->{_coro}{$coro+0}; 1973 delete $self->{_coro}{$coro+0};
1020 }); 1974 });
1021 1975
1193 2147
1194{ 2148{
1195 my $path = cf::localdir . "/database.pst"; 2149 my $path = cf::localdir . "/database.pst";
1196 2150
1197 sub db_load() { 2151 sub db_load() {
1198 warn "loading database $path\n";#d# remove later
1199 $DB = stat $path ? Storable::retrieve $path : { }; 2152 $DB = stat $path ? Storable::retrieve $path : { };
1200 } 2153 }
1201 2154
1202 my $pid; 2155 my $pid;
1203 2156
1204 sub db_save() { 2157 sub db_save() {
1205 warn "saving database $path\n";#d# remove later
1206 waitpid $pid, 0 if $pid; 2158 waitpid $pid, 0 if $pid;
1207 if (0 == ($pid = fork)) { 2159 if (0 == ($pid = fork)) {
1208 $DB->{_meta}{version} = 1; 2160 $DB->{_meta}{version} = 1;
1209 Storable::nstore $DB, "$path~"; 2161 Storable::nstore $DB, "$path~";
1210 rename "$path~", $path; 2162 rename "$path~", $path;
1258 open my $fh, "<:utf8", cf::confdir . "/config" 2210 open my $fh, "<:utf8", cf::confdir . "/config"
1259 or return; 2211 or return;
1260 2212
1261 local $/; 2213 local $/;
1262 *CFG = YAML::Syck::Load <$fh>; 2214 *CFG = YAML::Syck::Load <$fh>;
2215
2216 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2217
2218 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2219 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2220
2221 if (exists $CFG{mlockall}) {
2222 eval {
2223 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2224 and die "WARNING: m(un)lockall failed: $!\n";
2225 };
2226 warn $@ if $@;
2227 }
1263} 2228}
1264 2229
1265sub main { 2230sub main {
2231 # we must not ever block the main coroutine
2232 local $Coro::idle = sub {
2233 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2234 async { Event::one_event };
2235 };
2236
1266 cfg_load; 2237 cfg_load;
1267 db_load; 2238 db_load;
1268 load_extensions; 2239 load_extensions;
1269 Event::loop; 2240 Event::loop;
1270} 2241}
1271 2242
1272############################################################################# 2243#############################################################################
1273# initialisation 2244# initialisation and cleanup
1274 2245
2246# install some emergency cleanup handlers
2247BEGIN {
2248 for my $signal (qw(INT HUP TERM)) {
2249 Event->signal (
2250 data => WF_AUTOCANCEL,
2251 signal => $signal,
2252 cb => sub {
2253 cf::cleanup "SIG$signal";
2254 },
2255 );
2256 }
2257}
2258
2259sub emergency_save() {
2260 my $freeze_guard = cf::freeze_mainloop;
2261
2262 warn "enter emergency perl save\n";
2263
2264 cf::sync_job {
2265 # use a peculiar iteration method to avoid tripping on perl
2266 # refcount bugs in for. also avoids problems with players
2267 # and maps saved/destroyed asynchronously.
2268 warn "begin emergency player save\n";
2269 for my $login (keys %cf::PLAYER) {
2270 my $pl = $cf::PLAYER{$login} or next;
2271 $pl->valid or next;
2272 $pl->save;
2273 }
2274 warn "end emergency player save\n";
2275
2276 warn "begin emergency map save\n";
2277 for my $path (keys %cf::MAP) {
2278 my $map = $cf::MAP{$path} or next;
2279 $map->valid or next;
2280 $map->save;
2281 }
2282 warn "end emergency map save\n";
2283 };
2284
2285 warn "leave emergency perl save\n";
2286}
2287
1275sub _perl_reload() { 2288sub reload() {
2289 # can/must only be called in main
2290 if ($Coro::current != $Coro::main) {
2291 warn "can only reload from main coroutine\n";
2292 return;
2293 }
2294
1276 warn "reloading..."; 2295 warn "reloading...";
1277 2296
2297 warn "freezing server";
2298 my $guard = freeze_mainloop;
2299 cf::emergency_save;
2300
2301 warn "sync database to disk";
2302 cf::db_sync;
2303 IO::AIO::flush;
2304
1278 eval { 2305 eval {
1279 local $FREEZE = 1; 2306 # if anything goes wrong in here, we should simply crash as we already saved
1280 2307
1281 cf::emergency_save;
1282
1283 # cancel all watchers 2308 warn "cancel all watchers";
1284 for (Event::all_watchers) { 2309 for (Event::all_watchers) {
1285 $_->cancel if $_->data & WF_AUTOCANCEL; 2310 $_->cancel if $_->data & WF_AUTOCANCEL;
1286 } 2311 }
1287 2312
1288 # cancel all extension coros 2313 warn "cancel all extension coros";
1289 $_->cancel for values %EXT_CORO; 2314 $_->cancel for values %EXT_CORO;
1290 %EXT_CORO = (); 2315 %EXT_CORO = ();
1291 2316
2317 warn "remove commands";
2318 %COMMAND = ();
2319
2320 warn "remove ext commands";
2321 %EXTCMD = ();
2322
1292 # unload all extensions 2323 warn "unload/nuke all extensions";
1293 for (@exts) { 2324 for my $pkg (@EXTS) {
1294 warn "unloading <$_>"; 2325 warn "... unloading $pkg";
1295 unload_extension $_; 2326
2327 if (my $cb = $pkg->can ("unload")) {
2328 eval {
2329 $cb->($pkg);
2330 1
2331 } or warn "$pkg unloaded, but with errors: $@";
1296 } 2332 }
1297 2333
2334 warn "... nuking $pkg";
2335 Symbol::delete_package $pkg;
2336 }
2337
1298 # unload all modules loaded from $LIBDIR 2338 warn "unload all perl modules loaded from $LIBDIR";
1299 while (my ($k, $v) = each %INC) { 2339 while (my ($k, $v) = each %INC) {
1300 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2340 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1301 2341
1302 warn "removing <$k>"; 2342 warn "removing <$k>";
1303 delete $INC{$k}; 2343 delete $INC{$k};
1310 } 2350 }
1311 2351
1312 Symbol::delete_package $k; 2352 Symbol::delete_package $k;
1313 } 2353 }
1314 2354
1315 # sync database to disk
1316 cf::db_sync;
1317 IO::AIO::flush;
1318
1319 # get rid of safe::, as good as possible 2355 warn "get rid of safe::, as good as possible";
1320 Symbol::delete_package "safe::$_" 2356 Symbol::delete_package "safe::$_"
1321 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 2357 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1322 2358
1323 # remove register_script_function callbacks
1324 # TODO
1325
1326 # unload cf.pm "a bit" 2359 warn "unload cf.pm \"a bit\"";
1327 delete $INC{"cf.pm"}; 2360 delete $INC{"cf.pm"};
1328 2361
1329 # don't, removes xs symbols, too, 2362 # don't, removes xs symbols, too,
1330 # and global variables created in xs 2363 # and global variables created in xs
1331 #Symbol::delete_package __PACKAGE__; 2364 #Symbol::delete_package __PACKAGE__;
1332 2365
1333 # reload cf.pm
1334 warn "reloading cf.pm"; 2366 warn "reloading cf.pm";
1335 require cf; 2367 require cf;
1336 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2368 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1337 2369
1338 # load config and database again 2370 warn "load config and database again";
1339 cf::cfg_load; 2371 cf::cfg_load;
1340 cf::db_load; 2372 cf::db_load;
1341 2373
1342 # load extensions
1343 warn "load extensions"; 2374 warn "load extensions";
1344 cf::load_extensions; 2375 cf::load_extensions;
1345 2376
1346 # reattach attachments to objects 2377 warn "reattach attachments to objects/players";
1347 warn "reattach";
1348 _global_reattach; 2378 _global_reattach;
2379 warn "reattach attachments to maps";
2380 reattach $_ for values %MAP;
1349 }; 2381 };
1350 warn $@ if $@; 2382
2383 if ($@) {
2384 warn $@;
2385 warn "error while reloading, exiting.";
2386 exit 1;
2387 }
1351 2388
1352 warn "reloaded"; 2389 warn "reloaded";
1353}; 2390};
1354 2391
1355sub perl_reload() {
1356 _perl_reload;
1357}
1358
1359register "<global>", __PACKAGE__;
1360
1361register_command "perl-reload" => sub { 2392register_command "reload" => sub {
1362 my ($who, $arg) = @_; 2393 my ($who, $arg) = @_;
1363 2394
1364 if ($who->flag (FLAG_WIZ)) { 2395 if ($who->flag (FLAG_WIZ)) {
2396 $who->message ("start of reload.");
2397 reload;
1365 $who->message ("reloading..."); 2398 $who->message ("end of reload.");
1366 _perl_reload;
1367 } 2399 }
1368}; 2400};
1369 2401
1370unshift @INC, $LIBDIR; 2402unshift @INC, $LIBDIR;
1371 2403
1373 reentrant => 0, 2405 reentrant => 0,
1374 prio => 0, 2406 prio => 0,
1375 at => $NEXT_TICK || $TICK, 2407 at => $NEXT_TICK || $TICK,
1376 data => WF_AUTOCANCEL, 2408 data => WF_AUTOCANCEL,
1377 cb => sub { 2409 cb => sub {
1378 unless ($FREEZE) { 2410 $NOW = Event::time;
2411
1379 cf::server_tick; # one server iteration 2412 cf::server_tick; # one server iteration
1380 $RUNTIME += $TICK; 2413 $RUNTIME += $TICK;
1381 }
1382
1383 $NEXT_TICK += $TICK; 2414 $NEXT_TICK += $TICK;
2415
2416 $WAIT_FOR_TICK->broadcast;
2417 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
1384 2418
1385 # if we are delayed by four ticks or more, skip them all 2419 # if we are delayed by four ticks or more, skip them all
1386 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 2420 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1387 2421
1388 $TICK_WATCHER->at ($NEXT_TICK); 2422 $TICK_WATCHER->at ($NEXT_TICK);
1390 }, 2424 },
1391); 2425);
1392 2426
1393IO::AIO::max_poll_time $TICK * 0.2; 2427IO::AIO::max_poll_time $TICK * 0.2;
1394 2428
2429$AIO_POLL_WATCHER = Event->io (
1395Event->io (fd => IO::AIO::poll_fileno, 2430 fd => IO::AIO::poll_fileno,
1396 poll => 'r', 2431 poll => 'r',
1397 prio => 5, 2432 prio => 5,
1398 data => WF_AUTOCANCEL, 2433 data => WF_AUTOCANCEL,
1399 cb => \&IO::AIO::poll_cb); 2434 cb => \&IO::AIO::poll_cb,
2435);
1400 2436
1401# we must not ever block the main coroutine 2437$WRITE_RUNTIME_WATCHER = Event->timer (
1402$Coro::idle = sub { 2438 data => WF_AUTOCANCEL,
1403 #Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d# 2439 after => 0,
1404 warn "FATAL: Coro::idle was called, major BUG\n"; 2440 interval => 10,
2441 cb => sub {
1405 (Coro::unblock_sub { 2442 (Coro::unblock_sub {
1406 Event::one_event; 2443 write_runtime
2444 or warn "ERROR: unable to write runtime file: $!";
1407 })->(); 2445 })->();
1408}; 2446 },
2447);
2448
2449END { cf::emergency_save }
1409 2450
14101 24511
1411 2452

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines