西数超哥博客
运维经验教程分享的博客

SVN钩子简介和常用钩子说明

一,钩子简介
钩子脚本的具体写法就是操作系统中shell脚本程序的写法,实际就是shell脚本。请根据自己SVN所在的操作系统和shell程序进行相应的写作
所谓钩子就是与一些版本库事件触发的程序,例如新修订版本的创建,或是未版本化属性的修改。每个钩子都会被告知足够多的信息,包括那是什么事件,所操作的对象,和触发事件的用户名。通过钩子的输出或返回状态,钩子程序能让工作继续、停止或是以某种方式挂起。数据发生变化触发钩子。
默认情况下,版本库中,钩子的子目录中包含各种版本库钩子模板。首先,我们进入一个项目的版本库的hooks钩子目录看下模板:

[root@niaoyun43442 svndata]# cd 21yunweinew/hooks/
[root@niaoyun43442 hooks]# ll
total 36
-rw-r--r-- 1 root root 1977 Aug 29 23:39 post-commit.tmpl
-rw-r--r-- 1 root root 1638 Aug 29 23:39 post-lock.tmpl
-rw-r--r-- 1 root root 2289 Aug 29 23:39 post-revprop-change.tmpl
-rw-r--r-- 1 root root 1567 Aug 29 23:39 post-unlock.tmpl
-rw-r--r-- 1 root root 3426 Aug 29 23:39 pre-commit.tmpl
-rw-r--r-- 1 root root 2410 Aug 29 23:39 pre-lock.tmpl
-rw-r--r-- 1 root root 2786 Aug 29 23:39 pre-revprop-change.tmpl
-rw-r--r-- 1 root root 2100 Aug 29 23:39 pre-unlock.tmpl
-rw-r--r-- 1 root root 2780 Aug 29 23:39 start-commit.tmpl

通过查看这些钩子模板,我们可以看到是什么事件触发了脚本和如何给脚本传递数据。使用钩子的时候,我们只需要拷贝对应模板到具体对应文件名(除掉后缀.tmpl)然后编辑即可使用。
提示:
由于安全原因,Subversion版本库在一个空环境中执行钩子脚本—-就是没有任何环境变量,甚至没有$PATH或%PATH%。由于这个原因,许多管理员会感到很困惑,它们的钩子脚本手工运行时正常,可在Subversion中却不能运行。要注意,必须在你的钩子中设置好环境变量或为你的程序指定好绝对路径。

二,常用钩子说明。
目前Subversion有已实现了五种钩子:
1,start-commit
它在提交事务产生前已运行,通常用来判定一个用户是否有权提交。版本库传给该程序两个参数:到版本库的路径,和要进行提交的用户名。如果程序返回一个非零值,会在事务产生前停止该提交操作。如果钩子程序要在stderr中写入数据,它将排队送至客户端。

2,pre-commit
在事务完成提交之前运行,通常这个钩子是用来保护因为内容或位置(例如,你要求所有到一个特定分支的提交必须包括一个bug追踪的ticket号,或者是要求日志信息不为空)而不允许的提交。版本库传递两个参数到程序:版本库的路径和正在提交的事务名称,如果程序返回非零值,提交会失败,事务也会删除。如果钩子程序在stderr中写入了数据,也会传递到客户端。
用途:限制上传文件扩展名以及大小,控制提交要输入的信息等。

Subversion的分发版本包括了一些访问控制脚本(在Subversion源文件目录树的tools/hook-scripts目录),可以用来被pre-commit调用来实现精密的写访问控制。另一个选择是使用Apache的httpd模块mod_authz_svn,可以对单个目录进行读写访问控制(见“每目录访问控制”一节)。在未来的Subversion版本中,我们计划直接在文件系统中实现访问控制列表(ACL)。

