Subversion Repositories qbpwcf-lib(archive)

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

*/

#使用命名空間qbpwcf

namespace qbpwcf;

#匯入套件

require_once("qbpwcf/allInOneForJson.php");

#建議的log位置

$logFile=$_SERVER["DOCUMENT_ROOT"].$_SERVER["PHP_SELF"].".log";

#./usr_bin_test.php --cmd configCache.php

#函式說明:

#呼叫shell執行系統命令,並取得回傳的內容.

#回傳結果:

#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.

#$result["error"],錯誤訊息陣列.

#$result["function"],當前執行的函數名稱.

#$result["argu"],使用的參數.

#$result["cmd"],執行的指令內容.

#$result["fullCmd"],如果參數 $conf["inBackGround"] 為 "true" 則會回傳該值.

#$result["output"],爲執行完二元碼後的輸出陣列,若 $conf["inBackGround"] 為 "true",則為當下的輸出.

#$result["tmpFileOutput"],儲存輸出的暫存檔案名稱,若 $conf["inBackGround"] 為 "true" 則會回傳該值.

#$result["running"],是否還在執行.

#$result["pid"],pid.

#$result["statusCode"],執行結束後的代碼.

#$result["escape"],陣列,儲存重新排序過且已經escape過的指令(key為"cmd")與參數(key為"argu")與兩者組合的一維陣列(key為"array").

#必填參數:

#$conf["command"],字串,要執行的指令.

$conf["command"]="./usr_bin_test.php";

#$conf["fileArgu"],字串,變數__FILE__的內容.

$conf["fileArgu"]=__FILE__;

#可省略參數:

#$conf["argu"],陣列字串,指令搭配的參數,預設為空陣列.

$conf["argu"]=array("--cmd","configCache.php");

#$conf["arguIsAddr"],陣列字串,指令搭配的哪些參數為路徑,為路徑的參數會進行轉換以便符合呼叫當前函數的位置,預設不指定,若有3個參數,其中第3個參數為路徑,則表示為array("false","false","true").

#$conf["arguIsAddr"]=array();

#$conf["pre"],陣列,要在本指令前執行的每個指令與參數.

#$conf["pre"][$i]["cmd"],字串,要在本指令前執行的第$i+1個指令.

#$conf["pre"][$i]["param"],陣列字串,要在本指令前執行的第$i+1個指令的參數.

#$conf["enablePrintDescription"],字串,是否要印出$conf["printDescription"]的內容,"true"代表要,"false"代表不要,預設為"false".

#$conf["enablePrintDescription"]="true";

#$conf["printDescription"],字串,執行該外部程式前要印出來的的文字,預設為$conf["command"]的內容加上使用的$conf["argu"]參數.

#$conf["printDescription"]="";

#$conf["escapeshellarg"],字串,是否要啟用過濾參數,用了比較安全,但可能會出錯,"true"為啟用,"false"為不啟用,預設為"false".如果參數為"< 、<< 、> 、>> 、| 、2>&1"之一則不會過濾.

#$conf["escapeshellarg"]="false";

#$conf["thereIsShellVar"],陣列字串,指令搭配的參數"argu",若含有「\'」,則取代為「"」.每個argu參數都要有對應的元素."true"代表要置換.

#$conf["thereIsShellVar"]=array();

#$conf["username"],字串,要用什麼使用者來執行,預設為執行php的使用者,該參數不適用於apache環境.

#$conf["username"]="";

#$conf["password"],字串,root的使用者密碼,預設不使用密碼,該參數不適用於apache環境.

#$conf["password"]="";

#$conf["useScript"],字串,是否要啟用Linux的script指令來記錄輸出,"true"代表要,Fedora的selinux會擋住該操作;"false"代表不要,預設為"false".

#$conf["useScript"]="";

#$conf["logFilePath"],字串,當 $conf["useScript"] 為 "true" 時,輸出的內容要暫存到哪裡,預設為 "/tmp/.qbpwcf_tmp/external/callShell/".

#$conf["logFilePath"]=".qbpwcf_tmp/external/callShell/";

#$conf["inBackGround"],字串,是否要在背景執行,且不會等待程式執行結束再執行下一個指令,"true"代表是,"false"代表不要,預設為"false",如果$conf["command"]有用「;」區隔的多個指令將會出錯.

