Subversion Repositories php-qbpwcf

	#$conf["remoteIp"],字串,遠端ip或domainName,預設不使用,若存在則會透過ssh指令進行連線,然後執行指令.

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

	#$conf["remoteUser"],字串,遠端的使用者賬戶,預設不指定,亦即跟為運行該php程式的使用者.

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

			#取得搜尋 "=" 的結果

		#初始化儲存執行的參數

		$result["noEscaped"]["argu"]=array();

		#初始化儲存escaped後的指令與參數資訊

		$result["escaped"]=array();

		#儲存執行的指令

		$result["escaped"]["cmd"]=escapeshellarg($conf["command"]);

		#初始化儲存執行的參數

		$result["escaped"]["argu"]=array();

			#有幾個參數就執行幾次

			for($i=0;$i<count($conf["argu"]);$i++){

				#如果有指定位置參數

				if(isset($conf["arguIsAddr"])){

					#如果是位置參數

					if($conf["arguIsAddr"][$i]==="true"){

						#如果相對路徑就要轉換路徑

						if(strpos($conf["argu"][$i],"/")!==0){

							#函數說明:

							#將多個路徑字串變成相對於當前路徑的相對路徑字串

							#回傳結果:

							#$result["status"],"true"爲建立成功,"false"爲建立失敗.

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

							#$result["function"],函數名稱.

							#$result["content"],字串陣列,多個轉換好的相對路徑字串.

							#必填參數:

							#$conf["path"],陣列字串,要轉換成相對路徑的字串.;

							$conf["fileAccess::getRelativePath"]["path"]=array($conf["argu"][$i]);

							#$conf["fileArgu"],字串,當前路徑.

							$conf["fileAccess::getRelativePath"]["fileArgu"]=$conf["fileArgu"];

							$getRelativePath=fileAccess::getRelativePath($conf["fileAccess::getRelativePath"]);

							unset($conf["fileAccess::getRelativePath"]);

							#var_dump($getRelativePath);

							#如果轉換路徑失敗

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

								#設置執行失敗的識別

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

								#設置執行失敗的訊息

								$result["error"]=$getRelativePath;

				#如果參數長度大於3

				if(strlen($conf["argu"][$i])>3){

					if( strpos($conf["argu"][$i],"\${")===0 && strpos($conf["argu"][$i],"}")===(strlen($conf["argu"][$i])-1) ){

							#如果是第一個參數

								#更新真正執行的指令

								$result["cmd"]=$result["cmd"].$space.$conf["argu"][$i];

								#儲存escape的cmd

								$result["escaped"]["cmd"]=escapeshellarg($result["cmd"]);

								#儲存未escape的cmd

								$result["noEscaped"]["cmd"]=$result["cmd"];

							#儲存escape的參數

							$result["escaped"]["argu"][]=escapeshellarg($conf["argu"][$i]);

						$result["cmd"]=$result["cmd"].$space.$conf["argu"][$i];

						#下一個參數

				#如果參數是 < 、<< 、> 、>> 、| 、2>&1、;、`、~、&、$!

					$result["escaped"]["argu"][]=$conf["argu"][$i];

						#更新真正執行的指令

						$result["escaped"]["cmd"]=$result["cmd"];

							#如果有設置 $conf["thereIsShellVar"][$i]

							if(isset($conf["thereIsShellVar"][$i])){

								#如果含有 shell 變數

								if($conf["thereIsShellVar"][$i]==="true"){

									#檢查是否使用 shell 變數

									#函式說明：

									#尋找陣列中有無符合的key

									#回傳結果:

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

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

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

									#$result["argu"],所使用的參數.

									#$result["founded"],是否有找到shell變數,"true"代表有找到,"false"代表沒有找到..

									#必填參數:

									#$conf["input"],字串,要檢查的字串..

									$conf["search::findShellVar"]["input"]=$escapeArgu;

									#可省略參數:

									#參考資料:

									#無.

									#備註:

									#無.

									$findShellVar=search::findShellVar($conf["search::findShellVar"]);

									unset($conf["search::findShellVar"]);

									#如果檢查失敗

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

										#$result["returnString"]，爲符合字首條件的字串內容。

										#$result["argu"],使用的參數.

										#$conf["frontWord"],字串,用來檢查字首應該要有什麼字串,預設不指定.

										$conf["search::getMeetConditionsString"]["frontWord"]="'";

										#$conf["tailWord"],字串,用來檢查字尾應該要有什麼字串,預設不指定.

											#$result["content"],爲處理好的字串.

							}#if end

						#如果是要執行 escpaed 後的指令

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

							}#if end

						#反之

						else{

							#串接指令

							$result["cmd"]=$result["cmd"]." ".$unescapeArgu;

							}#else end

						#儲存未escape的參數

						$result["noEscaped"]["argu"][]=$unescapeArgu;

		#如果有指定遠端ip

		if(isset($conf["remoteIp"])){

			#設定ssh指令	

			$ssh="ssh ".$conf["remoteIp"];

			#如果有指定遠端使用者

			if(isset($conf["remoteUser"])){

				#設定ssh指令

				$ssh="ssh ".$conf["remoteUser"]."@".$conf["remoteIp"];

				}#if end

			#檢測能否成功遠端的指令

			$testRemote="echo 'env | grep SSH_CONNECTION' | ".$ssh;

			#debug

			#var_dump(__LINE__,$testRemote);

			#初始化輸出

			$output=array();

			#執行檢測遠端是否成功

			exec($testRemote,$output,$status);

			#如果異常

			if($status!==0){

				#設置執行不正常

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

				#設置執行錯誤

				$result["error"]="can not run cmd on remote shell(".$testRemote.")";

				#回傳結果

				return $result;

				}#if end

			#如果異常

			if(count($output)===0){

				#設置執行不正常

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

				#設置執行錯誤

				$result["error"]="can not run cmd on remote shell(".$testRemote.")";

				#回傳結果

				return $result;

				}#if end

			#繼承既有參數

			$conf["external::callShell"]=$conf;

			#連線到遠端的ssh參數

			$remote="";

			#如果有 remoteIp 參數

			if(isset($conf["external::callShell"]["remoteIp"])){

				#設置 remote ip

				$remote=$conf["external::callShell"]["remoteIp"];

				#移除之

				unset($conf["external::callShell"]["remoteIp"]);

				#如果有 remoteUser 參數

				if(isset($conf["external::callShell"]["remoteUser"])){

					#設置 remote user

					$remote=$conf["external::callShell"]["remoteUser"]."@".$remote;

					#移除之

					unset($conf["external::callShell"]["remoteUser"]);

					}#if end

				}#if end

			#設置不執行,只要印出指令內容

			$conf["external::callShell"]["doNotRun"]="true";

			#設置不escape

			#$conf["external::callShell"]["escapeshellarg"]="false";

			#函式說明:

			#呼叫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["noEcaped"],陣列,儲存重新排序過未經過escape過的指令(key為"cmd")與參數(key為"argu")與兩者組合的一維陣列(key為"array").

			#必填參數:

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

			#$conf["external::callShell"]["command"]="";

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

			#$conf["external::callShell"]["fileArgu"]=__FILE__;

			#可省略參數:

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

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

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

			#$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["remoteIp"],字串,遠端ip或domainName,預設不使用,若存在則會透過ssh指令進行連線,然後執行指令.

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

			#$conf["remoteUser"],字串,遠端的使用者賬戶,預設不指定,亦即跟為運行該php程式的使用者.

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

			#參考資料:

			#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["external::callShell"]);

			unset($conf["external::callShell"]);

			#如果執行異常

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

				#設置執行不正常

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

				#設置執行錯誤

				$result["error"]=$callShell;

				#回傳結果

				return $result;

				}#if end

			#指令與參數組成的陣列

			#var_dump(__LINE__,$callShell);exit;

			#函式說明:

			#將一維陣列轉換為用特定符號間隔的字串,ex:array("1","2","3") to "a;b;c;".

			#回傳的結果:

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

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

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

			#$result["content"],處理好的字串.

			#$result["argu"],使用的參數.

			#必填參數:

			#$conf["inputArray"],字串陣列,要轉成字串的一維陣列.

			$conf["arrays::arrayToString"]["inputArray"]=$callShell["noEscaped"]["array"];

			#可省略參數:

			#$conf["spiltSymbol"],字串,用來區隔字串的符號,預設為;

			$conf["arrays::arrayToString"]["spiltSymbol"]=" ";

			#$conf["skipEnd"],字串,結尾是否不要加上符號,預設為"false",要加上符號,"true"代表不要加上符號。

			$conf["arrays::arrayToString"]["skipEnd"]="true";

			#$conf["spiltSymbolAtStart"],字串,是否要在開頭加上spiltSymbol,預設為"false",代表不要;反之為“true”.

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

			#參考資料:

			#無.

			#備註:

			#無.

			$arrayToString=arrays::arrayToString($conf["arrays::arrayToString"]);

			unset($conf["arrays::arrayToString"]);

			#如果執行異常

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

				#設置執行不正常

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

				#設置執行錯誤

				$result["error"]=$arrayToString;

				#回傳結果

				return $result;

				}#if end

			#初始化要執行的程式

			$cmd="echo";

			#初始化要在遠端執行的參數

			$argu=array($arrayToString["content"],"|","ssh",$remote);

			#函式說明:

			#呼叫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["noEcaped"],陣列,儲存重新排序過未經過escape過的指令(key為"cmd")與參數(key為"argu")與兩者組合的一維陣列(key為"array").

			#必填參數: