org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/handlers/ImportHandler.java

   1 /**********************************************************************
   2  * Copyright (c) 2012, 2013 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  *   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;
  14
  15 import java.util.Iterator;
  16 import java.util.List;
  17
  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;
  56
  57 /**
  58  * <p>
  59  * Command handler implementation to import traces from a (remote) session to a tracing project.
  60  * </p>
  61  *
  62  * @author Bernd Hufmann
  63  */
  64 public class ImportHandler extends BaseControlViewHandler {
  65
  66     // ------------------------------------------------------------------------
  67     // Constants
  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$
  75
  76     // ------------------------------------------------------------------------
  77     // Attributes
  78     // ------------------------------------------------------------------------
  79
  80     /**
  81      * The command parameter
  82      */
  83     protected CommandParameter fParam;
  84
  85     // ------------------------------------------------------------------------
  86     // Operations
  87     // ------------------------------------------------------------------------
  88
  89     @Override
  90     public Object execute(ExecutionEvent event) throws ExecutionException {
  91
  92         IWorkbenchWindow window = PlatformUI.getWorkbench().getActiveWorkbenchWindow();
  93
  94         if (window == null) {
  95             return false;
  96         }
  97
  98         fLock.lock();
  99         try {
 100             final CommandParameter param = fParam.clone();
 101
 102             // create default project
 103             IProject project = TmfProjectRegistry.createProject(DEFAULT_REMOTE_PROJECT_NAME, null, null);
 104             TmfImportHelper.forceFolderRefresh(project.getFolder(TmfTraceFolder.TRACE_FOLDER_NAME));
 105
 106             if (param.getSession().isStreamedTrace()) {
 107                 // Streamed trace
 108                 TmfProjectElement projectElement = TmfProjectRegistry.getProject(project);
 109                 TmfTraceFolder traceFolder = projectElement.getTracesFolder();
 110
 111                 BatchImportTraceWizard wizard = new BatchImportTraceWizard();
 112                 wizard.init(PlatformUI.getWorkbench(), new StructuredSelection(traceFolder));
 113                 WizardDialog dialog = new WizardDialog(window.getShell(), wizard);
 114                 dialog.open();
 115                 traceFolder.refresh();
 116                 return null;
 117             }
 118
 119             // Remote trace
 120             final IImportDialog dialog = TraceControlDialogFactory.getInstance().getImportDialog();
 121             dialog.setSession(param.getSession());
 122             dialog.setDefaultProject(DEFAULT_REMOTE_PROJECT_NAME);
 123
 124             if (dialog.open() != Window.OK) {
 125                 return null;
 126             }
 127
 128             Job job = new Job(Messages.TraceControl_ImportJob) {
 129                 @Override
 130                 protected IStatus run(IProgressMonitor monitor) {
 131
 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();) {
 136                         try {
 137                             ImportFileInfo remoteFile = iterator.next();
 138
 139                             downloadTrace(remoteFile, selectedProject);
 140
 141                             // Set trace type
 142                             IFolder traceFolder = selectedProject.getFolder(TmfTraceFolder.TRACE_FOLDER_NAME);
 143                             TmfImportHelper.forceFolderRefresh(traceFolder);
 144                             IFile file = traceFolder.getFile(remoteFile.getLocalTraceName());
 145
 146                             TraceTypeHelper helper = null;
 147
 148                             if (remoteFile.isKernel()) {
 149                                 helper = TmfTraceType.getInstance().getTraceType(LTTNG_KERNEL_TRACE_TYPE);
 150                             } else {
 151                                 helper = TmfTraceType.getInstance().getTraceType(GENERIC_CTF_TRACE_TYPE);
 152                             }
 153
 154                             if (helper != null) {
 155                                 status.add(TmfTraceType.setTraceType(file.getFullPath(), helper));
 156                             }
 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));
 161                         }
 162                     }
 163                     return status;
 164                 }
 165             };
 166             job.setUser(true);
 167             job.schedule();
 168         } finally {
 169             fLock.unlock();
 170         }
 171         return null;
 172     }
 173
 174     @Override
 175     public boolean isEnabled() {
 176         // Get workbench page for the Control View
 177         IWorkbenchPage page = getWorkbenchPage();
 178         if (page == null) {
 179             return false;
 180         }
 181
 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;
 194                     }
 195                 }
 196             }
 197         }
 198         boolean isEnabled = session != null;
 199
 200         fLock.lock();
 201         try {
 202             fParam = null;
 203             if (isEnabled) {
 204                 fParam = new CommandParameter(session);
 205             }
 206         } finally {
 207             fLock.unlock();
 208         }
 209         return isEnabled;
 210     }
 211
 212     // ------------------------------------------------------------------------
 213     // Helper methods
 214     // ------------------------------------------------------------------------
 215
 216     /**
 217      * Downloads a trace from the remote host to the given project.
 218      *
 219      * @param trace
 220      *            - trace information of trace to import
 221      * @param project
 222      *            - project to import to
 223      * @throws ExecutionException
 224      */
 225     private static void downloadTrace(ImportFileInfo trace, IProject project)
 226             throws ExecutionException {
 227         try {
 228             IRemoteFileSubSystem fsss = trace.getImportFile().getParentRemoteFileSubSystem();
 229
 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$
 233             }
 234
 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$
 240                 }
 241             } else {
 242                 folder.create(true, true, null);
 243             }
 244
 245             IRemoteFile[] sources = fsss.list(trace.getImportFile(), IFileService.FILE_TYPE_FILES, new NullProgressMonitor());
 246
 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();
 251                 encodings[i] = null;
 252             }
 253
 254             fsss.downloadMultiple(sources, destinations, encodings, new NullProgressMonitor());
 255
 256         } catch (SystemMessageException e) {
 257             throw new ExecutionException(e.toString(), e);
 258         } catch (CoreException e) {
 259             throw new ExecutionException(e.toString(), e);
 260         }
 261     }
 262 }