Subversion Repositories php-qbpwcf

	#$conf["keepServiceUp"],字串,是否要另外增加確保服務有保持啟動的服務,預設為"false"代表否;反之為"true"代表是.

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

	#$conf["cmd::keepServiceUp"]["checkListen"],陣列,用來判斷服務是否有正確啟動的條件,一個元素代表,其中要有一個socket info符合之,若元素的key為"ip"，則其數值為[ipv4/ipv6]:port/protocol(tcp/udp);若元素的key為"addr",則其數值為unix domain socket 的位置與名稱;若元素的key為"name",則其數值為程序名稱.

	#$conf["cmd::keepServiceUp"]["checkListen"]=array(array("ip"=>169.254.1.1:443/tcp,"addr"=>/usr/lib/qbpwcf/qbpwcf-usock.sock,"name"=>"addr"),"name"=>"httpd");

	#$conf["cmd::keepServiceUp"]["interval"],字串,檢查沒問題後,要多少秒後再檢查一次,預設為30秒，亦即"30".

	#$conf["cmd::keepServiceUp"]["interval"]="30";

		#如果 keepServiceUp 為 "true"

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

			#檢查用於 cmd::keepServiceUp 的參數

			#函式說明:

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

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

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

			#$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["cmd::keepServiceUp"];

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

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

			#可以省略的參數:

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

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

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

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

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

			$conf["variableCheck::checkArguments"]["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("checkListen","interval");

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

			$conf["variableCheck::checkArguments"]["skipableVariableName"]=array("checkListen","interval");

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

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

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

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

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

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

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

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

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

			#要執行的php程式內容

			$phpScript2run=<<<'PHP'

#用於確保服務在線的程式 - start

#函式說明:

#執行 systemd 程序來確保服務是運行中.

#回傳結果:

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

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

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

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

#$result["content"],執行的結果.

#必填參數:

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

$conf["cmd::keepServiceUp"]["fileArgu"]=$conf["fileArgu"];

#$conf["name"],字串,服務名稱.

$conf["cmd::keepServiceUp"]["name"]=$conf["name"];

#可省略參數:

#$conf["username"],字串,要用什麼使用者來執行,預設為root使用者

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

#$conf["password"],字串,使用者的密碼,預設不使用.

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

#$conf["checkListen"],陣列,用來判斷服務是否有正確啟動的條件,一個元素代表,其中要有一個socket info符合之,若元素的key為"ip"，則其數值為[ipv4/ipv6]:port:protocol(tcp/udp);若元素的key為"addr",則其數值為unix domain socket 的位置與名稱;若元素的key為"name",則其數值為程序名稱.

#$conf["checkListen"]=array(array("ip"=>169.254.1.1:443/tcp,"addr"=>/usr/lib/qbpwcf/qbpwcf-usock.sock,"name"=>"addr"),"name"=>"httpd");

#$conf["interval"],字串,檢查沒問題後,要多少秒後再檢查一次,預設為30秒，亦即"30".

#$conf["interval"]="30";

#$conf["reportOnly"],字串,"true"代表不「啟動/重新啟動」服務,只是輸出訊息表示服務有正常或需要處理;預設為"false"代表直接「啟動/重新啟動」.

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

#$conf["verbose"],字串,預設為"false",若為"true"則會印出過程訊息.

$conf["cmd::keepServiceUp"]["verbose"]="true";

#$conf["onlyWhenEnable"],字串,預設為"true",代表若服務為enable才會將其變成運行中;反之為"false".

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

#參考資料:

#無.

#備註:

#無.

$keepServiceUp=cmd::keepServiceUp($conf["cmd::keepServiceUp"]);

unset($conf["cmd::keepServiceUp"]);

#如果執行異常

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

	#設置執行失敗

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

	#設置錯誤訊息

	$result["error"]=$keepServiceUp;

	#回傳結果

	return $result;

	}#if end

#用於確保服務在線的程式 - end

PHP;

			#遞迴呼叫,建立用於確保 $conf[name] 服務在線的服務

			#函式說明:

			#將要執行的程式變成透過 systemd 來運行.

			#回傳結果:

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

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

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

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

			#$result["content"],執行的結果.

			#必填參數:

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

			$paramsOfRegisterService["fileArgu"]=__FILE__;

			#$conf["name"],字串,服務名稱,實際產生的system名稱會加上".service".

			$paramsOfRegisterService["name"]=$conf["name"]."-keep";

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

			$paramsOfRegisterService["cmd"]="php";

			#可省略參數:

			#$conf["params"],字串陣列,指令要使用的參數.

			$paramsOfRegisterService["params"]=array("-r",$phpScript2run);

			#$conf["enable"],字串,預設為"true",代表該服務為enable.

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

			#$conf["startNow"],字串,預設為"true",代表該服務要立刻執行.

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

			#$conf["keepServiceUp"],字串,是否要另外增加確保服務有保持啟動的服務,預設為"false"代表否;反之為"true"代表是.

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

			#$conf["cmd::keepServiceUp"]["checkListen"]=array(array("ip"=>169.254.1.1:443/tcp,"addr"=>/usr/lib/qbpwcf/qbpwcf-usock.sock,"name"=>"addr"),"name"=>"httpd");

			#$conf["cmd::keepServiceUp"]["interval"],字串,檢查沒問題後,要多少秒後再檢查一次,預設為30秒，亦即"30".

			#$conf["cmd::keepServiceUp"]["interval"]="30";

			#參考資料:

			#無.

			#備註:

			#無.

			$registerService=cmd::registerService($paramsOfRegisterService);

			#如果執行異常

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

				#設置執行失敗

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

				#設置錯誤訊息

				$result["error"]=$registerService;

				#回傳結果

				return $result;

				}#if end

			#記錄運行 cmd::keepServiceUp 的回傳結果

			$result["content"]=$registerService;

			}#if end