SVN掛鉤子詳解（例如在提交時必須寫message）

【1.業務需求】

---

爲部門的SVN服務器添加一項commit控制：即用戶在提交改變時必須寫註釋，且不得低於10個字符。

【2.基本思路】

---

SVN本身並不提供這種強制寫log的功能，而是通過一系列的鉤子程序(我們稱爲hook腳本)，在提交之前(pre-commit)，提交過程中(start-commit)，提交之後(post-commit)，調用預定的鉤子程序來完成一些附加的功能。

本次我們要實現的是在提交到版本庫之前檢查用戶是否已經寫了註釋，當然要使用pre-commit這個鉤子程序。我們打開SVN的repository下的hook目錄，可以發現有好幾個文件，其中一個是“pre-commit.tmpl”。這個文件是一個模板文件，它告訴了我們如何實現提交前控制。打開該模板文件，我們看到如下一段說明：

# 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)
#
# 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.

我們看到在一個提交事務執行之前，該hook腳本會被調用。然後向該腳本傳遞兩個參數：REPOS-PATH和TXN-NAME，一個是用戶要提交的URL，一個是本次事務的一個事務號。如果提交成功則返回0，否則返回其它非0結果。那麼我們的鉤子程序就是要在事務提交之前，攔截這些請求，然後通過svnlook命令來檢查是否已經寫了log。

【3.示例代碼】

---

下面這段代碼是網上直接拷貝的一段代碼：

@echo off
setlocal
set REPOS=%1
set TXN=%2  
rem check that logmessage contains at least 10 characters
svnlook log "%REPOS%" -t "%TXN%" | findstr "." > nul
if %errorlevel% gtr 0 goto err
exit 0
:err
echo Empty log message not allowed. Commit aborted! 1>&2
exit 1

下面解析一下綠色高亮處代碼的作用：

 ①set REPOS=%1 
    set TXN=%2
   還記得我們前面提到的但事務提交時，會傳遞兩個參數嗎？這裏就是分別用來接收URL和事務號的
 
②svnlook log "%REPOS%" -t "%TXN%" | findstr ".........." > nul
   這句是核心程序。首先svnlook log是用來查看某個版本庫某次提交的log的，那麼我們怎麼知道這兩個
   參數呢？答案就是我們前面已經保存的REPOS和TXN參數。
   它的作用是查看%REPOS%這個URL第%TXN%次提交的log信息，那麼| findstr ".........."呢？細心
   的讀者會發現這裏有10個圓點號，即表示10個字符。
   整句的作用就是先獲取當前提交的log內容，然後判斷是否有10個字符以上

③echo Empty log message not allowed. Commit aborted! 1>&2
   這句話的作用是當提交檢查失敗時，輸出的提示信息

【4. 運行測試及錯誤解決】

---

到這裏我們應該可以正常運行了吧？下面我們把上面這個程序保存爲pre-commit.bat，保存到hook目錄下。啓動SVN，隨意修改一個文件後，不寫註釋提交。看看下面的結果： 居然提示我們找不到svn repository目錄下的format文件：

Svnlook：不能打開文件”C:\peng\Other\newRepo\fom…\” The system cannot find The path specified.

真鬱悶！這是什麼原因。仔細檢查文件，沒有發現語法錯誤。從SVN的官網上下了一份同樣內容的bat文件，測試通過！那會不會是文件的格式原因呢？我試着比較了這兩份文件的字符數，發現居然不一樣。會不會是一些控制字符的原因。

於是打開舊的文件，重新整理格式，發現每一行後面都多了一個中文的換行符。刪除這些換行符再測試，測試通過！

教訓：從網頁上直接拷貝代碼有時會帶有特殊字符，諸如控制字符會中文空格等，這些字符有時會引起一些不必要的錯誤。