perl / Git / Packet.pmon commit Merge branch 'rd/bisect-view-is-visualize' (69bfdc6)
   1package Git::Packet;
   2use 5.008;
   3use strict;
   4use warnings;
   5BEGIN {
   6        require Exporter;
   7        if ($] < 5.008003) {
   8                *import = \&Exporter::import;
   9        } else {
  10                # Exporter 5.57 which supports this invocation was
  11                # released with perl 5.8.3
  12                Exporter->import('import');
  13        }
  14}
  15
  16our @EXPORT = qw(
  17                        packet_compare_lists
  18                        packet_bin_read
  19                        packet_txt_read
  20                        packet_required_key_val_read
  21                        packet_bin_write
  22                        packet_txt_write
  23                        packet_flush
  24                        packet_initialize
  25                        packet_read_capabilities
  26                        packet_read_and_check_capabilities
  27                        packet_check_and_write_capabilities
  28                );
  29our @EXPORT_OK = @EXPORT;
  30
  31sub packet_compare_lists {
  32        my ($expect, @result) = @_;
  33        my $ix;
  34        if (scalar @$expect != scalar @result) {
  35                return undef;
  36        }
  37        for ($ix = 0; $ix < $#result; $ix++) {
  38                if ($expect->[$ix] ne $result[$ix]) {
  39                        return undef;
  40                }
  41        }
  42        return 1;
  43}
  44
  45sub packet_bin_read {
  46        my $buffer;
  47        my $bytes_read = read STDIN, $buffer, 4;
  48        if ( $bytes_read == 0 ) {
  49                # EOF - Git stopped talking to us!
  50                return ( -1, "" );
  51        } elsif ( $bytes_read != 4 ) {
  52                die "invalid packet: '$buffer'";
  53        }
  54        my $pkt_size = hex($buffer);
  55        if ( $pkt_size == 0 ) {
  56                return ( 1, "" );
  57        } elsif ( $pkt_size > 4 ) {
  58                my $content_size = $pkt_size - 4;
  59                $bytes_read = read STDIN, $buffer, $content_size;
  60                if ( $bytes_read != $content_size ) {
  61                        die "invalid packet ($content_size bytes expected; $bytes_read bytes read)";
  62                }
  63                return ( 0, $buffer );
  64        } else {
  65                die "invalid packet size: $pkt_size";
  66        }
  67}
  68
  69sub remove_final_lf_or_die {
  70        my $buf = shift;
  71        unless ( $buf =~ s/\n$// ) {
  72                die "A non-binary line MUST be terminated by an LF.\n"
  73                    . "Received: '$buf'";
  74        }
  75        return $buf;
  76}
  77
  78sub packet_txt_read {
  79        my ( $res, $buf ) = packet_bin_read();
  80        unless ( $res == -1 or $buf eq '' ) {
  81                $buf = remove_final_lf_or_die($buf);
  82        }
  83        return ( $res, $buf );
  84}
  85
  86sub packet_required_key_val_read {
  87        my ( $key ) = @_;
  88        my ( $res, $buf ) = packet_txt_read();
  89        unless ( $res == -1 or ( $buf =~ s/^$key=// and $buf ne '' ) ) {
  90                die "bad $key: '$buf'";
  91        }
  92        return ( $res, $buf );
  93}
  94
  95sub packet_bin_write {
  96        my $buf = shift;
  97        print STDOUT sprintf( "%04x", length($buf) + 4 );
  98        print STDOUT $buf;
  99        STDOUT->flush();
 100}
 101
 102sub packet_txt_write {
 103        packet_bin_write( $_[0] . "\n" );
 104}
 105
 106sub packet_flush {
 107        print STDOUT sprintf( "%04x", 0 );
 108        STDOUT->flush();
 109}
 110
 111sub packet_initialize {
 112        my ($name, $version) = @_;
 113
 114        packet_compare_lists([0, $name . "-client"], packet_txt_read()) ||
 115                die "bad initialize";
 116        packet_compare_lists([0, "version=" . $version], packet_txt_read()) ||
 117                die "bad version";
 118        packet_compare_lists([1, ""], packet_bin_read()) ||
 119                die "bad version end";
 120
 121        packet_txt_write( $name . "-server" );
 122        packet_txt_write( "version=" . $version );
 123        packet_flush();
 124}
 125
 126sub packet_read_capabilities {
 127        my @cap;
 128        while (1) {
 129                my ( $res, $buf ) = packet_bin_read();
 130                if ( $res == -1 ) {
 131                        die "unexpected EOF when reading capabilities";
 132                }
 133                return ( $res, @cap ) if ( $res != 0 );
 134                $buf = remove_final_lf_or_die($buf);
 135                unless ( $buf =~ s/capability=// ) {
 136                        die "bad capability buf: '$buf'";
 137                }
 138                push @cap, $buf;
 139        }
 140}
 141
 142# Read remote capabilities and check them against capabilities we require
 143sub packet_read_and_check_capabilities {
 144        my @required_caps = @_;
 145        my ($res, @remote_caps) = packet_read_capabilities();
 146        my %remote_caps = map { $_ => 1 } @remote_caps;
 147        foreach (@required_caps) {
 148                unless (exists($remote_caps{$_})) {
 149                        die "required '$_' capability not available from remote" ;
 150                }
 151        }
 152        return %remote_caps;
 153}
 154
 155# Check our capabilities we want to advertise against the remote ones
 156# and then advertise our capabilities
 157sub packet_check_and_write_capabilities {
 158        my ($remote_caps, @our_caps) = @_;
 159        foreach (@our_caps) {
 160                unless (exists($remote_caps->{$_})) {
 161                        die "our capability '$_' is not available from remote"
 162                }
 163                packet_txt_write( "capability=" . $_ );
 164        }
 165        packet_flush();
 166}
 167
 1681;