import { useCallback, useMemo, useRef } from "react"; import { Host, Identity, SftpFilenameEncoding, SftpFileEntry, SSHKey, } from "../../domain/models"; import { createEmptyPane, SftpStateOptions, } from "./sftp/types"; import { formatDate, formatFileSize, getFileExtension, getFileName, getParentPath, joinPath, } from "./sftp/utils"; import { useSftpTabsState } from "./sftp/useSftpTabsState"; import { isSessionError } from "./sftp/errors"; import { useSftpExternalOperations } from "./sftp/useSftpExternalOperations"; import { useSftpTransfers } from "./sftp/useSftpTransfers"; import { useSftpPaneActions } from "./sftp/useSftpPaneActions"; import { useSftpConnections } from "./sftp/useSftpConnections"; import { useSftpFileWatch } from "./sftp/useSftpFileWatch"; import { useSftpSessionCleanup } from "./sftp/useSftpSessionCleanup"; import { useSftpSessionErrors } from "./sftp/useSftpSessionErrors"; // types + utils now live in ./sftp/* export const useSftpState = ( hosts: Host[], keys: SSHKey[], identities: Identity[], options?: SftpStateOptions ) => { const createPane = useCallback( (id?: string, showHiddenFiles = options?.defaultShowHiddenFiles ?? false) => createEmptyPane(id, showHiddenFiles), [options?.defaultShowHiddenFiles], ); const tabsState = useSftpTabsState({ defaultShowHiddenFiles: options?.defaultShowHiddenFiles, }); const { leftTabs, rightTabs, leftTabsRef, rightTabsRef, setLeftTabs, setRightTabs, leftPane, rightPane, getActivePane, updateTab, updateActiveTab, clearSelectionsExcept, setTabShowHiddenFiles, addTab, closeTab, selectTab, reorderTabs, moveTabToOtherSide, getTabsInfo, getActiveTabId, } = tabsState; // SFTP session refs const sftpSessionsRef = useRef>(new Map()); // connectionId -> sftpId // Getter for sftpId from connectionId (for stream transfers) const getSftpIdForConnection = useCallback((connectionId: string) => { return sftpSessionsRef.current.get(connectionId); }, []); // Directory listing cache (connectionId + path) const DIR_CACHE_TTL_MS = 10_000; const dirCacheRef = useRef< Map >(new Map()); // Navigation sequence per pane, used to ignore stale async results const navSeqRef = useRef<{ left: number; right: number }>({ left: 0, right: 0, }); const makeCacheKey = useCallback( (connectionId: string, path: string, encoding?: SftpFilenameEncoding) => `${connectionId}::${encoding || "auto"}::${path}`, [], ); const clearCacheForConnection = useCallback((connectionId: string) => { for (const key of dirCacheRef.current.keys()) { if (key.startsWith(`${connectionId}::`)) { dirCacheRef.current.delete(key); } } }, []); const clearDirCacheEntry = useCallback((connectionId: string, path: string) => { // Remove all encoding variants of this path from the cache for (const key of dirCacheRef.current.keys()) { if (key.startsWith(`${connectionId}::`) && key.endsWith(`::${path}`)) { dirCacheRef.current.delete(key); } } }, []); const getPaneByConnectionId = useCallback((connectionId: string) => { for (const tab of leftTabsRef.current.tabs) { if (tab.connection?.id === connectionId) return tab; } for (const tab of rightTabsRef.current.tabs) { if (tab.connection?.id === connectionId) return tab; } return null; }, [leftTabsRef, rightTabsRef]); const getTabByConnectionId = useCallback((connectionId: string) => { for (const tab of leftTabsRef.current.tabs) { if (tab.connection?.id === connectionId) { return { side: "left" as const, tabId: tab.id, pane: tab }; } } for (const tab of rightTabsRef.current.tabs) { if (tab.connection?.id === connectionId) { return { side: "right" as const, tabId: tab.id, pane: tab }; } } return null; }, [leftTabsRef, rightTabsRef]); // Ref to track pending reconnections to avoid multiple reconnect attempts const reconnectingRef = useRef<{ left: boolean; right: boolean }>({ left: false, right: false, }); // Map connectionId → cache key, set at connect time so each tab's // navigateTo can use the correct cache key even when multiple tabs // share the same hostId with different session-time overrides. const connectionCacheKeyMapRef = useRef>(new Map()); // Store last connected host info for reconnection const lastConnectedHostRef = useRef<{ left: Host | "local" | null; right: Host | "local" | null; }>({ left: null, right: null, }); const handleSessionError = useSftpSessionErrors({ getActivePane, leftTabsRef, rightTabsRef, updateActiveTab, sftpSessionsRef, clearCacheForConnection, navSeqRef, lastConnectedHostRef, reconnectingRef, }); useSftpSessionCleanup(sftpSessionsRef); useSftpFileWatch(options); const { connect, disconnect, listLocalFiles, listRemoteFiles } = useSftpConnections({ hosts, keys, identities, terminalSettings: options?.terminalSettings, leftTabsRef, rightTabsRef, leftTabs, rightTabs, leftPane, rightPane, setLeftTabs, setRightTabs, getActivePane, updateTab, navSeqRef, dirCacheRef, sftpSessionsRef, lastConnectedHostRef, connectionCacheKeyMapRef, reconnectingRef, makeCacheKey, clearCacheForConnection, createEmptyPane: createPane, autoConnectLocalOnMount: options?.autoConnectLocalOnMount, }); const { navigateTo, refresh, navigateUp, openEntry, setFilter, toggleSelection, rangeSelect, clearSelection, selectAll, getFilteredFiles, createDirectory, createDirectoryAtPath, createFile, createFileAtPath, deleteFiles, deleteFilesAtPath, renameFile, renameFileAtPath, moveEntriesToPath, changePermissions, } = useSftpPaneActions({ hosts, getActivePane, updateTab, updateActiveTab, leftTabsRef, rightTabsRef, navSeqRef, dirCacheRef, sftpSessionsRef, lastConnectedHostRef, connectionCacheKeyMapRef, reconnectingRef, makeCacheKey, clearCacheForConnection, listLocalFiles, listRemoteFiles, handleSessionError, isSessionError, clearSelectionsExcept, dirCacheTtlMs: DIR_CACHE_TTL_MS, }); const setFilenameEncoding = useCallback( (side: "left" | "right", encoding: SftpFilenameEncoding) => { updateActiveTab(side, (prev) => ({ ...prev, filenameEncoding: encoding, })); const pane = getActivePane(side); if (pane?.connection && !pane.connection.isLocal) { clearCacheForConnection(pane.connection.id); // Defer refresh so state update lands before we read filenameEncoding in navigateTo. setTimeout(() => { const refreshedPane = getActivePane(side); if (refreshedPane?.connection) { navigateTo(side, refreshedPane.connection.currentPath, { force: true }); } }, 0); } }, [clearCacheForConnection, getActivePane, navigateTo, updateActiveTab], ); const setShowHiddenFiles = useCallback( (side: "left" | "right", tabId: string, showHiddenFiles: boolean) => { setTabShowHiddenFiles(side, tabId, showHiddenFiles); }, [setTabShowHiddenFiles], ); const { transfers, conflicts: transferConflicts, activeTransfersCount, startTransfer, downloadToLocal, addExternalUpload, updateExternalUpload, cancelTransfer, isTransferCancelled, retryTransfer, clearCompletedTransfers, dismissTransfer, resolveConflict: resolveTransferConflict, } = useSftpTransfers({ getActivePane, getPaneByConnectionId, getTabByConnectionId, updateTab, refresh, clearCacheForConnection, sftpSessionsRef, connectionCacheKeyMapRef, listLocalFiles, listRemoteFiles, handleSessionError, }); const { readTextFile, readBinaryFile, writeTextFile, writeTextFileByConnection, downloadToTempAndOpen, openWithSystemDefault, uploadExternalFiles, uploadExternalFileList, uploadExternalFolderPath, uploadExternalEntries, cancelExternalUpload, selectApplication, activeFileWatchCountRef, uploadConflicts, resolveUploadConflict, } = useSftpExternalOperations({ getActivePane, getPaneByConnectionId, refresh, sftpSessionsRef, connectionCacheKeyMapRef, clearDirCacheEntry, useCompressedUpload: options?.useCompressedUpload, addExternalUpload, updateExternalUpload, isTransferCancelled, dismissExternalUpload: dismissTransfer, }); const conflicts = useMemo( () => [...transferConflicts, ...uploadConflicts], [transferConflicts, uploadConflicts], ); const resolveAnyConflict = useCallback( (...args: Parameters) => { const [conflictId] = args; if (uploadConflicts.some((conflict) => conflict.transferId === conflictId)) { return resolveUploadConflict(...args); } return resolveTransferConflict(...args); }, [resolveTransferConflict, resolveUploadConflict, uploadConflicts], ); // Store methods in a ref to create stable wrapper functions // This prevents callback reference changes from causing re-renders in consumers const methodsRef = useRef({ getFilteredFiles, addTab, closeTab, selectTab, reorderTabs, moveTabToOtherSide, getTabsInfo, getActiveTabId, getActivePane, connect, disconnect, navigateTo, navigateUp, refresh, openEntry, toggleSelection, rangeSelect, clearSelection, clearSelectionsExcept, selectAll, setFilter, setFilenameEncoding, setShowHiddenFiles, createDirectory, createDirectoryAtPath, createFile, createFileAtPath, deleteFiles, deleteFilesAtPath, renameFile, renameFileAtPath, moveEntriesToPath, changePermissions, readTextFile, readBinaryFile, writeTextFile, writeTextFileByConnection, downloadToTempAndOpen, openWithSystemDefault, uploadExternalFiles, uploadExternalFileList, uploadExternalFolderPath, uploadExternalEntries, cancelExternalUpload, selectApplication, startTransfer, downloadToLocal, addExternalUpload, updateExternalUpload, cancelTransfer, retryTransfer, clearCompletedTransfers, dismissTransfer, resolveConflict: resolveAnyConflict, getSftpIdForConnection, reportSessionError: handleSessionError, }); methodsRef.current = { getFilteredFiles, addTab, closeTab, selectTab, reorderTabs, moveTabToOtherSide, getTabsInfo, getActiveTabId, getActivePane, connect, disconnect, navigateTo, navigateUp, refresh, openEntry, toggleSelection, rangeSelect, clearSelection, clearSelectionsExcept, selectAll, setFilter, setFilenameEncoding, setShowHiddenFiles, createDirectory, createDirectoryAtPath, createFile, createFileAtPath, deleteFiles, deleteFilesAtPath, renameFile, renameFileAtPath, moveEntriesToPath, changePermissions, readTextFile, readBinaryFile, writeTextFile, writeTextFileByConnection, downloadToTempAndOpen, openWithSystemDefault, uploadExternalFiles, uploadExternalFileList, uploadExternalFolderPath, uploadExternalEntries, cancelExternalUpload, selectApplication, startTransfer, downloadToLocal, addExternalUpload, updateExternalUpload, cancelTransfer, retryTransfer, clearCompletedTransfers, dismissTransfer, resolveConflict: resolveAnyConflict, getSftpIdForConnection, reportSessionError: handleSessionError, }; // Create stable method wrappers that call through methodsRef // These are created once and never change reference const stableMethods = useMemo(() => ({ getFilteredFiles: (...args: Parameters) => methodsRef.current.getFilteredFiles(...args), addTab: (...args: Parameters) => methodsRef.current.addTab(...args), closeTab: (...args: Parameters) => methodsRef.current.closeTab(...args), selectTab: (...args: Parameters) => methodsRef.current.selectTab(...args), reorderTabs: (...args: Parameters) => methodsRef.current.reorderTabs(...args), moveTabToOtherSide: (...args: Parameters) => methodsRef.current.moveTabToOtherSide(...args), getTabsInfo: (...args: Parameters) => methodsRef.current.getTabsInfo(...args), getActiveTabId: (...args: Parameters) => methodsRef.current.getActiveTabId(...args), getActivePane: (...args: Parameters) => methodsRef.current.getActivePane(...args), connect: (...args: Parameters) => methodsRef.current.connect(...args), disconnect: (...args: Parameters) => methodsRef.current.disconnect(...args), navigateTo: (...args: Parameters) => methodsRef.current.navigateTo(...args), navigateUp: (...args: Parameters) => methodsRef.current.navigateUp(...args), refresh: (...args: Parameters) => methodsRef.current.refresh(...args), openEntry: (...args: Parameters) => methodsRef.current.openEntry(...args), toggleSelection: (...args: Parameters) => methodsRef.current.toggleSelection(...args), rangeSelect: (...args: Parameters) => methodsRef.current.rangeSelect(...args), clearSelection: (...args: Parameters) => methodsRef.current.clearSelection(...args), clearSelectionsExcept: (...args: Parameters) => methodsRef.current.clearSelectionsExcept(...args), selectAll: (...args: Parameters) => methodsRef.current.selectAll(...args), setFilter: (...args: Parameters) => methodsRef.current.setFilter(...args), setFilenameEncoding: (...args: Parameters) => methodsRef.current.setFilenameEncoding(...args), setShowHiddenFiles: (...args: Parameters) => methodsRef.current.setShowHiddenFiles(...args), createDirectory: (...args: Parameters) => methodsRef.current.createDirectory(...args), createDirectoryAtPath: (...args: Parameters) => methodsRef.current.createDirectoryAtPath(...args), createFile: (...args: Parameters) => methodsRef.current.createFile(...args), createFileAtPath: (...args: Parameters) => methodsRef.current.createFileAtPath(...args), deleteFiles: (...args: Parameters) => methodsRef.current.deleteFiles(...args), deleteFilesAtPath: (...args: Parameters) => methodsRef.current.deleteFilesAtPath(...args), renameFile: (...args: Parameters) => methodsRef.current.renameFile(...args), renameFileAtPath: (...args: Parameters) => methodsRef.current.renameFileAtPath(...args), moveEntriesToPath: (...args: Parameters) => methodsRef.current.moveEntriesToPath(...args), changePermissions: (...args: Parameters) => methodsRef.current.changePermissions(...args), readTextFile: (...args: Parameters) => methodsRef.current.readTextFile(...args), readBinaryFile: (...args: Parameters) => methodsRef.current.readBinaryFile(...args), writeTextFile: (...args: Parameters) => methodsRef.current.writeTextFile(...args), writeTextFileByConnection: (...args: Parameters) => methodsRef.current.writeTextFileByConnection(...args), downloadToTempAndOpen: (...args: Parameters) => methodsRef.current.downloadToTempAndOpen(...args), openWithSystemDefault: (...args: Parameters) => methodsRef.current.openWithSystemDefault(...args), uploadExternalFiles: (...args: Parameters) => methodsRef.current.uploadExternalFiles(...args), uploadExternalFileList: (...args: Parameters) => methodsRef.current.uploadExternalFileList(...args), uploadExternalFolderPath: (...args: Parameters) => methodsRef.current.uploadExternalFolderPath(...args), uploadExternalEntries: (...args: Parameters) => methodsRef.current.uploadExternalEntries(...args), cancelExternalUpload: () => methodsRef.current.cancelExternalUpload(), selectApplication: () => methodsRef.current.selectApplication(), startTransfer: (...args: Parameters) => methodsRef.current.startTransfer(...args), downloadToLocal: (...args: Parameters) => methodsRef.current.downloadToLocal(...args), addExternalUpload: (...args: Parameters) => methodsRef.current.addExternalUpload(...args), updateExternalUpload: (...args: Parameters) => methodsRef.current.updateExternalUpload(...args), cancelTransfer: (...args: Parameters) => methodsRef.current.cancelTransfer(...args), retryTransfer: (...args: Parameters) => methodsRef.current.retryTransfer(...args), clearCompletedTransfers: () => methodsRef.current.clearCompletedTransfers(), dismissTransfer: (...args: Parameters) => methodsRef.current.dismissTransfer(...args), resolveConflict: (...args: Parameters) => methodsRef.current.resolveConflict(...args), getSftpIdForConnection: (...args: Parameters) => methodsRef.current.getSftpIdForConnection(...args), reportSessionError: (...args: Parameters) => methodsRef.current.reportSessionError(...args), activeFileWatchCountRef, }), [activeFileWatchCountRef]); // activeFileWatchCountRef is a stable ref // Return object with stable method references but reactive state // State changes will cause re-renders, but method references stay stable return useMemo(() => ({ // Reactive state - changes trigger re-renders leftPane, rightPane, leftTabs, rightTabs, transfers, activeTransfersCount, conflicts, // Stable methods - never change reference ...stableMethods, // Pure helper functions (these are defined at module level, always stable) formatFileSize, formatDate, getFileExtension, joinPath, getParentPath, getFileName, }), [ // Only state in deps - methods come from stableMethods which is stable leftPane, rightPane, leftTabs, rightTabs, transfers, activeTransfersCount, conflicts, stableMethods, ]); }; export type SftpStateApi = ReturnType;