|
|
|
|
@ -1,125 +1,26 @@
|
|
|
|
|
// Vendored from https://github.com/jupyterlab/jupyterlab/blob/b9511a52557d6ae56e597d0f48392993bdc432ae/packages/filebrowser-extension/src/index.ts
|
|
|
|
|
// Because of ILabShell being a required dependency in some of the plugins
|
|
|
|
|
// TODO: remove this package when ILabShell is optional upstream
|
|
|
|
|
|
|
|
|
|
// Copyright (c) Jupyter Development Team.
|
|
|
|
|
// Distributed under the terms of the Modified BSD License.
|
|
|
|
|
|
|
|
|
|
import {
|
|
|
|
|
ILayoutRestorer,
|
|
|
|
|
ITreePathUpdater,
|
|
|
|
|
IRouter,
|
|
|
|
|
JupyterFrontEnd,
|
|
|
|
|
JupyterFrontEndPlugin
|
|
|
|
|
} from '@jupyterlab/application';
|
|
|
|
|
import { CommandToolbarButton } from '@jupyterlab/apputils';
|
|
|
|
|
|
|
|
|
|
import {
|
|
|
|
|
Clipboard,
|
|
|
|
|
WidgetTracker,
|
|
|
|
|
ICommandPalette,
|
|
|
|
|
InputDialog,
|
|
|
|
|
showErrorMessage,
|
|
|
|
|
DOMUtils,
|
|
|
|
|
CommandToolbarButton
|
|
|
|
|
} from '@jupyterlab/apputils';
|
|
|
|
|
|
|
|
|
|
import { PathExt } from '@jupyterlab/coreutils';
|
|
|
|
|
|
|
|
|
|
import { IDocumentManager } from '@jupyterlab/docmanager';
|
|
|
|
|
|
|
|
|
|
import {
|
|
|
|
|
FilterFileBrowserModel,
|
|
|
|
|
FileBrowser,
|
|
|
|
|
IFileBrowserFactory
|
|
|
|
|
} from '@jupyterlab/filebrowser';
|
|
|
|
|
|
|
|
|
|
import { IMainMenu } from '@jupyterlab/mainmenu';
|
|
|
|
|
import { IFileBrowserFactory } from '@jupyterlab/filebrowser';
|
|
|
|
|
|
|
|
|
|
import { IRunningSessionManagers, RunningSessions } from '@jupyterlab/running';
|
|
|
|
|
|
|
|
|
|
import { Contents } from '@jupyterlab/services';
|
|
|
|
|
|
|
|
|
|
import { ISettingRegistry } from '@jupyterlab/settingregistry';
|
|
|
|
|
|
|
|
|
|
import { IStateDB } from '@jupyterlab/statedb';
|
|
|
|
|
|
|
|
|
|
import { ITranslator } from '@jupyterlab/translation';
|
|
|
|
|
|
|
|
|
|
import {
|
|
|
|
|
addIcon,
|
|
|
|
|
closeIcon,
|
|
|
|
|
copyIcon,
|
|
|
|
|
cutIcon,
|
|
|
|
|
downloadIcon,
|
|
|
|
|
editIcon,
|
|
|
|
|
fileIcon,
|
|
|
|
|
folderIcon,
|
|
|
|
|
markdownIcon,
|
|
|
|
|
newFolderIcon,
|
|
|
|
|
notebookIcon,
|
|
|
|
|
pasteIcon,
|
|
|
|
|
runningIcon,
|
|
|
|
|
stopIcon,
|
|
|
|
|
terminalIcon,
|
|
|
|
|
textEditorIcon
|
|
|
|
|
terminalIcon
|
|
|
|
|
} from '@jupyterlab/ui-components';
|
|
|
|
|
|
|
|
|
|
import { map, toArray } from '@lumino/algorithm';
|
|
|
|
|
|
|
|
|
|
import { CommandRegistry } from '@lumino/commands';
|
|
|
|
|
|
|
|
|
|
import { TabPanel } from '@lumino/widgets';
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* The command IDs used by the file browser plugin.
|
|
|
|
|
*/
|
|
|
|
|
namespace CommandIDs {
|
|
|
|
|
export const copy = 'filebrowser:copy';
|
|
|
|
|
|
|
|
|
|
export const copyDownloadLink = 'filebrowser:copy-download-link';
|
|
|
|
|
|
|
|
|
|
export const cut = 'filebrowser:cut';
|
|
|
|
|
|
|
|
|
|
export const del = 'filebrowser:delete';
|
|
|
|
|
|
|
|
|
|
export const download = 'filebrowser:download';
|
|
|
|
|
|
|
|
|
|
export const duplicate = 'filebrowser:duplicate';
|
|
|
|
|
|
|
|
|
|
export const goToPath = 'filebrowser:go-to-path';
|
|
|
|
|
|
|
|
|
|
export const openPath = 'filebrowser:open-path';
|
|
|
|
|
|
|
|
|
|
export const open = 'filebrowser:open';
|
|
|
|
|
|
|
|
|
|
export const openBrowserTab = 'filebrowser:open-browser-tab';
|
|
|
|
|
|
|
|
|
|
export const paste = 'filebrowser:paste';
|
|
|
|
|
|
|
|
|
|
export const createNewDirectory = 'filebrowser:create-new-directory';
|
|
|
|
|
|
|
|
|
|
export const createNewFile = 'filebrowser:create-new-file';
|
|
|
|
|
|
|
|
|
|
export const createNewMarkdownFile = 'filebrowser:create-new-markdown-file';
|
|
|
|
|
|
|
|
|
|
export const rename = 'filebrowser:rename';
|
|
|
|
|
|
|
|
|
|
// For main browser only.
|
|
|
|
|
export const share = 'filebrowser:share-main';
|
|
|
|
|
|
|
|
|
|
// For main browser only.
|
|
|
|
|
export const copyPath = 'filebrowser:copy-path';
|
|
|
|
|
|
|
|
|
|
export const shutdown = 'filebrowser:shutdown';
|
|
|
|
|
|
|
|
|
|
export const toggleNavigateToCurrentDirectory =
|
|
|
|
|
'filebrowser:toggle-navigate-to-current-directory';
|
|
|
|
|
|
|
|
|
|
export const toggleLastModified = 'filebrowser:toggle-last-modified';
|
|
|
|
|
|
|
|
|
|
export const search = 'filebrowser:search';
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Plugin to add extra buttons to the file browser to create
|
|
|
|
|
* new notebooks, files and terminals.
|
|
|
|
|
@ -149,7 +50,7 @@ const newFiles: JupyterFrontEndPlugin<void> = {
|
|
|
|
|
|
|
|
|
|
const newFile = new CommandToolbarButton({
|
|
|
|
|
commands,
|
|
|
|
|
id: CommandIDs.createNewFile
|
|
|
|
|
id: 'filebrowser:create-new-file'
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
browser.toolbar.insertItem(0, 'new-notebook', newNotebook);
|
|
|
|
|
@ -185,803 +86,47 @@ const newTerminal: JupyterFrontEndPlugin<void> = {
|
|
|
|
|
browser.toolbar.insertItem(2, 'new-terminal', newTerminal);
|
|
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* The default file browser extension.
|
|
|
|
|
*/
|
|
|
|
|
const browser: JupyterFrontEndPlugin<void> = {
|
|
|
|
|
activate: activateBrowser,
|
|
|
|
|
id: '@retrolab/tree-extension:browser',
|
|
|
|
|
requires: [
|
|
|
|
|
IFileBrowserFactory,
|
|
|
|
|
IDocumentManager,
|
|
|
|
|
ISettingRegistry,
|
|
|
|
|
ITranslator
|
|
|
|
|
],
|
|
|
|
|
optional: [
|
|
|
|
|
ICommandPalette,
|
|
|
|
|
IMainMenu,
|
|
|
|
|
ILayoutRestorer,
|
|
|
|
|
ITreePathUpdater,
|
|
|
|
|
IRunningSessionManagers
|
|
|
|
|
],
|
|
|
|
|
autoStart: true
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* The default file browser factory provider.
|
|
|
|
|
*
|
|
|
|
|
* TODO: remove and use upstream plugin
|
|
|
|
|
*/
|
|
|
|
|
const factory: JupyterFrontEndPlugin<IFileBrowserFactory> = {
|
|
|
|
|
activate: activateFactory,
|
|
|
|
|
id: '@retrolab/tree-extension:factory',
|
|
|
|
|
provides: IFileBrowserFactory,
|
|
|
|
|
requires: [IDocumentManager, ITranslator],
|
|
|
|
|
optional: [IStateDB, IRouter, JupyterFrontEnd.ITreeResolver]
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* The file browser namespace token.
|
|
|
|
|
*/
|
|
|
|
|
const namespace = 'filebrowser';
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Activate the file browser factory provider.
|
|
|
|
|
*/
|
|
|
|
|
async function activateFactory(
|
|
|
|
|
app: JupyterFrontEnd,
|
|
|
|
|
docManager: IDocumentManager,
|
|
|
|
|
translator: ITranslator,
|
|
|
|
|
state: IStateDB | null,
|
|
|
|
|
router: IRouter | null,
|
|
|
|
|
tree: JupyterFrontEnd.ITreeResolver | null
|
|
|
|
|
): Promise<IFileBrowserFactory> {
|
|
|
|
|
const { commands } = app;
|
|
|
|
|
const tracker = new WidgetTracker<FileBrowser>({ namespace });
|
|
|
|
|
const createFileBrowser = (
|
|
|
|
|
id: string,
|
|
|
|
|
options: IFileBrowserFactory.IOptions = {}
|
|
|
|
|
) => {
|
|
|
|
|
const model = new FilterFileBrowserModel({
|
|
|
|
|
translator: translator,
|
|
|
|
|
auto: options.auto ?? true,
|
|
|
|
|
manager: docManager,
|
|
|
|
|
driveName: options.driveName || '',
|
|
|
|
|
refreshInterval: options.refreshInterval,
|
|
|
|
|
state:
|
|
|
|
|
options.state === null ? undefined : options.state || state || undefined
|
|
|
|
|
});
|
|
|
|
|
const restore = options.restore;
|
|
|
|
|
const widget = new FileBrowser({ id, model, restore, translator });
|
|
|
|
|
|
|
|
|
|
// Track the newly created file browser.
|
|
|
|
|
void tracker.add(widget);
|
|
|
|
|
|
|
|
|
|
return widget;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
// Manually restore and load the default file browser.
|
|
|
|
|
const defaultBrowser = createFileBrowser('filebrowser', {
|
|
|
|
|
auto: false,
|
|
|
|
|
restore: false
|
|
|
|
|
});
|
|
|
|
|
void Private.restoreBrowser(defaultBrowser, commands, router, tree);
|
|
|
|
|
|
|
|
|
|
return { createFileBrowser, defaultBrowser, tracker };
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Activate the default file browser in the sidebar.
|
|
|
|
|
* A plugin to add the file browser widget to an ILabShell
|
|
|
|
|
*/
|
|
|
|
|
function activateBrowser(
|
|
|
|
|
app: JupyterFrontEnd,
|
|
|
|
|
factory: IFileBrowserFactory,
|
|
|
|
|
docManager: IDocumentManager,
|
|
|
|
|
settingRegistry: ISettingRegistry,
|
|
|
|
|
translator: ITranslator,
|
|
|
|
|
commandPalette: ICommandPalette | null,
|
|
|
|
|
mainMenu: IMainMenu | null,
|
|
|
|
|
restorer: ILayoutRestorer | null,
|
|
|
|
|
treePathUpdater: ITreePathUpdater | null,
|
|
|
|
|
manager: IRunningSessionManagers | null
|
|
|
|
|
): void {
|
|
|
|
|
const browser = factory.defaultBrowser;
|
|
|
|
|
|
|
|
|
|
// Let the application restorer track the primary file browser (that is
|
|
|
|
|
// automatically created) for restoration of application state (e.g. setting
|
|
|
|
|
// the file browser as the current side bar widget).
|
|
|
|
|
//
|
|
|
|
|
// All other file browsers created by using the factory function are
|
|
|
|
|
// responsible for their own restoration behavior, if any.
|
|
|
|
|
if (restorer) {
|
|
|
|
|
restorer.add(browser, namespace);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
addCommands(
|
|
|
|
|
app,
|
|
|
|
|
factory,
|
|
|
|
|
settingRegistry,
|
|
|
|
|
translator,
|
|
|
|
|
commandPalette,
|
|
|
|
|
mainMenu
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
browser.title.icon = folderIcon;
|
|
|
|
|
|
|
|
|
|
const tabPanel = new TabPanel({ tabPlacement: 'top', tabsMovable: true });
|
|
|
|
|
tabPanel.addClass('jp-TreePanel');
|
|
|
|
|
|
|
|
|
|
browser.title.label = 'Files';
|
|
|
|
|
tabPanel.addWidget(browser);
|
|
|
|
|
tabPanel.tabBar.addTab(browser.title);
|
|
|
|
|
|
|
|
|
|
if (manager) {
|
|
|
|
|
const running = new RunningSessions(manager, translator);
|
|
|
|
|
running.id = 'jp-running-sessions';
|
|
|
|
|
running.title.label = 'Running';
|
|
|
|
|
running.title.icon = runningIcon;
|
|
|
|
|
tabPanel.addWidget(running);
|
|
|
|
|
tabPanel.tabBar.addTab(running.title);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
app.shell.add(tabPanel, 'main', { rank: 100 });
|
|
|
|
|
|
|
|
|
|
void Promise.all([app.restored, browser.model.restored]).then(() => {
|
|
|
|
|
let navigateToCurrentDirectory = false;
|
|
|
|
|
let useFuzzyFilter = true;
|
|
|
|
|
|
|
|
|
|
void settingRegistry
|
|
|
|
|
.load('@jupyterlab/filebrowser-extension:browser')
|
|
|
|
|
.then(settings => {
|
|
|
|
|
settings.changed.connect(settings => {
|
|
|
|
|
navigateToCurrentDirectory = settings.get(
|
|
|
|
|
'navigateToCurrentDirectory'
|
|
|
|
|
).composite as boolean;
|
|
|
|
|
browser.navigateToCurrentDirectory = navigateToCurrentDirectory;
|
|
|
|
|
});
|
|
|
|
|
navigateToCurrentDirectory = settings.get('navigateToCurrentDirectory')
|
|
|
|
|
.composite as boolean;
|
|
|
|
|
browser.navigateToCurrentDirectory = navigateToCurrentDirectory;
|
|
|
|
|
settings.changed.connect(settings => {
|
|
|
|
|
useFuzzyFilter = settings.get('useFuzzyFilter').composite as boolean;
|
|
|
|
|
browser.useFuzzyFilter = useFuzzyFilter;
|
|
|
|
|
});
|
|
|
|
|
useFuzzyFilter = settings.get('useFuzzyFilter').composite as boolean;
|
|
|
|
|
browser.useFuzzyFilter = useFuzzyFilter;
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
if (treePathUpdater) {
|
|
|
|
|
browser.model.pathChanged.connect((sender, args) => {
|
|
|
|
|
treePathUpdater(args.newValue);
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Add the main file browser commands to the application's command registry.
|
|
|
|
|
*/
|
|
|
|
|
function addCommands(
|
|
|
|
|
app: JupyterFrontEnd,
|
|
|
|
|
factory: IFileBrowserFactory,
|
|
|
|
|
settingRegistry: ISettingRegistry,
|
|
|
|
|
translator: ITranslator,
|
|
|
|
|
commandPalette: ICommandPalette | null,
|
|
|
|
|
mainMenu: IMainMenu | null
|
|
|
|
|
): void {
|
|
|
|
|
const trans = translator.load('jupyterlab');
|
|
|
|
|
const { docRegistry: registry, commands } = app;
|
|
|
|
|
const { defaultBrowser: browser, tracker } = factory;
|
|
|
|
|
|
|
|
|
|
commands.addCommand(CommandIDs.del, {
|
|
|
|
|
execute: () => {
|
|
|
|
|
const widget = tracker.currentWidget;
|
|
|
|
|
|
|
|
|
|
if (widget) {
|
|
|
|
|
return widget.delete();
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
icon: closeIcon.bindprops({ stylesheet: 'menuItem' }),
|
|
|
|
|
label: trans.__('Delete'),
|
|
|
|
|
mnemonic: 0
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
commands.addCommand(CommandIDs.copy, {
|
|
|
|
|
execute: () => {
|
|
|
|
|
const widget = tracker.currentWidget;
|
|
|
|
|
|
|
|
|
|
if (widget) {
|
|
|
|
|
return widget.copy();
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
icon: copyIcon.bindprops({ stylesheet: 'menuItem' }),
|
|
|
|
|
label: trans.__('Copy'),
|
|
|
|
|
mnemonic: 0
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
commands.addCommand(CommandIDs.cut, {
|
|
|
|
|
execute: () => {
|
|
|
|
|
const widget = tracker.currentWidget;
|
|
|
|
|
|
|
|
|
|
if (widget) {
|
|
|
|
|
return widget.cut();
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
icon: cutIcon.bindprops({ stylesheet: 'menuItem' }),
|
|
|
|
|
label: trans.__('Cut')
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
commands.addCommand(CommandIDs.download, {
|
|
|
|
|
execute: () => {
|
|
|
|
|
const widget = tracker.currentWidget;
|
|
|
|
|
|
|
|
|
|
if (widget) {
|
|
|
|
|
return widget.download();
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
icon: downloadIcon.bindprops({ stylesheet: 'menuItem' }),
|
|
|
|
|
label: trans.__('Download')
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
commands.addCommand(CommandIDs.duplicate, {
|
|
|
|
|
execute: () => {
|
|
|
|
|
const widget = tracker.currentWidget;
|
|
|
|
|
|
|
|
|
|
if (widget) {
|
|
|
|
|
return widget.duplicate();
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
icon: copyIcon.bindprops({ stylesheet: 'menuItem' }),
|
|
|
|
|
label: trans.__('Duplicate')
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
commands.addCommand(CommandIDs.goToPath, {
|
|
|
|
|
execute: async args => {
|
|
|
|
|
const path = (args.path as string) || '';
|
|
|
|
|
try {
|
|
|
|
|
const item = await Private.navigateToPath(path, factory, translator);
|
|
|
|
|
if (item.type !== 'directory') {
|
|
|
|
|
const browserForPath = Private.getBrowserForPath(path, factory);
|
|
|
|
|
if (browserForPath) {
|
|
|
|
|
browserForPath.clearSelectedItems();
|
|
|
|
|
const parts = path.split('/');
|
|
|
|
|
const name = parts[parts.length - 1];
|
|
|
|
|
if (name) {
|
|
|
|
|
await browserForPath.selectItemByName(name);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
} catch (reason) {
|
|
|
|
|
console.warn(`${CommandIDs.goToPath} failed to go to: ${path}`, reason);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
commands.addCommand(CommandIDs.openPath, {
|
|
|
|
|
label: args =>
|
|
|
|
|
args.path ? trans.__('Open %1', args.path) : trans.__('Open from Path…'),
|
|
|
|
|
caption: args =>
|
|
|
|
|
args.path ? trans.__('Open %1', args.path) : trans.__('Open from path'),
|
|
|
|
|
execute: async args => {
|
|
|
|
|
let path: string | undefined;
|
|
|
|
|
if (args?.path) {
|
|
|
|
|
path = args.path as string;
|
|
|
|
|
} else {
|
|
|
|
|
path =
|
|
|
|
|
(
|
|
|
|
|
await InputDialog.getText({
|
|
|
|
|
label: trans.__('Path'),
|
|
|
|
|
placeholder: '/path/relative/to/jlab/root',
|
|
|
|
|
title: trans.__('Open Path'),
|
|
|
|
|
okLabel: trans.__('Open')
|
|
|
|
|
})
|
|
|
|
|
).value ?? undefined;
|
|
|
|
|
}
|
|
|
|
|
if (!path) {
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
try {
|
|
|
|
|
const trailingSlash = path !== '/' && path.endsWith('/');
|
|
|
|
|
if (trailingSlash) {
|
|
|
|
|
// The normal contents service errors on paths ending in slash
|
|
|
|
|
path = path.slice(0, path.length - 1);
|
|
|
|
|
}
|
|
|
|
|
const browserForPath = Private.getBrowserForPath(path, factory)!;
|
|
|
|
|
const { services } = browserForPath.model.manager;
|
|
|
|
|
const item = await services.contents.get(path, {
|
|
|
|
|
content: false
|
|
|
|
|
});
|
|
|
|
|
if (trailingSlash && item.type !== 'directory') {
|
|
|
|
|
throw new Error(`Path ${path}/ is not a directory`);
|
|
|
|
|
}
|
|
|
|
|
await commands.execute(CommandIDs.goToPath, {
|
|
|
|
|
path,
|
|
|
|
|
dontShowBrowser: args.dontShowBrowser
|
|
|
|
|
});
|
|
|
|
|
if (item.type === 'directory') {
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
return commands.execute('docmanager:open', { path });
|
|
|
|
|
} catch (reason) {
|
|
|
|
|
if (reason.response && reason.response.status === 404) {
|
|
|
|
|
reason.message = trans.__('Could not find path: %1', path);
|
|
|
|
|
}
|
|
|
|
|
return showErrorMessage(trans.__('Cannot open'), reason);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
// Add the openPath command to the command palette
|
|
|
|
|
if (commandPalette) {
|
|
|
|
|
commandPalette.addItem({
|
|
|
|
|
command: CommandIDs.openPath,
|
|
|
|
|
category: trans.__('File Operations')
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
commands.addCommand(CommandIDs.open, {
|
|
|
|
|
execute: args => {
|
|
|
|
|
const factory = (args['factory'] as string) || void 0;
|
|
|
|
|
const widget = tracker.currentWidget;
|
|
|
|
|
|
|
|
|
|
if (!widget) {
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
const { contents } = widget.model.manager.services;
|
|
|
|
|
return Promise.all(
|
|
|
|
|
toArray(
|
|
|
|
|
map(widget.selectedItems(), item => {
|
|
|
|
|
if (item.type === 'directory') {
|
|
|
|
|
const localPath = contents.localPath(item.path);
|
|
|
|
|
return widget.model.cd(`/${localPath}`);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return commands.execute('docmanager:open', {
|
|
|
|
|
factory: factory,
|
|
|
|
|
path: item.path
|
|
|
|
|
});
|
|
|
|
|
})
|
|
|
|
|
)
|
|
|
|
|
);
|
|
|
|
|
},
|
|
|
|
|
icon: args => {
|
|
|
|
|
const factory = (args['factory'] as string) || void 0;
|
|
|
|
|
if (factory) {
|
|
|
|
|
// if an explicit factory is passed...
|
|
|
|
|
const ft = registry.getFileType(factory);
|
|
|
|
|
// ...set an icon if the factory name corresponds to a file type name...
|
|
|
|
|
// ...or leave the icon blank
|
|
|
|
|
return ft?.icon?.bindprops({ stylesheet: 'menuItem' });
|
|
|
|
|
} else {
|
|
|
|
|
return folderIcon.bindprops({ stylesheet: 'menuItem' });
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
// FIXME-TRANS: Is this localizable?
|
|
|
|
|
label: args =>
|
|
|
|
|
(args['label'] || args['factory'] || trans.__('Open')) as string,
|
|
|
|
|
mnemonic: 0
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
commands.addCommand(CommandIDs.openBrowserTab, {
|
|
|
|
|
execute: () => {
|
|
|
|
|
const widget = tracker.currentWidget;
|
|
|
|
|
|
|
|
|
|
if (!widget) {
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return Promise.all(
|
|
|
|
|
toArray(
|
|
|
|
|
map(widget.selectedItems(), item => {
|
|
|
|
|
return commands.execute('docmanager:open-browser-tab', {
|
|
|
|
|
path: item.path
|
|
|
|
|
});
|
|
|
|
|
})
|
|
|
|
|
)
|
|
|
|
|
);
|
|
|
|
|
},
|
|
|
|
|
icon: addIcon.bindprops({ stylesheet: 'menuItem' }),
|
|
|
|
|
label: trans.__('Open in New Browser Tab'),
|
|
|
|
|
mnemonic: 0
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
commands.addCommand(CommandIDs.copyDownloadLink, {
|
|
|
|
|
execute: () => {
|
|
|
|
|
const widget = tracker.currentWidget;
|
|
|
|
|
if (!widget) {
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return widget.model.manager.services.contents
|
|
|
|
|
.getDownloadUrl(widget.selectedItems().next()!.path)
|
|
|
|
|
.then(url => {
|
|
|
|
|
Clipboard.copyToSystem(url);
|
|
|
|
|
});
|
|
|
|
|
},
|
|
|
|
|
icon: copyIcon.bindprops({ stylesheet: 'menuItem' }),
|
|
|
|
|
label: trans.__('Copy Download Link'),
|
|
|
|
|
mnemonic: 0
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
commands.addCommand(CommandIDs.paste, {
|
|
|
|
|
execute: () => {
|
|
|
|
|
const widget = tracker.currentWidget;
|
|
|
|
|
|
|
|
|
|
if (widget) {
|
|
|
|
|
return widget.paste();
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
icon: pasteIcon.bindprops({ stylesheet: 'menuItem' }),
|
|
|
|
|
label: trans.__('Paste'),
|
|
|
|
|
mnemonic: 0
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
commands.addCommand(CommandIDs.createNewDirectory, {
|
|
|
|
|
execute: () => {
|
|
|
|
|
const widget = tracker.currentWidget;
|
|
|
|
|
|
|
|
|
|
if (widget) {
|
|
|
|
|
return widget.createNewDirectory();
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
icon: newFolderIcon.bindprops({ stylesheet: 'menuItem' }),
|
|
|
|
|
label: trans.__('New Folder')
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
commands.addCommand(CommandIDs.createNewFile, {
|
|
|
|
|
execute: () => {
|
|
|
|
|
const {
|
|
|
|
|
model: { path }
|
|
|
|
|
} = browser;
|
|
|
|
|
void commands.execute('docmanager:new-untitled', {
|
|
|
|
|
path,
|
|
|
|
|
type: 'file',
|
|
|
|
|
ext: 'txt'
|
|
|
|
|
});
|
|
|
|
|
},
|
|
|
|
|
icon: textEditorIcon.bindprops({ stylesheet: 'menuItem' }),
|
|
|
|
|
label: trans.__('New File')
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
commands.addCommand(CommandIDs.createNewMarkdownFile, {
|
|
|
|
|
execute: () => {
|
|
|
|
|
const {
|
|
|
|
|
model: { path }
|
|
|
|
|
} = browser;
|
|
|
|
|
void commands.execute('docmanager:new-untitled', {
|
|
|
|
|
path,
|
|
|
|
|
type: 'file',
|
|
|
|
|
ext: 'md'
|
|
|
|
|
});
|
|
|
|
|
},
|
|
|
|
|
icon: markdownIcon.bindprops({ stylesheet: 'menuItem' }),
|
|
|
|
|
label: trans.__('New Markdown File')
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
commands.addCommand(CommandIDs.rename, {
|
|
|
|
|
execute: args => {
|
|
|
|
|
const widget = tracker.currentWidget;
|
|
|
|
|
|
|
|
|
|
if (widget) {
|
|
|
|
|
return widget.rename();
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
icon: editIcon.bindprops({ stylesheet: 'menuItem' }),
|
|
|
|
|
label: trans.__('Rename'),
|
|
|
|
|
mnemonic: 0
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
commands.addCommand(CommandIDs.copyPath, {
|
|
|
|
|
execute: () => {
|
|
|
|
|
const widget = tracker.currentWidget;
|
|
|
|
|
if (!widget) {
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
const item = widget.selectedItems().next();
|
|
|
|
|
if (!item) {
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
Clipboard.copyToSystem(item.path);
|
|
|
|
|
},
|
|
|
|
|
isVisible: () =>
|
|
|
|
|
!!tracker.currentWidget &&
|
|
|
|
|
tracker.currentWidget.selectedItems().next !== undefined,
|
|
|
|
|
icon: fileIcon.bindprops({ stylesheet: 'menuItem' }),
|
|
|
|
|
label: trans.__('Copy Path')
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
commands.addCommand(CommandIDs.shutdown, {
|
|
|
|
|
execute: () => {
|
|
|
|
|
const widget = tracker.currentWidget;
|
|
|
|
|
|
|
|
|
|
if (widget) {
|
|
|
|
|
return widget.shutdownKernels();
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
icon: stopIcon.bindprops({ stylesheet: 'menuItem' }),
|
|
|
|
|
label: trans.__('Shut Down Kernel')
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
commands.addCommand(CommandIDs.toggleNavigateToCurrentDirectory, {
|
|
|
|
|
label: trans.__('Show Active File in File Browser'),
|
|
|
|
|
isToggled: () => browser.navigateToCurrentDirectory,
|
|
|
|
|
execute: () => {
|
|
|
|
|
const value = !browser.navigateToCurrentDirectory;
|
|
|
|
|
const key = 'navigateToCurrentDirectory';
|
|
|
|
|
return settingRegistry
|
|
|
|
|
.set('@jupyterlab/filebrowser-extension:browser', key, value)
|
|
|
|
|
.catch((reason: Error) => {
|
|
|
|
|
console.error('Failed to set navigateToCurrentDirectory setting');
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
commands.addCommand(CommandIDs.toggleLastModified, {
|
|
|
|
|
label: trans.__('Toggle Last Modified Column'),
|
|
|
|
|
execute: () => {
|
|
|
|
|
const header = DOMUtils.findElement(document.body, 'jp-id-modified');
|
|
|
|
|
const column = DOMUtils.findElements(
|
|
|
|
|
document.body,
|
|
|
|
|
'jp-DirListing-itemModified'
|
|
|
|
|
);
|
|
|
|
|
if (header.classList.contains('jp-LastModified-hidden')) {
|
|
|
|
|
header.classList.remove('jp-LastModified-hidden');
|
|
|
|
|
for (let i = 0; i < column.length; i++) {
|
|
|
|
|
column[i].classList.remove('jp-LastModified-hidden');
|
|
|
|
|
}
|
|
|
|
|
} else {
|
|
|
|
|
header.classList.add('jp-LastModified-hidden');
|
|
|
|
|
for (let i = 0; i < column.length; i++) {
|
|
|
|
|
column[i].classList.add('jp-LastModified-hidden');
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
commands.addCommand(CommandIDs.search, {
|
|
|
|
|
label: trans.__('Search on File Names'),
|
|
|
|
|
execute: () => alert('search')
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
if (mainMenu) {
|
|
|
|
|
mainMenu.settingsMenu.addGroup(
|
|
|
|
|
[{ command: CommandIDs.toggleNavigateToCurrentDirectory }],
|
|
|
|
|
5
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (commandPalette) {
|
|
|
|
|
commandPalette.addItem({
|
|
|
|
|
command: CommandIDs.toggleNavigateToCurrentDirectory,
|
|
|
|
|
category: trans.__('File Operations')
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// matches anywhere on filebrowser
|
|
|
|
|
const selectorContent = '.jp-DirListing-content';
|
|
|
|
|
// matches all filebrowser items
|
|
|
|
|
const selectorItem = '.jp-DirListing-item[data-isdir]';
|
|
|
|
|
// matches only non-directory items
|
|
|
|
|
const selectorNotDir = '.jp-DirListing-item[data-isdir="false"]';
|
|
|
|
|
|
|
|
|
|
// If the user did not click on any file, we still want to show paste and new folder,
|
|
|
|
|
// so target the content rather than an item.
|
|
|
|
|
app.contextMenu.addItem({
|
|
|
|
|
command: CommandIDs.createNewDirectory,
|
|
|
|
|
selector: selectorContent,
|
|
|
|
|
rank: 1
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
app.contextMenu.addItem({
|
|
|
|
|
command: CommandIDs.createNewFile,
|
|
|
|
|
selector: selectorContent,
|
|
|
|
|
rank: 2
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
app.contextMenu.addItem({
|
|
|
|
|
command: CommandIDs.createNewMarkdownFile,
|
|
|
|
|
selector: selectorContent,
|
|
|
|
|
rank: 3
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
app.contextMenu.addItem({
|
|
|
|
|
command: CommandIDs.paste,
|
|
|
|
|
selector: selectorContent,
|
|
|
|
|
rank: 4
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
app.contextMenu.addItem({
|
|
|
|
|
command: CommandIDs.open,
|
|
|
|
|
selector: selectorItem,
|
|
|
|
|
rank: 1
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
app.contextMenu.addItem({
|
|
|
|
|
command: CommandIDs.openBrowserTab,
|
|
|
|
|
selector: selectorNotDir,
|
|
|
|
|
rank: 3
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
app.contextMenu.addItem({
|
|
|
|
|
command: CommandIDs.rename,
|
|
|
|
|
selector: selectorItem,
|
|
|
|
|
rank: 4
|
|
|
|
|
});
|
|
|
|
|
app.contextMenu.addItem({
|
|
|
|
|
command: CommandIDs.del,
|
|
|
|
|
selector: selectorItem,
|
|
|
|
|
rank: 5
|
|
|
|
|
});
|
|
|
|
|
app.contextMenu.addItem({
|
|
|
|
|
command: CommandIDs.cut,
|
|
|
|
|
selector: selectorItem,
|
|
|
|
|
rank: 6
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
app.contextMenu.addItem({
|
|
|
|
|
command: CommandIDs.copy,
|
|
|
|
|
selector: selectorNotDir,
|
|
|
|
|
rank: 7
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
app.contextMenu.addItem({
|
|
|
|
|
command: CommandIDs.duplicate,
|
|
|
|
|
selector: selectorNotDir,
|
|
|
|
|
rank: 8
|
|
|
|
|
});
|
|
|
|
|
app.contextMenu.addItem({
|
|
|
|
|
command: CommandIDs.download,
|
|
|
|
|
selector: selectorNotDir,
|
|
|
|
|
rank: 9
|
|
|
|
|
});
|
|
|
|
|
app.contextMenu.addItem({
|
|
|
|
|
command: CommandIDs.shutdown,
|
|
|
|
|
selector: selectorNotDir,
|
|
|
|
|
rank: 10
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
app.contextMenu.addItem({
|
|
|
|
|
command: CommandIDs.share,
|
|
|
|
|
selector: selectorItem,
|
|
|
|
|
rank: 11
|
|
|
|
|
});
|
|
|
|
|
app.contextMenu.addItem({
|
|
|
|
|
command: CommandIDs.copyPath,
|
|
|
|
|
selector: selectorItem,
|
|
|
|
|
rank: 12
|
|
|
|
|
});
|
|
|
|
|
app.contextMenu.addItem({
|
|
|
|
|
command: CommandIDs.copyDownloadLink,
|
|
|
|
|
selector: selectorNotDir,
|
|
|
|
|
rank: 13
|
|
|
|
|
});
|
|
|
|
|
app.contextMenu.addItem({
|
|
|
|
|
command: CommandIDs.toggleLastModified,
|
|
|
|
|
selector: '.jp-DirListing-header',
|
|
|
|
|
rank: 14
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* A namespace for private module data.
|
|
|
|
|
*/
|
|
|
|
|
namespace Private {
|
|
|
|
|
/**
|
|
|
|
|
* Get browser object given file path.
|
|
|
|
|
*/
|
|
|
|
|
export function getBrowserForPath(
|
|
|
|
|
path: string,
|
|
|
|
|
factory: IFileBrowserFactory
|
|
|
|
|
): FileBrowser | undefined {
|
|
|
|
|
const { defaultBrowser: browser, tracker } = factory;
|
|
|
|
|
const driveName = browser.model.manager.services.contents.driveName(path);
|
|
|
|
|
|
|
|
|
|
if (driveName) {
|
|
|
|
|
const browserForPath = tracker.find(
|
|
|
|
|
_path => _path.model.driveName === driveName
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
if (!browserForPath) {
|
|
|
|
|
// warn that no filebrowser could be found for this driveName
|
|
|
|
|
console.warn(
|
|
|
|
|
`${CommandIDs.goToPath} failed to find filebrowser for path: ${path}`
|
|
|
|
|
);
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return browserForPath;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// if driveName is empty, assume the main filebrowser
|
|
|
|
|
return browser;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Navigate to a path or the path containing a file.
|
|
|
|
|
*/
|
|
|
|
|
export async function navigateToPath(
|
|
|
|
|
path: string,
|
|
|
|
|
const browserWidget: JupyterFrontEndPlugin<void> = {
|
|
|
|
|
id: '@jupyterlab-classic/tree-extension:widget',
|
|
|
|
|
requires: [IFileBrowserFactory, ITranslator],
|
|
|
|
|
optional: [IRunningSessionManagers],
|
|
|
|
|
autoStart: true,
|
|
|
|
|
activate: (
|
|
|
|
|
app: JupyterFrontEnd,
|
|
|
|
|
factory: IFileBrowserFactory,
|
|
|
|
|
translator: ITranslator
|
|
|
|
|
): Promise<Contents.IModel> {
|
|
|
|
|
const trans = translator.load('jupyterlab');
|
|
|
|
|
const browserForPath = Private.getBrowserForPath(path, factory);
|
|
|
|
|
if (!browserForPath) {
|
|
|
|
|
throw new Error(trans.__('No browser for path'));
|
|
|
|
|
translator: ITranslator,
|
|
|
|
|
manager: IRunningSessionManagers | null
|
|
|
|
|
): void => {
|
|
|
|
|
const tabPanel = new TabPanel({ tabPlacement: 'top', tabsMovable: true });
|
|
|
|
|
tabPanel.addClass('jp-TreePanel');
|
|
|
|
|
|
|
|
|
|
const { defaultBrowser: browser } = factory;
|
|
|
|
|
browser.title.label = 'Files';
|
|
|
|
|
tabPanel.addWidget(browser);
|
|
|
|
|
tabPanel.tabBar.addTab(browser.title);
|
|
|
|
|
|
|
|
|
|
if (manager) {
|
|
|
|
|
const running = new RunningSessions(manager, translator);
|
|
|
|
|
running.id = 'jp-running-sessions';
|
|
|
|
|
running.title.label = 'Running';
|
|
|
|
|
running.title.icon = runningIcon;
|
|
|
|
|
tabPanel.addWidget(running);
|
|
|
|
|
tabPanel.tabBar.addTab(running.title);
|
|
|
|
|
}
|
|
|
|
|
const { services } = browserForPath.model.manager;
|
|
|
|
|
const localPath = services.contents.localPath(path);
|
|
|
|
|
|
|
|
|
|
await services.ready;
|
|
|
|
|
const item = await services.contents.get(path, { content: false });
|
|
|
|
|
const { model } = browserForPath;
|
|
|
|
|
await model.restored;
|
|
|
|
|
if (item.type === 'directory') {
|
|
|
|
|
await model.cd(`/${localPath}`);
|
|
|
|
|
} else {
|
|
|
|
|
await model.cd(`/${PathExt.dirname(localPath)}`);
|
|
|
|
|
}
|
|
|
|
|
return item;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Restores file browser state and overrides state if tree resolver resolves.
|
|
|
|
|
*/
|
|
|
|
|
export async function restoreBrowser(
|
|
|
|
|
browser: FileBrowser,
|
|
|
|
|
commands: CommandRegistry,
|
|
|
|
|
router: IRouter | null,
|
|
|
|
|
tree: JupyterFrontEnd.ITreeResolver | null
|
|
|
|
|
): Promise<void> {
|
|
|
|
|
const restoring = 'jp-mod-restoring';
|
|
|
|
|
|
|
|
|
|
browser.addClass(restoring);
|
|
|
|
|
|
|
|
|
|
if (!router) {
|
|
|
|
|
await browser.model.restore(browser.id);
|
|
|
|
|
await browser.model.refresh();
|
|
|
|
|
browser.removeClass(restoring);
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
const listener = async () => {
|
|
|
|
|
router.routed.disconnect(listener);
|
|
|
|
|
|
|
|
|
|
const paths = await tree?.paths;
|
|
|
|
|
if (paths?.file || paths?.browser) {
|
|
|
|
|
// Restore the model without populating it.
|
|
|
|
|
await browser.model.restore(browser.id, false);
|
|
|
|
|
if (paths.file) {
|
|
|
|
|
await commands.execute(CommandIDs.openPath, {
|
|
|
|
|
path: paths.file,
|
|
|
|
|
dontShowBrowser: true
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
if (paths.browser) {
|
|
|
|
|
await commands.execute(CommandIDs.openPath, {
|
|
|
|
|
path: paths.browser,
|
|
|
|
|
dontShowBrowser: true
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
} else {
|
|
|
|
|
await browser.model.restore(browser.id);
|
|
|
|
|
await browser.model.refresh();
|
|
|
|
|
}
|
|
|
|
|
browser.removeClass(restoring);
|
|
|
|
|
};
|
|
|
|
|
router.routed.connect(listener);
|
|
|
|
|
app.shell.add(tabPanel, 'main', { rank: 100 });
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Export the plugins as default.
|
|
|
|
|
*/
|
|
|
|
|
const plugins: JupyterFrontEndPlugin<any>[] = [
|
|
|
|
|
browser,
|
|
|
|
|
factory,
|
|
|
|
|
newFiles,
|
|
|
|
|
newTerminal
|
|
|
|
|
newTerminal,
|
|
|
|
|
browserWidget
|
|
|
|
|
];
|
|
|
|
|
export default plugins;
|
|
|
|
|
|
Jeremy Tuloup
5 years ago
committed by
GitHub