WebSVN – php-qbpwcf – /trunk/usr/bin/sslUpdater.php

#!/usr/bin/php
<?php

/*
        QBPWCF, Quick Build PHP website Component base on Fedora Linux.
    Copyright (C) 2014~2026 MIN ZHI, 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/>.

*/

/*
透過zerossl api確保ssl沒有過期.
*/

#指派命名空間
namespace qbpwcf;

#取得 lib path
exec("php -f ".escapeshellarg(pathinfo(__FILE__)["dirname"]."/libexec/folderOfUsrLib.php"),$output,$status);

#如果執行失敗
if($status!==0){

        #debug
        var_dump(__LINE__,$output);

        #結束執行,回傳shell 1.
        exit(1);

        }#if end

#儲存lib path
$folderOfUsrLib=$output[0];

#以該檔案的實際位置的 lib path 為 include path 首位
$output=array();
exec("cd ".escapeshellarg(pathinfo(__FILE__)["dirname"]."/../".$folderOfUsrLib."/qbpwcf").";pwd;",$output,$status);

#如果執行失敗
if($status!==0){

        #debug
        var_dump(__LINE__,$output);

        #結束執行,回傳shell 1.
        exit(1);

        }#if end

#設置 include path
set_include_path($output[0].PATH_SEPARATOR.get_include_path());

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

#當前lib路徑
$pwd=$output[0];

#unix socket 的位置
$unixSocket=$pwd."/../../../var/qbpwcf/".basename(__FILE__).".sock";

#說明函式
function help(){

        #印出指令說明
        echo "Usage of ".basename(__FILE__).":".PHP_EOL;
        echo "--sock [sslUpdater socket] unix domain socket 的位置與名稱,預設為相對於 QBPWCF套件的 \"/var/qbpwcf/sslUpdater.sock\"".PHP_EOL;
        echo "--daemon [\"on\"] 代表是要運行 server 端程式.".PHP_EOL;
        echo "--config [config file apth] 指定設定檔案的位置,預設為 相對於QBPWCF套件的 \"/etc/qbpwcf/sslUpdater.php\" 位置.".PHP_EOL;
        echo "\tconfig 檔案的格式為一個網域名稱搭配一組變數".PHP_EOL;
        echo "--multiThreads [\"on\"] 代表要啟用多執行序".PHP_EOL;
        echo "--debug [\"on\"] 代表要開啟 debug 模式.".PHP_EOL;
        
        #結束執行
        exit;

        }#function help end
        
#函式說明:
#解析參數.
#回傳結果:
#$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(1);

        }#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("sock",);
#$conf["mustBeFilledVariableType"],爲必填參數的變數陣列應該爲何種變數形態，形態爲陣列,元素數量需要跟"mustBeFilledVariableName"參數的元素數量一致,例如: $conf["mustBeFilledVariableType"] = array("string",integer,"double","resource","object"); , null代表不指定變數形態.
#$conf["mustBeFilledVariableType"]=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("sock","daemon","config","debug","multiThreads");
#$conf["skipableVariableName"],陣列字串,爲可省略參數的變數名稱陣列，形態爲陣列變數，例如: $conf["skipableVariableName"] = array("id","account","password");
$conf["skipableVariableName"]=array("sock","daemon","config","debug","multiThreads");
#$conf["skipableVariableType"],陣列字串,爲可省略參數的變數名稱陣列，形態爲陣列變數，例如: $conf["skipableVariableType"] = array("string",integer,"double");
$conf["skipableVariableType"]=array("array","array","array","array","array");
#$conf["skipableVarDefaultValue"],字串陣列,每個不存在的可省略變數要初始化為什麼,null與代表不指定,若預設值是參數之一，請將$conf["mustBeFilledVar"]改成"\$conf["\mustBeFilledVar\"]".
$conf["skipableVarDefaultValue"]=array(array(null),array(null),array($pwd."/../../../etc/qbpwcf/sslUpdater.php"),array("on"),array(null));
#$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(1);

        }#if end

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

        #印出結果
        var_dump($checkArguments);

        #結束執行
        exit(1);

        }#if end

#取得debug flag
$debug=$parseArgu["content"]["debug"][0];

#如果是 debug 模式
if($debug==="on"){

        #設置為 true
        $debug=true;

        }#if end

#反之
else{

        #設置為 false
        $debug=false;

        }#else end

#取得設定檔案路徑與名稱
$config=$parseArgu["content"]["config"][0];

