Subversion Repositories php-qbpwcf

Rev

Rev 226 | 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~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/>.

*/

/*

說明:
提供QBPWCF套件執行任何指令的unix domain socket服務的用戶端.

*/

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

#保存 lib path
$libPath=$output[0];

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

#建議的log位置
$logFile=$libPath."/log".$_SERVER["PHP_SELF"].".log";

#說明函式
function help(){

        #印出指令說明
        echo "Usage of ".basename(__FILE__).":".PHP_EOL;
        echo "--unixDomainSocketPath 代表要連接的 unix doamin socket 路徑.預設為 ".qbpwcf_usock_path.PHP_EOL;
        echo "--cmd 代表要執行的指令".PHP_EOL;
        echo "--param 代表要使用的參數".PHP_EOL;
        echo "--debug true 代表要啟動 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);

        #結束執行,回傳錯誤代碼1
        exit(1);

        }#if end

#break point
#var_dump($parseArgu);exit;

#break point
#var_dump(qbpwcf_usock_path);exit;

#檢查參數
#函式說明:
#檢查必填與可省略參數，可省略參數可指定預設要給與什麼數值內容。
#$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("cmd");
#$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("unixDomainSocketPath","param","debug");
#$conf["skipableVariableType"],陣列字串,爲可省略參數的變數名稱陣列，形態爲陣列變數，例如: $conf["skipableVariableType"] = array("string",integer,"double");
$conf["skipableVariableType"]=array("array","array","array");
#$conf["skipableVarDefaultValue"],字串陣列,每個不存在的可省略變數要初始化為什麼,null與代表不指定,若預設值是參數之一，請將$conf["mustBeFilledVar"]改成"\$conf["\mustBeFilledVar\"]".
$conf["skipableVarDefaultValue"]=array(array(qbpwcf_usock_path),null,array("false"));
#$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);

        #結束執行,回傳錯誤代碼1.
        exit(1);

        }#if end

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

        #印出結果
        var_dump($checkArguments);

        #結束執行,回傳錯誤代碼1.
        exit(1);

        }#if end

#預設不debug
$debug=false;

#如果設置要debug
if($parseArgu["content"]["debug"][0]==="true")
{
        #設置要debug
        $debug=true;

        #debug
        system("echo ".$logFile." > /tmp/output.log");

}

#取得要連接的 unix domain socket path
$unixDomainSocketPath=$parseArgu["content"]["unixDomainSocketPath"][0];

# 取得 id - start

#函式說明:
#連線到 unixDomainSockServer 提供的 unix domain socket.
#回傳結果:
#$result["status"],"true"代表執行正常;"false"代表執行不正常.
#$result["error"],錯誤訊息陣列.
#$result["function"],當前執行的函式名稱.
#$result["content"],取得的回應.
#必填參數:
#$conf["sock"],字串,要連線的unix domain socket.
$conf["sock"]=$unixDomainSocketPath;
#可省略參數:
#$conf["id"],字串,取得的id,若無此值,則會得到新的數值.
#$conf["id"]="";
#$conf["cmd"],字串,要執行的指令,當$conf["id"]參數合法時，才會執行.
#$conf["cmd"]="";
#$conf["param"],參數陣列.
#$conf["param"]=array();
#$conf["escaped"],字串,param參數是否已經escaped了,預設為"false",反之為"true".
#$conf["escaped"]="true";
#$conf["custom"],陣列,要客制化傳輸的內容,會覆蓋以上可省略參數.
#$conf["custom"]=array();
#參考資料:
#http://php.net/manual/en/function.stream-socket-client.php
#http://php.net/manual/en/function.stream-get-contents.php
#備註:
#要檢查 unix socket 檔案 $conf["sock"] 是否存在.
$unixDomainSockClient=sock::unixDomainSockClient($conf);
unset($conf);

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

        #印出結果
        var_dump($unixDomainSockClient);

        #如果要debug
        if($debug){

                #函式說明:
                #撰寫log
                #回傳結果:
                #$result["status"],狀態,"true"或"false".
                #$result["error"],錯誤訊息陣列.
                #$result["function"],當前函式的名稱.
                #$result["argu"],使用的參數.
                #必填參數:
                #$conf["path"],字串,log檔案的路徑與名稱.
                $conf["path"]=$logFile;
                #$conf["content"],any,要寫的內容,若內容不為字串則會用var_dump的格式寫入.
                $conf["content"]=$unixDomainSockClient;
                #$conf["fileArgu"],字串,php變數__FILE__的內容,亦即該檔案在檔案系統的絕對路徑
                $conf["fileArgu"]=__FILE__;
                #可省略參數:
                #$conf["rewrite"],預設為"false",接續寫入;反之"true"代表重新寫入.
                #$conf["rewrite"]="false";
                #參考資料:
                #無.
                #備註:
                #無.
                $record=logs::record($conf);
                unset($conf);

                #如果寫log失敗
                if($record["status"]==="false"){

                        #印出結果
                        var_dump($record);

                        }#if end

                }#if end

        #結束執行,回傳錯誤代碼1.
        exit(1);

        }#if end

#解析結果
$res=(array)(json_decode($unixDomainSockClient["content"]));

