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