WebSVN – php-qbpwcf – /trunk/usr/share/qbpwcf/sample/fileAccess::getTextFilePart/20260708-1.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
namespace qbpwcf;

#assets dir
$assetsDir="assets of fileAccess::getTextFilePart_20260708-1";

#產生一份 20 行資料的檔案
#函式說明:
#呼叫shell執行系統命令,並取得回傳的內容.
#回傳結果:
#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
#$result["error"],錯誤訊息陣列.
#$result["function"],當前執行的函數名稱.
#$result["argu"],使用的參數.
#$result["cmd"],執行的指令內容.
#$result["fullCmd"],如果參數 $conf["inBackGround"] 為 "true" 則會回傳該值.
#$result["output"],爲執行完後的輸出陣列,若 $conf["inBackGround"] 為 "true",則為當下的輸出.
#$result["content"],為執行完後的輸出字串.
#$result["tmpFileOutput"],儲存輸出的暫存檔案名稱,若 $conf["inBackGround"] 為 "true" 則會回傳該值.
#$result["running"],是否還在執行.
#$result["pid"],pid.
#$result["statusCode"],執行結束後的代碼.
#$result["escape"],陣列,儲存重新排序過且已經escape過的指令(key為"cmd")與參數(key為"argu")與兩者組合的一維陣列(key為"array").
#$result["noEscaped"],陣列,儲存重新排序過未經過escape過的指令(key為"cmd")與參數(key為"argu")與兩者組合的一維陣列(key為"array").
#必填參數:
#$conf["command"],字串,要執行的指令.
$conf["command"]="cat";
#$conf["fileArgu"],字串,變數__FILE__的內容.
$conf["fileArgu"]=__FILE__;
#可省略參數:
#$conf["argu"],陣列字串,指令搭配的參數,預設為空陣列.
$conf["argu"]=array($assetsDir."/readOnly_ssl_access_log","|","head","-n","20",">",$assetsDir."/ssl_access_log");
#$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";
#$conf["cmdContainArgu"],字串,cmd參數是否已經含有參數,預設為"false"代表沒有;反之為"true".
#$conf["cmdContainArgu"]="false";
#$conf["remoteIp"],字串,遠端ip或domainName,預設不使用,若存在則會透過ssh指令進行連線,然後執行指令.
#$conf["remoteIp"]="";
#$conf["remoteUser"],字串,遠端的使用者賬戶,預設不指定,亦即跟為運行該php程式的使用者.
#$conf["remoteUser"]="";
#$conf["sshOptions"],陣列,當具備 "remoteIp" 參數時,該參數每個元素為ssh指令的參數.
#$conf["sshOptions"]=array();
#參考資料:
#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);

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

        }#if end
        
#debug
#var_dump(__LINE__,$callShell);exit;

#初始化給 threads::proc 的 cmds 參數
$cmds=array();

#讀取檔案
$cmds[]="php -f ./loadLogFile.php";

#rotate檔案
$cmds[]="php -f ./rotateLogFile.php";

#設置工作目錄為 asset 目錄
$workPath=pathinfo(__FILE__)["dirname"]."/../".$assetsDir;

#函式說明:
#透過proc來多執行序運作.
#回傳結果:
#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
#$reuslt["error"],執行不正常結束的錯訊息陣列.
#$result["function"],當前執行的函式名稱.
#$result["argu"],使用的參數.
#$result["content"],陣列,每個元素為其指令執行的結果訊息陣列,key為"status"代表執行是否正常的識別;key為"statusCode"代表程式結束後回傳給對應executeBy程式的數值,若為"?"則代表程序尚未結束,若為整數0,則代表順利執行結束,可透過proc_update函式進行資訊的更新與取得;key為"content"代表標準輸出,若為resource,則代表為pipe;key為"error"代表非標準輸出,若為resource,則代表為pipe;key為"input"代表成功輸入的指令;key為"process"代表該程序經proc_open後的process source;key為"proc_get_status"代表程序的資訊.
#必填參數:
#$conf["cmds"],字串陣列,每個元素代表單一程序要執行的指令與參數.
$conf["cmds"]=$cmds;
#可省略參數:
#$conf["wait"],字串,是否需要等待所有程序結束,預設為"true"要等待;反之為"false"不要等待.
$conf["wait"]="false";
#$conf["timeout"],字串陣列,每個元素代表單一程序執行的最大等待秒數,超過後將會強迫停止執行,僅當wait參數為"true"時生效.
#$conf["timeout"]=array("10");
#$conf["workingDir"],字串陣列,個別程式執行時的家目錄,預設不指定.
$conf["workingDir"]=array($workPath,$workPath);
#$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
#https://www.php.net/manual/en/function.proc-terminate.php
#備註:
#當wait參數為"true"時,會自動解析stdout與stderr,因此不用再透過 self::proc_update 來更新.
#當wait參數不為"true"時,若需要取得當下的執行狀況,請使用 self::proc_update 來更新.
$proc=threads::proc($conf);
unset($conf);

