WebSVN – qbpwcf-lib(archive) – /trunk/usr/bin/rsync.php

#!/bin/php
<?php

/*
        QBPWCF, Quick Build PHP website Component base on Fedora Linux.
    Copyright (C) 2015~2024 Min-Jhin,Chen

    This file is part of QBPWCF.

    QBPWCF is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    QBPWCF is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with QBPWCF.  If not, see <http://www.gnu.org/licenses/>.
    
*/

/*
說明:
輔助使用rsync指令

範例:
rsync.php --source ~/Downloads/ --target ~/backupOfDownloads/ 
*/

#使用命名空間qbpwcf
namespace qbpwcf;

#以該檔案的實際位置的 lib path 為 include path 首位
exec("cd ".pathinfo(__FILE__)["dirname"]."/../lib;pwd;",$output,$status);
set_include_path($output[0].PATH_SEPARATOR.get_include_path());

#匯入外部套件
include("allInOne.php");

#說明函式
function help()
{
        #印出指令說明
        echo "Usage of ".basename(__FILE__).":".PHP_EOL; 
        echo "--source [path to source] 代表要複製的來源.".PHP_EOL;
        echo "--target [path to target] 代表要複製到的目的地.".PHP_EOL;
        echo "--recursive [on/off] 代表是否要包含目錄底下的所有內容,預設為on.".PHP_EOL;
        echo "--exclude [path to excluded source] 代表要排除指定的檔案或目錄,若有多個請指定多次.".PHP_EOL;
        echo "--excludeFileType [file type to exclude] 代表要排除指定的檔案類型,若有多個請指定多次.".PHP_EOL;
        echo "--bandWidthLimit [transfer bandwidth limit] 代表要指定傳輸的頻寬上限,單為可為K(KB)、M(MB)、G(GB).".PHP_EOL;
        echo "--newFileOnly [on/off] 代表是否只複製來源比目標新的檔案或目錄,預設為off.".PHP_EOL;
        echo "--appendMode [on/off] 代表是否要從檔案尾部新增不足的部分,預設為off.".PHP_EOL;
        
        #結束執行
        exit;
}

#函式說明:
#解析參數.
#回傳結果:
#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
#$reuslt["error"],執行不正常結束的錯訊息陣列.
#$result["function"],當前執行的函式名稱.
#$result["content"],解析好的參數陣列.
#$result["content"][$key][$i],參數 $key 的 $i+1 個參數數值內容.
#$result["program"],字串,執行的程式名稱.
#必填參數:
#無
#可省略參數:
#$conf["helpFunc"],如果解析的參數不成對，則要執行的函式名稱.
$conf["helpFunc"]="help";
#備註:
#僅能在命令列底下執行.
#建議:
#以後可將參數 --a--b 的名稱與後面的數值 $value 存成 $result["a"]["b"][$i]=$value .
$parseArgu=cmd::parseArgu($conf);
unset($conf);

#如果解析參數失敗
if($parseArgu["status"]==="false")
{
        #印出結果
        var_dump($parseArgu);
        
        #結束執行
        exit;
        
}#if end

