Files
opsxshell/electron/services/zmodem-service.ts
T
Logan.Li 514d62644e v2.0.0: 主题系统+SSH私钥解析修复+会话持久化+连接池优化+UI打磨
核心修复:
- ssh-service.ts: 新增 resolvePrivateKey(),将私钥文件路径(~/.ssh/id_rsa)解析为内容后传给 ssh2,
  解决 'Cannot parse privateKey: Unsupported key format' 错误
- useTerminalConnection.ts + sessionHelper.ts: 根据 authType 过滤字段,password/agent 认证不再传 privateKey
- sessionStore.ts: addSession() 现在先调用 sessionCreate() 持久化到 SQLite,解决恢复标签'无可用连接信息'问题
- database-service.ts: updateSession() 补充 private_key_path 字段持久化
- SessionDialog.tsx: 默认 username='root'、privateKey='~/.ssh/id_rsa'

UI/UX:
- 语义化主题系统(app-theme.ts),强制深色模式,全局无边框设计
- macOS 标题栏支持双击最大化(window:toggleMaximize IPC)
- macOS 菜单栏('OpsXShell' 应用菜单 + Settings Cmd+,)
- WelcomeView 4卡片布局,移除 Settings 按钮
- TabBar/TabItem 背景色统一(bg-dark-800/900),消除白色边框线

架构优化:
- SFTP 生命周期修复(useSFTP.ts useRef + autoConnectAttempted guard)
- 连接池竞态修复,支持快速多标签连接
- IPC 接口规范化,安全错误处理
- Vite 代码分割优化

质量: lint零错误 | tsc零错误 | build成功 | 49 tests pass
2026-04-22 11:15:41 +08:00

383 lines
10 KiB
TypeScript

