在自動化部署、持續集成、代碼審核系統中,常需程式化調用 SVN 命令。本文提供一個生產級 SvnUtils 類,封裝 ls、copy (分支/標籤)、delete、move、mkdir、diff、checkout 等核心操作,統一異常處理與結果判斷。
<?php
/**
* SVN 命令行封裝工具類
* 依賴:伺服器安裝 subversion 客戶端,PHP 有 exec/shell_exec 權限
* 注意:生產環境請使用 SSH Key 或憑證認證,避免明文密碼
*/
class SvnUtils {
// SVN 認證信息(建議從配置文件/環境變量讀取)
const SVN_USERNAME = 'deploy_user';
const SVN_PASSWORD = 'secure_password_123';
// 配置目錄:解決 "Can't open file '/root/.subversion/servers': Permission denied"
const SVN_CONFIG_DIR = '/var/tmp/svn_config';
/**
* 統一命令執行入口
* @param string $command 完整 shell 命令
* @return array 輸出行數組
*/
private static function runCmd($command) {
// 強制指定配置目錄,避免權限問題
$cmd = "SVN_CONFIG_DIR=" . self::SVN_CONFIG_DIR . " " . $command;
$output = [];
$returnVar = 0;
exec($cmd, $output, $returnVar);
if ($returnVar !== 0) {
error_log("SVN Command Failed [$returnVar]: $cmd\nOutput: " . implode("\n", $output));
}
return $output;
}
/**
* 判斷輸出是否包含成功標誌
*/
private static function isSuccess(array $output, string $keyword = 'Committed revision'): bool {
return (bool) preg_grep("/$keyword/", $output);
}
// ========== 公開 API ==========
/** 列出版本庫內容 */
public static function ls(string $repository): string|false {
$output = self::runCmd("svn ls " . escapeshellarg($repository));
if (preg_grep('/non-existent in that revision/', $output)) return false;
return implode("
", $output);
}
/** 複製(建立分支/標籤) */
public static function copy(string $src, string $dst, string $comment): bool|string {
$cmd = sprintf(
'svn cp %s %s -m %s',
escapeshellarg($src),
escapeshellarg($dst),
escapeshellarg($comment)
);
$output = self::runCmd($cmd);
return self::isSuccess($output) ? true : implode("
", $output);
}
/** 刪除 */
public static function delete(string $url, string $comment): bool|string {
$cmd = sprintf('svn del %s -m %s', escapeshellarg($url), escapeshellarg($comment));
$output = self::runCmd($cmd);
return self::isSuccess($output) ? true : implode("
", $output);
}
/** 移動/重命名 */
public static function move(string $src, string $dst, string $comment): bool|string {
$cmd = sprintf('svn mv %s %s -m %s', escapeshellarg($src), escapeshellarg($dst), escapeshellarg($comment));
$output = self::runCmd($cmd);
return self::isSuccess($output) ? true : implode("
", $output);
}
/** 建立目錄 */
public static function mkdir(string $url, string $comment): bool|string {
$cmd = sprintf('svn mkdir %s -m %s', escapeshellarg($url), escapeshellarg($comment));
$output = self::runCmd($cmd);
return self::isSuccess($output) ? true : implode("
", $output);
}
/** 差異比較 */
public static function diff(string $pathA, string $pathB): string {
$output = self::runCmd("svn diff " . escapeshellarg($pathA) . " " . escapeshellarg($pathB));
return implode("
", $output);
}
/** 檢出 */
public static function checkout(string $url, string $dir): bool|string {
$cmd = sprintf('cd %s && svn co %s', escapeshellarg($dir), escapeshellarg($url));
$output = self::runCmd($cmd);
return (bool) preg_grep('/Checked out revision/', $output) ? true : implode("
", $output);
}
/** 更新 */
public static function update(string $dir): bool|string {
$cmd = sprintf('cd %s && svn up', escapeshellarg($dir));
$output = self::runCmd($cmd);
return (bool) preg_grep('/Updated to revision|At revision/', $output) ? true : implode("
", $output);
}
/** 提交 */
public static function commit(string $dir, string $comment): bool|string {
$cmd = sprintf('cd %s && svn ci -m %s', escapeshellarg($dir), escapeshellarg($comment));
$output = self::runCmd($cmd);
return self::isSuccess($output) ? true : implode("
", $output);
}
/** 獲取日誌 */
public static function log(string $url, int $limit = 10): array {
$output = self::runCmd(sprintf('svn log %s -l %d --xml', escapeshellarg($url), $limit));
$xml = simplexml_load_string(implode("\n", $output));
$logs = [];
if ($xml) {
foreach ($xml->logentry as $entry) {
$logs[] = [
'revision' => (string)$entry['revision'],
'author' => (string)$entry->author,
'date' => (string)$entry->date,
'msg' => (string)$entry->msg
];
}
}
return $logs;
}
}
| 特性 | 實現方式 | 收益 |
|---|---|---|
| 命令注入防護 | 所有用戶輸入經 escapeshellarg() 轉義 | 杜絕命令注入漏洞 |
| 統一錯誤處理 | runCmd() 捕獲返回碼、記錄錯誤日誌 | 可觀測性、便於排查 |
| 配置目錄隔離 | SVN_CONFIG_DIR 指向可寫臨時目錄 | 解決權限報錯、多用戶隔離 |
| 成功判斷標準化 | 關鍵字匹配 Committed revision / Checked out revision | 避免解析輸出文本不穩定 |
| 返回值語義化 | 成功返回 true,失敗返回錯誤信息字串 | 調用方易於 if ($res === true) 判斷 |
<?php
require_once 'SvnUtils.php';
// 建立發布分支
$src = 'svn://svn.example.com/project/trunk';
$dst = 'svn://svn.example.com/project/branches/release-1.0';
$ok = SvnUtils::copy($src, $dst, 'Release 1.0 branch');
if ($ok === true) {
echo "分支建立成功";
} else {
echo "失敗: $ok";
}
// 檢出到部署目錄
$deployDir = '/var/www/project';
$result = SvnUtils::checkout($dst, $deployDir);
// 獲取最近 5 條提交日誌
$logs = SvnUtils::log($dst, 5);
print_r($logs);
?>
subversion 客戶端(yum install subversion / apt-get install subversion)SVN_CONFIG_DIR 指向 /var/tmp/svn_config_<項目名>,確保 PHP 進程用戶可讀寫disable_functions 中的 exec、shell_exec、proc_open(若被禁用需調整或改用 svn PECL 擴展)若不想依賴命令行,可安裝 pecl install svn 使用原生 PHP SVN 函數(svn_checkout(), svn_commit() 等),性能更高、異常處理更優雅,但編譯安裝較麻煩且文檔較少。命令行封裝類適合快速接入、運維腳本、CI/CD 流水線。