WebSVN – php-qbpwcf – /trunk/usr/share/qbpwcf/sample/autoService::createList.php

<?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;

#初始化輸出
$output=array();

#取得 lib path
exec("php -f ".escapeshellarg(pathinfo(__FILE__)["dirname"]."/../../../usr/bin/libexec/folderOfUsrLib.php"),$output,$status);

#如果執行失敗
if($status!==0){

        #debug
        var_dump(__LINE__,$output);

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

        }#if end

#儲存lib path
$folderOfUsrLib=$output[0];

#初始化輸出
$output=array();

#以該檔案的實際位置的 lib path 為 include path 首位
exec("cd ".pathinfo(__FILE__)["dirname"]."/../../../usr/".$folderOfUsrLib."/qbpwcf;pwd;",$output,$status);
set_include_path($output[0].PATH_SEPARATOR.get_include_path());

#匯入套件
require_once("allInOne.php");

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

#初始化儲存工作
$job_at_now_repeat_after_60sec=array();

#清空排程設定檔案
#函式說明:
#將字串寫入到檔案
#回傳結果:
#$result["status"],"true"表示檔案寫入成功,"false"表示檔案寫入失敗.
#$result["error"],錯誤訊息陣列.
#$result["function"],當前執行的函數名稱.
#$result["fileInfo"],實際上寫入的檔案資訊陣列.
#$result["fileInfo"]["createdFileName"],建立好的檔案名稱.
#$result["fileInfo"]["createdFilePath"],檔案建立的路徑.
#$result["fileInfo"]["createdFilePathAndName"].建立好的檔案名稱與路徑.
#$result["argu"],使用的參數.
#必填參數:
#$conf["fileArgu"],字串,php變數__FILE__的內容,亦即該檔案在檔案系統的絕對路徑
$conf["fileArgu"]=__FILE__;
#可省略參數:
#$conf["fileName"],字串,爲要編輯的檔案名稱,預設為隨機產生的檔案名稱.
$conf["fileName"]="assets of autoService/qbpwcf-schedule.conf.php";
#$conf["inputString"],字串,爲要寫入到裏面的內容，若要每筆資料寫入後換行，則可以在字串內容後面加上 \r\n 即可,預設為"".
#$conf["inputString"]="";
#$conf["writeMethod"],字串,爲檔案撰寫的方式,可省略,是複寫'a'還是,重新寫入'w',預設爲'w',重新寫入.
#$conf["writeMethod"]="a";
#$conf["checkRepeat"],字串,"true"代表建立檔案之前要先檢查檔案是否存在,若存在則在原名稱後面加上從(1)開始的編號.
#$conf["checkRepeat"]="";
#$conf["filenameExtensionStartPoint"],字串,檔案的副檔名是從倒數第幾個小數點(dot)開始,預設為"1",最後一個小數點,必須與$conf["checkRepeat"]搭配才會生效.
#$conf["filenameExtensionStartPoint"]="";
#$conf["repeatNameRule"],字串,遇到相同名稱的檔案要如何加上識別的編號,編號用「\$i」表示,預設為"(\$i)",必須與$conf["checkRepeat"]搭配才會生效.
#$conf["repeatNameRule"]="";
#$conf["web"],檔案是否位於網站上"true",若是在檔案系統則為"false",預設為"true".
$conf["web"]="false";
#參考資料:
#無.
#備註:
#無.
$writeTextIntoFile=fileAccess::writeTextIntoFile($conf);
unset($conf);

#如果執行失敗
if($writeTextIntoFile["status"]=="false"){
        
        #印出結果
        var_dump($callShell);
        
        #結束執行回傳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")與兩者組合的一維陣列(key為"array").
#必填參數:
#$conf["command"],字串,要執行的指令.
$conf["command"]="ps";
#$conf["fileArgu"],字串,變數__FILE__的內容.
$conf["fileArgu"]=__FILE__;
#可省略參數:
#$conf["argu"],陣列字串,指令搭配的參數,預設為空陣列.
$conf["argu"]=array("auxwf");
#$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"]="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"){
        
        #印出結果
        var_dump($callShell);
        
        #結束執行回傳1
        exit(1);
        
        }#if end

