使用PHP操作SVN基础类

cu_Cbear

使用PHP操作SVN基础类

我不想使用PECL包中php svn扩展，一方面对PHP版本有要求，另外一方面对svn代码包有限制，不过最严重的是：对服务器PHP环境的依赖。

一个基础的svn类，应该实现基本的svn操作，如：checkout、update、commit、copy（最常用到）

【目的】

作为一个码农，写出一个被众人使用的组件、类库总是一件令人兴奋的事情，另外，代码的重用性也提倡将某一个方面的操作使用代码封装。

在自动化软件管理中，将代码从svn获取到当前地点，然后再对代码进行部署，并且通过可视化界面对此流程进行管理，这是个不错的想法。另外，通过对svn的管理，实现对代码版本的管理也是一件很有意义的事情。定期去检查代码，然后通知管理员改动信息，都是很好的想法。

【流程】

我想过从svn的协议部分下手，太过复杂，想我几天内是没有办法把它弄完的。因此，通过PHP的shell_exec()下手是个不错的选择。

1. 
   
2. [php] view plaincopyprint?$result = @shell_exec("svn {$opts}" . $cmd . ' 2> ' . $this->errorfile);  
   
3. $result = @shell_exec("svn {$opts}" . $cmd . ' 2> ' . $this->errorfile);

复制代码

通过php执行shell，可以有各种空间来进行扩展和使用，但是有如下几点需要注意：

【环境依赖】

依赖Linux环境，

对操作目录、临时目录有操作权限

如果是web环境，同时需要保证apache的执行者具有权限。

【错误处理】

在调用SHELL的时候，倘若svn出错（这是不可避免的），错误不会通过标准输出（STDOUT）输出，而是通过标准错误（STDERR）来输出，标准错误不会被PHP捕捉到，但是会被apache或者操作系统捕捉到，造成PHP执行失败和无法显示的问题。

在这里，我选择了利用shell将错误信息重定向到一个临时文件，然后去读取临时文件来判断执行时是否有错误发生。

1. [php] view plaincopyprint?       private function shell($cmd){  
   
2.     $opts = '';  
   
3.     foreach($this->opts as $key => $item){  
   
4.         if(!emptyempty($item)){  
   
5.             $opts .= "--{$key} {$item} ";  
   
6.         }  
   
7.     }  
   
8.     $result = @shell_exec("svn {$opts}" . $cmd . ' 2> ' . $this->errorfile);  
   
9.     if($this->isResultError()){  
   
10.         return false;  
    
11.     }  
    
12.     return $result;  
    
13. }  
    
14.         private function shell($cmd){
    
15.                 $opts = '';
    
16.                 foreach($this->opts as $key => $item){
    
17.                         if(!empty($item)){
    
18.                                 $opts .= "--{$key} {$item} ";
    
19.                         }
    
20.                 }
    
21.                 $result = @shell_exec("svn {$opts}" . $cmd . ' 2> ' . $this->errorfile);
    
22.                 if($this->isResultError()){
    
23.                         return false;
    
24.                 }
    
25.                 return $result;
    
26.         }

复制代码

【选项】

选项包括：svn的用户名和密码，或者存储svn基本数据的目录（当然前提是有权限读取），可以通过设置来进行

1. [php] view plaincopyprint?       public function setOptions($options = array()){  
   
2.     $this->opts = array_merge($this->opts, $options);  
   
3. }  
   
4.         public function setOptions($options = array()){
   
5.                 $this->opts = array_merge($this->opts, $options);
   
6.         }

复制代码

【最终】

通过执行测试 和 phpdoc生成文档，即可完成一个基础类的创建

【开闭原则】

也许你知道，也许也不知道，说实话，我对它的理解仅仅局限于字面上。

使每一个与你共事的同事了解开闭原则是一件很重要的事，它能帮助你编写更多可重用的代码类库。

开（对扩展开放）闭（对修改关闭）保证了代码的可重用性和可维护性。




最后，将整个类库贴上。

1. 
   
2. [php] view plaincopyprint?<?php  
   
