/*--------------------------------------------------------------------------------------------- * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the Source EULA. See License.txt in the project root for license information. *--------------------------------------------------------------------------------------------*/ import { hasWorkspaceFileExtension, IWorkspaceFolderCreationData, IRecentFile, IWorkspacesService } from 'vs/platform/workspaces/common/workspaces'; import { normalize } from 'vs/base/common/path'; import { basename, extUri } from 'vs/base/common/resources'; import { IFileService } from 'vs/platform/files/common/files'; import { IWindowOpenable } from 'vs/platform/windows/common/windows'; import { URI } from 'vs/base/common/uri'; import { ITextFileService, stringToSnapshot } from 'vs/workbench/services/textfile/common/textfiles'; import { Schemas } from 'vs/base/common/network'; import { ITextEditorOptions } from 'vs/platform/editor/common/editor'; import { DataTransfers, IDragAndDropData } from 'vs/base/browser/dnd'; import { DragMouseEvent } from 'vs/base/browser/mouseEvent'; import { normalizeDriveLetter } from 'vs/base/common/labels'; import { MIME_BINARY } from 'vs/base/common/mime'; import { isWindows, isWeb } from 'vs/base/common/platform'; import { ServicesAccessor } from 'vs/platform/instantiation/common/instantiation'; import { isCodeEditor } from 'vs/editor/browser/editorBrowser'; import { IEditorIdentifier, GroupIdentifier } from 'vs/workbench/common/editor'; import { IEditorService, IResourceEditorInputType } from 'vs/workbench/services/editor/common/editorService'; import { Disposable, IDisposable, DisposableStore } from 'vs/base/common/lifecycle'; import { addDisposableListener, EventType, asDomUri } from 'vs/base/browser/dom'; import { IEditorGroup } from 'vs/workbench/services/editor/common/editorGroupsService'; import { IWorkspaceEditingService } from 'vs/workbench/services/workspaces/common/workspaceEditing'; import { withNullAsUndefined } from 'vs/base/common/types'; import { IHostService } from 'vs/workbench/services/host/browser/host'; import { isStandalone } from 'vs/base/browser/browser'; import { IBackupFileService } from 'vs/workbench/services/backup/common/backup'; import { Emitter } from 'vs/base/common/event'; export interface IDraggedResource { resource: URI; isExternal: boolean; } interface ISerializedDraggedResource { resource: string; } export class DraggedEditorIdentifier { constructor(public readonly identifier: IEditorIdentifier) { } } export class DraggedEditorGroupIdentifier { constructor(public readonly identifier: GroupIdentifier) { } } interface IDraggedEditorProps { dirtyContent?: string; encoding?: string; mode?: string; options?: ITextEditorOptions; } export interface IDraggedEditor extends IDraggedResource, IDraggedEditorProps { } export interface ISerializedDraggedEditor extends ISerializedDraggedResource, IDraggedEditorProps { } export const CodeDataTransfers = { EDITORS: 'CodeEditors', FILES: 'CodeFiles' }; export function extractResources(e: DragEvent, externalOnly?: boolean): Array { const resources: Array = []; if (e.dataTransfer && e.dataTransfer.types.length > 0) { // Check for window-to-window DND if (!externalOnly) { // Data Transfer: Code Editors const rawEditorsData = e.dataTransfer.getData(CodeDataTransfers.EDITORS); if (rawEditorsData) { try { const draggedEditors: ISerializedDraggedEditor[] = JSON.parse(rawEditorsData); draggedEditors.forEach(draggedEditor => { resources.push({ resource: URI.parse(draggedEditor.resource), dirtyContent: draggedEditor.dirtyContent, options: draggedEditor.options, encoding: draggedEditor.encoding, mode: draggedEditor.mode, isExternal: false }); }); } catch (error) { // Invalid transfer } } // Data Transfer: Resources else { try { const rawResourcesData = e.dataTransfer.getData(DataTransfers.RESOURCES); if (rawResourcesData) { const uriStrArray: string[] = JSON.parse(rawResourcesData); resources.push(...uriStrArray.map(uriStr => ({ resource: URI.parse(uriStr), isExternal: false }))); } } catch (error) { // Invalid transfer } } } // Check for native file transfer if (e.dataTransfer && e.dataTransfer.files) { for (let i = 0; i < e.dataTransfer.files.length; i++) { const file = e.dataTransfer.files[i]; if (file?.path /* Electron only */ && !resources.some(r => r.resource.fsPath === file.path) /* prevent duplicates */) { try { resources.push({ resource: URI.file(file.path), isExternal: true }); } catch (error) { // Invalid URI } } } } // Check for CodeFiles transfer const rawCodeFiles = e.dataTransfer.getData(CodeDataTransfers.FILES); if (rawCodeFiles) { try { const codeFiles: string[] = JSON.parse(rawCodeFiles); codeFiles.forEach(codeFile => { if (!resources.some(r => r.resource.fsPath === codeFile) /* prevent duplicates */) { resources.push({ resource: URI.file(codeFile), isExternal: true }); } }); } catch (error) { // Invalid transfer } } } return resources; } export interface IResourcesDropHandlerOptions { /** * Whether to open the actual workspace when a workspace configuration file is dropped * or whether to open the configuration file within the editor as normal file. */ allowWorkspaceOpen: boolean; } /** * Shared function across some components to handle drag & drop of resources. E.g. of folders and workspace files * to open them in the window instead of the editor or to handle dirty editors being dropped between instances of Code. */ export class ResourcesDropHandler { constructor( private options: IResourcesDropHandlerOptions, @IFileService private readonly fileService: IFileService, @IWorkspacesService private readonly workspacesService: IWorkspacesService, @ITextFileService private readonly textFileService: ITextFileService, @IBackupFileService private readonly backupFileService: IBackupFileService, @IEditorService private readonly editorService: IEditorService, @IWorkspaceEditingService private readonly workspaceEditingService: IWorkspaceEditingService, @IHostService private readonly hostService: IHostService ) { } async handleDrop(event: DragEvent, resolveTargetGroup: () => IEditorGroup | undefined, afterDrop: (targetGroup: IEditorGroup | undefined) => void, targetIndex?: number): Promise { const untitledOrFileResources = extractResources(event).filter(r => this.fileService.canHandleResource(r.resource) || r.resource.scheme === Schemas.untitled); if (!untitledOrFileResources.length) { return; } // Make the window active to handle the drop properly within await this.hostService.focus(); // Check for special things being dropped const isWorkspaceOpening = await this.doHandleDrop(untitledOrFileResources); if (isWorkspaceOpening) { return; // return early if the drop operation resulted in this window changing to a workspace } // Add external ones to recently open list unless dropped resource is a workspace const recentFiles: IRecentFile[] = untitledOrFileResources.filter(untitledOrFileResource => untitledOrFileResource.isExternal && untitledOrFileResource.resource.scheme === Schemas.file).map(d => ({ fileUri: d.resource })); if (recentFiles.length) { this.workspacesService.addRecentlyOpened(recentFiles); } const editors: IResourceEditorInputType[] = untitledOrFileResources.map(untitledOrFileResource => ({ resource: untitledOrFileResource.resource, encoding: (untitledOrFileResource as IDraggedEditor).encoding, mode: (untitledOrFileResource as IDraggedEditor).mode, options: { ...(untitledOrFileResource as IDraggedEditor).options, pinned: true, index: targetIndex } })); // Open in Editor const targetGroup = resolveTargetGroup(); await this.editorService.openEditors(editors, targetGroup); // Finish with provided function afterDrop(targetGroup); } private async doHandleDrop(untitledOrFileResources: Array): Promise { // Check for dirty editors being dropped const dirtyEditors: IDraggedEditor[] = untitledOrFileResources.filter(untitledOrFileResource => !untitledOrFileResource.isExternal && typeof (untitledOrFileResource as IDraggedEditor).dirtyContent === 'string'); if (dirtyEditors.length > 0) { await Promise.all(dirtyEditors.map(dirtyEditor => this.handleDirtyEditorDrop(dirtyEditor))); return false; } // Check for workspace file being dropped if we are allowed to do so if (this.options.allowWorkspaceOpen) { const externalFileOnDiskResources = untitledOrFileResources.filter(untitledOrFileResource => untitledOrFileResource.isExternal && untitledOrFileResource.resource.scheme === Schemas.file).map(d => d.resource); if (externalFileOnDiskResources.length > 0) { return this.handleWorkspaceFileDrop(externalFileOnDiskResources); } } return false; } private async handleDirtyEditorDrop(droppedDirtyEditor: IDraggedEditor): Promise { // Untitled: always ensure that we open a new untitled editor for each file we drop if (droppedDirtyEditor.resource.scheme === Schemas.untitled) { const untitledEditorResource = this.editorService.createEditorInput({ mode: droppedDirtyEditor.mode, encoding: droppedDirtyEditor.encoding, forceUntitled: true }).resource; if (untitledEditorResource) { droppedDirtyEditor.resource = untitledEditorResource; } } // File: ensure the file is not dirty or opened already else if (this.textFileService.isDirty(droppedDirtyEditor.resource) || this.editorService.isOpen({ resource: droppedDirtyEditor.resource })) { return false; } // If the dropped editor is dirty with content we simply take that // content and turn it into a backup so that it loads the contents if (typeof droppedDirtyEditor.dirtyContent === 'string') { try { await this.backupFileService.backup(droppedDirtyEditor.resource, stringToSnapshot(droppedDirtyEditor.dirtyContent)); } catch (e) { // Ignore error } } return false; } private async handleWorkspaceFileDrop(fileOnDiskResources: URI[]): Promise { const toOpen: IWindowOpenable[] = []; const folderURIs: IWorkspaceFolderCreationData[] = []; await Promise.all(fileOnDiskResources.map(async fileOnDiskResource => { // Check for Workspace if (hasWorkspaceFileExtension(fileOnDiskResource)) { toOpen.push({ workspaceUri: fileOnDiskResource }); return; } // Check for Folder try { const stat = await this.fileService.resolve(fileOnDiskResource); if (stat.isDirectory) { toOpen.push({ folderUri: stat.resource }); folderURIs.push({ uri: stat.resource }); } } catch (error) { // Ignore error } })); // Return early if no external resource is a folder or workspace if (toOpen.length === 0) { return false; } // Pass focus to window this.hostService.focus(); // Open in separate windows if we drop workspaces or just one folder if (toOpen.length > folderURIs.length || folderURIs.length === 1) { await this.hostService.openWindow(toOpen); } // folders.length > 1: Multiple folders: Create new workspace with folders and open else { await this.workspaceEditingService.createAndEnterWorkspace(folderURIs); } return true; } } export function fillResourceDataTransfers(accessor: ServicesAccessor, resources: (URI | { resource: URI, isDirectory: boolean })[], optionsCallback: ((resource: URI) => ITextEditorOptions) | undefined, event: DragMouseEvent | DragEvent): void { if (resources.length === 0 || !event.dataTransfer) { return; } const sources = resources.map(obj => { if (URI.isUri(obj)) { return { resource: obj, isDirectory: false /* assume resource is not a directory */ }; } return obj; }); // Text: allows to paste into text-capable areas const lineDelimiter = isWindows ? '\r\n' : '\n'; event.dataTransfer.setData(DataTransfers.TEXT, sources.map(source => source.resource.scheme === Schemas.file ? normalize(normalizeDriveLetter(source.resource.fsPath)) : source.resource.toString()).join(lineDelimiter)); // Download URL: enables support to drag a tab as file to desktop (only single file supported) // Disabled for PWA web due to: https://github.com/microsoft/vscode/issues/83441 if (!sources[0].isDirectory && (!isWeb || !isStandalone)) { event.dataTransfer.setData(DataTransfers.DOWNLOAD_URL, [MIME_BINARY, basename(sources[0].resource), asDomUri(sources[0].resource).toString()].join(':')); } // Resource URLs: allows to drop multiple resources to a target in VS Code (not directories) const files = sources.filter(source => !source.isDirectory); if (files.length) { event.dataTransfer.setData(DataTransfers.RESOURCES, JSON.stringify(files.map(file => file.resource.toString()))); } // Editors: enables cross window DND of tabs into the editor area const textFileService = accessor.get(ITextFileService); const editorService = accessor.get(IEditorService); const draggedEditors: ISerializedDraggedEditor[] = []; files.forEach(file => { let options: ITextEditorOptions | undefined = undefined; // Use provided callback for editor options if (typeof optionsCallback === 'function') { options = optionsCallback(file.resource); } // Otherwise try to figure out the view state from opened editors that match else { options = { viewState: (() => { const textEditorControls = editorService.visibleTextEditorControls; for (const textEditorControl of textEditorControls) { if (isCodeEditor(textEditorControl)) { const model = textEditorControl.getModel(); if (extUri.isEqual(model?.uri, file.resource)) { return withNullAsUndefined(textEditorControl.saveViewState()); } } } return undefined; })() }; } // Try to find encoding and mode from text model let encoding: string | undefined = undefined; let mode: string | undefined = undefined; const model = file.resource.scheme === Schemas.untitled ? textFileService.untitled.get(file.resource) : textFileService.files.get(file.resource); if (model) { encoding = model.getEncoding(); mode = model.getMode(); } // If the resource is dirty or untitled, send over its content // to restore dirty state. Get that from the text model directly let dirtyContent: string | undefined = undefined; if (model?.isDirty()) { dirtyContent = model.textEditorModel.getValue(); } // Add as dragged editor draggedEditors.push({ resource: file.resource.toString(), dirtyContent, options, encoding, mode }); }); if (draggedEditors.length) { event.dataTransfer.setData(CodeDataTransfers.EDITORS, JSON.stringify(draggedEditors)); } } /** * A singleton to store transfer data during drag & drop operations that are only valid within the application. */ export class LocalSelectionTransfer { private static readonly INSTANCE = new LocalSelectionTransfer(); private data?: T[]; private proto?: T; private constructor() { // protect against external instantiation } static getInstance(): LocalSelectionTransfer { return LocalSelectionTransfer.INSTANCE as LocalSelectionTransfer; } hasData(proto: T): boolean { return proto && proto === this.proto; } clearData(proto: T): void { if (this.hasData(proto)) { this.proto = undefined; this.data = undefined; } } getData(proto: T): T[] | undefined { if (this.hasData(proto)) { return this.data; } return undefined; } setData(data: T[], proto: T): void { if (proto) { this.data = data; this.proto = proto; } } } export interface IDragAndDropObserverCallbacks { onDragEnter: (e: DragEvent) => void; onDragLeave: (e: DragEvent) => void; onDrop: (e: DragEvent) => void; onDragEnd: (e: DragEvent) => void; onDragOver?: (e: DragEvent) => void; } export class DragAndDropObserver extends Disposable { // A helper to fix issues with repeated DRAG_ENTER / DRAG_LEAVE // calls see https://github.com/Microsoft/vscode/issues/14470 // when the element has child elements where the events are fired // repeadedly. private counter: number = 0; constructor(private element: HTMLElement, private callbacks: IDragAndDropObserverCallbacks) { super(); this.registerListeners(); } private registerListeners(): void { this._register(addDisposableListener(this.element, EventType.DRAG_ENTER, (e: DragEvent) => { this.counter++; this.callbacks.onDragEnter(e); })); this._register(addDisposableListener(this.element, EventType.DRAG_OVER, (e: DragEvent) => { e.preventDefault(); // needed so that the drop event fires (https://stackoverflow.com/questions/21339924/drop-event-not-firing-in-chrome) if (this.callbacks.onDragOver) { this.callbacks.onDragOver(e); } })); this._register(addDisposableListener(this.element, EventType.DRAG_LEAVE, (e: DragEvent) => { this.counter--; if (this.counter === 0) { this.callbacks.onDragLeave(e); } })); this._register(addDisposableListener(this.element, EventType.DRAG_END, (e: DragEvent) => { this.counter = 0; this.callbacks.onDragEnd(e); })); this._register(addDisposableListener(this.element, EventType.DROP, (e: DragEvent) => { this.counter = 0; this.callbacks.onDrop(e); })); } } export function containsDragType(event: DragEvent, ...dragTypesToFind: string[]): boolean { if (!event.dataTransfer) { return false; } const dragTypes = event.dataTransfer.types; const lowercaseDragTypes: string[] = []; for (let i = 0; i < dragTypes.length; i++) { lowercaseDragTypes.push(dragTypes[i].toLowerCase()); // somehow the types are lowercase } for (const dragType of dragTypesToFind) { if (lowercaseDragTypes.indexOf(dragType.toLowerCase()) >= 0) { return true; } } return false; } export type Before2D = { verticallyBefore: boolean; horizontallyBefore: boolean; }; export interface ICompositeDragAndDrop { drop(data: IDragAndDropData, target: string | undefined, originalEvent: DragEvent, before?: Before2D): void; onDragOver(data: IDragAndDropData, target: string | undefined, originalEvent: DragEvent): boolean; onDragEnter(data: IDragAndDropData, target: string | undefined, originalEvent: DragEvent): boolean; } export interface ICompositeDragAndDropObserverCallbacks { onDragEnter?: (e: IDraggedCompositeData) => void; onDragLeave?: (e: IDraggedCompositeData) => void; onDrop?: (e: IDraggedCompositeData) => void; onDragOver?: (e: IDraggedCompositeData) => void; onDragStart?: (e: IDraggedCompositeData) => void; onDragEnd?: (e: IDraggedCompositeData) => void; } export class CompositeDragAndDropData implements IDragAndDropData { constructor(private type: 'view' | 'composite', private id: string) { } update(dataTransfer: DataTransfer): void { // no-op } getData(): { type: 'view' | 'composite'; id: string; } { return { type: this.type, id: this.id }; } } export interface IDraggedCompositeData { eventData: DragEvent; dragAndDropData: CompositeDragAndDropData; } export class DraggedCompositeIdentifier { constructor(private _compositeId: string) { } get id(): string { return this._compositeId; } } export class DraggedViewIdentifier { constructor(private _viewId: string) { } get id(): string { return this._viewId; } } export type ViewType = 'composite' | 'view'; export class CompositeDragAndDropObserver extends Disposable { private transferData: LocalSelectionTransfer; private _onDragStart = this._register(new Emitter()); private _onDragEnd = this._register(new Emitter()); private static _instance: CompositeDragAndDropObserver | undefined; static get INSTANCE(): CompositeDragAndDropObserver { if (!CompositeDragAndDropObserver._instance) { CompositeDragAndDropObserver._instance = new CompositeDragAndDropObserver(); } return CompositeDragAndDropObserver._instance; } private constructor() { super(); this.transferData = LocalSelectionTransfer.getInstance(); this._register(this._onDragEnd.event(e => { const id = e.dragAndDropData.getData().id; const type = e.dragAndDropData.getData().type; const data = this.readDragData(type); if (data && data.getData().id === id) { this.transferData.clearData(type === 'view' ? DraggedViewIdentifier.prototype : DraggedCompositeIdentifier.prototype); } })); } private readDragData(type: ViewType): CompositeDragAndDropData | undefined { if (this.transferData.hasData(type === 'view' ? DraggedViewIdentifier.prototype : DraggedCompositeIdentifier.prototype)) { const data = this.transferData.getData(type === 'view' ? DraggedViewIdentifier.prototype : DraggedCompositeIdentifier.prototype); if (data && data[0]) { return new CompositeDragAndDropData(type, data[0].id); } } return undefined; } private writeDragData(id: string, type: ViewType): void { this.transferData.setData([type === 'view' ? new DraggedViewIdentifier(id) : new DraggedCompositeIdentifier(id)], type === 'view' ? DraggedViewIdentifier.prototype : DraggedCompositeIdentifier.prototype); } registerTarget(element: HTMLElement, callbacks: ICompositeDragAndDropObserverCallbacks): IDisposable { const disposableStore = new DisposableStore(); disposableStore.add(new DragAndDropObserver(element, { onDragEnd: e => { // no-op }, onDragEnter: e => { e.preventDefault(); if (callbacks.onDragEnter) { const data = this.readDragData('composite') || this.readDragData('view'); if (data) { callbacks.onDragEnter({ eventData: e, dragAndDropData: data! }); } } }, onDragLeave: e => { const data = this.readDragData('composite') || this.readDragData('view'); if (callbacks.onDragLeave && data) { callbacks.onDragLeave({ eventData: e, dragAndDropData: data! }); } }, onDrop: e => { if (callbacks.onDrop) { const data = this.readDragData('composite') || this.readDragData('view'); if (!data) { return; } callbacks.onDrop({ eventData: e, dragAndDropData: data! }); // Fire drag event in case drop handler destroys the dragged element this._onDragEnd.fire({ eventData: e, dragAndDropData: data! }); } }, onDragOver: e => { e.preventDefault(); if (callbacks.onDragOver) { const data = this.readDragData('composite') || this.readDragData('view'); if (!data) { return; } callbacks.onDragOver({ eventData: e, dragAndDropData: data! }); } } })); if (callbacks.onDragStart) { this._onDragStart.event(e => { callbacks.onDragStart!(e); }, this, disposableStore); } if (callbacks.onDragEnd) { this._onDragEnd.event(e => { callbacks.onDragEnd!(e); }); } return this._register(disposableStore); } registerDraggable(element: HTMLElement, draggedItemProvider: () => { type: ViewType, id: string }, callbacks: ICompositeDragAndDropObserverCallbacks): IDisposable { element.draggable = true; const disposableStore = new DisposableStore(); disposableStore.add(addDisposableListener(element, EventType.DRAG_START, e => { const { id, type } = draggedItemProvider(); this.writeDragData(id, type); if (e.dataTransfer) { e.dataTransfer.setDragImage(element, 0, 0); } this._onDragStart.fire({ eventData: e, dragAndDropData: this.readDragData(type)! }); })); disposableStore.add(new DragAndDropObserver(element, { onDragEnd: e => { const { type } = draggedItemProvider(); const data = this.readDragData(type); if (!data) { return; } this._onDragEnd.fire({ eventData: e, dragAndDropData: data! }); }, onDragEnter: e => { if (callbacks.onDragEnter) { const data = this.readDragData('composite') || this.readDragData('view'); if (!data) { return; } if (data) { callbacks.onDragEnter({ eventData: e, dragAndDropData: data! }); } } }, onDragLeave: e => { const data = this.readDragData('composite') || this.readDragData('view'); if (!data) { return; } if (callbacks.onDragLeave) { callbacks.onDragLeave({ eventData: e, dragAndDropData: data! }); } }, onDrop: e => { if (callbacks.onDrop) { const data = this.readDragData('composite') || this.readDragData('view'); if (!data) { return; } callbacks.onDrop({ eventData: e, dragAndDropData: data! }); // Fire drag event in case drop handler destroys the dragged element this._onDragEnd.fire({ eventData: e, dragAndDropData: data! }); } }, onDragOver: e => { if (callbacks.onDragOver) { const data = this.readDragData('composite') || this.readDragData('view'); if (!data) { return; } callbacks.onDragOver({ eventData: e, dragAndDropData: data! }); } } })); if (callbacks.onDragStart) { this._onDragStart.event(e => { callbacks.onDragStart!(e); }, this, disposableStore); } if (callbacks.onDragEnd) { this._onDragEnd.event(e => { callbacks.onDragEnd!(e); }); } return this._register(disposableStore); } } export function toggleDropEffect(dataTransfer: DataTransfer | null, dropEffect: string, shouldHaveIt: boolean) { if (!dataTransfer) { return; } dataTransfer.dropEffect = shouldHaveIt ? dropEffect : 'none'; }