#若執行異常
if($proc["status"]==="false"){

        #debug
        var_dump($callShell);

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

        }#if end

#儲存讀取檔案的std
$readStd=$proc["content"][0]["content"];

#儲存讀取檔案的err
$readErr=$proc["content"][0]["error"];

#儲存rotate檔案的std
$rotateStd=$proc["content"][1]["content"];

#儲存rotate檔案的err
$rotateErr=$proc["content"][1]["error"];

#設置給予 threads::proc_stream_select 的 streams 參數
$streams=array("readStd"=>$readStd,"readErr"=>$readErr,"rotateStd"=>$rotateStd,"rotateErr"=>$rotateErr);

#無窮迴圈
while(true){

        #函式說明:
        #類似stream_select的替代方案， 用來檢查透過proc運行的多執行序其標準輸出、錯誤輸出是否有訊息,程序是否已經結束.
        #回傳結果:
        #$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
        #$reuslt["error"],執行不正常結束的錯訊息陣列.
        #$result["function"],當前執行的函式名稱.
        #$result["argu"],使用的參數.
        #$result["content"],陣列,每個元素的key代表有訊息的channel名稱,數值為陣列.
        #$result["content"][$channel],陣列,$channel為通道的名稱亦即streams參數陣列中的key.陣列的key有"content",代表得到的訊息;"alive"則代表通道是否還處於開啟的狀態.
        #$result["streams"],陣列,依然開啟的通道(運行中),元素的key為該channel的名稱;數值為channel.
        #$result["allChannelClosed"],字串,"true"代表streams參數的通道已經全部關閉;反之為"false".
        #必填參數:
        #$conf["streams"],陣列,每個元素為threads::proc回傳結果content中每個元素的content跟error,key為該stream的名稱,例如:"client_1_std"、"client_1_err".
        $conf["streams"]=$streams;
        #可省略參數:
        #$conf["periodToWait"],整數,要等待多少秒來嘗試取得訊息,預設為1秒鐘.
        #$conf["periodToWait"]=1;
        #參考資料:
        #https://www.php.net/manual/en/function.proc-open.php
        #https://www.php.net/manual/en/function.proc-get-status.php
        #https://www.php.net/manual/en/function.proc-terminate.php
        #備註:
        #無.
        $proc_stream_select=threads::proc_stream_select($conf);
        unset($conf);

        #如果執行異常
        if($proc_stream_select["status"]==="false"){
                
                #debug
                var_dump($proc_stream_select);
                
                #結束執行,回傳shell 1
                exit(1);

                }#if end
                
        #如果有訊息
        if(!empty($proc_stream_select["content"])){
        
                #針對每個stream
                foreach($proc_stream_select["content"] as $channelName => $channelInfo){
                
                        #如果通道已經關閉
                        if($channelInfo["alive"]==="false"){
                        
                                #加上已經關閉 channel 的提示文字
                                $channelName=$channelName."(closed)";
                        
                                }#if end
                
                        #印出通道名稱與輸出的內容
                        echo $channelName." > ".$channelInfo["content"];
                
                        }#foreach end
        
                }#if end
                
        #如果通道都已經關閉
        if($proc_stream_select["allChannelClosed"]==="true"){
        
                #正常結束執行
                exit;
        
                }#if end

        #更新給予 threads::proc_stream_select 的 streams 參數
        $streams=$proc_stream_select["streams"];

        }#while end
        
#移除log檔案
#函式說明:
#移除檔案
#回傳結果:
#$result["status"],"true"代表移除成功,"false"代表移除失敗.
#$result["error"],錯誤訊息陣列.
#$result["warning"],警告訊息陣列.
#$result["function"],當前執行的函數名稱.
#$result["argu"],當前函式使用的參數.
#必填參數:
#$conf["fileAddress"],字串,要移除檔案的位置.
$conf["fileAddress"]=$workPath."/ssl_access_log";
#$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);

#如果執行異常
if($delFile["status"]==="false"){
        
        #debug
        var_dump($delFile);
        
        #結束執行,回傳shell 1
        exit(1);

        }#if end
Subversion Repositories php-qbpwcf

(root)/trunk/usr/share/qbpwcf/sample/fileAccess::getTextFilePart/20260708-1.php – Rev 391
