Subversion Repositories php-qbpwcf

	/*

	#函式說明:

	#呼叫shell執行系統php程式字串.

	#回傳結果:

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

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

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

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

	#$result["statusCode"],運行php程式後,shell回傳的代碼.

	#$result["content"],為輸出的結果陣列

	#$result["content"][std"],標準輸出結果.

	#$result["content"]["err"],錯誤輸出結果.

	#必填參數:

	#$conf["code"],字串,要運行的php程式字串,可以用cmd::createPHPcodeString產生.

	$conf["code"]="";

	#可省略參數:

	#$conf["getCmdOnly"],字串,若為"true"則代表不要運行程式,只要回傳cmd結果就好;反之預設為"false".

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

	#參考資料：

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

	#備註:

	#無.

	*/

	public static function execPHPcode(&$conf){

		#初始化要回傳的結果

		$result=array();

		#取得當前執行的函數名稱

		$result["function"]=__FUNCTION__;

		#如果沒有參數

		if(func_num_args()==0){

			#設置執行失敗

			$result["status"]="false";

			#設置執行錯誤訊息

			$result["error"]="函數".$result["function"]."需要參數";

			#回傳結果

			return $result;

			}#if end

		#取得參數

		$result["argu"]=$conf;

		#如果 $conf 不為陣列

		if(gettype($conf)!=="array"){

			#設置執行失敗

			$result["status"]="false";

			#設置執行錯誤訊息

			$result["error"][]="\$conf變數須為陣列形態";

			#如果傳入的參數為 null

			if($conf===null){

				#設置執行錯誤訊息

				$result["error"][]="\$conf變數不得為null,請檢查函數「".$result["function"]."」的參數設置有無正確!";

				}#if end

			#回傳結果

			return $result;

			}#if end

		#檢查參數

		#函式說明:

		#檢查必填與可省略的參數，可省略參數可指定預設要給與什麼數值內容.

		#回傳結果:

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

		#$result["error"],執行不正常結束的錯訊息陣列.

		#$result["simpleError"],簡單表示的錯誤訊息.

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

		#$result["argu"],設置給予的參數.

		#$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["variable::checkArguments"]["varInput"]=&$conf;

		#$conf["referenceVarKey"],字串,$conf參數後面的key值,用於移除不要的參考陣列.

		$conf["variable::checkArguments"]["referenceVarKey"]="variableCheck::checkArguments";

		#可省略參數:

		#$conf["mustBeFilledVariableName"],爲必填參數的變數名稱陣列，形態爲陣列變數，元素數量需要跟"mustBeFilledVariableType"參數的元素數量一致,例如: $conf["mustBeFilledVariableName"] = array("id","account","password");

		$conf["variable::checkArguments"]["mustBeFilledVariableName"]=array("code");

		#$conf["mustBeFilledVariableType"],爲必填參數的變數陣列應該爲何種變數形態，形態爲陣列,元素數量需要跟"mustBeFilledVariableName"參數的元素數量一致,例如: $conf["mustBeFilledVariableType"] = array("string",integer,"double","resource","object"); , null、any代表不指定變數形態.其中 resource也包含"resource (closed)".

		$conf["variable::checkArguments"]["mustBeFilledVariableType"]=array("string");

		#$conf["canBeEmptyString"],字串,必填變數內容如果是空字串就不能算是有設置的話，請設為"false",預設爲"true",可以為空字串.

		$conf["variable::checkArguments"]["canBeEmptyString"]="false";

		#$conf["canNotBeEmpty"],字串陣列,哪些必填參數的內容不得為空字串或空陣列,僅當$conf["canBeEmptyString"]為"true"時會生效.

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

		#$conf["canBeEmpty"],字串陣列,哪些必填參數的內容可為空字串或空陣列,僅當$conf["canBeEmptyString"]為"false"時會生效.

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

		#$conf["skipableVariableCanNotBeEmpty"],字串陣列,哪些可省略參數不可以為空字串或空陣列.

		$conf["variable::checkArguments"]["skipableVariableCanNotBeEmpty"]=array("getCmdOnly");

		#$conf["skipableVariableName"],陣列字串,爲可省略參數的變數名稱陣列，形態爲陣列變數，例如: $conf["skipableVariableName"] = array("id","account","password");

		$conf["variable::checkArguments"]["skipableVariableName"]=array("getCmdOnly");

		#$conf["skipableVariableType"],陣列字串,爲可省略參數的變數名稱陣列，形態爲陣列變數，例如: $conf["skipableVariableType"] = array("string",integer,"double");

		$conf["variable::checkArguments"]["skipableVariableType"]=array("string");

		#$conf["skipableVarDefaultValue"],字串陣列,每個不存在的可省略變數要初始化為什麼,null與代表不指定,若預設值是參數之一，請將$conf["mustBeFilledVar"]改成"\$conf["\mustBeFilledVar\"]".

		$conf["variable::checkArguments"]["skipableVarDefaultValue"]=array("false");

		#$conf["disallowAllSkipableVarIsEmpty"],字串,是否允許每個可省略參數都為空字串,預設為"true"允許,反之為"false".

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

		#$conf["disallowAllSkipableVarIsEmptyArray"],字串,是否允許每個可省略參數都為空陣列,預設為"true"允許,反之為"false".

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

		#$conf["disallowAllSkipableVarNotExist"],字串,是否不允許每個可省略參數都不存在,預設為"false"代表允許,反之為"true".

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

		#$conf["arrayCountEqualCheck"],字串陣列,為檢查哪些陣列參數的元素數量要一樣,$conf["arrayCountEqualCheck"][$i]=array()為第$i組key為哪些的變數其元素數量要相等.

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

		#參考資料:

		#array_keys=>http://php.net/manual/en/function.array-keys.php

		#備註:

		#無.

		$checkArguments=variable::checkArguments($conf["variable::checkArguments"]);

		unset($conf["variable::checkArguments"]);

		#如果執行異常

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

			#設置執行錯誤

			$result["error"]=$checkArguments;

			#設置執行異常

			$result["status"]="false";

			#回傳結果

			return $result;

			}#if end

		#如果參數檢查不通過

		if($checkArguments["passed"]==="false"){

			#設置執行錯誤

			$result["error"]=$checkArguments;

			#設置執行異常

			$result["status"]="false";

			#回傳結果

			return $result;

			}#if end

		#設置要給予 hreads::proc 的 cmds 參數

		$paramsFor_cmds="php -r ".escapeshellarg($conf["code"]);

		#如果 "getCmdOnly" 為 "true"

		if($conf["getCmdOnly"]==="true"){

			#儲存要運行的指令

			$result["cmd"]=$paramsFor_cmds;

			#設置執行正常與否的識別

			$result["status"]="true";

			#回傳結果

			return $result;

			}#if end

		#函式說明:

		#透過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["threads::proc"]["cmds"]=array($paramsFor_cmds);

		#可省略參數:

		#$conf["wait"],字串,是否需要等待所有程序結束,預設為"true"要等待;反之為"false"不要等待.

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

		#$conf["timeout"],字串陣列,每個元素代表單一程序執行的最大等待秒數,超過後將會強迫停止執行,僅當wait參數為"true"時生效.

		#$conf["timeout"]=array("10");

		#$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

		#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["threads::proc"]);

		unset($conf["threads::proc"]);

		#如果執行異常

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

			#設置執行錯誤

			$result["error"]=$proc;

			#設置執行異常

			$result["status"]="false";

			#回傳結果

			return $result;

			}#if end

		#儲存標準輸出的字串

		$result["content"]["std"]=$proc[0]["content"];

		#儲存錯誤輸出的字串

		$result["content"]["err"]=$proc[0]["error"];

		#儲存執行的完整指令

		$result["cmd"]=$proc[0]["input"];

		#設置shell回傳的代碼

		$result["statusCode"]=$proc[0]["statusCode"];

		#設置執行正常與否的識別

		$result["status"]=$proc[0]["status"];

		#回傳結果

		return $result;

		}#function execPHPcode end