Subversion Repositories php-qbpwcf

Rev

Rev 226 | Go to most recent revision | Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
3 liveuser 1
#!/usr/bin/php
2
<?php
3
 
4
/*
5
	QBPWCF, Quick Build PHP website Component base on Fedora Linux.
6
    Copyright (C) 2015~2024 Min-Jhin,Chen
7
 
8
    This file is part of QBPWCF.
9
 
10
    QBPWCF is free software: you can redistribute it and/or modify
11
    it under the terms of the GNU General Public License as published by
12
    the Free Software Foundation, either version 3 of the License, or
13
    (at your option) any later version.
14
 
15
    QBPWCF is distributed in the hope that it will be useful,
16
    but WITHOUT ANY WARRANTY; without even the implied warranty of
17
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18
    GNU General Public License for more details.
19
 
20
    You should have received a copy of the GNU General Public License
21
    along with QBPWCF.  If not, see <http://www.gnu.org/licenses/>.
22
 
23
*/
24
 
25
/*
26
說明:
27
啟動 用來接收 request 來跟 web socket server 互動.
28
 
29
範例:
30
webSocketClientDaemon.php [--domain server.wss.org] [--path wss] [--port 443]
31
*/
32
 
33
#使用命名空間qbpwcf
34
namespace qbpwcf;
35
 
36
#取得 lib path
37
exec("php -f ".escapeshellarg(pathinfo(__FILE__)["dirname"]."/libexec/folderOfUsrLib.php"),$output,$status);
38
 
39
#如果執行失敗
40
if($status!==0){
41
 
42
	#debug
43
	var_dump(__LINE__,$output);
44
 
45
	#結束執行,回傳shell 1.
46
	exit(1);
47
 
48
	}#if end
49
 
50
#儲存lib path
51
$folderOfUsrLib=$output[0];
52
 
53
#以該檔案的實際位置的 lib path 為 include path 首位
54
$output=array();
55
exec("cd ".escapeshellarg(pathinfo(__FILE__)["dirname"]."/../".$folderOfUsrLib."/qbpwcf").";pwd;",$output,$status);
56
 
57
#如果執行失敗
58
if($status!==0){
59
 
60
	#debug
61
	var_dump(__LINE__,$output);
62
 
63
	#結束執行,回傳shell 1.
64
	exit(1);
65
 
66
	}#if end
67
 
68
#設置 include path 
69
set_include_path($output[0].PATH_SEPARATOR.get_include_path());
70
 
71
#匯入外部套件
72
include("allInOne.php");
73
 
74
#說明函式
75
function help()
76
{
77
	#印出指令說明
78
	echo "Usage of ".basename(__FILE__).":".PHP_EOL; 
79
	echo "--domain 代表要連線的 web socket 服務域名".PHP_EOL;
80
	echo "--path 代表要連線的 web socket 服務path,預設為 wss".PHP_EOL;
81
	echo "--port 代表要連線的 web socket 服務port,預設為 443".PHP_EOL;
82
 
83
	#結束執行
84
	exit;
85
}
86
 
87
#函式說明:
88
#解析參數.
89
#回傳結果:
90
#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
91
#$reuslt["error"],執行不正常結束的錯訊息陣列.
92
#$result["function"],當前執行的函式名稱.
93
#$result["content"],解析好的參數陣列.
94
#$result["content"][$key][$i],參數 $key 的 $i+1 個參數數值內容.
95
#$result["program"],字串,執行的程式名稱.
96
#必填參數:
97
#無
98
#可省略參數:
99
#$conf["helpFunc"],如果解析的參數不成對,則要執行的函式名稱.
100
$conf["helpFunc"]="help";
101
#備註:
102
#僅能在命令列底下執行.
103
#建議:
104
#以後可將參數 --a--b 的名稱與後面的數值 $value 存成 $result["a"]["b"][$i]=$value .
105
$parseArgu=cmd::parseArgu($conf);
106
unset($conf);
107
 
