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

   1 /**********************************************************************
   2  * Copyright (c) 2012 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  **********************************************************************/
  12 package org.eclipse.linuxtools.internal.lttng2.ui.views.control.handlers;
  13
  14 import java.util.ArrayList;
  15 import java.util.Arrays;
  16 import java.util.Iterator;
  17 import java.util.List;
  18
  19 import org.eclipse.core.commands.ExecutionEvent;
  20 import org.eclipse.core.commands.ExecutionException;
  21 import org.eclipse.core.runtime.IProgressMonitor;
  22 import org.eclipse.core.runtime.IStatus;
  23 import org.eclipse.core.runtime.Status;
  24 import org.eclipse.core.runtime.jobs.Job;
  25 import org.eclipse.jface.viewers.ISelection;
  26 import org.eclipse.jface.viewers.StructuredSelection;
  27 import org.eclipse.jface.window.Window;
  28 import org.eclipse.linuxtools.internal.lttng2.ui.Activator;
  29 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.ControlView;
  30 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.Messages;
  31 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs.IGetEventInfoDialog;
  32 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs.TraceControlDialogFactory;
  33 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.ITraceControlComponent;
  34 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.impl.BaseEventComponent;
  35 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.impl.KernelProviderComponent;
  36 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.impl.TargetNodeComponent;
  37 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.impl.TraceChannelComponent;
  38 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.impl.TraceSessionComponent;
  39 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.impl.UstProviderComponent;
  40 import org.eclipse.ui.IWorkbenchPage;
  41
  42 /**
  43  * <b><u>AssignEventHandler</u></b>
  44  * <p>
  45  * Command handler implementation to assign events to a session and channel and enable/configure them.
  46  * This is done on the trace provider level.
  47  * </p>
  48  */
  49 public class AssignEventHandler extends BaseControlViewHandler {
  50
  51     // ------------------------------------------------------------------------
  52     // Attributes
  53     // ------------------------------------------------------------------------
  54     /**
  55      * The command execution parameter.
  56      */
  57     private Parameter fParam;
  58
  59     // ------------------------------------------------------------------------
  60     // Operations
  61     // ------------------------------------------------------------------------
  62
  63     /*
  64      * (non-Javadoc)
  65      * @see org.eclipse.core.commands.AbstractHandler#execute(org.eclipse.core.commands.ExecutionEvent)
  66      */
  67     @Override
  68     public Object execute(ExecutionEvent event) throws ExecutionException {
  69
  70         fLock.lock();
  71         try {
  72             // Make a copy for thread safety
  73             final Parameter param = new Parameter(fParam);
  74
  75             // Open dialog box to retrieve the session and channel where the events should be enabled in.
  76             final IGetEventInfoDialog dialog = TraceControlDialogFactory.getInstance().getGetEventInfoDialog();
  77             dialog.setIsKernel(param.isKernel());
  78             dialog.setSessions(param.getSessions());
  79
  80             if (dialog.open() != Window.OK) {
  81                 return null;
  82             }
  83
  84             Job job = new Job(Messages.TraceControl_EnableEventsJob) {
  85                 @Override
  86                 protected IStatus run(IProgressMonitor monitor) {
  87
  88                     Exception error = null;
  89
  90                     try {
  91                         List<String> eventNames = new ArrayList<String>();
  92                         List<BaseEventComponent> events = param.getEvents();
  93                         // Create list of event names
  94                         for (Iterator<BaseEventComponent> iterator = events.iterator(); iterator.hasNext();) {
  95                             BaseEventComponent event = (BaseEventComponent) iterator.next();
  96                             eventNames.add(event.getName());
  97                         }
  98
  99                         TraceChannelComponent channel = dialog.getChannel();
 100                         if (channel == null) {
 101                             // enable events on default channel (which will be created by lttng-tools)
 102                             dialog.getSession().enableEvents(eventNames, param.isKernel(), monitor);
 103                         } else {
 104                             channel.enableEvents(eventNames, monitor);
 105                         }
 106
 107                     } catch (ExecutionException e) {
 108                         error = e;
 109                     }
 110
 111                     // refresh in all cases
 112                     refresh(new CommandParameter(dialog.getSession()));
 113
 114                     if (error != null) {
 115                         return new Status(Status.ERROR, Activator.PLUGIN_ID, Messages.TraceControl_EnableEventsFailure, error);
 116                     }
 117                     return Status.OK_STATUS;
 118                 }
 119             };
 120             job.setUser(true);
 121             job.schedule();
 122         } finally {
 123             fLock.unlock();
 124         }
 125
 126         return null;
 127     }
 128
 129     /*
 130      * (non-Javadoc)
 131      * @see org.eclipse.core.commands.AbstractHandler#isEnabled()
 132      */
 133     @Override
 134     public boolean isEnabled() {
 135         ArrayList<BaseEventComponent> events = new ArrayList<BaseEventComponent>();
 136         TraceSessionComponent[] sessions = null;
 137         Boolean isKernel = null;
 138
 139         // Get workbench page for the Control View
 140         IWorkbenchPage page = getWorkbenchPage();
 141         if (page == null) {
 142             return false;
 143         }
 144
 145         // Check if one or more session are selected
 146         ISelection selection = page.getSelection(ControlView.ID);
 147         if (selection instanceof StructuredSelection) {
 148
 149             StructuredSelection structered = ((StructuredSelection) selection);
 150             for (Iterator<?> iterator = structered.iterator(); iterator.hasNext();) {
 151                 Object element = (Object) iterator.next();
 152                 if (element instanceof BaseEventComponent) {
 153                     BaseEventComponent event = (BaseEventComponent) element;
 154                     ITraceControlComponent provider = event.getParent();
 155
 156                     // check for kernel or UST provider
 157                     boolean temp = false;
 158                     if (provider instanceof KernelProviderComponent) {
 159                         temp = true;
 160                     } else if (provider instanceof UstProviderComponent) {
 161                         temp = false;
 162                     } else {
 163                         return false;
 164                     }
 165                     if (isKernel == null) {
 166                         isKernel = Boolean.valueOf(temp);
 167                     } else {
 168                         // don't mix events from Kernel and UST provider
 169                         if (isKernel.booleanValue() != temp) {
 170                             return false;
 171                         }
 172                     }
 173
 174                     // Add BaseEventComponents
 175                     events.add(event);
 176
 177                     if (sessions == null) {
 178                         TargetNodeComponent  root = (TargetNodeComponent)event.getParent().getParent().getParent();
 179                         sessions = root.getSessions();
 180                     }
 181                 }
 182             }
 183         }
 184
 185         boolean isEnabled = ((!events.isEmpty()) && (sessions != null) && (sessions.length > 0));
 186         fLock.lock();
 187         try {
 188             fParam = null;
 189             if(isEnabled) {
 190                 fParam = new Parameter(sessions, events, isKernel);
 191             }
 192         } finally {
 193             fLock.unlock();
 194         }
 195         return isEnabled;
 196     }
 197
 198     /**
 199      *  Class containing parameter for the command execution.
 200      */
 201     final static private class Parameter {
 202
 203         /**
 204          * The list of event components the command is to be executed on.
 205          */
 206         private List<BaseEventComponent> fEvents;
 207
 208         /**
 209          * The list of available sessions.
 210          */
 211         final private TraceSessionComponent[] fSessions;
 212
 213         /**
 214          * Flag for indicating Kernel or UST.
 215          */
 216         final private boolean fIsKernel;
 217
 218         /**
 219          * Constructor
 220          *
 221          * @param sessions - a array of trace sessions
 222          * @param events - a lists of events to enable
 223          * @param isKernel - domain (true for kernel or UST)
 224          */
 225         public Parameter(TraceSessionComponent[] sessions, List<BaseEventComponent> events, boolean isKernel) {
 226             fSessions = Arrays.copyOf(sessions, sessions.length);
 227             fEvents = new ArrayList<BaseEventComponent>();
 228             fEvents.addAll(events);
 229             fIsKernel = isKernel;
 230         }
 231
 232         /**
 233          * Copy constructor
 234          * @param other - a parameter to copy
 235          */
 236         public Parameter(Parameter other) {
 237             this(other.fSessions, other.fEvents, other.fIsKernel);
 238         }
 239
 240         public TraceSessionComponent[] getSessions() {
 241             return fSessions;
 242         }
 243
 244         public List<BaseEventComponent> getEvents() {
 245             return fEvents;
 246         }
 247
 248         public boolean isKernel() {
 249             return fIsKernel;
 250         }
 251     }
 252 }