[deliverable/tracecompass.git] / org.eclipse.linuxtools.lttng.ui / src / org / eclipse / linuxtools / lttng / ui / tracecontrol / wizards / TraceConfigurationPage.java

/*******************************************************************************\r
 * Copyright (c) 2011 Ericsson\r
 * \r
 * All rights reserved. This program and the accompanying materials are\r
 * made available under the terms of the Eclipse Public License v1.0 which\r
 * accompanies this distribution, and is available at\r
 * http://www.eclipse.org/legal/epl-v10.html\r
 * \r
 * Contributors:\r
 *   Bernd Hufmann - Initial API and implementation\r
 *   \r
 *******************************************************************************/\r
package org.eclipse.linuxtools.lttng.ui.tracecontrol.wizards;\r
\r
import java.io.File;\r
\r
import org.eclipse.jface.wizard.WizardPage;\r
import org.eclipse.linuxtools.lttng.core.tracecontrol.model.TraceResource;\r
import org.eclipse.linuxtools.lttng.core.tracecontrol.model.TraceResource.TraceState;\r
import org.eclipse.linuxtools.lttng.core.tracecontrol.model.config.TraceConfig;\r
import org.eclipse.linuxtools.lttng.ui.tracecontrol.TraceControlConstants;\r
import org.eclipse.linuxtools.lttng.ui.tracecontrol.Messages;\r
import org.eclipse.linuxtools.lttng.ui.tracecontrol.subsystems.TraceSubSystem;\r
import org.eclipse.rse.services.clientserver.messages.SystemMessageException;\r
import org.eclipse.rse.ui.SystemBasePlugin;\r
import org.eclipse.swt.SWT;\r
import org.eclipse.swt.events.VerifyEvent;\r
import org.eclipse.swt.events.VerifyListener;\r
import org.eclipse.swt.layout.GridData;\r
import org.eclipse.swt.layout.GridLayout;\r
import org.eclipse.swt.widgets.Button;\r
import org.eclipse.swt.widgets.Composite;\r
import org.eclipse.swt.widgets.DirectoryDialog;\r
import org.eclipse.swt.widgets.Display;\r
import org.eclipse.swt.widgets.Event;\r
import org.eclipse.swt.widgets.Group;\r
import org.eclipse.swt.widgets.Label;\r
import org.eclipse.swt.widgets.Listener;\r
import org.eclipse.swt.widgets.Text;\r
\r
/**\r
 * <b><u>UstTraceChannelConfigurationPage</u></b>\r
 * <p>\r
 *  Wizard page implementation to configure a trace (Kernel and UST).\r
 * </p>\r
 */\r