3. /**
   
4. * For svn use by php
   
5. *  
   
6. * This class allow you checkout svn files through web
   
7. * And allow you update files
   
8. * I hope in the later version, it can handle commit and other actions
   
9. *  
   
10. * @example
    
11. * <code>
    
12. * $phpsvn = new phpsvn();
    
13. * $phpsvn->setOptions(array(
    
14. *  'username' => 'yourname',
    
15. *  'password' => 'yourpassword'
    
16. * ));
    
17. * $phpsvn->setPath($svnpath, $localpath);
    
18. * $r = $phpsvn->checkout();
    
19. * if($r === false){
    
20. *  echo $phpsvn->error();
    
21. * }else{
    
22. *  print_r($r);
    
23. * }
    
24. * </code>
    
25. * @author hufeng<[email]hufeng@staff.sina.com.cn[/email]>
    
26. * @version v1.0
    
27. * @access sflib
    
28. * @package sflib
    
29. * @category phpsvn
    
30. * @copyright 2012-2013@copyright sflib  
    
31. */  
    
32.   
    
33.   
    
34. class phpsvn  
    
35. {  
    
36.     /**
    
37.      * svn command options
    
38.      *  
    
39.      * @var array
    
40.      */  
    
41.     private $opts = array(  
    
42.         'username' => '',  
    
43.         'password' => '',  
    
44.         'config-dir' => '',  ///usr/home/finance/.subversion   
    
45.     );  
    
46.       
    
47.     /**
    
48.      * error log file
    
49.      *  
    
50.      * Will not save data in this file
    
51.      * Just a tmp file store tmp error message
    
52.      * @var string
    
53.      */  
    
54.     private $errorfile = '/tmp/phpsvn.err';  
    
55.       
    
56.     /**
    
57.      * Error message
    
58.      *  
    
59.      * If no error, error = ''
    
60.      * @var string
    
61.      */  
    
62.     private $error = '';  
    
63.       
    
64.     /**
    
65.      * The value to return
    
66.      *  
    
67.      * @var array
    
68.      */  
    
69.     private $retValue = array();  
    
70.       
    
71.     /**
    
72.      * Svn path
    
73.      *  
    
74.      * @var string
    
75.      */  
    
76.     private $svnpath = '';  
    
77.       
    
78.     /**
    
79.      * Local file path where file stored
    
80.      *  
    
81.      * @var string
    
82.      */  
    
83.     private $targetPath = '.';  
    
84.       
    
85.     /**
    
86.      * actions tags
    
87.      *  
    
88.      * @var array
    
89.      */  
    
90.     private $shortTags = array('a', 'u', 'd');  
    
91.       
    
92.     /**
    
93.      * Set opts of svn command
    
94.      *  
    
95.      * allow opts:
    
96.      * username : your svn username
    
97.      * password : your svn password
    
98.      * config-dir : your execute user config dir
    
99.      * @param array $options
    
100.      */  
     
101.     public function setOptions($options = array()){  
     
102.         $this->opts = array_merge($this->opts, $options);  
     
103.     }  
     
104.       
     
105.     /**
     
106.      * Set svn path & localpath
     
107.      *  
     
108.      * @param string $svnpath svn path
     
109.      * @param string $targetpath local path
     
110.      * @return void
     
111.      */  
     
112.     public function setPath($svnpath, $targetpath = '.'){  
     
113.         $this->svnpath = $svnpath;  
     
114.         $this->targetPath = realpath($targetpath);  
     
115.     }  
     
116.       
     
117.     /**
     
118.      * update from server
     
119.      *  
     
120.      * @return mixed array on success or false on error
     
121.      */  
     
122.     public function update(){  
     
123.         return $this->doCmd('up');  
     
124.     }  
     
125.       
     
126.     /**
     
127.      * commit file to server
     
128.      *  
     
129.      * @return mixed array on success or false on error
     
130.      */  
     
131.     public function commit(){  
     
132.         return $this->doCmd('ci');  
     
133.     }  
     
134.       
     
135.     /**
     
136.      * Add file to svn
     
137.      *  
     
138.      * @param string $file filename
     
139.      * @return mixed array on success or false on error
     
140.      */  
     
141.     public function add($file){  
     
142.         return $this->doCmd('add', $file);  
     
143.     }  
     
144.   
     
145.     /**
     
146.      * Chectout file from svn to local
     
147.      *  
     
148.      * @return mixed array on success or false on error
     
149.      */  
     
150.     public function checkout(){  
     
151.         return $this->doCmd('co', $this->svnpath);  
     
152.         //Checked out revision 240772   
     
153.     }  
     
154.       
     
155.     /**
     
156.      * Execute command for svn
     
157.      *  
     
158.      * support commands:add/checkout(co)/cleanup/commit(ci)/copy(cp)/delete(del,remove,rm)/diff(di)/update (up)
     
159.      * todo commands:export
     
160.      * help (?, h)
     
161.      * import
     
162.      * info
     
163.      * list (ls)
     
164.      * lock
     
165.      * log
     
166.      * merge
     
167.      * mkdir
     
168.      * move (mv, rename, ren)
     
169.      * propdel (pdel, pd)
     
170.      * propedit (pedit, pe)
     
171.      * propget (pget, pg)
     
172.      * proplist (plist, pl)
     
173.      * propset (pset, ps)
     
174.      * resolved
     
175.      * revert
     
176.      * status (stat, st)
     
177.      * switch (sw)
     
178.      * @param string $cmd
     
179.      * @param string $param
     
180.      */  
     
181.     public function doCmd($cmd, $param = ''){  
     
182.         chdir($this->targetPath);  
     
183.         $cmd = "{$cmd} {$param}";  
     
184.         $result = $this->shell($cmd);  
     
185.         return $this->result($result);  
     
186.     }  
     
187.       
     
188.     /**
     
189.      * Error message last time
     
190.      *  
     
191.      * @return string error message
     
192.      */  
     
193.     public function error(){  
     
194.         return $this->error;  
     
195.     }  
     
196.       
     
197.     /**
     
198.      * Format the result handle
     
199.      *  
     
200.      * @param string $result result string
     
201.      * @return string
     
202.      */  
     
203.     private function result($result){  
     
204.         if($result === false){  
     
205.             return false;  
     
206.         }  
     
207.         foreach(explode("\n", $result) as $line){  
     
208.             $line = trim($line);  
     
209.             $this->retLine($line);  
     
210.         }  
     
211.         return $this->retValue;  
     
212.     }  
     
213.       
     
214.     private function retLine($line){  
     
215.         $line = strtolower($line);  
     
216.         if(emptyempty($line)){  
     
217.             return;  
     
218.         }  
     
219.         $retValue = array();  
     
220.         if(in_array($line[0], $this->shortTags)){  
     
221.             $retValue['a'] = $line[0];  
     
222.             $retValue['v'] = trim(substr($line, 2));  
     
223.         }else{  
     
224.             preg_match('/([0-9]+)/', $line, $match);  
     
225.             $num = intval($match[0]);  
     
226.             if($num > 0){  
     
227.                 $retValue['a'] = 'v';  
     
228.                 $retValue['v'] = $num;  
     
229.             }  
     
230.         }  
     
231.         $this->retValue[] = $retValue;  
     
232.     }  
     
233.       
     
234.     /**
     
235.      * Get svn file version from result line
     
236.      *  
     
237.      * @param string $line result line
     
238.      * @return mixed version number or false if on error
     
239.      */  
     
240.     private function getVersionByLine($line){  
     
241.         $line = trim(strtolower($line));  
     
242.         if(preg_match('/([0-9]+)/', $line, $match)){  
     
243.             return $match[0];  
     
244.         }  
     
245.         return false;  
     
246.     }  
     
247.     /**
     
248.      * Exec shell command
     
249.      *  
     
250.      * @access private
     
251.      * @param string $cmd command to be executed
     
252.      * @return string result string should been displayed on stdout,  
     
253.      * @return return false if on error
     
254.      */  
     
255.     private function shell($cmd){  
     
256.         $opts = '';  
     
257.         foreach($this->opts as $key => $item){  
     
258.             if(!emptyempty($item)){  
     
259.                 $opts .= "--{$key} {$item} ";  
     
260.             }  
     
261.         }  
     
262.         $result = @shell_exec("svn {$opts}" . $cmd . ' 2> ' . $this->errorfile);  
     
263.         if($this->isResultError()){  
     
264.             return false;  
     
265.         }  
     
266.         return $result;  
     
267.     }  
     
268.       
     
269.     /**
     
270.      * Check if on error
     
271.      *  
     
272.      * @param string $result shell result string
     
273.      * @return boolen
     
274.      */  
     
275.     private function isResultError(){  
     
276.         $this->error = file_get_contents($this->errorfile);  
     
277.         if(emptyempty($this->error)){  
     
278.             return false;  
     
279.         }  
     
280.         return true;  
     
281.     }  
     
282. }  
     
283.   
     
284. ?>  

复制代码

健康木乃伊

谢谢分享