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