Merge pull request #24 from fcollonval/submenu

hadim · web-flow · commit 2cccb724aec2 · 2019-10-13T10:05:40.000-04:00
Use a submenu if archive format is null
diff --git a/jupyter_archive/handlers.py b/jupyter_archive/handlers.py
@@ -12,6 +12,17 @@
 # The delay in ms at which we send the chunk of data
 # to the client.
 ARCHIVE_DOWNLOAD_FLUSH_DELAY = 100
+SUPPORTED_FORMAT = [
+    "zip",
+    "tgz",
+    "tar.gz",
+    "tbz",
+    "tbz2",
+    "tar.bz",
+    "tar.bz2",
+    "txz",
+    "tar.xz"
+]
 
 
 class ArchiveStream():
@@ -84,6 +95,9 @@ def get(self, archive_path, include_body=False):
 
         archive_token = self.get_argument('archiveToken')
         archive_format = self.get_argument('archiveFormat', 'zip')
+        if archive_format not in SUPPORTED_FORMAT:
+            self.log.error("Unsupported format {}.".format(archive_format))
+            raise web.HTTPError(404)
 
         archive_path = os.path.join(cm.root_dir, url2path(archive_path))
 
diff --git a/schema/archive.json b/schema/archive.json
@@ -3,10 +3,10 @@
   "description": "Archive handler options.",
   "properties": {
     "format": {
-      "type": "string",
-      "enum": ["zip", "tgz", "tar.gz","tbz", "tbz2", "tar.bz", "tar.bz2","txz", "tar.xz"],
+      "type": ["string", "null"],
+      "enum": [null, "zip", "tgz", "tar.gz","tbz", "tbz2", "tar.bz", "tar.bz2","txz", "tar.xz"],
       "title": "Archive format",
-      "description": "Archive format for compressing folder; one of ['zip', 'tgz', 'tar.gz', 'tbz', 'tbz2', 'tar.bz', 'tar.bz2', 'txz', 'tar.xz']",
+      "description": "Archive format for compressing folder; one of [null (submenu), 'zip', 'tgz', 'tar.gz', 'tbz', 'tbz2', 'tar.bz', 'tar.bz2', 'txz', 'tar.xz']",
       "default": "zip"
     }
   },
diff --git a/src/index.ts b/src/index.ts
@@ -2,25 +2,38 @@ import {
   JupyterFrontEnd,
   JupyterFrontEndPlugin
 } from "@jupyterlab/application";
-
-import { each } from "@phosphor/algorithm";
+import { showErrorMessage } from "@jupyterlab/apputils";
+import { ISettingRegistry, URLExt } from "@jupyterlab/coreutils";
 import { IFileBrowserFactory } from "@jupyterlab/filebrowser";
 import { ServerConnection } from "@jupyterlab/services";
-import { URLExt, ISettingRegistry } from "@jupyterlab/coreutils";
-import { showErrorMessage } from "@jupyterlab/apputils";
+import { each } from "@phosphor/algorithm";
+import { IDisposable } from "@phosphor/disposable";
+import { Menu } from "@phosphor/widgets";
 
 const DIRECTORIES_URL = "directories";
 const EXTRACT_ARCHVE_URL = "extract-archive";
