[catagits/Gitalist.git] / lib / Gitalist / Git / Project.pm

use MooseX::Declare;

class Gitalist::Git::Project {
    # FIXME, use Types::Path::Class and coerce
    use MooseX::Types::Common::String qw/NonEmptySimpleStr/;
    use MooseX::Types::Moose qw/Str Maybe Bool HashRef/;
    use DateTime;
    use MooseX::Types::Path::Class qw/Dir/;
    use Gitalist::Git::Util;
    use aliased 'Gitalist::Git::Object';

    our $SHA1RE = qr/[0-9a-fA-F]{40}/;

    has name => ( isa => NonEmptySimpleStr,
                  is => 'ro', required => 1 );
    has path => ( isa => Dir,
                  is => 'ro', required => 1);

    has description => ( isa => Str,
                         is => 'ro',
                         lazy_build => 1,
                     );
    has owner => ( isa => NonEmptySimpleStr,
                   is => 'ro',
                   lazy_build => 1,
               );
    has last_change => ( isa => Maybe['DateTime'],
                         is => 'ro',
                         lazy_build => 1,
                     );
    has _util => ( isa => 'Gitalist::Git::Util',
                   is => 'ro',
                   lazy_build => 1,
                   handles => [ 'run_cmd', 'get_gpp_object' ],
               );

    has project_dir => ( isa => Dir,
        is => 'ro',
        lazy => 1,
        default => sub {
            my $self = shift;
            $self->is_bare
                ? $self->path
                : $self->path->subdir('.git')
        },
    );
    has is_bare => (
        isa => Bool,
        is => 'ro',
        lazy => 1,
        default => sub {
            my $self = shift;
            -f $self->path->file('.git', 'HEAD')
                ? 0
                : -f $self->path->file('HEAD')
                    ? 1
                    : confess("Cannot find " . $self->path . "/.git/HEAD or "
                        . $self->path . "/HEAD");
        },
    );

    method BUILD {
        $self->$_() for qw/_util last_change owner description/; # Ensure to build early.
    }

    method _project_dir {
        -f $self->{path}->file('.git', 'HEAD')
            ? $self->{path}->subdir('.git')
            : $self->{path};
    }

    method _build__util {
        Gitalist::Git::Util->new(
            project => $self,
        );
    }

    method _build_description {
        my $description = "";
        eval {
            $description = $self->project_dir->file('description')->slurp;
            chomp $description;
        };
        return $description;
    }

    method _build_owner {
        my ($gecos, $name) = (getpwuid $self->project_dir->stat->uid)[6,0];
        $gecos =~ s/,+$//;
        return length($gecos) ? $gecos : $name;
    }

    method _build_last_change {
        my $last_change;
        my $output = $self->run_cmd(
            qw{ for-each-ref --format=%(committer)
                --sort=-committerdate --count=1 refs/heads
          });
        if (my ($epoch, $tz) = $output =~ /\s(\d+)\s+([+-]\d+)$/) {
            my $dt = DateTime->from_epoch(epoch => $epoch);
            $dt->set_time_zone($tz);
            $last_change = $dt;
        }
        return $last_change;
    }

    method heads {
        my $cmdout = $self->run_cmd(qw/for-each-ref --sort=-committerdate /, '--format=%(objectname)%00%(refname)%00%(committer)', 'refs/heads');
        my @output = $cmdout ? split(/\n/, $cmdout) : ();
        my @ret;
        for my $line (@output) {
            my ($rev, $head, $commiter) = split /\0/, $line, 3;
            $head =~ s!^refs/heads/!!;

            push @ret, { sha1 => $rev, name => $head };

            #FIXME: That isn't the time I'm looking for..
            if (my ($epoch, $tz) = $line =~ /\s(\d+)\s+([+-]\d+)$/) {
                my $dt = DateTime->from_epoch(epoch => $epoch);
                $dt->set_time_zone($tz);
                $ret[-1]->{last_change} = $dt;
            }
        }

        return @ret;
    }

