1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
package Local::MrRepo::Repo::Git::Annex;
# Copyright (C) 2019 Sean Whitton
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or (at
# your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
use 5.018;
use strict;
use warnings;
use lib "$ENV{HOME}/lib/perl5";
use parent 'Local::MrRepo::Repo::Git';
use Exporter 'import';
use File::Spec::Functions qw(rel2abs);
use Git::Wrapper;
use JSON;
use Local::ScriptStatus;
use Try::Tiny;
use Term::ReadKey;
use Local::Interactive qw(prompt);
our @EXPORT_OK = ();
# public methods
sub review {
my $self = shift;
my $issues = $self->SUPER::review(@_);
# if there were git issues, fail now, as the annex issues can
# produce copious output and it is nice to know there were no git
# issues when reviewing the annex issues
return $issues if $issues;
# another command we could consider running is `git annex fsck --fast`
# 1. Check for files stored only locally where that's not okay
my @annex_find_output = $self->git->annex("find", "--json",
"--in", "here", "--and", "--not", "--copies=2", "--and", "--lackingcopies=1");
unless (@annex_find_output == 0) {
say_spaced_bullet("Some annex content is present only locally:");
say " $_" for map { ${decode_json($_)}{file} } @annex_find_output;
say "";
say_bold
(" use `git annex sync --content' to fix this (`mr push' should be");
say_bold
(" configured to run that command with the right remotes)");
$issues = 1;
}
# 2. Check for unused files which we should be able to clean up
my ($review_unused) = $self->git->config(qw(--local --get --type=bool
--default true
mrrepo.review-unused));
$issues = $self->review_unused(interactive => 0) || $issues
if $review_unused eq 'true';
return $issues;
}
sub review_unused {
my $self = shift;
my %opts = @_;
$opts{interactive} //= 0;
$opts{used_refspec} //= "+refs/heads/*:-refs/heads/synced/*";
my %unused_args = (used_refspec => $opts{used_refspec});
my %dropunused_args = (force => 1);
$unused_args{from} = $dropunused_args{from} = $opts{from}
if defined $opts{from};
my @to_drop = ();
my @unused_lines = $self->git->annex("unused", \%unused_args);
my @unused_files
= map { /^ ([0-9]+) +([^ ]+)$/ ? { number => $1, key => $2 } : () }
@unused_lines;
return 0 if @unused_files == 0;
unless ($opts{interactive}) {
say_spaced_bullet("There are unused files you can drop with"
. " `git annex dropunused':");
say for @unused_lines;
say "";
}
foreach my $unused_file (@unused_files) {
system('clear', '-x') if $opts{interactive};
say_bold("unused file #" . $unused_file->{number} . ":");
# this way of determining whether a file is tmp or bad, rather
# than really unused, is not great because it only works for
# the local repo and makes unneeded `ga contentlocation`
# calls. it would be better just to parse @unused_lines with
# a proper state machine and thereby extract into separate
# arrays the unused and the tmp/bad data
my $is_tmp_or_bad = 0;
my $content_location;
try {
($content_location)
= $self->git->annex("contentlocation", $unused_file->{key});
$content_location = rel2abs($content_location, $self->toplevel);
}
catch {
$is_tmp_or_bad = 1;
};
# $is_tmp_or_bad can only be trusted when we are operating on
# the local repo, so guard for that here
if ($is_tmp_or_bad && !defined $opts{from}) {
say " looks like stale tmp or bad file, with key "
. $unused_file->{key};
} else {
# We need the RUN here to avoid special postprocessing but
# also to get the -c option passed -- unclear how to pass
# short options to git itself, not the 'log' subcommand,
# with Git::Wrapper except by using RUN (passing long
# options to git itself is easy, per Git::Wrapper docs)
my @log_lines = map { s/^/ /r } $self->git->RUN(
"-c",
"diff.renameLimit=3000",
"log",
{
stat => 1,
no_textconv => 1
},
"--color=always",
"-S",
$unused_file->{key});
if ($opts{interactive}) {
# truncate log output if necessary to ensure user's
# terminal does not scroll
my (undef, $height, undef, undef) = GetTerminalSize();
splice @log_lines, (($height - 5) - @log_lines)
if @log_lines > ($height - 5);
}
say "";
say for @log_lines;
if ($opts{interactive}) {
my $response;
while (1) {
$response
= lc(prompt("Drop this unused file? (y/n/o)"));
if ($response eq 'y') {
push @to_drop, $unused_file->{number};
last;
} elsif ($response eq 'n') {
last;
} elsif ($response eq 'o') {
system('xdg-open', $content_location);
} else {
say "invalid response";
}
}
}
}
say "";
}
$self->git->annex("dropunused", \%dropunused_args, @to_drop) if @to_drop;
# return boolean value representing whether or not there are any
# unused files left after this run. note in non-interactive mode
# @to_drop will be empty so will always return 1 if we got this
# far in the subroutine
return @to_drop != @unused_files;
}
1;
|
