Subversion Repositories php-qbpwcf

	/*

	#函式說明:

	#類似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"]=array();

	#可省略參數:

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

	#備註:

	#無.

	*/

	public static function proc_stream_select(&$conf){

		#初始化要回傳的結果

		$result=array();

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

		$result["function"]=__FUNCTION__;

		#如果沒有參數

		if(func_num_args()==0){

			#設置執行失敗

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

			#設置執行錯誤訊息

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

			#回傳結果

			return $result;

			}#if end

		#涵式說明：

		#判斷當前環境為web還是cmd

		#回傳結果：

		#$result,"web"或"cmd"

		if(csInformation::getEnv()==="web"){

			#設置執行失敗

			$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(is_null($conf)){

				#設置執行錯誤訊息

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

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

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

		#可省略參數:

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

		$conf["variableCheck::checkArguments"]["mustBeFilledVariableName"]=array("streams");

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

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

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

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

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

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

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

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

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

		$conf["variableCheck::checkArguments"]["skipableVariableCanNotBeEmpty"]=array("periodToWait");

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

		$conf["variableCheck::checkArguments"]["skipableVariableName"]=array("periodToWait");

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

		$conf["variableCheck::checkArguments"]["skipableVariableType"]=array("integer");

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

		$conf["variableCheck::checkArguments"]["skipableVarDefaultValue"]=array(1);

		#$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=variableCheck::checkArguments($conf["variableCheck::checkArguments"]);

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

		#如果執行異常

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

			#設置執行失敗

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

			#設置執行錯誤訊息

			$result["error"]=$checkArguments;

			#回傳結果

			return $result;

			}#if end

		#如果參數檢查不通過

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

			#設置執行失敗

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

			#設置執行錯誤訊息

			$result["error"]=$checkArguments;

			#回傳結果

			return $result;

			}#if end

		#初始化設置要監控的 stream 陣列資訊

		$streamInfo=array();

		#針對每個 stream

		foreach($conf["streams"] as $channelName => $stream){

			#設置 channel 的 stream

			$streamInfo[$channelName]["stream"]=$stream;

			#預設 channel 視為開啟的狀況

			$streamInfo[$channelName]["alive"]=true;

			#初始化該chnnel得到的回應為空.

			$result["content"][$channelName]["content"]="";

			#初始化該chnnel為開啟的狀態

			$result["content"][$channelName]["alive"]=true;

			}#foreach end

		#無窮迴圈

		while(true){

			#針對每個 stream

			foreach($streamInfo as $name=>$info){

				#如果通道是開啟的

				if($info["alive"]){

					#確認是否尚未關閉

					if(!feof($info["stream"])){

						#讀取訊息

						$msg=fread($info["stream"],2048);

						#如果有訊息

						if(!empty($msg)){

							#記錄訊息

							$result["content"][$name]["content"]=$result["content"][$name]["content"].$msg.PHP_EOL;

							}#if end

						}#if end

					#反之

					else{

						#設置通道已經關閉的識別

						$streamInfo[$name]["alive"]=false;

						#初始化該chnnel為開啟的狀態

						$result["content"][$channelName]["alive"]=false;

						#卸除作為參數的通道

						unset($conf["streams"][$name]);

						}#else end

					}#if end

				}#foreach end

			#如果已經沒有要監控的通道存在

			if(empty($conf["streams"])){

				#跳出 while

				break;

				}#if end

			#如果等待時間已經結束

			if(--$conf["periodToWait"]===0){

				#跳出 while

				break;

				}#if end

			#休息1秒鐘

			sleep(1);

			}#while end

		#針對每個 stream

		foreach($result["content"] as $channelName => $stream){

			#如果輸出為空

			if(empty($result["content"][$channelName]["content"])){

				#卸除之

				unset($result["content"][$channelName]);

				}#if end

			}#foreach end

		#取得依然可以使用的通道

		$result["streams"]=$conf["streams"];

		#如果可以使用的通道已經不存在

		if(empty($result["streams"])){

			#設置所有 channel 已經關閉.

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

			}#if end

		#反之

		else{

			#設置所有 channel 未關閉.

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

			}#else end

		#設置執行正常

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

		#回傳結果

		return $result;

		}#function proc_stream_select end