org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/handlers/ChangeEventStateHandler.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.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.runtime.IProgressMonitor;
  21 import org.eclipse.core.runtime.IStatus;
  22 import org.eclipse.core.runtime.Status;
  23 import org.eclipse.core.runtime.jobs.Job;
  24 import org.eclipse.jface.viewers.ISelection;
  25 import org.eclipse.jface.viewers.StructuredSelection;
  26 import org.eclipse.linuxtools.internal.lttng2.core.control.model.TraceEnablement;
  27 import org.eclipse.linuxtools.internal.lttng2.ui.Activator;
  28 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.ControlView;
  29 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.messages.Messages;
  30 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.impl.TraceChannelComponent;
  31 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.impl.TraceEventComponent;
  32 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.impl.TraceSessionComponent;
  33 import org.eclipse.ui.IWorkbenchPage;
  34 import org.eclipse.ui.IWorkbenchWindow;
  35 import org.eclipse.ui.PlatformUI;
  36
  37 /**
  38  * <p>
  39  * Base Command handler implementation to enable or disabling a trace channel.
  40  * </p>
  41  *
  42  * @author Bernd Hufmann
  43  */
  44 abstract public class ChangeEventStateHandler extends BaseControlViewHandler {
  45
  46     // ------------------------------------------------------------------------
  47     // Attributes
  48     // ------------------------------------------------------------------------
  49     /**
  50      * The command execution parameter.
  51      */
  52     protected Parameter fParam;
  53
  54     // ------------------------------------------------------------------------
  55     // Accessors
  56     // ------------------------------------------------------------------------
  57     /**
  58      * @return the new state to set
  59      */
  60     abstract protected TraceEnablement getNewState();
  61
  62     // ------------------------------------------------------------------------
  63     // Operations
  64     // ------------------------------------------------------------------------
  65     /**
  66      * Change the state
  67      * @param channel - channel of events to be enabled
  68      * @param eventNames - list event names
  69      * @param monitor - a progress monitor
  70      * @throws ExecutionException
  71      */
  72     abstract protected void changeState(TraceChannelComponent channel, List<String> eventNames, IProgressMonitor monitor) throws ExecutionException;
  73
  74     /*
  75      * (non-Javadoc)
  76      * @see org.eclipse.core.commands.AbstractHandler#execute(org.eclipse.core.commands.ExecutionEvent)
  77      */
  78     @Override
  79     public Object execute(ExecutionEvent event) throws ExecutionException {
  80
  81         IWorkbenchWindow window = PlatformUI.getWorkbench().getActiveWorkbenchWindow();
  82
  83         if (window == null) {
  84             return false;
  85         }
  86
  87         fLock.lock();
  88         try {
  89
  90             final Parameter param = new Parameter(fParam);
  91
  92             Job job = new Job(Messages.TraceControl_ChangeChannelStateJob) {
  93                 @Override
  94                 protected IStatus run(IProgressMonitor monitor) {
  95                     Exception error = null;
  96
  97                     TraceSessionComponent session = null;
  98
  99                     try {
 100                         boolean isAll = false;
 101                         if (param.getChannel() != null) {
 102                             session = param.getChannel().getSession();
 103                             List<String> eventNames = new ArrayList<String>();
 104                             List<TraceEventComponent> events = param.getEvents();
 105
 106                             for (Iterator<TraceEventComponent> iterator = events.iterator(); iterator.hasNext();) {
 107                                 // Enable/disable all selected channels which are disabled
 108                                 TraceEventComponent traceEvent = iterator.next();
 109
 110                                 // Workaround for wildcard handling in lttng-tools
 111                                 if ("*".equals(traceEvent.getName())) { //$NON-NLS-1$
 112                                     isAll = true;
 113                                 } else {
 114                                     eventNames.add(traceEvent.getName());
 115                                 }
 116                             }
 117                             if (isAll) {
 118                                 changeState(param.getChannel(), null, monitor);
 119                             }
 120
 121                             if (!eventNames.isEmpty()) {
 122                                 changeState(param.getChannel(), eventNames, monitor);
 123                             }
 124
 125                             for (Iterator<TraceEventComponent> iterator = events.iterator(); iterator.hasNext();) {
 126                                 // Enable all selected channels which are disabled
 127                                 TraceEventComponent ev = iterator.next();
 128                                 ev.setState(getNewState());
 129                             }
 130                         }
 131                     } catch (ExecutionException e) {
 132                         error = e;
 133                     }
 134
 135                     if (session != null) {
 136                         // In all cases notify listeners
 137                         session.fireComponentChanged(session);
 138                     }
 139
 140                     if (error != null) {
 141                         return new Status(IStatus.ERROR, Activator.PLUGIN_ID, Messages.TraceControl_ChangeEventStateFailure, error);
 142                     }
 143
 144                     return Status.OK_STATUS;
 145                 }
 146             };
 147             job.setUser(true);
 148             job.schedule();
 149         } finally {
 150             fLock.unlock();
 151         }
 152         return null;
 153     }
 154
 155     /*
 156      * (non-Javadoc)
 157      * @see org.eclipse.core.commands.AbstractHandler#isEnabled()
 158      */
 159     @Override
 160     public boolean isEnabled() {
 161         // Get workbench page for the Control View
 162         IWorkbenchPage page = getWorkbenchPage();
 163         if (page == null) {
 164             return false;
 165         }
 166
 167         // Check if one or more session are selected
 168         ISelection selection = page.getSelection(ControlView.ID);
 169
 170         TraceChannelComponent channel = null;
 171         List<TraceEventComponent> events = new ArrayList<TraceEventComponent>();
 172
 173         if (selection instanceof StructuredSelection) {
 174             StructuredSelection structered = ((StructuredSelection) selection);
 175             String sessionName = null;
 176             String channelName = null;
 177
 178             for (Iterator<?> iterator = structered.iterator(); iterator.hasNext();) {
 179                 Object element = iterator.next();
 180
 181                 if (element instanceof TraceEventComponent) {
 182
 183                     TraceEventComponent event = (TraceEventComponent) element;
 184                     if (sessionName == null) {
 185                         sessionName = String.valueOf(event.getSessionName());
 186                     }
 187
 188                     if (channel == null) {
 189                         channel = (TraceChannelComponent)event.getParent();
 190                     }
 191
 192                     if (channelName == null) {
 193                         channelName = event.getChannelName();
 194                     }
 195
 196                     // Enable command only for events of same session, same channel and domain
 197                     if ((!sessionName.equals(event.getSessionName())) ||
 198                         (!channelName.equals(event.getChannelName())) ||
 199                         (channel.isKernel() != event.isKernel())) {
 200                         events.clear();
 201                         break;
 202                     }
 203
 204                     if ((event.getState() != getNewState())) {
 205                         events.add(event);
 206                     }
 207                 }
 208             }
 209         }
 210         boolean isEnabled = !events.isEmpty();
 211
 212         fLock.lock();
 213         try {
 214             fParam = null;
 215             if (isEnabled) {
 216                 fParam = new Parameter(channel, events);
 217             }
 218         } finally {
 219             fLock.unlock();
 220         }
 221         return isEnabled;
 222     }
 223
 224     /**
 225      *  Class containing parameter for the command execution.
 226      */
 227     static protected class Parameter {
 228         /**
 229          * Channel component reference.
 230          */
 231         final private TraceChannelComponent fChannel;
 232         /**
 233          * The list of kernel channel components the command is to be executed on.
 234          */
 235         final private List<TraceEventComponent> fEvents = new ArrayList<TraceEventComponent>();
 236
 237         /**
 238          * Constructor
 239          * @param channel - a channel component
 240          * @param events - a list of event components
 241          */
 242         public Parameter(TraceChannelComponent channel, List<TraceEventComponent> events) {
 243             fChannel = channel;
 244             fEvents.addAll(events);
 245         }
 246
 247         /**
 248          * Copy constructor
 249          * @param other - a parameter to copy
 250          */
 251         public Parameter(Parameter other) {
 252             this(other.fChannel, other.fEvents);
 253         }
 254
 255         /**
 256          * @return the trace channel component.
 257          */
 258         public TraceChannelComponent getChannel() {
 259             return fChannel;
 260         }
 261
 262         /**
 263          * @return a list of trace event components.
 264          */
 265         public List<TraceEventComponent> getEvents() {
 266             return fEvents;
 267         }
 268     }
 269 }