plugins/org.eclipse.mat.ui/src/org/eclipse/mat/ui/internal/GettingStartedWizard.java

/*******************************************************************************
 * Copyright (c) 2008, 2011 SAP AG and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    SAP AG - initial API and implementation
 *    IBM Corporation - accessibility improvements
 *******************************************************************************/
package org.eclipse.mat.ui.internal;

import java.io.File;
import java.io.FilenameFilter;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;

import org.eclipse.jface.action.Action;
import org.eclipse.jface.layout.GridDataFactory;
import org.eclipse.jface.layout.GridLayoutFactory;
import org.eclipse.jface.layout.TableColumnLayout;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.resource.JFaceResources;
import org.eclipse.jface.viewers.ColumnWeightData;
import org.eclipse.jface.viewers.ISelectionChangedListener;
import org.eclipse.jface.viewers.IStructuredContentProvider;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.LabelProvider;
import org.eclipse.jface.viewers.SelectionChangedEvent;
import org.eclipse.jface.viewers.TableViewer;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.jface.wizard.IWizardPage;
import org.eclipse.jface.wizard.Wizard;
import org.eclipse.jface.wizard.WizardPage;
import org.eclipse.mat.snapshot.ISnapshot;
import org.eclipse.mat.ui.MemoryAnalyserPlugin;
import org.eclipse.mat.ui.Messages;
import org.eclipse.mat.ui.actions.ImportReportAction;
import org.eclipse.mat.ui.internal.actions.ExecuteQueryAction;
import org.eclipse.mat.ui.snapshot.editor.HeapEditor;
import org.eclipse.swt.SWT;
import org.eclipse.swt.accessibility.AccessibleAdapter;
import org.eclipse.swt.accessibility.AccessibleEvent;
import org.eclipse.swt.events.ModifyEvent;
import org.eclipse.swt.events.ModifyListener;
import org.eclipse.swt.layout.FormAttachment;
import org.eclipse.swt.layout.FormData;
import org.eclipse.swt.layout.FormLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.TableColumn;
import org.eclipse.swt.widgets.Text;

public class GettingStartedWizard extends Wizard
{
    public static final String HIDE_WIZARD_KEY = "hideGettingStartedWizard";//$NON-NLS-1$

    /* package */Action action;
    /* package */HeapEditor editor;

    /* package */ChoicePage choicePage;
    /* package */PackagePage packagePage;
    /* package */OpenReportsPage openReportsPage;

    public GettingStartedWizard(HeapEditor editor)
    {
        this.editor = editor;

        setWindowTitle(Messages.GettingStartedWizard_GettingStartedWizard);
    }

    @Override
    public void addPages()
    {
        choicePage = new ChoicePage();
        addPage(choicePage);
        packagePage = new PackagePage();
        addPage(packagePage);
        openReportsPage = new OpenReportsPage();
        addPage(openReportsPage);
    }

    @Override
    public boolean canFinish()
    {
        return action != null;
    }

    @Override
    public boolean performFinish()
    {
        IPreferenceStore prefs = MemoryAnalyserPlugin.getDefault().getPreferenceStore();
        prefs.setValue(HIDE_WIZARD_KEY, !choicePage.askAgain.getSelection());

        if (action != null)
            action.run();

        return true;
    }

    @Override
    public boolean performCancel()
    {
        IPreferenceStore prefs = MemoryAnalyserPlugin.getDefault().getPreferenceStore();
        prefs.setValue(HIDE_WIZARD_KEY, !choicePage.askAgain.getSelection());

        return true;
    }

    // //////////////////////////////////////////////////////////////
    // internal classes
    // //////////////////////////////////////////////////////////////

    private static class ChoicePage extends WizardPage implements Listener
    {
        private Button componentReport;
        private Button leakReport;
        private Button openReports;
        private Button askAgain;
        private static String space = " ";    //$NON-NLS-1$
        private static String fullStop = "."; //$NON-NLS-1$