108
#如果解析參數失敗
109
if($parseArgu["status"]==="false")
110
{
111
	#印出結果
112
	var_dump($parseArgu);
113
 
114
	#結束執行,回傳shell 1
115
	exit(1);
116
 
117
}#if end
118
 
119
#檢查參數
120
#函式說明:
121
#檢查必填與可省略參數,可省略參數可指定預設要給與什麼數值內容。
122
#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
123
#$reuslt["error"],執行不正常結束的錯訊息陣列.
124
#$result["function"],當前執行的函式名稱.
125
#$result["passed"],識別要檢查的全體變數是否存在以及型態是否正確的變數,"true"代表檢查全部通過;"false"代表檢查不通過
126
#$result[$shouldBeCheckedVarName]["varExist"],所檢查的變數是否存在,"false"代表不存在;"true"代表存在
127
#$result[$shouldBeCheckedVarName]["varType"],所檢查的變數型態是否正確,"false"代表錯誤;"true"代表正確
128
#$result[$shouldBeCheckedVarName]["error"],每個參數設定的錯誤訊息
129
#$result["shouldNotBeEmpty"],不應該為空字串或控陣列的變數.
130
#$result["argu"],字串陣列,目前輸入的參數名稱陣列.
131
#$result["legalVarName"],字串陣列,合法可用的參數名稱陣列.
132
#$result["notNeedVar"],字串陣列,多餘的參數名稱.
133
#必填寫的參數:
134
#$conf["varInput"],陣列變數,要檢查的陣列變數,請在要檢查的參數前面加上&,這樣變動的結果才能被套用。
135
$conf["varInput"]=&$parseArgu["content"];
136
#$conf["referenceVarKey"],字串,$conf參數後面的key值,用於移除不要的參考陣列.
137
$conf["referenceVarKey"]="variableCheck::checkArguments";
138
#可以省略的參數:
139
#$conf["mustBeFilledVariableName"],爲必填參數的變數名稱陣列,形態爲陣列變數,元素數量需要跟"mustBeFilledVariableType"參數的元素數量一致,例如: $conf["mustBeFilledVariableName"] = array("id","account","password");
140
$conf["mustBeFilledVariableName"]=array("domain");
141
#$conf["mustBeFilledVariableType"],爲必填參數的變數陣列應該爲何種變數形態,形態爲陣列,元素數量需要跟"mustBeFilledVariableName"參數的元素數量一致,例如: $conf["mustBeFilledVariableType"] = array("string",integer,"double","resource","object"); , null代表不指定變數形態.
142
$conf["mustBeFilledVariableType"]=array("array");
143
#$conf["canBeEmptyString"],字串,必填變數內容如果是空字串就不能算是有設置的話,請設為"false",預設爲"true",可以為空字串.
144
$conf["canBeEmptyString"]="false";
145
#$conf["canNotBeEmpty"],字串陣列,哪些必填參數的內容不得為空字串或空陣列,僅當$conf["canBeEmptyString"]為"true"時會生效.
146
#$conf["canNotBeEmpty"]=array();
147
#$conf["canBeEmpty"],字串陣列,哪些必填參數的內容可為空字串或空陣列,僅當$conf["canBeEmptyString"]為"false"時會生效.
148
#$conf["canBeEmpty"]=array();
149
#$conf["skipableVariableCanNotBeEmpty"],字串陣列,哪些可省略參數不可以為空字串或空陣列.
150
$conf["skipableVariableCanNotBeEmpty"]=array("path","port");
151
#$conf["skipableVariableName"],陣列字串,爲可省略參數的變數名稱陣列,形態爲陣列變數,例如: $conf["skipableVariableName"] = array("id","account","password");
152
$conf["skipableVariableName"]=array("path","port");
153
#$conf["skipableVariableType"],陣列字串,爲可省略參數的變數名稱陣列,形態爲陣列變數,例如: $conf["skipableVariableType"] = array("string",integer,"double");
154
$conf["skipableVariableType"]=array("array","array");
155
#$conf["skipableVarDefaultValue"],字串陣列,每個不存在的可省略變數要初始化為什麼,null與代表不指定,若預設值是參數之一,請將$conf["mustBeFilledVar"]改成"\$conf["\mustBeFilledVar\"]".
156
$conf["skipableVarDefaultValue"]=array(array("wss"),array(443));
157
#$conf["disallowAllSkipableVarIsEmpty"],字串,是否允許每個可省略參數都為空字串,預設為"true"允許,反之為"false".
158
#$conf["variableCheck::checkArguments"]["disallowAllSkipableVarIsEmpty"]="false";
159
#$conf["disallowAllSkipableVarIsEmptyArray"],字串,是否允許每個可省略參數都為空陣列,預設為"true"允許,反之為"false".
160
#$conf["disallowAllSkipableVarIsEmptyArray"]="";
161
#$conf["arrayCountEqualCheck"],字串陣列,為檢查哪些陣列參數的元素數量要一樣,$conf["arrayCountEqualCheck"][$i]=array()為第$i組key為哪些的變數其元素數量要相等.
162
#$conf["arrayCountEqualCheck"][]=array();
163
#參考資料來源:
164
#array_keys=>http://php.net/manual/en/function.array-keys.php
165
$checkArguments=variableCheck::checkArguments($conf);
166
unset($conf);
167
 
168
#若執行失敗
169
if($checkArguments["status"]==="false"){
170
 
171
	#印出結果
172
	var_dump($checkArguments);
173
 
174
	#結束執行,回傳shell 1
175
	exit(1);
176
 
177
	}#if end
178
 
179
#若檢查不通過
180
if($checkArguments["passed"]==="false"){
181
 
182
	#印出結果
183
	var_dump($checkArguments);
184
 
185
	#結束執行,回傳shell 1
186
	exit(1);
187
 
188
	}#if end
189
 
190
#預設的 unix doamin socket
191
#$defaultUnixDomainSocket="./".basename(__FILE__).".sock";
192
 
193
#取得各項參數
194
$addr=$parseArgu["content"]["domain"][0];
195
$path=$parseArgu["content"]["path"][0];
196
$port=$parseArgu["content"]["port"][0];
197
 
198
#函式說明:
199
#透過proc來多執行序運作.
200
#回傳結果:
201
#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
202
#$reuslt["error"],執行不正常結束的錯訊息陣列.
203
#$result["function"],當前執行的函式名稱.
204
#$result["argu"],使用的參數.
205
#$result["content"],陣列,每個元素為其指令執行的結果訊息陣列,key為"status"代表執行是否正常的識別;key為"statusCode"代表程式結束後回傳給對應executeBy程式的數值;key為"output"代表標準輸出,若為resource,則代表為pipe;key為"error"代表非標準輸出,若為resource,則代表為pipe;key為"input"代表成功輸入的指令;key為"process"代表該程序經proc_open後的process source;key為"proc_get_status"代表程序的資訊.
206
#必填參數:
207
#$conf["cmds"],字串陣列,每個元素代表要執行的指令與參數.
208
$conf["cmds"]=array(pathinfo(__FILE__)["dirname"]."/libexec/webSocketClientDaemon.php --domain ".$addr." --path ".$path." --port ".$port);
209
#可省略參數:
210
#$conf["wait"],字串,是否需要等待所有程序結束,預設為"true"要等待;反之為"false"不要等待.
211
$conf["wait"]="false";
212
#$conf["workingDir"],字串陣列,個別程式執行時的家目錄,預設不指定.
213
#$conf["workingDir"]=array("path");
214
#$conf["envs"],2維字串陣列,每個元素代表個別程式執行時的指定環境變數,key變數名稱;value為變數內容.預設為array("QBPWCF" => "Quick Build PHP Website Componment base on Fedora Linux");
215
#$conf["envs"]=array(array("key"=>"value"));
216
#$conf["executeBy"],字串陣列,每個元素代表個別指令要用什麼程式執行,預設為"bash".
217
#$conf["executeBy"]=array("bash");
218
#參考資料:
219
#https://www.php.net/manual/en/function.proc-open.php
220
#https://www.php.net/manual/en/function.proc-get-status.php
221
#備註:
222
#無.
223
$proc=threads::proc($conf);
224
unset($conf);
225
 
