Subversion Repositories php-qbpwcf

Rev

Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | RSS feed

#!/usr/bin/php
<?php

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

/*
說明:
一次檢查多個節點是否存在,存在的node清單會以jsone格式印出.

範例:

檢查名為 nodoeToCheckExist 的節點(檔案/目錄)是否存在
checkNodeExist.php --node nodoeToCheckExist

檢查名為 nodoeToCheckExist 的節點(檔案/目錄)是否存在於路徑 ./path 底下
checkNodeExist.php --node ./path/nodoeToCheckExist

*/

#使用命名空間qbpwcf
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");

#說明函式
function help(){

        #印出指令說明
        echo "Usage of ".basename(__FILE__).":".PHP_EOL; 
        echo "--node [path/node] 代表要確認位於 path 底下的 node 是否存在".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);
        
        #結束執行,回傳shell 1,代表異常.
        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("backupAddr");
#$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("backTime");
#$conf["skipableVariableName"],陣列字串,爲可省略參數的變數名稱陣列,形態爲陣列變數,例如: $conf["skipableVariableName"] = array("id","account","password");
$conf["skipableVariableName"]=array("node");
#$conf["skipableVariableType"],陣列字串,爲可省略參數的變數名稱陣列,形態爲陣列變數,例如: $conf["skipableVariableType"] = array("string",integer,"double");
$conf["skipableVariableType"]=array("array");
#$conf["skipableVarDefaultValue"],字串陣列,每個不存在的可省略變數要初始化為什麼,null與代表不指定,若預設值是參數之一,請將$conf["mustBeFilledVar"]改成"\$conf["\mustBeFilledVar\"]".
$conf["skipableVarDefaultValue"]=array(null);
#$conf["disallowAllSkipableVarIsEmpty"],字串,是否允許每個可省略參數都為空字串,預設為"true"允許,反之為"false".
#$conf["variableCheck::checkArguments"]["disallowAllSkipableVarIsEmpty"]="false";
#$conf["disallowAllSkipableVarIsEmptyArray"],字串,是否允許每個可省略參數都為空陣列,預設為"true"允許,反之為"false".
#$conf["disallowAllSkipableVarIsEmptyArray"]="";
#$conf["disallowAllSkipableVarNotExist"],字串,是否不允許每個可省略參數都不存在,預設為"false"代表允許,反之為"true".
$conf["disallowAllSkipableVarNotExist"]="true";
#$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);
        
        #結束執行,回傳shell 1,代表異常.
        exit(1);

        }#if end

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

        #印出結果
        #var_dump($checkArguments);
        
        #提示用法
        help();
        
        #結束執行
        exit;

        }#if end

#初始化儲存運行的 proc資訊 
$procs=array();
        
#針對每個 node 參數
foreach($parseArgu["content"]["node"] as $node){

        #函式說明:
        #用shell檢查檔案是否存在,可以指定查詢時用的身份.
        #回傳的結果:
        #$result["status"],執行是否成功,"true"代表成功,"false"代表失敗.
        #$result["function"],當前執行的函式名稱.
        #$result["error"],錯誤訊息陣列.
        #$result["founded"],"true"代表有找到檔案,"false"代表沒有找到檔案,"?"代表沒有執行指令.
        #$result["cmdStr"],查詢檔案是否存在的指令與參數字串.
        #$result["escapedCmdArray"],陣列,儲存重新排序過且已經escape過的指令(key為"cmd")與參數(key為"argu")與兩者組合的一維陣列(key為"array").
        #必填參數:
        #$conf["fileName"],字串,要檢查的檔案名稱.
        $conf["cmd::checkFileExist"]["fileName"]=$node;
        #$conf["fileArgu"],字串,__FILE__的內容,預設為當前檔案的位置.
        $conf["cmd::checkFileExist"]["fileArgu"]=__FILE__;
        #可省略參數:
        #$conf["username"],字串,要用哪個身份來檢查檔案是否存在,預設不使用.
        #$conf["username"]="";
        #$conf["password"],字串,要用哪個身份來檢查檔案是否存在,預設不使用,若沒有設定好不用密碼即可登入,則在web端會直接出錯,在命令列則會提示輸入密碼.
        #$conf["password"]="";
        #$conf["getCmdOnly"],字串,若不要執行指令,只要取得要執行的指令,則設置為"true";反之為預設值"false".
        $conf["cmd::checkFileExist"]["getCmdOnly"]="true";
        #參考資料:
        #無.
        #備註:
        #僅能在命令列環境下執行.
        $checkFileExist=cmd::checkFileExist($conf["cmd::checkFileExist"]);
        unset($conf["cmd::checkFileExist"]);

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

                #印出結果
                var_dump($checkFileExist);
                
                #結束執行,回傳shell 1,代表異常.
                exit(1);

                }#if end

        #函式說明:
        #透過proc來多執行序運作.
        #回傳結果:
        #$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
        #$reuslt["error"],執行不正常結束的錯訊息陣列.
        #$result["function"],當前執行的函式名稱.
        #$result["argu"],使用的參數.
        #$result["content"],陣列,每個元素為其指令執行的結果訊息陣列,key為"status"代表執行是否正常的識別;key為"statusCode"代表程式結束後回傳給對應executeBy程式的數值;key為"output"代表標準輸出,若為resource,則代表為pipe;key為"error"代表非標準輸出,若為resource,則代表為pipe;key為"input"代表成功輸入的指令;key為"process"代表該程序經proc_open後的process source;key為"proc_get_status"代表程序的資訊.
        #必填參數:
        #$conf["cmds"],字串陣列,每個元素代表要執行的指令與參數.
        $conf["threads::proc"]["cmds"]=array($checkFileExist["cmdStr"]);
        #可省略參數:
        #$conf["wait"],字串,是否需要等待所有程序結束,預設為"true"要等待;反之為"false"不要等待.
        $conf["threads::proc"]["wait"]="false";
        #$conf["workingDir"],字串陣列,個別程式執行時的家目錄,預設不指定.
        #$conf["workingDir"]=array("path");
        #$conf["envs"],2維字串陣列,每個元素代表個別程式執行時的指定環境變數,key變數名稱;value為變數內容.預設為array("QBPWCF" => "Quick Build PHP Website Componment base on Fedora Linux");
        #$conf["envs"]=array(array("key"=>"value"));
        #$conf["executeBy"],字串陣列,每個元素代表個別指令要用什麼程式執行,預設為"bash".
        #$conf["executeBy"]=array("bash");
        #參考資料:
        #https://www.php.net/manual/en/function.proc-open.php
        #https://www.php.net/manual/en/function.proc-get-status.php
        #備註:
        #若需要取得當下的執行狀況,請使用 self::proc_update 來更新.
        $proc=threads::proc($conf["threads::proc"]);
        unset($conf["threads::proc"]);

        #如果異常
        if($proc["status"]==="false"){
        
                #印出結果
                var_dump($proc);
                
                #結束執行,回傳shell 1,代表異常.
                exit(1);
        
                }#if end

        #儲存執行的proc資訊
        $procs[]=$proc;
        
        #記錄查詢的node資訊
        $nodes2check[]=$node;

        }#if end