#檢查參數
#函式說明:
#檢查必填與可省略參數，可省略參數可指定預設要給與什麼數值內容。
#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
#$reuslt["error"],執行不正常結束的錯訊息陣列.
#$result["function"],當前執行的函式名稱.
#$result["passed"],識別要檢查的全體變數是否存在以及型態是否正確的變數,"true"代表檢查全部通過;"false"代表檢查不通過
#$result[$shouldBeCheckedVarName]["varExist"],所檢查的變數是否存在,"false"代表不存在;"true"代表存在
#$result[$shouldBeCheckedVarName]["varType"],所檢查的變數型態是否正確,"false"代表錯誤;"true"代表正確
#$result[$shouldBeCheckedVarName]["error"],每個參數設定的錯誤訊息
#$result["shouldNotBeEmpty"],不應該為空字串或控陣列的變數.
#$result["argu"],字串陣列,目前輸入的參數名稱陣列.
#$result["legalVarName"],字串陣列,合法可用的參數名稱陣列.
#$result["notNeedVar"],字串陣列,多餘的參數名稱.
#必填寫的參數:
#$conf["varInput"],陣列變數,要檢查的陣列變數,請在要檢查的參數前面加上&，這樣變動的結果才能被套用。
$conf["varInput"]=&$parseArgu["content"];
#$conf["referenceVarKey"],字串,$conf參數後面的key值,用於移除不要的參考陣列.
$conf["referenceVarKey"]="variableCheck::checkArguments";
#可以省略的參數:
#$conf["mustBeFilledVariableName"],爲必填參數的變數名稱陣列，形態爲陣列變數，元素數量需要跟"mustBeFilledVariableType"參數的元素數量一致,例如: $conf["mustBeFilledVariableName"] = array("id","account","password");
$conf["mustBeFilledVariableName"]=array("source","target");
#$conf["mustBeFilledVariableType"],爲必填參數的變數陣列應該爲何種變數形態，形態爲陣列,元素數量需要跟"mustBeFilledVariableName"參數的元素數量一致,例如: $conf["mustBeFilledVariableType"] = array("string",integer,"double","resource","object"); , null代表不指定變數形態.
$conf["mustBeFilledVariableType"]=array("array","array");
#$conf["canBeEmptyString"],字串,必填變數內容如果是空字串就不能算是有設置的話，請設為"false",預設爲"true",可以為空字串.
#$conf["canBeEmptyString"]="false";
#$conf["canNotBeEmpty"],字串陣列,哪些必填參數的內容不得為空字串或空陣列,僅當$conf["canBeEmptyString"]為"true"時會生效.
#$conf["canNotBeEmpty"]=array();
#$conf["canBeEmpty"],字串陣列,哪些必填參數的內容可為空字串或空陣列,僅當$conf["canBeEmptyString"]為"false"時會生效.
#$conf["canBeEmpty"]=array();
#$conf["skipableVariableCanNotBeEmpty"],字串陣列,哪些可省略參數不可以為空字串或空陣列.
#$conf["skipableVariableCanNotBeEmpty"]=array("backTime");
#$conf["skipableVariableName"],陣列字串,爲可省略參數的變數名稱陣列，形態爲陣列變數，例如: $conf["skipableVariableName"] = array("id","account","password");
$conf["skipableVariableName"]=array("recursive","exclude","excludeFileType","bandWidthLimit","newFileOnly","appendMode");
#$conf["skipableVariableType"],陣列字串,爲可省略參數的變數名稱陣列，形態爲陣列變數，例如: $conf["skipableVariableType"] = array("string",integer,"double");
$conf["skipableVariableType"]=array("array","array","array","array","array","array");
#$conf["skipableVarDefaultValue"],字串陣列,每個不存在的可省略變數要初始化為什麼,null與代表不指定,若預設值是參數之一，請將$conf["mustBeFilledVar"]改成"\$conf["\mustBeFilledVar\"]".
$conf["skipableVarDefaultValue"]=array(array("on"),null,null,null,array("off"),array("off"));
#$conf["disallowAllSkipableVarIsEmpty"],字串,是否允許每個可省略參數都為空字串,預設為"true"允許,反之為"false".
#$conf["variableCheck::checkArguments"]["disallowAllSkipableVarIsEmpty"]="false";
#$conf["disallowAllSkipableVarIsEmptyArray"],字串,是否允許每個可省略參數都為空陣列,預設為"true"允許,反之為"false".
#$conf["disallowAllSkipableVarIsEmptyArray"]="";
#$conf["arrayCountEqualCheck"],字串陣列,為檢查哪些陣列參數的元素數量要一樣,$conf["arrayCountEqualCheck"][$i]=array()為第$i組key為哪些的變數其元素數量要相等.
#$conf["arrayCountEqualCheck"][]=array();
#參考資料來源:
#array_keys=>http://php.net/manual/en/function.array-keys.php
$checkArguments=variableCheck::checkArguments($conf);
unset($conf);

#若執行失敗
if($checkArguments["status"]==="false"){

        #印出結果
        var_dump($checkArguments);
        
        #結束執行
        exit;

        }#if end