        public ChoicePage()
        {
            super("");//$NON-NLS-1$

            setTitle(Messages.GettingStartedWizard_GettingStarted);
            setDescription(Messages.GettingStartedWizard_ChooseOneOfReports);
        }

        public void createControl(Composite parent)
        {
            Composite composite = new Composite(parent, SWT.NONE);
            Composite choices = new Composite(composite, SWT.NONE);

            FormLayout formLayout = new FormLayout();
            choices.setLayout(formLayout);
            composite.setLayout(formLayout);

            leakReport = new Button(choices, SWT.RADIO);
            leakReport.setText(Messages.GettingStartedWizard_LeakSuspectReport);
            leakReport.setFont(JFaceResources.getFontRegistry().getBold(JFaceResources.DIALOG_FONT));
            leakReport.addListener(SWT.Selection, this);

            // Set the button's accessible name to the text + description
            leakReport.getAccessible().addAccessibleListener(new AccessibleAdapter()
            {

                @Override
                public void getName(AccessibleEvent e)
                {
                    e.result = Messages.GettingStartedWizard_LeakSuspectReport + fullStop + space
                                    + Messages.GettingStartedWizard_LeakSuspectReportDescription;
                }
            });

            componentReport = new Button(choices, SWT.RADIO);
            componentReport.setText(Messages.GettingStartedWizard_ComponentReport);
            componentReport.setFont(JFaceResources.getFontRegistry().getBold(JFaceResources.DIALOG_FONT));
            componentReport.addListener(SWT.Selection, this);

            // Set the button's accessible name to the text + description
            componentReport.getAccessible().addAccessibleListener(new AccessibleAdapter()
            {

                @Override
                public void getName(AccessibleEvent e)
                {
                    e.result = Messages.GettingStartedWizard_ComponentReport + fullStop + space
                                    + Messages.GettingStartedWizard_ComponentReportDescription;
                }
            });

            openReports = new Button(choices, SWT.RADIO);
            openReports.setText(Messages.GettingStartedWizard_ReOpenExistingReports);
            openReports.setFont(JFaceResources.getFontRegistry().getBold(JFaceResources.DIALOG_FONT));
            openReports.addListener(SWT.Selection, this);

            // Set the button's accessible name to the text + description
            openReports.getAccessible().addAccessibleListener(new AccessibleAdapter()
            {

                @Override
                public void getName(AccessibleEvent e)
                {
                    e.result = Messages.GettingStartedWizard_ReOpenExistingReports + fullStop + space
                                    + Messages.GettingStartedWizard_ExistingReportsLocation;
                }
            });

            Label leakDescription = new Label(choices, SWT.WRAP);
            // Set the label's accessible name to space as we are reading this
            // with the button
            leakDescription.getAccessible().addAccessibleListener(new AccessibleAdapter()
            {

                @Override
                public void getName(AccessibleEvent e)
                {
                    e.result = space;
                }
            });
            leakDescription.setText(Messages.GettingStartedWizard_LeakSuspectReportDescription);
            leakDescription.setFont(JFaceResources.getFontRegistry().get(JFaceResources.DIALOG_FONT));

            Label componentDescription = new Label(choices, SWT.WRAP);
            componentDescription.setText(Messages.GettingStartedWizard_ComponentReportDescription);
            componentDescription.setFont(JFaceResources.getFontRegistry().get(JFaceResources.DIALOG_FONT));

            // Set the label's accessible name to space as we are reading this
            // with the button
            componentDescription.getAccessible().addAccessibleListener(new AccessibleAdapter()
            {

                @Override
                public void getName(AccessibleEvent e)
                {
                    e.result = space;
                }
            });
            Label openDescription = new Label(choices, SWT.WRAP);
            openDescription.setText(Messages.GettingStartedWizard_ExistingReportsLocation);
            openDescription.setFont(JFaceResources.getFontRegistry().get(JFaceResources.DIALOG_FONT));

            // Set the label's accessible name to space as we are reading this
            // with the button
            openDescription.getAccessible().addAccessibleListener(new AccessibleAdapter()
            {

                @Override
                public void getName(AccessibleEvent e)
                {
                    e.result = space;
                }
            });

            // Layout the buttons this way so that JAWS reads them as a group
            FormData data = new FormData();
            leakReport.setLayoutData(data);

            data = new FormData(450, SWT.DEFAULT);
            data.top = new FormAttachment(leakReport, 10, SWT.DEFAULT);
            leakDescription.setLayoutData(data);

            data = new FormData();
            data.top = new FormAttachment(leakDescription, 10, SWT.DEFAULT);
            componentReport.setLayoutData(data);

            data = new FormData(450, SWT.DEFAULT);
            data.top = new FormAttachment(componentReport, 10, SWT.DEFAULT);
            componentDescription.setLayoutData(data);

            data = new FormData();
            data.top = new FormAttachment(componentDescription, 10, SWT.DEFAULT);
            openReports.setLayoutData(data);

            data = new FormData(450, SWT.DEFAULT);
            data.top = new FormAttachment(openReports, 10, SWT.DEFAULT);
            openDescription.setLayoutData(data);

            choices.pack();

            askAgain = new Button(composite, SWT.CHECK);
            askAgain.setSelection(true);
            askAgain.setText(Messages.GettingStartedWizard_ShowThisDialog);
            askAgain.setFont(JFaceResources.getFontRegistry().get(JFaceResources.DIALOG_FONT));

            IPreferenceStore prefs = MemoryAnalyserPlugin.getDefault().getPreferenceStore();
            askAgain.setSelection(!prefs.getBoolean(HIDE_WIZARD_KEY));

            data = new FormData();
            data.top = new FormAttachment(choices, 20, SWT.DEFAULT);
            askAgain.setLayoutData(data);

            composite.pack();

            setControl(composite);
        }

