Subversion Repositories qbpwcf-lib(archive)

Rev

Rev 710 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
709 liveuser 1
#!/bin/php
708 liveuser 2
<?php
3
 
4
/*
5
 
6
        QBPWCF, Quick Build PHP website Component base on Fedora Linux.
7
    Copyright (C) 2015~2024 Min-Jhin,Chen
8
 
9
    This file is part of QBPWCF.
10
 
11
    QBPWCF is free software: you can redistribute it and/or modify
12
    it under the terms of the GNU General Public License as published by
13
    the Free Software Foundation, either version 3 of the License, or
14
    (at your option) any later version.
15
 
16
    QBPWCF is distributed in the hope that it will be useful,
17
    but WITHOUT ANY WARRANTY; without even the implied warranty of
18
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19
    GNU General Public License for more details.
20
 
21
    You should have received a copy of the GNU General Public License
22
    along with QBPWCF.  If not, see <http://www.gnu.org/licenses/>.
23
 
24
*/
25
 
26
#使用命名空間qbpwcf
27
namespace qbpwcf;
28
 
29
#匯入套件
30
require_once("qbpwcf/allInOneForJson.php");
31
 
32
#建議的log位置
33
$logFile=$_SERVER["DOCUMENT_ROOT"].$_SERVER["PHP_SELF"].".log";
34
 
35
#./usr_bin_test.php --cmd configCache.php
36
 
37
#函式說明:
38
#呼叫shell執行系統命令,並取得回傳的內容.
39
#回傳結果:
40
#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
41
#$result["error"],錯誤訊息陣列.
42
#$result["function"],當前執行的函數名稱.
43
#$result["argu"],使用的參數.
44
#$result["cmd"],執行的指令內容.
45
#$result["fullCmd"],如果參數 $conf["inBackGround"] 為 "true" 則會回傳該值.
46
#$result["output"],爲執行完二元碼後的輸出陣列,若 $conf["inBackGround"] 為 "true",則為當下的輸出.
47
#$result["tmpFileOutput"],儲存輸出的暫存檔案名稱,若 $conf["inBackGround"] 為 "true" 則會回傳該值.
48
#$result["running"],是否還在執行.
49
#$result["pid"],pid.
50
#$result["statusCode"],執行結束後的代碼.
51
#$result["escape"],陣列,儲存重新排序過且已經escape過的指令(key為"cmd")與參數(key為"argu")與兩者組合的一維陣列(key為"array").
52
#必填參數:
53
#$conf["command"],字串,要執行的指令.
54
$conf["command"]="./usr_bin_test.php";
55
#$conf["fileArgu"],字串,變數__FILE__的內容.
56
$conf["fileArgu"]=__FILE__;
57
#可省略參數:
58
#$conf["argu"],陣列字串,指令搭配的參數,預設為空陣列.
59
$conf["argu"]=array("--cmd","configCache.php");
60
#$conf["arguIsAddr"],陣列字串,指令搭配的哪些參數為路徑,為路徑的參數會進行轉換以便符合呼叫當前函數的位置,預設不指定,若有3個參數,其中第3個參數為路徑,則表示為array("false","false","true").
61
#$conf["arguIsAddr"]=array();
62
#$conf["pre"],陣列,要在本指令前執行的每個指令與參數.
63
#$conf["pre"][$i]["cmd"],字串,要在本指令前執行的第$i+1個指令.
64
#$conf["pre"][$i]["param"],陣列字串,要在本指令前執行的第$i+1個指令的參數.
65
#$conf["enablePrintDescription"],字串,是否要印出$conf["printDescription"]的內容,"true"代表要,"false"代表不要,預設為"false".
66
#$conf["enablePrintDescription"]="true";
67
#$conf["printDescription"],字串,執行該外部程式前要印出來的的文字,預設為$conf["command"]的內容加上使用的$conf["argu"]參數.
68
#$conf["printDescription"]="";
69
#$conf["escapeshellarg"],字串,是否要啟用過濾參數,用了比較安全,但可能會出錯,"true"為啟用,"false"為不啟用,預設為"false".如果參數為"< 、<< 、> 、>> 、| 、2>&1"之一則不會過濾.
709 liveuser 70
$conf["escapeshellarg"]="true";
708 liveuser 71
#$conf["thereIsShellVar"],陣列字串,指令搭配的參數"argu",若含有「\'」,則取代為「"」.每個argu參數都要有對應的元素."true"代表要置換.
72
#$conf["thereIsShellVar"]=array();
73
#$conf["username"],字串,要用什麼使用者來執行,預設為執行php的使用者,該參數不適用於apache環境.
74
#$conf["username"]="";
75
#$conf["password"],字串,root的使用者密碼,預設不使用密碼,該參數不適用於apache環境.
76
#$conf["password"]="";
77
#$conf["useScript"],字串,是否要啟用Linux的script指令來記錄輸出,"true"代表要,Fedora的selinux會擋住該操作;"false"代表不要,預設為"false".
78
#$conf["useScript"]="";
79
#$conf["logFilePath"],字串,當 $conf["useScript"] 為 "true" 時,輸出的內容要暫存到哪裡,預設為 "/tmp/.qbpwcf_tmp/external/callShell/".
80
#$conf["logFilePath"]=".qbpwcf_tmp/external/callShell/";
81
#$conf["inBackGround"],字串,是否要在背景執行,且不會等待程式執行結束再執行下一個指令,"true"代表是,"false"代表不要,預設為"false",如果$conf["command"]有用「;」區隔的多個指令將會出錯.
82
#$conf["inBackGround"]="";
83
#$conf["getErr"],字串,"true"代表將錯誤輸出變成標準輸出,反之"false"為不變動.
84
#$conf["getErr"]="false";
85
#$conf["doNotRun"],字串,"true"代表不執行指令,預設為"false"會執行指令.
86
$conf["doNotRun"]="true";
87
#參考資料:
88
#exec=>http://php.net/manual/en/function.exec.php
89
#escapeshellcmd=>http://php.net/manual/en/function.escapeshellcmd.php
90
#escapeshellarg=>http://php.net/manual/en/function.escapeshellarg.php
91
#備註:
92
#不是所有指令都能用apache的身份執行,目前已知java,javac指令無法執行,使用root身份可能會被selinux阻擋.
93
#若使用的 command、argu 參數,含有 ~ 則會被視為字串,若有需要其於 shell 中代表的家目錄位置,可用 fileAccess::tildeToPath 來進行轉換.
94
$callShell=external::callShell($conf);
95
unset($conf);
96
 
