feat: Unify the encapsulation of the component for 'service not exist' (#8348)

Author: ssongliu

agent/app/api/v2/docker.go

@@ -12,7 +12,7 @@ import (
 // @Tags Container Docker
 // @Summary Load docker status
 // @Produce json
-// @Success 200 {string} status
+// @Success 200 {string} dto.DockerStatus
 // @Security ApiKeyAuth
 // @Security Timestamp
 // @Router /containers/docker/status [get]
@@ -49,7 +49,11 @@ func (b *BaseApi) LoadDaemonJsonFile(c *gin.Context) {
 // @Security Timestamp
 // @Router /containers/daemonjson [get]
 func (b *BaseApi) LoadDaemonJson(c *gin.Context) {
-	conf := dockerService.LoadDockerConf()
+	conf, err := dockerService.LoadDockerConf()
+	if err != nil {
+		helper.InternalServer(c, err)
+		return
+	}
 	helper.SuccessWithData(c, conf)
 }
 

agent/app/dto/docker.go

@@ -4,10 +4,13 @@ type DaemonJsonUpdateByFile struct {
 	File string `json:"file"`
 }
 
+type DockerStatus struct {
+	IsActive bool `json:"isActive"`
+	IsExist  bool `json:"isExist"`
+}
+
 type DaemonJsonConf struct {
 	IsSwarm      bool     `json:"isSwarm"`
-	IsExist      bool     `json:"isExist"`
-	IsActive     bool     `json:"isActive"`
 	Version      string   `json:"version"`
 	Mirrors      []string `json:"registryMirrors"`
 	Registries   []string `json:"insecureRegistries"`

agent/app/service/docker.go

@@ -25,8 +25,8 @@ type IDockerService interface {
 	UpdateLogOption(req dto.LogOption) error
 	UpdateIpv6Option(req dto.Ipv6Option) error
 	UpdateConfByFile(info dto.DaemonJsonUpdateByFile) error
-	LoadDockerStatus() string
-	LoadDockerConf() *dto.DaemonJsonConf
+	LoadDockerStatus() *dto.DockerStatus
+	LoadDockerConf() (*dto.DaemonJsonConf, error)
 	OperateDocker(req dto.DockerOperation) error
 }
 
@@ -52,66 +52,66 @@ type logOption struct {
 	LogMaxFile string `json:"max-file"`
 }
 
-func (u *DockerService) LoadDockerStatus() string {
+func (u *DockerService) LoadDockerStatus() *dto.DockerStatus {
+	ctx := context.Background()
+	var data dto.DockerStatus
+	if !cmd.Which("docker") {
+		data.IsExist = false
+		return &data
+	}
+	data.IsExist = true
+	data.IsActive, _ = systemctl.IsActive("docker")
 	client, err := docker.NewDockerClient()
 	if err != nil {
-		return constant.StatusStopped
+		global.LOG.Errorf("load docker client failed, err: %v", err)
+		data.IsActive = false
+		return &data
 	}
 	defer client.Close()
-	if _, err := client.Ping(context.Background()); err != nil {
-		return constant.StatusStopped
+	if _, err := client.Ping(ctx); err != nil {
+		global.LOG.Errorf("ping docker client failed, err: %v", err)
+		data.IsActive = false
 	}
 
-	return constant.StatusRunning
+	return &data
 }
 
-func (u *DockerService) LoadDockerConf() *dto.DaemonJsonConf {
+func (u *DockerService) LoadDockerConf() (*dto.DaemonJsonConf, error) {
 	ctx := context.Background()
 	var data dto.DaemonJsonConf
 	data.IPTables = true
 	data.Version = "-"
-	if !cmd.Which("docker") {
-		data.IsExist = false
-		return &data
-	}
-	data.IsExist = true
-	data.IsActive = true
 	client, err := docker.NewDockerClient()
 	if err != nil {
-		data.IsActive = false
-	} else {
-		defer client.Close()
-		if _, err := client.Ping(ctx); err != nil {
-			data.IsActive = false
-		}
-		itemVersion, err := client.ServerVersion(ctx)
-		if err == nil {
-			data.Version = itemVersion.Version
-		}
+		return &data, err
+	}
+	itemVersion, err := client.ServerVersion(ctx)
+	if err == nil {
+		data.Version = itemVersion.Version
 	}
 	data.IsSwarm = false
 	stdout2, _ := cmd.Exec("docker info  | grep Swarm")
 	if string(stdout2) == " Swarm: active\n" {
 		data.IsSwarm = true
 	}
 	if _, err := os.Stat(constant.DaemonJsonPath); err != nil {
-		return &data
+		return &data, nil
 	}
 	file, err := os.ReadFile(constant.DaemonJsonPath)
 	if err != nil {
-		return &data
+		return &data, nil
 	}
 	var conf daemonJsonItem
 	daemonMap := make(map[string]interface{})
 	if err := json.Unmarshal(file, &daemonMap); err != nil {
-		return &data
+		return &data, nil
 	}
 	arr, err := json.Marshal(daemonMap)
 	if err != nil {
-		return &data
+		return &data, err
 	}
 	if err := json.Unmarshal(arr, &conf); err != nil {
-		return &data
+		return &data, err
 	}
 	if _, ok := daemonMap["iptables"]; !ok {
 		conf.IPTables = true
@@ -133,7 +133,7 @@ func (u *DockerService) LoadDockerConf() *dto.DaemonJsonConf {
 	data.Registries = conf.Registries
 	data.IPTables = conf.IPTables
 	data.LiveRestore = conf.LiveRestore
-	return &data
+	return &data, nil
 }
 
 func (u *DockerService) UpdateConf(req dto.SettingUpdate) error {

frontend/src/api/interface/container.ts

@@ -335,6 +335,10 @@ export namespace Container {
     export interface DaemonJsonUpdateByFile {
         file: string;
     }
+    export interface DockerStatus {
+        isActive: boolean;
+        isExist: boolean;
+    }
     export interface DaemonJsonConf {
         isSwarm: boolean;
         isExist: boolean;

frontend/src/api/modules/container.ts

@@ -187,7 +187,7 @@ export const loadDaemonJsonFile = () => {
     return http.get<string>(`/containers/daemonjson/file`);
 };
 export const loadDockerStatus = () => {
-    return http.get<string>(`/containers/docker/status`);
+    return http.get<Container.DockerStatus>(`/containers/docker/status`);
 };
 export const updateDaemonJson = (key: string, value: string) => {
     return http.post(`/containers/daemonjson/update`, { key: key, value: value }, TimeoutEnum.T_60S);

frontend/src/components/layout-content/no-such-service.vue

@@ -0,0 +1,32 @@
+<template>
+    <div>
+        <LayoutContent :divider="true">
+            <template #main>
+                <div class="app-warn">
+                    <div class="flex flex-col gap-2 items-center justify-center w-full sm:flex-row">
+                        <span>{{ $t('cronjob.library.noSuchApp', [prop.name]) }}</span>
+                        <span @click="toDoc" class="flex items-center justify-center gap-0.5">
+                            <el-icon><Position /></el-icon>
+                            {{ $t('firewall.quickJump') }}
+                        </span>
+                    </div>
+                    <div>
+                        <img src="@/assets/images/no_app.svg" />
+                    </div>
+                </div>
+            </template>
+        </LayoutContent>
+    </div>
+</template>
+
+<script lang="ts" setup>
+import router from '@/routers';
+
+const prop = defineProps({
+    name: String,
+});
+
+const toDoc = () => {
+    router.push({ name: 'Library' });
+};
+</script>

frontend/src/lang/modules/en.ts

@@ -1046,6 +1046,7 @@ const message = {
             groupHelper:
                 'Set different groups based on script characteristics, which allows for faster script filtering operations.',
             handleHelper: 'Execute script {1} on {0}, continue?',
+            noSuchApp: 'The {0} service was not detected. Please install it quickly using the script library first!',
         },
     },
     monitor: {
@@ -1185,7 +1186,6 @@ const message = {
         fail2ban: {
             sshPort: 'Listen to SSH Port',
             sshPortHelper: 'Current Fail2ban listens to the SSH connection port of the host',
-            noFail2ban: 'Fail2ban service not detected, please refer to the official documentation for installation!',
             unActive: 'The Fail2ban service is not enabled at present, please enable it first!',
             operation: 'Perform [{0}] operation on Fail2ban service, continue?',
             fail2banChange: 'Fail2ban Configuration Modification',
@@ -1208,7 +1208,6 @@ const message = {
         ftp: {
             ftp: 'FTP Account',
             notStart: 'FTP service is currently not running, please start it first!',
-            noFtp: 'FTP (pure-ftpd) service not detected, please refer to the official documentation for installation!',
             operation: 'Perform [{0}] operation on FTP service, continue?',
             noPasswdMsg: 'Can not get the current FTP account password, please set the password and try again! ',
             enableHelper:
@@ -1230,7 +1229,6 @@ const message = {
             hideFresh: 'Hide Virus Database Service',
             clamHelper:
                 'The minimum recommended configuration for ClamAV is: 3 GiB of RAM or more, single-core CPU with 2.0 GHz or higher, and at least 5 GiB of available hard disk space.',
-            noClam: 'ClamAV service not detected, please refer to the official documentation for installation!',
             notStart: 'ClamAV service is currently not running, please start it first!',
             removeRecord: 'Delete Report Files',
             removeResultHelper: 'Delete report files generated during task execution to free up storage space.',
@@ -2538,8 +2536,6 @@ const message = {
     firewall: {
         create: 'Create Rule',
         edit: 'Edit rule',
-        notSupport:
-            'No system firewall detected (firewalld or ufw). Please refer to the official documentation for installation.',
         ccDeny: 'CC Protection',
         ipWhiteList: 'IP Whitelist',
         ipBlockList: 'IP Blacklist',

frontend/src/lang/modules/ja.ts

@@ -1005,6 +1005,8 @@ const message = {
             groupHelper:
                 'スクリプトの特徴に基づいて異なるグループを設定することで、スクリプトのフィルタリング操作をより迅速に行うことができます。',
             handleHelper: '{0} で {1} スクリプトを実行します。続行しますか？',
+            noSuchApp:
+                '{0} サービスが検出されませんでした。スクリプトライブラリを使って素早くインストールしてください！',
         },
     },
     monitor: {
@@ -1123,7 +1125,6 @@ const message = {
         fail2ban: {
             sshPort: 'SSHポートを聞いてください',
             sshPortHelper: '現在のFAL2BANは、ホストのSSH接続ポートに耳を傾けます',
-            noFail2ban: `Fail2banサービスは検出されません。インストールする公式ドキュメントを参照してください。`,
             unActive: `現在、Fail2Banサービスは有効になっていません。`,
             operation: 'fail2banサービスで操作「{0}」を実行します。続けたいですか？',
             fail2banChange: 'fail2ban構成の変更',
@@ -1146,7 +1147,6 @@ const message = {
         ftp: {
             ftp: 'FTPアカウント|FTPアカウント',
             notStart: 'FTP Serviceは現在実行されていません。最初に開始してください！',
-            noFtp: `FTP（Pure-FTPD）サービスは検出されません。インストールする公式ドキュメントを参照してください。`,
             operation: 'これにより、FTPサービスで「{0}」操作が実行されます。続けたいですか？',
             noPasswdMsg: '現在のFTPアカウントパスワードを取得できません。パスワードを設定して再試行してください！',
             enableHelper: '選択したFTPアカウントを有効にすると、アクセス許可が復元されます。続けたいですか？',
@@ -1166,7 +1166,6 @@ const message = {
             hideFresh: '署名のアップデーターサービスを非表示にします',
             clamHelper:
                 'Clamavの最小推奨構成は、3ギブ以上のRAM、2.0 GHz以上のシングルコアCPU、および少なくとも5 GIBの利用可能なハードディスクスペースです。',
-            noClam: 'CLAMAVサービスは検出されていません。インストールのための公式ドキュメントを参照してください！',
             notStart: 'Clamav Serviceは現在実行されていません。最初に開始してください！',
             removeRecord: 'ペポートファイルを削除します',
             noRecords: '[トリガー]ボタンをクリックしてスキャンを開始すると、ここにレコードが表示されます。',
@@ -2424,8 +2423,6 @@ const message = {
     firewall: {
         create: 'ルールを作成します',
         edit: 'ルールを編集します',
-        notSupport:
-            'システムファイアウォールは検出されません（ファイアウォールまたはUFW）。インストールのための公式ドキュメントを参照してください。',
         ccDeny: 'CC保護',
         ipWhiteList: 'IP AllowList',
         ipBlockList: 'IPブロックリスト',

frontend/src/lang/modules/ko.ts

@@ -999,6 +999,7 @@ const message = {
             groupHelper:
                 '스크립트 특성에 따라 다양한 그룹을 설정하여 스크립트 필터링 작업을 더 빠르게 수행할 수 있습니다.',
             handleHelper: '{0} 에서 {1} 스크립트를 실행합니다. 계속하시겠습니까?',
+            noSuchApp: '{0} 서비스가 감지되지 않았습니다. 스크립트 라이브러리를 사용하여 먼저 빠르게 설치하세요!',
         },
     },
     monitor: {
@@ -1114,7 +1115,6 @@ const message = {
         fail2ban: {
             sshPort: 'SSH 포트 청취',
             sshPortHelper: '현재 Fail2ban 은 호스트의 SSH 연결 포트를 청취합니다.',
-            noFail2ban: 'Fail2ban 서비스가 감지되지 않았습니다. 공식 문서를 참조하여 설치하세요.',
             unActive: '현재 Fail2ban 서비스가 활성화되어 있지 않습니다.',
             operation: 'Fail2ban 서비스에서 "{0}" 작업을 수행합니다. 계속하시겠습니까?',
             fail2banChange: 'Fail2ban 구성 수정',
@@ -1137,7 +1137,6 @@ const message = {
         ftp: {
             ftp: 'FTP 계정 | FTP 계정들',
             notStart: 'FTP 서비스가 현재 실행 중이 아닙니다. 먼저 시작하세요!',
-            noFtp: `FTP (pure-ftpd) 서비스가 감지되지 않았습니다. 공식 문서를 참조하여 설치하세요.`,
             operation: 'FTP 서비스에서 "{0}" 작업을 수행합니다. 계속하시겠습니까?',
             noPasswdMsg: '현재 FTP 계정의 비밀번호를 가져올 수 없습니다. 비밀번호를 설정한 후 다시 시도하세요!',
             enableHelper: '선택한 FTP 계정을 활성화하면 접근 권한이 복원됩니다. 계속하시겠습니까?',
@@ -1155,7 +1154,6 @@ const message = {
             hideFresh: '서명 업데이트 서비스 숨기기',
             clamHelper:
                 'ClamAV의 최소 권장 구성은 다음과 같습니다: RAM 3 GiB 이상, 2.0 GHz 이상의 단일 코어 CPU, 최소 5 GiB의 사용 가능한 하드 디스크 공간.',
-            noClam: 'ClamAV 서비스가 감지되지 않았습니다. 공식 문서를 참조하여 설치하세요!',
             notStart: 'ClamAV 서비스가 현재 실행 중이 아닙니다. 먼저 시작하세요!',
             removeRecord: '보고서 파일 삭제',
             noRecords: '"Trigger" 버튼을 클릭하여 스캔을 시작하면 이곳에서 기록을 확인할 수 있습니다.',
@@ -2385,7 +2383,6 @@ const message = {
     firewall: {
         create: '규칙 만들기',
         edit: '규칙 수정',
-        notSupport: '시스템 방화벽이 감지되지 않았습니다 (firewalld 또는 ufw). 설치 방법은 공식 문서를 참조하세요.',
         ccDeny: 'CC 보호',
         ipWhiteList: 'IP 허용 목록',
         ipBlockList: 'IP 차단 목록',

frontend/src/lang/modules/ms.ts

@@ -1035,6 +1035,8 @@ const message = {
             groupHelper:
                 'Tetapkan kumpulan yang berbeza berdasarkan ciri skrip, yang membolehkan operasi penapisan skrip dilakukan dengan lebih pantas.',
             handleHelper: 'Akan melaksanakan skrip {1} pada {0}, teruskan?',
+            noSuchApp:
+                'Perkhidmatan {0} tidak dikesan. Sila pasang dengan cepat menggunakan pustaka skrip terlebih dahulu!',
         },
     },
     monitor: {
@@ -1161,7 +1163,6 @@ const message = {
         fail2ban: {
             sshPort: 'Dengar pada port SSH',
             sshPortHelper: 'Fail2ban semasa mendengar pada port sambungan SSH hos',
-            noFail2ban: 'Perkhidmatan Fail2ban tidak dikesan. Rujuk dokumen rasmi untuk memasang.',
             unActive: 'Perkhidmatan Fail2ban tidak diaktifkan pada masa ini.',
             operation: 'Anda akan melaksanakan operasi "{0}" pada perkhidmatan Fail2ban. Adakah anda mahu meneruskan?',
             fail2banChange: 'Pengubahan Konfigurasi Fail2ban',
@@ -1185,7 +1186,6 @@ const message = {
         ftp: {
             ftp: 'Akaun FTP | Akaun FTP',
             notStart: 'Perkhidmatan FTP tidak berjalan pada masa ini, sila mulakan dahulu!',
-            noFtp: 'Perkhidmatan FTP (pure-ftpd) tidak dikesan. Rujuk dokumen rasmi untuk memasang.',
             operation: 'Ini akan melaksanakan operasi "{0}" pada perkhidmatan FTP. Adakah anda mahu meneruskan?',
             noPasswdMsg:
                 'Tidak dapat mendapatkan kata laluan akaun FTP semasa, sila tetapkan kata laluan dan cuba lagi!',
@@ -1208,7 +1208,6 @@ const message = {
             hideFresh: 'Sembunyikan perkhidmatan pengemas kini tanda tangan',
             clamHelper:
                 'Konfigurasi minimum yang disyorkan untuk ClamAV ialah: RAM 3 GiB atau lebih, CPU teras tunggal dengan 2.0 GHz atau lebih tinggi, dan sekurang-kurangnya 5 GiB ruang cakera keras yang tersedia.',
-            noClam: 'Perkhidmatan ClamAV tidak dikesan, sila rujuk dokumentasi rasmi untuk pemasangan!',
             notStart: 'Perkhidmatan ClamAV tidak berjalan pada masa ini, sila mulakan dahulu!',
             removeRecord: 'Padam fail laporan',
             noRecords: 'Klik butang "Picu" untuk memulakan imbasan dan anda akan melihat rekod di sini.',
@@ -2482,8 +2481,6 @@ const message = {
     firewall: {
         create: 'Buat peraturan',
         edit: 'Edit peraturan',
-        notSupport:
-            'Tiada firewall sistem yang dikesan (firewalld atau ufw). Sila rujuk dokumentasi rasmi untuk pemasangan.',
         ccDeny: 'Perlindungan CC',
         ipWhiteList: 'Senarai putih IP',
         ipBlockList: 'Senarai blok IP',