        @Override
        public boolean canFlipToNextPage()
        {
            return componentReport.getSelection() || openReports.getSelection();
        }

        @Override
        public IWizardPage getNextPage()
        {
            if (componentReport.getSelection())
            {
                return getWizard().packagePage;
            }
            else if (openReports.getSelection())
            {
                getWizard().openReportsPage.loadReportList();
                return getWizard().openReportsPage;
            }
            else
            {
                return null;
            }
        }

        public void handleEvent(Event event)
        {
            if (event.widget == componentReport)
            {
                getWizard().action = null;
            }
            else if (event.widget == openReports)
            {
                getWizard().action = null;
            }
            else if (event.widget == leakReport)
            {
                getWizard().action = new ExecuteQueryAction(getWizard().editor,
                                "default_report org.eclipse.mat.api:suspects");//$NON-NLS-1$
            }

            getWizard().getContainer().updateButtons();
        }

        @Override
        public void setVisible(boolean visible)
        {
            if (visible)
                getWizard().action = null;
            super.setVisible(visible);
        }

        @Override
        public GettingStartedWizard getWizard()
        {
            return (GettingStartedWizard) super.getWizard();
        }

    }

    private static class PackagePage extends WizardPage implements ModifyListener
    {
        public PackagePage()
        {
            super("");//$NON-NLS-1$

            setTitle(Messages.GettingStartedWizard_SelectClasses);
            setDescription(Messages.GettingStartedWizard_SpecifyRegularExpression);
        }

        public void createControl(Composite parent)
        {
            Composite composite = new Composite(parent, SWT.NONE);
            GridLayoutFactory.fillDefaults().applyTo(composite);

            Label label = new Label(composite, SWT.NONE);
            label.setText(Messages.GettingStartedWizard_Package);

            Text regex = new Text(composite, SWT.BORDER);
            GridDataFactory.fillDefaults().grab(true, false).applyTo(regex);

            regex.addModifyListener(this);

            setControl(composite);
        }

