Merge pull request #2703 from codefori/fix/copyMoveKeepCCSID

Run `cp` and `mv` in QSH to keep CCSID attribute

Author: worksofliam

src/api/IBMiContent.ts

@@ -103,7 +103,7 @@ export default class IBMiContent {
    * @param content Raw content
    * @param encoding Optional encoding to write.
    */
-  async writeStreamfileRaw(originalPath: string, content: string|Uint8Array, encoding?: string) {
+  async writeStreamfileRaw(originalPath: string, content: string | Uint8Array, encoding?: string) {
     const client = this.ibmi.client!;
     const features = this.ibmi.remoteFeatures;
     const tmpobj = await tmpFile();
@@ -228,7 +228,7 @@ export default class IBMiContent {
    * @param content 
    */
   async uploadMemberContent(library: string, sourceFile: string, member: string, content: string | Uint8Array): Promise<boolean>;
-  
+
   /**
    * @deprecated Will be removed in `v3.0.0`; use {@link IBMiContent.uploadMemberContent()} without the `asp` parameter instead.
    * @param asp 
@@ -315,7 +315,7 @@ export default class IBMiContent {
    */
   runSQL(statements: string) {
     console.warn(`[Code for IBM i] runSQL is deprecated and will be removed by 4.0.0. Use IBMi.runSQL instead.`);
-    
+
     return this.ibmi.runSQL(statements);
   }
 
@@ -1149,4 +1149,26 @@ export default class IBMiContent {
   downloadDirectory(localDirectory: EditorPath, remoteDirectory: string, options?: node_ssh.SSHGetPutDirectoryOptions) {
     return this.ibmi.client!.getDirectory(Tools.fileToPath(localDirectory), remoteDirectory, options);
   }
+
+  /**
+   * Copy one or more folders or files into a directory. Uses QSH's `cp` to keep all the attributes of the original file into its copy.
+   * @param paths one or more files/folders to copy
+   * @param toDirectory the directory where the files/folders will be copied into
+   * @returns the {@link CommandResult} of the `cp` command execution
+   */
+  async copy(paths: string | string[], toDirectory: string) {
+    paths = Array.isArray(paths) ? paths : [paths];
+    return this.ibmi.runCommand({ command: `cp -r ${paths.map(path => Tools.escapePath(path)).join(" ")} ${Tools.escapePath(toDirectory)}`, environment: "qsh" });
+  }
+
+  /**
+   * Move one or more folders or files into a directory. Uses QSH's `mv` to ensures attributes are not altered during the opration.
+   * @param paths one or more files/folders to copy
+   * @param toDirectory the directory where the files/folders will be copied into
+   * @returns the {@link CommandResult} of the `mv` command execution
+   */
+  async move(paths: string | string[], toDirectory: string) {
+    paths = Array.isArray(paths) ? paths : [paths];
+    return await this.ibmi.runCommand({ command: `mv ${paths.map(path => Tools.escapePath(path)).join(" ")} ${Tools.escapePath(toDirectory)}`, environment: "qsh" });
+  }
 }

src/api/tests/suites/content.test.ts

@@ -5,10 +5,10 @@ import util from 'util';
 import { afterAll, beforeAll, describe, expect, it } from 'vitest';
 import IBMi from '../../IBMi';
 import { Tools } from '../../Tools';
-import { CONNECTION_TIMEOUT, disposeConnection, newConnection } from '../connection';
 import { ModuleExport, ProgramExportImportInfo } from '../../types';
+import { CONNECTION_TIMEOUT, disposeConnection, newConnection } from '../connection';
 
-describe('Content Tests', {concurrent: true}, () => {
+describe('Content Tests', { concurrent: true }, () => {
   let connection: IBMi
   beforeAll(async () => {
     connection = await newConnection();
@@ -521,7 +521,7 @@ describe('Content Tests', {concurrent: true}, () => {
       expect(error).toBeInstanceOf(Tools.SqlError);
       expect(error.sqlstate).toBe('38501');
     }
-  }, {timeout: 25000});
+  }, { timeout: 25000 });
 
   it('Test @clCommand + select statement', async () => {
     const content = connection.getContent();
@@ -717,4 +717,40 @@ describe('Content Tests', {concurrent: true}, () => {
       }
     });
   });
+
+  it('Copy and move streamfiles', async () => {
+    const content = connection.getContent();
+    await connection.withTempDirectory(async directory => {
+      const checkFile = async (path: string, ccsid: number) => {
+        expect(await content.testStreamFile(path, "w")).toBe(true);
+        const attributes = await content.getAttributes(path, "CCSID");
+        expect(attributes).toBeDefined();
+        expect(attributes!["CCSID"]).toBe(String(ccsid));
+      }
+
+      const unicodeFile = "unicode";
+      const ccsid37File = "ccsid37";
+
+      await content.createStreamFile(`${directory}/${unicodeFile}`);
+      await checkFile(`${directory}/${unicodeFile}`, 1208);
+      await content.createStreamFile(`${directory}/${ccsid37File}`);
+      await connection.sendCommand({ command: `${connection.remoteFeatures.attr} ${directory}/${ccsid37File} CCSID=37` });
+      await checkFile(`${directory}/${ccsid37File}`, 37);
+      const files = [`${directory}/${unicodeFile}`, `${directory}/${ccsid37File}`];
+      
+      expect((await connection.sendCommand({ command: `mkdir ${directory}/copy` })).code).toBe(0);
+      expect((await content.copy(files, `${directory}/copy`)).code).toBe(0);
+      expect(await content.testStreamFile(`${directory}/${unicodeFile}`, "f")).toBe(true);
+      expect(await content.testStreamFile(`${directory}/${ccsid37File}`, "f")).toBe(true);
+      await checkFile(`${directory}/copy/${unicodeFile}`, 1208);
+      await checkFile(`${directory}/copy/${ccsid37File}`, 37);
+
+      expect((await connection.sendCommand({ command: `mkdir ${directory}/move` })).code).toBe(0);
+      expect((await content.move(files, `${directory}/move`)).code).toBe(0);
+      expect(await content.testStreamFile(`${directory}/${unicodeFile}`, "f")).toBe(false);
+      expect(await content.testStreamFile(`${directory}/${ccsid37File}`, "f")).toBe(false);
+      await checkFile(`${directory}/move/${unicodeFile}`, 1208);
+      await checkFile(`${directory}/move/${ccsid37File}`, 37);
+    });
+  });
 });

src/ui/views/ifsBrowser.ts

@@ -253,13 +253,15 @@ class IFSBrowserDragAndDrop implements vscode.TreeDragAndDropController<IFSItem>
 
       if (action) {
         let result;
+        const froms = ifsBrowserItems.map(item => item.path);
+        const to = toDirectory.path;
         switch (action) {
           case "copy":
-            result = await connection.sendCommand({ command: `cp -r ${ifsBrowserItems.map(item => Tools.escapePath(item.path)).join(" ")} ${Tools.escapePath(toDirectory.path)}` });
+            result = await connection.getContent().copy(froms, to);
             break;
 
           case "move":
-            result = await connection.sendCommand({ command: `mv ${ifsBrowserItems.map(item => Tools.escapePath(item.path)).join(" ")} ${Tools.escapePath(toDirectory.path)}` });
+            result = await await connection.getContent().move(froms, to);
             ifsBrowserItems.map(item => item.parent)
               .filter(Tools.distinct)
               .forEach(folder => folder?.refresh?.());
@@ -654,7 +656,7 @@ Please type "{0}" to confirm deletion.`, dirName);
         if (target) {
           const targetPath = path.posix.isAbsolute(target) ? target : path.posix.join(homeDirectory, target);
           try {
-            const moveResult = await connection.sendCommand({ command: `mv ${Tools.escapePath(node.path)} ${Tools.escapePath(targetPath)}` });
+            const moveResult = await connection.runCommand({ command: `mv ${Tools.escapePath(node.path)} ${Tools.escapePath(targetPath)}`, environment: "qsh" });
             if (moveResult.code !== 0) {
               throw moveResult.stderr;
             }
@@ -704,7 +706,10 @@ Please type "{0}" to confirm deletion.`, dirName);
         if (target) {
           const targetPath = target.startsWith(`/`) ? target : homeDirectory + `/` + target;
           try {
-            await connection.sendCommand({ command: `cp -r ${Tools.escapePath(node.path)} ${Tools.escapePath(targetPath)}` });
+            const result = await connection.getContent().copy(node.path, targetPath);
+            if (result.code !== 0) {
+              throw result.stderr;
+            }
             if (IBMi.connectionManager.get(`autoRefresh`)) {
               ifsBrowser.refresh();
             }