1 /**********************************************************************
2 * Copyright (c) 2013, 2014 Ericsson, École Polytechnique de Montréal
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
10 * Matthew Khouzam - Initial API and implementation
11 * Patrick Tasse - Update open trace and add open experiment
12 * Geneviève Bastien - Merge methods to open trace and experiments
13 * Bernd Hufmann - Updated handling of directory traces
14 **********************************************************************/
16 package org
.eclipse
.tracecompass
.tmf
.ui
.project
.model
;
19 import java
.util
.List
;
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
.core
.runtime
.IPath
;
26 import org
.eclipse
.core
.runtime
.IStatus
;
27 import org
.eclipse
.core
.runtime
.Path
;
28 import org
.eclipse
.core
.runtime
.Status
;
29 import org
.eclipse
.core
.runtime
.URIUtil
;
30 import org
.eclipse
.jface
.util
.OpenStrategy
;
31 import org
.eclipse
.osgi
.util
.NLS
;
32 import org
.eclipse
.swt
.widgets
.Display
;
33 import org
.eclipse
.swt
.widgets
.MessageBox
;
34 import org
.eclipse
.swt
.widgets
.Shell
;
35 import org
.eclipse
.tracecompass
.internal
.tmf
.ui
.Activator
;
36 import org
.eclipse
.tracecompass
.internal
.tmf
.ui
.project
.model
.TmfImportHelper
;
37 import org
.eclipse
.tracecompass
.tmf
.core
.TmfCommonConstants
;
38 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfEvent
;
39 import org
.eclipse
.tracecompass
.tmf
.core
.exceptions
.TmfTraceException
;
40 import org
.eclipse
.tracecompass
.tmf
.core
.project
.model
.TmfTraceImportException
;
41 import org
.eclipse
.tracecompass
.tmf
.core
.project
.model
.TmfTraceType
;
42 import org
.eclipse
.tracecompass
.tmf
.core
.project
.model
.TraceTypeHelper
;
43 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfTrace
;
44 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.experiment
.TmfExperiment
;
45 import org
.eclipse
.tracecompass
.tmf
.ui
.editors
.TmfEditorInput
;
46 import org
.eclipse
.tracecompass
.tmf
.ui
.editors
.TmfEventsEditor
;
47 import org
.eclipse
.ui
.IEditorInput
;
48 import org
.eclipse
.ui
.IEditorPart
;
49 import org
.eclipse
.ui
.IEditorReference
;
50 import org
.eclipse
.ui
.IReusableEditor
;
51 import org
.eclipse
.ui
.IWorkbench
;
52 import org
.eclipse
.ui
.IWorkbenchPage
;
53 import org
.eclipse
.ui
.PartInitException
;
54 import org
.eclipse
.ui
.PlatformUI
;
55 import org
.eclipse
.ui
.ide
.IDE
;
56 import org
.eclipse
.ui
.part
.FileEditorInput
;
61 * Helper class for opening trace resources and loading them to a tracing
64 * @author Matthew Khouzam
66 public class TmfOpenTraceHelper
{
68 private TmfOpenTraceHelper() {
71 private static final String ENDL
= System
.getProperty("line.separator"); //$NON-NLS-1$
74 * Opens a trace from a path while importing it to the destination folder.
75 * The trace is linked as a resource.
77 * @param destinationFolder
78 * The destination trace folder
82 * the shell to use for dialogs
83 * @return IStatus OK if successful
84 * @throws CoreException
85 * core exceptions if something is not well set up in the back
88 public static IStatus
openTraceFromPath(TmfTraceFolder destinationFolder
, String path
, Shell shell
) throws CoreException
{
89 return openTraceFromPath(destinationFolder
, path
, shell
, null);
93 * Opens a trace from a path while importing it to the destination folder.
94 * The trace is linked as a resource.
96 * @param destinationFolder
97 * The destination trace folder
101 * the shell to use for dialogs
102 * @param tracetypeHint
103 * The trace type id, can be null
104 * @return IStatus OK if successful
105 * @throws CoreException
106 * core exceptions if something is not well set up in the back
109 public static IStatus
openTraceFromPath(TmfTraceFolder destinationFolder
, String path
, Shell shell
, String tracetypeHint
) throws CoreException
{
110 final String pathToUse
= checkTracePath(path
);
111 TraceTypeHelper traceTypeToSet
= null;
113 traceTypeToSet
= TmfTraceTypeUIUtils
.selectTraceType(pathToUse
, null, tracetypeHint
);
114 } catch (TmfTraceImportException e
) {
115 MessageBox mb
= new MessageBox(shell
);
116 mb
.setMessage(e
.getMessage());
118 return new Status(IStatus
.ERROR
, Activator
.PLUGIN_ID
, e
.getMessage());
121 IFolder folder
= destinationFolder
.getResource();
122 String traceName
= getTraceName(pathToUse
, folder
);
123 if (traceExists(pathToUse
, folder
)) {
124 return openTraceFromFolder(destinationFolder
, traceName
);
126 final IPath pathString
= Path
.fromOSString(pathToUse
);
127 IResource linkedTrace
= TmfImportHelper
.createLink(folder
, pathString
, traceName
);
129 if (linkedTrace
== null || !linkedTrace
.exists()) {
130 return new Status(IStatus
.ERROR
, Activator
.PLUGIN_ID
,
131 Messages
.TmfOpenTraceHelper_LinkFailed
);
134 String sourceLocation
= URIUtil
.toUnencodedString(pathString
.toFile().toURI());
135 linkedTrace
.setPersistentProperty(TmfCommonConstants
.SOURCE_LOCATION
, sourceLocation
);
137 // No trace type was determined.
138 if (traceTypeToSet
== null) {
139 return Status
.OK_STATUS
;
142 IStatus ret
= TmfTraceTypeUIUtils
.setTraceType(linkedTrace
, traceTypeToSet
);
144 ret
= openTraceFromFolder(destinationFolder
, traceName
);
150 * Checks whether the parent or grandparent of given path to a file is a
151 * valid directory trace. If it is a directory trace then return the parent
152 * or grandparent path.
156 * @return path to use for trace type validation.
158 private static String
checkTracePath(String path
) {
159 File file
= new File(path
);
160 if (file
.exists() && !file
.isDirectory()) {
161 // First check parent
162 File parent
= file
.getParentFile();
163 String pathToUse
= parent
.getAbsolutePath();
164 if (TmfTraceType
.isDirectoryTrace(pathToUse
)) {
167 // Second check grandparent
168 File grandParent
= parent
.getParentFile();
169 if (grandParent
!= null) {
170 pathToUse
= grandParent
.getAbsolutePath();
171 if (TmfTraceType
.isDirectoryTrace(pathToUse
)) {
179 private static boolean traceExists(String path
, IFolder folder
) {
180 String val
= getTraceName(path
, folder
);
181 return (folder
.findMember(val
) != null);
184 private static boolean isWrongMember(IFolder folder
, String name
, final File traceFile
) {
185 final IResource candidate
= folder
.findMember(name
);
186 if (candidate
!= null) {
187 final IPath rawLocation
= candidate
.getRawLocation();
188 final File file
= rawLocation
.toFile();
189 return !file
.equals(traceFile
);
195 * Gets the display name, either "filename" or "filename(n)" if there is
196 * already a filename existing where n is the next unused integer starting
202 * the folder to import to
203 * @return the filename
205 private static String
getTraceName(String path
, IFolder folder
) {
207 final File traceFile
= new File(path
);
208 name
= traceFile
.getName();
209 for (int i
= 2; isWrongMember(folder
, name
, traceFile
); i
++) {
210 name
= traceFile
.getName() + '(' + i
+ ')';
216 * Open a trace from a trace folder
218 * @param destinationFolder
219 * The destination trace folder
222 * @return success or error
224 private static IStatus
openTraceFromFolder(TmfTraceFolder destinationFolder
, String traceName
) {
225 final List
<ITmfProjectModelElement
> elements
= destinationFolder
.getChildren();
226 TmfTraceElement traceElement
= null;
227 for (ITmfProjectModelElement element
: elements
) {
228 if (element
instanceof TmfTraceElement
&& element
.getName().equals(traceName
)) {
229 traceElement
= (TmfTraceElement
) element
;
232 if (traceElement
== null) {
233 return new Status(IStatus
.ERROR
, Activator
.PLUGIN_ID
, NLS
.bind(Messages
.TmfOpenTraceHelper_TraceNotFound
, traceName
));
235 openTraceFromElement(traceElement
);
236 return Status
.OK_STATUS
;
239 private static ITmfTrace
openTraceElement(final TmfTraceElement traceElement
) {
240 final ITmfTrace trace
= traceElement
.instantiateTrace();
241 final ITmfEvent traceEvent
= traceElement
.instantiateEvent();
242 if ((trace
== null) || (traceEvent
== null)) {
243 TraceUtils
.displayErrorMsg(NLS
.bind(Messages
.TmfOpenTraceHelper_OpenElement
, traceElement
.getTypeName()),
244 Messages
.TmfOpenTraceHelper_NoTraceType
);
252 trace
.initTrace(traceElement
.getResource(), traceElement
.getResource().getLocation().toOSString(), traceEvent
.getClass(), traceElement
.getElementPath(), traceElement
.getTraceType());
253 } catch (final TmfTraceException e
) {
254 TraceUtils
.displayErrorMsg(NLS
.bind(Messages
.TmfOpenTraceHelper_OpenElement
, traceElement
.getTypeName()),
255 Messages
.TmfOpenTraceHelper_InitError
+ ENDL
+ ENDL
+ e
);
262 private static ITmfTrace
openExperimentElement(final TmfExperimentElement experimentElement
) {
263 /* Experiment element now has an experiment type associated with it */
264 final TmfExperiment experiment
= experimentElement
.instantiateTrace();
265 if (experiment
== null) {
266 TraceUtils
.displayErrorMsg(NLS
.bind(Messages
.TmfOpenTraceHelper_OpenElement
, experimentElement
.getTypeName()),
267 NLS
.bind(Messages
.TmfOpenTraceHelper_NoTraceOrExperimentType
, experimentElement
.getTypeName()));
271 // Instantiate the experiment's traces
272 final List
<TmfTraceElement
> traceEntries
= experimentElement
.getTraces();
273 int cacheSize
= Integer
.MAX_VALUE
;
274 final ITmfTrace
[] traces
= new ITmfTrace
[traceEntries
.size()];
275 for (int i
= 0; i
< traceEntries
.size(); i
++) {
276 TmfTraceElement element
= traceEntries
.get(i
);
278 // Since trace is under an experiment, use the original trace from
280 element
= element
.getElementUnderTraceFolder();
282 ITmfTrace trace
= openTraceElement(element
);
285 for (int j
= 0; j
< i
; j
++) {
290 cacheSize
= Math
.min(cacheSize
, trace
.getCacheSize());
295 // Create the experiment
296 experiment
.initExperiment(ITmfEvent
.class, experimentElement
.getName(), traces
, cacheSize
, experimentElement
.getResource());
301 private static ITmfTrace
openProjectElement(final TmfCommonProjectElement element
) {
302 ITmfTrace trace
= null;
303 if (element
instanceof TmfTraceElement
) {
304 trace
= openTraceElement((TmfTraceElement
) element
);
305 } else if (element
instanceof TmfExperimentElement
) {
306 trace
= openExperimentElement((TmfExperimentElement
) element
);
312 * Open a trace (or experiment) from a project element. If the trace is already opened, its
313 * editor is activated and brought to top.
315 * @param traceElement
316 * the {@link TmfTraceElement} to open
318 public static void openTraceFromElement(final TmfCommonProjectElement traceElement
) {
322 file
= traceElement
.createBookmarksFile();
323 } catch (final CoreException e
) {
324 Activator
.getDefault().logError(NLS
.bind(Messages
.TmfOpenTraceHelper_ErrorOpeningElement
, traceElement
.getTypeName()) + ' ' + traceElement
.getName());
325 TraceUtils
.displayErrorMsg(NLS
.bind(Messages
.TmfOpenTraceHelper_OpenElement
, traceElement
.getTypeName()),
326 NLS
.bind(Messages
.TmfOpenTraceHelper_ErrorElement
, traceElement
.getTypeName()) + ENDL
+ ENDL
+ e
.getMessage());
330 final IWorkbench wb
= PlatformUI
.getWorkbench();
331 final IWorkbenchPage activePage
= wb
.getActiveWorkbenchWindow().getActivePage();
332 final IEditorPart editor
= findEditor(new FileEditorInput(file
), true);
333 if (editor
!= null) {
334 activePage
.activate(editor
);
338 // If a trace type is not set then delegate it to the eclipse platform
339 if ((traceElement
instanceof TmfTraceElement
) && (traceElement
.getResource() instanceof IFile
) && (traceElement
.getTraceType() == null)) {
341 boolean activate
= OpenStrategy
.activateOnOpen();
342 // only local open is supported
343 IDE
.openEditor(activePage
, file
, activate
);
344 } catch (PartInitException e
) {
345 TraceUtils
.displayErrorMsg(NLS
.bind(Messages
.TmfOpenTraceHelper_OpenElement
, traceElement
.getTypeName()),
346 NLS
.bind(Messages
.TmfOpenTraceHelper_ErrorOpeningElement
, traceElement
.getElementPath()) + ENDL
+ ENDL
+ e
.getMessage());
351 Thread thread
= new Thread() {
354 final ITmfTrace trace
= openProjectElement(traceElement
);
360 // Get the editor id from the extension point
361 String traceEditorId
= traceElement
.getEditorId();
362 final String editorId
= (traceEditorId
!= null) ? traceEditorId
: TmfEventsEditor
.ID
;
363 final IEditorInput editorInput
= new TmfEditorInput(file
, trace
);
365 Display
.getDefault().asyncExec(new Runnable() {
369 activePage
.openEditor(editorInput
, editorId
);
370 IDE
.setDefaultEditor(file
, editorId
);
371 // editor should dispose the trace on close
372 } catch (final PartInitException e
) {
373 TraceUtils
.displayErrorMsg(NLS
.bind(Messages
.TmfOpenTraceHelper_OpenElement
, traceElement
.getTypeName()),
374 NLS
.bind(Messages
.TmfOpenTraceHelper_ErrorOpeningElement
, traceElement
.getTypeName()) + ENDL
+ ENDL
+ e
.getMessage());
375 Activator
.getDefault().logError(NLS
.bind(Messages
.TmfOpenTraceHelper_ErrorOpeningElement
, traceElement
.getTypeName()) + ' ' + traceElement
.getName());
386 * Returns the editor with the specified input. Returns null if there is no
387 * opened editor with that input. If restore is requested, the method finds
388 * and returns the editor even if it is not restored yet after a restart.
393 * true if the editor should be restored
394 * @return an editor with input equals to <code>input</code>
396 private static IEditorPart
findEditor(IEditorInput input
, boolean restore
) {
397 final IWorkbench wb
= PlatformUI
.getWorkbench();
398 final IWorkbenchPage activePage
= wb
.getActiveWorkbenchWindow().getActivePage();
399 for (IEditorReference editorReference
: activePage
.getEditorReferences()) {
401 IEditorInput editorInput
= editorReference
.getEditorInput();
402 if (editorInput
.equals(input
)) {
403 return editorReference
.getEditor(restore
);
405 } catch (PartInitException e
) {
412 * Reopen a trace or experiment from a project element in the provided
415 * @param traceElement
416 * the {@link TmfTraceElement} to open
418 * the reusable editor
420 public static void reopenTraceFromElement(final TmfCommonProjectElement traceElement
, final IReusableEditor editor
) {
424 file
= traceElement
.createBookmarksFile();
425 } catch (final CoreException e
) {
426 Activator
.getDefault().logError(NLS
.bind(Messages
.TmfOpenTraceHelper_ErrorOpeningElement
, traceElement
.getTypeName()) + ' ' + traceElement
.getName());
427 TraceUtils
.displayErrorMsg(NLS
.bind(Messages
.TmfOpenTraceHelper_OpenElement
, traceElement
.getTypeName()),
428 NLS
.bind(Messages
.TmfOpenTraceHelper_ErrorElement
, traceElement
.getTypeName()) + ENDL
+ ENDL
+ e
.getMessage());
432 Thread thread
= new Thread() {
436 final ITmfTrace trace
= openProjectElement(traceElement
);
441 final IEditorInput editorInput
= new TmfEditorInput(file
, trace
);
443 Display
.getDefault().asyncExec(new Runnable() {
446 final IWorkbench wb
= PlatformUI
.getWorkbench();
447 final IWorkbenchPage activePage
= wb
.getActiveWorkbenchWindow().getActivePage();
448 activePage
.reuseEditor(editor
, editorInput
);
449 activePage
.activate(editor
);