1 /**********************************************************************
2 * Copyright (c) 2012, 2013 Ericsson
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 * Bernd Hufmann - Initial API and implementation
11 * Bernd Hufmann - Updated for support of streamed traces
12 **********************************************************************/
13 package org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.handlers
;
15 import java
.util
.Iterator
;
16 import java
.util
.List
;
18 import org
.eclipse
.core
.commands
.ExecutionEvent
;
19 import org
.eclipse
.core
.commands
.ExecutionException
;
20 import org
.eclipse
.core
.resources
.IFile
;
21 import org
.eclipse
.core
.resources
.IFolder
;
22 import org
.eclipse
.core
.resources
.IProject
;
23 import org
.eclipse
.core
.runtime
.CoreException
;
24 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
25 import org
.eclipse
.core
.runtime
.IStatus
;
26 import org
.eclipse
.core
.runtime
.MultiStatus
;
27 import org
.eclipse
.core
.runtime
.NullProgressMonitor
;
28 import org
.eclipse
.core
.runtime
.Status
;
29 import org
.eclipse
.core
.runtime
.jobs
.Job
;
30 import org
.eclipse
.jface
.viewers
.ISelection
;
31 import org
.eclipse
.jface
.viewers
.StructuredSelection
;
32 import org
.eclipse
.jface
.window
.Window
;
33 import org
.eclipse
.jface
.wizard
.WizardDialog
;
34 import org
.eclipse
.linuxtools
.internal
.lttng2
.core
.control
.model
.TraceSessionState
;
35 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.Activator
;
36 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.ControlView
;
37 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.dialogs
.IImportDialog
;
38 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.dialogs
.ImportFileInfo
;
39 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.dialogs
.TraceControlDialogFactory
;
40 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.messages
.Messages
;
41 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.model
.impl
.TraceSessionComponent
;
42 import org
.eclipse
.linuxtools
.internal
.tmf
.ui
.project
.model
.TmfImportHelper
;
43 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.TmfProjectElement
;
44 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.TmfProjectRegistry
;
45 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.TmfTraceFolder
;
46 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.TmfTraceType
;
47 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.TraceTypeHelper
;
48 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.wizards
.importtrace
.BatchImportTraceWizard
;
49 import org
.eclipse
.rse
.services
.clientserver
.messages
.SystemMessageException
;
50 import org
.eclipse
.rse
.services
.files
.IFileService
;
51 import org
.eclipse
.rse
.subsystems
.files
.core
.subsystems
.IRemoteFile
;
52 import org
.eclipse
.rse
.subsystems
.files
.core
.subsystems
.IRemoteFileSubSystem
;
53 import org
.eclipse
.ui
.IWorkbenchPage
;
54 import org
.eclipse
.ui
.IWorkbenchWindow
;
55 import org
.eclipse
.ui
.PlatformUI
;
59 * Command handler implementation to import traces from a (remote) session to a tracing project.
62 * @author Bernd Hufmann
64 public class ImportHandler
extends BaseControlViewHandler
{
66 // ------------------------------------------------------------------------
68 // ------------------------------------------------------------------------
69 /** Trace Type ID for LTTng Kernel traces */
70 private static final String LTTNG_KERNEL_TRACE_TYPE
= "org.eclipse.linuxtools.lttng2.kernel.tracetype"; //$NON-NLS-1$
71 /** Trace Type ID for Generic CTF traces */
72 private static final String GENERIC_CTF_TRACE_TYPE
= "org.eclipse.linuxtools.tmf.ui.type.ctf"; //$NON-NLS-1$
73 /** Name of default project to import traces to */
74 public static final String DEFAULT_REMOTE_PROJECT_NAME
= "Remote"; //$NON-NLS-1$
76 // ------------------------------------------------------------------------
78 // ------------------------------------------------------------------------
81 * The command parameter
83 protected CommandParameter fParam
;
85 // ------------------------------------------------------------------------
87 // ------------------------------------------------------------------------
90 public Object
execute(ExecutionEvent event
) throws ExecutionException
{
92 IWorkbenchWindow window
= PlatformUI
.getWorkbench().getActiveWorkbenchWindow();
100 final CommandParameter param
= fParam
.clone();
102 // create default project
103 IProject project
= TmfProjectRegistry
.createProject(DEFAULT_REMOTE_PROJECT_NAME
, null, null);
104 TmfImportHelper
.forceFolderRefresh(project
.getFolder(TmfTraceFolder
.TRACE_FOLDER_NAME
));
106 if (param
.getSession().isStreamedTrace()) {
108 TmfProjectElement projectElement
= TmfProjectRegistry
.getProject(project
);
109 TmfTraceFolder traceFolder
= projectElement
.getTracesFolder();
111 BatchImportTraceWizard wizard
= new BatchImportTraceWizard();
112 wizard
.init(PlatformUI
.getWorkbench(), new StructuredSelection(traceFolder
));
113 WizardDialog dialog
= new WizardDialog(window
.getShell(), wizard
);
115 traceFolder
.refresh();
120 final IImportDialog dialog
= TraceControlDialogFactory
.getInstance().getImportDialog();
121 dialog
.setSession(param
.getSession());
122 dialog
.setDefaultProject(DEFAULT_REMOTE_PROJECT_NAME
);
124 if (dialog
.open() != Window
.OK
) {
128 Job job
= new Job(Messages
.TraceControl_ImportJob
) {
130 protected IStatus
run(IProgressMonitor monitor
) {
132 MultiStatus status
= new MultiStatus(Activator
.PLUGIN_ID
, IStatus
.OK
, Messages
.TraceControl_ImportFailure
, null);
133 List
<ImportFileInfo
> traces
= dialog
.getTracePathes();
134 IProject selectedProject
= dialog
.getProject();
135 for (Iterator
<ImportFileInfo
> iterator
= traces
.iterator(); iterator
.hasNext();) {
137 ImportFileInfo remoteFile
= iterator
.next();
139 downloadTrace(remoteFile
, selectedProject
);
142 IFolder traceFolder
= selectedProject
.getFolder(TmfTraceFolder
.TRACE_FOLDER_NAME
);
143 TmfImportHelper
.forceFolderRefresh(traceFolder
);
144 IFile file
= traceFolder
.getFile(remoteFile
.getLocalTraceName());
146 TraceTypeHelper helper
= null;
148 if (remoteFile
.isKernel()) {
149 helper
= TmfTraceType
.getInstance().getTraceType(LTTNG_KERNEL_TRACE_TYPE
);
151 helper
= TmfTraceType
.getInstance().getTraceType(GENERIC_CTF_TRACE_TYPE
);
154 if (helper
!= null) {
155 status
.add(TmfTraceType
.setTraceType(file
.getFullPath(), helper
));
157 } catch (ExecutionException e
) {
158 status
.add(new Status(IStatus
.ERROR
, Activator
.PLUGIN_ID
, Messages
.TraceControl_ImportFailure
, e
));
159 } catch (CoreException e
) {
160 status
.add(new Status(IStatus
.ERROR
, Activator
.PLUGIN_ID
, Messages
.TraceControl_ImportFailure
, e
));
175 public boolean isEnabled() {
176 // Get workbench page for the Control View
177 IWorkbenchPage page
= getWorkbenchPage();
182 // Check if one or more session are selected
183 ISelection selection
= page
.getSelection(ControlView
.ID
);
184 TraceSessionComponent session
= null;
185 if (selection
instanceof StructuredSelection
) {
186 StructuredSelection structered
= ((StructuredSelection
) selection
);
187 for (Iterator
<?
> iterator
= structered
.iterator(); iterator
.hasNext();) {
188 Object element
= iterator
.next();
189 if (element
instanceof TraceSessionComponent
) {
190 // Add only TraceSessionComponents that are inactive and not destroyed
191 TraceSessionComponent tmpSession
= (TraceSessionComponent
) element
;
192 if (((tmpSession
.isSnapshotSession()) || (tmpSession
.getSessionState() == TraceSessionState
.INACTIVE
)) && (!tmpSession
.isDestroyed())) {
193 session
= tmpSession
;
198 boolean isEnabled
= session
!= null;
204 fParam
= new CommandParameter(session
);
212 // ------------------------------------------------------------------------
214 // ------------------------------------------------------------------------
217 * Downloads a trace from the remote host to the given project.
220 * - trace information of trace to import
222 * - project to import to
223 * @throws ExecutionException
225 private static void downloadTrace(ImportFileInfo trace
, IProject project
)
226 throws ExecutionException
{
228 IRemoteFileSubSystem fsss
= trace
.getImportFile().getParentRemoteFileSubSystem();
230 IFolder traceFolder
= project
.getFolder(TmfTraceFolder
.TRACE_FOLDER_NAME
);
231 if (!traceFolder
.exists()) {
232 throw new ExecutionException(Messages
.TraceControl_ImportDialogInvalidTracingProject
+ " (" + TmfTraceFolder
.TRACE_FOLDER_NAME
+ ")"); //$NON-NLS-1$//$NON-NLS-2$
235 String traceName
= trace
.getLocalTraceName();
236 IFolder folder
= traceFolder
.getFolder(traceName
);
237 if (folder
.exists()) {
238 if(!trace
.isOverwrite()) {
239 throw new ExecutionException(Messages
.TraceControl_ImportDialogTraceAlreadyExistError
+ ": " + traceName
); //$NON-NLS-1$
242 folder
.create(true, true, null);
245 IRemoteFile
[] sources
= fsss
.list(trace
.getImportFile(), IFileService
.FILE_TYPE_FILES
, new NullProgressMonitor());
247 String
[] destinations
= new String
[sources
.length
];
248 String
[] encodings
= new String
[sources
.length
];
249 for (int i
= 0; i
< sources
.length
; i
++) {
250 destinations
[i
] = folder
.getLocation().addTrailingSeparator().append(sources
[i
].getName()).toString();
254 fsss
.downloadMultiple(sources
, destinations
, encodings
, new NullProgressMonitor());
256 } catch (SystemMessageException e
) {
257 throw new ExecutionException(e
.toString(), e
);
258 } catch (CoreException e
) {
259 throw new ExecutionException(e
.toString(), e
);