You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@subversion.apache.org by kf...@collab.net on 2005/01/05 17:44:45 UTC
Re: mime-type check pre-commit hook
Tom Brown <td...@uiuc.edu> writes:
> Like several other users, I had problems with the default eol handling
> with subversion 1.0 when Windows and UNIX users edited the same file.
> http://svn.haxx.se/users/archive-2003-12/0062.shtml
> suggests a (Python) pre-commit hook to check the mime-type and
> eol-style before accepting a commit. I couldn't find anything to do it
> in the distribution so I adapted commit-access-control.pl to this
> purpose. Perhaps you could include this script as an example hook?
Done in r12600, thanks.
(I called it contrib/hook-scripts/check-mime-type.pl, by the way.)
-Karl
> --
> Tom Brown tdbrown@uiuc.edu Siebel Center 2107 +1 (217) 778-7908
>
> #!/usr/bin/env perl
>
> # ====================================================================
> # commit-mime-type-check.pl: check that every added file has the
> # svn:mime-type property set and every added file with a mime-type
> # matching text/* also has svn:eol-style set. If any file fails this
> # test the user is sent a verbose error message suggesting solutions and
> # the commit is aborted.
> #
> # Usage: commit-mime-type-check.pl REPOS TXN-NAME
> # ====================================================================
> # Most of commit-mime-type-check.pl was taken from
> # commit-access-control.pl, Revision 9986, 2004-06-14 16:29:22 -0400.
> # ====================================================================
> # Copyright (c) 2000-2004 CollabNet. All rights reserved.
> #
> # This software is licensed as described in the file COPYING, which
> # you should have received as part of this distribution. The terms
> # are also available at http://subversion.tigris.org/license.html.
> # If newer versions of this license are posted there, you may use a
> # newer version instead, at your option.
> #
> # This software consists of voluntary contributions made by many
> # individuals. For exact contribution history, see the revision
> # history and logs, available at http://subversion.tigris.org/.
> # ====================================================================
>
> # Turn on warnings the best way depending on the Perl version.
> BEGIN {
> if ( $] >= 5.006_000)
> { require warnings; import warnings; }
> else
> { $^W = 1; }
> }
>
> use strict;
> use Carp;
>
>
> ######################################################################
> # Configuration section.
>
> # Svnlook path.
> my $svnlook = "/usr/bin/svnlook";
>
> # Since the path to svnlook depends upon the local installation
> # preferences, check that the required program exists to insure that
> # the administrator has set up the script properly.
> {
> my $ok = 1;
> foreach my $program ($svnlook)
> {
> if (-e $program)
> {
> unless (-x $program)
> {
> warn "$0: required program `$program' is not executable, ",
> "edit $0.\n";
> $ok = 0;
> }
> }
> else
> {
> warn "$0: required program `$program' does not exist, edit $0.\n";
> $ok = 0;
> }
> }
> exit 1 unless $ok;
> }
>
> ######################################################################
> # Initial setup/command-line handling.
>
> &usage unless @ARGV == 2;
>
> my $repos = shift;
> my $txn = shift;
>
> unless (-e $repos)
> {
> &usage("$0: repository directory `$repos' does not exist.");
> }
> unless (-d $repos)
> {
> &usage("$0: repository directory `$repos' is not a directory.");
> }
>
> # Define two constant subroutines to stand for read-only or read-write
> # access to the repository.
> sub ACCESS_READ_ONLY () { 'read-only' }
> sub ACCESS_READ_WRITE () { 'read-write' }
>
>
> ######################################################################
> # Harvest data using svnlook.
>
> # Change into /tmp so that svnlook diff can create its .svnlook
> # directory.
> my $tmp_dir = '/tmp';
> chdir($tmp_dir)
> or die "$0: cannot chdir `$tmp_dir': $!\n";
>
> # Figure out what files have added using svnlook.
> my @files_added;
> foreach my $line (&read_from_process($svnlook, 'changed', $repos, '-t', $txn))
> {
> # Add only files that were added to @files_added
> if ($line =~ /^A. (.*[^\/])$/)
> {
> push(@files_added, $1);
> }
> }
>
> my @errors;
> foreach my $path ( @files_added )
> {
> my $mime_type;
> my $eol_style;
>
> # Parse the complete list of property values of the file $path to extract
> # the mime-type and eol-style
> foreach my $prop (&read_from_process($svnlook, 'proplist', $repos, '-t',
> $txn, '--verbose', $path))
> {
> if ($prop =~ /^\s*svn:mime-type : (\S+)/)
> {
> $mime_type = $1;
> }
> elsif ($prop =~ /^\s*svn:eol-style : (\S+)/)
> {
> $eol_style = $1;
> }
> }
>
> # Detect error conditions and add them to @errors
> if (not $mime_type)
> {
> push @errors, "$path : svn:mime-type is not set";
> }
> elsif ($mime_type =~ /^text\// and not $eol_style)
> {
> push @errors, "$path : svn:mime-type=$mime_type but svn:eol-style is not set";
> }
> }
>
> # If there are any errors list the problem files and give information
> # on how to avoid the problem. Hopefully people will set up auto-props
> # and will not see this verbose message more than once.
> if (@errors)
> {
> warn "$0:\n\n",
> join("\n", @errors), "\n\n",
> <<EOS;
>
> Every added file must have the svn:mime-type property set. In
> addition text files must have the svn:eol-style property set.
>
> For binary files try running
> svn propset svn:mime-type application/octet-stream path/of/file
>
> For text files try
> svn propset svn:mime-type text/plain path/of/file
> svn propset svn:eol-style native path/of/file
>
> You may want to consider uncommenting the auto-props section
> in your ~/.subversion/config file. Read the Subversion book
> (http://svnbook.red-bean.com/), Chapter 7, Properties section,
> Automatic Property Setting subsection for more help.
> EOS
> exit 1;
> }
> else
> {
> exit 0;
> }
>
> sub usage
> {
> warn "@_\n" if @_;
> die "usage: $0 REPOS TXN-NAME\n";
> }
>
> sub safe_read_from_pipe
> {
> unless (@_)
> {
> croak "$0: safe_read_from_pipe passed no arguments.\n";
> }
> print "Running @_\n";
> my $pid = open(SAFE_READ, '-|');
> unless (defined $pid)
> {
> die "$0: cannot fork: $!\n";
> }
> unless ($pid)
> {
> open(STDERR, ">&STDOUT")
> or die "$0: cannot dup STDOUT: $!\n";
> exec(@_)
> or die "$0: cannot exec `@_': $!\n";
> }
> my @output;
> while (<SAFE_READ>)
> {
> chomp;
> push(@output, $_);
> }
> close(SAFE_READ);
> my $result = $?;
> my $exit = $result >> 8;
> my $signal = $result & 127;
> my $cd = $result & 128 ? "with core dump" : "";
> if ($signal or $cd)
> {
> warn "$0: pipe from `@_' failed $cd: exit=$exit signal=$signal\n";
> }
> if (wantarray)
> {
> return ($result, @output);
> }
> else
> {
> return $result;
> }
> }
>
> sub read_from_process
> {
> unless (@_)
> {
> croak "$0: read_from_process passed no arguments.\n";
> }
> my ($status, @output) = &safe_read_from_pipe(@_);
> if ($status)
> {
> if (@output)
> {
> die "$0: `@_' failed with this output:\n", join("\n", @output), "\n";
> }
> else
> {
> die "$0: `@_' failed with no output.\n";
> }
> }
> else
> {
> return @output;
> }
> }
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
> For additional commands, e-mail: dev-help@subversion.tigris.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: mime-type check pre-commit hook
Posted by kf...@collab.net.
Tom Brown <to...@thecap.org> writes:
> Perhaps you could link to
> http://svn.collab.net/repos/svn/trunk/contrib/hook-scripts/check-mime-type.pl
> from
> http://subversion.tigris.org/project_faq.html#auto-props
Done in r12666, thanks for the suggestion.
-Karl
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: mime-type check pre-commit hook
Posted by Tom Brown <to...@thecap.org>.
On Wed, Jan 05, 2005 at 11:44:45AM -0600, kfogel@collab.net wrote:
> Tom Brown <td...@uiuc.edu> writes:
> > Like several other users, I had problems with the default eol handling
> > with subversion 1.0 when Windows and UNIX users edited the same file.
> Done in r12600, thanks.
>
> (I called it contrib/hook-scripts/check-mime-type.pl, by the way.)
Perhaps you could link to
http://svn.collab.net/repos/svn/trunk/contrib/hook-scripts/check-mime-type.pl
from
http://subversion.tigris.org/project_faq.html#auto-props
Tom (concerned that I'm described as particularly paranoid) Brown
--
28 70 20 71 2C 65 29 61 9C B1 36 3D D4 69 CE 62 4A 22 8B 0E DC 3E
mailto:mail@thecap.org
http://thecap.org/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org