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.100 by root, Mon Dec 25 11:25:49 2006 UTC vs.
Revision 1.188 by root, Sat Jan 20 23:30:16 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines