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

#!/usr/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/>.
    
*/

/*

備註:
要確認 fileAccess::parseVaraiableInPHPfile 能否解析多個同名的設定成一個陣列

*/

#指派命名空間
namespace qbpwcf;

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

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

#該指令的 help 文件
function help(){

        #印出指令說明
        echo basename($_SERVER["PHP_SELF"])." is a program to kepp sshd running ok.".PHP_EOL;
        echo basename($_SERVER["PHP_SELF"])." usage:".PHP_EOL;
        echo "--ipAndPort [sshd listen ip address and port]".PHP_EOL;
        echo "\texample: 169.254.1.1:22".PHP_EOL;
        echo "--reportOnly [true]".PHP_EOL;
        echo "\tset it to true will only output message, will not try to start or restart service automatically.".PHP_EOL;
        echo "--config addr 代表設定檔的位置,裡面寫需要使用的 ipAndPort 或 reportOnly 變數參數.".PHP_EOL;
        echo "若都沒有參數，則預設會使用 --config /usr/lib/qbpwcf/etc/sshd_config.php 參數.".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"){

        #debug
        var_dump($parseArgu);

        #異常結束執行
        exit(1);

        }#if end

#檢查參數
#函式說明:
#檢查必填與可省略的參數，可省略參數可指定預設要給與什麼數值內容.
#回傳結果:
#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
#$reuslt["error"],執行不正常結束的錯訊息陣列.
#$result["function"],當前執行的函式名稱.
#$result["argu"],設置給予的參數.
#$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("");
#$conf["mustBeFilledVariableType"],爲必填參數的變數陣列應該爲何種變數形態，形態爲陣列,元素數量需要跟"mustBeFilledVariableName"參數的元素數量一致,例如: $conf["mustBeFilledVariableType"] = array("string",integer,"double","resource","object"); , null代表不指定變數形態.
#$conf["mustBeFilledVariableType"]=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("ipAndPort","reportOnly","config");
#$conf["skipableVariableName"],陣列字串,爲可省略參數的變數名稱陣列，形態爲陣列變數，例如: $conf["skipableVariableName"] = array("id","account","password");
$conf["skipableVariableName"]=array("ipAndPort","reportOnly","config");
#$conf["skipableVariableType"],陣列字串,爲可省略參數的變數名稱陣列，形態爲陣列變數，例如: $conf["skipableVariableType"] = array("string",integer,"double");
$conf["skipableVariableType"]=array("string","string","string");
#$conf["skipableVarDefaultValue"],字串陣列,每個不存在的可省略變數要初始化為什麼,null與代表不指定,若預設值是參數之一，請將$conf["mustBeFilledVar"]改成"\$conf["\mustBeFilledVar\"]".
$conf["skipableVarDefaultValue"]=array(null,null,null);
#$conf["disallowAllSkipableVarIsEmpty"],字串,是否允許每個可省略參數都為空字串,預設為"true"允許,反之為"false".
#$conf["disallowAllSkipableVarIsEmpty"]="";
#$conf["disallowAllSkipableVarIsEmptyArray"],字串,是否允許每個可省略參數都為空陣列,預設為"true"允許,反之為"false".
#$conf["disallowAllSkipableVarIsEmptyArray"]="";
#$conf["arrayCountEqualCheck"],字串陣列,為檢查哪些陣列參數的元素數量要一樣,$conf["arrayCountEqualCheck"][$i]=array()為第$i組key為哪些的變數其元素數量要相等.
#$conf["arrayCountEqualCheck"][]=array("rootPath","name","mode","ip","dbAcct","dbPass","dbName","dbAddr","dbPort","headless");
#參考資料:
#array_keys=>http://php.net/manual/en/function.array-keys.php
#備註:
#無.
$checkArguments=variableCheck::checkArguments($conf);
unset($conf);

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

        #debug
        var_dump($checkArguments);

        #異常結束執行
        exit(1);

        }#if end

#初始化 $checkListen 參數
$checkListen=array();

#如果有設置參數
if(count($parseArgu["content"])>0){

        #如果有 ipAndPort 參數
        if(isset($parseArgu["content"]["ipAndPort"])){
        
                #針對每個條件
                foreach($parseArgu["content"]["ipAndPort"] as $ipAndPort){
                
                        #增加參數
                        $checkListen[]=array("ip"=>$ipAndPort."/tcp");
                
                        }#foreach end
        
                }#if end
                
        #如果有 reportOnly 參數
        if(isset($parseArgu["content"]["reportOnly"])){
        
                #針對每個條件
                foreach($parseArgu["content"]["reportOnly"] as $reportOnly){
                
                        #設置 reportOnly 參數要啟用
                        $reportOnly="true";
                
                        }#foreach end
                
                }#if end
                
        #如果有 config 參數
        if(isset($parseArgu["content"]["config"])){
        
                #針對每個條件
                foreach($parseArgu["content"]["config"] as $config){
                
                        #取得設定檔內容
                        #函式說明:
                        #解析PHP檔案裡面的變數.
                        #回傳結果:
                        #$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
                        #$result["error"],錯誤訊息.
                        #$result["function"],當前執行的函數名稱.
                        #$result["argu"],所使用的參數.    
                        #$result["content"],找到的變數內容陣列.
                        #$result["content"]["value"],依找到變數順序的數值.
                        #$result["content"]["struc"],依找到變數順序的階層結構.
                        #$result["content"]["direct"],變數名稱對應的數值內容.
                        #必填參數:
                        #$conf["file"],字串,檔案的路徑與名稱.
                        $conf["file"]=$config;
                        #$conf["fileArgu"],字串,php變數__FILE__的內容,亦即該檔案在檔案系統的絕對路徑
                        $conf["fileArgu"]=__FILE__;
                        #$conf["varName"],字串陣列,要搜尋的變數名稱,例如要搜尋變數$email則輸入"email".
                        $conf["varName"]=array("ipAndPort","reportOnly");
                        #可省略參數:
                        #$conf["web"],是要取得網路上的檔案則為"true";反之則為"false",預設為"false".
                        $conf["web"]="false";
                        #參考資料:
                        #https://www.php.net/manual/en/function.parse-str.php
                        #備註:
                        #無.
                        $parseVaraiableInPHPfile=fileAccess::parseVaraiableInPHPfile($conf);
                        unset($conf);
                        
                        #如果失敗
                        if($parseVaraiableInPHPfile["status"]==="false"){
                        
                                #印出結果
                                var_dump($parseVaraiableInPHPfile);
                                
                                #結束執行
                                exit;
                        
                                }#if end
                
                        #針對每個 ipAndPort 參數
                        foreach($parseVaraiableInPHPfile["content"]["ipAndPort"] as $ipAndPort){
                        
                                #增加參數
                                $checkListen[]=array("ip"=>$ipAndPort."/tcp");
                        
                                }#foreach end
                        
                        #針對每個 reportOnly 參數
                        foreach($parseVaraiableInPHPfile["content"]["reportOnly"] as $reportOnly){
                        
                                #設置 reportOnly 參數要啟用
                                $reportOnly="true";
                        
                                }#foreach end
                
                        }#foreach end
        
                }#if end

        }#if end