#若檢查不通過
if($checkArguments["passed"]==="false"){

        #debug
        var_dump($checkArguments);

        #提示用法
        help();
        
        #結束執行
        exit;

        }#if end

#取得來源參數
$source=$parseArgu["content"]["source"][0];

#取得目標參數
$target=$parseArgu["content"]["target"][0];

#取得recursive參數
$recursive=$parseArgu["content"]["recursive"][0];

#如果是 "on"
if($recursive==="on"){

        #轉換為 "true"
        $recursive="true";

        }#if end
        
#反之
else{

        #轉換為 "false"
        $recursive="false";

        }#else end

#取得newFileOnly參數
$newFileOnly=$parseArgu["content"]["newFileOnly"][0];

#如果是 "on"
if($newFileOnly==="on"){

        #轉換為 "true"
        $newFileOnly="true";

        }#if end
        
#反之
else{

        #轉換為 "false"
        $newFileOnly="false";

        }#else end

#取得appendMode參數
$appendMode=$parseArgu["content"]["appendMode"][0];

#如果是 "on"
if($appendMode==="on"){

        #轉換為 "true"
        $appendMode="true";

        }#if end
        
#反之
else{

        #轉換為 "false"
        $appendMode="false";

        }#else end
        
#如果有 exclude 參數
if(isset($parseArgu["content"]["exclude"])){

        #設置 exclude 變數
        $exclude=$parseArgu["content"]["exclude"];

        }#if end
        
#如果有 excludeFileType 參數
if(isset($parseArgu["content"]["excludeFileType"])){

        #設置 excludeFileType 變數
        $excludeFileType=$parseArgu["content"]["excludeFileType"];

        }#if end
        
#如果有 bandWidthLimit 參數
if(isset($parseArgu["content"]["bandWidthLimit"])){

        #bandWidthLimit
        $bandWidthLimit=$parseArgu["content"]["bandWidthLimit"][0];

        }#if end

#函式說明:
#使用 linux 的 rsync 指令來進行備份檔案.
#回傳結果:
#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
#$result["error"],錯誤訊息.
#$result["function"],當前執行的函式名稱.
#$result["cmd"],執行的指令.
#必填參數:
#$conf["source"],字串,需要進行備份的目錄或檔案
$conf["source"]=$source;
#$conf["target"],字串,備份到哪個地方或檔案
$conf["target"]=$target;
#$conf["fileArgu"],字串,php變數__FILE__的內容,亦即該檔案在檔案系統的絕對路徑
$conf["fileArgu"]=__FILE__;
#可省略參數:
#$conf["recursive"],字串,"true"代表目標目錄底下的內容都要複製,預設為"false".
$conf["recursive"]=$recursive;

#如果有 $exclude 變數
if(isset($exclude)){

        #$conf["exclude"],字串陣列,每個元素代表要排除的項目,預設不指定.
        $conf["exclude"]=$exclude;

        }#if end

#如果有 $excludeFileType 變數
if(isset($excludeFileType)){

        #$conf["excludeFileType"],字串陣列,每個元素代表要排除的副檔名,預設不指定.
        $conf["excludeFileType"]=$excludeFileType;
        
        }#if end

#如果有 $bandWidthLimit 變數
if(isset($bandWidthLimit)){

        #$conf["bandWidthLimit"],字串,代表頻寬上限,單為可為K、M、G等,預設不指定.
        $conf["bandWidthLimit"]=$bandWidthLimit;

        }#if end

#$conf["newFileOnly"],字串,是否只複製比較新的檔案,預設為"true"代表要;反之為"false".
$conf["newFileOnly"]=$newFileOnly;
#$conf["appendMode"],字串,是否用append的方式複製,適用於檔案內同位置內容一樣的檔案,預設值"false"代表不要;反之為"true".
$conf["appendMode"]=$appendMode;
#參考資料:
#無
#備註:
#無.
$rsync=cmd::rsync($conf);
unset($conf);

#若執行失敗
if($rsync["status"]==="false"){

        #印出結果
        var_dump($rsync);
        
        #結束執行
        exit;

        }#if end
Subversion Repositories qbpwcf-lib(archive)

(root)/trunk/usr/bin/rsync.php – Rev 906