+type ArchiveFormat =
+  | null
+  | "zip"
+  | "tgz"
+  | "tar.gz"
+  | "tbz"
+  | "tbz2"
+  | "tar.bz"
+  | "tar.bz2"
+  | "txz"
+  | "tar.xz";
 
 namespace CommandIDs {
   export const downloadArchive = "filebrowser:download-archive";
   export const extractArchive = "filebrowser:extract-archive";
-  export const downloadArchiveCurrentFolder = "filebrowser:download-archive-current-folder";
+  export const downloadArchiveCurrentFolder =
+    "filebrowser:download-archive-current-folder";
 }
 
 function downloadArchiveRequest(
   path: string,
-  archiveFormat: string
+  archiveFormat: ArchiveFormat
 ): Promise<void> {
   const settings = ServerConnection.makeSettings();
 
@@ -56,8 +69,8 @@ function downloadArchiveRequest(
   } else {
     let element = document.createElement("a");
     document.body.appendChild(element);
-    element.setAttribute('href', url);
-    element.setAttribute('download', '');
+    element.setAttribute("href", url);
+    element.setAttribute("download", "");
     element.click();
     document.body.removeChild(element);
   }
@@ -107,54 +120,145 @@ const extension: JupyterFrontEndPlugin<void> = {
     const { commands } = app;
     const { tracker } = factory;
 
-    let archiveFormat: string = "zip";
+    const allowedArchiveExtensions = [
+      ".zip",
+      ".tgz",
+      ".tar.gz",
+      ".tbz",
+      ".tbz2",
+      ".tar.bz",
+      ".tar.bz2",
+      ".txz",
+      ".tar.xz"
+    ];
+    let archiveFormat: ArchiveFormat; // Default value read from settings
+
+    // matches anywhere on filebrowser
+    const selectorContent = ".jp-DirListing-content";
+
+    // matches all filebrowser items
+    const selectorOnlyDir = '.jp-DirListing-item[data-isdir="true"]';
+
+    // Create submenus
+    const archiveFolder = new Menu({
+      commands
+    });
+    archiveFolder.title.label = "Download As";
+    archiveFolder.title.iconClass = "jp-MaterialIcon jp-DownloadIcon";
+    const archiveCurrentFolder = new Menu({
+      commands
+    });
+    archiveCurrentFolder.title.label = "Download Current Folder As";
+    archiveCurrentFolder.title.iconClass = "jp-MaterialIcon jp-DownloadIcon";
+
+    ["zip", "tar.bz2", "tar.gz", "tar.xz"].forEach(format => {
+      archiveFolder.addItem({
+        command: CommandIDs.downloadArchive,
+        args: { format }
+      });
+      archiveCurrentFolder.addItem({
+        command: CommandIDs.downloadArchiveCurrentFolder,
+        args: { format }
+      });
+    });
+
+    // Reference to menu items
+    let archiveFolderItem: IDisposable;
+    let archiveCurrentFolderItem: IDisposable;
+
+    function updateFormat(newFormat: ArchiveFormat, oldFormat: ArchiveFormat) {
+      if (newFormat !== oldFormat) {
+        if (
+          newFormat === null ||
+          oldFormat === null ||
+          oldFormat === undefined
+        ) {
+          if (oldFormat !== undefined) {
+            archiveFolderItem.dispose();
+            archiveCurrentFolderItem.dispose();
+          }
+
+          if (newFormat === null) {
+            archiveFolderItem = app.contextMenu.addItem({
+              selector: selectorOnlyDir,
+              rank: 10,
+              type: "submenu",
+              submenu: archiveFolder
+            });
+
+            archiveCurrentFolderItem = app.contextMenu.addItem({
+              selector: selectorContent,
+              rank: 3,
+              type: "submenu",
+              submenu: archiveCurrentFolder
+            });
+          } else {
+            archiveFolderItem = app.contextMenu.addItem({
+              command: CommandIDs.downloadArchive,
+              selector: selectorOnlyDir,
+              rank: 10
+            });
+
+            archiveCurrentFolderItem = app.contextMenu.addItem({
+              command: CommandIDs.downloadArchiveCurrentFolder,
+              selector: selectorContent,
+              rank: 3
+            });
+          }
+        }
+
+        archiveFormat = newFormat;
+      }
+    }
 
     // Load the settings
     settingRegistry
       .load("@hadim/jupyter-archive:archive")
       .then(settings => {
         settings.changed.connect(settings => {
-          archiveFormat = settings.get("format").composite as string;
+          const newFormat = settings.get("format").composite as ArchiveFormat;
+          updateFormat(newFormat, archiveFormat);
         });
-        archiveFormat = settings.get("format").composite as string;
+
+        const newFormat = settings.get("format").composite as ArchiveFormat;
+        updateFormat(newFormat, archiveFormat);
       })
       .catch(reason => {
         console.error(reason);
         showErrorMessage(
-          "Fail to read settings for '@jupyterlab/archive:archive'",
+          "Fail to read settings for '@hadim/jupyter-archive:archive'",
           reason
         );
       });
 
-    // matches anywhere on filebrowser
-    const selectorContent = '.jp-DirListing-content';
-
-    // matches all filebrowser items
-    const selectorOnlyDir = '.jp-DirListing-item[data-isdir="true"]';
-
-    // Add the 'download_archive' command to the file's menu.
+    // Add the 'downloadArchive' command to the file's menu.
     commands.addCommand(CommandIDs.downloadArchive, {
-      execute: () => {
+      execute: args => {
         const widget = tracker.currentWidget;
         if (widget) {
           each(widget.selectedItems(), item => {
             if (item.type == "directory") {
-              downloadArchiveRequest(item.path, archiveFormat);
+              const format = args["format"] as ArchiveFormat;
+              downloadArchiveRequest(
+                item.path,
+                allowedArchiveExtensions.indexOf("." + format) >= 0
+                  ? format
+                  : archiveFormat
+              );
             }
           });
         }
       },
-      iconClass: "jp-MaterialIcon jp-DownloadIcon",
-      label: "Download as an archive"
-    });
-
-    app.contextMenu.addItem({
-      command: CommandIDs.downloadArchive,
-      selector: selectorOnlyDir,
-      rank: 10
+      iconClass: args =>
+        "format" in args ? "" : "jp-MaterialIcon jp-DownloadIcon",
+      label: args => {
+        const format = (args["format"] as ArchiveFormat) || "";
+        const label = format.replace(".", " ").toLocaleUpperCase();
+        return label ? `${label} Archive` : "Download as an Archive";
+      }
     });
 
-    // Add the 'extract_archive' command to the file's menu.
+    // Add the 'extractArchive' command to the file's menu.
     commands.addCommand(CommandIDs.extractArchive, {
       execute: () => {
         const widget = tracker.currentWidget;
@@ -165,14 +269,11 @@ const extension: JupyterFrontEndPlugin<void> = {
         }
       },
       iconClass: "jp-MaterialIcon jp-DownCaretIcon",
-      label: "Extract archive"
+      label: "Extract Archive"
     });
 
     // Add a command for each archive extensions
     // TODO: use only one command and accept multiple extensions.
-    const allowedArchiveExtensions = [".zip", ".tgz", ".tar.gz",".tbz", ".tbz2",
-                                      ".tar.bz", ".tar.bz2", ".txz", ".tar.xz"]
-
     allowedArchiveExtensions.forEach(extension => {
       const selector = '.jp-DirListing-item[title$="' + extension + '"]';
       app.contextMenu.addItem({
@@ -182,24 +283,30 @@ const extension: JupyterFrontEndPlugin<void> = {
       });
     });
 
-    // Add the 'download_archive' command to fiel browser content.
+    // Add the 'downloadArchiveCurrentFolder' command to file browser content.
     commands.addCommand(CommandIDs.downloadArchiveCurrentFolder, {
-      execute: () => {
+      execute: args => {
         const widget = tracker.currentWidget;
         if (widget) {
-          downloadArchiveRequest(widget.model.path, archiveFormat);
+          const format = args["format"] as ArchiveFormat;
+          downloadArchiveRequest(
+            widget.model.path,
+            allowedArchiveExtensions.indexOf("." + format) >= 0
+              ? format
+              : archiveFormat
+          );
         }
       },
-      iconClass: "jp-MaterialIcon jp-DownloadIcon",
-      label: "Download current folder as an archive"
-    });
-
-    app.contextMenu.addItem({
-      command: CommandIDs.downloadArchiveCurrentFolder,
-      selector: selectorContent,
-      rank: 3
+      iconClass: args =>
+        "format" in args ? "" : "jp-MaterialIcon jp-DownloadIcon",
+      label: args => {
+        const format = (args["format"] as ArchiveFormat) || "";
+        const label = format.replace(".", " ").toLocaleUpperCase();
+        return label
+          ? `${label} Archive`
+          : "Download Current Folder as an Archive";
+      }
     });
-
   }
 };
 
