From c1a046f30e757e100b483f19e2add4214e9e9761 Mon Sep 17 00:00:00 2001
From: lijiahangmax <ljh1553488six@139.com>
Date: Fri, 12 Jan 2024 02:05:27 +0800
Subject: [PATCH] =?UTF-8?q?feat:=20=E8=A1=A5=E5=85=A8=E7=BB=88=E7=AB=AF?=
 =?UTF-8?q?=E4=BA=A4=E4=BA=92=E9=80=BB=E8=BE=91.?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../host/terminal/enums/InputTypeEnum.java    |   2 +-
 .../handler/TerminalConnectHandler.java       |   2 +-
 .../model/request/TerminalConnectRequest.java |   3 +
 .../terminal/session/ITerminalSession.java    |   7 +-
 .../terminal/session/TerminalSession.java     |   5 +-
 .../model/TerminalPreferenceModel.java        |   2 +-
 orion-ops-ui/src/hooks/copy.ts                |   4 +-
 .../view-setting/block-setting-item.vue       |   2 +-
 .../view-setting/terminal-interact-block.vue  |  10 +-
 .../components/xterm/terminal-view.vue        |   9 +-
 .../handler/terminal-output-processor.ts      |  16 ++-
 .../host/terminal/handler/terminal-session.ts | 130 +++++++++++++++---
 .../host/terminal/types/terminal.protocol.ts  |   2 +-
 .../host/terminal/types/terminal.type.ts      |   8 +-
 14 files changed, 150 insertions(+), 52 deletions(-)

