分享Laravel是怎麼操作寶塔面板API

<?php
namespace App\Http\Controllers\Custom;
use App\Http\Controllers\Controller;
use Illuminate\Support\Facades\Http;
/**
 * 除了 AddSite GetSSL GetFileBody 外  其他都有返回 "msg"
 * 返回狀態 "status" => true/false  "msg" => "申請成功!"
 * 官方API檔案  https://www.bt.cn/api-doc.pdf
 */
class BtPanel extends Controller
{
    /**
     * 傳送請求
     * @param string $path /data?action=getData&table=sites 請求路徑
     * @param array $query 請求引數
     */
    private function sendRequest(string $path, array $query)
    {
        // 寶塔面板祕鑰
        $secretKey = config('custom.bt.key');
        // 寶塔面板地址 http://xxx.xxx.xxx:2222 填寫至埠即可
        $panelPath = config('custom.bt.panel_path');
        $time = time();
        $response = Http::withOptions(['verify' => false])
            ->retry(2, 5000) // !!!這裡時間不適用於 GetApplyCert 介面
            ->attach('cookie', $secretKey, 'bt.cookie') // 隨便傳東西就行
            ->post($panelPath . $path, array_merge([
                'request_token' => md5($time . '' . md5($secretKey)),
                'request_time' => $time
            ], $query))
            ->json();
        return $response ?: false;
    }
    /**
     * 查詢網站
     * @param string|null $search 需要搜尋的關鍵詞
     * @return array|false
     */
    public function SiteSearch(string $search = null)
    {
        $search = $search ?: config('custom.bt.domain');
        $response = $this->sendRequest('/data?action=getData&table=sites', [
            'limit' => 5,
            'search' => $search
        ]);
        // 獲取失敗
        if (!isset($response['data'])) return false;
        // 不允許出現相似的網站名
        if (count($response['data']) != 1) return false;
        $site = $response['data'][0];
        return [
            'id' => $site['id'],
            'name' => $site['name'],
            'path' => $site['path'],
            'ps' => $site['ps'],
            'php' => str_replace('.', '', $site['php_version'])
        ];
    }
    /**
     * 建立網站
     * ！！！PS: 使用API建立網站時  最好 不要建立相似網站名的網站  不然查詢時有些麻煩
     * @param string $domain 網站域名
     * @param [type] json webname        網站域名
     * @param [type] string path         網站路徑 /www/wwwroot/www.baidu.com
     * @param [type] integer type_id     網站分類ID
     * @param [type] string type         網站型別 PHP/JAVA
     * @param [type] string version      PHP版本 73/74
     * @param [type] string port         網站埠
     * @param [type] string ps           網站備註
     * @param [type] bool ftp            是否建立FTP
     * @param [type] string ftp_username  FTP使用者名稱 // ftp為true必傳
     * @param [type] string ftp_password  FTP密碼  // ftp為true必傳
     * @param [type] bool sql            是否建立資料庫
     * @param [type] string codeing      資料庫編碼型別 utf8|utf8mb4|gbk|big5  // sql為true必傳
     * @param [type] string datauser     資料庫賬號 // sql為true必傳
     * @param [type] string datapassword 資料庫密碼 // sql為true必傳
     * @return false|int
     */
    public function AddSite(string $domain)
    {
        $data = [
            'webname' => json_encode([
                'domain' => $domain,
                'domainlist' => [],
                'count' => 0
            ]),
            'path' => config('custom.bt.site_path'),
            'type_id' => '0',
            'type' => 'PHP',
            'version' => '74',
            'port' => '80',
            'ps' => $domain,
            'ftp' => 'false',
            'sql' => 'false'
        ];
        $response = $this->sendRequest('/site?action=AddSite', $data);
        return (isset($response['siteStatus']) && $response['siteStatus'] === true) ? (int)$response['siteId'] : false;
    }
    /**
     * 刪除網站
     * @param string $siteName 網站名稱 一般是網站域名
     * @return bool
     */
    public function DeleteSite(string $siteName): bool
    {
        $site = $this->SiteSearch($siteName);
        $response = $this->sendRequest('/site?action=DeleteSite', [
            'id' => $site['id'],
            'webname' => $site['name']
        ]);
        return isset($response['status']) && $response['status'] === true;
    }
    /**
     * 開啟網站
     * @param string $siteName 網站名稱 一般是網站域名
     * @return bool
     */
    public function SiteStart(string $siteName): bool
    {
        $site = $this->SiteSearch($siteName);
        $response = $this->sendRequest('/site?action=SiteStart', [
            'id' => $site['id'],
            'name' => $site['name']
        ]);
        return isset($response['status']) && $response['status'] === true;
    }
    /**
     * 關閉網站
     * @param string $siteName 網站名稱 一般是網站域名
     * @return bool
     */
    public function SiteStop(string $siteName): bool
    {
        $site = $this->SiteSearch($siteName);
        $response = $this->sendRequest('/site?action=SiteStop', [
            'id' => $site['id'],
            'name' => $site['name']
        ]);
        return isset($response['status']) && $response['status'] === true;
    }
    /**
     * 為網站繫結域名
     * @param string $siteName 網站名稱 一般是網站域名
     * @param string $domain 需要繫結的域名
     * @return bool
     */
    public function AddDomain(string $siteName, string $domain)
    {
        $site = $this->SiteSearch($siteName);
        $response = $this->sendRequest('/site?action=AddDomain', [
            'id' => $site['id'],
            'webname' => $site['name'],
            'domain' => $domain
        ]);
        // 繫結成功 status === true
        // 繫結失敗 和 指定域名已係結過  都返回 status === false
        // 不好區分 失敗 還是 域名已係結
        return isset($response['status']);
    }
    /**
     * 刪除網站繫結的域名
     * @param string $siteName 網站名稱 一般是網站域名
     * @param string $domain 需要刪除的域名
     * @return bool
     */
    public function DelDomain(string $siteName, string $domain)
    {
        $site = $this->SiteSearch($siteName);
        $response = $this->sendRequest('/site?action=DelDomain', [
            'id' => $site['id'],
            'webname' => $site['name'],
            'port' => '80',
            'domain' => $domain
        ]);
        return isset($response['status']) && $response['status'] === true;
    }
    /**
     * 網站設定SSL證書
     * @param string $domain 站點域名
     * @param string $key
     * @param string $csr
     * @return bool
     */
    public function SetSSL(string $domain, string $key, string $csr): bool
    {
        $data = [
            'type' => 1,
            'siteName' => $domain,
            'key' => '',
            'csr' => ''
        ];
        $response = $this->sendRequest('/site?action=SetSSL', $data);
        return isset($response['status']) && $response['status'] === true;
    }
    /**
     * 獲取SSL狀態及證書詳情
     * @param string $domain 站點域名
     * @return string|false 成功則返回證書到期時間
     */
    public function GetSSL(string $domain)
    {
        $data = [
            'siteName' => $domain
        ];
        $response = $this->sendRequest('/site?action=GetSSL', $data);
        return (isset($response['status']) && $response['status'] === true && $response['cert_data']) ? $response['cert_data']['notAfter'] : false;
    }
    /**
     * 設定網站執行目錄
     * @param int $siteId 站點域名
     * @param string $runPath 執行目錄路徑
     * @return bool
     */
    public function SetSiteRunPath(int $siteId, string $runPath = '/public'): bool
    {
        $data = [
            'id' => $siteId,
            'runPath' => $runPath
        ];
        $response = $this->sendRequest('/site?action=SetSiteRunPath', $data);
        return isset($response['status']) && $response['status'] === true;
    }
    /**
     * 獲取網站預置偽靜態規則內容（檔案內容）
     * @param string $domain 網站域名
     * @param [type] $type 0->獲取內建偽靜態規則 /www/server/panel/rewrite/nginx/xxxxx.conf；1->獲取當前站點偽靜態規則 /www/server/panel/vhost/rewrite/www.baidu.com.conf
     * @return string|false 成功則返回偽靜態規則內容
     */
    public function GetFileBody(string $domain)
    {
        $data = [
            'path' => "/www/server/panel/vhost/rewrite/$domain.conf"
        ];
        $response = $this->sendRequest('/files?action=GetFileBody', $data);
        return (isset($response['status']) && $response['status'] === true) ? $response['data'] : false;
    }
    /**
     * 儲存網站偽靜態規則內容(儲存檔案內容)
     * 0->系統預設路徑；1->自定義全路徑
     * @param string $domain
     * @param string|null $htaccess
     * @return bool
     */
    public function SaveFileBody(string $domain, string $htaccess = null): bool
    {
        $htaccess = $htaccess ?: config('custom.bt.htaccess');
        $data = [
            'path' => "/www/server/panel/vhost/rewrite/$domain.conf", // 偽靜態檔案路徑
            'data' => $htaccess, // 偽靜態規則內容 ==> 字串
            'encoding' => 'utf-8'
        ];
        $response = $this->sendRequest('/files?action=SaveFileBody', $data);
        return isset($response['status']) && $response['status'] === true;
    }
    /**
     * 網站申請並設定SSL證書
     * ！！！PS：當前請求比較耗時間 20s-60s不等  最好單獨使用
     * @param int $id 站點ID
     * @param string $domain 需要申請的域名
     * @return bool|integer
     */
    public function GetApplyCert(int $id, string $domain)
    {
        $data = [
            "domains" => json_encode([$domain]),
            "auth_type" => "http",
            "auto_wildcard" => 0,
            "auth_to" => $id,
            "id" => $id,
            "siteName" => $domain
        ];
        $response = $this->sendRequest('/acme?action=apply_cert_api', $data);
//        $response = [
//            'cert' => '',
//            'root' => '',
//            'private_key' => '',
//            'cert_timeout' => 1679184499,
//            'status' => true
//        ];
        if (isset($response['status']) && $response['status'] === true) {
            Storage::put("ssl/$domain.txt", json_encode($response));
            $res = $this->SetSSL($domain, $response['private_key'], $response['cert'] . $response['root']);
            return $res ? $response['cert_timeout'] : false;
        }
        return false;
    }
}