97
#如果執行失敗
98
if($callShell["status"]==="false"){
99
 
100
	#debug
101
	var_dump($callShell);
102
 
103
	#結束執行,回傳1給shell.
104
	exit(1);
105
 
106
	}#if end
107
 
709 liveuser 108
#debug
109
#var_dump(__LINE__,$callShell);exit;
110
 
708 liveuser 111
#函式說明:
112
#將一維陣列轉換為用特定符號間隔的字串,ex:array("1","2","3") to "a;b;c;".
113
#回傳的結果:
114
#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
115
#$result["function"],當前執行的function名稱
116
#$result["error"],錯誤訊息陣列.
117
#$result["content"],處理好的字串.
118
#$result["argu"],使用的參數.
119
#必填參數:
120
#$conf["inputArray"],字串陣列,要轉成字串的一維陣列.
121
$conf["inputArray"]=$callShell["escape"]["array"];
122
#可省略參數:
123
#$conf["spiltSymbol"],字串,用來區隔字串的符號,預設為;
710 liveuser 124
$conf["spiltSymbol"]=" ";
708 liveuser 125
#$conf["skipEnd"],字串,結尾是否不要加上符號,預設為"false",要加上符號,"true"代表不要加上符號。
126
#$conf["skipEnd"]="";
127
#$conf["spiltSymbolAtStart"],字串,是否要在開頭加上spiltSymbol,預設為"false",代表不要;反之為“true”.
128
#$conf["spiltSymbolAtStart"]="";
129
#參考資料:
130
#無.
131
#備註:
132
#無.
133
$arrayToString=arrays::arrayToString($conf);
134
unset($conf);
135
 
