Subversion Repositories php-qbpwcf

Rev

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

Rev Author Line No. Line
290 liveuser 1
#!/usr/bin/php
2
<?php
3
 
4
/*
5
	QBPWCF, Quick Build PHP website Component base on Fedora Linux.
6
    Copyright (C) 2014~2026 MIN ZHI, 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
透過zerossl api確保ssl沒有過期.
27
*/
28
 
29
#指派命名空間
30
namespace qbpwcf;
31
 
32
#取得 lib path
33
exec("php -f ".escapeshellarg(pathinfo(__FILE__)["dirname"]."/libexec/folderOfUsrLib.php"),$output,$status);
34
 
35
#如果執行失敗
36
if($status!==0){
37
 
38
	#debug
39
	var_dump(__LINE__,$output);
40
 
41
	#結束執行,回傳shell 1.
42
	exit(1);
43
 
44
	}#if end
45
 
46
#儲存lib path
47
$folderOfUsrLib=$output[0];
48
 
49
#以該檔案的實際位置的 lib path 為 include path 首位
50
$output=array();
51
exec("cd ".escapeshellarg(pathinfo(__FILE__)["dirname"]."/../".$folderOfUsrLib."/qbpwcf").";pwd;",$output,$status);
52
 
53
#如果執行失敗
54
if($status!==0){
55
 
56
	#debug
57
	var_dump(__LINE__,$output);
58
 
59
	#結束執行,回傳shell 1.
60
	exit(1);
61
 
62
	}#if end
63
 
64
#設置 include path
65
set_include_path($output[0].PATH_SEPARATOR.get_include_path());
66
 
67
#匯入外部套件
68
include("allInOne.php");
69
 
70
#當前lib路徑
71
$pwd=$output[0];
72
 
73
#unix socket 的位置
74
$unixSocket=$pwd."/../../../var/qbpwcf/".basename(__FILE__).".sock";
75
 
76
#說明函式
77
function help(){
78
 
79
	#印出指令說明
80
	echo "Usage of ".basename(__FILE__).":".PHP_EOL;
81
	echo "--sock [sslUpdater socket] unix domain socket 的位置與名稱,預設為相對於 QBPWCF套件的 \"/var/qbpwcf/sslUpdater.sock\"".PHP_EOL;
82
	echo "--daemon [\"on\"] 代表是要運行 server 端程式.".PHP_EOL;
83
	echo "--config [config file apth] 指定設定檔案的位置,預設為 相對於QBPWCF套件的 \"/etc/qbpwcf/sslUpdater.php\" 位置.".PHP_EOL;
84
	echo "--debug [\"on\"] 代表要開啟 debug 模式.".PHP_EOL;
85
 
86
	#結束執行
87
	exit;
88
 
89
	}#function help end
90
 
91
#函式說明:
92
#解析參數.
93
#回傳結果:
94
#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
95
#$reuslt["error"],執行不正常結束的錯訊息陣列.
96
#$result["function"],當前執行的函式名稱.
97
#$result["content"],解析好的參數陣列.
98
#$result["content"][$key][$i],參數 $key 的 $i+1 個參數數值內容.
99
#$result["program"],字串,執行的程式名稱.
100
#必填參數:
101
#無
102
#可省略參數:
103
#$conf["helpFunc"],如果解析的參數不成對,則要執行的函式名稱.
104
$conf["helpFunc"]="help";
105
#備註:
106
#僅能在命令列底下執行.
107
#建議:
108
#以後可將參數 --a--b 的名稱與後面的數值 $value 存成 $result["a"]["b"][$i]=$value .
109
$parseArgu=cmd::parseArgu($conf);
110
unset($conf);
111
 
112
#如果解析參數失敗
113
if($parseArgu["status"]==="false"){
114
 
115
	#印出結果
116
	var_dump($parseArgu);
117
 
118
	#結束執行
119
	exit(1);
120
 
121
	}#if end
122
 
