OpenSnapshotAction.java

/*******************************************************************************
 * Copyright (c) 2008, 2020 SAP AG and IBM Corporation.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    SAP AG - initial API and implementation
 *    Andrew Johnson - remove deprecated call
 *******************************************************************************/
package org.eclipse.mat.ui.snapshot.actions;

import java.util.ArrayList;

import org.eclipse.core.commands.AbstractHandler;
import org.eclipse.core.commands.ExecutionEvent;
import org.eclipse.core.filesystem.EFS;
import org.eclipse.core.filesystem.IFileStore;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IWorkspace;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.OperationCanceledException;
import org.eclipse.core.runtime.Path;
import org.eclipse.jface.action.Action;
import org.eclipse.jface.action.IAction;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.LabelProvider;
import org.eclipse.jface.window.Window;
import org.eclipse.mat.ui.MemoryAnalyserPlugin;
import org.eclipse.mat.ui.Messages;
import org.eclipse.mat.ui.editor.PathEditorInput;
import org.eclipse.mat.ui.snapshot.OpenSnapshot;
import org.eclipse.mat.util.MessageUtil;
import org.eclipse.ui.IEditorInput;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.IWorkbenchWindowActionDelegate;
import org.eclipse.ui.PartInitException;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.dialogs.ElementListSelectionDialog;
import org.eclipse.ui.part.FileEditorInput;

public class OpenSnapshotAction extends Action implements IWorkbenchWindowActionDelegate
{
    private IWorkbenchWindow fWindow;

    public OpenSnapshotAction()
    {}

    public void run(IAction action)
    {
        run();
    }

    public void run()
    {
        boolean successful = new OpenSnapshot.Visitor()
        {

            @Override
            public void visit(IFileStore fileStore)
            {
                try
                {
                    IEditorInput input = createEditorInput(fileStore);
                    IWorkbenchPage page = fWindow.getActivePage();
                    page.openEditor(input, MemoryAnalyserPlugin.EDITOR_ID);
                }
                catch (OperationCanceledException e)
                {}
                catch (PartInitException e)
                {
                    MemoryAnalyserPlugin.log(e.getStatus());
                    String msg = MessageUtil.format(Messages.OpenSnapshotAction_ErrorOpeningFile, fileStore.getName());
                    MessageDialog.openError(fWindow.getShell(), Messages.ErrorHelper_InternalError, msg);
                }
            }

        }.go(getWindow().getShell());

        if (successful && PlatformUI.getWorkbench().getIntroManager().getIntro() != null)
        {
            // if this action was called with open welcome page - set it to
            // standby mode.
            PlatformUI.getWorkbench().getIntroManager().setIntroStandby(
                            PlatformUI.getWorkbench().getIntroManager().getIntro(), true);
        }

    }

    public static class Handler extends AbstractHandler
    {

        public Handler()
        {}

        public Object execute(ExecutionEvent executionEvent)
        {
            new OpenSnapshotAction().run();
            return null;
        }
    }

    static class FileLabelProvider extends LabelProvider
    {
        /*
         * @see
         * org.eclipse.jface.viewers.LabelProvider#getText(java.lang.Object)
         */
        public String getText(Object element)
        {
            if (element instanceof IFile)
            {
                IPath path = ((IFile) element).getFullPath();
                return path != null ? path.toString() : ""; //$NON-NLS-1$
            }
            return super.getText(element);
        }
    }

    public void dispose()
    {
        fWindow = null;
    }

    public void init(IWorkbenchWindow window)
    {
        fWindow = window;
    }

    public void selectionChanged(IAction action, ISelection selection)
    {}

    // //////////////////////////////////////////////////////////////
    // internal helper methods
    // //////////////////////////////////////////////////////////////

    private IWorkbenchWindow getWindow()
    {
        IWorkbench workbench = PlatformUI.getWorkbench();
        fWindow = workbench.getActiveWorkbenchWindow();
        return fWindow;
    }

    // //////////////////////////////////////////////////////////////
    // helpers to actually correctly open the editor window
    // //////////////////////////////////////////////////////////////

    private IEditorInput createEditorInput(IFileStore fileStore)
    {
        try
        {
            IFile workspaceFile = getWorkspaceFile(fileStore);
            if (workspaceFile != null)
                return new FileEditorInput(workspaceFile);
            return new PathEditorInput(new Path(fileStore.toLocalFile(EFS.NONE, new NullProgressMonitor())
                            .getAbsolutePath()));
        }
        catch (CoreException e)
        {
            throw new RuntimeException(e);
        }
    }

    private IFile getWorkspaceFile(IFileStore fileStore)
    {
        IWorkspace workspace = ResourcesPlugin.getWorkspace();
        IFile[] files = workspace.getRoot().findFilesForLocationURI(fileStore.toURI());
        files = filterNonExistentFiles(files);
        if (files == null || files.length == 0)
            return null;
        if (files.length == 1)
            return files[0];
        return selectWorkspaceFile(files);
    }

    private IFile[] filterNonExistentFiles(IFile[] files)
    {
        if (files == null)
            return null;

        int length = files.length;
        ArrayList<IFile> existentFiles = new ArrayList<IFile>(length);
        for (int i = 0; i < length; i++)
        {
            if (files[i].exists())
                existentFiles.add(files[i]);
        }
        return existentFiles.toArray(new IFile[existentFiles.size()]);
    }

    private IFile selectWorkspaceFile(IFile[] files)
    {
        ElementListSelectionDialog dialog = new ElementListSelectionDialog(fWindow.getShell(), new FileLabelProvider());
        dialog.setElements(files);
        dialog.setTitle(Messages.OpenSnapshotAction_SelectWorkspace);
        dialog.setMessage(Messages.OpenSnapshotAction_Message);
        if (dialog.open() == Window.OK)
            return (IFile) dialog.getFirstResult();
        else
            throw new OperationCanceledException();
    }

}