import Zmodem from 'zmodem-ts'
import fs from 'fs'
import path from 'path'
import { app } from 'electron'
import { createLogger } from '../utils/logger'
const logger = createLogger('ZmodemService')
// Type definitions for Zmodem sessions (since zmodem-ts doesn't export them properly)
interface ZmodemSendSession {
type: 'send'
set_sender(func: (octets: number[]) => void): void
send_offer(params: { name: string; size: number; mtime?: number }): Promise<unknown>
on(event: string, handler: (data: unknown) => void): void
abort(): void
close(): Promise<unknown>
}
interface ZmodemReceiveSession {
type: 'receive'
set_sender(func: (octets: number[]) => void): void
start(): Promise<unknown>
on(event: string, handler: (data: unknown) => void): void
abort(): void
}
interface ZmodemSentry {
consume(octets: number[]): void
}
interface ZmodemDetection {
get_session(): { type: string } & ZmodemSendSession
}
interface ZmodemOffer {
getDetails(): { name: string; size: number }
accept(options: { on_input: string }): Promise<ZmodemTransfer>
}
interface ZmodemTransfer {
on(event: 'input', handler: (data: Uint8Array) => void): void
on(event: 'complete', handler: () => void): void
}
export interface ZmodemProgress {
percentage: number
transferred: number
total: number
fileName?: string
}
interface ZmodemSessionInfo {
id: string
shellId: string
type: 'send' | 'receive'
session: ZmodemSendSession | ZmodemReceiveSession
fileName?: string
filePath?: string
totalSize?: number
transferred?: number
sentry?: ZmodemSentry
onComplete?: (success: boolean, error?: string) => void
}
export class ZmodemService {
private sessions: Map<string, ZmodemSessionInfo> = new Map()
private shellDataCallbacks: Map<string, (data: Buffer) => void> = new Map()
constructor() {
app.on('before-quit', () => {
this.closeAll()
})
}
/**
* Send file to server via Zmodem (rz)
*
* Flow: Server types "rz" -> sends ZRQINIT/ZRINIT -> we send file
* We use Sentry to detect when server is ready (ZRINIT received)
*/
sendFile(
shellId: string,
fileName: string,
fileData: Buffer,
writeFunc: (data: Uint8Array) => void,
onProgress?: (progress: ZmodemProgress) => void,
onComplete?: (success: boolean, error?: string) => void
): string {
const sessionId = `zmodem-send-${Date.now()}`
const totalSize = fileData.length
// Create session info
const sessionInfo: ZmodemSessionInfo = {
id: sessionId,
shellId,
type: 'send',
session: null as unknown as ZmodemSendSession,
fileName,
totalSize,
transferred: 0
}
this.sessions.set(sessionId, sessionInfo)
// Store completion callback
if (onComplete) {
sessionInfo.onComplete = onComplete
}
// Create Sentry to detect ZRINIT from server
const sentry = new Zmodem.Sentry({
to_terminal: (octets: number[]) => {
// Echo to terminal
writeFunc(new Uint8Array(octets))
},
on_detect: (detection: ZmodemDetection) => {
const detectedSession = detection.get_session()
if (detectedSession && detectedSession.type === 'send') {
// Server is ready for file transfer (received ZRINIT)
const sendSession = detectedSession as ZmodemSendSession
// Update session reference
sessionInfo.session = sendSession
// Set up sender to write to shell
sendSession.set_sender((octets: number[]) => {
writeFunc(new Uint8Array(octets))
})
// Handle session end
sendSession.on('session_end', () => {
this.sessions.delete(sessionId)
})
sendSession.on('error', (err: unknown) => {
const error = err instanceof Error ? err : new Error(String(err))
logger.error('Zmodem send error:', error)
onComplete?.(false, error.message)
})
// Send the file
this.doSendFile(sessionId, sendSession, fileName, fileData, onProgress, onComplete)
}
},
on_retract: () => {
// Session was retracted
logger.info('Zmodem send session retracted')
this.sessions.delete(sessionId)
onComplete?.(false, 'Session retracted')
},
sender: (octets: number[]) => {
writeFunc(new Uint8Array(octets))
}
})
sessionInfo.sentry = sentry
// Store shell data callback to feed to Sentry
this.shellDataCallbacks.set(shellId, (data: Buffer) => {
sentry.consume(Array.from(data))
})
return sessionId
}
/**
* Internal method to send file after ZRINIT is received
*/
private async doSendFile(
sessionId: string,
session: ZmodemSendSession,
fileName: string,
fileData: Buffer,
onProgress?: (progress: ZmodemProgress) => void,
onComplete?: (success: boolean, error?: string) => void
): Promise<void> {
try {
// Send file offer
const result = await session.send_offer({
name: fileName,
size: fileData.length,
mtime: Date.now()
})
if (result) {
// Transfer completed successfully
onProgress?.({
percentage: 100,
transferred: fileData.length,
total: fileData.length,
fileName
})
onComplete?.(true)
} else {
// Transfer was skipped or rejected
onComplete?.(false, 'Transfer skipped or rejected')
}
} catch (err: unknown) {
logger.error('Zmodem send error:', err)
onComplete?.(false, err instanceof Error ? err.message : String(err))
}
}
/**
* Feed shell data to Zmodem service for protocol detection
* This should be called when shell receives data
*/
feedShellData(shellId: string, data: Buffer): void {
const callback = this.shellDataCallbacks.get(shellId)
if (callback) {
callback(data)
}
// Also check all sessions for matching shellId
for (const [, session] of this.sessions) {
if (session.shellId === shellId && session.sentry) {
// Feed to sentry for detection
}
}
}
/**
* Receive file from server via Zmodem (sz)
*
* Flow: User clicks "sz" in UI -> we open receive session
* Server sends ZRQINIT -> we accept -> server sends file
*/
receiveFile(
shellId: string,
filePath: string,
writeFunc: (data: Uint8Array) => void,
onProgress?: (progress: ZmodemProgress) => void,
onComplete?: (success: boolean, error?: string) => void
): string {
const sessionId = `zmodem-receive-${Date.now()}`
const fileName = path.basename(filePath)
// Create receive session
// @ts-expect-error - zmodem-ts types are incomplete
const session: ZmodemReceiveSession = new Zmodem.ReceiveSession()
const sessionInfo: ZmodemSessionInfo = {
id: sessionId,
shellId,
type: 'receive',
session,
filePath,
fileName,
totalSize: 0,
transferred: 0
}
this.sessions.set(sessionId, sessionInfo)
if (onComplete) {
sessionInfo.onComplete = onComplete
}
// Set up sender to write responses to shell
session.set_sender((octets: number[]) => {
writeFunc(new Uint8Array(octets))
})
// Handle file offer
session.on('offer', (offer: unknown) => {
const zmodemOffer = offer as ZmodemOffer
const details = zmodemOffer.getDetails()
logger.info('Zmodem offer received:', details)
sessionInfo.fileName = details.name || fileName
sessionInfo.totalSize = details.size || 0
// Accept the offer
zmodemOffer.accept({
on_input: 'spool_array'
}).then((transfer) => {
// Handle incoming data
transfer.on('input', (data: Uint8Array) => {
sessionInfo.transferred = (sessionInfo.transferred || 0) + data.length
// Write to file
try {
fs.writeFileSync(filePath, data, { flag: 'a' })
} catch (err: unknown) {
logger.error('Error writing Zmodem file:', err)
}
const total = sessionInfo.totalSize || sessionInfo.transferred || 0
onProgress?.({
percentage: total > 0
? Math.round((sessionInfo.transferred! / total) * 100)
: 0,
transferred: sessionInfo.transferred!,
total: total,
fileName: sessionInfo.fileName
})
})
transfer.on('complete', () => {
logger.info('Zmodem receive complete')
onProgress?.({
percentage: 100,
transferred: sessionInfo.totalSize || sessionInfo.transferred || 0,
total: sessionInfo.totalSize || sessionInfo.transferred || 0,
fileName: sessionInfo.fileName
})
onComplete?.(true)
})
}).catch((err: Error) => {
logger.error('Zmodem accept error:', err)
onComplete?.(false, err.message)
})
})
// Handle session end
session.on('session_end', () => {
this.sessions.delete(sessionId)
})
session.on('error', (err: unknown) => {
const error = err instanceof Error ? err : new Error(String(err))
logger.error('Zmodem receive error:', error)
onComplete?.(false, error.message)
})
// Start receiving - this sends ZRINIT to signal we're ready
session.start().catch((err: Error) => {
logger.error('Zmodem start error:', err)
this.sessions.delete(sessionId)
onComplete?.(false, err.message)
})
return sessionId
}
/**
* Cancel a Zmodem session
*/
cancelSession(sessionId: string): void {
const session = this.sessions.get(sessionId)
if (session) {
try {
const s = session.session as { abort?: () => void; close?: () => void }
s.abort?.()
s.close?.()
} catch (err: unknown) {
logger.error('Error canceling Zmodem session:', err)
}
// Clean up shell data callback
this.shellDataCallbacks.delete(session.shellId)
this.sessions.delete(sessionId)
}
}
/**
* Close all active sessions
*/
closeAll(): void {
for (const sessionId of this.sessions.keys()) {
this.cancelSession(sessionId)
}
}
/**
* Get active session IDs
*/
getActiveSessions(): string[] {
return Array.from(this.sessions.keys())
}
/**
* Get session by ID
*/
getSession(sessionId: string): ZmodemSessionInfo | undefined {
return this.sessions.get(sessionId)
}
}
// Singleton instance
export const zmodemService = new ZmodemService()