feat(jupyter): support file download (only access to the same source)

.changeset/flat-planets-impress.md

@@ -0,0 +1,32 @@
+---
+'@difizen/libro-cofine-editor-contribution': patch
+'@difizen/libro-cofine-editor-core': patch
+'@difizen/libro-search-code-cell': patch
+'@difizen/libro-cofine-textmate': patch
+'@difizen/libro-cofine-editor': patch
+'@difizen/libro-markdown-cell': patch
+'@difizen/libro-shared-model': patch
+'@difizen/libro-code-editor': patch
+'@difizen/libro-prompt-cell': patch
+'@difizen/libro-virtualized': patch
+'@difizen/libro-codemirror': patch
+'@difizen/libro-rendermime': patch
+'@difizen/libro-code-cell': patch
+'@difizen/libro-markdown': patch
+'@difizen/libro-raw-cell': patch
+'@difizen/libro-terminal': patch
+'@difizen/libro-jupyter': patch
+'@difizen/libro-common': patch
+'@difizen/libro-kernel': patch
+'@difizen/libro-output': patch
+'@difizen/libro-search': patch
+'@difizen/libro-widget': patch
+'@difizen/libro-core': patch
+'@difizen/libro-l10n': patch
+'@difizen/libro-lab': patch
+'@difizen/libro-lsp': patch
+'@difizen/libro-toc': patch
+'@difizen/libro-docs': patch
+---
+
+Support file download.

apps/docs/.dumirc.ts