#$conf["inBackGround"]="";

#$conf["getErr"],字串,"true"代表將錯誤輸出變成標準輸出,反之"false"為不變動.

#$conf["getErr"]="false";

#$conf["doNotRun"],字串,"true"代表不執行指令,預設為"false"會執行指令.

$conf["doNotRun"]="true";

#參考資料：

#exec=>http://php.net/manual/en/function.exec.php

#escapeshellcmd=>http://php.net/manual/en/function.escapeshellcmd.php

#escapeshellarg=>http://php.net/manual/en/function.escapeshellarg.php

#備註:

#不是所有指令都能用apache的身份執行,目前已知java,javac指令無法執行,使用root身份可能會被selinux阻擋.

#若使用的 command、argu 參數，含有 ~ 則會被視為字串，若有需要其於 shell 中代表的家目錄位置，可用 fileAccess::tildeToPath 來進行轉換.

$callShell=external::callShell($conf);

unset($conf);

#如果執行失敗

if($callShell["status"]==="false"){

	#debug

	var_dump($callShell);

	#結束執行,回傳1給shell.

	exit(1);

	}#if end

#函式說明:

#將一維陣列轉換為用特定符號間隔的字串,ex:array("1","2","3") to "a;b;c;".

#回傳的結果:

#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.

#$result["function"],當前執行的function名稱

#$result["error"],錯誤訊息陣列.

#$result["content"],處理好的字串.

#$result["argu"],使用的參數.

#必填參數:

#$conf["inputArray"],字串陣列,要轉成字串的一維陣列.

$conf["inputArray"]=$callShell["escape"]["array"];

#可省略參數:

#$conf["spiltSymbol"],字串,用來區隔字串的符號,預設為;

$conf["spiltSymbol"]="";

#$conf["skipEnd"],字串,結尾是否不要加上符號,預設為"false",要加上符號,"true"代表不要加上符號。

#$conf["skipEnd"]="";

#$conf["spiltSymbolAtStart"],字串,是否要在開頭加上spiltSymbol,預設為"false",代表不要;反之為“true”.

#$conf["spiltSymbolAtStart"]="";

#參考資料:

#無.

#備註:

#無.

$arrayToString=arrays::arrayToString($conf);

unset($conf);

#如果執行失敗

if($arrayToString["status"]==="false"){

	#debug

	var_dump($arrayToString);

	#結束執行,回傳1給shell.

	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["cmds"]=array($arrayToString["content"]);

#可省略參數:

#$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"){

	#debug

	var_dump($proc);

	#結束執行,回傳1給shell.

	exit(1);

	}#if end

#函式說明:

#查尋有使用 server 函式提供組態設定檔的服務,取得key的value.

#回傳結果:

#$result["status"],執行是否正常,"true"為正常,"false"為不正常.

#$result["error"],錯誤訊息陣列.

#$result["function"],當前執行的函數名稱.

#$result["rawContent"],得到的原始訊息.

#$result["content"],用json_decode後的結果;若"inBg"為"true",則其每個元素為其指令執行的結果訊息陣列,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["server"],字串,組態服務設定服務的網址

$conf["server"]="https://qbpwc.sourceforge.io/demo/configServerDemo.php";

#$conf["postName"],字串,POST變數的名稱,亦即要查尋的定義名稱.

$conf["postName"]="";

#$conf["fileArgu"],字串,變數__FILE__的內容.

$conf["fileArgu"]=__FILE__;

#可省略參數:

#$conf["cache"],字串,預設為"true",代表會啟用cache服務;反之為"false".

#$conf["cache"]="false";

#$conf["clientCacheDaemonSock"],字串,提供cache服務的 unix domain socket 檔案位置,預設為套件根目錄底下的"var/config::client/clientCacheDaemon.sock";.

#$conf["clientCacheDaemonSock"]="";

#$conf["inBg"],字串,預設為"false",代表在前景執行;反之為"true"代表在背景中執行,會強制將"cache"參數設為"false".

#$conf["inBg"]="true";

#參考資料:

#無.

#備註:

#目前僅能跟server函式提供的服務對接.

$client=config::client($conf);

unset($conf);

?>