WebSVN – php-qbpwcf – Diff – /trunk/usr/bin/webSocketServer.php

 #!/usr/bin/php
 <?php
 /*
 	QBPWCF, Quick Build PHP website Component base on Fedora Linux.
-    Copyright (C) 2015~2024 Min-Jhin,Chen
+    Copyright (C) 2014~2025 MIN ZHI, CHEN
     This file is part of QBPWCF.
     QBPWCF is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
     You should have received a copy of the GNU General Public License
     along with QBPWCF.  If not, see <http://www.gnu.org/licenses/>.
 */
 /*
 說明:
 啟動 web socket server.
 	#結束執行,回傳shell 1.
 	exit(1);
 	}#if end
 #設置 include path
 set_include_path($output[0].PATH_SEPARATOR.get_include_path());
 #匯入外部套件
 include("allInOne.php");
 #說明函式
 function help()
+{
 	#印出指令說明
 	echo "Usage of ".basename(__FILE__).":".PHP_EOL;
 	echo "--addr 代表 Server 要 Listen 的 address".PHP_EOL;
 	echo "--port 代表 Server 要 Listen 的 port".PHP_EOL;
 	#結束執行
 	exit;
+}
 #函式說明:
 #如果解析參數失敗
 if($parseArgu["status"]==="false")
+{
 	#印出結果
 	var_dump($parseArgu);
 	#結束執行
 	exit;
 }#if end
 #如果沒有 addr 參數
 if(!isset($parseArgu["content"]["addr"])){
 #若執行失敗
 if($checkArguments["status"]==="false"){
 	#印出結果
 	var_dump($checkArguments);
 	#結束執行
 	exit;
 	}#if end
 #若檢查不通過
 if($checkArguments["passed"]==="false"){
 	#印出結果
 	var_dump($checkArguments);
 	#結束執行
 	exit;
 	}#if end
 #如果 啟動失敗
 if($nativeSocketTcpIpServer["status"]==="false"){
 	#印出結果
 	var_dump($nativeSocketTcpIpServer);
 	#結束執行
 	exit;
 	}#if end
 /*
 #函式說明:
 #提供取得當前路徑的功能
 #回傳結果:
 #$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
 #$result["function"],當前執行的函數名稱.
 #$result["content"],加密後的結果.
 #$result["error"],錯誤訊息陣列.
 #$result["argu"],使用的參數.
 #必填參數:
 	#涵式說明：
 	#判斷當前環境為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($conf==null){
 			#設置執行錯誤訊息
 			$result["error"][]="\$conf變數不得為null,請檢查函數「".$result["function"]."」的參數設置有無正確!";
 			}#if end
 		#回傳結果
 		return $result;
 		}#if end
 	#檢查參數
 	#函式說明：
 	#檢查必填與可省略的參數，可省略參數可指定預設要給與什麼數值內容。
 	#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
 	#$reuslt["error"],執行不正常結束的錯訊息陣列.
 	#$conf["canBeEmpty"]=array();
 	#$conf["skipableVariableCanNotBeEmpty"],字串陣列,哪些可省略參數不可以為空字串或空陣列.
 	#$conf["variableCheck::checkArguments"]["skipableVariableCanNotBeEmpty"]=array();
 	#$conf["skipableVariableName"],陣列字串,爲可省略參數的變數名稱陣列，形態爲陣列變數，例如: $conf["skipableVariableName"] = array("id","account","password");
 	#$conf["variableCheck::checkArguments"]["skipableVariableName"]=array("listenIp","listenPort","wsMode","processFuncs");
 	#$conf["skipableVariableType"],陣列字串,爲可省略參數的變數名稱陣列，形態爲陣列變數，例如: $conf["skipableVariableType"] = array("string",integer,"double");
 	#$conf["variableCheck::checkArguments"]["skipableVariableType"]=array("string","string","string","array");
 	#$conf["skipableVarDefaultValue"],字串陣列,每個不存在的可省略變數要初始化為什麼,null與代表不指定,若預設值是參數之一，請將$conf["mustBeFilledVar"]改成"\$conf["\mustBeFilledVar\"]".
 	#$conf["variableCheck::checkArguments"]["skipableVarDefaultValue"]=array("127.0.0.1",null,"false",null);
 	#$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
 	#取得收到的訊息
 	$receivedData=$conf["data"];
 	#取得 server 的 socket
 	$serverSocket=$conf["serverSock"];
 	#取得 client 的 socket
 	$clientSocket=$conf["clientSock"];
 	#取得 client 的資訊
 	$clientInfo=$conf["clientInfo"];
 	#取得 client 的索引
 	$clientIndex=$conf["clientIndex"];
 	#取得 all clients 的資訊
 	$allConn=$conf["allConn"];
 	#函式說明:
 	#呼叫shell執行系統命令,並取得回傳的內容.
 	#回傳結果:
 	#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
 	#$result["error"],錯誤訊息陣列.
 	#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);
 	unset($conf);
 	#如果執行失敗
 	if($callShell["status"]==="false"){
 		#印出結果
 		return $callShell;
 		}#if end
 	#取得經過編碼的執行後結果字串
 	$callShellResultStr=base64_encode(urlencode(json_encode($callShell)));
 	#debug
 	#var_dump(__LINE__,$callShellResultStr);
 	#函式說明:
 	#加密 handshake 後要傳送的訊息
 	#回傳結果:
 	#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
 	#$result["error"],執行不正常結束的錯訊息陣列.
 	#$result["content"],陣列,加密 handshake 後要傳送給 client 的訊息,若有多個代表要分為多個 Fragmentation 來依序傳送.
 	#$result["argu"],陣列,使用的參數.
 	#$conf["ping"]="true";
 	#參考資料:
 	#https://www.rfc-editor.org/rfc/rfc6455#page-28, Web Socket Base Framing Protocol.
 	#備註:
 	#目前$conf["text"]長度超過125會出錯.
 	$talkback=webSock::encode($conf["webSock::encode"]);
 	unset($conf["webSock::encode"]);
 	#如果產生 web socket 格式封包 失敗
 	if($talkback["status"]==="false"){
 		#印出結果
 		return $talkback;
 		}#if end
 	#針對每個訊息的分段
 	foreach($talkback["content"] as $msgIndex=>$msg){
 		#debug - start
 		#提示第幾個訊息
 		echo "第 ".($msgIndex+1)." 個訊息的內容:".PHP_EOL;
 		#函式說明:
 		#將字串中的每個字變成bytes陣列
 		#回傳結果:
 		#$result["content"],bytes陣列.
 		#必填參數:
 		#無.
 		#備註:
 		#無.
 		$str2bytesArray=stringProcess::str2bytesArray($conf["stringProcess::str2bytesArray"]);
 		unset($conf["stringProcess::str2bytesArray"]);
 		#如果執行失敗
 		if($str2bytesArray["status"]==="false"){
 			#印出結果
 			return $str2bytesArray;
 			}#if end
 		#針對每個 bytes
 		foreach($str2bytesArray["content"] as $byteIndex=>$bytes){
 			#函式說明:
 			#將bytes數字(16進位)轉換為bit字串(0跟1來表述)
 			#回傳結果:
 			#$result["content"],bit字串(0跟1來表述).
 			#必填參數:
 			#無.
 			#備註:
 			#無.
 			$bytes2bitString=stringProcess::bytes2bitString($conf["stringProcess::bytes2bitString"]);
 			unset($conf["stringProcess::bytes2bitString"]);
 			#如果執行失敗
 			if($bytes2bitString["status"]==="false"){
 				#印出結果
 				return $bytes2bitString;
 			}#if end
 			#印出 8bit
 			echo $bytes2bitString["content"];
 			#如果為 32 bit 結束
 			if(($byteIndex+1)%4===0){
 				#印出換行符號
 				echo PHP_EOL;
 				}#if end
 			}#foreach end
 		#debug - end
 		#回傳訊息
 		$socket_write=socket_write($clientSocket, $msg, strlen($msg));
 		#換行
 		echo PHP_EOL;
 		#debug
 		#var_dump(__LINE__,$socket_write,socket_strerror(socket_last_error($clientSocket)));
 		}#foreach end
 	#初始化結果
 	$result=array();
 	#設置執行正常
 	$result["status"]="continue";
 	#回傳結果
 	return $result;
 	}#function pwd end
 /*
 #函式說明:
 #讓 web socket server 尋找對應的 session 檔案內容,看是否透過 email 認證了.
 #回傳結果:
 #$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
 #$result["function"],當前執行的函數名稱.
 #$result["content"],加密後的結果.
 #$result["error"],錯誤訊息陣列.
 #$result["argu"],使用的參數.
 #必填參數:
 	#涵式說明：
 	#判斷當前環境為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($conf==null){
 			#設置執行錯誤訊息
 			$result["error"][]="\$conf變數不得為null,請檢查函數「".$result["function"]."」的參數設置有無正確!";
 			}#if end
 		#回傳結果
 		return $result;
 		}#if end
 	#檢查參數
 	#函式說明：
 	#檢查必填與可省略的參數，可省略參數可指定預設要給與什麼數值內容。
 	#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
 	#$reuslt["error"],執行不正常結束的錯訊息陣列.
 	#$conf["canBeEmpty"]=array();
 	#$conf["skipableVariableCanNotBeEmpty"],字串陣列,哪些可省略參數不可以為空字串或空陣列.
 	#$conf["variableCheck::checkArguments"]["skipableVariableCanNotBeEmpty"]=array();
 	#$conf["skipableVariableName"],陣列字串,爲可省略參數的變數名稱陣列，形態爲陣列變數，例如: $conf["skipableVariableName"] = array("id","account","password");
 	#$conf["variableCheck::checkArguments"]["skipableVariableName"]=array("listenIp","listenPort","wsMode","processFuncs");
 	#$conf["skipableVariableType"],陣列字串,爲可省略參數的變數名稱陣列，形態爲陣列變數，例如: $conf["skipableVariableType"] = array("string",integer,"double");
 	#$conf["variableCheck::checkArguments"]["skipableVariableType"]=array("string","string","string","array");
 	#$conf["skipableVarDefaultValue"],字串陣列,每個不存在的可省略變數要初始化為什麼,null與代表不指定,若預設值是參數之一，請將$conf["mustBeFilledVar"]改成"\$conf["\mustBeFilledVar\"]".
 	#$conf["variableCheck::checkArguments"]["skipableVarDefaultValue"]=array("127.0.0.1",null,"false",null);
 	#$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
 	#取得收到的訊息
 	$receivedData=$conf["data"];
 	#取得 server 的 socket
 	$serverSocket=$conf["serverSock"];
 	#取得 client 的 socket
 	$clientSocket=$conf["clientSock"];
 	#取得 client 的資訊
 	$clientInfo=$conf["clientInfo"];
 	#取得 client 的索引
 	$clientIndex=$conf["clientIndex"];
 	#取得 all clients 的資訊
 	$allConn=$conf["allConn"];
 	#解析收到的資料
 	$receivedData=json_decode($receivedData);
 	#檢查參數($receivedData)
 	#函式說明：
 	#檢查必填與可省略的參數，可省略參數可指定預設要給與什麼數值內容。
 	#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
 	#$reuslt["error"],執行不正常結束的錯訊息陣列.
 	#$conf["canBeEmpty"]=array();
 	#$conf["skipableVariableCanNotBeEmpty"],字串陣列,哪些可省略參數不可以為空字串或空陣列.
 	#$conf["variableCheck::checkArguments"]["skipableVariableCanNotBeEmpty"]=array();
 	#$conf["skipableVariableName"],陣列字串,爲可省略參數的變數名稱陣列，形態爲陣列變數，例如: $conf["skipableVariableName"] = array("id","account","password");
 	$conf["variableCheck::checkArguments"]["skipableVariableName"]=array("timeout");
 	#$conf["skipableVariableType"],陣列字串,爲可省略參數的變數名稱陣列，形態爲陣列變數，例如: $conf["skipableVariableType"] = array("string",integer,"double");
 	$conf["variableCheck::checkArguments"]["skipableVariableType"]=array("string");
 	#$conf["skipableVarDefaultValue"],字串陣列,每個不存在的可省略變數要初始化為什麼,null與代表不指定,若預設值是參數之一，請將$conf["mustBeFilledVar"]改成"\$conf["\mustBeFilledVar\"]".
 	$conf["variableCheck::checkArguments"]["skipableVarDefaultValue"]=array("300");
 	#$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
 	#告訴 web socket server 要尋找對應的session檔案內容,看是否透過email認證了.
 	#...
-	}#function checkStatusOfEmailVarify end
+	}#function checkStatusOfEmailVarify end

Subversion Repositories php-qbpwcf

(root)/trunk/usr/bin/webSocketServer.php – Rev 66 → 226