#檢查設定檔案是否存在
#函式說明:
#檢查多個檔案與資料夾是否存在.
#回傳的結果:
#$result["status"],執行正常與否,"true"代表正常,"false"代表不正常.
#$result["error"],錯誤訊息陣列.
#$resutl["function"],當前執行的涵式名稱.
#$result["argu"],使用的參數.
#$result["allExist"],所有檔案皆存在的識別,"true"代表皆存在,"false"代表沒有全部都存在.
#$result["varName"][$i]，爲第$i個資料夾或檔案的路徑與名稱。
#$result["varNameFullPath"][$i],爲第$i個資料夾或檔案的完整檔案系統路徑與名稱,如果不存在則代表路徑是網址.
#$result["varNameWebPath"][$i],為第$i個資料夾或檔案的網址,若"web"參數為"true",才會有該內容.
#$result["varExist"][$i]，爲第$i個資料夾或檔案是否存在，"true"代表存在，"false"代表不存在。
#必填參數:
#$conf["fileArray"],陣列字串,要檢查是否存在的檔案有哪些，須爲一維陣列數值。
$conf["fileArray"]=array($config);
#$conf["fileArgu"],字串,php變數__FILE__的內容,亦即該檔案在檔案系統的絕對路徑
$conf["fileArgu"]=__FILE__;
#可省略參數:
#$conf["disableWebSearch"],"字串",是否取消「當檔案找不到時,改用catchWebContent類別的wget函數來檢查檔案是否存在於網路上」的功能,"false"不取消,若要取消該功能請設為"true",若抓到的內容為空字串則會視為檔案不存在,預設為"true".
$conf["disableWebSearch"]="true";
#$conf["userDir"],字串,網頁是否置放於家目錄底下,"true"為是,"false"為不是,預設為"true".
$conf["userDir"]="false";
#$conf["web"],字串,檔案是放在web就是"true",反之為檔案系統"false",預設為"true".
$conf["web"]="false";
#參考資料:
#http://php.net/manual/en/function.file-exists.php
#http://php.net/manual/en/control-structures.foreach.php
#備註:
#函數file_exists檢查的路徑為檔案系統的路徑
#$result["varName"][$i]結果未實作
$checkMultiFileExist=fileAccess::checkMultiFileExist($conf);
unset($conf);

#若執行異常
if($checkMultiFileExist["status"]==="false"){

        #印出結果
        var_dump($checkMultiFileExist);

        #結束執行
        exit(1);

        }#if end
        
#若設定檔案不存在
if($checkMultiFileExist["allExist"]==="false"){

        #印出結果
        var_dump($checkMultiFileExist);

        #結束執行
        exit(1);

        }#if end

#載入設定檔案
#函式說明:
#解析PHP檔案裡面的變數.
#回傳結果:
#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
#$result["error"],錯誤訊息.
#$result["function"],當前執行的函數名稱.
#$result["argu"],所使用的參數.
#$result["content"],找到的變數內容陣列,若有多個變數則會用array來表示.
#必填參數:
#$conf["file"],字串,檔案的路徑與名稱.
$conf["file"]=$config;
#$conf["fileArgu"],字串,php變數__FILE__的內容,亦即該檔案在檔案系統的絕對路徑
$conf["fileArgu"]=__FILE__;
#$conf["varName"],字串陣列,要搜尋的變數名稱,例如要搜尋變數$email則輸入"email".
$conf["varName"]=array("domainName","certificatePath","privateKey","ca_bundlePath","cert_and_ca_bundle_path","RR_file_path","dns_server_addr","action_after_update_certs");
#可省略參數:
#$conf["web"],是要取得網路上的檔案則為"true";反之則為"false",預設為"false".
$conf["web"]="false";
#$conf["allVarCountSame"],字串,是否每個參數的數量要一致,預設為"false"不要;反之為"true"代表要.
$conf["allVarCountSame"]="true";
#參考資料:
#https://www.php.net/manual/en/function.parse-str.php
#備註:
#無.
$parseVaraiableInPHPfile=fileAccess::parseVaraiableInPHPfile($conf);
unset($conf);

#如果執行異常
if($parseVaraiableInPHPfile["status"]==="false"){

        #印出結果
        var_dump($parseVaraiableInPHPfile);

        #結束執行
        exit(1);

        }#if end

#有多少個 domain name 要處理就執行幾次
for($i=0;$i<count($parseVaraiableInPHPfile["content"]["domainName"]);$i++){

        #設置 cname
        $conf["cName"][]=$parseVaraiableInPHPfile["content"]["domainName"][$i];

        #設置 certPath
        $conf["certInfo"][$i]["certPath"]=$parseVaraiableInPHPfile["content"]["certificatePath"][$i];
        
        #設置 pKey
        $conf["certInfo"][$i]["pKey"]=$parseVaraiableInPHPfile["content"]["privateKey"][$i];
        
        #設置 caPath
        $conf["certInfo"][$i]["caPath"]=$parseVaraiableInPHPfile["content"]["ca_bundlePath"][$i];
        
        #設置 certWithCaPath
        $conf["certInfo"][$i]["certWithCaPath"]=$parseVaraiableInPHPfile["content"]["cert_and_ca_bundle_path"][$i];
        
        #設置 rrFile
        $conf["rrFile"][]=$parseVaraiableInPHPfile["content"]["RR_file_path"][$i];
        
        #設置 dnsSerAddr
        $conf["dnsSerAddr"][]=$parseVaraiableInPHPfile["content"]["dns_server_addr"][$i];

        #設置 actionAfterUpdateCert
        $conf["actionAfterUpdateCert"][]=$parseVaraiableInPHPfile["content"]["action_after_update_certs"][$i];

        }#for end

