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/>.

*/

/*
說明:
啟動 用來接收 request 來跟 web socket server 互動.

範例:
webSocketClientDaemon.php [--domain server.wss.org] [--path wss] [--port 443]
*/

#使用命名空間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 "--domain 代表要連線的 web socket 服務域名".PHP_EOL;
        echo "--path 代表要連線的 web socket 服務path,預設為 wss".PHP_EOL;
        echo "--port 代表要連線的 web socket 服務port,預設為 443".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);

        #結束執行,回傳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("domain");
#$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("path","port");
#$conf["skipableVariableName"],陣列字串,爲可省略參數的變數名稱陣列,形態爲陣列變數,例如: $conf["skipableVariableName"] = array("id","account","password");
$conf["skipableVariableName"]=array("path","port");
#$conf["skipableVariableType"],陣列字串,爲可省略參數的變數名稱陣列,形態爲陣列變數,例如: $conf["skipableVariableType"] = array("string",integer,"double");
$conf["skipableVariableType"]=array("array","array");
#$conf["skipableVarDefaultValue"],字串陣列,每個不存在的可省略變數要初始化為什麼,null與代表不指定,若預設值是參數之一,請將$conf["mustBeFilledVar"]改成"\$conf["\mustBeFilledVar\"]".
$conf["skipableVarDefaultValue"]=array(array("wss"),array(443));
#$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);

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

        }#if end

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

        #印出結果
        var_dump($checkArguments);

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

        }#if end

#預設的 unix doamin socket
#$defaultUnixDomainSocket="./".basename(__FILE__).".sock";

#取得各項參數
$addr=$parseArgu["content"]["domain"][0];
$path=$parseArgu["content"]["path"][0];
$port=$parseArgu["content"]["port"][0];

#函式說明:
#透過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["cmds"]=array(pathinfo(__FILE__)["dirname"]."/libexec/webSocketClientDaemon.php --domain ".$addr." --path ".$path." --port ".$port);
#可省略參數:
#$conf["wait"],字串,是否需要等待所有程序結束,預設為"true"要等待;反之為"false"不要等待.
$conf["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
#備註:
#無.
$proc=threads::proc($conf);
unset($conf);

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

        #印出結果
        var_dump($proc);

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

        }#if end

#提示執行的指令
echo "輸入指令:".$proc["content"][0]["input"]." 成功.".PHP_EOL;

