Subversion Repositories php-qbpwcf

	#$conf["signGpgThroughSocket"],字串,"true"代表簽署gpg id的操作透過qbpwcf-uscok.service處理;預設為"false",直接用執行本程式的使用者來執行.

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

	#$conf["gpgPrivateKeyUser"],字串,當參數"signGpgThroughSocket"為"true"時,需要切換到哪個使用者才能取得gpg private key,預設使用運行qbpwcf-uscok.service的使用者.

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

		#設置 MIME Version

		$head=$head."MIME-Version: 1.0\r\n";

		$mixBoundaryE=$mixBoundaryS."--";

		#函式說明:

		#建立以圖片(PNG格式)呈現的驗證碼.

		#回傳的解果：

		#$result["status"],執行是否正常,"true"代表執行成功,"false"代表執行失敗.

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

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

		#$result["randNumberWord"],傳驗證碼的內容.

		#$result["imgAddress"],包含src圖片的位置與名稱.

		#$result["imgSrcVal"],放在src裏面的圖片位置與名稱.

		#必填參數:

		#$conf["imgAddressAndName"],字串,爲驗證碼圖片儲存的位置與名稱，副檔名程式會自動產生

		$conf["authenticate::validationCode"]["imgAddressAndName"]="/tmp/xxx.png";

		#$conf["fileArgu"],字串,php變數__FILE__的內容,亦即該檔案在檔案系統的絕對路徑

		$conf["authenticate::validationCode"]["fileArgu"]=__FILE__;

		#可省略參數：

		#$conf["num"],字串,爲驗證碼的位數,請輸入阿拉伯數字,預設為"8"位數.

		#$conf["num"]="8";

		#$conf["disableImg"],字串,是否要取消驗證碼圖片的輸出,"true"為要取消,預設為"false"為不取消

		$conf["authenticate::validationCode"]["disableImg"]="true";

		#$conf["imgToData"],字串,預設為"true"代表將圖片轉存成base64圖片,並將原始圖片移除;反之為"false"

		#$conf["imgToData"]="true";

		#$conf["class"],字串,圖片要套用的css樣式類別.

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

		#$conf["content"],字串陣列,允許的亂數陣列內容,預設爲(1~9 and A~Z).

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

		#參考資料:

		#無.

		#備註:

		#無.

		$validationCode=authenticate::validationCode($conf["authenticate::validationCode"]);

		unset($conf["authenticate::validationCode"]);

		#如果檢查失敗

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

			#設置錯誤識別

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

			#設置錯誤訊息

			$result["error"]=$validationCode;

			#回傳結果

			return $result;

			}#if end

		#初始化 boundary

		$altBoundary=$validationCode["randNumberWord"];

		#初始化 boundary start

		$altBoundaryS="--".$altBoundary;

		#初始化 boundary end

		#設置信件本文(純文字與html兩種)

		$body=$body.$altBoundaryS."\r\n";

		$body=$body."Content-Type: text/plain; charset=UTF-8\r\n";

		$body=$body."\r\n";

		$body=$body.$conf["plainBody"]."\r\n";

		$body=$body."\r\n";

		$body=$body.$altBoundaryS."\r\n";

		$body=$body."Content-Type: text/html; charset=UTF-8\r\n";

		$body=$body."\r\n";

		$body=$body.$conf["htmlBody"]."\r\n";

		$body=$body."\r\n";

		#如果沒有附件

		if(!isset($conf["attachment"])){

			#alt Boundary end 

			$body=$body.$altBoundaryE."\r\n";

			}#if end

		else{

			#將原本放置於head的alt Contet-Type描述,變成body的內容,串在 body 前面.

			$body=$contentDescInHead.$body;

			#更新放置於head的Contet-Type描述

			$contentDescInHead="Content-Type: multipart/mixed; boundary=".$mixBoundary."\r\n\r\n";

			#設置目前的 type 為 mix,代表有 text 跟 html 以及 attachment

			#設置 mix boundary start,串在 body 其面.

			$body=$mixBoundaryS."\r\n".$body;

				#debug

				#var_dump(__LINE__,$checkMutiFileExist);exit;

				#取得附件的絕對位置

				$attachAddr=$checkMutiFileExist["varNameFullPath"][0];

				#函式說明:

				#依據行號分隔抓取檔案的內容,結果會回傳一個陣列

				#$result["status"],執行是否成功，"true"代表成功；"fasle"代表失敗.

				#$result["error"],錯誤訊息提示.

				#$result["warning"],警告訊息.

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

				#$result["fileContent"],爲檔案的內容陣列.

				#$result["lineCount"],爲檔案內容總共的行數.

				#$result["fullContent"],為檔案的完整內容.

				#$result["base64dataOnly"],檔案的base64data.

				#$result["base64data"],為在網頁上給予src參數的數值.

				#$result["mimeType"],為檔案的mime type.

				#必填參數:

				#$conf["filePositionAndName"],字串,爲檔案的位置以及名稱.

				$conf["fileAccess::getFileContent"]["filePositionAndName"]=$attachAddr;

				#$conf["fileArgu"],字串,php變數__FILE__的內容,亦即該檔案在檔案系統的絕對路徑

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

				#可省略參數:

				#$conf["web"],是要取得網路上的檔案則為"true";反之預設為"false".

				#$conf["web"]="true";

				#$conf["createIfnotExist"],字串,預設為"false"代表檔案不存在也不需要建立;反之為"true".

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

				#$conf["autoDeleteSpaceOnEachLineStart"],字串,預設為"false",不做額外處理;反之為"true"

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

				#參考資料：

				#file(),取得檔案內容的行數.

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

				#rtrim(),剔除透過file()取得每行內容結尾的換行符號.

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

				#參考資料:

				#無.

				#無.

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

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

				#如果解析檔案資訊失敗

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

					#設置錯誤識別

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

					#回傳結果

					return $result;

				#取得檔案的 base64 內容

				$attachmentB64=$getFileContent["base64dataOnly"];

				#取得自動判斷的 mime type

				$attachmentAutoDetectedMimeType=$getFileContent["mimeType"];

				#debug

				#var_dump(__LINE__,$attachAddr,$conf["attachmentMimeType"],$conf["attachmentName"][$i]);

			#加上 mix Boundary end

			$body=$body."\r\n".$mixBoundaryE."\r\n\r\n";

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

				# 取得 username 參數 "@" 前面的內容

				#無.

					}#if end

				#預設的賬戶名稱

				$user=$conf["username"];

				#如果含有 "@" 存在

				if($delStrAfterKeyWord["founded"]==="true"){

					#取得賬戶名稱

					$user=$delStrAfterKeyWord["content"];

					}#if end

			#debug

			#var_dump(__LINE__,"data2sign",$body);

			#初始化要給 external::callShell 的 argu 參數內容

			$arguForExternalCallShell=array(base64_encode($body),"|");

			#如果是要透過 qbpwcf-uscok 來進行

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

				#如果有指定 gpgPrivateKeyUser 參數

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

					#加上使用 sudo 指令

					$arguForExternalCallShell[]="sudo";

					#加上指定使用者的參數識別

					$arguForExternalCallShell[]="-u";

					#加上指定使用者的參數數值

					$arguForExternalCallShell[]=$conf["gpgPrivateKeyUser"];

					}#if end

				}#if end

			#使用 gpg 指令

			$arguForExternalCallShell[]="gpg";

			#指定 id 的參數

			$arguForExternalCallShell[]="-u";

			#指定 id

			$arguForExternalCallShell[]=$conf["signWithGPGid"];

			#指定 要簽署 的參數

			$arguForExternalCallShell[]="--armor";

			#指定要可以清楚識別的簽署方式

			$arguForExternalCallShell[]="--detach-sign";

			#如果是要透過 qbpwcf-uscok 來進行

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

				#函式說明:

				#連線到 usr/bin/qbpwcf-usock.php 產生的  unix domain socket,運行指定的指令.

				#回傳結果:

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

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

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

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

				#$result["content"],執行完指令的結果,回傳的格式為external::callShell的回傳結果.

				#必填參數:

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

				$conf["sock::execAnyCmdByQBPWCFunixSocket"]["fileArgu"]=__FILE__;

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

				$conf["sock::execAnyCmdByQBPWCFunixSocket"]["command"]="base64decode.php";

				#可省略參數:

				#$conf["sock"],字串,要連線的 usr/bin/qbpwcf-sock.php(sock::unixDomainSockServer) 所產生的 unix domain socket 路徑與名稱,預設為 qbpwcf_usock_path.

				#$conf["sock"]=qbpwcf_usock_path;

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

				$conf["sock::execAnyCmdByQBPWCFunixSocket"]["argu"]=$arguForExternalCallShell;

				#$conf["commandIncludeArgu"],字串,是否command含有參數,預設為"false"代表沒有;反之為"true".

				$conf["sock::execAnyCmdByQBPWCFunixSocket"]["commandIncludeArgu"]="false";

				#$conf["commandInBg"],字串,是否要將程序放在背景執行,再取得相關資訊,預設為"false"代表不要;反之為"true".

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

				#參考資料:

				#無.

				#備註:

				#無.

				$execAnyCmdByQBPWCFunixSocket=sock::execAnyCmdByQBPWCFunixSocket($conf["sock::execAnyCmdByQBPWCFunixSocket"]);

				unset($conf["sock::execAnyCmdByQBPWCFunixSocket"]);

				#如果解析檔案資訊失敗

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

					}#if end

				#取得執行後的回傳結果

				$callShell=$execAnyCmdByQBPWCFunixSocket["content"];

			#反之

			else{

				#用gpg指令簽署body

				#函式說明:

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

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

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

				#可省略參數:

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

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

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

				#參考資料：

				#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"]);

				}#else end

			#debug

			#var_dump(__LINE__,$callShell);exit;

			#描述內容為 gpg key 簽署的 head 資訊 需要 word wrap

			$gpgData=wordwrap($gpgData,70,"\r\n",true);

			#gpg header 需要 word wrap

			$signDataOfGPG=wordwrap($signDataOfGPGhead,70,"\r\n",true).$signDataOfGPG."\r\n";

			#串接 data

			#$body=$contentDescInHead."\r\n\r\n".$body;

		#串接 data

		$body=$contentDescInHead."\r\n\r\n".$body;