@electerm/electerm-react 5.3.26 → 5.5.9

package/client/components/terminal/shell-detect.js

@@ -0,0 +1,37 @@
+/**
+ * Remote shell detection.
+ *
+ * Kept out of shell.js on purpose: it needs the network (runCmd), which drags
+ * the whole app runtime into the import graph. shell.js stays pure so the
+ * startup queue can be imported (and unit tested) on its own.
+ */
+import { runCmd } from './terminal-apis.js'
+import { detectShellType } from './shell.js'
+
+export async function detectRemoteShell (pid) {
+  // SSH exec runs under the account shell, so prefer the configured shell path
+  // instead of probing for any shell binary installed on the host.
+  const cmd = 'printf "%s\n" "$SHELL"'
+
+  // { silent: true } so this best-effort probe does not emit a transport-level
+  // fetch warning; a single, clearer warning is logged below if it fails.
+  const r = await runCmd(pid, cmd, { silent: true })
+    .catch((err) => {
+      // Non-fatal: the interactive shell already opened, so the terminal keeps
+      // working. We just can't inject OSC 633 shell integration for command
+      // tracking. This commonly happens when the server limits concurrent
+      // sessions (sshd MaxSessions) or the account uses a forced/restricted
+      // command, which rejects the auxiliary exec channel with
+      // "(SSH) Channel open failure: open failed".
+      console.warn('detectRemoteShell: exec channel rejected by server, shell integration disabled, falling back to sh —', err?.message || err)
+      return 'sh'
+    })
+
+  const shell = r.trim().toLowerCase()
+
+  if (!shell) {
+    return 'sh'
+  }
+
+  return detectShellType(shell)
+}

package/client/components/terminal/shell.js

@@ -15,7 +15,6 @@
  */
 
 /* eslint-disable no-template-curly-in-string, no-useless-escape */