#if enable debug
if($debug){

        echo "serivce config data:".PHP_EOL;
        
        #debug
        var_dump($conf);

        }#if end

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

        #取得 unix domain socket 的位置
        $sock=$parseArgu["content"]["sock"][0];

        }#if end

#取得 daemon 參數的內容
$dameon=$parseArgu["content"]["daemon"][0];

#如果為 "on"
if($dameon==="on"){

        #if enable debug
        if($debug){

                #設定 debug 參數
                $conf["debug"]="true";

                }#if end

        #如果有設置 sock
        if(isset($sock)){
        
                #設置 sock 參數
                $conf["sock"]=$sock;
        
                }#if end

        #取得多執行序的要求與否
        $multiThreads=$parseArgu["content"]["multiThreads"][0];
        
        #如果有啟用多執行序
        if($multiThreads==="on"){
        
                #設置 multiThreads 參數
                $conf["multiThreads"]="true";
        
                }#if end

        #函式說明:
        #透過zerossl api確保ssl沒有過期.
        #回傳結果:
        #$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
        #$reuslt["error"],執行不正常結束的錯訊息陣列.
        #$result["function"],當前執行的函式名稱.
        #$result["argu"],所使用的參數.
        #必填參數:
        #$conf["cName"],陣列,每個ssl的common domain name.
        #$conf["cName"]=array();
        #$conf["certInfo"],陣列,每個cName參數對應的憑證資訊,$conf["certInfo"][$i]["certPath"]為第$+1個cName的certifate.crt的檔案位置與名稱;$conf["certInfo"][$i]["pKey"]為第$i+1個cName的private key;$conf["certInfo"][$i]["caPath"]為第$i+1個cName的ca_bundle.crt的檔案位置與名稱;$conf["certInfo"][$i]["certWithCaPath"]為第$+1個cName的certifate.crt跟ca_bundle.crt內容合併後的檔案位置與名稱.
        #$conf["certInfo"]=array();
        #$conf["rrFile"],陣列,每個cName參數對應的RR檔案路徑與名稱.
        #$conf["rrFile"]=array();
        #$conf["dnsSerAddr"],陣列,每個cName參數對應的dns server位置,亦即ip或dns,用於透過root@dnsSerAddr將dns server重新啟動.
        #$conf["dnsSerAddr"]=array();
        #$conf["actionAfterUpdateCert"],陣列,每個元素代表對應cName所屬的憑證更新後要執行的指令,例如重新啟動apache(array("systemctl","restart","httpd").若要執行多個指令,用陣列表示即可,例如重新啟動apache跟qbpwcf-wss(array(array("systemctl","restart","httpd"),array("podman","restart","qbpwcf-wss")).
        #$conf["actionAfterUpdateCert"]=array();
        #可省略參數:
        #$conf["apiDomain"],字串,提供服務的domain,預設為 self::getApiInfo()["doamin"].
        #$conf["apiDomain"]=self::getApiInfo()["doamin"];
        #$conf["key"],字串,api key,預設為 self::getApiInfo()["apiKey"].
        #$conf["key"]=self::getApiInfo()["apiKey"];
        #$conf["debug"],字串,是否要開啟debug模式,"true"代表要;反之為預設"false"代表不要.
        #$conf["debug"]="";
        #$conf["addOnProcessFunc"],陣列,收到訊息後,要依順執行的函式,預設為array("\qbpwcf\zerosll::sslUpdater_cmd").
        #$conf["addOnProcessFunc"]=array();
        #$conf["funcToRunWhenIdle"],陣列,閒置時要依序執行的函式,預設為array("/qbpwcf/zerossl::sslUpdater_idle");
        #$conf["funcToRunWhenIdle"]=array();
        #參考資料:
        #無.
        #備註:
        #無.
        $sslUpdater=zerossl::sslUpdater($conf);
        unset($conf);

        #如果執行異常
        if($sslUpdater["status"]==="false"){

                #印出結果
                var_dump($sslUpdater);

                #結束執行
                exit(1);

                }#if end

        }#if end
Subversion Repositories php-qbpwcf

(root)/trunk/usr/bin/sslUpdater.php – Rev 293