public class TraceConfigurationPage extends WizardPage {\r
\r
    // ------------------------------------------------------------------------\r
    // Attributes\r
    // ------------------------------------------------------------------------\r
    private ConfigureTraceWizard fWizard;\r
    private String fTraceName;\r
    private String fTraceTransport;\r
    private String fTracePath;\r
    private int fMode;\r
    private int fNumChannel;\r
    private boolean fIsAppend;\r
    private boolean fIsNetwork;\r
    private Text fNameText;\r
    private Text fTransportText;\r
    private Text fPathText;\r
    private Text fNumLttdThreadsText;\r
    private Button fHostButton;\r
    private Button fTargetButton;\r
    private Button fIsAppendButton;\r
    private Button fFlightRecorderButton;\r
    private Button fNormalButton;\r
    private Display fDisplay;\r
    private String fTraceNameError;\r
    private String fTracePathError;\r
    private Button fBrowseButton;\r
    \r
    private TraceResource fTraceResource;\r
    private TraceConfig   fOldTraceConfig;\r
    private TraceSubSystem fSubSystem;\r
\r
    // ------------------------------------------------------------------------\r
    // Constructors\r
    // ------------------------------------------------------------------------\r
\r
    /**\r
     * Constructore\r
     * \r
     * @param wizard\r
     */\r
    public TraceConfigurationPage(ConfigureTraceWizard wizard) {\r
        super("TraceConfigurationPage"); //$NON-NLS-1$\r
        setTitle(Messages.ConfigureTraceDialog_Title);\r
//        setDescription("set description..."); \r
        this.fWizard = wizard;\r
        setPageComplete(false);\r
        fTraceNameError = ""; //$NON-NLS-1$\r
        fTracePathError = ""; //$NON-NLS-1$\r
        fTraceResource = this.fWizard.getSelectedTrace();\r
        fOldTraceConfig = fTraceResource.getTraceConfig();\r
        fSubSystem = (TraceSubSystem)this.fWizard.getSelectedTrace().getSubSystem();\r
    }\r
\r
    // ------------------------------------------------------------------------\r
    // Operations\r
    // ------------------------------------------------------------------------\r
\r
    /*\r
     * (non-Javadoc)\r
     * @see org.eclipse.jface.dialogs.IDialogPage#createControl(org.eclipse.swt.widgets.Composite)\r
     */\r
    @Override\r
	public void createControl(Composite parent) {\r
        GridData griddata = new GridData();\r
\r
        griddata = new GridData();\r
        Composite composite1 = new Composite(parent, SWT.NONE);\r
        GridLayout compositeLayout1 = new GridLayout(4, false);\r
        composite1.setSize(520, 300);\r
        composite1.setLayout(compositeLayout1);\r
        griddata.horizontalSpan = 3;\r
        griddata.widthHint = 520;\r
        griddata.minimumWidth = 520;\r
        composite1.setLayoutData(griddata);\r
        fDisplay = this.getShell().getDisplay();\r
        setControl(composite1);\r
        Label nameLabel = new Label(composite1, SWT.NULL);\r
        nameLabel.setText(Messages.NewTraceDialog_TraceName + ":"); //$NON-NLS-1$\r
        griddata = new GridData();\r
        griddata.verticalIndent = 20;\r
        nameLabel.setLayoutData(griddata);\r
\r
        fNameText = new Text(composite1, SWT.SINGLE | SWT.BORDER);\r
        if (fTraceResource.isUst()) {\r
            fNameText.setText(TraceControlConstants.Lttng_Ust_TraceName);\r
            fNameText.setEnabled(false);\r
        }\r
\r
        griddata = new GridData();\r
        griddata.horizontalAlignment = SWT.FILL;\r
        griddata.grabExcessHorizontalSpace = true;\r
        griddata.verticalIndent = 20;\r
        griddata.horizontalSpan = 3;\r
        fNameText.setLayoutData(griddata);\r
        fNameText.setText(fTraceResource.getName());\r
        fNameText.setEnabled(false);\r
\r
        Label transportLabel = new Label(composite1, SWT.NULL);\r
        transportLabel.setText(Messages.ConfigureTraceDialog_Trace_Transport + ":"); //$NON-NLS-1$\r
        griddata = new GridData();\r
        transportLabel.setLayoutData(griddata);\r
\r
        fTransportText = new Text(composite1, SWT.SINGLE | SWT.BORDER);\r
        griddata = new GridData();\r
        griddata.horizontalAlignment = SWT.FILL;\r
        griddata.grabExcessHorizontalSpace = true;\r
        griddata.horizontalSpan = 3;\r
        fTransportText.setLayoutData(griddata);\r
        fTransportText.setText(TraceControlConstants.Lttng_Trace_Transport_Relay);\r
        fTransportText.setEnabled(false); // relay is the only allowed value\r
        if (fOldTraceConfig != null) {\r
            fTransportText.setText(fOldTraceConfig.getTraceTransport());\r
        }\r
\r
        griddata = new GridData();\r
        Group composite21 = new Group(composite1, SWT.SHADOW_OUT);\r
        composite21.setSize(300, 300);\r
        composite21.setText(Messages.ConfigureTraceDialog_Trace_Location);\r
        griddata.horizontalAlignment = SWT.FILL;\r
        griddata.horizontalSpan = 4;\r
        griddata.verticalIndent = 10;\r
        griddata.widthHint = 300;\r
        griddata.minimumWidth = 300;\r
        composite21.setLayoutData(griddata);\r
        GridLayout compositeLayout21 = new GridLayout(4, false);\r
        composite21.setLayout(compositeLayout21);\r
        fTargetButton = new Button(composite21, SWT.RADIO);\r
        fTargetButton.setText(Messages.ConfigureTraceDialog_Target);\r
        fTargetButton.setSelection(true);\r
        fIsNetwork = false;\r
        fHostButton = new Button(composite21, SWT.RADIO);\r
        fHostButton.setText(Messages.ConfigureTraceDialog_Host);\r
        griddata = new GridData();\r
        griddata.horizontalSpan = 3;\r
        fHostButton.setLayoutData(griddata);\r
        fHostButton.addListener(SWT.Selection, new Listener() {\r
            @Override\r
            public void handleEvent(Event e) {\r
                if (fHostButton.getSelection()) {\r
                    fBrowseButton.setEnabled(true);\r
                } else {\r
                    fBrowseButton.setEnabled(false);\r
                }\r
                fIsNetwork = fHostButton.getSelection();\r
                validatePathName(fPathText.getText());\r
                validate();\r
            }\r
        });\r
        \r
        Label pathLabel = new Label(composite21, SWT.NULL);\r
        pathLabel.setText(Messages.ConfigureTraceDialog_Trace_Path);\r
        griddata = new GridData();\r
        griddata.verticalIndent = 10;\r
        pathLabel.setLayoutData(griddata);\r
\r
        fPathText = new Text(composite21, SWT.SINGLE | SWT.BORDER);\r
        griddata = new GridData();\r
        griddata.horizontalAlignment = SWT.FILL;\r
        griddata.grabExcessHorizontalSpace = true;\r
        griddata.verticalIndent = 10;\r
        fPathText.setLayoutData(griddata);\r
        fPathText.setData(""); //$NON-NLS-1$\r
\r
        fBrowseButton = new Button(composite21, SWT.PUSH);\r
        fBrowseButton.setText(Messages.ConfigureTraceDialog_Browse + "...");  //$NON-NLS-1$\r
        griddata = new GridData();\r
        griddata.grabExcessHorizontalSpace = false;\r
        griddata.widthHint = 100;\r
        griddata.verticalIndent = 10;\r
        fBrowseButton.setLayoutData(griddata);\r
        fBrowseButton.setEnabled(false);\r
        fBrowseButton.addListener(SWT.Selection, new Listener() {\r
            @Override\r
            public void handleEvent(Event event) {\r
                DirectoryDialog dialog = new DirectoryDialog(fDisplay.getActiveShell());\r
                String newPath = dialog.open();\r
                if (newPath != null) {\r
                    fPathText.setText(newPath);\r
                }\r
            }\r
        });\r
\r
        fNameText.addListener(SWT.Modify, new Listener() {\r
            @Override\r
            public void handleEvent(Event event) {\r
                validateTraceName(fNameText.getText());\r
                validate();\r
            }\r
        });\r
\r
        fTransportText.addListener(SWT.Modify, new Listener() {\r
            @Override\r
            public void handleEvent(Event event) {\r
                validate();\r
            }\r
        });\r
\r
        fPathText.addListener(SWT.Modify, new Listener() {\r
            @Override\r
            public void handleEvent(Event event) {\r
                if (!fPathText.isEnabled()) {\r
                    return;\r
                }\r
                validatePathName(fPathText.getText());\r
                validate();\r
            }\r
        });\r
\r
        griddata = new GridData();\r
        Composite composite2 = new Composite(composite1, SWT.NONE);\r
        GridLayout compositeLayout2 = new GridLayout(2, false);\r
        composite2.setLayout(compositeLayout2);\r
        griddata.horizontalSpan = 4;\r
        griddata.widthHint = 500;\r
        griddata.minimumWidth = 500;\r
        composite2.setLayoutData(griddata);\r
\r
        Label numLttdThreadsLabel = new Label(composite2, SWT.NULL);\r
        numLttdThreadsLabel.setText(Messages.ConfigureTraceDialog_Num_Lttd_Threads + ":"); //$NON-NLS-1$);\r
        griddata = new GridData();\r
        griddata.verticalIndent = 10;\r
        numLttdThreadsLabel.setLayoutData(griddata);\r
\r
        fNumLttdThreadsText = new Text(composite2, SWT.SINGLE | SWT.BORDER);\r
        griddata = new GridData();\r
        griddata.horizontalAlignment = SWT.BEGINNING;\r
        griddata.verticalIndent = 10;\r
        griddata.widthHint = 50;\r
        griddata.minimumWidth = 50;\r
        fNumLttdThreadsText.setLayoutData(griddata);\r
        if (fTraceResource.isUst()) {\r
            fNumLttdThreadsText.setText("1"); //$NON-NLS-1$\r
            fNumLttdThreadsText.setEnabled(false);\r
        } else {\r
            fNumLttdThreadsText.setText("2"); //$NON-NLS-1$\r
        }\r
\r
        fNumLttdThreadsText.addVerifyListener(new VerifyListener() {\r
            @Override\r
            public void verifyText(VerifyEvent e) {\r
                e.doit = e.text.matches("[0-9]*"); //$NON-NLS-1$\r
            }\r
        });\r
\r
        fNumLttdThreadsText.addListener(SWT.Modify, new Listener() {\r
            @Override\r
            public void handleEvent(Event event) {\r
                validate();\r
            }\r
        });\r
\r
        fIsAppendButton = new Button(composite1, SWT.CHECK);\r
        fIsAppendButton.setText(Messages.ConfigureTraceDialog_Append);\r
        griddata = new GridData();\r
        griddata.horizontalAlignment = SWT.BEGINNING;\r
        griddata.horizontalSpan = 4;\r
        griddata.verticalIndent = 10;\r
        fIsAppendButton.setLayoutData(griddata);\r
        fIsAppend = false;\r
        fIsAppendButton.addListener(SWT.Selection, new Listener() {\r
            @Override\r
            public void handleEvent(Event e) {\r
                fIsAppend = fIsAppendButton.getSelection();\r
            }\r
        });\r
        if (fTraceResource.isUst()) {\r
            fIsAppendButton.setEnabled(false);\r
        }\r
\r
        griddata = new GridData();\r
        Group composite22 = new Group(composite1, SWT.SHADOW_OUT);\r
        composite22.setText(Messages.ConfigureTraceDialog_Trace_Mode);\r
        griddata.horizontalSpan = 4;\r
        griddata.verticalIndent = 10;\r
        composite22.setLayoutData(griddata);\r
        GridLayout compositeLayout22 = new GridLayout(2, false);\r
        composite22.setLayout(compositeLayout22);\r
        fNormalButton = new Button(composite22, SWT.RADIO);\r
        fNormalButton.setText(Messages.ConfigureTraceDialog_Mode_Normal);\r
        fFlightRecorderButton = new Button(composite22, SWT.RADIO);\r
        fFlightRecorderButton.setText(Messages.ConfigureTraceDialog_Mode_Flight_Recorder);\r
        fMode = TraceConfig.NORMAL_MODE;\r
        fNormalButton.setSelection(true);\r
        fNormalButton.addListener(SWT.Selection, new Listener() {\r
        	@Override\r
        	public void handleEvent(Event e) {\r
        		if (fNormalButton.getSelection()) {\r
        			fMode = TraceConfig.NORMAL_MODE;\r
        		}\r
        	}\r
        });\r
        fFlightRecorderButton.addListener(SWT.Selection, new Listener() {\r
            @Override\r
            public void handleEvent(Event e) {\r
                if (fFlightRecorderButton.getSelection()) {\r
                    fMode = TraceConfig.FLIGHT_RECORDER_MODE;\r
                }\r
            }\r
        });\r
        if (fTraceResource.isUst()) {\r
            fFlightRecorderButton.setEnabled(false);\r
            fNormalButton.setEnabled(false);\r
        }\r
\r
        if(fOldTraceConfig != null) {\r
            fPathText.setText(fOldTraceConfig.getTracePath());\r
            fTargetButton.setSelection(!fOldTraceConfig.isNetworkTrace());\r
            fHostButton.setSelection(fOldTraceConfig.isNetworkTrace());\r
            fIsNetwork = fOldTraceConfig.isNetworkTrace();\r
            fBrowseButton.setEnabled(true);\r
            fNumLttdThreadsText.setText(String.valueOf(fOldTraceConfig.getNumChannel()));\r
            fIsAppendButton.setSelection(fOldTraceConfig.getIsAppend());\r
            fIsAppend = fOldTraceConfig.getIsAppend();\r
            fFlightRecorderButton.setSelection(fOldTraceConfig.getMode() == TraceConfig.FLIGHT_RECORDER_MODE);\r
            fNormalButton.setSelection(fOldTraceConfig.getMode() == TraceConfig.NORMAL_MODE);\r
        }\r
\r
        // Depending on the state disable fields, it's only informational then\r
        if ((fTraceResource.getTraceState() == TraceState.STARTED) || (fTraceResource.getTraceState() == TraceState.PAUSED)) {\r
            fPathText.setEnabled(false);\r
            fBrowseButton.setEnabled(false);\r
            fTargetButton.setEnabled(false);\r
            fHostButton.setEnabled(false);\r
            fIsAppendButton.setEnabled(false);\r
            fNumLttdThreadsText.setEnabled(false);\r
            fFlightRecorderButton.setEnabled(false);\r
            fNormalButton.setEnabled(false);\r
        }\r
\r
        validate();\r
\r
        fDisplay.getActiveShell().addListener(SWT.Traverse, new Listener() {\r
            @Override\r
            public void handleEvent(Event event) {\r
                if (event.detail == SWT.TRAVERSE_ESCAPE) {\r
                    event.doit = false;\r
                }\r
            }\r
        });\r
    }\r
\r
    /*\r
     * (non-Javadoc)\r
     * @see org.eclipse.jface.dialogs.DialogPage#dispose()\r
     */\r
    @Override\r
    public void dispose() {\r
        super.dispose();\r
    }\r
\r
    /* (non-Javadoc)\r
     * @see org.eclipse.jface.dialogs.DialogPage#setVisible(boolean)\r
     */\r
    @Override\r
    public void setVisible(boolean visible) {\r
        if (visible) {\r
            validate();\r
        }\r
        super.setVisible(visible);\r
    }\r
    \r
    /*\r
     * Validates the trace name which has to be unique.\r
     */\r
    protected boolean validateTraceName(String name) {\r
        if (name.length() > 0) {\r
            TraceResource[] traces = new TraceResource[0];\r
            try {\r
                traces = fSubSystem.getAllTraces();\r
            } catch (SystemMessageException e) {\r
                SystemBasePlugin.logError("TraceConfigurationPage ", e); //$NON-NLS-1$\r
            }\r
            for (int i = 0; i < traces.length; i++) {\r
                if (traces[i].getName().compareTo(name) == 0) {\r
                    fTraceNameError = Messages.NewTraceDialog_Error_Already_Exists;\r
                    setErrorMessage(fTraceNameError);\r
                    return false;\r
                }\r
            }\r
            final char[] chars = name.toCharArray();\r
            for (int x = 0; x < chars.length; x++) {\r
                final char c = chars[x];\r
                if ((x == 0) && !(((c >= 'a') && (c <= 'z')) || ((c >= 'A') && (c <= 'Z')))) {\r
                    fTraceNameError = Messages.NewTraceDialog_Error_Invalid_First_Char;\r
                    setErrorMessage(fTraceNameError);\r
                    return false;\r
                } else if (x != 0) {\r
                    if (!((c >= 'a') && (c <= 'z')) && !((c >= 'A') && (c <= 'Z')) && !((c >= '0') && (c <= '9'))) {\r
                        fTraceNameError = Messages.NewTraceDialog_Error_Invalid_Name;\r
                        setErrorMessage(fTraceNameError);\r
                        return false;\r
                    }\r
                }\r
            }\r
        }\r
        if (fTracePathError.length() > 0) {\r
            setErrorMessage(fTracePathError);\r
        } else {\r
            setErrorMessage(null);\r
        }\r
        fTraceNameError = ""; //$NON-NLS-1$\r
        return true;\r
    }\r
\r
    /*\r
     * Validates the trace path.\r
     */\r
    private boolean validatePathName(String path) {\r
        if (path.length() > 0) {\r
            final char c0 = path.charAt(0);\r
            if (c0 != '/') {\r
                fTracePathError = Messages.ConfigureTraceDialog_Error_Invalid_Path;\r
                setErrorMessage(fTracePathError);\r
                return false;\r
            } else {\r
                String[] folders = path.split("/"); //$NON-NLS-1$\r
                for (int i = 0; i < folders.length; i++) {\r
                    final char[] chars = folders[i].toCharArray();\r
                    for (int x = 0; x < chars.length; x++) {\r
                        final char c = chars[x];\r
                        if ((c >= 'a') && (c <= 'z')) {\r
                            continue; // lowercase\r
                        }\r
                        if ((c >= 'A') && (c <= 'Z')) {\r
                            continue; // uppercase\r
                        }\r
                        if ((c >= '0') && (c <= '9')) {\r
                            continue; // numeric\r
                        }\r
                        fTracePathError = Messages.ConfigureTraceDialog_Error_Invalid_Folder;\r
                        setErrorMessage(fTracePathError);\r
                        return false;\r
                    }\r
                }\r
                if (path.length() > 1) {\r
                    for (int i = 0; i < path.length() - 1; i++) {\r
                        if ((path.charAt(i) == '/') && (path.charAt(i + 1) == '/')) {\r
                            fTracePathError = Messages.ConfigureTraceDialog_Error_Multiple_Seps;\r
                            setErrorMessage(fTracePathError);\r
                            return false;\r
                        }\r
                    }\r
                }\r
            }\r
            if (fHostButton.getSelection()) {\r
                File file = new File(path);\r
                if (file.isFile()) {\r
                    fTracePathError = Messages.ConfigureTraceDialog_Error_File_Exists;\r
                    setErrorMessage(fTracePathError);\r
                    return false;\r
                }\r
                if (path.length() > 1 && !file.getParentFile().canWrite()) {\r
                    fTracePathError = Messages.ConfigureTraceDialog_Error_Can_Not_Write;\r
                    setErrorMessage(fTracePathError);\r
                    return false;\r
                }\r
            }\r
        }\r
        if (fTraceNameError.length() > 0) {\r
            setErrorMessage(fTraceNameError);\r
        } else {\r
            setErrorMessage(null);\r
        }\r
        fTracePathError = ""; //$NON-NLS-1$\r
        return true;\r
    }\r
    \r
    /*\r
     * Validates all input values.\r
     */\r
    private void validate() {\r
        if ((fNameText.getText() == null) || (fTransportText.getText() == null) || (fTransportText.getText().length() == 0) || (fNameText.getText().length() == 0)\r
                || (fNumLttdThreadsText.getText().length() == 0) || (fNumLttdThreadsText.getText().length() == 0)) {\r
            setPageComplete(false);\r
            return;\r
        }\r
        if (fPathText.getText().length() == 0) {\r
            setPageComplete(false);\r
            return;\r
        }\r
        if ((fTracePathError.length() > 0) || (fTraceNameError.length() > 0)) {\r
            setPageComplete(false);\r
            return;\r
        }\r
        fTraceName = fNameText.getText();\r
        fTraceTransport = fTransportText.getText();\r
        fTracePath = fPathText.getText();\r
        fNumChannel = Integer.parseInt(fNumLttdThreadsText.getText());\r
        \r
        if (fTraceNameError.length() == 0) {\r
            setErrorMessage(null);\r
            setPageComplete(true);\r
       } else {\r
            setErrorMessage(fTraceNameError);\r
            setPageComplete(false);\r
        }\r
    }\r
\r
    /**\r
     * Gets the trace configuration. \r
     * \r
     * @return trace configuration\r
     */\r
    public TraceConfig getTraceConfig() {\r
        TraceConfig newTraceConfig = new TraceConfig();\r
        newTraceConfig.setTraceName(fTraceName);\r
        newTraceConfig.setTraceTransport(fTraceTransport);\r
        newTraceConfig.setTracePath(fTracePath);\r
        newTraceConfig.setNetworkTrace(fIsNetwork);\r
        newTraceConfig.setIsAppend(fIsAppend);\r
        newTraceConfig.setMode(fMode);\r
        newTraceConfig.setNumChannel(fNumChannel);\r
\r
        return newTraceConfig;\r
    }\r
\r
    /**\r
     * Gets if trace is a local trace (i.e. if trace output is stored on host \r
     * where client is running)\r
     * \r
     * @return isLocalTrace\r
     */\r
    public boolean isLocalTrace() {\r
        return fHostButton.getSelection();\r
    }\r
}\r