    method references {
	return $self->{references}
		if $self->{references};

	# 5dc01c595e6c6ec9ccda4f6f69c131c0dd945f8c refs/tags/v2.6.11
	# c39ae07f393806ccf406ef966e9a15afc43cc36a refs/tags/v2.6.11^{}
	my $cmdout = $self->run_cmd(qw(show-ref --dereference))
		or return;
        my @reflist = $cmdout ? split(/\n/, $cmdout) : ();
	my %refs;
	for(@reflist) {
		push @{$refs{$1}}, $2
			if m!^($SHA1RE)\srefs/(.*)$!;
	}

	return $self->{references} = \%refs;
}

    method valid_rev (Str $rev) {
        return ($rev =~ /^($SHA1RE)$/);
    }


=head2 head_hash

Find the hash of a given head (defaults to HEAD).

=cut

    method head_hash (Str $head?) {
        my $output = $self->run_cmd(qw/rev-parse --verify/, $head || 'HEAD' );
        return unless defined $output;

        my($sha1) = $output =~ /^($SHA1RE)$/;
        return $sha1;
    }

=head2 list_tree

Return an array of contents for a given tree.
The tree is specified by sha1, and defaults to HEAD.
The keys for each item will be:

	mode
	type
	object
	file

=cut

    method list_tree (Str $sha1?) {
        $sha1 ||= $self->head_hash;

        my $output = $self->run_cmd(qw/ls-tree -z/, $sha1);
        return unless defined $output;

        my @ret;
        for my $line (split /\0/, $output) {
            my ($mode, $type, $object, $file) = split /\s+/, $line, 4;
            push @ret, Object->new( mode => oct $mode,
                                    type => $type,
                                    sha1 => $object,
                                    file => $file,
                                    project => $self,
                                  );
        }
        return @ret;
    }

    use Gitalist::Git::Object;
    method get_object (Str $sha1) {
        return Gitalist::Git::Object->new(
            project => $self,
            sha1 => $sha1,
        );
    }
    
    # Should be in ::Object
    method get_object_mode_string (Gitalist::Git::Object $object) {
        return unless $object && $object->{mode};
        return $object->{modestr};
    }

    method get_object_type ($object) {
        chomp(my $output = $self->run_cmd(qw/cat-file -t/, $object));
        return unless $output;

        return $output;
    }

    method cat_file ($object) {
        my $type = $self->get_object_type($object);
        die "object `$object' is not a file\n"
            if (!defined $type || $type ne 'blob');

        my $output = $self->run_cmd(qw/cat-file -p/, $object);
        return unless $output;

        return $output;
    }

    method hash_by_path ($base, $path?, $type?) {
        $path ||= '';
        $path =~ s{/+$}();

        my $output = $self->run_cmd('ls-tree', $base, '--', $path)
            or return;
        my($line) = $output ? split(/\n/, $output) : ();

        #'100644 blob 0fa3f3a66fb6a137f6ec2c19351ed4d807070ffa	panic.c'
        $line =~ m/^([0-9]+) (.+) ($SHA1RE)\t/;
        return defined $type && $type ne $2
            ? ()
                : $3;
    }

    method list_revs ( NonEmptySimpleStr :$sha1!,
                       Int :$count?,
                       Int :$skip?,
                       HashRef :$search?,
                       NonEmptySimpleStr :$file?
                   ) {
        $sha1 = $self->head_hash($sha1)
            if !$sha1 || $sha1 !~ $SHA1RE;

	my @search_opts;
        if($search) {
            $search->{type} = 'grep'
                if $search->{type} eq 'commit';
            @search_opts = (
                # This seems a little fragile ...
                qq[--$search->{type}=$search->{text}],
                '--regexp-ignore-case',
                $search->{regexp} ? '--extended-regexp' : '--fixed-strings'
            );
        }

        my $output = $self->run_cmd(
            'rev-list',
            '--header',
            (defined $count ? "--max-count=$count" : ()),
            (defined $skip ? "--skip=$skip"       : ()),
            @search_opts,
            $sha1,
            '--',
            ($file ? $file : ()),
        );
        return unless $output;

        my @revs = $self->parse_rev_list($output);

        return @revs;
    }