@@ -87,6 +87,13 @@ export default defineConfig({
       pathRewrite: {},
       ws: true,
     },
+    '/files': {
+      target: 'http://localhost:8888/',
+      changeOrigin: true,
+      secure: false,
+      pathRewrite: {},
+      ws: true,
+    },
     '/lsp': {
       target: 'http://localhost:8888/',
       changeOrigin: true,

packages/libro-jupyter/src/config/config-contribution.ts

@@ -8,7 +8,12 @@ import { LibroJupyterConfiguration } from './config.js';
 @singleton({ contrib: ConfigurationContribution })
 export class LibroJupyterSettingContribution implements ConfigurationContribution {
   registerConfigurations() {
-    return [LibroJupyterConfiguration.AutoSave, LibroJupyterConfiguration.OpenSlot];
+    return [
+      LibroJupyterConfiguration.AutoSave,
+      LibroJupyterConfiguration.OpenSlot,
+      LibroJupyterConfiguration.AllowDownload,
+      LibroJupyterConfiguration.AllowUpload,
+    ];
   }
 }
 @singleton({ contrib: ApplicationContribution })

packages/libro-jupyter/src/config/config.ts

@@ -4,7 +4,7 @@ import { l10n } from '@difizen/mana-l10n';
 export const LibroConfigAutoSave: ConfigurationNode<boolean> = {
   id: 'libro.autosave',
   description: l10n.t('是否自动保存修改'),
-  title: 'checkbox',
+  title: '自动保存',
   type: 'checkbox',
   defaultValue: false,
   schema: {
@@ -16,14 +16,38 @@ export const LibroConfigOpenSlot: ConfigurationNode<string> = {
   id: 'libro.jupyter.open.slot',
   description: '文件默认打开位置',
   title: '文件默认打开位置',
-  type: 'checkbox',
+  type: 'input',
   defaultValue: 'main',
   schema: {
     type: 'string',
   },
 };
 
+export const LibroConfigAllowDownload: ConfigurationNode<boolean> = {
+  id: 'libro.jupyter.allow.download',
+  description: '是否允许下载',
+  title: '允许下载',
+  type: 'checkbox',
+  defaultValue: true,
+  schema: {
+    type: 'boolean',
+  },
+};
+
+export const LibroConfigAllowUpload: ConfigurationNode<boolean> = {
+  id: 'libro.jupyter.allow.upload',
+  description: '是否允许上传',
+  title: '允许上传',
+  type: 'checkbox',
+  defaultValue: true,
+  schema: {
+    type: 'boolean',
+  },
+};
+
 export const LibroJupyterConfiguration = {
   AutoSave: LibroConfigAutoSave,
   OpenSlot: LibroConfigOpenSlot,
+  AllowUpload: LibroConfigAllowUpload,
+  AllowDownload: LibroConfigAllowDownload,
 };

packages/libro-jupyter/src/file/file-command.tsx

@@ -1,13 +1,14 @@
 import pathUtil from 'path';
 
 import { ReloadOutlined } from '@ant-design/icons';
+import { ContentsManager } from '@difizen/libro-kernel';
 import type {
   CommandRegistry,
   MenuPath,
   MenuRegistry,
   ToolbarRegistry,
 } from '@difizen/mana-app';
-import { ViewManager } from '@difizen/mana-app';
+import { ViewManager, ConfigurationService } from '@difizen/mana-app';
 import {
   CommandContribution,
   FileStatNode,
@@ -21,6 +22,8 @@ import {
 } from '@difizen/mana-app';
 import { message, Modal } from 'antd';
 
+import { LibroConfigAllowDownload } from '../config/index.js';
+
 import { FileCreateModal } from './file-create-modal.js';
 import { FileDirCreateModal } from './file-createdir-modal.js';
 import { FileRenameModal } from './file-rename-modal.js';
@@ -74,6 +77,10 @@ export const FileCommands = {
     id: 'fileTree.command.remove',
     label: '删除',
   },
+  DOWNLOAD: {
+    id: 'fileTree.command.download',
+    label: '下载',
+  },
 };
 export const FileTreeContextMenuPath: MenuPath = ['file-tree-context-menu'];
 
@@ -87,6 +94,9 @@ export class FileCommandContribution
   @inject(JupyterFileService) fileService: JupyterFileService;
   @inject(ModalService) modalService: ModalService;
   @inject(OpenerService) protected openService: OpenerService;
+  @inject(ConfigurationService) configurationService: ConfigurationService;
+  @inject(ContentsManager) contentsManager: ContentsManager;
+
   fileView: FileView;
   lastAction: 'COPY' | 'CUT';
   lastActionNode: FileStatNode;
@@ -148,13 +158,18 @@ export class FileCommandContribution
     menu.registerMenuAction(FileTreeContextMenuPath, {
       id: FileCommands.COPY_PATH.id,
       command: FileCommands.COPY_PATH.id,
-      order: 'g',
+      order: 'f',
     });
     menu.registerMenuAction(FileTreeContextMenuPath, {
       id: FileCommands.COPY_RELATIVE_PATH.id,
       command: FileCommands.COPY_RELATIVE_PATH.id,
       order: 'g',
     });
+    menu.registerMenuAction(FileTreeContextMenuPath, {
+      id: FileCommands.DOWNLOAD.id,
+      command: FileCommands.DOWNLOAD.id,
+      order: 'h',
+    });
   }
   registerCommands(command: CommandRegistry): void {
     command.registerCommand(FileCommands.OPEN_FILE, {
@@ -321,6 +336,34 @@ export class FileCommandContribution
         return view instanceof FileView;
       },
     });
+
+    command.registerCommand(FileCommands.DOWNLOAD, {
+      execute: (data) => {
+        if (!FileStatNode.is(data)) {
+          return;
+        }
+        const path = data.uri.path.toString();
+        this.contentsManager
+          .getDownloadUrl(path)
+          .then((url) => {
+            const element = document.createElement('a');
+            element.href = url;
+            element.download = '';
+            element.target = '_blank';
+            document.body.appendChild(element);
+            element.click();
+            document.body.removeChild(element);
+            return;
+          })
+          .catch(console.error);
+      },
+      isVisible: (data) => {
+        return (
+          !!this.configurationService.get(LibroConfigAllowDownload) &&
+          FileStatNode.is(data)
+        );
+      },
+    });
   }
 
   registerToolbarItems(toolbarRegistry: ToolbarRegistry): void {