-import { runCmd } from './terminal-apis.js'
 
 /**
  * Get inline shell integration command for bash (one-liner format)
@@ -153,30 +152,3 @@ export function getShellIntegrationCommand (shellType = 'bash') {
   const cmd = getInlineShellIntegration(shellType)
   return wrapSilent(cmd, shellType)
 }
-export async function detectRemoteShell (pid) {
-  // SSH exec runs under the account shell, so prefer the configured shell path
-  // instead of probing for any shell binary installed on the host.
-  const cmd = 'printf "%s\n" "$SHELL"'
-
-  // { silent: true } so this best-effort probe does not emit a transport-level
-  // fetch warning; a single, clearer warning is logged below if it fails.
-  const r = await runCmd(pid, cmd, { silent: true })
-    .catch((err) => {
-      // Non-fatal: the interactive shell already opened, so the terminal keeps
-      // working. We just can't inject OSC 633 shell integration for command
-      // tracking. This commonly happens when the server limits concurrent
-      // sessions (sshd MaxSessions) or the account uses a forced/restricted
-      // command, which rejects the auxiliary exec channel with
-      // "(SSH) Channel open failure: open failed".
-      console.warn('detectRemoteShell: exec channel rejected by server, shell integration disabled, falling back to sh —', err?.message || err)
-      return 'sh'
-    })
-
-  const shell = r.trim().toLowerCase()
-
-  if (!shell) {
-    return 'sh'
-  }
-
-  return detectShellType(shell)
-}

package/client/components/terminal/shortcut-bar-defs.js

@@ -100,9 +100,17 @@ const modifierOptions = [
   { id: 'meta', label: 'Meta' }
 ]
 
+const MODIFIER_IDS = new Set(modifierOptions.map(m => m.id))
+
+// the builder's second slot accepts either a modifier (Ctrl/Alt/Shift/Meta)
+// or a bare key, so we need to tell them apart.
+function isModifier (id) {
+  return MODIFIER_IDS.has(id)
+}
+
 // compose the bytes to send for a (mods, key) combo.
 // Ctrl+letter -> the control byte; Alt -> ESC prefix; Shift+letter -> uppercase
-function buildComboData (mods, key) {
+function applyMods (mods, key) {
   const ctrl = mods.includes('ctrl')
   const alt = mods.includes('alt')
   const shift = mods.includes('shift')
@@ -118,10 +126,27 @@ function buildComboData (mods, key) {
   return data
 }
 
-// human-readable label, e.g. mods ['ctrl','shift'] + key A -> "Ctrl+Shift+A"
-function buildComboLabel (mods, key) {
+// `prefix` is an optional first key typed BEFORE `key` — that's how you build
+// two-step combos such as tmux's Ctrl+A then D: the modifiers apply to the
+// prefix only, the trailing key is sent plain.
+//   mods [ctrl], prefix A, key D -> Ctrl+A then D
+//   mods [ctrl, shift], key D    -> Ctrl+Shift+D
+function buildComboData (mods, key, prefix) {
+  if (prefix) {
+    return applyMods(mods, prefix) + key.data
+  }
+  return applyMods(mods, key)
+}
+
+// human-readable label, e.g.
+//   mods ['ctrl','shift'] + key A        -> "Ctrl+Shift+A"
+//   mods ['ctrl'] + prefix A + key D     -> "Ctrl+A D"
+function buildComboLabel (mods, key, prefix) {
   const byId = new Map(modifierOptions.map(m => [m.id, m.label]))
-  return [...mods.map(m => byId.get(m) || m), key.label].join('+')
+  const head = mods.map(m => byId.get(m) || m)
+  return prefix
+    ? [...head, prefix.label].join('+') + ' ' + key.label
+    : [...head, key.label].join('+')
 }
 
 // full library, de-duplicated by id
@@ -196,6 +221,7 @@ export {
   candidates,
   keyOptions,
   modifierOptions,
+  isModifier,
   buildComboData,
   buildComboLabel
 }

package/client/components/terminal/shortcut-bar-edit.jsx

@@ -26,6 +26,7 @@ import {
   defaultActive,
   keyOptions,
   modifierOptions,
+  isModifier,
   buildComboData,
   buildComboLabel
 } from './shortcut-bar-defs'
@@ -43,6 +44,9 @@ export default function ShortcutBarEdit (props) {
 
   const [keyword, setKeyword] = useState('')
   const [customMod1, setCustomMod1] = useState(undefined)
+  // second slot takes a modifier OR a bare key: a modifier stacks onto the
+  // first one (Ctrl+Shift+D), a key becomes a prefix typed before the third
+  // slot's key (Ctrl+A then D).
   const [customMod2, setCustomMod2] = useState(undefined)
   const [customKey, setCustomKey] = useState(undefined)
 
@@ -70,13 +74,21 @@ export default function ShortcutBarEdit (props) {
     if (!customKey) {
       return
     }
-    const mods = [customMod1, customMod2].filter(Boolean)
     const key = keyOptions.find(k => k.id === customKey)
     if (!key) {
       return
     }
-    const label = buildComboLabel(mods, key)
-    const data = buildComboData(mods, key)
+    const mods = [customMod1].filter(Boolean)
+    let prefix
+    if (customMod2) {
+      if (isModifier(customMod2)) {
+        mods.push(customMod2)
+      } else {
+        prefix = keyOptions.find(k => k.id === customMod2)
+      }
+    }
+    const label = buildComboLabel(mods, key, prefix)
+    const data = buildComboData(mods, key, prefix)
     const id = 'custom-' + label + '-' + Date.now()
     onSave([...active, { id, label, data, custom: true }])
     setCustomMod1(undefined)
@@ -88,6 +100,26 @@ export default function ShortcutBarEdit (props) {
     onSave(defaultActive())
   }
 
+  // second slot option list: modifiers first, then the same bare-key list the
+  // third slot offers (so Ctrl+A then D is expressible).
+  const secondOptions = [
+    {
+      label: e('modifier'),
+      options: modifierOptions.map(m => ({
+        value: m.id,
+        label: m.label,
+        disabled: m.id === customMod1
+      }))
+    },
+    {
+      label: e('key'),
+      options: keyOptions.map(k => ({
+        value: k.id,
+        label: k.label
+      }))
+    }
+  ]
+
   const kw = keyword.trim().toLowerCase()
   const filtered = allCandidates.filter(b => {
     if (!kw) {
@@ -195,15 +227,13 @@ export default function ShortcutBarEdit (props) {
           <Select
             value={customMod2}
             onChange={setCustomMod2}
-            placeholder={e('modifier') + ' (' + e('optional') + ')'}
+            placeholder={e('modifier') + '/' + e('key') + ' (' + e('optional') + ')'}
             className='shortcut-custom-select'
             allowClear
+            showSearch
+            optionFilterProp='label'
             getPopupContainer={popupContainer}
-            options={modifierOptions.map(m => ({
-              value: m.id,
-              label: m.label,
-              disabled: m.id === customMod1
-            }))}
+            options={secondOptions}
           />
           <Select
             value={customKey}
@@ -212,6 +242,7 @@ export default function ShortcutBarEdit (props) {
             className='shortcut-custom-select shortcut-custom-key'
             allowClear
             showSearch
+            optionFilterProp='label'
             getPopupContainer={popupContainer}
             options={keyOptions.map(k => ({
               value: k.id,

package/client/components/terminal/shortcut-bar-entry.jsx

@@ -38,6 +38,7 @@
 
 import { lazy, Suspense, useEffect, useState } from 'react'
 import { auto } from 'manate/react'
+import LazyBoundary from '../common/lazy-boundary'
 
 const ShortcutBar = lazy(() => import('./shortcut-bar'))
 
@@ -166,9 +167,11 @@ function ShortcutBarEntry (props) {
     return null
   }
   return (
-    <Suspense fallback={null}>
-      <ShortcutBar {...props} />
-    </Suspense>
+    <LazyBoundary>
+      <Suspense fallback={null}>
+        <ShortcutBar {...props} />
+      </Suspense>
+    </LazyBoundary>
   )
 }
 

package/client/components/terminal/shortcut-bar.jsx

@@ -56,11 +56,20 @@ function sendToTerminal (data) {
   }
 }
 
-// honor the active terminal's DECCKM state for the cursor / Home / End keys
+// honor the active terminal's DECCKM state for the cursor / Home / End keys.
+// custom combos can be multi-key sequences (Ctrl+A then ↑), so match the
+// trailing key too — not only the whole payload.
 function resolveCursorMode (data, term) {
-  const app = appCursorMap[data]
-  if (app && term?.term?.modes?.applicationCursorKeysMode) {
-    return app
+  if (!term?.term?.modes?.applicationCursorKeysMode) {
+    return data
+  }
+  for (const normal in appCursorMap) {
+    if (data === normal) {
+      return appCursorMap[normal]
+    }
+    if (data.length > normal.length && data.endsWith(normal)) {
+      return data.slice(0, data.length - normal.length) + appCursorMap[normal]
+    }
   }
   return data
 }
@@ -135,12 +144,10 @@ function ShortcutBar (props) {
   // keep the offset in a CSS var consumed by shortcut-bar.styl, and expose the
   // lifted height so layout.jsx can shrink the terminal accordingly.
   useEffect(() => {
-    document.documentElement.style.setProperty(
-      '--shortcut-bar-kb-offset',
-      kbOffset ? kbOffset + 'px' : '0px'
-    )
-    store.shortcutBarKbOffset = kbOffset
-  }, [kbOffset])
+    const offset = store.shortcutBarVisible ? kbOffset : 0
+    document.documentElement.style.setProperty('--shortcut-bar-kb-offset', offset + 'px')
+    store.shortcutBarKbOffset = offset
+  }, [kbOffset, store.shortcutBarVisible])
 
   // reserve layout space + lift the footer while the bar is shown.
   // expose the bar height as a CSS var so the .styl + footer-lift rule stay

package/client/components/terminal/shortcut-bar.styl

@@ -79,6 +79,10 @@
 .shortcut-bar-on
   .main-footer
     bottom calc(var(--shortcut-bar-h, 44px) + var(--shortcut-bar-kb-offset, 0px))
+  .remote-monitor-bar
+    bottom calc(var(--shortcut-bar-h, 44px) + var(--shortcut-bar-kb-offset, 0px) + 36px)
+  .qm-wrap-tooltip
+    bottom calc(var(--footer-stack-height, 36px) + var(--shortcut-bar-h, 44px) + var(--shortcut-bar-kb-offset, 0px))
 
 // --- edit modal -----------------------------------------------------------
 

package/client/components/terminal/ssh-reload-state.js

@@ -0,0 +1,96 @@
+const maxCwdLength = 4096
+
+// Shell-backed terminal types whose cwd + screen can be restored on reload.
+// Graphical / file-transfer tabs (rdp, vnc, web, ftp, spice, sftp, ...) are
+// intentionally excluded: they have no shell cwd to `cd` back to.
+export const restorableTerminalTypes = new Set([
+  'ssh',
+  'local',
+  'telnet',
+  'serial'
+])
+
+export function isSshTab (tab = {}) {
+  return !!tab.host && (!tab.type || tab.type === 'ssh')
+}
+
+export function isRestorableTerminalTab (tab = {}) {
+  if (!tab.type) {
+    // Legacy tabs without an explicit type are ssh (host set) or local
+    // (no host) - both are shell terminals.
+    return true
+  }
+  return restorableTerminalTypes.has(tab.type)
+}
+
+export function sanitizeSshCwd (cwd) {
+  if (typeof cwd !== 'string' || !cwd || cwd.length > maxCwdLength) {
+    return ''
+  }
+  if (/[\0\r\n]/.test(cwd)) {
+    return ''
+  }
+  return cwd
+}
+
+export const sanitizeTerminalCwd = sanitizeSshCwd
+
+export function quotePosixShellArg (value) {
+  const quote = '\''
+  const escapedQuote = quote + '"' + quote + '"' + quote
+  return quote + value.replace(/'/g, escapedQuote) + quote
+}
+
+export function createRestoreCwdCommand (cwd) {
+  const safeCwd = sanitizeSshCwd(cwd)
+  return safeCwd ? `cd -- ${quotePosixShellArg(safeCwd)}` : ''
+}
+
+export function createWindowsRestoreCwdCommand (cwd) {
+  const safeCwd = sanitizeSshCwd(cwd)
+  if (!safeCwd) {
+    return ''
+  }
+  // Strip control chars already handled by sanitize; escape embedded double
+  // quotes for cmd/powershell (`""` is accepted by both as a literal quote).
+  const escaped = safeCwd.replace(/"/g, '""')
+  return `cd /d "${escaped}"`
+}
+
+export function shouldCaptureTerminalReloadState (tab, config = {}) {
+  return !!config.restoreTerminalSessionOnReload && isRestorableTerminalTab(tab)
+}
+
+// Kept for backward compatibility - now covers all shell terminals
+// (ssh, local, telnet, serial), not just ssh.
+export function shouldCaptureSshReloadState (tab, config = {}) {
+  return shouldCaptureTerminalReloadState(tab, config)
+}
+
+export function createSshReloadState ({ cwd, screen } = {}) {
+  const safeCwd = sanitizeSshCwd(cwd)
+  const safeScreen = typeof screen === 'string' ? screen : ''
+  if (!safeCwd && !safeScreen) {
+    return undefined
+  }
+  return {
+    cwd: safeCwd,
+    screen: safeScreen
+  }
+}
+
+export const createTerminalReloadState = createSshReloadState
+
+export function getAlternateBufferSnapshot (buffer) {
+  if (!buffer || buffer.type !== 'alternate') {
+    return ''
+  }
+  const lines = []
+  for (let i = 0; i < buffer.length; i++) {
+    lines.push(buffer.getLine(i)?.translateToString(true) || '')
+  }
+  while (lines.length && !lines[lines.length - 1]) {
+    lines.pop()
+  }
+  return lines.join('\r\n')
+}