#記錄 action
$job_at_now_repeat_after_60sec["action"]=$callShell["escape"]["array"];

#記錄 time
$job_at_now_repeat_after_60sec["time"]="0000-00-00 00:00:00";

#記錄 repeat 規則
$job_at_now_repeat_after_60sec["repeat"]=array("times"=>-1,"after"=>60);

#初始化儲存工作
$job_at_every_min=array();

#函式說明:
#呼叫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"]="ps";
#$conf["fileArgu"],字串,變數__FILE__的內容.
$conf["fileArgu"]=__FILE__;
#可省略參數:
#$conf["argu"],陣列字串,指令搭配的參數,預設為空陣列.
$conf["argu"]=array("auxwf");
#$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"]="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"){
        
        #印出結果
        var_dump($callShell);
        
        #結束執行回傳1
        exit(1);
        
        }#if end

#記錄 action
$job_at_every_min["action"]=$callShell["escape"]["array"];

#記錄 time
$job_at_every_min["time"]="0000-00-00 00:00:05";

#記錄 repeat 規則
$job_at_every_min["repeat"]=array("times"=>-1,"fixed"=>$job_at_every_min["time"]);

#函式說明:
#新增或覆蓋系統上有哪些要自動執行的工作.
#回傳結果:
#$result["ststus"],執行是否正常,"true"代表執行正常,"false"代表執行不正常.
#$result["error"],錯誤訊息陣列.
#$result["function"],當前執行的函式名稱.
#必填參數:
#$conf["fileArgu"],字串,php變數__FILE__的內容,亦即該檔案在檔案系統的絕對路徑
$conf["fileArgu"]=__FILE__;
#$conf["actions"],字串陣列,每個元素代表要執行的事情,每個事情為要執行的指令與參數所組成的一維陣列.
$conf["actions"]=array($job_at_now_repeat_after_60sec["action"],$job_at_every_min["action"]);
#$conf["actions"]=array($job_at_now_repeat_after_60sec["action"]);
#$conf["times"],字串陣列,每個元素代表要執行事情的時間點,單為為秒.格式為UTC時區的「年年年年-月月-日日 時 時:分分:秒秒」格式,事情不存在於啟動的狀態且當前時間大於等於之就會執行.
$conf["times"]=array($job_at_now_repeat_after_60sec["time"],$job_at_every_min["time"]);
#$conf["times"]=array($job_at_now_repeat_after_60sec["time"]);
#$conf["repeat"],字串陣列,每個元素為一維陣列,key為"times"代表要執行事情的重複方式,若其value為"N"代表重複執行N次(若N等於-1,則代表無限重複執行;若N等於0,則代表執行後就會消失);key為"after"代表下次執行的時間為times+加其value;key為"fixed"代表下次執行的時間為一個循環的固定時間點,value為每次循環的固定時間點,例如每天01:05則為1h*3600s+5m*60s=3900,小於一天(86400秒)的時間,因此周期為天.
$conf["repeat"]=array($job_at_now_repeat_after_60sec["repeat"],$job_at_every_min["repeat"]);
#$conf["repeat"]=array($job_at_now_repeat_after_60sec["repeat"]);
#可省略參數:
#$conf["config"],字串,排程的設定檔位置,預設為"/usr/local/etc/qbpwcf-schedule.conf.php".
$conf["config"]="assets of autoService/qbpwcf-schedule.conf.php";
#$conf["append"],字串,是否要用append的方式增加資料,預設為"true";若要完全覆蓋既有的資料則要設置為"false".
#$conf["append"]="false";
#參考資料:
#無.
#備註:
#建構中
$createList=autoService::createList($conf);
unset($conf);

#如果執行失敗
if($createList["status"]=="false"){
        
        #印出結果
        var_dump($createList);
        
        #結束執行回傳1
        exit(1);
        
        }#if end

#debug
var_dump($createList);

?>
Subversion Repositories php-qbpwcf

(root)/trunk/usr/share/qbpwcf/sample/autoService::createList.php – Rev 81
