svn对提交上传文档的检查和备注的限制脚本.docx

/bin/sh

# PRE-COMMIT HOOK
#
# The pre-commit hook is invoked before a Subversion txn is
# committed. Subversion runs this hook by invoking a program
# (script, executable, binary, etc.) named 'pre-commit' (for which
# this file is a template), with the following ordered arguments:
#
# [1] REPOS-PATH (the path to this repository)
# [2] TXN-NAME (the name of the txn about to be committed)
#
# [STDIN] LOCK-TOKENS ** the lock tokens are passed via STDIN.
#
# If STDIN contains the line "LOCK-TOKENS:\n" (the "\n" denotes a
# single newline), the lines following it are the lock tokens for
# this commit. The end of the list is marked by a line containing
# only a newline character.
#
# Each lock token line consists of a URI-escaped path, followed
# by the separator character '|', followed by the lock token string,
# followed by a newline.
#
# The default working directory for the invocation is undefined, so
# the program should set one explicitly if it cares.
#
# If the hook program exits with success, the txn is committed; but
# if it exits with failure (non-zero), the txn is aborted, no commit
# takes place, and STDERR is returned to the client. The hook
# program can use the 'svnlook' utility to help it examine the txn.
#
# On a Unix system, the normal procedure is to have 'pre-commit'
# invoke other programs to do the real work, though it may do the
# work itself too.
#
# *** NOTE: THE HOOK PROGRAM MUST NOT MODIFY THE TXN, EXCEPT ***
# *** FOR REVISION PROPERTIES (like svn:log or svn:author). ***
#
# This is why we recommend using the read-only 'svnlook' utility.
# In the future, Subversion may enforce the rule that pre-commit
# hooks should not modify the versioned data in txns, or else come
# up with a mechanism to make it safe to do so (by informing the
# committing client of the changes). However, right now neither
# mechanism is implemented, so hook writers just have to be careful.
#
# Note that 'pre-commit' must be executable by the user(s) who will
# invoke it (typically the user httpd runs as), and that user must
# have filesystem-level permission to access the repository.
#
# On a Windows system, you should name the hook program
# 'pre-commit.bat' or 'pre-commit.exe',
# but the basic idea is the same.
#
# The hook program typically does not inherit the environment of
# its parent process. For example, a common problem is for the
# PATH environment variable to not be set to its usual value, so
# that subprograms fail to launch unless invoked via absolute path.
# If you're having unexpected problems with a hook program, the
# culprit may be unusual (or missing) environment variables.
#
# Here is an example hook script, for a Unix /bin/sh interpreter.
# For more examples and pre-written hooks, see those in
# the Subversion repository at
# and
#
# Check that the author of this commit has the rights to perform
# the commit on the files and directories being modified.
#commit-access-control.pl "$REPOS" "$TXN" commit-access-control.cfg || exit 1

#Set the path of svnlook
SVNLOOK=/opt/CollabNet_Subversion/bin/svnlook

#Initiate the result for checking the comment message.
RES="OK"

#Set the 2 basic parameters.
REPOS="$1"
TXN="$2"

#Set the issue's project key.--设置JIRA中对应的项目Key值。
ISSUE_NUM=MB-

#Set the comment message's length.--设置提交备注的长度。
MIN_LENGTH=5

#Set the limited size of file, ex 1024 Byte.--设置提交文件大小的限制，单位为Byte。
MAX_SIZE=1024

#Set the file type for the limited upload.--设置限制上传的文件类型。
FILTER='\.(zip|rar|o|obj|tar|gz)$'

#Make sure the length of comment message.--检查提交备注的长度。
LOGMSG=$($SVNLOOK log -t "$TXN" "$REPOS" | egrep "[a-zA-Z0-9]" |wc -c)
if [ "$LOGMSG" -lt "$MIN_LENGTH" ]
then
echo -e "\nLog message cann't be empty! you must input more than $MIN_LENGTH characters as comment!" >&2
exit 1
fi

# Make sure that the comment message contains some text.--检查提交备注非空。
$SVNLOOK log -t "$TXN" "$REPOS" | egrep "[^[:space:]]+" >/dev/null ||
unset RES
if [ "$RES" != "OK" ]
then
echo "You must input some comments." >&2
exit 1
fi

# Make sure that the comment message contains the issue's number.--检查提交备注中是否包含相应的缺陷号。
$SVNLOOK log -t "$TXN" "$REPOS" | egrep "$ISSUE_NUM+[0-9]" >/dev/null ||
unset RES
if [ "$RES" != "OK" ]
then
echo "You must input the issue number related with your submit. such as $ISSUE_NUM""01." >&2
exit 1
fi

#Collect the files changed.--收集提交文件的信息。
files=$($SVNLOOK changed -t $TXN $REPOS |awk '{print $2}')

#Check the file in the files collection by the following rules.--按照如下方式检查检查提交文件。
for f in $files
do
#check file type.--检查文件是否属于限制类型。
if echo $f|tr A-Z a-z|grep -Eq $FILTER
then
echo "File $f is not allow ($FILTER) file." >&2
exit 1
fi

#check file size.--检查文件是否超出限制大小。
filesize=$($SVNLOOK cat -t $TXN $REPOS $f|wc -c)
if [ "$filesize" -gt "$MAX_SIZE" ]
then
echo "File $f is too large(must <=$MAX_SIZE Byte)." >&2
exit 1
fi
done

# All checks passed, so allow the commit.--所有以上的检查通过，完成提交。
exit 0