diff --git a/orion-ops-module-asset/orion-ops-module-asset-service/src/main/java/com/orion/ops/module/asset/handler/host/terminal/enums/InputTypeEnum.java b/orion-ops-module-asset/orion-ops-module-asset-service/src/main/java/com/orion/ops/module/asset/handler/host/terminal/enums/InputTypeEnum.java
index 42cf2f6b..aec35ab1 100644
--- a/orion-ops-module-asset/orion-ops-module-asset-service/src/main/java/com/orion/ops/module/asset/handler/host/terminal/enums/InputTypeEnum.java
+++ b/orion-ops-module-asset/orion-ops-module-asset-service/src/main/java/com/orion/ops/module/asset/handler/host/terminal/enums/InputTypeEnum.java
@@ -32,7 +32,7 @@ public enum InputTypeEnum {
      */
     CONNECT("co",
             TerminalConnectHandler.class,
-            new String[]{"type", "sessionId", "cols", "rows"},
+            new String[]{"type", "sessionId", "terminalType", "cols", "rows"},
             TerminalConnectRequest.class),
 
     /**
diff --git a/orion-ops-module-asset/orion-ops-module-asset-service/src/main/java/com/orion/ops/module/asset/handler/host/terminal/handler/TerminalConnectHandler.java b/orion-ops-module-asset/orion-ops-module-asset-service/src/main/java/com/orion/ops/module/asset/handler/host/terminal/handler/TerminalConnectHandler.java
index bfddd4f2..716dadaa 100644
--- a/orion-ops-module-asset/orion-ops-module-asset-service/src/main/java/com/orion/ops/module/asset/handler/host/terminal/handler/TerminalConnectHandler.java
+++ b/orion-ops-module-asset/orion-ops-module-asset-service/src/main/java/com/orion/ops/module/asset/handler/host/terminal/handler/TerminalConnectHandler.java
@@ -110,7 +110,7 @@ public class TerminalConnectHandler extends AbstractTerminalHandler<TerminalConn
             // 建立连接
             SessionStore sessionStore = hostTerminalService.openSessionStore(connect);
             terminalSession = new TerminalSession(sessionId, channel, sessionStore, config);
-            terminalSession.connect(body.getCols(), body.getRows());
+            terminalSession.connect(body.getTerminalType(), body.getCols(), body.getRows());
             log.info("TerminalConnectHandler-handle success sessionId: {}", sessionId);
             return terminalSession;
         } catch (Exception e) {
diff --git a/orion-ops-module-asset/orion-ops-module-asset-service/src/main/java/com/orion/ops/module/asset/handler/host/terminal/model/request/TerminalConnectRequest.java b/orion-ops-module-asset/orion-ops-module-asset-service/src/main/java/com/orion/ops/module/asset/handler/host/terminal/model/request/TerminalConnectRequest.java
index 06264ac2..16cc3a6f 100644
--- a/orion-ops-module-asset/orion-ops-module-asset-service/src/main/java/com/orion/ops/module/asset/handler/host/terminal/model/request/TerminalConnectRequest.java
+++ b/orion-ops-module-asset/orion-ops-module-asset-service/src/main/java/com/orion/ops/module/asset/handler/host/terminal/model/request/TerminalConnectRequest.java
@@ -25,6 +25,9 @@ import lombok.experimental.SuperBuilder;
 @Schema(name = "TerminalConnectRequest", description = "终端连接请求 实体对象")
 public class TerminalConnectRequest extends TerminalBasePayload {
 
+    @Schema(description = "伪终端类型")
+    private String terminalType;
+
     @Schema(description = "列数")
     private Integer cols;
 
diff --git a/orion-ops-module-asset/orion-ops-module-asset-service/src/main/java/com/orion/ops/module/asset/handler/host/terminal/session/ITerminalSession.java b/orion-ops-module-asset/orion-ops-module-asset-service/src/main/java/com/orion/ops/module/asset/handler/host/terminal/session/ITerminalSession.java
index a216f9e1..f5f2f0fb 100644
--- a/orion-ops-module-asset/orion-ops-module-asset-service/src/main/java/com/orion/ops/module/asset/handler/host/terminal/session/ITerminalSession.java
+++ b/orion-ops-module-asset/orion-ops-module-asset-service/src/main/java/com/orion/ops/module/asset/handler/host/terminal/session/ITerminalSession.java
@@ -14,10 +14,11 @@ public interface ITerminalSession extends SafeCloseable {
     /**
      * 连接
      *
-     * @param cols cols
-     * @param rows rows
+     * @param terminalType terminalType
+     * @param cols         cols
+     * @param rows         rows
      */
-    void connect(int cols, int rows);
+    void connect(String terminalType, int cols, int rows);
 
     /**
      * 重置大小
diff --git a/orion-ops-module-asset/orion-ops-module-asset-service/src/main/java/com/orion/ops/module/asset/handler/host/terminal/session/TerminalSession.java b/orion-ops-module-asset/orion-ops-module-asset-service/src/main/java/com/orion/ops/module/asset/handler/host/terminal/session/TerminalSession.java
index 6e11a488..3d8d1834 100644
--- a/orion-ops-module-asset/orion-ops-module-asset-service/src/main/java/com/orion/ops/module/asset/handler/host/terminal/session/TerminalSession.java
+++ b/orion-ops-module-asset/orion-ops-module-asset-service/src/main/java/com/orion/ops/module/asset/handler/host/terminal/session/TerminalSession.java
@@ -61,14 +61,13 @@ public class TerminalSession implements ITerminalSession {
     }
 
     @Override
-    public void connect(int cols, int rows) {
+    public void connect(String terminalType, int cols, int rows) {
         config.setCols(cols);
         config.setRows(rows);
         // 打开 shell
         this.executor = sessionStore.getShellExecutor();
         executor.size(cols, rows);
-        // FIXME
-        executor.terminalType(TerminalType.XTERM.getType());
+        executor.terminalType(terminalType);
         executor.streamHandler(this::streamHandler);
         executor.callback(this::eofCallback);
         executor.connect();
diff --git a/orion-ops-module-infra/orion-ops-module-infra-service/src/main/java/com/orion/ops/module/infra/handler/preference/model/TerminalPreferenceModel.java b/orion-ops-module-infra/orion-ops-module-infra-service/src/main/java/com/orion/ops/module/infra/handler/preference/model/TerminalPreferenceModel.java
index fce00f22..36044c17 100644
--- a/orion-ops-module-infra/orion-ops-module-infra-service/src/main/java/com/orion/ops/module/infra/handler/preference/model/TerminalPreferenceModel.java
+++ b/orion-ops-module-infra/orion-ops-module-infra-service/src/main/java/com/orion/ops/module/infra/handler/preference/model/TerminalPreferenceModel.java
@@ -86,7 +86,7 @@ public class TerminalPreferenceModel implements PreferenceModel {
         @Schema(description = "右键选中词条")
         private Boolean rightClickSelectsWord;
 
-        @Schema(description = "选中词条自动复制")
+        @Schema(description = "选中自动复制")
         private Boolean selectionChangeCopy;
 
         @Schema(description = "复制去除空格")
diff --git a/orion-ops-ui/src/hooks/copy.ts b/orion-ops-ui/src/hooks/copy.ts
index d3ed2d9d..86feab58 100644
--- a/orion-ops-ui/src/hooks/copy.ts
+++ b/orion-ops-ui/src/hooks/copy.ts
@@ -4,14 +4,14 @@ import { Message } from '@arco-design/web-vue';
 export default function useCopy() {
   const { copy: c } = useClipboard();
   // 复制
-  const copy = async (value: string | undefined, tips = `${value} 已复制`) => {
+  const copy = async (value: string | undefined, tips: string | boolean = `${value} 已复制`) => {
     try {
       if (!value) {
         return;
       }
       await c(value);
       if (tips) {
-        Message.success(tips);
+        Message.success(tips as string);
       }
     } catch (e) {
       Message.error('复制失败');
diff --git a/orion-ops-ui/src/views/host/terminal/components/view-setting/block-setting-item.vue b/orion-ops-ui/src/views/host/terminal/components/view-setting/block-setting-item.vue
index 2e080db3..b1f0ee22 100644
--- a/orion-ops-ui/src/views/host/terminal/components/view-setting/block-setting-item.vue
+++ b/orion-ops-ui/src/views/host/terminal/components/view-setting/block-setting-item.vue
@@ -17,7 +17,6 @@
       </div>
     </div>
   </a-col>
-
 </template>
 
 <script lang="ts">
@@ -64,6 +63,7 @@
     :deep(.arco-input-wrapper) {
       background-color: var(--color-fill-3)
     }
+
     :deep(.arco-select) {
       background-color: var(--color-fill-3)
     }
diff --git a/orion-ops-ui/src/views/host/terminal/components/view-setting/terminal-interact-block.vue b/orion-ops-ui/src/views/host/terminal/components/view-setting/terminal-interact-block.vue
index 4b94fea6..0d308cd8 100644
--- a/orion-ops-ui/src/views/host/terminal/components/view-setting/terminal-interact-block.vue
+++ b/orion-ops-ui/src/views/host/terminal/components/view-setting/terminal-interact-block.vue
@@ -24,12 +24,12 @@
       </a-row>
       <a-row class="mb16" align="stretch" :gutter="16">
         <!-- 右键选中词条 -->
-        <block-setting-item label="右键选中词条" desc="右键文本">
+        <block-setting-item label="右键选中词条" desc="右键文本后会根据单词分隔符自动选中词条">
           <a-switch type="round"
                     v-model="formModel.rightClickSelectsWord" />
         </block-setting-item>
-        <!-- 选中词条自动复制 -->
-        <block-setting-item label="选中词条自动复制" desc="自动将选中的词条复制到剪切板">
+        <!-- 选中自动复制 -->
+        <block-setting-item label="选中自动复制" desc="自动将选中的文本复制到剪切板">
           <a-switch type="round"
                     v-model="formModel.selectionChangeCopy" />
         </block-setting-item>
@@ -41,14 +41,14 @@
                     v-model="formModel.copyAutoTrim" />
         </block-setting-item>
         <!-- 粘贴去除空格 -->
-        <block-setting-item label="粘贴去除空格" desc="粘贴文本前自动删除尾部空格">
+        <block-setting-item label="粘贴去除空格" desc="粘贴文本前自动删除尾部空格 如: 命令输入框, 命令编辑器, 右键粘贴, 粘贴按钮, 右键菜单粘贴, 自定义粘贴快捷键. (系统快捷键无法干预 如: ctrl + shift + v, shift + insert)">
           <a-switch type="round"
                     v-model="formModel.pasteAutoTrim" />
         </block-setting-item>
       </a-row>
       <a-row class="mb16" align="stretch" :gutter="16">
         <!-- 右键粘贴 -->
-        <block-setting-item label="右键粘贴" desc="右键自动粘贴, 启用后需要关闭右键菜单">
+        <block-setting-item label="右键粘贴" desc="右键自动粘贴, 启用后需要关闭右键菜单 (若开启了右键选中词条, 有选中的文本时, 右键粘贴无效)">
           <a-switch type="round"
                     v-model="formModel.rightClickPaste" />
         </block-setting-item>
diff --git a/orion-ops-ui/src/views/host/terminal/components/xterm/terminal-view.vue b/orion-ops-ui/src/views/host/terminal/components/xterm/terminal-view.vue
index 65bfd29f..9d833ec8 100644
--- a/orion-ops-ui/src/views/host/terminal/components/xterm/terminal-view.vue
+++ b/orion-ops-ui/src/views/host/terminal/components/xterm/terminal-view.vue
@@ -83,8 +83,9 @@
   const session = ref<ITerminalSession>();
 
   // FIXME
-  // 右键菜单补充
   // 搜索 search color 配置
+  // 右键菜单补充     启用右键菜单 enableRightClickMenu  粘贴逻辑
+  // 快捷键补充 粘贴逻辑
   // 截屏
   // 主机获取逻辑 最近连接逻辑
 
@@ -100,7 +101,7 @@
   // 发送命令
   const writeCommand = (value: string) => {
     if (session.value?.canWrite) {
-      session.value.paste(value);
+      session.value.pasteTrimEnd(value);
     }
   };
 
@@ -129,9 +130,9 @@
     // 全选
     checkAll: () => session.value?.selectAll(),
     // 复制选中部分
-    copy: () => copy(session.value?.getSelection(), '已复制'),
+    copy: () => session.value?.copySelection(),
     // 粘贴
-    paste: async () => session.value?.paste(await readText()),
+    paste: async () => session.value?.pasteTrimEnd(await readText()),
     // ctrl + c
     interrupt: () => session.value?.paste(String.fromCharCode(3)),
     // 回车
diff --git a/orion-ops-ui/src/views/host/terminal/handler/terminal-output-processor.ts b/orion-ops-ui/src/views/host/terminal/handler/terminal-output-processor.ts
index cae8ddd6..720e563b 100644
--- a/orion-ops-ui/src/views/host/terminal/handler/terminal-output-processor.ts
+++ b/orion-ops-ui/src/views/host/terminal/handler/terminal-output-processor.ts
@@ -1,11 +1,7 @@
-import {
-  ITerminalChannel,
-  ITerminalOutputProcessor,
-  ITerminalSessionManager,
-  OutputPayload
-} from '../types/terminal.type';
+import { ITerminalChannel, ITerminalOutputProcessor, ITerminalSessionManager, OutputPayload } from '../types/terminal.type';
 import { InputProtocol } from '../types/terminal.protocol';
 import { TerminalStatus } from '../types/terminal.const';
+import { useTerminalStore } from '@/store';
 
 // 终端输出消息体处理器实现
 export default class TerminalOutputProcessor implements ITerminalOutputProcessor {
@@ -29,8 +25,14 @@ export default class TerminalOutputProcessor implements ITerminalOutputProcessor
       session.status = TerminalStatus.CLOSED;
       return;
     }
+    const { preference } = useTerminalStore();
     // 发送 connect 命令
-    this.channel.send(InputProtocol.CONNECT, { sessionId, cols: session.inst.cols, rows: session.inst.rows });
+    this.channel.send(InputProtocol.CONNECT, {
+      sessionId,
+      terminalType: preference.sessionSetting.terminalEmulationType || 'xterm',
+      cols: session.inst.cols,
+      rows: session.inst.rows
+    });
   }
 
   // 处理连接消息
diff --git a/orion-ops-ui/src/views/host/terminal/handler/terminal-session.ts b/orion-ops-ui/src/views/host/terminal/handler/terminal-session.ts
index bbbb1375..ae643e28 100644
--- a/orion-ops-ui/src/views/host/terminal/handler/terminal-session.ts
+++ b/orion-ops-ui/src/views/host/terminal/handler/terminal-session.ts
@@ -1,14 +1,20 @@
+import type { UnwrapRef } from 'vue';
+import type { TerminalPreference } from '@/store/modules/terminal/types';
 import type { ITerminalChannel, ITerminalSession, TerminalAddons } from '../types/terminal.type';
 import { useTerminalStore } from '@/store';
 import { fontFamilySuffix, TerminalStatus } from '../types/terminal.const';
 import { InputProtocol } from '../types/terminal.protocol';
 import { ITerminalOptions, Terminal } from 'xterm';
 import { FitAddon } from 'xterm-addon-fit';
-import { WebglAddon } from 'xterm-addon-webgl';
 import { WebLinksAddon } from 'xterm-addon-web-links';
 import { SearchAddon } from 'xterm-addon-search';
 import { ImageAddon } from 'xterm-addon-image';
 import { CanvasAddon } from 'xterm-addon-canvas';
+import { WebglAddon } from 'xterm-addon-webgl';
+import { playBell } from '@/utils/bell';
+import useCopy from '@/hooks/copy';
+
+const copy = useCopy();
 
 // 终端会话实现
 export default class TerminalSession implements ITerminalSession {
@@ -49,33 +55,29 @@ export default class TerminalSession implements ITerminalSession {
     this.inst = new Terminal({
       ...(preference.displaySetting as any),
       theme: preference.theme.schema,
-      fastScrollModifier: 'alt',
+      fastScrollModifier: !!preference.interactSetting.fastScrollModifier ? 'alt' : 'none',
+      altClickMovesCursor: !!preference.interactSetting.altClickMovesCursor,
+      rightClickSelectsWord: !!preference.interactSetting.rightClickSelectsWord,
       fontFamily: preference.displaySetting.fontFamily + fontFamilySuffix,
+      wordSeparator: preference.interactSetting.wordSeparator,
+      scrollback: preference.sessionSetting.scrollBackLine,
     });
+    // 注册快捷键
+    // 注册事件
+    this.registerEvent(dom, preference);
     // 注册插件
-    this.addons.fit = new FitAddon();
-    // this.addons.webgl = new WebglAddon();
-    this.addons.canvas = new CanvasAddon();
-    this.addons.link = new WebLinksAddon();
-    this.addons.search = new SearchAddon();
-    this.addons.image = new ImageAddon();
-    for (const addon of Object.values(this.addons)) {
-      this.inst.loadAddon(addon);
-    }
+    this.registerAddions(preference);
     // 打开终端
     this.inst.open(dom);
     // 自适应
     this.addons.fit.fit();
   }
 
-  // 设置已连接
-  connect(): void {
-    this.status = TerminalStatus.CONNECTED;
-    this.connected = true;
-    this.inst.focus();
+  // 注册事件
+  private registerEvent(dom: HTMLElement, preference: UnwrapRef<TerminalPreference>) {
     // 注册输入事件
     this.inst.onData(s => {
-      if (!this.canWrite) {
+      if (!this.canWrite || !this.connected) {
         return;
       }
       // 输入
@@ -84,14 +86,81 @@ export default class TerminalSession implements ITerminalSession {
         command: s
       });
     });
+    // 启用响铃
+    if (preference.interactSetting.enableBell) {
+      this.inst.onBell(() => {
+        // 播放蜂鸣
+        playBell();
+      });
+    }
+    // 选中复制
+    if (preference.interactSetting.selectionChangeCopy) {
+      this.inst.onSelectionChange(() => {
+        // 复制选中内容
+        this.copySelection();
+      });
+    }
     // 注册 resize 事件
     this.inst.onResize(({ cols, rows }) => {
+      if (!this.connected) {
+        return;
+      }
       this.channel.send(InputProtocol.RESIZE, {
         sessionId: this.sessionId,
         cols,
         rows
       });
     });
+    // 设置右键选项
+    dom.addEventListener('contextmenu', async (event) => {
+      // 如果开启了右键粘贴 右键选中 右键菜单 则关闭默认右键菜单
+      if (preference.interactSetting.rightClickSelectsWord
+        || preference.interactSetting.rightClickPaste
+        || preference.interactSetting.enableRightClickMenu) {
+        event.preventDefault();
+      }
+      // 右键粘贴逻辑
+      if (preference.interactSetting.rightClickPaste) {
+        if (!this.canWrite || !this.connected) {
+          return;
+        }
+        // 未开启右键选中 || 开启并无选中的内容则粘贴
+        if (!preference.interactSetting.rightClickSelectsWord || !this.inst.hasSelection()) {
+          this.pasteTrimEnd(await copy.readText());
+        }
+      }
+    });
+  }
+
+  // 注册插件
+  private registerAddions(preference: UnwrapRef<TerminalPreference>) {
+    this.addons.fit = new FitAddon();
+    this.addons.search = new SearchAddon();
+    // 超链接插件
+    if (preference.pluginsSetting.enableWeblinkPlugin) {
+      this.addons.weblink = new WebLinksAddon();
+    }
+    if (preference.pluginsSetting.enableWebglPlugin) {
+      // WebGL 渲染插件
+      this.addons.webgl = new WebglAddon();
+    } else {
+      // canvas 渲染插件
+      this.addons.canvas = new CanvasAddon();
+    }
+    // 图片渲染插件
+    if (preference.pluginsSetting.enableImagePlugin) {
+      this.addons.image = new ImageAddon();
+    }
+    for (const addon of Object.values(this.addons)) {
+      this.inst.loadAddon(addon);
+    }
+  }
+
+  // 设置已连接
+  connect(): void {
+    this.status = TerminalStatus.CONNECTED;
+    this.connected = true;
+    this.inst.focus();
   }
 
   // 设置是否可写
@@ -132,15 +201,36 @@ export default class TerminalSession implements ITerminalSession {
     this.inst.focus();
   }
 
+  // 粘贴并且去除尾部空格 (如果配置)
+  pasteTrimEnd(value: string): void {
+    if (useTerminalStore().preference.interactSetting.pasteAutoTrim) {
+      // 粘贴前去除尾部空格
+      this.inst.paste(value.trimEnd());
+    } else {
+      this.inst.paste(value);
+    }
+    this.inst.focus();
+  }
+
   // 选中全部
   selectAll(): void {
     this.inst.selectAll();
     this.inst.focus();
   }
 
-  // 获取选中
-  getSelection(): string {
-    const selection = this.inst.getSelection();
+  // 复制选中
+  copySelection(): string {
+    let selection = this.inst.getSelection();
+    if (selection) {
+      // 去除尾部空格
+      const { preference } = useTerminalStore();
+      if (preference.interactSetting.copyAutoTrim) {
+        selection = selection.trimEnd();
+      }
+      // 复制
+      copy.copy(selection, false);
+    }
+    // 聚焦
     this.inst.focus();
     return selection;
   }
diff --git a/orion-ops-ui/src/views/host/terminal/types/terminal.protocol.ts b/orion-ops-ui/src/views/host/terminal/types/terminal.protocol.ts
index 0696a59c..b5167f90 100644
--- a/orion-ops-ui/src/views/host/terminal/types/terminal.protocol.ts
+++ b/orion-ops-ui/src/views/host/terminal/types/terminal.protocol.ts
@@ -8,7 +8,7 @@ export const InputProtocol = {
   // 连接主机
   CONNECT: {
     type: 'co',
-    template: ['type', 'sessionId', 'cols', 'rows']
+    template: ['type', 'sessionId', 'terminalType', 'cols', 'rows']
   },
   // 关闭连接
   CLOSE: {
diff --git a/orion-ops-ui/src/views/host/terminal/types/terminal.type.ts b/orion-ops-ui/src/views/host/terminal/types/terminal.type.ts
index 289f0110..9740374c 100644
--- a/orion-ops-ui/src/views/host/terminal/types/terminal.type.ts
+++ b/orion-ops-ui/src/views/host/terminal/types/terminal.type.ts
@@ -119,7 +119,7 @@ export interface TerminalAddons {
   fit: FitAddon;
   webgl: WebglAddon;
   canvas: CanvasAddon;
-  link: WebLinksAddon;
+  weblink: WebLinksAddon;
   search: SearchAddon;
   image: ImageAddon;
 }
@@ -152,10 +152,12 @@ export interface ITerminalSession {
   clear: () => void;
   // 粘贴
   paste: (value: string) => void;
+  // 粘贴并且去除尾部空格 (如果配置)
+  pasteTrimEnd: (value: string) => void;
   // 选中全部
   selectAll: () => void;
-  // 获取选中
-  getSelection: () => string;
+  // 复制选中
+  copySelection: () => string;
   // 去顶部
   toTop: () => void;
   // 去底部