123
#檢查參數
124
#函式說明:
125
#檢查必填與可省略參數,可省略參數可指定預設要給與什麼數值內容。
126
#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
127
#$reuslt["error"],執行不正常結束的錯訊息陣列.
128
#$result["function"],當前執行的函式名稱.
129
#$result["passed"],識別要檢查的全體變數是否存在以及型態是否正確的變數,"true"代表檢查全部通過;"false"代表檢查不通過
130
#$result[$shouldBeCheckedVarName]["varExist"],所檢查的變數是否存在,"false"代表不存在;"true"代表存在
131
#$result[$shouldBeCheckedVarName]["varType"],所檢查的變數型態是否正確,"false"代表錯誤;"true"代表正確
132
#$result[$shouldBeCheckedVarName]["error"],每個參數設定的錯誤訊息
133
#$result["shouldNotBeEmpty"],不應該為空字串或控陣列的變數.
134
#$result["argu"],字串陣列,目前輸入的參數名稱陣列.
135
#$result["legalVarName"],字串陣列,合法可用的參數名稱陣列.
136
#$result["notNeedVar"],字串陣列,多餘的參數名稱.
137
#必填寫的參數:
138
#$conf["varInput"],陣列變數,要檢查的陣列變數,請在要檢查的參數前面加上&,這樣變動的結果才能被套用。
139
$conf["varInput"]=&$parseArgu["content"];
140
#$conf["referenceVarKey"],字串,$conf參數後面的key值,用於移除不要的參考陣列.
141
$conf["referenceVarKey"]="variableCheck::checkArguments";
142
#可以省略的參數:
143
#$conf["mustBeFilledVariableName"],爲必填參數的變數名稱陣列,形態爲陣列變數,元素數量需要跟"mustBeFilledVariableType"參數的元素數量一致,例如: $conf["mustBeFilledVariableName"] = array("id","account","password");
144
#$conf["mustBeFilledVariableName"]=array("sock",);
145
#$conf["mustBeFilledVariableType"],爲必填參數的變數陣列應該爲何種變數形態,形態爲陣列,元素數量需要跟"mustBeFilledVariableName"參數的元素數量一致,例如: $conf["mustBeFilledVariableType"] = array("string",integer,"double","resource","object"); , null代表不指定變數形態.
146
#$conf["mustBeFilledVariableType"]=array("array");
147
#$conf["canBeEmptyString"],字串,必填變數內容如果是空字串就不能算是有設置的話,請設為"false",預設爲"true",可以為空字串.
148
#$conf["canBeEmptyString"]="false";
149
#$conf["canNotBeEmpty"],字串陣列,哪些必填參數的內容不得為空字串或空陣列,僅當$conf["canBeEmptyString"]為"true"時會生效.
150
#$conf["canNotBeEmpty"]=array();
151
#$conf["canBeEmpty"],字串陣列,哪些必填參數的內容可為空字串或空陣列,僅當$conf["canBeEmptyString"]為"false"時會生效.
152
#$conf["canBeEmpty"]=array();
153
#$conf["skipableVariableCanNotBeEmpty"],字串陣列,哪些可省略參數不可以為空字串或空陣列.
154
$conf["skipableVariableCanNotBeEmpty"]=array("sock","daemon","config","debug");
155
#$conf["skipableVariableName"],陣列字串,爲可省略參數的變數名稱陣列,形態爲陣列變數,例如: $conf["skipableVariableName"] = array("id","account","password");
156
$conf["skipableVariableName"]=array("sock","daemon","config","debug");
157
#$conf["skipableVariableType"],陣列字串,爲可省略參數的變數名稱陣列,形態爲陣列變數,例如: $conf["skipableVariableType"] = array("string",integer,"double");
158
$conf["skipableVariableType"]=array("array","array","array","array");
159
#$conf["skipableVarDefaultValue"],字串陣列,每個不存在的可省略變數要初始化為什麼,null與代表不指定,若預設值是參數之一,請將$conf["mustBeFilledVar"]改成"\$conf["\mustBeFilledVar\"]".
160
$conf["skipableVarDefaultValue"]=array(array(null),array(null),array($pwd."/../../../etc/qbpwcf/sslUpdater.php"),array("on"));
161
#$conf["disallowAllSkipableVarIsEmpty"],字串,是否允許每個可省略參數都為空字串,預設為"true"允許,反之為"false".
162
#$conf["variableCheck::checkArguments"]["disallowAllSkipableVarIsEmpty"]="false";
163
#$conf["disallowAllSkipableVarIsEmptyArray"],字串,是否允許每個可省略參數都為空陣列,預設為"true"允許,反之為"false".
164
#$conf["disallowAllSkipableVarIsEmptyArray"]="";
165
#$conf["arrayCountEqualCheck"],字串陣列,為檢查哪些陣列參數的元素數量要一樣,$conf["arrayCountEqualCheck"][$i]=array()為第$i組key為哪些的變數其元素數量要相等.
166
#$conf["arrayCountEqualCheck"][]=array();
167
#參考資料來源:
168
#array_keys=>http://php.net/manual/en/function.array-keys.php
169
$checkArguments=variableCheck::checkArguments($conf);
170
unset($conf);
171
 
172
#若執行失敗
173
if($checkArguments["status"]==="false"){
174
 
175
	#印出結果
176
	var_dump($checkArguments);
177
 
178
	#結束執行
179
	exit(1);
180
 
181
	}#if end
182
 
183
#若檢查不通過
184
if($checkArguments["passed"]==="false"){
185
 
186
	#印出結果
187
	var_dump($checkArguments);
188
 
189
	#結束執行
190
	exit(1);
191
 
192
	}#if end
193
 
194
#取得debug flag
195
$debug=$parseArgu["content"]["debug"][0];
196
 
197
#如果是 debug 模式
198
if($debug==="on"){
199
 
200
	#設置為 true
201
	$debug=true;
202
 
203
	}#if end
204
 
205
#反之
206
else{
207
 
208
	#設置為 false
209
	$debug=false;
210
 
211
	}#else end
212
 
213
#取得設定檔案路徑與名稱
214
$config=$parseArgu["content"]["config"][0];
215
 
216
#檢查設定檔案是否存在
217
#函式說明:
218
#檢查多個檔案與資料夾是否存在.
219
#回傳的結果:
220
#$result["status"],執行正常與否,"true"代表正常,"false"代表不正常.
221
#$result["error"],錯誤訊息陣列.
222
#$resutl["function"],當前執行的涵式名稱.
223
#$result["argu"],使用的參數.
224
#$result["allExist"],所有檔案皆存在的識別,"true"代表皆存在,"false"代表沒有全部都存在.
225
#$result["varName"][$i],爲第$i個資料夾或檔案的路徑與名稱。
226
#$result["varNameFullPath"][$i],爲第$i個資料夾或檔案的完整檔案系統路徑與名稱,如果不存在則代表路徑是網址.
227
#$result["varNameWebPath"][$i],為第$i個資料夾或檔案的網址,若"web"參數為"true",才會有該內容.
228
#$result["varExist"][$i],爲第$i個資料夾或檔案是否存在,"true"代表存在,"false"代表不存在。
229
#必填參數:
230
#$conf["fileArray"],陣列字串,要檢查是否存在的檔案有哪些,須爲一維陣列數值。
231
$conf["fileArray"]=array($config);
232
#$conf["fileArgu"],字串,php變數__FILE__的內容,亦即該檔案在檔案系統的絕對路徑
233
$conf["fileArgu"]=__FILE__;
234
#可省略參數:
235
#$conf["disableWebSearch"],"字串",是否取消「當檔案找不到時,改用catchWebContent類別的wget函數來檢查檔案是否存在於網路上」的功能,"false"不取消,若要取消該功能請設為"true",若抓到的內容為空字串則會視為檔案不存在,預設為"true".
236
$conf["disableWebSearch"]="true";
237
#$conf["userDir"],字串,網頁是否置放於家目錄底下,"true"為是,"false"為不是,預設為"true".
238
$conf["userDir"]="false";
239
#$conf["web"],字串,檔案是放在web就是"true",反之為檔案系統"false",預設為"true".
240
$conf["web"]="false";
241
#參考資料:
242
#http://php.net/manual/en/function.file-exists.php
243
#http://php.net/manual/en/control-structures.foreach.php
244
#備註:
245
#函數file_exists檢查的路徑為檔案系統的路徑
246
#$result["varName"][$i]結果未實作
247
$checkMultiFileExist=fileAccess::checkMultiFileExist($conf);
248
unset($conf);
249
 
250
#若執行異常
251
if($checkMultiFileExist["status"]==="false"){
252
 
253
	#印出結果
254
	var_dump($checkMultiFileExist);
255
 
256
	#結束執行
257
	exit(1);
258
 
259
	}#if end
260
 
261
#若設定檔案不存在
262
if($checkMultiFileExist["allExist"]==="false"){
263
 
264
	#印出結果
265
	var_dump($checkMultiFileExist);
266
 
267
	#結束執行
268
	exit(1);
269
 
270
	}#if end
271
 
272
#載入設定檔案
273
#函式說明:
274
#解析PHP檔案裡面的變數.
275
#回傳結果:
276
#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
277
#$result["error"],錯誤訊息.
278
#$result["function"],當前執行的函數名稱.
279
#$result["argu"],所使用的參數.
280
#$result["content"],找到的變數內容陣列,若有多個變數則會用array來表示.
281
#必填參數:
282
#$conf["file"],字串,檔案的路徑與名稱.
283
$conf["file"]=$config;
284
#$conf["fileArgu"],字串,php變數__FILE__的內容,亦即該檔案在檔案系統的絕對路徑
285
$conf["fileArgu"]=__FILE__;
286
#$conf["varName"],字串陣列,要搜尋的變數名稱,例如要搜尋變數$email則輸入"email".
287
$conf["varName"]=array("domainName","certificatePath","privateKey","ca_bundlePath","cert_and_ca_bundle_path","RR_file_path","dns_server_addr","action_after_update_certs");
288
#可省略參數:
289
#$conf["web"],是要取得網路上的檔案則為"true";反之則為"false",預設為"false".
290
$conf["web"]="false";
291
#$conf["allVarCountSame"],字串,是否每個參數的數量要一致,預設為"false"不要;反之為"true"代表要.
292
$conf["allVarCountSame"]="true";
293
#參考資料:
294
#https://www.php.net/manual/en/function.parse-str.php
295
#備註:
296
#無.
297
$parseVaraiableInPHPfile=fileAccess::parseVaraiableInPHPfile($conf);
298
unset($conf);
299
 
300
#如果執行異常
301
if($parseVaraiableInPHPfile["status"]==="false"){
302
 
303
	#印出結果
304
	var_dump($parseVaraiableInPHPfile);
305
 
306
	#結束執行
307
	exit(1);
308
 
309
	}#if end
310
 
311
#有多少個 domain name 要處理就執行幾次
312
for($i=0;$i<count($parseVaraiableInPHPfile["content"]["domainName"]);$i++){
313
 
314
	#設置 cname
315
	$conf["cName"][]=$parseVaraiableInPHPfile["content"]["domainName"][$i];
316
 
317
	#設置 certPath
318
	$conf["certInfo"][$i]["certPath"]=$parseVaraiableInPHPfile["content"]["certificatePath"][$i];
319
 
320
	#設置 pKey
321
	$conf["certInfo"][$i]["pKey"]=$parseVaraiableInPHPfile["content"]["privateKey"][$i];
322
 
323
	#設置 caPath
324
	$conf["certInfo"][$i]["caPath"]=$parseVaraiableInPHPfile["content"]["ca_bundlePath"][$i];
325
 
326
	#設置 certWithCaPath
327
	$conf["certInfo"][$i]["certWithCaPath"]=$parseVaraiableInPHPfile["content"]["cert_and_ca_bundle_path"][$i];
328
 
329
	#設置 rrFile
330
	$conf["rrFile"][]=$parseVaraiableInPHPfile["content"]["RR_file_path"][$i];
331
 
332
	#設置 dnsSerAddr
333
	$conf["dnsSerAddr"][]=$parseVaraiableInPHPfile["content"]["dns_server_addr"][$i];
334
 
335
	#設置 actionAfterUpdateCert
336
	$conf["actionAfterUpdateCert"][]=$parseVaraiableInPHPfile["content"]["action_after_update_certs"][$i];
337
 
338
	}#for end
339
 
340
#if enable debug
341
if($debug){
342
 
343
	echo "serivce config data:".PHP_EOL;
344
 
345
	#debug
346
	var_dump($conf);
347
 
348
	}#if end
349
 
350
#如果有 sock 參數
351
if(isset($parseArgu["content"]["sock"])){
352
 
353
	#取得 unix domain socket 的位置
354
	$sock=$parseArgu["content"]["sock"][0];
355
 
356
	}#if end
357
 
358
#取得 daemon 參數的內容
359
$dameon=$parseArgu["content"]["daemon"][0];
360
 
361
#如果為 "on"
362
if($dameon==="on"){
363
 
364
	#if enable debug
365
	if($debug){
366
 
367
		#設定 debug 參數
368
		$conf["debug"]="true";
369
 
370
		}#if end
371
 
372
	#如果有設置 sock
373
	if(isset($sock)){
374
 
375
		#設置 sock 參數
376
		$conf["sock"]=$sock;
377
 
378
		}#if end
379
 
380
	#函式說明:
381
	#透過zerossl api確保ssl沒有過期.
382
	#回傳結果:
383
	#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
384
	#$reuslt["error"],執行不正常結束的錯訊息陣列.
385
	#$result["function"],當前執行的函式名稱.
386
	#$result["argu"],所使用的參數.
387
	#必填參數:
388
	#$conf["cName"],陣列,每個ssl的common domain name.
389
	#$conf["cName"]=array();
390
	#$conf["certInfo"],陣列,每個cName參數對應的憑證資訊,$conf["certInfo"][$i]["certPath"]為第$+1個cName的certifate.crt的檔案位置與名稱;$conf["certInfo"][$i]["pKey"]為第$i+1個cName的private key;$conf["certInfo"][$i]["caPath"]為第$i+1個cName的ca_bundle.crt的檔案位置與名稱;$conf["certInfo"][$i]["certWithCaPath"]為第$+1個cName的certifate.crt跟ca_bundle.crt內容合併後的檔案位置與名稱.
391
	#$conf["certInfo"]=array();
392
	#$conf["rrFile"],陣列,每個cName參數對應的RR檔案路徑與名稱.
393
	#$conf["rrFile"]=array();
394
	#$conf["dnsSerAddr"],陣列,每個cName參數對應的dns server位置,亦即ip或dns,用於透過root@dnsSerAddr將dns server重新啟動.
395
	#$conf["dnsSerAddr"]=array();
396
	#$conf["actionAfterUpdateCert"],陣列,每個元素代表對應cName所屬的憑證更新後要執行的指令,例如重新啟動apache(array("systemctl","restart","httpd").若要執行多個指令,用陣列表示即可,例如重新啟動apache跟qbpwcf-wss(array(array("systemctl","restart","httpd"),array("podman","restart","qbpwcf-wss")).
397
	#$conf["actionAfterUpdateCert"]=array();
398
	#可省略參數:
399
	#$conf["apiDomain"],字串,提供服務的domain,預設為 self::getApiInfo()["doamin"].
400
	#$conf["apiDomain"]=self::getApiInfo()["doamin"];
401
	#$conf["key"],字串,api key,預設為 self::getApiInfo()["apiKey"].
402
	#$conf["key"]=self::getApiInfo()["apiKey"];
403
	#$conf["debug"],字串,是否要開啟debug模式,"true"代表要;反之為預設"false"代表不要.
404
	#$conf["debug"]="";
405
	#$conf["addOnProcessFunc"],陣列,收到訊息後,要依順執行的函式,預設為array("\qbpwcf\zerosll::sslUpdater_cmd").
406
	#$conf["addOnProcessFunc"]=array();
407
	#$conf["funcToRunWhenIdle"],陣列,閒置時要依序執行的函式,預設為array("/qbpwcf/zerossl::sslUpdater_idle");
408
	#$conf["funcToRunWhenIdle"]=array();
409
	#參考資料:
410
	#無.
411
	#備註:
412
	#無.
413
	$sslUpdater=zerossl::sslUpdater($conf);
414
	unset($conf);
415
 
416
	#如果執行異常
417
	if($sslUpdater["status"]==="false"){
418
 
419
		#印出結果
420
		var_dump($sslUpdater);
421
 
422
		#結束執行
423
		exit(1);
424
 
425
		}#if end
426
 
427
	}#if end