org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/internal/tmf/ui/project/handlers/OpenTraceHandler.java

   1 /*******************************************************************************
   2  * Copyright (c) 2009, 2010, 2011 Ericsson
   3  *
   4  * All rights reserved. This program and the accompanying materials are
   5  * made available under the terms of the Eclipse Public License v1.0 which
   6  * accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *   Francois Chouinard - Initial API and implementation
  11  *******************************************************************************/
  12
  13 package org.eclipse.linuxtools.internal.tmf.ui.project.handlers;
  14
  15 import java.io.ByteArrayInputStream;
  16 import java.io.InputStream;
  17
  18 import org.eclipse.core.commands.AbstractHandler;
  19 import org.eclipse.core.commands.ExecutionEvent;
  20 import org.eclipse.core.commands.ExecutionException;
  21 import org.eclipse.core.resources.IFile;
  22 import org.eclipse.core.resources.IFolder;
  23 import org.eclipse.core.resources.IResource;
  24 import org.eclipse.core.runtime.CoreException;
  25 import org.eclipse.jface.viewers.ISelection;
  26 import org.eclipse.jface.viewers.ISelectionProvider;
  27 import org.eclipse.jface.viewers.TreeSelection;
  28 import org.eclipse.linuxtools.internal.tmf.ui.Activator;
  29 import org.eclipse.linuxtools.tmf.core.TmfCommonConstants;
  30 import org.eclipse.linuxtools.tmf.core.event.ITmfEvent;
  31 import org.eclipse.linuxtools.tmf.core.exceptions.TmfTraceException;
  32 import org.eclipse.linuxtools.tmf.core.trace.ITmfTrace;
  33 import org.eclipse.linuxtools.tmf.core.trace.TmfTrace;
  34 import org.eclipse.linuxtools.tmf.ui.editors.TmfEditorInput;
  35 import org.eclipse.linuxtools.tmf.ui.editors.TmfEventsEditor;
  36 import org.eclipse.linuxtools.tmf.ui.project.model.TmfTraceElement;
  37 import org.eclipse.swt.widgets.Display;
  38 import org.eclipse.swt.widgets.MessageBox;
  39 import org.eclipse.ui.IEditorInput;
  40 import org.eclipse.ui.IEditorPart;
  41 import org.eclipse.ui.IReusableEditor;
  42 import org.eclipse.ui.IWorkbench;
  43 import org.eclipse.ui.IWorkbenchPage;
  44 import org.eclipse.ui.IWorkbenchPart;
  45 import org.eclipse.ui.IWorkbenchWindow;
  46 import org.eclipse.ui.PartInitException;
  47 import org.eclipse.ui.PlatformUI;
  48 import org.eclipse.ui.ide.IDE;
  49 import org.eclipse.ui.part.FileEditorInput;
  50
  51 /**
  52  * <b><u>OpenTraceHandler</u></b>
  53  * <p>
  54  * TODO: Add support for multiple trace selection
  55  */
  56 public class OpenTraceHandler extends AbstractHandler {
  57
  58     private static final String BOOKMARKS_HIDDEN_FILE = ".bookmarks"; //$NON-NLS-1$
  59
  60     // ------------------------------------------------------------------------
  61     // Attributes
  62     // ------------------------------------------------------------------------
  63
  64     private TmfTraceElement fTrace = null;
  65
  66     // ------------------------------------------------------------------------
  67     // Validation
  68     // ------------------------------------------------------------------------
  69
  70     @Override
  71     public boolean isEnabled() {
  72
  73         // Check if we are closing down
  74         final IWorkbenchWindow window = PlatformUI.getWorkbench().getActiveWorkbenchWindow();
  75         if (window == null) {
  76             return false;
  77         }
  78
  79         // Get the selection
  80         final IWorkbenchPage page = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage();
  81         final IWorkbenchPart part = page.getActivePart();
  82         final ISelectionProvider selectionProvider = part.getSite().getSelectionProvider();
  83         if (selectionProvider == null) {
  84             return false;
  85         }
  86         final ISelection selection = selectionProvider.getSelection();
  87
  88         // Make sure there is only one selection and that it is a trace
  89         fTrace = null;
  90         if (selection instanceof TreeSelection) {
  91             final TreeSelection sel = (TreeSelection) selection;
  92             // There should be only one item selected as per the plugin.xml
  93             final Object element = sel.getFirstElement();
  94             if (element instanceof TmfTraceElement) {
  95                 fTrace = (TmfTraceElement) element;
  96             }
  97         }
  98
  99         // We only enable opening from the Traces folder for now
 100         return (fTrace != null);
 101     }
 102
 103     // ------------------------------------------------------------------------
 104     // Execution
 105     // ------------------------------------------------------------------------
 106
 107     @Override
 108     public Object execute(final ExecutionEvent event) throws ExecutionException {
 109
 110         // Check if we are closing down
 111         final IWorkbenchWindow window = PlatformUI.getWorkbench().getActiveWorkbenchWindow();
 112         if (window == null) {
 113             return null;
 114         }
 115
 116         // Check that the trace is valid
 117         if (fTrace == null) {
 118             return null;
 119         }
 120
 121         // If trace is under an experiment, use the original trace from the traces folder
 122         final TmfTraceElement traceElement = fTrace.getElementUnderTraceFolder();
 123
 124         Thread thread = new Thread() {
 125             @Override
 126             public void run() {
 127
 128                 final ITmfTrace trace = traceElement.instantiateTrace();
 129                 final ITmfEvent traceEvent = traceElement.instantiateEvent();
 130                 if ((trace == null) || (traceEvent == null)) {
 131                     displayErrorMsg(Messages.OpenTraceHandler_NoTraceType);
 132                     if (trace != null) {
 133                         trace.dispose();
 134                     }
 135                     return;
 136                 }
 137
 138                 // Get the editor_id from the extension point
 139                 String traceEditorId = traceElement.getEditorId();
 140                 final String editorId = (traceEditorId != null) ? traceEditorId : TmfEventsEditor.ID;
 141
 142                 try {
 143                     trace.initTrace(traceElement.getResource(), traceElement.getLocation().getPath(), traceEvent.getClass());
 144                 } catch (final TmfTraceException e) {
 145                     displayErrorMsg(Messages.OpenTraceHandler_InitError + "\n\n" + e); //$NON-NLS-1$
 146                     trace.dispose();
 147                     return;
 148                 }
 149
 150                 final IResource resource = traceElement.getResource();
 151                 IFile file = null;
 152                 if (resource instanceof IFile) {
 153                     file = (IFile) resource;
 154                 } else if (resource instanceof IFolder) {
 155                     try {
 156                         final IFile bookmarksFile = traceElement.getProject().getTracesFolder().getResource().getFile(BOOKMARKS_HIDDEN_FILE);
 157                         if (!bookmarksFile.exists()) {
 158                             final InputStream source = new ByteArrayInputStream(new byte[0]);
 159                             bookmarksFile.create(source, true, null);
 160                         }
 161                         bookmarksFile.setHidden(true);
 162
 163                         final IFolder folder = (IFolder) resource;
 164                         file = folder.getFile(traceElement.getName() + '_');
 165                         if (!file.exists()) {
 166                             file.createLink(bookmarksFile.getLocation(), IResource.REPLACE, null);
 167                         }
 168                         file.setHidden(true);
 169                         file.setPersistentProperty(TmfCommonConstants.TRACETYPE, TmfTrace.class.getCanonicalName());
 170                         IDE.setDefaultEditor(file, editorId);
 171                         // editor should dispose the experiment on close
 172                     } catch (final CoreException e) {
 173                         Activator.getDefault().logError("Error opening trace " + traceElement.getName(), e); //$NON-NLS-1$
 174                         displayErrorMsg(Messages.OpenTraceHandler_Error + "\n\n" + e.getMessage()); //$NON-NLS-1$
 175                         trace.dispose();
 176                         return;
 177                     }
 178                 }
 179
 180                 final IFile editorFile = file;
 181                 Display.getDefault().asyncExec(new Runnable() {
 182                     @Override
 183                     public void run() {
 184                         try {
 185                             final IEditorInput editorInput = new TmfEditorInput(editorFile, trace);
 186                             final IWorkbench wb = PlatformUI.getWorkbench();
 187                             final IWorkbenchPage activePage = wb.getActiveWorkbenchWindow().getActivePage();
 188
 189                             final IEditorPart editor = activePage.findEditor(new FileEditorInput(editorFile));
 190                             if ((editor != null) && (editor instanceof IReusableEditor)) {
 191                                 activePage.reuseEditor((IReusableEditor) editor, editorInput);
 192                                 activePage.activate(editor);
 193                             } else {
 194                                 activePage.openEditor(editorInput, editorId);
 195                                 if (resource instanceof IFile) {
 196                                     IDE.setDefaultEditor((IFile) resource, editorId);
 197                                 }
 198                             }
 199                         } catch (final PartInitException e) {
 200                             displayErrorMsg(Messages.OpenTraceHandler_Error + "\n\n" + e.getMessage()); //$NON-NLS-1$
 201                             Activator.getDefault().logError("Error opening trace " + traceElement.getName(), e); //$NON-NLS-1$
 202                             trace.dispose();
 203                         }
 204                     }
 205                 });
 206
 207             }
 208         };
 209
 210         thread.start();
 211         return null;
 212     }
 213
 214     private static void displayErrorMsg(final String errorMsg) {
 215         Display.getDefault().asyncExec(new Runnable() {
 216             @Override
 217             public void run() {
 218                 final MessageBox mb = new MessageBox(PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell());
 219                 mb.setText(Messages.OpenTraceHandler_Title);
 220                 mb.setMessage(errorMsg);
 221                 mb.open();
 222             }
 223         });
 224     }
 225
 226 }