Subversion Repositories php-qbpwcf

	#$conf["disableReturnBase64"],字串,預設為"false"代表要回傳base64結果,反之為"true".

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

			#取得檔案的base64data

			$result["base64dataOnly"]=base64_encode($result["fullContent"]);

			}#if end

	#一次讀取一行純文字檔案的內容.

	#回傳結果:

	#$result["status"],"true"代表移除成功,"false"代表移除失敗.

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

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

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

	#$result["content"],取得的檔案內容,若沒有內容則為null,反之為字串.

	#$result["length"],取得的內容長度.

	#$result["EOF"],識別是否已經到檔案結尾,"true"代表是,"false"代表不是.

	#$result["nextLine"],整數,下一行的行號,亦即下次來讀取下一行時,lineStart參數要給予的數值.

	#$result["fileSize"],整數,檔案的大小,用於下次來讀取下一行時,preFileSize參數要給予的數值.

	#必填參數:

	#$conf["file"],字串,檔案的路徑與名稱.

	$conf["file"]="";

	#可省略參數:

	#$conf["lineStart"],整數,要從第幾行開始,起始點為1.

	#$conf["lineStart"]=1;

	#$conf["preFileSize"],整數,上次透過本函式取得的fileSize結果,用於確認檔案是否有被rotate過,預設不設置.

	#$conf["preFileSize"]=;

	#可省略參數:

	#無

	#參考資料:

	#無.

	#備註:

	#無

	*/

	public static function getTextFilePart(&$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(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("file");

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

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

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

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

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

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

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

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

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

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

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

		$conf["variableCheck::checkArguments"]["skipableVariableName"]=array("lineStart","preFileSize");

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

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

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

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

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

		#取得檔案資訊,包含檔案的大小

		#函式說明:

		#取得節點的資訊.

		#回傳結果:

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

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

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

		#$result["content"],檔案資訊陣列.

		#$result["content"]["is_folder"],是否為目錄,"true"代表是,"false"代表不是.

		#$result["content"]["ownerPerm"],檔案擁有者權限資訊.

		#$result["content"]["groupPerm"],檔案歸屬群組權限資訊.

		#$result["content"]["otherPerm"],檔案對於其他身份使用者的權限資訊.

		#$result["content"]["subElementCount"],目錄底下的檔案目錄數量.

		#$result["content"]["ownerName"],檔案擁有着資訊.

		#$result["content"]["groupName"],檔案所屬擁有着資訊.

		#$result["content"]["size"],檔案大小.

		#$result["content"]["modifyDate"],檔案變更年月日.

		#$result["content"]["modifyTime"],檔案變更時分秒.

		#$result["content"]["modifyTimeFloat"],檔案變更時間秒的float數值.

		#$result["content"]["timezone"],檔案變更時間的時區與UTC的差距.

		#必填參數:

		#$conf["fileArgu"],字串,當前檔案的位置亦即__FILE__的內容.

		$conf["fileAccess::fileInfo"]["fileArgu"]=__FILE__;

		#$conf["file"],字串,要查看擁有者資訊的檔案.

		$conf["fileAccess::fileInfo"]["file"]=$conf["file"];

		#可省略參數:

		#$conf["web"],檔案是否位於網站上"true",若是在檔案系統則為"false",預設為"true".

		$conf["fileAccess::fileInfo"]["web"]="false";

		#參考資料:

		#fileowner=>http://php.net/manual/en/function.fileowner.php

		#posix_getpwuid=>http://php.net/manual/en/function.posix-getpwuid.php

		#備註:

		#無.

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

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

		#如果執行異常

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

			#設置執行失敗

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

			#設置執行錯誤訊息

			$result["error"]=$fileInfo;

			#回傳結果

			return $result;

			}#if end

		#如果有設置

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

			#如果檔案大小變小

			if( $conf["preFileSize"] < (int)$fileInfo["content"]["size"] ){

				#代表檔案被 rotate 了

				#設置從頭開始讀取

				$conf["lineStart"]=1;

				}#if end

			}#if end

		#取得檔案大小

		$result["fileSize"]=$fileInfo["content"]["size"];

		#函式說明:

		#呼叫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["fileAccess::callShell"]["command"]="getContentByLineRange.php";

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

		$conf["fileAccess::callShell"]["fileArgu"]=__FILE__;

		#可省略參數:

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

		$conf["fileAccess::callShell"]["argu"]=array($conf["lineStart"],$conf["lineStart"]+1,$conf["file"]);

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

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

		#debug

		#var_dump(__LINE__,$callShell);

		#預設尚未到檔案結尾

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

		#如果沒有內容

		if(empty($callShell["output"])){

			#代表檔案被 rotate 了

			#設置到檔案結尾了

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

			#設置下一行的行號為當前行號

			$result["nextLine"]=$conf["lineStart"];

			#設置沒有內容

			$result["content"]=null;

			}#if end

		#反之

		else{

			#取得行內容

			$result["content"]=$callShell["output"][0];

			}#else end

		#如果沒有下一行的內容

		if(!isset($callShell["output"][1])){

			#設置已經到檔案結尾了

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

			#設置下一行的行號為當前行號

			$result["nextLine"]=$conf["lineStart"];

			}#if end

		#反之

		else{

			#設置下一行的行號

			$result["nextLine"]=$conf["lineStart"]+1;

			}#else end

		#儲存執行的指令內容

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

		#取得行內容長度

		$result["length"]=strlen($result["content"]);

		#設置執行正常

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

		#回傳結果

		return $result;

		}#function getTextFilePart end

	/*

	#函式說明: