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