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.signal.TmfExperimentSelectedSignal;
  33 import org.eclipse.linuxtools.tmf.core.signal.TmfSignalManager;
  34 import org.eclipse.linuxtools.tmf.core.trace.ITmfTrace;
  35 import org.eclipse.linuxtools.tmf.core.trace.TmfExperiment;
  36 import org.eclipse.linuxtools.tmf.core.trace.TmfTrace;
  37 import org.eclipse.linuxtools.tmf.ui.editors.EventsViewEditor;
  38 import org.eclipse.linuxtools.tmf.ui.editors.TmfEditorInput;
  39 import org.eclipse.linuxtools.tmf.ui.project.model.TmfTraceElement;
  40 import org.eclipse.swt.widgets.MessageBox;
  41 import org.eclipse.ui.IEditorInput;
  42 import org.eclipse.ui.IEditorPart;
  43 import org.eclipse.ui.IReusableEditor;
  44 import org.eclipse.ui.IWorkbench;
  45 import org.eclipse.ui.IWorkbenchPage;
  46 import org.eclipse.ui.IWorkbenchPart;
  47 import org.eclipse.ui.IWorkbenchWindow;
  48 import org.eclipse.ui.PartInitException;
  49 import org.eclipse.ui.PlatformUI;
  50 import org.eclipse.ui.ide.IDE;
  51 import org.eclipse.ui.part.FileEditorInput;
  52
  53 /**
  54  * <b><u>OpenTraceHandler</u></b>
  55  * <p>
  56  * TODO: Add support for multiple trace selection
  57  */
  58 public class OpenTraceHandler extends AbstractHandler {
  59
  60     private static final String BOOKMARKS_HIDDEN_FILE = ".bookmarks"; //$NON-NLS-1$
  61
  62     // ------------------------------------------------------------------------
  63     // Attributes
  64     // ------------------------------------------------------------------------
  65
  66     private TmfTraceElement fTrace = null;
  67
  68     // ------------------------------------------------------------------------
  69     // Validation
  70     // ------------------------------------------------------------------------
  71
  72     @Override
  73     public boolean isEnabled() {
  74
  75         // Check if we are closing down
  76         final IWorkbenchWindow window = PlatformUI.getWorkbench().getActiveWorkbenchWindow();
  77         if (window == null) {
  78             return false;
  79         }
  80
  81         // Get the selection
  82         final IWorkbenchPage page = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage();
  83         final IWorkbenchPart part = page.getActivePart();
  84         final ISelectionProvider selectionProvider = part.getSite().getSelectionProvider();
  85         if (selectionProvider == null) {
  86             return false;
  87         }
  88         final ISelection selection = selectionProvider.getSelection();
  89
  90         // Make sure there is only one selection and that it is a trace
  91         fTrace = null;
  92         if (selection instanceof TreeSelection) {
  93             final TreeSelection sel = (TreeSelection) selection;
  94             // There should be only one item selected as per the plugin.xml
  95             final Object element = sel.getFirstElement();
  96             if (element instanceof TmfTraceElement) {
  97                 fTrace = (TmfTraceElement) element;
  98             }
  99         }
 100
 101         // We only enable opening from the Traces folder for now
 102         return (fTrace != null);
 103     }
 104
 105     // ------------------------------------------------------------------------
 106     // Execution
 107     // ------------------------------------------------------------------------
 108
 109     @Override
 110     @SuppressWarnings({ "rawtypes", "unchecked" })
 111     public Object execute(final ExecutionEvent event) throws ExecutionException {
 112
 113         // Check if we are closing down
 114         final IWorkbenchWindow window = PlatformUI.getWorkbench().getActiveWorkbenchWindow();
 115         if (window == null) {
 116             return null;
 117         }
 118
 119         // Check that the trace is valid
 120         if (fTrace == null) {
 121             return null;
 122         }
 123
 124         // If trace is under an experiment, use the original trace from the traces folder
 125         fTrace = fTrace.getElementUnderTraceFolder();
 126
 127         final ITmfTrace trace = fTrace.instantiateTrace();
 128         final ITmfEvent traceEvent = fTrace.instantiateEvent();
 129         if ((trace == null) || (traceEvent == null)) {
 130             displayErrorMsg(Messages.OpenTraceHandler_NoTraceType);
 131             return null;
 132         }
 133
 134         // Get the editor_id from the extension point
 135         final String editorId = fTrace.getEditorId();
 136         final boolean usesEditor = (editorId != null) && (editorId.length() > 0);
 137
 138         try {
 139             trace.initTrace(fTrace.getResource(), fTrace.getLocation().getPath(), traceEvent.getClass());
 140         } catch (final TmfTraceException e) {
 141             displayErrorMsg(Messages.OpenTraceHandler_NoTrace + "\n\n" + e); //$NON-NLS-1$
 142             return null;
 143         }
 144
 145         final IResource resource = fTrace.getResource();
 146         IFile file = null;
 147         if (resource instanceof IFile) {
 148             file = (IFile) resource;
 149         } else if (resource instanceof IFolder) {
 150             try {
 151                 final IFile bookmarksFile = fTrace.getProject().getTracesFolder().getResource().getFile(BOOKMARKS_HIDDEN_FILE);
 152                 if (!bookmarksFile.exists()) {
 153                     final InputStream source = new ByteArrayInputStream(new byte[0]);
 154                     bookmarksFile.create(source, true, null);
 155                 }
 156                 bookmarksFile.setHidden(true);
 157
 158                 final IFolder folder = (IFolder) resource;
 159                 file = folder.getFile(fTrace.getName() + '_');
 160                 if (!file.exists()) {
 161                     file.createLink(bookmarksFile.getLocation(), IResource.REPLACE, null);
 162                 }
 163                 file.setHidden(true);
 164                 if (usesEditor) {
 165                     file.setPersistentProperty(TmfCommonConstants.TRACETYPE, fTrace.getTraceType());
 166                 } else {
 167                     file.setPersistentProperty(TmfCommonConstants.TRACETYPE, TmfTrace.class.getCanonicalName());
 168                 }
 169             } catch (final CoreException e) {
 170                 Activator.getDefault().logError("Error opening trace " + fTrace.getName(), e); //$NON-NLS-1$
 171             }
 172         }
 173
 174         if (usesEditor) {
 175             try {
 176                 final IEditorInput editorInput = new TmfEditorInput(file, trace);
 177                 final IWorkbench wb = PlatformUI.getWorkbench();
 178                 final IWorkbenchPage activePage = wb.getActiveWorkbenchWindow().getActivePage();
 179
 180                 final IEditorPart editor = activePage.findEditor(new FileEditorInput(file));
 181                 if ((editor != null) && (editor instanceof IReusableEditor)) {
 182                     activePage.reuseEditor((IReusableEditor) editor, editorInput);
 183                     activePage.activate(editor);
 184                 } else {
 185                     activePage.openEditor(editorInput, editorId);
 186                     if (resource instanceof IFile) {
 187                         IDE.setDefaultEditor((IFile) resource, editorId);
 188                     }
 189                 }
 190             } catch (final PartInitException e) {
 191                 Activator.getDefault().logError("Error opening trace " + fTrace.getName(), e); //$NON-NLS-1$
 192             }
 193         } else {
 194             // Create the experiment
 195             final ITmfTrace[] traces = new ITmfTrace[] { trace };
 196             final TmfExperiment experiment = new TmfExperiment(traceEvent.getClass(), fTrace.getName(), traces, trace.getCacheSize());
 197             experiment.setBookmarksFile(file);
 198
 199             TmfExperiment.setCurrentExperiment(experiment);
 200             TmfSignalManager.dispatchSignal(new TmfExperimentSelectedSignal(this, experiment));
 201             IDE.setDefaultEditor(file, EventsViewEditor.ID);
 202         }
 203         return null;
 204     }
 205
 206     private static void displayErrorMsg(final String errorMsg) {
 207         final MessageBox mb = new MessageBox(PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell());
 208         mb.setText(Messages.OpenTraceHandler_Title);
 209         mb.setMessage(errorMsg);
 210         mb.open();
 211     }
 212
 213 }