136
#如果執行失敗
137
if($arrayToString["status"]==="false"){
138
 
139
	#debug
140
	var_dump($arrayToString);
141
 
142
	#結束執行,回傳1給shell.
143
	exit(1);
144
 
145
	}#if end
146
 
147
#函式說明:
148
#透過proc來多執行序運作.
149
#回傳結果:
150
#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
151
#$reuslt["error"],執行不正常結束的錯訊息陣列.
152
#$result["function"],當前執行的函式名稱.
153
#$result["argu"],使用的參數.
154
#$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"代表程序的資訊.
155
#必填參數:
156
#$conf["cmds"],字串陣列,每個元素代表要執行的指令與參數.
157
$conf["cmds"]=array($arrayToString["content"]);
158
#可省略參數:
159
#$conf["wait"],字串,是否需要等待所有程序結束,預設為"true"要等待;反之為"false"不要等待.
160
$conf["wait"]="false";
161
#$conf["workingDir"],字串陣列,個別程式執行時的家目錄,預設不指定.
162
#$conf["workingDir"]=array("path");
163
#$conf["envs"],2維字串陣列,每個元素代表個別程式執行時的指定環境變數,key變數名稱;value為變數內容.預設為array("QBPWCF" => "Quick Build PHP Website Componment base on Fedora Linux");
164
#$conf["envs"]=array(array("key"=>"value"));
165
#$conf["executeBy"],字串陣列,每個元素代表個別指令要用什麼程式執行,預設為"bash".
166
#$conf["executeBy"]=array("bash");
167
#參考資料:
168
#https://www.php.net/manual/en/function.proc-open.php
169
#https://www.php.net/manual/en/function.proc-get-status.php
170
#備註:
171
#無.
172
$proc=threads::proc($conf);
173
unset($conf);
174
 
175
#如果執行失敗
176
if($proc["status"]==="false"){
177
 
178
	#debug
179
	var_dump($proc);
180
 
181
	#結束執行,回傳1給shell.
182
	exit(1);
183
 
184
	}#if end
185
 
709 liveuser 186
#debug
187
#var_dump(__LINE__,$proc);exit;
188
 
189
#停1秒
190
sleep(1);
191
 
708 liveuser 192
#函式說明:
193
#查尋有使用 server 函式提供組態設定檔的服務,取得key的value.
194
#回傳結果:
195
#$result["status"],執行是否正常,"true"為正常,"false"為不正常.
196
#$result["error"],錯誤訊息陣列.
197
#$result["function"],當前執行的函數名稱.
198
#$result["rawContent"],得到的原始訊息.
199
#$result["content"],用json_decode後的結果;若"inBg"為"true",則其每個元素為其指令執行的結果訊息陣列,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"代表程序的資訊.
200
#必填參數:
201
#$conf["server"],字串,組態服務設定服務的網址
709 liveuser 202
$conf["server"]="https://latest.qbpwcf.org/sample/config::server.php";
708 liveuser 203
#$conf["postName"],字串,POST變數的名稱,亦即要查尋的定義名稱.
717 liveuser 204
$conf["postName"]="169.254.1.1";
708 liveuser 205
#$conf["fileArgu"],字串,變數__FILE__的內容.
206
$conf["fileArgu"]=__FILE__;
207
#可省略參數:
208
#$conf["cache"],字串,預設為"true",代表會啟用cache服務;反之為"false".
209
#$conf["cache"]="false";
210
#$conf["clientCacheDaemonSock"],字串,提供cache服務的 unix domain socket 檔案位置,預設為套件根目錄底下的"var/config::client/clientCacheDaemon.sock";.
211
#$conf["clientCacheDaemonSock"]="";
212
#$conf["inBg"],字串,預設為"false",代表在前景執行;反之為"true"代表在背景中執行,會強制將"cache"參數設為"false".
213
#$conf["inBg"]="true";
214
#參考資料:
215
#無.
216
#備註:
217
#目前僅能跟server函式提供的服務對接.
218
$client=config::client($conf);
219
unset($conf);
220
 
709 liveuser 221
#如果程式最後狀態為進行中
222
if($proc["content"][0]["proc_get_status"]["running"]===true){
708 liveuser 223
 
709 liveuser 224
	#debug
225
	#var_dump(__LINE__,$proc["content"][0]);
708 liveuser 226
 
709 liveuser 227
	#取得新狀態
228
	$proc["content"][0]["proc_get_status"]=proc_get_status($proc["content"][0]["process"]);
229
 
230
	#debug
231
	#var_dump(__LINE__,$proc["content"][0]);
232
 
233
	}#if end
234
 
235
#debug
236
#var_dump(__LINE__,$proc["content"][0]);
237
 
238
#如果有 $proc["content"][0]["content"]
239
if(isset($proc["content"][0]["content"])){
240
 
241
	#取得clientCacheDaemon的標準輸出
242
	$clientCacheDaemonStdOutput=$proc["content"][0]["content"];
243
 
244
	#debug
245
	#var_dump(__LINE__,gettype($proc["content"][0]["content"]));
246
 
247
	#如果輸出為 resource
248
	if(gettype($proc["content"][0]["content"])==="resource"){
249
 
250
		#取得clientCacheDaemon的標準輸出
251
		$clientCacheDaemonStdOutput=stream_get_contents($proc["content"][0]["content"]);
252
 
253
		#關閉 output
254
		fclose($proc["content"][0]["content"]);
255
 
256
		}#if end
257
 
258
	}#if end
259
 
260
#如果有 $proc["content"][0]["error"]
261
if(isset($proc["content"][0]["error"])){
262
 
263
	#取得clientCacheDaemon的錯誤輸出
264
	$clientCacheDaemonErrorOutput=$proc["content"][0]["error"];
265
 
266
	#debug
267
	#var_dump(__LINE__,gettype($proc["content"][0]["error"]));
268
 
269
	#如果錯誤輸出為 resource
270
	if(gettype($proc["content"][0]["error"])==="resource"){
271
 
272
		#取得clientCacheDaemon的錯誤輸出
273
		$clientCacheDaemonErrorOutput=stream_get_contents($proc["content"][0]["error"]);
274
 
275
		#關閉 error
276
		fclose($proc["content"][0]["error"]);
277
 
278
		}#if end
279
 
280
	}#if end
281
 
282
#如果有 $proc["process"]
283
if(isset($proc["content"][0]["process"])){
284
 
285
	#結束 clientCacheDaemon.php 
286
	$clientCacheDaemonStatusCode = proc_close($proc["content"][0]["process"]);
287
 
288
	#debug
289
	#var_dump(__LINE__,$clientCacheDaemonStatusCode);exit;
290
 
291
	#如果 clientCacheDaemon.php 不是正常結束
292
	if($clientCacheDaemonStatusCode!==0){
293
 
294
		#提示 clientCacheDaemon.php 未正常結束
295
		echo "clientCacheDaemon.php 未正常結束(".$clientCacheDaemonStatusCode.")".PHP_EOL;
296
 
297
		#如果有 $clientCacheDaemonStdOutput
298
		if(isset($clientCacheDaemonStdOutput)){
299
 
300
			#提示 clientCacheDaemon.php 的標準輸出內容
301
			echo "clientCacheDaemon.php 的標準輸出內容:".PHP_EOL.$clientCacheDaemonStdOutput.PHP_EOL;
302
 
303
			}#if end
304
 
305
		#如果有 $clientCacheDaemonErrorOutput
306
		if(isset($clientCacheDaemonErrorOutput)){
307
 
308
			#提示 clientCacheDaemon.php 的錯誤輸出內容
309
			echo "clientCacheDaemon.php 的錯誤輸出內容:".PHP_EOL.$clientCacheDaemonErrorOutput.PHP_EOL;
310
 
311
			}#if end
312
 
313
		}#if end
314
 
315
		#結束執行,回傳1給shell.
316
		exit(1);
317
 
318
	}#if end
319
 
320
#如果執行失敗
321
if($client["status"]==="false"){
322
 
323
	#debug
324
	var_dump($client);
325
 
326
	#結束執行,回傳1給shell.
327
	exit(1);
328
 
329
	}#if end
330
 
331
#印出結果
332
var_dump($client);
333
 
708 liveuser 334
?>