#如果取得id失敗
if($res["status"]==="false"){

        #印出結果
        var_dump($res);

        #如果要debug
        if($debug){

                #函式說明:
                #撰寫log
                #回傳結果:
                #$result["status"],狀態,"true"或"false".
                #$result["error"],錯誤訊息陣列.
                #$result["function"],當前函式的名稱.
                #$result["argu"],使用的參數.
                #必填參數:
                #$conf["path"],字串,log檔案的路徑與名稱.
                $conf["path"]=$logFile;
                #$conf["content"],any,要寫的內容,若內容不為字串則會用var_dump的格式寫入.
                $conf["content"]=$res;
                #$conf["fileArgu"],字串,php變數__FILE__的內容,亦即該檔案在檔案系統的絕對路徑
                $conf["fileArgu"]=__FILE__;
                #可省略參數:
                #$conf["rewrite"],預設為"false",接續寫入;反之"true"代表重新寫入.
                #$conf["rewrite"]="false";
                #參考資料:
                #無.
                #備註:
                #無.
                $record=logs::record($conf);
                unset($conf);

                #如果寫log失敗
                if($record["status"]==="false"){

                        #印出結果
                        var_dump($record);

                        }#if end

                }#if end

        #結束執行,回傳錯誤代碼1.
        exit(1);

        }#if end

#取得 id
$id=$res["id"];

# 取得 id - end

#取得要傳送的訊息內容
$cmd=$parseArgu["content"]["cmd"][0];

#預設無參數
$params=array();

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

        #針對每個參數
        for($i=0;$i<count($parseArgu["content"]["param"]);$i++){

                #儲存參數
                $params[]=$parseArgu["content"]["param"][$i];

                }#for end

        }#if end

#函式說明:
#連線到 unixDomainSockServer 提供的 unix domain socket.
#回傳結果:
#$result["status"],"true"代表執行正常;"false"代表執行不正常.
#$result["error"],錯誤訊息陣列.
#$result["function"],當前執行的函式名稱.
#$result["content"],取得的回應.
#必填參數:
#$conf["sock"],字串,要連線的unix domain socket.
$conf["sock"]=$unixDomainSocketPath;
#可省略參數:
#$conf["id"],字串,取得的id,若無此值,則會得到新的數值.
$conf["id"]=$id;
#$conf["cmd"],字串,要執行的指令,當$conf["id"]參數合法時，才會執行.
$conf["cmd"]=$cmd;

#如果有參數
if(count($params)>0){

        #$conf["param"],參數陣列.
        $conf["param"]=$params;

        }#if end

#$conf["escaped"],字串,param參數是否已經escaped了,預設為"false",反之為"true".
$conf["escaped"]="true";
#$conf["custom"],陣列,要客制化傳輸的內容,會覆蓋以上可省略參數.
#$conf["custom"]=array();
#參考資料:
#http://php.net/manual/en/function.stream-socket-client.php
#http://php.net/manual/en/function.stream-get-contents.php
#備註:
#要檢查 unix socket 檔案 $conf["sock"] 是否存在.
$unixDomainSockClient=sock::unixDomainSockClient($conf);
unset($conf);

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

        #印出結果
        var_dump($unixDomainSockClient);

        #如果要debug
        if($debug){

                #函式說明:
                #撰寫log
                #回傳結果:
                #$result["status"],狀態,"true"或"false".
                #$result["error"],錯誤訊息陣列.
                #$result["function"],當前函式的名稱.
                #$result["argu"],使用的參數.
                #必填參數:
                #$conf["path"],字串,log檔案的路徑與名稱.
                $conf["path"]=$logFile;
                #$conf["content"],any,要寫的內容,若內容不為字串則會用var_dump的格式寫入.
                $conf["content"]=$unixDomainSockClient;
                #$conf["fileArgu"],字串,php變數__FILE__的內容,亦即該檔案在檔案系統的絕對路徑
                $conf["fileArgu"]=__FILE__;
                #可省略參數:
                #$conf["rewrite"],預設為"false",接續寫入;反之"true"代表重新寫入.
                #$conf["rewrite"]="false";
                #參考資料:
                #無.
                #備註:
                #無.
                $record=logs::record($conf);
                unset($conf);

                #如果寫log失敗
                if($record["status"]==="false"){

                        #印出結果
                        var_dump($record);

                        }#if end

                }#if end

        #結束執行,回傳錯誤代碼1.
        exit(1);

        }#if end

#解析結果
$res=(array)(json_decode($unixDomainSockClient["content"]));

#如果取得id失敗
if($res["status"]==="false"){

        #印出結果
        var_dump($res);

        #如果要debug
        if($debug){

                #函式說明:
                #撰寫log
                #回傳結果:
                #$result["status"],狀態,"true"或"false".
                #$result["error"],錯誤訊息陣列.
                #$result["function"],當前函式的名稱.
                #$result["argu"],使用的參數.
                #必填參數:
                #$conf["path"],字串,log檔案的路徑與名稱.
                $conf["path"]=$logFile;
                #$conf["content"],any,要寫的內容,若內容不為字串則會用var_dump的格式寫入.
                $conf["content"]=$res;
                #$conf["fileArgu"],字串,php變數__FILE__的內容,亦即該檔案在檔案系統的絕對路徑
                $conf["fileArgu"]=__FILE__;
                #可省略參數:
                #$conf["rewrite"],預設為"false",接續寫入;反之"true"代表重新寫入.
                #$conf["rewrite"]="false";
                #參考資料:
                #無.
                #備註:
                #無.
                $record=logs::record($conf);
                unset($conf);

                #如果寫log失敗
                if($record["status"]==="false"){

                        #印出結果
                        var_dump($record);

                        }#if end

                }#if end

        #結束執行,回傳錯誤代碼1.
        exit(1);

        }#if end

#印出回應
for($i=0;$i<count($res["output"]);$i++){

        #印出結果
        echo $res["output"][$i].PHP_EOL;

        }#for end