org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/internal/tmf/ui/project/handlers/OpenExperimentHandler.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 import java.util.List;
  19
  20 import org.eclipse.core.commands.AbstractHandler;
  21 import org.eclipse.core.commands.ExecutionEvent;
  22 import org.eclipse.core.commands.ExecutionException;
  23 import org.eclipse.core.resources.IFile;
  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.ITmfEvent;
  30 import org.eclipse.linuxtools.tmf.core.event.TmfEvent;
  31 import org.eclipse.linuxtools.tmf.core.experiment.TmfExperiment;
  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.ui.editors.EventsViewEditor;
  36 import org.eclipse.linuxtools.tmf.ui.editors.TmfEditorInput;
  37 import org.eclipse.linuxtools.tmf.ui.editors.TmfEventsEditor;
  38 import org.eclipse.linuxtools.tmf.ui.project.model.TmfExperimentElement;
  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.PlatformUI;
  49 import org.eclipse.ui.ide.IDE;
  50 import org.eclipse.ui.part.FileEditorInput;
  51
  52 /**
  53  * <b><u>OpenExperimentHandler</u></b>
  54  * <p>
  55  */
  56 public class OpenExperimentHandler extends AbstractHandler {
  57
  58     private static final String BOOKMARKS_HIDDEN_FILE = ".bookmarks"; //$NON-NLS-1$
  59
  60     private TmfExperimentElement fExperiment = null;
  61
  62     // ------------------------------------------------------------------------
  63     // Validation
  64     // ------------------------------------------------------------------------
  65
  66     @Override
  67     public boolean isEnabled() {
  68
  69         // Check if we are closing down
  70         final IWorkbenchWindow window = PlatformUI.getWorkbench().getActiveWorkbenchWindow();
  71         if (window == null)
  72             return false;
  73
  74         // Get the selection
  75         final IWorkbenchPage page = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage();
  76         final IWorkbenchPart part = page.getActivePart();
  77         final ISelectionProvider selectionProvider = part.getSite().getSelectionProvider();
  78         if (selectionProvider == null)
  79             return false;
  80         final ISelection selection = selectionProvider.getSelection();
  81
  82         // Make sure there is only one selection and that it is an experiment
  83         fExperiment = null;
  84         if (selection instanceof TreeSelection) {
  85             final TreeSelection sel = (TreeSelection) selection;
  86             // There should be only one item selected as per the plugin.xml
  87             final Object element = sel.getFirstElement();
  88             if (element instanceof TmfExperimentElement)
  89                 fExperiment = (TmfExperimentElement) element;
  90         }
  91
  92         // We only enable opening from the Traces folder for now
  93         return (fExperiment != null);
  94     }
  95
  96     // ------------------------------------------------------------------------
  97     // Execution
  98     // ------------------------------------------------------------------------
  99
 100     @SuppressWarnings({ "rawtypes", "unchecked" })
 101     @Override
 102     public Object execute(final ExecutionEvent event) throws ExecutionException {
 103
 104         // Check if we are closing down
 105         final IWorkbenchWindow window = PlatformUI.getWorkbench().getActiveWorkbenchWindow();
 106         if (window == null)
 107             return false;
 108
 109         try {
 110             final IFile bookmarksFile = fExperiment.getProject().getExperimentsFolder().getResource().getFile(BOOKMARKS_HIDDEN_FILE);
 111             if (!bookmarksFile.exists()) {
 112                 final InputStream source = new ByteArrayInputStream(new byte[0]);
 113                 bookmarksFile.create(source, true, null);
 114             }
 115             bookmarksFile.setHidden(true);
 116
 117             final IFile file = fExperiment.getResource().getFile(fExperiment.getName() + '_');
 118             if (!file.exists())
 119                 file.createLink(bookmarksFile.getLocation(), IResource.REPLACE, null);
 120             file.setHidden(true);
 121             file.setPersistentProperty(TmfTraceElement.TRACETYPE, TmfExperiment.class.getCanonicalName());
 122
 123             // Instantiate the experiment's traces
 124             final List<TmfTraceElement> traceEntries = fExperiment.getTraces();
 125             final int nbTraces = traceEntries.size();
 126             int cacheSize = Integer.MAX_VALUE;
 127             boolean useEditor = true;
 128             String experimentEditorId = null;
 129             final ITmfTrace<?>[] traces = new ITmfTrace[nbTraces];
 130             for (int i = 0; i < nbTraces; i++) {
 131                 final TmfTraceElement element = traceEntries.get(i);
 132                 final ITmfTrace trace = element.instantiateTrace();
 133                 final ITmfEvent traceEvent = element.instantiateEvent();
 134                 if ((trace == null) || (traceEvent == null)) {
 135                     displayErrorMsg(Messages.OpenExperimentHandler_NoTraceType);
 136                     for (int j = 0; j < i; j++)
 137                         traces[j].dispose();
 138                     return null;
 139                 }
 140                 try {
 141                     trace.initTrace(element.getResource(), element.getLocation().getPath(), traceEvent.getClass());
 142                 } catch (final FileNotFoundException e) {
 143                     displayErrorMsg(""); //$NON-NLS-1$
 144                 }
 145                 cacheSize = Math.min(cacheSize, trace.getCacheSize());
 146                 final String editorId = element.getEditorId();
 147                 if (editorId == null) {
 148                     useEditor = false;
 149                     experimentEditorId = null;
 150                 } else if (useEditor)
 151                     if (experimentEditorId == null)
 152                         experimentEditorId = editorId;
 153                     else if (!editorId.equals(experimentEditorId))
 154                         useEditor = false;
 155                 traces[i] = trace;
 156             }
 157
 158             // Create the experiment
 159             final TmfExperiment experiment = new TmfExperiment(TmfEvent.class, fExperiment.getName(), traces, cacheSize);
 160             experiment.setBookmarksFile(file);
 161
 162             if (useEditor) {
 163                 final IEditorInput editorInput = new TmfEditorInput(file, experiment);
 164                 final IWorkbench wb = PlatformUI.getWorkbench();
 165                 final IWorkbenchPage activePage = wb.getActiveWorkbenchWindow().getActivePage();
 166
 167                 final String editorId = TmfEventsEditor.ID;
 168                 final IEditorPart editor = activePage.findEditor(new FileEditorInput(file));
 169                 if ((editor != null) && (editor instanceof IReusableEditor)) {
 170                     activePage.reuseEditor((IReusableEditor) editor, editorInput);
 171                     activePage.activate(editor);
 172                 } else
 173                     activePage.openEditor(editorInput, editorId);
 174                 experiment.initTrace(null, null, null);
 175                 IDE.setDefaultEditor(file, editorId);
 176                 // editor should dispose the experiment on close
 177             } else {
 178                 TmfExperiment.setCurrentExperiment(experiment);
 179                 TmfSignalManager.dispatchSignal(new TmfExperimentSelectedSignal(this, experiment));
 180                 IDE.setDefaultEditor(file, EventsViewEditor.ID);
 181             }
 182         } catch (final CoreException e) {
 183             displayErrorMsg(e.getMessage());
 184         }
 185
 186         return null;
 187     }
 188
 189     private void displayErrorMsg(final String errorMsg) {
 190         final MessageBox mb = new MessageBox(PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell());
 191         mb.setText(Messages.OpenExperimentHandler_Title);
 192         mb.setMessage(errorMsg);
 193         mb.open();
 194     }
 195
 196 }