Merge pull request #67 from PermanentOrg/64-fix-stats

Generate correct file attributes

Author: slifty

src/classes/PermanentFileSystem.ts

@@ -7,6 +7,8 @@ import {
   getRecord,
 } from '@permanentorg/sdk';
 import {
+  generateAttributesForFile,
+  generateAttributesForFolder,
   generateDefaultAttributes,
   generateFileEntry,
   generateFileEntriesForRecords,
@@ -21,7 +23,10 @@ import type {
   File,
   Record,
 } from '@permanentorg/sdk';
-import type { FileEntry } from 'ssh2';
+import type {
+  Attributes,
+  FileEntry,
+} from 'ssh2';
 
 const isRootPath = (requestedPath: string): boolean => (
   requestedPath === '/'
@@ -99,6 +104,27 @@ export class PermanentFileSystem {
     throw new Error('Item was not found');
   }
 
+  public async getItemAttributes(itemPath: string): Promise<Attributes> {
+    if (isRootPath(itemPath)
+     || isArchiveCataloguePath(itemPath)
+     || isArchivePath(itemPath)) {
+      return generateDefaultAttributes(fs.constants.S_IFDIR);
+    }
+    const fileType = await this.getItemType(itemPath);
+    switch (fileType) {
+      case fs.constants.S_IFREG: {
+        const file = await this.loadFile(itemPath);
+        return generateAttributesForFile(file);
+      }
+      case fs.constants.S_IFDIR: {
+        const folder = await this.loadFolder(itemPath);
+        return generateAttributesForFolder(folder);
+      }
+      default:
+        throw new Error('The specified path is neither a file nor a directory.');
+    }
+  }
+
   public async loadDirectory(requestedPath: string): Promise<FileEntry[]> {
     if (isRootPath(requestedPath)) {
       return PermanentFileSystem.loadRootFileEntries();

src/classes/SftpSessionHandler.ts

@@ -3,11 +3,7 @@ import fetch from 'node-fetch';
 import { v4 as uuidv4 } from 'uuid';
 import ssh2 from 'ssh2';
 import { logger } from '../logger';
-import {
-  generateFileEntry,
-  generateDefaultAttributes,
-  generateAttributesForFile,
-} from '../utils';
+import { generateFileEntry } from '../utils';
 import { PermanentFileSystem } from './PermanentFileSystem';
 import type {
   Attributes,
@@ -156,20 +152,11 @@ export class SftpSessionHandler {
    */
   public fstatHandler = (
     reqId: number,
-    handle: Buffer,
+    itemPath: Buffer,
   ): void => {
     logger.verbose('SFTP read open file statistics request (SSH_FXP_FSTAT)');
-    logger.debug('Request:', { reqId, handle });
-    const file = this.openFiles.get(handle.toString());
-    if (!file) {
-      logger.info('There is no open file associated with this handle', { reqId, handle });
-      logger.debug('Response: Status (FAILURE)', { reqId }, SFTP_STATUS_CODE.FAILURE);
-      this.sftpConnection.status(reqId, SFTP_STATUS_CODE.FAILURE);
-      return;
-    }
-    const attrs = generateAttributesForFile(file);
-    logger.debug('Response: Attributes', { reqId, attrs });
-    this.sftpConnection.attrs(reqId, attrs);
+    logger.debug('Request:', { reqId, itemPath });
+    this.genericStatHandler(reqId, itemPath);
   };
 
   /**
@@ -253,22 +240,13 @@ export class SftpSessionHandler {
    * Also: Retrieving File Attributes
    * https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-02#section-6.8
    */
-  public lstatHandler = (reqId: number, handle: Buffer): void => {
+  public lstatHandler = (
+    reqId: number,
+    itemPath: Buffer,
+  ): void => {
     logger.verbose('SFTP read file statistics without following symbolic links request (SSH_FXP_LSTAT)');
-    logger.debug('Request:', { reqId, handle });
-    this.permanentFileSystem.getItemType(handle.toString())
-      .then((fileType) => {
-        const attrs = generateDefaultAttributes(fileType);
-        logger.debug('Response:', { reqId, attrs });
-        this.sftpConnection.attrs(
-          reqId,
-          attrs,
-        );
-      })
-      .catch(() => {
-        logger.debug('Response: Status (EOF)', { reqId }, SFTP_STATUS_CODE.NO_SUCH_FILE);
-        this.sftpConnection.status(reqId, SFTP_STATUS_CODE.NO_SUCH_FILE);
-      });
+    logger.debug('Request:', { reqId, itemPath });
+    this.genericStatHandler(reqId, itemPath);
   };
 
   /**
@@ -277,22 +255,13 @@ export class SftpSessionHandler {
    * Also: Retrieving File Attributes
    * https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-02#section-6.8
    */
-  public statHandler = (reqId: number, handle: Buffer): void => {
+  public statHandler = (
+    reqId: number,
+    itemPath: Buffer,
+  ): void => {
     logger.verbose('SFTP read file statistics following symbolic links request (SSH_FXP_STAT)');
-    logger.debug('Request:', { reqId, handle });
-    this.permanentFileSystem.getItemType(handle.toString())
-      .then((fileType) => {
-        const attrs = generateDefaultAttributes(fileType);
-        logger.debug('Response:', { reqId, attrs });
-        this.sftpConnection.attrs(
-          reqId,
-          attrs,
-        );
-      })
-      .catch(() => {
-        logger.debug('Response: Status (EOF)', { reqId }, SFTP_STATUS_CODE.NO_SUCH_FILE);
-        this.sftpConnection.status(reqId, SFTP_STATUS_CODE.NO_SUCH_FILE);
-      });
+    logger.debug('Request:', { reqId, itemPath });
+    this.genericStatHandler(reqId, itemPath);
   };
 
   /**
@@ -327,11 +296,11 @@ export class SftpSessionHandler {
     logger.verbose('SFTP canonicalize path request (SSH_FXP_REALPATH)');
     logger.debug('Request:', { reqId, relativePath });
     const resolvedPath = path.resolve('/', relativePath);
-    this.permanentFileSystem.getItemType(resolvedPath)
-      .then((fileType) => {
+    this.permanentFileSystem.getItemAttributes(resolvedPath)
+      .then((attrs) => {
         const fileEntry = generateFileEntry(
           resolvedPath,
-          generateDefaultAttributes(fileType),
+          attrs,
         );
         const names = [fileEntry];
         logger.debug('Response:', { reqId, names });
@@ -397,4 +366,19 @@ export class SftpSessionHandler {
   public symLinkHandler = (): void => {
     logger.verbose('SFTP create symlink request (SSH_FXP_SYMLINK)');
   };
+
+  private readonly genericStatHandler = (reqId: number, itemPath: Buffer): void => {
+    this.permanentFileSystem.getItemAttributes(itemPath.toString())
+      .then((attrs) => {
+        logger.debug('Response:', { reqId, attrs });
+        this.sftpConnection.attrs(
+          reqId,
+          attrs,
+        );
+      })
+      .catch(() => {
+        logger.debug('Response: Status (NO_SUCH_FILE)', { reqId }, SFTP_STATUS_CODE.NO_SUCH_FILE);
+        this.sftpConnection.status(reqId, SFTP_STATUS_CODE.NO_SUCH_FILE);
+      });
+  };
 }

src/utils/generateAttributesForFolder.ts

@@ -0,0 +1,13 @@
+import fs from 'fs';
+import { generateDefaultMode } from './generateDefaultMode';
+import type { Attributes } from 'ssh2';
+import type { Folder } from '@permanentorg/sdk';
+
+export const generateAttributesForFolder = (folder: Folder): Attributes => ({
+  mode: generateDefaultMode(fs.constants.S_IFDIR),
+  uid: 0,
+  gid: 0,
+  size: folder.size,
+  atime: 0,
+  mtime: folder.updatedAt.getTime(),
+});

src/utils/index.ts

@@ -1,4 +1,5 @@
 export * from './generateAttributesForFile';
+export * from './generateAttributesForFolder';
 export * from './generateDefaultAttributes';
 export * from './generateFileEntriesForFolders';
 export * from './generateFileEntriesForRecords';