contrib/hook-scripts/syntax-check.sh

   1 #!/bin/bash
   2 #
   3 # SVN Syntax Check Hook Script
   4 # Copyright (c) 2007, Lucas Nealan <lucas@sizzo.org>, Facebook Inc.
   5 #
   6 # This program is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 2 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program; if not, write to the Free Software
  18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 # 02110-1301  USA
  20 #
  21 # --------------------------------------------------------------------
  22 #
  23 # This script provides language independant syntax checking
  24 # functionality intended to be invoked from a subversion pre-commit
  25 # hook.
  26 #
  27 # Invocation: /path/to/syntax-check $1 $2
  28 #         or: source syntax-check
  29 #
  30 # Requires bash 3.x or higher.
  31 #
  32
  33 FPATTERN="\.\(php\|phpt\)$"
  34 FLANG="PHP"
  35 SYNTAX_CMD="php"
  36 SYNTAX_ARGS="-l"
  37 # address to email notifications of syntax errors
  38 NOTIFY_SYNTAX="user@domain.tld"
  39 # adderss to notify for syntax script failures
  40 NOTIFY_ERROR="user@domain.tld"
  41 # log of syntax errors, must be writable by svn server users
  42 SYNTAX_LOG="/tmp/syntax.log"
  43 BYPASSPW="change_this_syntax_bypass_password_please"
  44
  45 [ -z "$REPOS" ] && REPOS="$1"
  46 [ -z "$TXN" ]   && TXN="$2"
  47 [ -z "$MODE" ]  && if [ -n "$3" ]; then MODE="$3"; else MODE="-t"; fi
  48 [ -z "$SVNLOOK" ] && SVNLOOK=svnlook
  49 [ -z "$LOG" ] && LOG=`$SVNLOOK log $MODE "$TXN" "$REPOS"`
  50 [ -z "$DIFF" ] && DIFF=`$SVNLOOK diff $MODE "$TXN" "$REPOS"`
  51 [ -z "$AUTHOR" ] && AUTHOR=`$SVNLOOK author $MODE "$TXN" "$REPOS"`
  52 [ -z "$CHANGEDFILES" ] && CHANGEDFILES=`$SVNLOOK changed $MODE "$TXN" "$REPOS"`
  53 [ -n "$SYNTAXENABLED" ] && SYNTAXENABLED="1"
  54
  55 syntaxclean() {
  56   [ -d $1 ] && rm -rf $1
  57 }
  58
  59 syntaxexit() {
  60   echo $1 >> /dev/stderr
  61   echo $1 >> $SYNTAX_LOG
  62
  63   # save working dir and debug files
  64   if [ -d $WORKING ]; then
  65     [ -n "$DIFF" ] && echo $"$DIFF" > $WORKING/patch
  66     [ -n "$LOG" ] && echo $"$LOG" > $WORKING/svnlog
  67     [ -n "$CHANGED" ] && echo $"$CHANGED" > $WORKING/changed
  68     mv $WORKING $WORKING.failed
  69   fi
  70
  71   [ -n "$NOTIFY_ERROR" ] && echo "$1 ($WORKING.failed)" | mail -s "syntax commit failed" $NOTIFY_ERROR
  72
  73   # clean working dir if specified
  74   [ -n $2 ] && syntaxclean $2
  75   exit 1
  76 }
  77
  78 function strlpad() {
  79   STR="$1"
  80   CHAR=$2
  81   LEN=$3
  82   L=${#STR}
  83   D=$((LEN-L))
  84   echo "$STR""`printf '%'$D's'| tr \  \"$CHAR\"`"
  85 }
  86
  87 function errormessage() {
  88   echo
  89   HEADER=`strlpad "Error" "-" 76`
  90   echo "|--$HEADER|" >&2
  91   SPACES="`strlpad '' ' ' 78`"
  92   echo "|$SPACES|" >&2
  93   ERROR=`strlpad "$1" " " 77`
  94   echo "| $ERROR|" >&2
  95   echo "|$SPACES|" >&2
  96   LINE=`strlpad "" "-" 78`
  97   echo "|$LINE|" >&2
  98   echo
  99 }
 100
 101 if [ "$SYNTAXENABLED" == "1" ]; then
 102   # allow selective bypass of syntax check for commits
 103   [[ "$LOG" =~ "$BYPASSPW" ]] && return;
 104
 105   # get changed file list and count
 106   NUMMATCHCHANGED=0
 107   if [ -n "$CHANGEDFILES" ]; then
 108     MATCHCHANGED=`echo $"$CHANGEDFILES" | grep "$FPATTERN"`
 109     [ -n "$MATCHCHANGED" ] && NUMMATCHCHANGED=`echo $"$MATCHCHANGED" | wc -l`
 110   fi
 111
 112   # make sure matched files were changed
 113   if [ $NUMMATCHCHANGED -gt 0 ]; then
 114     # create temporary working directory
 115     WORKING=/tmp/$(basename $0).$$
 116     [ -d $WORKING ] && rm -rf $WORKING
 117     mkdir $WORKING || syntaxexit "failed to create temp dir for syntax check: $WORKING"
 118     cd $WORKING
 119
 120     # export changed files (no dirs) from local repo (speed)
 121     IFS=$'\n'
 122     for LINE in $MATCHCHANGED; do
 123       IFS=' '
 124       WORDS=($LINE)
 125       FSTATUS=${WORDS[0]}
 126       FNAME=${WORDS[1]}
 127
 128       # only export modified and deleted files. new files wont exist in repo yet
 129       if [ "$FSTATUS" == "U" ] || [ "$FSTATUS" == "UU" ] || [ "$FSTATUS" == "A" ]; then
 130         TMPFNAME=${FNAME//\//.}
 131         $SVNLOOK cat $MODE "$TXN" "$REPOS" $FNAME > $TMPFNAME
 132
 133         file `which $SYNTAX_CMD` || syntaxexit "unablet to find systax command binary: $SYNTAX_CMD"
 134         SYNTAXERROR=`$SYNTAX_CMD $SYNTAX_ARGS $TMPFNAME 2> $WORKING/$TMPFNAME.STDERR`
 135         SYNTAXRETURN=$?
 136         [ -s "$WORKING/$TMPFNAME.STDERR" ] && SYNTAXWARNING=`cat $WORKING/$TMPFNAME.STDERR`
 137
 138         if [ "$SYNTAXRETURN" -ne 0 ] || [ -n "$SYNTAXWARNING" ]; then
 139           [ -n "$SYNTAXWARNING" ] && SYNTAXERROR=$SYNTAXWARNING
 140
 141           # cleanup HTML out of PHP parse error so a human can read it
 142           if [ "$FLANG" == "PHP" ]; then
 143             SYNTAXERROR=`echo $SYNTAXERROR | sed -e 's/<[^<]*>//g' | cut -d',' -f 2`
 144             SYNTAXERROR=`echo $SYNTAXERROR | sed -e 's/\(on line [0-9]* \)/\1\n/g'`
 145           fi
 146
 147           # sloppy email notification
 148           ETMP=$WORKING/sloppy.txt
 149           echo "$FLANG Syntax Error: $SYNTAXERROR" > $ETMP
 150           echo >> $ETMP
 151           echo Log: $LOG >> $ETMP
 152           echo >> $ETMP
 153           echo $"$DIFF" >> $ETMP
 154           cat $ETMP | mail -s "SVN SYNTAX ERROR: $AUTHOR" $NOTIFY_SYNTAX
 155           rm -f $ETMP
 156
 157           echo "$AUTHOR: $FLANG Syntax Error: $SYNTAXERROR" >> $SYNTAX_LOG
 158           errormessage "$FLANG Syntax Error: $SYNTAXERROR"
 159           syntaxclean $WORKING
 160           exit 1
 161         fi
 162       fi
 163     done
 164     # exit within a loop only sets the return value of the loop itself, check this to exit
 165     [ $? -ne 0 ] && exit 1
 166   fi
 167   syntaxclean $WORKING
 168 fi