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/allInOne.php");

#建議的log位置

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

#函式說明:

#建立腳本檔案.

#回傳結果:

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

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

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

#$result["content"],腳本檔案的位置與名稱.

#必填參數:

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

$conf["cmd"]=array("ps");

#可省略參數:

#$conf["params"],要執行對應指令所屬的參數字串陣列.

$conf["params"]=array(array("auxwf","|","grep","httpd"));

#$conf["excuteBy"],字串,預設不指定,反之為執行該腳本的程式絕對路徑,例如"bash"、"php"之類的.

$conf["excuteBy"]="bash";

#$conf["fileName"],字串,指定要輸出的檔案名稱.

$conf["fileName"]="assets of cmd/createBatch.sh";

#參考資料:

#無.

#備註:

#無.

$createBatch=cmd::createBatch($conf);

unset($conf);

#印出結果

var_dump($createBatch);

#如果執行失敗

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

	#結束執行,錯誤代碼1

	exit(1);

	}#if end

#取得腳本檔案的內容

#函式說明:

#依據行號分隔抓取檔案的內容,結果會回傳一個陣列

#回傳的變數說明:

#$result["status"],執行是否成功，"true"代表成功；"fasle"代表失敗.

#$result["error"],錯誤訊息提示.

#$result["warning"],警告訊息.

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

#$result["fileContent"],爲檔案的內容陣列.

#$result["lineCount"],爲檔案內容總共的行數.

#$result["fullContent"],為檔案的完整內容.

#$result["base64data"],為檔案的base64內容.

#$result["mimeType"],為檔案的mime type.

#必填參數:

#$conf["filePositionAndName"],字串,爲檔案的位置以及名稱.

$conf["filePositionAndName"]=$createBatch["content"];

#$conf["fileArgu"],字串,php變數__FILE__的內容,亦即該檔案在檔案系統的絕對路徑

$conf["fileArgu"]=__FILE__;

#可省略參數:

#$conf["web"],是要取得網路上的檔案則為"true";反之則為"false".

$conf["web"]="false";

#參考資料：

#file(),取得檔案內容的行數.

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

#rtrim(),剔除透過file()取得每行內容結尾的換行符號.

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

#參考資料:

#無.

#備註:

#無.

$getFileContent=fileAccess::getFileContent($conf);

unset($conf);

#印出結果

var_dump($getFileContent);

#如果執行失敗

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

	#結束執行,錯誤代碼1

	exit(1);

	}#if end

#將腳本給予執行的權限

#函式說明:

#呼叫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").

#必填參數:

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

$conf["command"]="chmod";

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

$conf["fileArgu"]=__FILE__;

#可省略參數:

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

$conf["argu"]=array("+x",$createBatch["content"]);

#$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"]="true";

#$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"]="false";

#參考資料：

#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);

#印出結果

var_dump($callShell);

#如果執行失敗

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

	#結束執行,錯誤代碼1

	exit(1);

	}#if end

#執行腳本

#函式說明:

#呼叫shell執行編譯過的2元碼程式或具備執行權限的檔案後回傳的結果

#回傳結果:

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

#$result["function"],正在執行的函式

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

#$result["error"]["returnCode"],錯誤代碼.

#$result["output"],爲執行完二元碼後的輸出陣列.

#$result["escapedCmd"],實際執行的指令.

#必填參數:

$conf["exeFileAddress"]=$createBatch["content"];#可執行檔的位置與名稱

#可省略參數:

#$conf["arguments"]="";#要給執行檔的參數

#參考資料：

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

#備註:

#無.

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

unset($conf);

#印出結果

var_dump($execByteCode);

#如果執行失敗

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

	#結束執行,錯誤代碼1

	exit(1);

	}#if end

#移除腳本檔案

#函式說明:

#移除檔案

#回傳結果:

#$result["status"],"true"代表移除成功,"false"代表移除失敗.

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

#$result["warning"],警告訊息陣列.

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

#$result["argu"],當前函式使用的參數.

#必填參數:

#$conf["fileAddress"],字串,要移除檔案的位置.

$conf["fileAddress"]=$createBatch["content"];

#$conf["fileArgu"],字串,php變數__FILE__的內容,亦即該檔案在檔案系統的絕對路徑.

$conf["fileArgu"]=__FILE__;

#可省略參數:

#$conf["commentsArray"],字串陣列,提示的文字描述,$conf["commentsArray"][$i]代表第($+1)行的描述.

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

#$conf["allowDelSymlink"],字串,預設為"false",不移除軟連結;"true"代表要移除軟連結.

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

#$conf["allowDelFolder"],字串,預設為"false",不移除目錄;"true"代表要移除目錄.

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

#參考資料:

#無.

#備註:

#無.

$delFile=fileAccess::delFile($conf);

unset($conf);

#印出結果

var_dump($delFile);

#如果執行失敗

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

	#結束執行,錯誤代碼1

	exit(1);

	}#if end

?>