lib/Gitalist/Git/Project.pm

   1 use MooseX::Declare;
   2
   3 =head1 NAME
   4
   5 Gitalist::Git::Project - Model of a git repository
   6
   7 =head1 SYNOPSIS
   8
   9     my $gitrepo = dir('/repo/base/Gitalist');
  10     my $project = Gitalist::Git::Project->new($gitrepo);
  11      $project->name;        # 'Gitalist'
  12      $project->path;        # '/repo/base/Gitalist/.git'
  13      $project->description; # 'Unnamed repository.'
  14
  15 =head1 DESCRIPTION
  16
  17 This class models a git repository, referred to in Gitalist
  18 as a "Project".
  19
  20 =cut
  21
  22 class Gitalist::Git::Project with Gitalist::Git::HasUtils {
  23     # FIXME, use Types::Path::Class and coerce
  24     use MooseX::Types::Common::String qw/NonEmptySimpleStr/;
  25     use MooseX::Types::Path::Class qw/Dir/;
  26     use MooseX::Types::Moose qw/Str Maybe Bool HashRef ArrayRef/;
  27     use List::MoreUtils qw/any zip/;
  28     use DateTime;
  29     use aliased 'Gitalist::Git::Object';
  30
  31     our $SHA1RE = qr/[0-9a-fA-F]{40}/;
  32
  33     around BUILDARGS (ClassName $class: Dir $dir) {
  34         # Allows us to be called as Project->new($dir)
  35         # Last path component becomes $self->name
  36         # Full path to git objects becomes $self->path
  37         my $name = $dir->dir_list(-1);
  38         $dir = $dir->subdir('.git') if (-f $dir->file('.git', 'HEAD'));
  39         confess("Can't find a git repository at " . $dir)
  40             unless ( -f $dir->file('HEAD') );
  41         return $class->$orig(name => $name,
  42                              path => $dir);
  43     }
  44
  45 =head1 ATTRIBUTES
  46
  47 =head2 name
  48
  49 The name of the Project.  By default, this is derived from the path to the git repository.
  50
  51 =cut
  52     has name => ( isa => NonEmptySimpleStr,
  53                   is => 'ro', required => 1 );
  54
  55 =head2 path
  56
  57 L<Path::Class:Dir> for the location of the git repository.
  58
  59 =cut
  60     has path => ( isa => Dir,
  61                   is => 'ro', required => 1);
  62
  63 =head2 description
  64
  65 String containing .git/description
  66
  67 =cut
  68     has description => ( isa => Str,
  69                          is => 'ro',
  70                          lazy_build => 1,
  71                      );
  72
  73 =head2 owner
  74
  75 Owner of the files on disk.
  76
  77 =cut
  78     has owner => ( isa => NonEmptySimpleStr,
  79                    is => 'ro',
  80                    lazy_build => 1,
  81                );
  82
  83 =head2 last_change
  84
  85 L<DateTime> for the time of the last update.
  86 undef if the repository has never been used.
  87
  88 =cut
  89     has last_change => ( isa => Maybe['DateTime'],
  90                          is => 'ro',
  91                          lazy_build => 1,
  92                      );
  93
  94 =head2 is_bare
  95
  96 Bool indicating whether this Project is bare.
  97
  98 =cut
  99     has is_bare => ( isa => Bool,
 100                      is => 'ro',
 101                      lazy => 1,
 102                      default => sub {
 103                          -d $_[0]->path->parent->subdir->($_[0]->name)
 104                              ? 1 : 0
 105                          },
 106                      );
 107
 108 =head2 heads
 109
 110 ArrayRef of hashes containing the name and sha1 of all heads.
 111
 112 =cut
 113     has heads => ( isa => ArrayRef[HashRef],
 114                    is => 'ro',
 115                    lazy_build => 1);
 116
 117 =head2 references
 118
 119 Hashref of ArrayRefs for each reference.
 120
 121 =cut
 122     has references => ( isa => HashRef[ArrayRef[Str]],
 123                         is => 'ro',
 124                         lazy_build => 1 );
 125
 126     method BUILD {
 127         $self->$_() for qw/last_change owner description/; # Ensure to build early.
 128     }
 129
 130 =head1 METHODS
 131
 132 =head2 head_hash ($head?)
 133
 134 Return the sha1 for HEAD, or any specified head.
 135
 136 =cut
 137     method head_hash (Str $head?) {
 138         my $output = $self->run_cmd(qw/rev-parse --verify/, $head || 'HEAD' );
 139         confess("No such head: " . $head) unless defined $output;
 140
 141         my($sha1) = $output =~ /^($SHA1RE)$/;
 142         return $sha1;
 143     }
 144
 145 =head2 list_tree ($sha1?)
 146
 147 Return an array of contents for a given tree.
 148 The tree is specified by sha1, and defaults to HEAD.
 149 Each item is a L<Gitalist::Git::Object>.
 150
 151 =cut
 152     method list_tree (Str $sha1?) {
 153         $sha1 ||= $self->head_hash;
 154
 155         my $output = $self->run_cmd(qw/ls-tree -z/, $sha1);
 156         return unless defined $output;
 157
 158         my @ret;
 159         for my $line (split /\0/, $output) {
 160             my ($mode, $type, $object, $file) = split /\s+/, $line, 4;
 161             push @ret, Object->new( mode => oct $mode,
 162                                     type => $type,
 163                                     sha1 => $object,
 164                                     file => $file,
 165                                     project => $self,
 166                                   );
 167         }
 168         return @ret;
 169     }
 170
 171 =head2 get_object ($sha1)
 172
 173 Return a L<Gitalist::Git::Object> for the given sha1.
 174
 175 =cut
 176     method get_object (NonEmptySimpleStr $sha1) {
 177         unless ( $self->_is_valid_rev($sha1) ) {
 178             $sha1 = $self->head_hash($sha1);
 179         }
 180         return Object->new(
 181             project => $self,
 182             sha1 => $sha1,
 183         );
 184     }
 185
 186 =head2 hash_by_path($sha1, $path, $type?)
 187
 188 Returns the sha1 for a given path, optionally limited by type.
 189
 190 =cut
 191     method hash_by_path ($base, $path = '', $type?) {
 192         $path =~ s{/+$}();
 193         # FIXME should this really just take the first result?
 194         my @paths = $self->run_cmd('ls-tree', $base, '--', $path)
 195             or return;
 196         my $line = $paths[0];
 197
 198         #'100644 blob 0fa3f3a66fb6a137f6ec2c19351ed4d807070ffa  panic.c'
 199         $line =~ m/^([0-9]+) (.+) ($SHA1RE)\t/;
 200         return defined $type && $type ne $2
 201             ? ()
 202                 : $3;
 203     }
 204
 205 =head2 list_revs($sha1, $count?, $skip?, \%search?, $file?)
 206
 207 Returns a list of revs for the given head ($sha1).
 208
 209 =cut
 210     method list_revs ( NonEmptySimpleStr :$sha1!,
 211                        Int :$count?,
 212                        Int :$skip?,
 213                        HashRef :$search?,
 214                        NonEmptySimpleStr :$file?
 215                    ) {
 216         $sha1 = $self->head_hash($sha1)
 217             if !$sha1 || $sha1 !~ $SHA1RE;
 218
 219         my @search_opts;
 220         if($search) {
 221             $search->{type} = 'grep'
 222                 if $search->{type} eq 'commit';
 223             @search_opts = (
 224                 # This seems a little fragile ...
 225                 qq[--$search->{type}=$search->{text}],
 226                 '--regexp-ignore-case',
 227                 $search->{regexp} ? '--extended-regexp' : '--fixed-strings'
 228             );
 229         }
 230
 231         my $output = $self->run_cmd(
 232             'rev-list',
 233             '--header',
 234             (defined $count ? "--max-count=$count" : ()),
 235             (defined $skip ? "--skip=$skip"       : ()),
 236             @search_opts,
 237             $sha1,
 238             '--',
 239             ($file ? $file : ()),
 240         );
 241         return unless $output;
 242
 243         my @revs = $self->_parse_rev_list($output);
 244
 245         return @revs;
 246     }
 247
 248 =head2 diff($commit, $patch?, $parent?, $file?)
 249
 250 Generate a diff.
 251
 252 FIXME this should be a method on the commit object.
 253
 254 =cut
 255
 256     # XXX Ideally this would return a wee object instead of ad hoc structures.
 257     method diff ( Gitalist::Git::Object :$commit!,
 258                   Bool :$patch?,
 259                   Maybe[NonEmptySimpleStr] :$parent?,
 260                   NonEmptySimpleStr :$file? ) {
 261         # Use parent if specifed, else take the parent from the commit
 262         # if there is only one, otherwise it was a merge commit.
 263         $parent = $parent
 264             ? $parent
 265             : $commit->parents <= 1
 266             ? $commit->parent_sha1
 267             : '-c';
 268         my @etc = (
 269             ( $file  ? ('--', $file) : () ),
 270         );
 271
 272         my @out = $self->_raw_diff(
 273             ( $patch ? '--patch-with-raw' : () ),
 274             ( $parent ? $parent : () ),
 275             $commit->sha1, @etc,
 276         );
 277
 278         # XXX Yes, there is much wrongness having _parse_diff_tree be destructive.
 279         my @difftree = $self->_parse_diff_tree(\@out);
 280
 281         return \@difftree
 282             unless $patch;
 283
 284         # The blank line between the tree and the patch.
 285         shift @out;
 286
 287         # XXX And no I'm not happy about having diff return tree + patch.
 288         return \@difftree, [$self->_parse_diff(@out)];
 289     }
 290
 291 =head2 reflog(@lorgargs)
 292
 293 Return a list of hashes representing each reflog entry.
 294
 295 FIXME Should this return objects?
 296
 297 =cut
 298     method reflog (@logargs) {
 299         my @entries
 300             =  $self->run_cmd(qw(log -g), @logargs)
 301                 =~ /(^commit.+?(?:(?=^commit)|(?=\z)))/msg;
 302
 303 #  commit 02526fc15beddf2c64798a947fecdd8d11bf993d
 304 #  Reflog: HEAD@{14} (The Git Server <git@git.dev.venda.com>)
 305 #  Reflog message: push
 306 #  Author: Foo Barsby <fbarsby@example.com>
 307 #  Date:   Thu Sep 17 12:26:05 2009 +0100
 308 #
 309 #      Merge branch 'abc123'
 310
 311         return map {
 312             # XXX Stuff like this makes me want to switch to Git::PurePerl
 313             my($sha1, $type, $author, $date)
 314                 = m{
 315                        ^ commit \s+ ($SHA1RE)$
 316                        .*?
 317                        Reflog[ ]message: \s+ (.+?)$ \s+
 318                      Author: \s+ ([^<]+) <.*?$ \s+
 319                    Date: \s+ (.+?)$
 320                }xms;
 321
 322             pos($_) = index($_, $date) + length $date;
 323
 324             # Yeah, I just did that.
 325             my($msg) = /\G\s+(\S.*)/sg;
 326             {
 327                 hash    => $sha1,
 328                 type    => $type,
 329                 author  => $author,
 330
 331                 # XXX Add DateTime goodness.
 332                 date    => $date,
 333                 message => $msg,
 334             }
 335             ;
 336         } @entries;
 337     }
 338
 339     ## BUILDERS
 340     method _build__util {
 341         Gitalist::Git::Util->new(
 342             project => $self,
 343         );
 344     }
 345
 346     method _build_description {
 347         return $self->gpp->description;
 348     }
 349
 350     method _build_owner {
 351         my ($gecos, $name) = (getpwuid $self->path->stat->uid)[6,0];
 352         $gecos =~ s/,+$//;
 353         return length($gecos) ? $gecos : $name;
 354     }
 355
 356     method _build_last_change {
 357         my $last_change;
 358         my $output = $self->run_cmd(
 359             qw{ for-each-ref --format=%(committer)
 360                 --sort=-committerdate --count=1 refs/heads
 361           });
 362         if (my ($epoch, $tz) = $output =~ /\s(\d+)\s+([+-]\d+)$/) {
 363             my $dt = DateTime->from_epoch(epoch => $epoch);
 364             $dt->set_time_zone($tz);
 365             $last_change = $dt;
 366         }
 367         return $last_change;
 368     }
 369
 370     method _build_heads {
 371         my @revlines = $self->run_cmd_list(qw/for-each-ref --sort=-committerdate /, '--format=%(objectname)%00%(refname)%00%(committer)', 'refs/heads');
 372         my @ret;
 373         for my $line (@revlines) {
 374             my ($rev, $head, $commiter) = split /\0/, $line, 3;
 375             $head =~ s!^refs/heads/!!;
 376
 377             push @ret, { sha1 => $rev, name => $head };
 378
 379             #FIXME: That isn't the time I'm looking for..
 380             if (my ($epoch, $tz) = $line =~ /\s(\d+)\s+([+-]\d+)$/) {
 381                 my $dt = DateTime->from_epoch(epoch => $epoch);
 382                 $dt->set_time_zone($tz);
 383                 $ret[-1]->{last_change} = $dt;
 384             }
 385         }
 386
 387         return \@ret;
 388     }
 389
 390     method _build_references {
 391         # 5dc01c595e6c6ec9ccda4f6f69c131c0dd945f8c refs/tags/v2.6.11
 392         # c39ae07f393806ccf406ef966e9a15afc43cc36a refs/tags/v2.6.11^{}
 393         my @reflist = $self->run_cmd_list(qw(show-ref --dereference))
 394                 or return;
 395         my %refs;
 396             for(@reflist) {
 397                     push @{$refs{$1}}, $2
 398                             if m!^($SHA1RE)\srefs/(.*)$!;
 399             }
 400
 401             return \%refs;
 402     }
 403
 404     ## Private methods
 405     method _is_valid_rev (Str $rev) {
 406         return ($rev =~ /^($SHA1RE)$/);
 407     }
 408
 409     method _parse_rev_list ($output) {
 410         return
 411             map  $self->get_gpp_object($_),
 412                 grep $self->_is_valid_rev($_),
 413                     map  split(/\n/, $_, 6), split /\0/, $output;
 414     }
 415
 416     method _parse_diff_tree ($diff) {
 417         my @keys = qw(modesrc modedst sha1src sha1dst status src dst);
 418         my @ret;
 419         while (@$diff and $diff->[0] =~ /^:\d+/) {
 420             my $line = shift @$diff;
 421             # see. man git-diff-tree for more info
 422             # mode src, mode dst, sha1 src, sha1 dst, status, src[, dst]
 423             my @vals = $line =~ /^:(\d+) (\d+) ($SHA1RE) ($SHA1RE) ([ACDMRTUX]\d*)\t([^\t]+)(?:\t([^\n]+))?$/;
 424             my %line = zip @keys, @vals;
 425             # Some convenience keys
 426             $line{file}   = $line{src};
 427             $line{sha1}   = $line{sha1dst};
 428             $line{is_new} = $line{sha1src} =~ /^0+$/
 429                 if $line{sha1src};
 430             @line{qw/status sim/} = $line{status} =~ /(R)(\d+)/
 431                 if $line{status} =~ /^R/;
 432             push @ret, \%line;
 433         }
 434
 435         return @ret;
 436     }
 437     method _parse_diff (@diff) {
 438         my @ret;
 439         for (@diff) {
 440             # This regex is a little pathological.
 441             if(m{^diff --git (a/(.*?)) (b/\2)}) {
 442                 push @ret, {
 443                     head => $_,
 444                     a    => $1,
 445                     b    => $3,
 446                     file => $2,
 447                     diff => '',
 448                 };
 449                 next;
 450             }
 451
 452             if(/^index (\w+)\.\.(\w+) (\d+)$/) {
 453                 @{$ret[-1]}{qw(index src dst mode)} = ($_, $1, $2, $3);
 454                 next
 455             }
 456
 457             # XXX Somewhat hacky. Ahem.
 458             $ret[@ret ? -1 : 0]{diff} .= "$_\n";
 459         }
 460
 461         return @ret;
 462     }
 463
 464     # gitweb uses the following sort of command for diffing merges:
 465 # /home/dbrook/apps/bin/git --git-dir=/home/dbrook/dev/app/.git diff-tree -r -M --no-commit-id --patch-with-raw --full-index --cc 316cf158df3f6207afbae7270bcc5ba0 --
 466 # and for regular diffs
 467 # /home/dbrook/apps/bin/git --git-dir=/home/dbrook/dev/app/.git diff-tree -r -M --no-commit-id --patch-with-raw --full-index 2e3454ca0749641b42f063730b0090e1 316cf158df3f6207afbae7270bcc5ba0 --
 468     method _raw_diff (@args) {
 469         return $self->run_cmd_list(
 470             qw(diff-tree -r -M --no-commit-id --full-index),
 471             @args
 472         );
 473     }
 474
 475 =head1 SEE ALSO
 476
 477 L<Gitalist::Git::Util> L<Gitalist::Git::Object>
 478
 479 =head1 AUTHORS AND COPYRIGHT
 480
 481   Catalyst application:
 482     (C) 2009 Venda Ltd and Dan Brook <dbrook@venda.com>
 483
 484   Original gitweb.cgi from which this was derived:
 485     (C) 2005-2006, Kay Sievers <kay.sievers@vrfy.org>
 486     (C) 2005, Christian Gierke
 487
 488 =head1 LICENSE
 489
 490 FIXME - Is this going to be GPLv2 as per gitweb? If so this is broken..
 491
 492 This library is free software. You can redistribute it and/or modify
 493 it under the same terms as Perl itself.
 494
 495 =cut
 496
 497 } # end class