    method parse_rev_list ($output) {
        return
            map  $self->get_gpp_object($_),
                grep $self->valid_rev($_),
                    map  split(/\n/, $_, 6), split /\0/, $output;
    }


    # Compatibility

=head2 info

Returns a hash containing properties of this project. The keys will
be:

	name
	description (empty if .git/description is empty/unnamed)
	owner
	last_change

=cut

    method info {
        return {
            name => $self->name,
            description => $self->description,
            owner => $self->owner,
            last_change => $self->last_change,
        };
    };

} # end class
Commit	Line	Data
56b6dbe6	1	use MooseX::Declare;
	2
	3	class Gitalist::Git::Project {
	4	# FIXME, use Types::Path::Class and coerce
	5	use MooseX::Types::Common::String qw/NonEmptySimpleStr/;
4111e151	6	use MooseX::Types::Moose qw/Str Maybe Bool HashRef/;
56b6dbe6	7	use DateTime;
84f31a44	8	use MooseX::Types::Path::Class qw/Dir/;
941bb5a1	9	use Gitalist::Git::Util;
a8a8f8f9	10	use aliased 'Gitalist::Git::Object';
56b6dbe6	11
4baaeeef	12	our $SHA1RE = qr/[0-9a-fA-F]{40}/;
29debefd	13
56b6dbe6	14	has name => ( isa => NonEmptySimpleStr,
01ced85b	15	is => 'ro', required => 1 );
84f31a44	16	has path => ( isa => Dir,
01ced85b	17	is => 'ro', required => 1);
56b6dbe6	18
0617cbd0	19	has description => ( isa => Str,
56b6dbe6	20	is => 'ro',
	21	lazy_build => 1,
	22	);
	23	has owner => ( isa => NonEmptySimpleStr,
	24	is => 'ro',
	25	lazy_build => 1,
	26	);
0617cbd0	27	has last_change => ( isa => Maybe['DateTime'],
56b6dbe6	28	is => 'ro',
	29	lazy_build => 1,
	30	);
941bb5a1	31	has _util => ( isa => 'Gitalist::Git::Util',
	32	is => 'ro',
	33	lazy_build => 1,
4111e151	34	handles => [ 'run_cmd', 'get_gpp_object' ],
941bb5a1	35	);
56b6dbe6	36
84f31a44	37	has project_dir => ( isa => Dir,
	38	is => 'ro',
	39	lazy => 1,
	40	default => sub {
	41	my $self = shift;
	42	$self->is_bare
	43	? $self->path
	44	: $self->path->subdir('.git')
	45	},
	46	);
	47	has is_bare => (
	48	isa => Bool,
	49	is => 'ro',
	50	lazy => 1,
	51	default => sub {
	52	my $self = shift;
	53	-f $self->path->file('.git', 'HEAD')
	54	? 0
	55	: -f $self->path->file('HEAD')
	56	? 1
	57	: confess("Cannot find " . $self->path . "/.git/HEAD or "
	58	. $self->path . "/HEAD");
	59	},
	60	);
	61
01ced85b	62	method BUILD {
	63	$self->$_() for qw/_util last_change owner description/; # Ensure to build early.
	64	}
	65
8dbe8024	66	method _project_dir {
	67	-f $self->{path}->file('.git', 'HEAD')
	68	? $self->{path}->subdir('.git')
	69	: $self->{path};
	70	}
	71
941bb5a1	72	method _build__util {
255ee743	73	Gitalist::Git::Util->new(
84f31a44	74	project => $self,
941bb5a1	75	);
941bb5a1	76	}
29debefd	77
56b6dbe6	78	method _build_description {
4ce9e8a0	79	my $description = "";
d9a9b56b	80	eval {
84f31a44	81	$description = $self->project_dir->file('description')->slurp;
d9a9b56b	82	chomp $description;
d9a9b56b	83	};
56b6dbe6	84	return $description;
	85	}
	86
	87	method _build_owner {
84f31a44	88	my ($gecos, $name) = (getpwuid $self->project_dir->stat->uid)[6,0];
263e2578	89	$gecos =~ s/,+$//;
263e2578	90	return length($gecos) ? $gecos : $name;
56b6dbe6	91	}
29debefd	92
56b6dbe6	93	method _build_last_change {
	94	my $last_change;
	95	my $output = $self->run_cmd(
	96	qw{ for-each-ref --format=%(committer)
	97	--sort=-committerdate --count=1 refs/heads
	98	});
	99	if (my ($epoch, $tz) = $output =~ /\s(\d+)\s+([+-]\d+)$/) {
	100	my $dt = DateTime->from_epoch(epoch => $epoch);
	101	$dt->set_time_zone($tz);
	102	$last_change = $dt;
	103	}
	104	return $last_change;
	105	}
	106
8dbe8024	107	method heads {
	108	my $cmdout = $self->run_cmd(qw/for-each-ref --sort=-committerdate /, '--format=%(objectname)%00%(refname)%00%(committer)', 'refs/heads');
	109	my @output = $cmdout ? split(/\n/, $cmdout) : ();
	110	my @ret;
	111	for my $line (@output) {
	112	my ($rev, $head, $commiter) = split /\0/, $line, 3;
	113	$head =~ s!^refs/heads/!!;
	114
	115	push @ret, { sha1 => $rev, name => $head };
	116
	117	#FIXME: That isn't the time I'm looking for..
	118	if (my ($epoch, $tz) = $line =~ /\s(\d+)\s+([+-]\d+)$/) {
	119	my $dt = DateTime->from_epoch(epoch => $epoch);
	120	$dt->set_time_zone($tz);
	121	$ret[-1]->{last_change} = $dt;
	122	}
	123	}
	124
	125	return @ret;
	126	}
	127
4111e151	128	method references {
	129	return $self->{references}
	130	if $self->{references};
	131
	132	# 5dc01c595e6c6ec9ccda4f6f69c131c0dd945f8c refs/tags/v2.6.11
	133	# c39ae07f393806ccf406ef966e9a15afc43cc36a refs/tags/v2.6.11^{}
	134	my $cmdout = $self->run_cmd(qw(show-ref --dereference))
	135	or return;
	136	my @reflist = $cmdout ? split(/\n/, $cmdout) : ();
	137	my %refs;
	138	for(@reflist) {
	139	push @{$refs{$1}}, $2
	140	if m!^($SHA1RE)\srefs/(.*)$!;
	141	}
	142
	143	return $self->{references} = \%refs;
	144	}
	145
	146	method valid_rev (Str $rev) {
	147	return ($rev =~ /^($SHA1RE)$/);
	148	}
	149
8dbe8024	150
4baaeeef	151	=head2 head_hash
	152
	153	Find the hash of a given head (defaults to HEAD).
	154
	155	=cut
	156
	157	method head_hash (Str $head?) {
	158	my $output = $self->run_cmd(qw/rev-parse --verify/, $head \|\| 'HEAD' );
	159	return unless defined $output;
	160
	161	my($sha1) = $output =~ /^($SHA1RE)$/;
	162	return $sha1;
	163	}
	164
a8a8f8f9	165	=head2 list_tree
	166
	167	Return an array of contents for a given tree.
	168	The tree is specified by sha1, and defaults to HEAD.
	169	The keys for each item will be:
	170
	171	mode
	172	type
	173	object
	174	file
	175
	176	=cut
	177
	178	method list_tree (Str $sha1?) {
	179	$sha1 \|\|= $self->head_hash;
	180
	181	my $output = $self->run_cmd(qw/ls-tree -z/, $sha1);
	182	return unless defined $output;
	183
	184	my @ret;
	185	for my $line (split /\0/, $output) {
	186	my ($mode, $type, $object, $file) = split /\s+/, $line, 4;
	187	push @ret, Object->new( mode => oct $mode,
	188	type => $type,
	189	sha1 => $object,
	190	file => $file,
50394a3e	191	project => $self,
a8a8f8f9	192	);
	193	}
	194	return @ret;
	195	}
	196
54368e9d	197	use Gitalist::Git::Object;
	198	method get_object (Str $sha1) {
	199	return Gitalist::Git::Object->new(
	200	project => $self,
	201	sha1 => $sha1,
	202	);
	203	}
	204
	205	# Should be in ::Object
	206	method get_object_mode_string (Gitalist::Git::Object $object) {
	207	return unless $object && $object->{mode};
	208	return $object->{modestr};
	209	}
	210
	211	method get_object_type ($object) {
	212	chomp(my $output = $self->run_cmd(qw/cat-file -t/, $object));
	213	return unless $output;
	214
	215	return $output;
	216	}
	217
	218	method cat_file ($object) {
	219	my $type = $self->get_object_type($object);
	220	die "object `$object' is not a file\n"
	221	if (!defined $type \|\| $type ne 'blob');
	222
	223	my $output = $self->run_cmd(qw/cat-file -p/, $object);
	224	return unless $output;
	225
	226	return $output;
	227	}
	228
	229	method hash_by_path ($base, $path?, $type?) {
	230	$path \|\|= '';
	231	$path =~ s{/+$}();
	232
	233	my $output = $self->run_cmd('ls-tree', $base, '--', $path)
	234	or return;
	235	my($line) = $output ? split(/\n/, $output) : ();
	236
	237	#'100644 blob 0fa3f3a66fb6a137f6ec2c19351ed4d807070ffa panic.c'
	238	$line =~ m/^([0-9]+) (.+) ($SHA1RE)\t/;
	239	return defined $type && $type ne $2
	240	? ()
	241	: $3;
	242	}
	243
4111e151	244	method list_revs ( NonEmptySimpleStr :$sha1!,
	245	Int :$count?,
	246	Int :$skip?,
	247	HashRef :$search?,
	248	NonEmptySimpleStr :$file?
	249	) {
	250	$sha1 = $self->head_hash($sha1)
	251	if !$sha1 \|\| $sha1 !~ $SHA1RE;
	252
	253	my @search_opts;
	254	if($search) {
	255	$search->{type} = 'grep'
	256	if $search->{type} eq 'commit';
	257	@search_opts = (
	258	# This seems a little fragile ...
	259	qq[--$search->{type}=$search->{text}],
	260	'--regexp-ignore-case',
	261	$search->{regexp} ? '--extended-regexp' : '--fixed-strings'
	262	);
	263	}
	264
	265	my $output = $self->run_cmd(
	266	'rev-list',
	267	'--header',
	268	(defined $count ? "--max-count=$count" : ()),
	269	(defined $skip ? "--skip=$skip" : ()),
	270	@search_opts,
	271	$sha1,
	272	'--',
	273	($file ? $file : ()),
	274	);
	275	return unless $output;
	276
	277	my @revs = $self->parse_rev_list($output);
	278
	279	return @revs;
	280	}
	281
	282	method parse_rev_list ($output) {
	283	return
	284	map $self->get_gpp_object($_),
	285	grep $self->valid_rev($_),
	286	map split(/\n/, $_, 6), split /\0/, $output;
	287	}
54368e9d	288
54368e9d	289
56b6dbe6	290	# Compatibility
56b6dbe6	291
caba5c95	292	=head2 info
56b6dbe6	293
	294	Returns a hash containing properties of this project. The keys will
	295	be:
	296
	297	name
	298	description (empty if .git/description is empty/unnamed)
	299	owner
	300	last_change
	301
	302	=cut
	303
caba5c95	304	method info {
56b6dbe6	305	return {
	306	name => $self->name,
	307	description => $self->description,
	308	owner => $self->owner,
	309	last_change => $self->last_change,
	310	};
	311	};
29debefd	312
56b6dbe6	313	} # end class