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.602 by root, Sun Nov 11 18:21:21 2012 UTC vs.
Revision 1.622 by root, Wed Nov 23 06:05:33 2016 UTC

57use JSON::XS 2.01 (); 57use JSON::XS 2.01 ();
58use BDB (); 58use BDB ();
59use Data::Dumper; 59use Data::Dumper;
60use Fcntl; 60use Fcntl;
61use YAML::XS (); 61use YAML::XS ();
62use CBOR::XS ();
62use IO::AIO (); 63use IO::AIO ();
63use Compress::LZF; 64use Compress::LZF;
64use Digest::MD5 (); 65use Digest::MD5 ();
65 66
66AnyEvent::detect; 67AnyEvent::detect;
225=item $cf::RUNTIME 226=item $cf::RUNTIME
226 227
227The time this server has run, starts at 0 and is increased by $cf::TICK on 228The time this server has run, starts at 0 and is increased by $cf::TICK on
228every server tick. 229every server tick.
229 230
230=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR 231=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
231$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR 232$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
232$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR 233$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
233 234
234Various directories - "/etc", read-only install directory, perl-library 235Various directories - "/etc", read-only install directory, perl-library
235directory, pod-directory, read-only maps directory, "/var", "/var/tmp", 236directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
464 465
465sub decode_yaml($) { 466sub decode_yaml($) {
466 fork_call { YAML::XS::Load $_[0] } @_ 467 fork_call { YAML::XS::Load $_[0] } @_
467} 468}
468 469
470=item $scalar = cf::decode_cbor $scalar
471
472Same as CBOR::XS::decode_cbor, but takes server ticks into account, so
473blocks. For small amounts of data, C<CBOR::XS::decode_cbor> is the better
474alternative.
475
476=cut
477
478sub decode_cbor($) {
479 # we assume 10mb/s minimum decoding speed (on a ~2ghz machine)
480 cf::get_slot +(length $_[0]) / 10_000_000, 0, "decode_cbor";
481 CBOR::XS::decode_cbor $_[0]
482}
483
469=item $scalar = cf::unlzf $scalar 484=item $scalar = cf::unlzf $scalar
470 485
471Same as Compress::LZF::compress, but takes server ticks into account, so 486Same as Compress::LZF::compress, but takes server ticks into account, so
472blocks. 487blocks.
473 488
510 } 525 }
511} 526}
512 527
513=item cf::lock_wait $string 528=item cf::lock_wait $string
514 529
515Wait until the given lock is available. See cf::lock_acquire. 530Wait until the given lock is available. See cf::lock_acquire.
516 531
517=item my $lock = cf::lock_acquire $string 532=item my $lock = cf::lock_acquire $string
518 533
519Wait until the given lock is available and then acquires it and returns 534Wait until the given lock is available and then acquires it and returns
520a L<Guard> object. If the guard object gets destroyed (goes out of scope, 535a L<Guard> object. If the guard object gets destroyed (goes out of scope,
573Allocate $time seconds of blocking CPU time at priority C<$priority> 588Allocate $time seconds of blocking CPU time at priority C<$priority>
574(default: 0): This call blocks and returns only when you have at least 589(default: 0): This call blocks and returns only when you have at least
575C<$time> seconds of cpu time till the next tick. The slot is only valid 590C<$time> seconds of cpu time till the next tick. The slot is only valid
576till the next cede. 591till the next cede.
577 592
578Background jobs should use a priority les than zero, interactive jobs 593Background jobs should use a priority less than zero, interactive jobs
579should use 100 or more. 594should use 100 or more.
580 595
581The optional C<$name> can be used to identify the job to run. It might be 596The optional C<$name> can be used to identify the job to run. It might be
582used for statistical purposes and should identify the same time-class. 597used for statistical purposes and should identify the same time-class.
583 598
596 my $signal = new Coro::Signal; 611 my $signal = new Coro::Signal;
597 my $busy; 612 my $busy;
598 613
599 while () { 614 while () {
600 next_job: 615 next_job:
616
617 Coro::cede;
601 618
602 my $avail = cf::till_tick; 619 my $avail = cf::till_tick;
603 620
604 for (0 .. $#SLOT_QUEUE) { 621 for (0 .. $#SLOT_QUEUE) {
605 if ($SLOT_QUEUE[$_][0] <= $avail) { 622 if ($SLOT_QUEUE[$_][0] <= $avail) {
606 $busy = 0; 623 $busy = 0;
607 my $job = splice @SLOT_QUEUE, $_, 1, (); 624 my $job = splice @SLOT_QUEUE, $_, 1, ();
608 $job->[2]->send; 625 $job->[2]->send;
609 Coro::cede;
610 goto next_job; 626 goto next_job;
611 } else { 627 } else {
612 $SLOT_QUEUE[$_][0] *= $SLOT_DECAY; 628 $SLOT_QUEUE[$_][0] *= $SLOT_DECAY;
613 } 629 }
614 } 630 }
615 631
616 if (@SLOT_QUEUE) { 632 if (@SLOT_QUEUE) {
617 # we do not use wait_for_tick() as it returns immediately when tick is inactive 633 wait_for_tick;
618 $WAIT_FOR_TICK->wait;
619 } else { 634 } else {
620 $busy = 0; 635 $busy = 0;
621 Coro::schedule; 636 Coro::schedule;
622 } 637 }
623 } 638 }
649BEGIN { *async = \&Coro::async_pool } 664BEGIN { *async = \&Coro::async_pool }
650 665
651=item cf::sync_job { BLOCK } 666=item cf::sync_job { BLOCK }
652 667
653The design of Deliantra requires that the main coroutine ($Coro::main) 668The design of Deliantra requires that the main coroutine ($Coro::main)
654is always able to handle events or runnable, as Deliantra is only 669is always able to handle events or is runnable, as Deliantra is only
655partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not 670partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
656acceptable. 671acceptable.
657 672
658If it must be done, put the blocking parts into C<sync_job>. This will run 673If it must be done, put the blocking parts into C<sync_job>. This will run
659the given BLOCK in another coroutine while waiting for the result. The 674the given BLOCK in another coroutine while waiting for the result. The
687 702
688 while ($busy) { 703 while ($busy) {
689 if (Coro::nready) { 704 if (Coro::nready) {
690 Coro::cede_notself; 705 Coro::cede_notself;
691 } else { 706 } else {
692 EV::loop EV::LOOP_ONESHOT; 707 EV::run EV::RUN_ONCE;
693 } 708 }
694 } 709 }
695 710
696 my $time = AE::time - $time; 711 my $time = AE::time - $time;
697 712
738 reset_signals; 753 reset_signals;
739} 754}
740 755
741sub fork_call(&@) { 756sub fork_call(&@) {
742 my ($cb, @args) = @_; 757 my ($cb, @args) = @_;
743
744 # we seemingly have to make a local copy of the whole thing,
745 # otherwise perl prematurely frees the stuff :/
746 # TODO: investigate and fix (likely this will be rather laborious)
747 758
748 my @res = Coro::Util::fork_eval { 759 my @res = Coro::Util::fork_eval {
749 cf::post_fork; 760 cf::post_fork;
750 &$cb 761 &$cb
751 } @args; 762 } @args;
2388 2399
2389 $MAP_PREFETCHER ||= cf::async { 2400 $MAP_PREFETCHER ||= cf::async {
2390 $Coro::current->{desc} = "map prefetcher"; 2401 $Coro::current->{desc} = "map prefetcher";
2391 2402
2392 while (%MAP_PREFETCH) { 2403 while (%MAP_PREFETCH) {
2393 while (my ($k, $v) = each %MAP_PREFETCH) { 2404 for my $k (keys %MAP_PREFETCH) {
2394 if (my $map = find $k) { 2405 if (my $map = find $k) {
2395 $map->load if $v; 2406 $map->load if $MAP_PREFETCH{$k};
2396 } 2407 }
2397 2408
2398 delete $MAP_PREFETCH{$k}; 2409 delete $MAP_PREFETCH{$k};
2399 } 2410 }
2400 } 2411 }
2746=item $player_object->may ("access") 2757=item $player_object->may ("access")
2747 2758
2748Returns wether the given player is authorized to access resource "access" 2759Returns wether the given player is authorized to access resource "access"
2749(e.g. "command_wizcast"). 2760(e.g. "command_wizcast").
2750 2761
2762This is implemented by checking a config setting of C<may_access> where
2763C<access> is replaced by the access string. The following alternatives are
2764possible (and are tested in order):
2765
2766=over 4
2767
2768=item * Player is DM
2769
2770The request will succeed.
2771
2772=item * may_access is an array reference
2773
2774If either the player nickname or UUID is in the array, the request will
2775succeed, otherwise it will fail.
2776
2777=item * may_access is a true value
2778
2779The request will succeed.
2780
2781=item * may_access is missing or false
2782
2783The request will fail.
2784
2785=back
2786
2751=cut 2787=cut
2752 2788
2753sub cf::object::player::may { 2789sub cf::object::player::may {
2754 my ($self, $access) = @_; 2790 my ($self, $access) = @_;
2755 2791
2756 $self->flag (cf::FLAG_WIZ) || 2792 $self->flag (cf::FLAG_WIZ) ||
2757 (ref $cf::CFG{"may_$access"} 2793 (ref $cf::CFG{"may_$access"}
2758 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 2794 ? scalar grep $self->name eq $_ || $self->uuid eq $_, @{$cf::CFG{"may_$access"}}
2759 : $cf::CFG{"may_$access"}) 2795 : $cf::CFG{"may_$access"})
2760} 2796}
2761 2797
2762=item $player_object->enter_link 2798=item $player_object->enter_link
2763 2799
2766The player should be reasonably safe there for short amounts of time (e.g. 2802The player should be reasonably safe there for short amounts of time (e.g.
2767for loading a map). You I<MUST> call C<leave_link> as soon as possible, 2803for loading a map). You I<MUST> call C<leave_link> as soon as possible,
2768though, as the player cannot control the character while it is on the link 2804though, as the player cannot control the character while it is on the link
2769map. 2805map.
2770 2806
2771Will never block. 2807This method will never block, which is the whole reaosn for it's
2808existance: you can I<always> put a player onto the link map, which is the
2809only place to put objects that is guaranteed to exist.
2810
2811A typical usage pattern is to call C<enter_link> synchronously from the
2812server, then start a new thread, do your blocking stuff there and then
2813call C<leave_link> from that thread.
2772 2814
2773=item $player_object->leave_link ($map, $x, $y) 2815=item $player_object->leave_link ($map, $x, $y)
2774 2816
2775Moves the player out of the special C<{link}> map onto the specified 2817Moves the player out of the special C<{link}> map onto the specified
2776map. If the map is not valid (or omitted), the player will be moved back 2818map. If the map is not valid (or omitted), the player will be moved back
3046 3088
3047=head3 cf::client 3089=head3 cf::client
3048 3090
3049=over 4 3091=over 4
3050 3092
3051=item $client->send_drawinfo ($text, $flags)
3052
3053Sends a drawinfo packet to the client. Circumvents output buffering so
3054should not be used under normal circumstances.
3055
3056=cut
3057
3058sub cf::client::send_drawinfo {
3059 my ($self, $text, $flags) = @_;
3060
3061 utf8::encode $text;
3062 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
3063}
3064
3065=item $client->send_big_packet ($pkt) 3093=item $client->send_big_packet ($pkt)
3066 3094
3067Like C<send_packet>, but tries to compress large packets, and fragments 3095Like C<send_packet>, but tries to compress large packets, and fragments
3068them as required. 3096them as required.
3069 3097
3087 $self->send_packet ($pkt); 3115 $self->send_packet ($pkt);
3088} 3116}
3089 3117
3090=item $client->send_msg ($channel, $msg, $color, [extra...]) 3118=item $client->send_msg ($channel, $msg, $color, [extra...])
3091 3119
3092Send a drawinfo or msg packet to the client, formatting the msg for the 3120Send a msg packet to the client, formatting the msg for the client if
3093client if neccessary. C<$type> should be a string identifying the type of 3121necessary. C<$type> should be a string identifying the type of the
3094the message, with C<log> being the default. If C<$color> is negative, suppress 3122message, with C<log> being the default. If C<$color> is negative, suppress
3095the message unless the client supports the msg packet. 3123the message unless the client supports the msg packet.
3096 3124
3097=cut 3125=cut
3098 3126
3099# non-persistent channels (usually the info channel) 3127# non-persistent channels (usually the info channel)
3204 id => "death", 3232 id => "death",
3205 title => "Death", 3233 title => "Death",
3206 reply => undef, 3234 reply => undef,
3207 tooltip => "Reason for and more info about your most recent death", 3235 tooltip => "Reason for and more info about your most recent death",
3208 }, 3236 },
3237 "c/fatal" => {
3238 id => "fatal",
3239 title => "Fatal Error",
3240 reply => undef,
3241 tooltip => "Reason for the server disconnect",
3242 },
3209 "c/say" => $SAY_CHANNEL, 3243 "c/say" => $SAY_CHANNEL,
3210 "c/chat" => $CHAT_CHANNEL, 3244 "c/chat" => $CHAT_CHANNEL,
3211); 3245);
3212 3246
3213sub cf::client::send_msg { 3247sub cf::client::send_msg {
3286 3320
3287 $self->send_packet ($self->{query_queue}[0][0]) 3321 $self->send_packet ($self->{query_queue}[0][0])
3288 if @{ $self->{query_queue} } == 1; 3322 if @{ $self->{query_queue} } == 1;
3289 3323
3290 1 3324 1
3325}
3326
3327=item $client->update_command_faces
3328
3329=cut
3330
3331our %COMMAND_FACE;
3332
3333sub cf::client::update_command_faces {
3334 my ($self) = @_;
3335
3336 my @faces = grep $_,
3337 $COMMAND_FACE{preferred},
3338 $COMMAND_FACE{standard},
3339 $COMMAND_FACE{skill},
3340 $self->pl->ob->flag (cf::FLAG_WIZ) ? $COMMAND_FACE{dm} : (),
3341 $COMMAND_FACE{emote},
3342 ;
3343
3344 $self->send_face ($_)
3345 for @faces;
3346 $self->flush_fx;
3347
3348 $self->ext_msg (command_list => @faces);
3349}
3350
3351=item cf::client::set_command_face $type, $commands
3352
3353=cut
3354
3355sub cf::client::set_command_face {
3356 my ($type, $list) = @_;
3357
3358 my $idx = &cf::face::set ( #d# ugly forward reference
3359 "command_list/$type" => cf::FT_RSRC,
3360 JSON::XS->new->utf8->encode ([ sort @$list ])
3361 );
3362
3363 $COMMAND_FACE{$type} = $idx;
3291} 3364}
3292 3365
3293cf::client->attach ( 3366cf::client->attach (
3294 on_connect => sub { 3367 on_connect => sub {
3295 my ($ns) = @_; 3368 my ($ns) = @_;
3536 my ($name, $type, $data) = @_; 3609 my ($name, $type, $data) = @_;
3537 3610
3538 my $idx = cf::face::find $name; 3611 my $idx = cf::face::find $name;
3539 3612
3540 if ($idx) { 3613 if ($idx) {
3541 delete $HASH{cf::face::get_chksum $idx}; 3614 delete $HASH{cf::face::get_csum $idx};
3542 } else { 3615 } else {
3543 $idx = cf::face::alloc $name; 3616 $idx = cf::face::alloc $name;
3544 } 3617 }
3545 3618
3546 my $hash = cf::face::mangle_csum Digest::MD5::md5 $data; 3619 my $hash = cf::face::mangle_csum Digest::MD5::md5 $data;
3761 cf::face::set 3834 cf::face::set
3762 "res/spell_paths" => FT_RSRC, 3835 "res/spell_paths" => FT_RSRC,
3763 JSON::XS->new->utf8->canonical->encode ( 3836 JSON::XS->new->utf8->canonical->encode (
3764 [map [cf::spellpathnames ($_)], 0 .. NRSPELLPATHS - 1] 3837 [map [cf::spellpathnames ($_)], 0 .. NRSPELLPATHS - 1]
3765 ); 3838 );
3839
3840 # command completion
3841 my @commands;
3842
3843 for (0..cf::arch::skillvec_size - 1) {
3844 my $skill = cf::arch::skillvec $_;
3845 my $name = $skill->name;
3846 my $flags = cf::skill_flags $skill->subtype;
3847
3848 push @commands, "ready_skill $name" if $flags & (SF_COMBAT | SF_RANGED | SF_GRACE);
3849 push @commands, "use_skill $name" if $flags & (SF_USE | SF_AUTARK | SF_GRACE);
3850 }
3851
3852 cf::client::set_command_face skill => \@commands;
3766} 3853}
3767 3854
3768sub reload_treasures { 3855sub reload_treasures {
3769 load_resource_file "$DATADIR/treasures" 3856 load_resource_file "$DATADIR/treasures"
3770 or die "unable to load treasurelists\n"; 3857 or die "unable to load treasurelists\n";
3843 seek $fh, 0, 0; 3930 seek $fh, 0, 0;
3844 print $fh $$; 3931 print $fh $$;
3845} 3932}
3846 3933
3847sub main_loop { 3934sub main_loop {
3848 trace "EV::loop starting\n"; 3935 trace "EV::run starting\n";
3849 if (1) { 3936 if (1) {
3850 EV::loop; 3937 EV::run;
3851 } 3938 }
3852 trace "EV::loop returned\n"; 3939 trace "EV::run returned\n";
3853 goto &main_loop unless $REALLY_UNLOOP; 3940 goto &main_loop unless $REALLY_UNLOOP;
3854} 3941}
3855 3942
3856sub main { 3943sub main {
3857 cf::init_globals; # initialise logging 3944 cf::init_globals; # initialise logging
3866 # we must not ever block the main coroutine 3953 # we must not ever block the main coroutine
3867 $Coro::idle = sub { 3954 $Coro::idle = sub {
3868 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3955 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
3869 (async { 3956 (async {
3870 $Coro::current->{desc} = "IDLE BUG HANDLER"; 3957 $Coro::current->{desc} = "IDLE BUG HANDLER";
3871 EV::loop EV::LOOP_ONESHOT; 3958 EV::run EV::RUN_ONCE;
3872 })->prio (Coro::PRIO_MAX); 3959 })->prio (Coro::PRIO_MAX);
3873 }; 3960 };
3874 3961
3875 evthread_start IO::AIO::poll_fileno; 3962 evthread_start IO::AIO::poll_fileno;
3876 3963

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines