.git-hooks/pre-commit

   1 #!/usr/bin/env perl
   2
   3 # A hook script to verify what is about to be committed.
   4 # Called by "git commit" with no arguments.  The hook should
   5 # exit with non-zero status after issuing an appropriate message
   6 # if it wants to stop the commit.
   7
   8 use strict;
   9 use lib "solenv/clang-format";
  10 #use File::Copy;
  11 #use Cwd;
  12
  13 $ENV{LC_ALL} = "C";
  14
  15 sub check_whitespaces($)
  16 {
  17     my ($h) = @_;
  18     my $src_limited = "c|cpp|cxx|h|hrc|hxx|idl|inl|java|swift|map|MK|pmk|pl|pm|sdi|sh|src|tab|ui|xcu|xml|xsl";
  19     my $src_full = "c|cpp|cxx|h|hrc|hxx|idl|inl|java|swift|map|mk|MK|pmk|pl|pm|sdi|sh|src|tab|ui|xcu|xml|xsl";
  20
  21     my $found_bad = 0;
  22     my $filename;
  23     my $reported_filename = "";
  24     my $lineno;
  25     sub bad_line
  26     {
  27         my ($why, $line, $file_filter) = @_;
  28         if (!defined $file_filter || $filename =~ /\.($file_filter)$/)
  29         {
  30             if (!$found_bad)
  31             {
  32                 print STDERR "*\n";
  33                 print STDERR "* You have some suspicious patch lines:\n";
  34                 print STDERR "*\n";
  35                 $found_bad = 1;
  36             }
  37             if ($reported_filename ne $filename)
  38             {
  39                 print STDERR "* In $filename\n";
  40                 $reported_filename = $filename;
  41             }
  42             print STDERR "* $why (line $lineno)\n";
  43             print STDERR "$filename:$lineno:$line\n";
  44         }
  45     }
  46     open( FILES, "git-diff-index -p -M --cached $h |" ) ||  die "Cannot run git diff-index.";
  47     while (<FILES>)
  48     {
  49         if (m|^diff --git a/(.*) b/\1$|)
  50         {
  51             $filename = $1;
  52             next;
  53         }
  54         if (/^@@ -\S+ \+(\d+)/)
  55         {
  56             $lineno = $1 - 1;
  57             next;
  58         }
  59         if (/^ /)
  60         {
  61             $lineno++;
  62             next;
  63         }
  64         if (s/^\+//)
  65         {
  66             $lineno++;
  67             chomp;
  68             if (/\s$/)
  69             {
  70                 bad_line("trailing whitespace", $_ , $src_limited);
  71             }
  72             if (/\r$/)
  73             {
  74                 bad_line("DOS lineends", $_ , $src_limited);
  75             }
  76             if (/\s*    /)
  77             {
  78                 bad_line("indent with Tab", $_, $src_limited);
  79             }
  80             if (/^(?:[<>=]){7}$/)
  81             {
  82                 bad_line("unresolved merge conflict", $src_full);
  83             }
  84             if (/SAL_DEBUG/)
  85             {
  86                 bad_line("temporary debug in commit", $_, $src_limited);
  87             }
  88             if (/<property name="use_markup">True<\/property>/)
  89             {
  90                 bad_line("use font attributes instead of use-markup", $_, "ui");
  91             }
  92             if (/<property name="tooltip_markup"/ )
  93             {
  94                 bad_line("use tooltip_text instead of tooltip_markup", $_, "ui");
  95             }
  96             if ((/translatable="yes"/) and not(/context=/))
  97             {
  98                 bad_line("translatable .ui file line without context", $_, "ui");
  99             }
 100             if ((/<interface/) and not(/domain=/))
 101             {
 102                 bad_line(".ui file without translation domain", $_, "ui");
 103             }
 104         }
 105     }
 106     if ( $found_bad)
 107     {
 108         exit($found_bad);
 109     }
 110 }
 111
 112 sub check_author()
 113 {
 114     my $author = `git var GIT_AUTHOR_IDENT`;
 115     chomp $author;
 116     if ($author =~ /^Your Name <you\@example.com>/)
 117     {
 118         print("ERROR: You have a suspicious author identity: '$author'\n");
 119         exit(1);
 120     }
 121 }
 122
 123 sub check_style($)
 124 {
 125     if (! -e "solenv/clang-format/ClangFormat.pm")
 126     {
 127         # Commit happens in a submodule.
 128         return;
 129     }
 130
 131     require ClangFormat;
 132     ClangFormat->import();
 133
 134     my ($h) = @_;
 135     my $src = ClangFormat::get_extension_regex();
 136     my @bad_names = ();
 137     my $blacklist_names = ClangFormat::get_blacklist();
 138     my $clang_format = ClangFormat::find();
 139
 140     # Get a list of non-deleted changed files.
 141     open (FILES, "git diff-index --cached --diff-filter=AM --name-only $h |") ||  die "Cannot run git diff.";
 142     while (my $filename = <FILES>)
 143     {
 144         chomp $filename;
 145         if ($filename =~ /\.($src)$/ and !exists($blacklist_names->{$filename}))
 146         {
 147             if (!defined($clang_format))
 148             {
 149                 my $version = ClangFormat::get_wanted_version();
 150                 my $opt_lo = ClangFormat::get_own_directory();
 151
 152                 print("\nWARNING: Commit touches new (non-blacklisted) files, but no clang-format"
 153                       . " ${version}\n");
 154                 print(" found (via CLANG_FORMAT or PATH env vars, or in ${opt_lo}).\n\n");
 155
 156                 my $platform = "linux64";
 157                 my $download = "wget";
 158                 if ($^O eq "cygwin")
 159                 {
 160                     $platform = "win.exe";
 161                 }
 162                 elsif ($^O eq "darwin")
 163                 {
 164                     $platform = "mac";
 165                     $download = "curl -O";
 166                 }
 167
 168                 print("To get a suitable binary, please do:\n\n");
 169                 print("mkdir -p $opt_lo\n");
 170                 print("cd $opt_lo\n");
 171                 print("$download https://dev-www.libreoffice.org/bin/clang-format-$version-$platform\n");
 172                 print("cp clang-format-$version-$platform clang-format\n");
 173                 print("chmod +x clang-format\n\n");
 174
 175                 print("(Or read solenv/clang-format/README on how to build it yourself.\n");
 176                 return;
 177             }
 178             if (!ClangFormat::check_style($clang_format, $filename))
 179             {
 180                 push @bad_names, $filename;
 181             }
 182         }
 183     }
 184
 185     # Enforce style.
 186     if (scalar @bad_names)
 187     {
 188         my $autostyle = `git config libreoffice.autostyle`;
 189         chomp $autostyle;
 190         if ($autostyle ne "true")
 191         {
 192             print("\nThe above differences were found between the code to commit \n");
 193             print("and the clang-format rules. You can apply these changes with:\n");
 194             print("\n$clang_format -i " . join(" ", @bad_names) . "\n\n");
 195             print("Aborting commit. Apply changes and commit again or skip checking\n");
 196             print("with --no-verify (not recommended).\n");
 197             exit(1);
 198         }
 199         else
 200         {
 201             # 'git config libreoffice.autostyle true' was invoked to run
 202             # clang-format automatically.
 203             print("\nThe above differences were found between the code to commit \n");
 204             print("and the clang-format rules. Fixing these now automatically.\n");
 205             print("Running '$clang_format -i " . join(" ", @bad_names) . "' for you...\n");
 206             system("$clang_format -i " . join(" ", @bad_names));
 207             # TODO this stages all local modifications, staging originally
 208             # unstaged hunks.
 209             system("git add " . join(" ", @bad_names));
 210             print("Done.\n");
 211         }
 212     }
 213 }
 214
 215 # Do the work :-)
 216
 217 # Initial commit: diff against an empty tree object
 218 my $against="4b825dc642cb6eb9a060e54bf8d69288fbee4904";
 219 if ( system( "git rev-parse --verify HEAD >/dev/null 2>&1" ) == 0 )
 220 {
 221     $against="HEAD"
 222 }
 223
 224 # If you want to allow non-ascii filenames set this variable to true.
 225 my $allownonascii=`git config hooks.allownonascii`;
 226
 227 # Cross platform projects tend to avoid non-ascii filenames; prevent
 228 # them from being added to the repository. We exploit the fact that the
 229 # printable range starts at the space character and ends with tilde.
 230 if ( $allownonascii ne "true" &&
 231     # Note that the use of brackets around a tr range is ok here, (it's
 232     # even required, for portability to Solaris 10's /usr/bin/tr), since
 233     # the square bracket bytes happen to fall in the designated range.
 234     `git diff --cached --name-only --diff-filter=A -z $against | \
 235      LC_ALL=C tr -d '[ -~]\\0'` ne "" )
 236 {
 237     print <<EOM;
 238 Error: Attempt to add a non-ascii file name.
 239
 240 This can cause problems if you want to work
 241 with people on other platforms.
 242
 243 To be portable it is advisable to rename the file ...
 244
 245 If you know what you are doing you can disable this
 246 check using:
 247
 248   git config hooks.allownonascii true
 249
 250 EOM
 251     exit( 1 );
 252 }
 253
 254 # Block large files.
 255 open( FILES, "git diff --cached --name-only --diff-filter=A -z $against |" ) ||  die "Cannot run git diff-index.";
 256 while (<FILES>)
 257 {
 258     if (/\.ui$/) # .ui files can get large
 259     {
 260         continue;
 261     }
 262     if (/\.xsl$/) # XSLT
 263     {
 264         continue;
 265     }
 266     my $size = `git cat-file -s :$_`;
 267     # For now let's say large is 500KB
 268     my $limit = 500;
 269     if ($size > $limit * 1024)
 270     {
 271         print "Error: Attempt to add a large file: $_, pleasy try to fit into $limit KB.\n";
 272         exit( 1 );
 273     }
 274 }
 275
 276 # fix whitespace in code
 277 check_whitespaces( $against);
 278
 279 # fix style in code
 280 check_style($against);
 281
 282 # catch missing author info
 283 check_author();
 284
 285 # all OK
 286 exit( 0 );
 287 # vi:set shiftwidth=4 expandtab: