added methods to extract only selected files

Author: TheTechsTech

lib/index.d.ts

@@ -11,7 +11,6 @@ export = SevenZip;
  * @param filepath {string} Path to the archive.
  * @param files {string|array} Files to add.
  * @param options {Object} An object of acceptable 7-zip switch options.
- * @param useBinary {string} binary to use.
  * @param override {boolean} should binary directory change?
  *
  * @resolve {array} Arguments passed to the child-process.
@@ -28,29 +27,21 @@ export function createArchive(filepath: string, files: string | array, options?:
  * @param filepath {string} Path to the archive.
  * @param files {string|array} Files to remove.
  * @param options {Object} An object of acceptable 7-zip switch options.
- * @param useBinary {string} binary to use.
  * @param override {boolean} should binary directory change?
  *
  * @resolve {array} Arguments passed to the child-process.
  * @reject {Error} The error as issued by 7-Zip.
  *
  * @returns {Promise} Promise
  */
-export function deleteArchive(
-  filepath: string,
-  files: string | array,
-  options?: object,
-  useBinary?: string,
-  override?: boolean
-): Promise<any>;
+export function deleteArchive(filepath: string, files: string | array, options?: object, override?: boolean): Promise<any>;
 
 /**
  * Extract an archive.
  *
- * @param {string} archive Path to the archive.
+ * @param {string} filepath Path to the archive.
  * @param {string} dest Destination.
  * @param options {Object} An object of acceptable 7-zip switch options.
- * @param useBinary {string} binary to use.
  * @param override {boolean} should binary directory change?
  *
  * @resolve {array} Arguments passed to the child-process.
@@ -59,13 +50,24 @@ export function deleteArchive(
  *
  * @returns {Promise} Promise
  */
-export function extractArchive(
-  filepath: string,
-  dest: string | array,
-  options?: object,
-  useBinary?: string,
-  override?: boolean
-): Promise<any>;
+export function extractArchive(filepath: string, dest: string, options?: object, override?: boolean): Promise<any>;
+
+/**
+ * Extract only selected files from archive.
+ *
+ * @param {string} filepath Path to the archive.
+ * @param {string} dest Destination.
+ * @param {string|array} files Files in archive to extract.
+ * @param options {Object} An object of acceptable 7-zip switch options.
+ * @param override {boolean} should binary directory change?
+ *
+ * @resolve {array} Arguments passed to the child-process.
+ * @progress {array} Extracted files and directories.
+ * @reject {Error} The error as issued by 7-Zip.
+ *
+ * @returns {Promise} Promise
+ */
+export function onlyArchive(filepath: string, dest: string, files: string | array, options?: object, override?: boolean): Promise<any>;
 
 export function fullArchive(filepath: string, files: string | array, options?: object, useBinary?: string, override?: boolean): Promise<any>;
 export function listArchive(filepath: string, files: string | array, options?: object, useBinary?: string, override?: boolean): Promise<any>;

lib/index.mjs

@@ -5,13 +5,14 @@ import _deleteArchive from './deleteArchive.mjs';
 import _extractArchive from './extractArchive.mjs';
 import _fullArchive from './fullArchive.mjs';
 import _listArchive from './listArchive.mjs';
+import _onlyArchive from './onlyArchive.mjs';
 import _renameArchive from './renameArchive.mjs';
 import _testArchive from './testArchive.mjs';
 import _updateArchive from './updateArchive.mjs';
 import createSfx from './createSfx.mjs';
 
 class SevenZip {
-  constructor() {}
+  constructor() { }
 }
 
 export default SevenZip;
@@ -20,6 +21,23 @@ export const deleteArchive = SevenZip.deleteArchive = _deleteArchive;
 export const extractArchive = SevenZip.extractArchive = _extractArchive;
 export const fullArchive = SevenZip.fullArchive = _fullArchive;
 export const listArchive = SevenZip.listArchive = _listArchive;
+
+/**
+ * Extract only selected files from archive.
+ *
+ * @param {string} filepath Path to the archive.
+ * @param {string} dest Destination.
+ * @param {string|array} files Files in archive to extract.
+ * @param options {Object} An object of acceptable 7-zip switch options.
+ * @param override {boolean} should binary directory change?
+ *
+ * @resolve {array} Arguments passed to the child-process.
+ * @progress {array} Extracted files and directories.
+ * @reject {Error} The error as issued by 7-Zip.
+ *
+ * @returns {Promise} Promise
+ */
+export const onlyArchive = SevenZip.onlyArchive = _onlyArchive;
 export const renameArchive = SevenZip.renameArchive = _renameArchive;
 export const testArchive = SevenZip.testArchive = _testArchive;
 export const updateArchive = SevenZip.updateArchive = _updateArchive;

lib/onlyArchive.mjs

@@ -0,0 +1,72 @@
+'use strict';
+
+import when from 'when';
+import Files from '../util/files.mjs';
+import ReplaceNativeSeparator from '../util/replaceNativeSeparator.mjs';
+import Run from '../util/run.mjs';
+
+/**
+ * Extract only selected files from archive.
+ *
+ * @param {string} filepath Path to the archive.
+ * @param {string} dest Destination.
+ * @param {string|array} files Files in archive to extract.
+ * @param options {Object} An object of acceptable 7-zip switch options.
+ * @param override {boolean} should binary directory change?
+ *
+ * @resolve {array} Arguments passed to the child-process.
+ * @progress {array} Extracted files and directories.
+ * @reject {Error} The error as issued by 7-Zip.
+ *
+ * @returns {Promise} Promise
+ */
+export default function (filepath, dest = '*', files = [], options = {}, override = false) {
+  return when.promise(function (resolve, reject, progress) {
+    /**
+     * When a stdout is emitted, parse each line and search for a pattern.When
+     * the pattern is found, extract the file (or directory) name from it and
+     * pass it to an array. Finally returns this array.
+     */
+    function onprogress(data) {
+      let entries = [];
+      data.split('\n').forEach(function (line) {
+        if (line.substr(0, 1) === '-') {
+          entries.push(ReplaceNativeSeparator(line.substr(2, line.length)));
+        }
+      });
+      return entries;
+    }
+
+    // Convert array of files into a string if needed.
+    files = Files(files);
+
+    // Create a string that can be parsed by `run`.
+    let command = 'e "' + filepath + '" -o"' + dest + '" -r -aos ' + files;
+
+    // Start the command
+    Run('7z', command, options, override)
+      .progress(function (data) {
+        return progress(onprogress(data));
+      })
+
+      // When all is done resolve the Promise.
+      .then(function (args) {
+        return resolve(args);
+      })
+
+      // Catch the error and pass it to the reject function of the Promise.
+      .catch(function () {
+        console.error('OnlyArchive failed using `7z`, retying with `7za`.');
+        Run('7za', command, options, override)
+          .progress(function (data) {
+            return progress(onprogress(data));
+          })
+          .then(function (args) {
+            return resolve(args);
+          })
+          .catch(function (err) {
+            return reject(err);
+          });
+      });
+  });
+};

test/lib/onlyArchive.test.js

@@ -0,0 +1,53 @@
+/*global describe, it */
+'use strict';
+import chai from 'chai';
+import fs from 'fs-extra';
+import {
+  onlyArchive
+} from '../../lib/index.mjs';
+const expect = chai.expect;
+
+describe('Method: `onlyArchive`', function () {
+
+  it('should return an error on 7z error', function (done) {
+    onlyArchive('test/nothere.7z', '.tmp/test')
+      .catch(function (err) {
+        expect(err).to.be.an.instanceof(Error);
+        done();
+      });
+  });
+
+  it('should return an error on output duplicate', function (done) {
+    onlyArchive('test/zip.7z', '.tmp/test', '', {
+      o: '.tmp/test/duplicate'
+    })
+      .catch(function (err) {
+        expect(err).to.be.an.instanceof(Error);
+        done();
+      });
+  });
+
+  it('should return entries on progress', function (done) {
+    onlyArchive('test/zip.7z', '.tmp/test', ['zip/file1.txt', 'zip/file2.txt'])
+      .progress(function (entries) {
+        expect(entries.length).to.be.at.least(1);
+        done();
+      });
+  });
+
+  it('should extract only on the right path', function (done) {
+    onlyArchive('test/zip.7z', '.tmp/test', ['zip/folder/file0.txt', 'zip/file2.txt', 'zip/file3.txt'])
+      .then(function () {
+        //  expect(fs.existsSync('.tmp/test/file3.txt')).to.be.eql(true);
+        expect(fs.existsSync('.tmp/test/file0.txt')).to.be.eql(true);
+        expect(fs.existsSync('.tmp/test/file1.txt')).to.be.eql(false);
+        expect(fs.existsSync('.tmp/test/file2.txt')).to.be.eql(true);
+        done();
+      })
+      .catch((err) => {
+        console.log(err);
+        done();
+      });
+  });
+
+});