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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines