Subversion Repositories qbpwcf-lib(archive)

Rev

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

<?php

/*
        QBPWCF, Quick Build PHP website Component base on Fedora Linux.
    Copyright (C) 2015~2023 Min-Jhin,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
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    QBPWCF is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    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/>.
    
*/

/*

抓取資料庫資料

*/

#使用命名空間qbpwcf
namespace qbpwcf;

#以該檔案的實際位置的 lib path 為 include path 首位
exec("cd ".pathinfo(__FILE__)["dirname"]."/../;pwd;",$output,$status);
set_include_path($output[0].PATH_SEPARATOR.get_include_path());

#匯入外部套件
include("allInOneForJson.php");

#設定log的檔案名稱
$logFile=basename(__FILE__).".log.readonly";

/*

# test case - 1 - start

$params=array();
$params["dbSecret"]="";
$params["dbAddr"]="localhost";
$params["dbPort"]="3306";
$params["dbName"]="test";
$params["dbUser"]="test";
$params["dbPass"]="test";
$params["dtName"]="member";
$params["cols"]=array("*");
#$params["WhereColumnName"];
#$params["WhereColumnValue"];
#$params["WhereColumnOperator"];
#$params["orderItem"];
#$params["ascORdesc"];
#$params["numLimit"];
#$params["numberStart"];

#設置參數
$_POST["params"]=base64_encode(urlencode(json_encode($params)));

# test case - 1 - end

*/

#涵式說明：
#可以處理多個透過GET、POST而來的資訊，儲存成變數，同時限定傳送的方法、來源，來增加安全性，檢查有沒有皆收到必須要接收到的變數,沒有接收到的變數可以指定從session變數中取得.
#回傳的結果：
#$result["status"],執行正常與否,"true"代表正常,"false"代表不正常.
#$result["error"],錯誤訊息陣列.
#$resutl["function"],當前執行的涵式名稱.
#$result["warning"],警告訊息陣列.
#$result["passed"],是否有皆收到全部該接收到的變數，若有設定$conf["checkedVarName"]的話，執行正常後會回傳該結果。
#$result["lostVarName"],沒有皆收到的變數名稱陣列
#$result["inputDataContent"],所接收的參數陣列.
#$result["inputDataContent"]["變數名稱"]，所接收變數的內容.
#$result["inputDataCount"],從表單總共接收到幾個元素.
#$result["HTTP_REFERER"],前一頁的網址,null代表不存在.
#必填的參數:
#$conf["method"],字串,傳送過來的資料是用"post/POST"還是"get/GET"?
$conf["method"]="POST";
#可省略的參數：
#$conf["allowGet"],字串,是否要允許 get 傳值，"true"，代表允許；"false" ，代表不允許，預設爲不允許.
#$conf["allowGet"]="true";
#$conf["limitPrePage"],字串陣列,是否要限定前一頁的網址為哪些，才能接收內容，不符合則轉址.
#$conf["limitPrePage"]=array("");
#$conf["transferLocation"],字串,遇到get傳值，或前一個頁面不符合要求時要轉址到的頁面，預設爲資安素養網"https://isafe.moe.edu.tw/"
#$conf["transferLocation"]="";
#$conf["ignore"]=字串陣列,如果要接收的變數名稱與該陣列其一元素一樣,則不放進要回傳的變數裏面.
#$conf["ignore"]=array();
#$conf["correctCharacter"]=,字串,如果爲"false"，則不處理可能導致網頁出問題的字串，預設爲要進行處理.
#$conf["correctCharacter"]="false";
#$conf["checkedVarName"],字串陣列,為檢查是否有接收到哪些變數.
$conf["checkedVarName"]=array("params");
#$conf["canBeEmptyString"],字串,用$conf["checkedVarName"]指定接收的變數名稱陣列,若接收到的內容為空字串是否算有接收到內容,預設為"false","true"代表接收到的內容可以為空字串,"false"代表接收到的內容不可以為空字串.
#$conf["canBeEmptyString"]="false";
#$conf["sessionNameArray"],陣列,若存在則代表若沒有從表單取得變數,則從session變數中取得內容,每個元素代表每個表單變數對應的session名稱,若不是要改用session方式取得變數內容的變數,請輸入null,數量請跟$conf["checkedVarName"]參數一致.
#$conf["sessionNameArray"]=array();
#$conf["unsetSessionArray"],陣列,與$conf["sessionNameArray"]對應的元素,是否要接收到變數後就卸除,"true"代表要卸除,"false"代表不要卸除.
#$conf["unsetSessionArray"]=array();
#$conf["recaptcha_url"],字串,有內容代表要檢查有無透過recaptcha於特定頁面網址認證過.
#$conf["recaptcha_url"]="";
#參考資料來源：
#foreach 的用法 -> http://php.net/manual/en/control-structures.foreach.php
#伺服器端的變數 -> http://php.net/manual/en/reserved.variables.server.php
#備註：
#表單變數的名稱若含有「.」，則會變成「-」。
$responseMultiInputDataSecurityEnhance=form::responseMultiInputDataSecurityEnhance($conf);
unset($conf);

#函式說明:
#撰寫log
#回傳結果:
#$result["status"],狀態,"true"或"false".
#$result["error"],錯誤訊息陣列.
#$result["function"],當前函式的名稱.
#$result["argu"],使用的參數.
#必填參數:
#$conf["path"],log檔案的路徑與名稱.
$conf["path"]=$logFile;
#$conf["content"],字串,要寫的內容.
$conf["content"]=json_encode($responseMultiInputDataSecurityEnhance).PHP_EOL;
#$conf["fileArgu"],字串,php變數__FILE__的內容,亦即該檔案在檔案系統的絕對路徑
$conf["fileArgu"]=__FILE__;
#可省略參數:
#$conf["rewrite"],預設為"false",接續寫入;反之"true"代表重新寫入.
#$conf["rewrite"]="false";
#參考資料:
#無.
#備註:
#無.   
$record=logs::record($conf);
unset($conf);

#如果寫log 失敗
if($record["status"]==="false"){

        #印出訊息
        echo json_encode($record);
        
        #結束執行
        exit;

        }#if end

#如果執行失敗
if($responseMultiInputDataSecurityEnhance["status"]==="false"){

        #印出訊息
        echo json_encode($responseMultiInputDataSecurityEnhance);

        #結束執行
        exit;

        }#if end

#如果邊數檢查不通過
if($responseMultiInputDataSecurityEnhance["passed"]==="false"){

        #印出訊息
        echo json_encode($responseMultiInputDataSecurityEnhance);

        #結束執行
        exit;

        }#if end

#取得參數
$params=$responseMultiInputDataSecurityEnhance["inputDataContent"]["params"];

#解析變數
$params=json_decode(urldecode(base64_decode($params)));

#轉換為陣列
$params=(array)$params;

#函式說明:
#撰寫log
#回傳結果:
#$result["status"],狀態,"true"或"false".
#$result["error"],錯誤訊息陣列.
#$result["function"],當前函式的名稱.
#$result["argu"],使用的參數.
#必填參數:
#$conf["path"],log檔案的路徑與名稱.
$conf["path"]=$logFile;
#$conf["content"],字串,要寫的內容.
$conf["content"]=json_encode($params).PHP_EOL;
#$conf["fileArgu"],字串,php變數__FILE__的內容,亦即該檔案在檔案系統的絕對路徑
$conf["fileArgu"]=__FILE__;
#可省略參數:
#$conf["rewrite"],預設為"false",接續寫入;反之"true"代表重新寫入.
#$conf["rewrite"]="false";
#參考資料:
#無.
#備註:
#無.   
$record=logs::record($conf);
unset($conf);

#如果寫log 失敗
if($record["status"]==="false"){

        #印出訊息
        echo json_encode($record);
        
        #結束執行
        exit;

        }#if end

#如果少了使用資料庫系統的dbSecret
if(!isset($params["dbSecret"])){

        #結束執行
        exit;

        }#if end
        
#驗證密碼是否正確
else{

        #若dbSecret錯誤
        if($params["dbSecret"]!==dbSecret){
        
                #結束執行
                exit;
        
                }#if end
        
        #移除傳遞的 dbSecret
        unset($params["dbSecret"]);

        }#else end

#檢查變數
#函式說明:
#檢查必填與可省略的參數，可省略參數可指定預設要給與什麼數值內容。
#$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"]=&$params;
#$conf["referenceVarKey"],字串,$conf參數後面的key值,用於移除不要的參考陣列.
$conf["variableCheck::checkArguments"]["referenceVarKey"]="variableCheck::checkArguments";
#可以省略的參數:
#$conf["mustBeFilledVariableName"],爲必填參數的變數名稱陣列，形態爲陣列變數，元素數量需要跟"mustBeFilledVariableType"參數的元素數量一致,例如: $conf["mustBeFilledVariableName"] = array("id","account","password");
$conf["variableCheck::checkArguments"]["mustBeFilledVariableName"]=array("dbAddr","dbName","dbUser","dbPass","dtName","cols");
#$conf["mustBeFilledVariableType"],爲必填參數的變數陣列應該爲何種變數形態，形態爲陣列,元素數量需要跟"mustBeFilledVariableName"參數的元素數量一致,例如: $conf["mustBeFilledVariableType"] = array("string",integer,"double","resource","object"); , null代表不指定變數形態.
$conf["variableCheck::checkArguments"]["mustBeFilledVariableType"]=array("string","string","string","string","string","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("dbPort","orderItem","ascORdesc","numLimit","WhereColumnName","WhereColumnValue","WhereColumnOperator","numberStart");
#$conf["skipableVariableName"],陣列字串,爲可省略參數的變數名稱陣列，形態爲陣列變數，例如: $conf["skipableVariableName"] = array("id","account","password");
$conf["variableCheck::checkArguments"]["skipableVariableName"]=array("dbPort","orderItem","ascORdesc","numLimit","WhereColumnName","WhereColumnValue","WhereColumnOperator","numberStart");
#$conf["skipableVariableType"],陣列字串,爲可省略參數的變數名稱陣列，形態爲陣列變數，例如: $conf["skipableVariableType"] = array("string",integer,"double");
$conf["variableCheck::checkArguments"]["skipableVariableType"]=array("string","string","string","string","array","array","array","string");
#$conf["skipableVarDefaultValue"],字串陣列,每個不存在的可省略變數要初始化為什麼,null與代表不指定,若預設值是參數之一，請將$conf["mustBeFilledVar"]改成"\$conf["\mustBeFilledVar\"]".
$conf["variableCheck::checkArguments"]["skipableVarDefaultValue"]=array("3306",null,null,null,null,null,null,"0");
#$conf["disallowAllSkipableVarIsEmpty"],字串,是否允許每個可省略參數都為空字串,預設為"true"允許,反之為"false".
#$conf["disallowAllSkipableVarIsEmpty"]="";
#$conf["disallowAllSkipableVarIsEmptyArray"],字串,是否允許每個可省略參數都為空陣列,預設為"true"允許,反之為"false".
#$conf["disallowAllSkipableVarIsEmptyArray"]="";
#$conf["arrayCountEqualCheck"],字串陣列,為檢查哪些陣列參數的元素數量要一樣,$conf["arrayCountEqualCheck"][$i]=array()為第$i組key為哪些的變數其元素數量要相等.
$conf["variableCheck::checkArguments"]["arrayCountEqualCheck"][]=array("cols","vals");
#參考資料來源:
#array_keys=>http://php.net/manual/en/function.array-keys.php
$checkArguments=variableCheck::checkArguments($conf["variableCheck::checkArguments"]);
unset($conf["variableCheck::checkArguments"]);

#函式說明:
#撰寫log
#回傳結果:
#$result["status"],狀態,"true"或"false".
#$result["error"],錯誤訊息陣列.
#$result["function"],當前函式的名稱.
#$result["argu"],使用的參數.
#必填參數:
#$conf["path"],log檔案的路徑與名稱.
$conf["path"]=$logFile;
#$conf["content"],字串,要寫的內容.
$conf["content"]=json_encode($checkArguments).PHP_EOL;
#$conf["fileArgu"],字串,php變數__FILE__的內容,亦即該檔案在檔案系統的絕對路徑
$conf["fileArgu"]=__FILE__;
#可省略參數:
#$conf["rewrite"],預設為"false",接續寫入;反之"true"代表重新寫入.
#$conf["rewrite"]="false";
#參考資料:
#無.
#備註:
#無.   
$record=logs::record($conf);
unset($conf);

#如果寫log 失敗
if($record["status"]==="false"){

        #印出訊息
        echo json_encode($record);
        
        #結束執行
        exit;

        }#if end

#如果執行失敗
if($checkArguments["status"]==="false"){

        #印出訊息
        echo json_encode($checkArguments);

        #結束執行
        exit;

        }#if end

#如果邊數檢查不通過
if($checkArguments["passed"]==="false"){

        #印出訊息
        echo json_encode($checkArguments);

        #結束執行
        exit;

        }#if end

/*
#可能存在的參數
$params["dbAddr"];
$params["dbPort"];
$params["dbName"];
$params["dbUser"];
$params["dbPass"];
$params["dtName"];
$params["cols"];
$params["WhereColumnName"];
$params["WhereColumnValue"];
$params["WhereColumnOperator"];
$params["orderItem"];
$params["ascORdesc"];
$params["numLimit"];
*/

#涵式說明：
#一次取得資料庫、表的資料
#回傳的結果
#$result["status"],執行結果"true"為成功；"false"為執行失敗。
#$result["error"],錯誤訊息陣列。
#$result["function"],當前執行的漢書名稱.
#$result["argu"],使用的參數.
#$result["dataColumnName"],抓取的資料欄位名稱陣列.
        #$result["dataColumnName"][$i]代表第$i+1個欄位名稱
#$result["dataContent"],爲資料的內容。
#$result["dataContent"][$conf["WhereColumnName"][$i]][$dataSetNum]
        #$dataSetNum 爲第$dataSetNum+1筆資料
        #$conf["WhereColumnName"][$i] 爲第 $i+1 個欄位的名稱
#$result["dataCount"],爲取得的資料筆數。
#$result["sql"],執行的sql字串.
#必填的參數：
$conf["dbAddress"]=$params["dbAddr"];#爲dbServer的位置。
$conf["dbAccount"]=$params["dbUser"];#爲登入dbServer的帳號。
$conf["dbName"]=$params["dbName"];#爲要存取的資料庫名稱
$conf["tableName"]=$params["dtName"];#爲要存取的資料表名稱
$conf["columnYouWant"]=$params["cols"];#你想要的欄位！,若設為「array("*")」則代表全部欄位.
#可省略的參數：
$conf["dbPassword"]=$params["dbPass"];#爲要存取dbServer的密碼

#如果存在 $params["WhereColumnName"]
if(isset($params["WhereColumnName"])){

        $conf["WhereColumnName"]=$params["WhereColumnName"];#用於判斷語句的欄位項目陣列。

        }#if end

#如果存在 $params["WhereColumnName"]
if(isset($params["WhereColumnValue"])){

        $conf["WhereColumnValue"]=$params["WhereColumnValue"];#用於判斷語句的欄位數值陣列，若與LIKE搭配，則可以在關鍵自字串的左右名加上「%」符號，這樣就可以搜尋具有該字串的內容。

        }#if end

#$conf["WhereColumnCombine"]=array("");#用於判斷語句當中需要()起來的判斷式，須爲陣列值，"s"代表「(」，"e"代表「)」 ，若無則須設爲""。

#如果存在 $params["WhereColumnOperator"]
if(isset($params["WhereColumnOperator"])){

        $conf["WhereColumnOperator"]=$params["WhereColumnOperator"];#用於判斷語句的比較符號陣列，可以用的符號有「"="、"!="、">"、"<"、"LIKE"、"NOT LIKE"」，預設都爲「=」。

        }#if end

#$conf["WhereColumnAndOr"]=array("");#用於判斷語句條件之間成立的條件是AND還是OR，須爲陣列值。其數量應爲要判斷的欄位數量減一。
#$conf["whereIn"],二維字串陣列,為每個in語句的內容,特定欄位數值等於陣列元素之一。array(array("colName",array("a","b","c")));代表欄位colName的值為a,b,c三者之一.
#$conf["whereIn"]=array(array("colName",array("a","b","c")));
#$conf["whereNotIn"],二維字串陣列,為每個not in語句的內容,array(array("colName",array("a","b","c")));代表欄位colName的值不為a,b,c三者之一.
#$conf["whereNotIn"]=array(array("colName",array("a","b","c")));

#如果有設置 $params["orderItem"]
if(isset($params["orderItem"])){

        $conf["orderItem"]=$params["orderItem"];#爲排序的項目依據,若要用隨機抽樣，可以用"rand()"，可省略。

        }#if end

#如果有設置 $params["ascORdesc"]
if(isset($params["ascORdesc"])){

        $conf["ascORdesc"]=$params["ascORdesc"];#爲要低增還是遞減排序,asc爲遞增；desc爲遞減。

        }#if end

#如果有設置 $params["numLimit"]
if(isset($params["numLimit"])){

        $conf["numLimit"]=$params["numLimit"];#為要取幾筆資料,可以省略，省略則表示不限制數目。

        }#if end

#如果有設置 $params["numberStart"]
if(isset($params["numberStart"])){

        $conf["numberStart"]=$params["numberStart"];#為從第幾筆開始讀取，預設為0，代筆第一筆。

        }#if end

#$conf["groupBy"]=array("");#爲要以哪幾個欄爲作爲分羣的依據(欄位相同的數值僅會取出一筆)。
#$conf["dbPort"],字串,爲連線到mysql-Server時要使用的port，可省略，若省略則代表使用預設的3306 port.
$conf["dbPort"]=$params["dbPort"];
$fastGetDbData=db::fastGetDbData($conf);
unset($conf);

#函式說明:
#撰寫log
#回傳結果:
#$result["status"],狀態,"true"或"false".
#$result["error"],錯誤訊息陣列.
#$result["function"],當前函式的名稱.
#$result["argu"],使用的參數.
#必填參數:
#$conf["path"],log檔案的路徑與名稱.
$conf["path"]=$logFile;
#$conf["content"],字串,要寫的內容.
$conf["content"]=json_encode($fastGetDbData).PHP_EOL;
#$conf["fileArgu"],字串,php變數__FILE__的內容,亦即該檔案在檔案系統的絕對路徑
$conf["fileArgu"]=__FILE__;
#可省略參數:
#$conf["rewrite"],預設為"false",接續寫入;反之"true"代表重新寫入.
#$conf["rewrite"]="false";
#參考資料:
#無.
#備註:
#無.   
$record=logs::record($conf);
unset($conf);

#如果寫log 失敗
if($record["status"]==="false"){

        #印出訊息
        echo json_encode($record);
        
        #結束執行
        exit;

        }#if end

#印出訊息
echo json_encode($fastGetDbData);

?>