#反之
else{

        #嘗試從 /usr/lib/qbpwcf/etc/sshd_config.php 取得設定
        
        #預設的設定檔案位置
        $defaultConfigAddr="/usr/lib/qbpwcf/etc/sshd_config.php";
        
        #取得設定檔內容
        #函式說明:
        #解析PHP檔案裡面的變數.
        #回傳結果:
        #$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
        #$result["error"],錯誤訊息.
        #$result["function"],當前執行的函數名稱.
        #$result["argu"],所使用的參數.    
        #$result["content"],找到的變數內容陣列.
        #$result["content"]["value"],依找到變數順序的數值.
        #$result["content"]["struc"],依找到變數順序的階層結構.
        #$result["content"]["direct"],變數名稱對應的數值內容.
        #必填參數:
        #$conf["file"],字串,檔案的路徑與名稱.
        $conf["file"]=$defaultConfigAddr;
        #$conf["fileArgu"],字串,php變數__FILE__的內容,亦即該檔案在檔案系統的絕對路徑
        $conf["fileArgu"]=__FILE__;
        #$conf["varName"],字串陣列,要搜尋的變數名稱,例如要搜尋變數$email則輸入"email".
        $conf["varName"]=array("ipAndPort","reportOnly","verbose");
        #可省略參數:
        #$conf["web"],是要取得網路上的檔案則為"true";反之則為"false",預設為"false".
        $conf["web"]="false";
        #參考資料:
        #https://www.php.net/manual/en/function.parse-str.php
        #備註:
        #無.
        $parseVaraiableInPHPfile=fileAccess::parseVaraiableInPHPfile($conf);
        unset($conf);
        
        #exit
        #var_dump(__LINE__,$parseVaraiableInPHPfile);
        
        #如果失敗
        if($parseVaraiableInPHPfile["status"]==="false"){
        
                #印出結果
                var_dump($parseVaraiableInPHPfile);
                
                #結束執行
                exit;
        
                }#if end

        #如果有指定 ipAndPort
        if(isset($parseVaraiableInPHPfile["content"]["ipAndPort"])){

                #針對每個 ipAndPort 參數
                foreach($parseVaraiableInPHPfile["content"]["ipAndPort"] as $ipAndPort){
                
                        #增加參數
                        $checkListen[]=array("ip"=>$ipAndPort."/tcp");
                
                        }#foreach end
                        
                }#if end
        
        #如果有指定 reportOnly
        if(isset($parseVaraiableInPHPfile["content"]["reportOnly"])){
        
                #針對每個 reportOnly 參數
                foreach($parseVaraiableInPHPfile["content"]["reportOnly"] as $reportOnly){
                
                        #設置 reportOnly 參數要啟用
                        $reportOnly="true";
                
                        }#foreach end
                        
                }#if end
                
        #如果有指定 verbose
        if(isset($parseVaraiableInPHPfile["content"]["verbose"])){
        
                #針對每個 verbose 參數
                foreach($parseVaraiableInPHPfile["content"]["verbose"] as $verbose){
                
                        #設置 reportOnly 參數要啟用
                        $verbose="true";
                
                        }#foreach end
                        
                }#if end
        
        }#else end

#函式說明:
#執行 systemd 程序來確保服務是運行中.
#回傳結果:
#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
#$result["error"],錯誤訊息.
#$result["function"],當前執行的函式名稱.
#$result["argu"],所使用的參數.
#$result["content"],執行的結果.
#必填參數:
#$conf["fileArgu"],字串,php變數__FILE__的內容,亦即該檔案在檔案系統的絕對路徑.
$conf["fileArgu"]=__FILE__;
#$conf["name"],字串,服務名稱.
$conf["name"]="sshd";
#可省略參數:
#$conf["username"],字串,要用什麼使用者來執行,預設為root使用者
#$conf["username"]="";
#$conf["password"],字串,使用者的密碼,預設不使用.
#$conf["password"]="";

if(count($checkListen)>0){

        #$conf["checkListen"],陣列,用來判斷服務是否有正確啟動的條件,一個元素代表,其中要有一個socket info符合之,若元素的key為"ip"，則其數值為[ipv4/ipv6]:port:protocol(tcp/udp);若元素的key為"addr",則其數值為unix domain socket 的位置與名稱;若元素的key為"name",則其數值為程序名稱.
        $conf["checkListen"]=$checkListen;

        }#if end

#$conf["interval"],字串,檢查沒問題後,要多少秒後再檢查一次,預設為30秒，亦即"30".
#$conf["interval"]="30";

#如果有 reportOnly 參數
if(isset($reportOnly)){

        #$conf["reportOnly"],字串,"true"代表不「啟動/重新啟動」服務,只是輸出訊息表示服務有正常或需要處理;預設為"false"代表直接「啟動/重新啟動」.
        $conf["reportOnly"]=$reportOnly;

        }#if end

#如果有 verbose 參數
if(isset($verbose)){

        #$conf["verbose"],字串,預設為"false",若為"true"則會印出過程訊息.
        $conf["verbose"]=$verbose;

        }#if end

#參考資料:
#無.
#備註:
#無.
$keepServiceUp=cmd::keepServiceUp($conf);
unset($conf);

#debug
var_dump($keepServiceUp);

?>
Subversion Repositories qbpwcf-lib(archive)

(root)/trunk/usr/bin/keepSshd.php – Rev 620
