devextreme
Version:
HTML5 JavaScript Component Suite for Responsive Web Development
666 lines (665 loc) • 28.8 kB
JavaScript
/**
* DevExtreme (esm/ui/file_manager/ui.file_manager.js)
* Version: 21.1.4
* Build date: Mon Jun 21 2021
*
* Copyright (c) 2012 - 2021 Developer Express Inc. ALL RIGHTS RESERVED
* Read about DevExtreme licensing here: https://js.devexpress.com/Licensing/
*/
import $ from "../../core/renderer";
import eventsEngine from "../../events/core/events_engine";
import {
extend
} from "../../core/utils/extend";
import {
isFunction
} from "../../core/utils/type";
import {
when
} from "../../core/utils/deferred";
import {
ensureDefined,
equalByValue
} from "../../core/utils/common";
import messageLocalization from "../../localization/message";
import registerComponent from "../../core/component_registrator";
import Widget from "../widget/ui.widget";
import notify from "../notify";
import {
findItemsByKeys,
extendAttributes
} from "./ui.file_manager.common";
import FileItemsController from "./file_items_controller";
import {
FileManagerCommandManager
} from "./ui.file_manager.command_manager";
import FileManagerContextMenu from "./ui.file_manager.context_menu";
import FileManagerFilesTreeView from "./ui.file_manager.files_tree_view";
import FileManagerDetailsItemList from "./ui.file_manager.item_list.details";
import FileManagerThumbnailsItemList from "./ui.file_manager.item_list.thumbnails";
import FileManagerToolbar from "./ui.file_manager.toolbar";
import FileManagerNotificationControl from "./ui.file_manager.notification";
import FileManagerEditingControl from "./ui.file_manager.editing";
import FileManagerBreadcrumbs from "./ui.file_manager.breadcrumbs";
import FileManagerAdaptivityControl from "./ui.file_manager.adaptivity";
var FILE_MANAGER_CLASS = "dx-filemanager";
var FILE_MANAGER_WRAPPER_CLASS = FILE_MANAGER_CLASS + "-wrapper";
var FILE_MANAGER_CONTAINER_CLASS = FILE_MANAGER_CLASS + "-container";
var FILE_MANAGER_DIRS_PANEL_CLASS = FILE_MANAGER_CLASS + "-dirs-panel";
var FILE_MANAGER_INACTIVE_AREA_CLASS = FILE_MANAGER_CLASS + "-inactive-area";
var FILE_MANAGER_EDITING_CONTAINER_CLASS = FILE_MANAGER_CLASS + "-editing-container";
var FILE_MANAGER_ITEMS_PANEL_CLASS = FILE_MANAGER_CLASS + "-items-panel";
var FILE_MANAGER_ITEM_CUSTOM_THUMBNAIL_CLASS = FILE_MANAGER_CLASS + "-item-custom-thumbnail";
var PARENT_DIRECTORY_KEY_PREFIX = "[*DXPDK*]$40F96F03-FBD8-43DF-91BE-F55F4B8BA871$";
var VIEW_AREAS = {
folders: "navPane",
items: "itemView"
};
class FileManager extends Widget {
_initTemplates() {}
_init() {
super._init();
this._controller = new FileItemsController({
currentPath: this.option("currentPath"),
currentPathKeys: this.option("currentPathKeys"),
rootText: this.option("rootFolderName"),
fileProvider: this.option("fileSystemProvider"),
allowedFileExtensions: this.option("allowedFileExtensions"),
uploadMaxFileSize: this.option("upload").maxFileSize,
uploadChunkSize: this.option("upload").chunkSize,
onInitialized: this._onControllerInitialized.bind(this),
onDataLoading: this._onDataLoading.bind(this),
onSelectedDirectoryChanged: this._onSelectedDirectoryChanged.bind(this)
})
}
_initMarkup() {
super._initMarkup();
this._initActions();
this._firstItemViewLoad = true;
this._lockSelectionProcessing = false;
this._lockFocusedItemProcessing = false;
this._itemKeyToFocus = void 0;
this._commandManager = new FileManagerCommandManager(this.option("permissions"));
this.$element().addClass(FILE_MANAGER_CLASS);
this._createNotificationControl();
this._initCommandManager();
this._setItemsViewAreaActive(false)
}
_createNotificationControl() {
var $notificationControl = $("<div>").addClass("dx-filemanager-notification-container").appendTo(this.$element());
this._notificationControl = this._createComponent($notificationControl, FileManagerNotificationControl, {
progressPanelContainer: this.$element(),
contentTemplate: (container, notificationControl) => this._createWrapper(container, notificationControl),
onActionProgress: e => this._onActionProgress(e),
positionTarget: ".".concat(FILE_MANAGER_CONTAINER_CLASS),
showProgressPanel: this.option("notifications.showPanel"),
showNotificationPopup: this.option("notifications.showPopup")
})
}
_createWrapper(container, notificationControl) {
this._$wrapper = $("<div>").addClass(FILE_MANAGER_WRAPPER_CLASS).appendTo(container);
this._createEditing(notificationControl);
var $toolbar = $("<div>").appendTo(this._$wrapper);
this._toolbar = this._createComponent($toolbar, FileManagerToolbar, {
commandManager: this._commandManager,
generalItems: this.option("toolbar.items"),
fileItems: this.option("toolbar.fileSelectionItems"),
itemViewMode: this.option("itemView").mode,
onItemClick: args => this._actions.onToolbarItemClick(args)
});
this._createAdaptivityControl()
}
_createAdaptivityControl() {
var $container = $("<div>").addClass(FILE_MANAGER_CONTAINER_CLASS).appendTo(this._$wrapper);
this._adaptivityControl = this._createComponent($container, FileManagerAdaptivityControl, {
drawerTemplate: container => this._createFilesTreeView(container),
contentTemplate: container => this._createItemsPanel(container),
onAdaptiveStateChanged: e => this._onAdaptiveStateChanged(e)
})
}
_createEditing(notificationControl) {
var $editingContainer = $("<div>").addClass(FILE_MANAGER_EDITING_CONTAINER_CLASS).appendTo(this.$element());
this._editing = this._createComponent($editingContainer, FileManagerEditingControl, {
controller: this._controller,
model: {
getMultipleSelectedItems: this._getMultipleSelectedItems.bind(this)
},
getItemThumbnail: this._getItemThumbnailInfo.bind(this),
notificationControl: notificationControl,
uploadDropZonePlaceholderContainer: this.$element(),
rtlEnabled: this.option("rtlEnabled"),
onSuccess: _ref => {
var {
updatedOnlyFiles: updatedOnlyFiles
} = _ref;
return this._redrawComponent(updatedOnlyFiles)
},
onCreating: () => this._setItemsViewAreaActive(false),
onError: e => this._onEditingError(e)
})
}
_createItemsPanel($container) {
this._$itemsPanel = $("<div>").addClass(FILE_MANAGER_ITEMS_PANEL_CLASS).appendTo($container);
this._createBreadcrumbs(this._$itemsPanel);
this._createItemView(this._$itemsPanel);
if (this._commandManager.isCommandAvailable("upload")) {
this._editing.setUploaderDropZone(this._$itemsPanel)
}
}
_createFilesTreeView(container) {
this._filesTreeViewContextMenu = this._createContextMenu(false, VIEW_AREAS.folders);
var $filesTreeView = $("<div>").addClass(FILE_MANAGER_DIRS_PANEL_CLASS).appendTo(container);
this._filesTreeView = this._createComponent($filesTreeView, FileManagerFilesTreeView, {
storeExpandedState: true,
contextMenu: this._filesTreeViewContextMenu,
getDirectories: this.getDirectories.bind(this),
getCurrentDirectory: this._getCurrentDirectory.bind(this),
onDirectoryClick: this._onFilesTreeViewDirectoryClick.bind(this),
onClick: () => this._setItemsViewAreaActive(false)
});
this._filesTreeView.updateCurrentDirectory()
}
_createItemView($container, viewMode) {
this._itemViewContextMenu = this._createContextMenu(true, VIEW_AREAS.items);
var itemViewOptions = this.option("itemView");
var options = {
selectionMode: this.option("selectionMode"),
selectedItemKeys: this.option("selectedItemKeys"),
focusedItemKey: this.option("focusedItemKey"),
contextMenu: this._itemViewContextMenu,
getItems: this._getItemViewItems.bind(this),
onError: _ref2 => {
var {
error: error
} = _ref2;
return this._showError(error)
},
onSelectionChanged: this._onItemViewSelectionChanged.bind(this),
onFocusedItemChanged: this._onItemViewFocusedItemChanged.bind(this),
onSelectedItemOpened: this._onSelectedItemOpened.bind(this),
onContextMenuShowing: e => this._onContextMenuShowing(VIEW_AREAS.items, e),
getItemThumbnail: this._getItemThumbnailInfo.bind(this),
customizeDetailColumns: this.option("customizeDetailColumns"),
detailColumns: this.option("itemView.details.columns")
};
var $itemView = $("<div>").appendTo($container);
viewMode = viewMode || itemViewOptions.mode;
var widgetClass = "thumbnails" === viewMode ? FileManagerThumbnailsItemList : FileManagerDetailsItemList;
this._itemView = this._createComponent($itemView, widgetClass, options);
eventsEngine.on($itemView, "click", this._onItemViewClick.bind(this))
}
_createBreadcrumbs($container) {
var $breadcrumbs = $("<div>").appendTo($container);
this._breadcrumbs = this._createComponent($breadcrumbs, FileManagerBreadcrumbs, {
rootFolderDisplayName: this.option("rootFolderName"),
onCurrentDirectoryChanging: _ref3 => {
var {
currentDirectory: currentDirectory
} = _ref3;
return this._setCurrentDirectory(currentDirectory, true)
}
});
this._breadcrumbs.setCurrentDirectory(this._getCurrentDirectory())
}
_createContextMenu(isolateCreationItemCommands, viewArea) {
var $contextMenu = $("<div>").appendTo(this._$wrapper);
return this._createComponent($contextMenu, FileManagerContextMenu, {
commandManager: this._commandManager,
items: this.option("contextMenu.items"),
onItemClick: args => this._actions.onContextMenuItemClick(args),
onContextMenuShowing: e => this._onContextMenuShowing(viewArea, e),
isolateCreationItemCommands: isolateCreationItemCommands,
viewArea: viewArea
})
}
_initCommandManager() {
var actions = extend(this._editing.getCommandActions(), {
refresh: () => this._refreshAndShowProgress(),
thumbnails: () => this.option("itemView.mode", "thumbnails"),
details: () => this.option("itemView.mode", "details"),
clearSelection: () => this._clearSelection(),
showNavPane: () => this._adaptivityControl.toggleDrawer()
});
this._commandManager.registerActions(actions)
}
_onFilesTreeViewDirectoryClick(_ref4) {
var {
itemData: itemData
} = _ref4;
this._setCurrentDirectory(itemData);
this._setItemsViewAreaActive(false)
}
_onItemViewSelectionChanged(_ref5) {
var {
selectedItemInfos: selectedItemInfos,
selectedItems: selectedItems,
selectedItemKeys: selectedItemKeys,
currentSelectedItemKeys: currentSelectedItemKeys,
currentDeselectedItemKeys: currentDeselectedItemKeys
} = _ref5;
this._lockSelectionProcessing = true;
this.option("selectedItemKeys", selectedItemKeys);
this._lockSelectionProcessing = false;
this._actions.onSelectionChanged({
selectedItems: selectedItems,
selectedItemKeys: selectedItemKeys,
currentSelectedItemKeys: currentSelectedItemKeys,
currentDeselectedItemKeys: currentDeselectedItemKeys
});
this._updateToolbar(selectedItemInfos);
this._setItemsViewAreaActive(true)
}
_onItemViewFocusedItemChanged(e) {
this._lockFocusedItemProcessing = true;
this.option("focusedItemKey", e.itemKey);
this._lockFocusedItemProcessing = false;
this._actions.onFocusedItemChanged({
item: e.item,
itemElement: e.itemElement
})
}
_onAdaptiveStateChanged(_ref6) {
var {
enabled: enabled
} = _ref6;
this._commandManager.setCommandEnabled("showNavPane", enabled);
this._updateToolbar()
}
_onActionProgress(_ref7) {
var {
message: message,
status: status
} = _ref7;
this._toolbar.updateRefreshItem(message, status);
this._updateToolbar()
}
_onEditingError(e) {
var args = extendAttributes({}, e, ["errorCode", "errorText", "fileSystemItem"]);
this._actions.onErrorOccurred(args);
e.errorText = args.errorText
}
_refreshAndShowProgress() {
return when(this._notificationControl.tryShowProgressPanel(), this._controller.refresh()).then(() => this._filesTreeView.refresh())
}
_updateToolbar(selectedItems) {
var items = selectedItems || this._getSelectedItemInfos();
this._toolbar.update(items)
}
_setItemsViewAreaActive(active) {
if (this._itemsViewAreaActive === active) {
return
}
this._itemsViewAreaActive = active;
var $activeArea = null;
var $inactiveArea = null;
if (active) {
$activeArea = this._itemView.$element();
$inactiveArea = this._filesTreeView.$element()
} else {
$activeArea = this._filesTreeView.$element();
$inactiveArea = this._itemView.$element()
}
$activeArea.removeClass(FILE_MANAGER_INACTIVE_AREA_CLASS);
$inactiveArea.addClass(FILE_MANAGER_INACTIVE_AREA_CLASS)
}
_switchView(viewMode) {
this._disposeWidget(this._itemView.option("contextMenu"));
this._disposeWidget(this._itemView);
this._createItemView(this._$itemsPanel, viewMode);
this._toolbar.option({
itemViewMode: viewMode
})
}
_disposeWidget(widget) {
widget.dispose();
widget.$element().remove()
}
_clearSelection() {
this._itemView.clearSelection()
}
_getMultipleSelectedItems() {
return this._itemsViewAreaActive ? this._getSelectedItemInfos() : [this._getCurrentDirectory()]
}
_showError(message) {
this._showNotification(message, false)
}
_showNotification(message, isSuccess) {
notify({
message: message,
width: 450
}, isSuccess ? "success" : "error", 5e3)
}
_redrawComponent(onlyFileItemsView) {
this._itemView.refresh().then(() => !onlyFileItemsView && this._filesTreeView.refresh())
}
_getItemViewItems() {
var showFolders = this.option("itemView").showFolders;
var result = this._controller.getCurrentItems(!showFolders);
this._updateToolbarWithSelectionOnFirstLoad(result);
if (this.option("itemView.showParentFolder")) {
result = when(result).then(items => this._getPreparedItemViewItems(items))
}
return result
}
_updateToolbarWithSelectionOnFirstLoad(itemsResult) {
if (!this._firstItemViewLoad) {
return
}
this._firstItemViewLoad = false;
var selectedItemKeys = this.option("selectedItemKeys");
if (selectedItemKeys.length > 0) {
when(itemsResult).done(items => {
var selectedItems = findItemsByKeys(items, selectedItemKeys);
if (selectedItems.length > 0) {
this._updateToolbar(selectedItems)
}
})
}
}
_getPreparedItemViewItems(items) {
var selectedDir = this._getCurrentDirectory();
if (selectedDir.fileItem.isRoot()) {
return items
}
var parentDirItem = selectedDir.fileItem.createClone();
parentDirItem.isParentFolder = true;
parentDirItem.name = "..";
parentDirItem.relativeName = "..";
parentDirItem.key = "".concat(PARENT_DIRECTORY_KEY_PREFIX).concat(selectedDir.fileItem.key);
var itemsCopy = [...items];
itemsCopy.unshift({
fileItem: parentDirItem,
icon: "parentfolder"
});
return itemsCopy
}
_onItemViewClick() {
this._setItemsViewAreaActive(true)
}
_onContextMenuShowing(viewArea, e) {
var _e$itemData;
this._setItemsViewAreaActive(viewArea === VIEW_AREAS.items);
var eventArgs = extendAttributes({}, e, ["targetElement", "cancel", "event"]);
eventArgs = extend(eventArgs, {
viewArea: viewArea,
fileSystemItem: null === (_e$itemData = e.itemData) || void 0 === _e$itemData ? void 0 : _e$itemData.fileItem,
_isActionButton: e.isActionButton
});
this._actions.onContextMenuShowing(eventArgs);
e.cancel = ensureDefined(eventArgs.cancel, false)
}
_getItemThumbnailInfo(fileInfo) {
var func = this.option("customizeThumbnail");
var thumbnail = isFunction(func) ? func(fileInfo.fileItem) : fileInfo.fileItem.thumbnail;
if (thumbnail) {
return {
thumbnail: thumbnail,
cssClass: FILE_MANAGER_ITEM_CUSTOM_THUMBNAIL_CLASS
}
}
return {
thumbnail: fileInfo.icon
}
}
_getDefaultOptions() {
return extend(super._getDefaultOptions(), {
fileSystemProvider: null,
currentPath: "",
currentPathKeys: [],
rootFolderName: messageLocalization.format("dxFileManager-rootDirectoryName"),
selectionMode: "multiple",
selectedItemKeys: [],
focusedItemKey: void 0,
toolbar: {
items: ["showNavPane", "create", "upload", "switchView", {
name: "separator",
location: "after"
}, "refresh"],
fileSelectionItems: ["download", "separator", "move", "copy", "rename", "separator", "delete", "clearSelection", {
name: "separator",
location: "after"
}, "refresh"]
},
contextMenu: {
items: ["create", "upload", "rename", "move", "copy", "delete", "refresh", "download"]
},
itemView: {
details: {
columns: ["thumbnail", "name", "dateModified", "size"]
},
mode: "details",
showFolders: true,
showParentFolder: true
},
customizeThumbnail: null,
customizeDetailColumns: null,
onContextMenuItemClick: null,
onContextMenuShowing: null,
onCurrentDirectoryChanged: null,
onSelectedFileOpened: null,
onSelectionChanged: null,
onFocusedItemChanged: null,
onToolbarItemClick: null,
onErrorOccurred: null,
allowedFileExtensions: [],
upload: {
maxFileSize: 0,
chunkSize: 2e5
},
permissions: {
create: false,
copy: false,
move: false,
delete: false,
rename: false,
upload: false,
download: false
},
notifications: {
showPanel: true,
showPopup: true
}
})
}
_optionChanged(args) {
var name = args.name;
switch (name) {
case "currentPath":
this._controller.setCurrentPath(args.value);
break;
case "currentPathKeys":
this._controller.setCurrentPathByKeys(args.value);
break;
case "selectedItemKeys":
if (!this._lockSelectionProcessing && this._itemView) {
this._itemView.option("selectedItemKeys", args.value)
}
break;
case "focusedItemKey":
if (!this._lockFocusedItemProcessing && this._itemView) {
this._itemView.option("focusedItemKey", args.value)
}
break;
case "rootFolderName":
this._controller.setRootText(args.value);
this.repaint();
break;
case "fileSystemProvider":
this._controller.updateProvider(args.value, this.option("currentPath")).then(() => this.repaint());
break;
case "allowedFileExtensions":
this._controller.setAllowedFileExtensions(args.value);
this.repaint();
break;
case "upload":
this._controller.setUploadOptions(this.option("upload"));
this.repaint();
break;
case "permissions":
case "selectionMode":
case "customizeThumbnail":
case "customizeDetailColumns":
this.repaint();
break;
case "itemView":
if ("itemView.mode" === args.fullName) {
this._switchView(args.value)
} else {
this.repaint()
}
break;
case "toolbar":
var toolbarOptions = {};
if ("toolbar" === args.fullName) {
if (args.value.items) {
toolbarOptions.generalItems = args.value.items
}
if (args.value.fileSelectionItems) {
toolbarOptions.fileItems = args.value.fileSelectionItems
}
}
if (0 === args.fullName.indexOf("toolbar.items")) {
toolbarOptions.generalItems = this.option("toolbar.items")
}
if (0 === args.fullName.indexOf("toolbar.fileSelectionItems")) {
toolbarOptions.fileItems = this.option("toolbar.fileSelectionItems")
}
this._toolbar.option(toolbarOptions);
break;
case "contextMenu":
if ("contextMenu" === args.fullName && args.value.items || 0 === args.fullName.indexOf("contextMenu.items")) {
var contextMenuItems = this.option("contextMenu.items");
this._filesTreeViewContextMenu.option("items", contextMenuItems);
this._itemViewContextMenu.option("items", contextMenuItems)
}
break;
case "notifications":
this._notificationControl.option("showProgressPanel", this.option("notifications.showPanel"));
this._notificationControl.option("showNotificationPopup", this.option("notifications.showPopup"));
break;
case "onContextMenuItemClick":
case "onContextMenuShowing":
case "onCurrentDirectoryChanged":
case "onSelectedFileOpened":
case "onSelectionChanged":
case "onFocusedItemChanged":
case "onToolbarItemClick":
case "onErrorOccurred":
this._actions[name] = this._createActionByOption(name);
break;
case "rtlEnabled":
this._editing.updateDialogRtl(args.value);
super._optionChanged(args);
break;
default:
super._optionChanged(args)
}
}
_initActions() {
this._actions = {
onContextMenuItemClick: this._createActionByOption("onContextMenuItemClick"),
onContextMenuShowing: this._createActionByOption("onContextMenuShowing"),
onCurrentDirectoryChanged: this._createActionByOption("onCurrentDirectoryChanged"),
onSelectedFileOpened: this._createActionByOption("onSelectedFileOpened"),
onSelectionChanged: this._createActionByOption("onSelectionChanged"),
onFocusedItemChanged: this._createActionByOption("onFocusedItemChanged"),
onToolbarItemClick: this._createActionByOption("onToolbarItemClick"),
onErrorOccurred: this._createActionByOption("onErrorOccurred")
}
}
executeCommand(commandName) {
return this._commandManager.executeCommand(commandName)
}
_setCurrentDirectory(directoryInfo, checkActuality) {
this._controller.setCurrentDirectory(directoryInfo, checkActuality)
}
_getCurrentDirectory() {
return this._controller.getCurrentDirectory()
}
_onControllerInitialized(_ref8) {
var {
controller: controller
} = _ref8;
this._controller = this._controller || controller;
var currentDirectory = controller.getCurrentDirectory();
if (!currentDirectory.fileItem.isRoot()) {
this._syncToCurrentDirectory()
}
}
_onDataLoading(_ref9) {
var {
operation: operation
} = _ref9;
var options = null;
if ("navigation" === operation) {
options = {
focusedItemKey: this._itemKeyToFocus
};
this._itemKeyToFocus = void 0
}
this._itemView.refresh(options)
}
_onSelectedDirectoryChanged() {
var currentDirectory = this._getCurrentDirectory();
this._syncToCurrentDirectory();
this._actions.onCurrentDirectoryChanged({
directory: currentDirectory.fileItem
})
}
_syncToCurrentDirectory() {
var currentDirectory = this._getCurrentDirectory();
var currentPath = this._controller.getCurrentPath();
var currentPathKeys = currentDirectory.fileItem.pathKeys;
if (this._filesTreeView) {
this._filesTreeView.updateCurrentDirectory()
}
if (this._breadcrumbs) {
this._breadcrumbs.setCurrentDirectory(currentDirectory)
}
var options = {
currentPath: currentPath
};
if (!equalByValue(this.option("currentPathKeys"), currentPathKeys)) {
options.currentPathKeys = currentPathKeys
}
this.option(options)
}
getDirectories(parentDirectoryInfo, skipNavigationOnError) {
return this._controller.getDirectories(parentDirectoryInfo, skipNavigationOnError)
}
_getSelectedItemInfos() {
return this._itemView ? this._itemView.getSelectedItems() : []
}
refresh() {
return this.executeCommand("refresh")
}
getCurrentDirectory() {
var directoryInfo = this._getCurrentDirectory();
return directoryInfo && directoryInfo.fileItem || null
}
getSelectedItems() {
return this._getSelectedItemInfos().map(itemInfo => itemInfo.fileItem)
}
_onSelectedItemOpened(_ref10) {
var {
fileItemInfo: fileItemInfo
} = _ref10;
var fileItem = fileItemInfo.fileItem;
if (!fileItem.isDirectory) {
this._actions.onSelectedFileOpened({
file: fileItem
});
return
}
if (fileItem.isParentFolder) {
this._itemKeyToFocus = this._getCurrentDirectory().fileItem.key
}
var newCurrentDirectory = fileItem.isParentFolder ? this._getCurrentDirectory().parentDirectory : fileItemInfo;
this._setCurrentDirectory(newCurrentDirectory);
if (newCurrentDirectory) {
this._filesTreeView.toggleDirectoryExpandedState(newCurrentDirectory.parentDirectory, true)
}
}
}
registerComponent("dxFileManager", FileManager);
export default FileManager;