        public void modifyText(ModifyEvent event)
        {
            try
            {
                String text = ((Text) event.widget).getText();
                if (!"".equals(text))//$NON-NLS-1$
                {
                    Pattern.compile(text);

                    getWizard().action = new ExecuteQueryAction(getWizard().editor, "component_report " + text);//$NON-NLS-1$
                }
                if (getErrorMessage() != null)
                    setErrorMessage(null);
            }
            catch (PatternSyntaxException e)
            {
                setErrorMessage(e.getMessage());
                getWizard().action = null;
            }

            getWizard().getContainer().updateButtons();
        }

        @Override
        public boolean canFlipToNextPage()
        {
            return false;
        }

        @Override
        public GettingStartedWizard getWizard()
        {
            return (GettingStartedWizard) super.getWizard();
        }

    }

    private static class OpenReportsPage extends WizardPage
    {
        TableViewer viewer;

        public OpenReportsPage()
        {
            super("");//$NON-NLS-1$

            setTitle(Messages.GettingStartedWizard_ReOpenReport);
            setDescription(Messages.GettingStartedWizard_ReOpenExistingReport);
        }

        public void createControl(Composite parent)
        {
            Composite composite = new Composite(parent, SWT.NONE);
            TableColumnLayout layout = new TableColumnLayout();
            composite.setLayout(layout);

            viewer = new TableViewer(composite, SWT.SINGLE | SWT.BORDER | SWT.FULL_SELECTION);

            TableColumn column = new TableColumn(viewer.getTable(), SWT.NONE);
            column.setText(Messages.GettingStartedWizard_Report);
            layout.setColumnData(column, new ColumnWeightData(100, true));

            viewer.setLabelProvider(new LabelProvider()
            {
                @Override
                public String getText(Object element)
                {
                    return ((File) element).getName();
                }
            });

            viewer.setContentProvider(new IStructuredContentProvider()
            {
                File[] fileList;

                public Object[] getElements(Object inputElement)
                {
                    return fileList;
                }

                public void dispose()
                {}

                public void inputChanged(Viewer viewer, Object oldInput, Object newInput)
                {
                    if (newInput instanceof ISnapshot)
                    {
                        try
                        {
                            ISnapshot snapshot = (ISnapshot) newInput;

                            String prefix = snapshot.getSnapshotInfo().getPath();

                            int p = prefix.lastIndexOf(File.separatorChar);
                            if (p >= 0)
                                prefix = prefix.substring(p + 1);

                            p = prefix.lastIndexOf('.');
                            if (p >= 0)
                                prefix = prefix.substring(0, p);

                            final String fragment = prefix;
                            final Pattern regex = Pattern.compile(".*\\.zip$");//$NON-NLS-1$

                            fileList = new File(snapshot.getSnapshotInfo().getPath()).getParentFile().listFiles(
                                            new FilenameFilter()
                                            {
                                                public boolean accept(File dir, String name)
                                                {
                                                    return name.startsWith(fragment) && regex.matcher(name).matches();
                                                }
                                            });
                        }
                        catch (PatternSyntaxException ignore)
                        {}
                    }
                }
            });

            viewer.addSelectionChangedListener(new ISelectionChangedListener()
            {
                public void selectionChanged(SelectionChangedEvent event)
                {
                    getWizard().action = new ImportReportAction(getWizard().editor,
                                    (File) ((IStructuredSelection) event.getSelection()).getFirstElement());
                    getWizard().getContainer().updateButtons();
                }
            });

            setControl(composite);
        }

        public void loadReportList()
        {
            viewer.setInput(getWizard().editor.getSnapshotInput().getSnapshot());
        }

        @Override
        public boolean canFlipToNextPage()
        {
            return false;
        }

        @Override
        public GettingStartedWizard getWizard()
        {
            return (GettingStartedWizard) super.getWizard();
        }
    }
}