#初始化記錄執行正常的 proc 程序
$success_procs=array();

#初始化記錄執行失敗的 proc 程序
$error_procs=array();

#初始化記錄找到的node清單
$found_node=array();

#初始化記錄沒有找到的node清單
$not_found_node=array();

#無窮迴圈
while(true){
        
        #針對每個 proc 資訊
        foreach($procs as $pIndex => $proc){
        
                #函式說明:
                #更新透過proc執行的多程序資訊.
                #回傳結果:
                #$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
                #$reuslt["error"],執行不正常結束的錯訊息陣列.
                #$result["function"],當前執行的函式名稱.
                #$result["argu"],使用的參數.
                #$result["content"],陣列,每個元素為其指令執行的結果訊息陣列,key為"status"代表執行是否正常的識別;key為"statusCode"代表程式結束後回傳給對應executeBy程式的數值,若為"?"則代表程序尚未結束,可透過proc_update函式進行資訊的更新與取得;key為"output"代表標準輸出,若為resource,則代表為pipe;key為"error"代表非標準輸出,若為resource,則代表為pipe;key為"input"代表成功輸入的指令;key為"process"代表該程序經proc_open後的process source;key為"proc_get_status"代表程序的資訊.
                #必填參數:
                #$conf["procs"],陣列,運行self::proc後回傳的content.
                $conf["threads::proc_update"]["procs"]=$proc["content"];
                #可省略參數:
                #無.
                #參考資料:
                #無.
                #備註:
                #無.
                $proc_update=threads::proc_update($conf["threads::proc_update"]);
                unset($conf["threads::proc_update"]);
        
                #如果異常
                if($proc_update["status"]==="false"){
                
                        #印出結果
                        var_dump($proc_update);
                        
                        #結束執行,回傳shell 1,代表異常.
                        exit(1);
                
                        }#if end
                
                #更新第一個程序的proc資訊
                $procs[$pIndex]["content"]=$proc_update["content"];
                
                #給予別名
                $pInfo=&$procs[$pIndex]["content"][0];
                
                #如果已經執行結束
                if($pInfo["statusCode"]!=="?"){
                
                        #若程序執行異常
                        if($pInfo["statusCode"]!==0){
                        
                                #記錄之
                                $error_procs[]=$pInfo;
                                
                                #移除其資訊
                                unset($procs[$pIndex]);
                                
                                #換下個proc程序
                                continue;
                        
                                }#if end
                
                        #記錄之
                        $success_procs[]=$pInfo;
                        
                        #移除其資訊
                        unset($procs[$pIndex]);
                        
                        #取得輸出的結果
                        $stdOut=trim($pInfo["content"]);
                
                        #如果有找到
                        if($stdOut==="found"){
                        
                                #記錄找到的 node
                                $found_node[]=$nodes2check[$pIndex];
                                
                                }#if end
                
                        #反之若沒有找到
                        else if($stdOut==="not found"){
                        
                                #記錄沒找到的 node
                                $not_found_node[]=$nodes2check[$pIndex];
                        
                                }#if end
                
                        #換下個proc程序
                        continue;
                
                        }#if end
                        
                #執行到這邊,代表程序尚未結束.
                        
                #換下個proc程序
                continue;
        
                }#foreach end

        #如果已經執行完所有的 proc 程序
        if(empty($procs)){
        
                #結束執行
                break;
        
                }#if end

        #休息0.1秒
        usleep(100000);

        }#while end
        
#印出 json 結果
echo json_encode($found_node);