226
#如果執行失敗
227
if($proc["status"]==="false"){
228
 
229
	#印出結果
230
	var_dump($proc);
231
 
232
	#結束執行,回傳shell 1
233
	exit(1);
234
 
235
	}#if end
236
 
237
#提示執行的指令
238
echo "輸入指令:".$proc["content"][0]["input"]." 成功.".PHP_EOL;
239
 
240
#無窮迴圈
241
while(true){
242
 
243
	#等待1毫秒
244
	usleep(100000);
245
 
246
	#針對每個程序
247
	foreach($proc["content"] as $index=>$process){
248
 
249
		#如果程序執行異常
250
		if($process["status"]==="false"){
251
 
252
			#debug
253
			var_dump($proc);
254
 
255
			#移除該程序資訊
256
			unset($proc["content"][$index]);
257
 
258
			}#if end
259
 
260
		#如果是 resource
261
		if(is_resource($process["process"])){
262
 
263
			#如果error為resource
264
			if(is_resource($process["error"])){
265
 
266
				#將建立的 listen sock 放到 $master 陣列
267
				$master[] = $process["error"];
268
 
269
				#設置給 stream_select 監控的sock變數
270
				$read = $write = $except = $master;
271
 
272
				#等待0.1秒,看有沒有讀寫的狀況
273
				$mod_fd = stream_select($read, $write, $except, 1);
274
 
275
				#如果偵測異動失敗
276
				if($mod_fd===FALSE){
277
 
278
					#monitior stream failed
279
 
280
					#debug
281
					var_dump($proc);
282
 
283
					#結束執行,回傳shell 1
284
					exit(1);
285
 
286
					}#if end
287
 
288
				#如果有異動的跡象
289
				else if($mod_fd>0){
290
 
291
					#針對每個異動的 stream
292
					foreach($read as $readStream){
293
 
294
						#如果是有錯誤輸出
295
						if($readStream===$process["error"]){
296
 
297
							#debug
298
							#echo "try read std error output".PHP_EOL;
299
 
300
							#讀取1Kbyte
301
							$errorByte=fread($process["error"],1024);
302
 
303
							#提示為錯誤訊息
304
							echo "error:";
305
 
306
							#印出內容
307
							echo $errorByte;
308
 
309
							#換行
310
							echo PHP_EOL;
311
 
312
							}#if end
313
 
314
						}#foreach end
315
 
316
					}#if end
317
 
318
				}#if end
319
 
320
			#如果content為resource
321
			if(is_resource($process["content"])){
322
 
323
				#將建立的 listen sock 放到 $master 陣列
324
				$master[] = $process["content"];
325
 
326
				#設置給 stream_select 監控的sock變數
327
				$read = $write = $except = $master;
328
 
329
				#等待1秒,看有沒有讀寫的狀況
330
				$mod_fd = stream_select($read, $write, $except, 1);
331
 
332
				#如果偵測異動失敗
333
				if($mod_fd===FALSE){
334
 
335
					#monitior stream failed
336
 
337
					#debug
338
					var_dump($proc);
339
 
340
					#結束執行,回傳shell 1
341
					exit(1);
342
 
343
					}#if end
344
 
345
				#如果有異動的跡象
346
				else if($mod_fd>0){
347
 
348
					#針對每個異動的 stream
349
					foreach($read as $readStream){
350
 
351
						#如果是有標準輸出
352
						if($readStream===$process["content"]){
353
 
354
							#debug
355
							#echo "try read std output".PHP_EOL;
356
 
357
							#不讓標準輸出會阻擋程式執行
358
							#stream_set_blocking($process["content"],false);
359
 
360
							#讀取1Kbyte
361
							$contentByte=fread($process["content"],1024);
362
 
363
							#如果有資料
364
							if(strlen($contentByte)>0){
365
 
366
								#如果有關鍵字
367
								if(strpos($contentByte,"unixDomainSocket:")===0){
368
 
369
									#函式說明:
370
									#將固定格式的字串分開,並回傳分開的結果.
371
									#回傳結果:
372
									#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
373
									#$result["error"],錯誤訊息陣列
374
									#$result["function"],當前執行的函數名稱.
375
									#$result["argu"],使用的參數.
376
									#$result["oriStr"],要分割的原始字串內容
377
									#$result["dataArray"],爲分割好字串的陣列內容,$result["dataArray"][$i]爲第($i+1)段的內容。
378
									#$result["dataCounts"],爲總共分成幾段
379
									#$result["found"],是否有在$conf["stringIn"]找到$conf["spiltSymbol"],"true"代表有找到,"false"代表沒有找到.
380
									#必填參數:
381
									#$conf["stringIn"],字串,要處理的字串.
382
									$conf["stringIn"]=$contentByte;
383
									#$conf["spiltSymbol"],字串,爲以哪個符號作爲分割.
384
									$conf["spiltSymbol"]="unixDomainSocket:";
385
									#可省略參數:
386
									#$conf["allowEmptyStr"],是否允許分割出來空字串,預設為"false"不允許;"true"代表允許.
387
									$conf["allowEmptyStr"]="false";
388
									#參考資料:
389
									#無.
390
									#備註:
391
									#無.
392
									$spiltString=stringProcess::spiltString($conf);
393
									unset($conf);
394
 
395
									#debug
396
									#var_dump(__LINE__,$spiltString);
397
 
398
									#如果執行失敗
399
									if($spiltString["status"]==="false"){
400
 
401
										#debug
402
										var_dump($spiltString);
403
 
404
										#結束執行,回傳shell 1
405
										exit(1);
406
 
407
										}#if end
408
 
409
									#如果有分割用的關鍵字
410
									if($spiltString["found"]==="true"){
411
 
412
										#如果分割出來的數量為1
413
										if($spiltString["dataCounts"]===1){
414
 
415
											#取得 unix doamin socket 的位置
416
											$unixDomainSocket=$spiltString["dataArray"][0];
417
 
418
											#提示透過 unix domain socket 來傳接收要做的事情
419
											echo "Using unix domain socket:".$unixDomainSocket." 來跟 web socket server 互動".PHP_EOL;
420
 
421
											#後面忽略,換下一個
422
											continue;
423
 
424
											}#if end	
425
 
426
										}#if end
427
 
428
									}#if end
429
 
430
								#印出內容
431
								echo $contentByte;
432
 
433
								#換行
434
								echo PHP_EOL;
435
 
436
								}#if end
437
 
438
							}#if end
439
 
440
						}#foreach end
441
 
442
					}#if end
443
 
444
					#反之代表沒有任何輸出
445
					else{
446
 
447
						#提示在等待任何輸出
448
						echo ".";
449
 
450
						}#else end
451
 
452
				}#if end
453
 
454
			#如果已經結束執行
455
			if($process["proc_get_status"]["running"]==="false"){
456
 
457
				#移除該程序資訊
458
				unset($proc["content"][$index]);
459
 
460
				}#if end
461
 
462
			#反之
463
			else{
464
 
465
				#更新 "proc_get_status"
466
				$proc["content"][$index]["proc_get_status"]=proc_get_status($process["process"]);
467
 
468
				}#else end
469
 
470
			}#if end
471
 
472
		#反之
473
		else{
474
 
475
			#移除該程序資訊
476
			unset($proc["content"][$index]);
477
 
478
			}#else end
479
 
480
		}#foreach end
481
 
482
	}#while end