#無窮迴圈
while(true){

        #等待1毫秒
        usleep(100000);

        #針對每個程序
        foreach($proc["content"] as $index=>$process){

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

                        #debug
                        var_dump($proc);

                        #移除該程序資訊
                        unset($proc["content"][$index]);

                        }#if end

                #如果是 resource
                if(is_resource($process["process"])){

                        #如果error為resource
                        if(is_resource($process["error"])){

                                #將建立的 listen sock 放到 $master 陣列
                                $master[] = $process["error"];

                                #設置給 stream_select 監控的sock變數
                                $read = $write = $except = $master;

                                #等待0.1秒,看有沒有讀寫的狀況
                                $mod_fd = stream_select($read, $write, $except, 1);

                                #如果偵測異動失敗
                                if($mod_fd===FALSE){

                                        #monitior stream failed

                                        #debug
                                        var_dump($proc);

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

                                        }#if end

                                #如果有異動的跡象
                                else if($mod_fd>0){

                                        #針對每個異動的 stream
                                        foreach($read as $readStream){

                                                #如果是有錯誤輸出
                                                if($readStream===$process["error"]){

                                                        #debug
                                                        #echo "try read std error output".PHP_EOL;

                                                        #讀取1Kbyte
                                                        $errorByte=fread($process["error"],1024);

                                                        #提示為錯誤訊息
                                                        echo "error:";

                                                        #印出內容
                                                        echo $errorByte;

                                                        #換行
                                                        echo PHP_EOL;

                                                        }#if end

                                                }#foreach end

                                        }#if end

                                }#if end

                        #如果content為resource
                        if(is_resource($process["content"])){

                                #將建立的 listen sock 放到 $master 陣列
                                $master[] = $process["content"];

                                #設置給 stream_select 監控的sock變數
                                $read = $write = $except = $master;

                                #等待1秒,看有沒有讀寫的狀況
                                $mod_fd = stream_select($read, $write, $except, 1);

                                #如果偵測異動失敗
                                if($mod_fd===FALSE){

                                        #monitior stream failed

                                        #debug
                                        var_dump($proc);

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

                                        }#if end

                                #如果有異動的跡象
                                else if($mod_fd>0){

                                        #針對每個異動的 stream
                                        foreach($read as $readStream){

                                                #如果是有標準輸出
                                                if($readStream===$process["content"]){

                                                        #debug
                                                        #echo "try read std output".PHP_EOL;

                                                        #不讓標準輸出會阻擋程式執行
                                                        #stream_set_blocking($process["content"],false);

                                                        #讀取1Kbyte
                                                        $contentByte=fread($process["content"],1024);

                                                        #如果有資料
                                                        if(strlen($contentByte)>0){

                                                                #如果有關鍵字
                                                                if(strpos($contentByte,"unixDomainSocket:")===0){

                                                                        #函式說明:
                                                                        #將固定格式的字串分開,並回傳分開的結果.
                                                                        #回傳結果:
                                                                        #$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
                                                                        #$result["error"],錯誤訊息陣列
                                                                        #$result["function"],當前執行的函數名稱.
                                                                        #$result["argu"],使用的參數.
                                                                        #$result["oriStr"],要分割的原始字串內容
                                                                        #$result["dataArray"],爲分割好字串的陣列內容,$result["dataArray"][$i]爲第($i+1)段的內容。
                                                                        #$result["dataCounts"],爲總共分成幾段
                                                                        #$result["found"],是否有在$conf["stringIn"]找到$conf["spiltSymbol"],"true"代表有找到,"false"代表沒有找到.
                                                                        #必填參數:
                                                                        #$conf["stringIn"],字串,要處理的字串.
                                                                        $conf["stringIn"]=$contentByte;
                                                                        #$conf["spiltSymbol"],字串,爲以哪個符號作爲分割.
                                                                        $conf["spiltSymbol"]="unixDomainSocket:";
                                                                        #可省略參數:
                                                                        #$conf["allowEmptyStr"],是否允許分割出來空字串,預設為"false"不允許;"true"代表允許.
                                                                        $conf["allowEmptyStr"]="false";
                                                                        #參考資料:
                                                                        #無.
                                                                        #備註:
                                                                        #無.
                                                                        $spiltString=stringProcess::spiltString($conf);
                                                                        unset($conf);

                                                                        #debug
                                                                        #var_dump(__LINE__,$spiltString);

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

                                                                                #debug
                                                                                var_dump($spiltString);

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

                                                                                }#if end

                                                                        #如果有分割用的關鍵字
                                                                        if($spiltString["found"]==="true"){

                                                                                #如果分割出來的數量為1
                                                                                if($spiltString["dataCounts"]===1){

                                                                                        #取得 unix doamin socket 的位置
                                                                                        $unixDomainSocket=$spiltString["dataArray"][0];

                                                                                        #提示透過 unix domain socket 來傳接收要做的事情
                                                                                        echo "Using unix domain socket:".$unixDomainSocket." 來跟 web socket server 互動".PHP_EOL;

                                                                                        #後面忽略,換下一個
                                                                                        continue;

                                                                                        }#if end

                                                                                }#if end

                                                                        }#if end

                                                                #印出內容
                                                                echo $contentByte;

                                                                #換行
                                                                echo PHP_EOL;

                                                                }#if end

                                                        }#if end

                                                }#foreach end

                                        }#if end

                                        #反之代表沒有任何輸出
                                        else{

                                                #提示在等待任何輸出
                                                echo ".";

                                                }#else end

                                }#if end

                        #如果已經結束執行
                        if($process["proc_get_status"]["running"]==="false"){

                                #移除該程序資訊
                                unset($proc["content"][$index]);

                                }#if end

                        #反之
                        else{

                                #更新 "proc_get_status"
                                $proc["content"][$index]["proc_get_status"]=proc_get_status($process["process"]);

                                }#else end

                        }#if end

                #反之
                else{

                        #移除該程序資訊
                        unset($proc["content"][$index]);

                        }#else end

                }#foreach end

        }#while end