3,post-commit
它在事务完成后运行,创建一个新的修订版本。大多数人用这个钩子来发送关于提交的描述性电子邮件,或者作为版本库的备份。版本库传给程序两个参数:到版本库的路径和被创建的新的修订版本号。退出程序会被忽略。
用途:svn更新自动周知,邮件或短信通知;更新出发checkout程序,实时rsync推送到服务器

Subversion分发版本中包括mailer.py和commit-email.pl脚本(存于Subversion源代码树中的 tools/hook-scripts/目录中)可以用来发送描述给定提交的email(并且或只是追加到一个日志文件),这个mail包含变化的路径清单,提交的日志信息、日期和作者以及修改文件的GNU区别样式输出。
,
Subversion提供的另一个有用的工具是hot-backup.py脚本(在Subversion源代码树中的tools/backup/目录中)。这个脚本可以为Subversion版本库进行热备份(Berkeley DB数据库后端支持的一种特性),可以制作版本库每次提交的快照作为归档和紧急情况的备份。

4,pre-revprop-change
因为Subversion的修订版本属性不是版本化的,对这类属性的修改(例如提交日志属性 svn:log)将会永久覆盖以前的属性值。因为数据在此可能丢失,所以Subversion提供了这种钩子(及与之对应的post-revprop- change),因此版本库管理员可用一些外部方法记录变化。作为对丢失未版本化属性数据的防范,Subversion客户端不能远程修改修订版本属性,除非为你的版本库实现这个钩子。
这个钩子在对版本库进行这种修改时才会运行,版本库给钩子传递四个参数:到版本库的路径,要修改属性的修订版本,经过认证的用户名和属性自身的名字。

5,post-revprop-change
我们在前面提到过,这个钩子与pre-revprop-change对应。事实上,因为多疑的原因,只有存在pre-revprop-change时这个脚本才会执行。当这两个钩子都存在时,post-revprop-change在修订版本属性被改变之后运行,通常用来发送包含新属性的email。版本库传递四个参数给该钩子:到版本库的路径,属性存在的修订版本,经过校验的产生变化的用户名,和属性自身的名字。

Subversion分发版本中包含propchange-email.pl脚本(在Subversion源代码树中的tools/hook- scripts/目录中),可以用来发送修订版本属性修改细节的email(并且或只是追加到一个日志文件)。这个email包含修订版本和发生变化的属性名,作出修改的用户和新属性值。

注意:
不要尝试用钩子脚本修改事务。一个常见的例子就是在提交时自动设置svn:eol-style或svn:mime-type这类属性。这看起来是个好主意,但它会引起问题。主要的问题是客户并不知道由钩子脚本进行的修改,同时没有办法通告客户它的数据是过时的,这种矛盾会导致出人意料和不能预测的行为。

作为尝试修改事务的替代,我们通过检查pre-commit钩子的事务,在不满足要求时拒绝提交。
Subversion会试图以当前访问版本库的用户身份执行钩子。通常,对版本库的访问总是通过Apache HTTP服务器和mod_dav_svn进行,因此,执行钩子的用户就是运行Apache的用户。钩子本身需要具有操作系统级的访问许可,用户可以运行它。另外,其它被钩子直接或间接使用的文件或程序(包括Subversion版本库本身)也要被同一个用户访问。换句话说,要注意潜在的访问控制问题,它可能会让你的钩子无法按照你的目的顺利执行

 

文章理论性内容转载于:http://www.cnblogs.com/tdalcn/p/3886567.html

转载请注明:西数超哥博客www.ysidc.top» SVN钩子简介和常用钩子说明

https://www.ysidc.top 西数超哥博客,数据库,西数超哥,虚拟主机,域名注册,域名,云服务器,云主机,云建站,ysidc.top

赞(0) 打赏
声明:本站发布的内容(图片、视频和文字)以原创、转载和分享网络内容为主,若涉及侵权请及时告知,将会在第一时间删除。本站原创内容未经允许不得转载:西数超哥 » SVN钩子简介和常用钩子说明

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

微信扫一扫打赏